Skip to content

[Infra] UI - Testing: Adding Unit Testing Coverage #20596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yuneng-jiang merged 1 commit into from
Feb 6, 2026
Merged

[Infra] UI - Testing: Adding Unit Testing Coverage #20596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 180 additions & 0 deletions ui/litellm-dashboard/src/app/(dashboard)/hooks/useDisableShowNewBadge.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
import { renderHook, waitFor } from "@testing-library/react";
import { useDisableShowNewBadge } from "./useDisableShowNewBadge";
import { LOCAL_STORAGE_EVENT } from "@/utils/localStorageUtils";

describe("useDisableShowNewBadge", () => {
const STORAGE_KEY = "disableShowNewBadge";

beforeEach(() => {
localStorage.clear();
vi.clearAllMocks();
});

afterEach(() => {
localStorage.clear();
});

it("should return false when localStorage is empty", () => {
const { result } = renderHook(() => useDisableShowNewBadge());

expect(result.current).toBe(false);
});

it("should return false when localStorage value is not 'true'", () => {
localStorage.setItem(STORAGE_KEY, "false");

const { result } = renderHook(() => useDisableShowNewBadge());

expect(result.current).toBe(false);
});

it("should return true when localStorage value is 'true'", () => {
localStorage.setItem(STORAGE_KEY, "true");

const { result } = renderHook(() => useDisableShowNewBadge());

expect(result.current).toBe(true);
});

it("should return false when localStorage value is an empty string", () => {
localStorage.setItem(STORAGE_KEY, "");

const { result } = renderHook(() => useDisableShowNewBadge());

expect(result.current).toBe(false);
});

it("should update when storage event fires for the correct key", async () => {
const { result } = renderHook(() => useDisableShowNewBadge());

expect(result.current).toBe(false);

localStorage.setItem(STORAGE_KEY, "true");
const storageEvent = new StorageEvent("storage", {
key: STORAGE_KEY,
newValue: "true",
});
window.dispatchEvent(storageEvent);

await waitFor(() => {
expect(result.current).toBe(true);
});
});

it("should not update when storage event fires for a different key", () => {
localStorage.setItem(STORAGE_KEY, "false");
const { result } = renderHook(() => useDisableShowNewBadge());

expect(result.current).toBe(false);

const storageEvent = new StorageEvent("storage", {
key: "otherKey",
newValue: "true",
});
window.dispatchEvent(storageEvent);

expect(result.current).toBe(false);
});

it("should update when custom LOCAL_STORAGE_EVENT fires for the correct key", async () => {
const { result } = renderHook(() => useDisableShowNewBadge());

expect(result.current).toBe(false);

localStorage.setItem(STORAGE_KEY, "true");
const customEvent = new CustomEvent(LOCAL_STORAGE_EVENT, {
detail: { key: STORAGE_KEY },
});
window.dispatchEvent(customEvent);

await waitFor(() => {
expect(result.current).toBe(true);
});
});

it("should not update when custom LOCAL_STORAGE_EVENT fires for a different key", () => {
localStorage.setItem(STORAGE_KEY, "false");
const { result } = renderHook(() => useDisableShowNewBadge());

expect(result.current).toBe(false);

const customEvent = new CustomEvent(LOCAL_STORAGE_EVENT, {
detail: { key: "otherKey" },
});
window.dispatchEvent(customEvent);

expect(result.current).toBe(false);
});

it("should update when localStorage changes from false to true via custom event", async () => {
localStorage.setItem(STORAGE_KEY, "false");
const { result } = renderHook(() => useDisableShowNewBadge());

expect(result.current).toBe(false);

localStorage.setItem(STORAGE_KEY, "true");
const customEvent = new CustomEvent(LOCAL_STORAGE_EVENT, {
detail: { key: STORAGE_KEY },
});
window.dispatchEvent(customEvent);

await waitFor(() => {
expect(result.current).toBe(true);
});
});

it("should update when localStorage changes from true to false via storage event", async () => {
localStorage.setItem(STORAGE_KEY, "true");
const { result } = renderHook(() => useDisableShowNewBadge());

expect(result.current).toBe(true);

localStorage.setItem(STORAGE_KEY, "false");
const storageEvent = new StorageEvent("storage", {
key: STORAGE_KEY,
newValue: "false",
});
window.dispatchEvent(storageEvent);

await waitFor(() => {
expect(result.current).toBe(false);
});
});

it("should cleanup event listeners on unmount", () => {
const addEventListenerSpy = vi.spyOn(window, "addEventListener");
const removeEventListenerSpy = vi.spyOn(window, "removeEventListener");

const { unmount } = renderHook(() => useDisableShowNewBadge());

expect(addEventListenerSpy).toHaveBeenCalledTimes(2);
expect(addEventListenerSpy).toHaveBeenCalledWith("storage", expect.any(Function));
expect(addEventListenerSpy).toHaveBeenCalledWith(LOCAL_STORAGE_EVENT, expect.any(Function));

unmount();

expect(removeEventListenerSpy).toHaveBeenCalledTimes(2);
expect(removeEventListenerSpy).toHaveBeenCalledWith("storage", expect.any(Function));
expect(removeEventListenerSpy).toHaveBeenCalledWith(LOCAL_STORAGE_EVENT, expect.any(Function));
});

it("should handle multiple hooks independently", async () => {
const { result: result1 } = renderHook(() => useDisableShowNewBadge());
const { result: result2 } = renderHook(() => useDisableShowNewBadge());

expect(result1.current).toBe(false);
expect(result2.current).toBe(false);

localStorage.setItem(STORAGE_KEY, "true");
const customEvent = new CustomEvent(LOCAL_STORAGE_EVENT, {
detail: { key: STORAGE_KEY },
});
window.dispatchEvent(customEvent);

await waitFor(() => {
expect(result1.current).toBe(true);
expect(result2.current).toBe(true);
});
});
});
180 changes: 180 additions & 0 deletions ui/litellm-dashboard/src/app/(dashboard)/hooks/useDisableShowPrompts.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
import { renderHook, waitFor } from "@testing-library/react";
import { useDisableShowPrompts } from "./useDisableShowPrompts";
import { LOCAL_STORAGE_EVENT } from "@/utils/localStorageUtils";

describe("useDisableShowPrompts", () => {
const STORAGE_KEY = "disableShowPrompts";

beforeEach(() => {
localStorage.clear();
vi.clearAllMocks();
});

afterEach(() => {
localStorage.clear();
});

it("should return false when localStorage is empty", () => {
const { result } = renderHook(() => useDisableShowPrompts());

expect(result.current).toBe(false);
});

it("should return false when localStorage value is not 'true'", () => {
localStorage.setItem(STORAGE_KEY, "false");

const { result } = renderHook(() => useDisableShowPrompts());

expect(result.current).toBe(false);
});

it("should return true when localStorage value is 'true'", () => {
localStorage.setItem(STORAGE_KEY, "true");

const { result } = renderHook(() => useDisableShowPrompts());

expect(result.current).toBe(true);
});

it("should return false when localStorage value is an empty string", () => {
localStorage.setItem(STORAGE_KEY, "");

const { result } = renderHook(() => useDisableShowPrompts());

expect(result.current).toBe(false);
});

it("should update when storage event fires for the correct key", async () => {
const { result } = renderHook(() => useDisableShowPrompts());

expect(result.current).toBe(false);

localStorage.setItem(STORAGE_KEY, "true");
const storageEvent = new StorageEvent("storage", {
key: STORAGE_KEY,
newValue: "true",
});
window.dispatchEvent(storageEvent);

await waitFor(() => {
expect(result.current).toBe(true);
});
});

it("should not update when storage event fires for a different key", () => {
localStorage.setItem(STORAGE_KEY, "false");
const { result } = renderHook(() => useDisableShowPrompts());

expect(result.current).toBe(false);

const storageEvent = new StorageEvent("storage", {
key: "otherKey",
newValue: "true",
});
window.dispatchEvent(storageEvent);

expect(result.current).toBe(false);
});

it("should update when custom LOCAL_STORAGE_EVENT fires for the correct key", async () => {
const { result } = renderHook(() => useDisableShowPrompts());

expect(result.current).toBe(false);

localStorage.setItem(STORAGE_KEY, "true");
const customEvent = new CustomEvent(LOCAL_STORAGE_EVENT, {
detail: { key: STORAGE_KEY },
});
window.dispatchEvent(customEvent);

await waitFor(() => {
expect(result.current).toBe(true);
});
});

it("should not update when custom LOCAL_STORAGE_EVENT fires for a different key", () => {
localStorage.setItem(STORAGE_KEY, "false");
const { result } = renderHook(() => useDisableShowPrompts());

expect(result.current).toBe(false);

const customEvent = new CustomEvent(LOCAL_STORAGE_EVENT, {
detail: { key: "otherKey" },
});
window.dispatchEvent(customEvent);

expect(result.current).toBe(false);
});

it("should update when localStorage changes from false to true via custom event", async () => {
localStorage.setItem(STORAGE_KEY, "false");
const { result } = renderHook(() => useDisableShowPrompts());

expect(result.current).toBe(false);

localStorage.setItem(STORAGE_KEY, "true");
const customEvent = new CustomEvent(LOCAL_STORAGE_EVENT, {
detail: { key: STORAGE_KEY },
});
window.dispatchEvent(customEvent);

await waitFor(() => {
expect(result.current).toBe(true);
});
});

it("should update when localStorage changes from true to false via storage event", async () => {
localStorage.setItem(STORAGE_KEY, "true");
const { result } = renderHook(() => useDisableShowPrompts());

expect(result.current).toBe(true);

localStorage.setItem(STORAGE_KEY, "false");
const storageEvent = new StorageEvent("storage", {
key: STORAGE_KEY,
newValue: "false",
});
window.dispatchEvent(storageEvent);

await waitFor(() => {
expect(result.current).toBe(false);
});
});

it("should cleanup event listeners on unmount", () => {
const addEventListenerSpy = vi.spyOn(window, "addEventListener");
const removeEventListenerSpy = vi.spyOn(window, "removeEventListener");

const { unmount } = renderHook(() => useDisableShowPrompts());

expect(addEventListenerSpy).toHaveBeenCalledTimes(2);
expect(addEventListenerSpy).toHaveBeenCalledWith("storage", expect.any(Function));
expect(addEventListenerSpy).toHaveBeenCalledWith(LOCAL_STORAGE_EVENT, expect.any(Function));

unmount();

expect(removeEventListenerSpy).toHaveBeenCalledTimes(2);
expect(removeEventListenerSpy).toHaveBeenCalledWith("storage", expect.any(Function));
expect(removeEventListenerSpy).toHaveBeenCalledWith(LOCAL_STORAGE_EVENT, expect.any(Function));
});

it("should handle multiple hooks independently", async () => {
const { result: result1 } = renderHook(() => useDisableShowPrompts());
const { result: result2 } = renderHook(() => useDisableShowPrompts());

expect(result1.current).toBe(false);
expect(result2.current).toBe(false);

localStorage.setItem(STORAGE_KEY, "true");
const customEvent = new CustomEvent(LOCAL_STORAGE_EVENT, {
detail: { key: STORAGE_KEY },
});
window.dispatchEvent(customEvent);

await waitFor(() => {
expect(result1.current).toBe(true);
expect(result2.current).toBe(true);
});
});
});
Loading
Loading