Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Empty file removed src/controllers/.gitkeep
Empty file.
57 changes: 57 additions & 0 deletions src/controllers/useFilters.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
import { beforeEach, describe, expect, test } from "vitest";
import { act, renderHook } from "@testing-library/react";
import { DEFAULT_FILTERS, saveFilters } from "../models/filters";
import { useFilters } from "./useFilters";

describe("useFilters Hook", () => {
beforeEach(() => {
window.sessionStorage.clear();
});

test("starts with defaults when nothing is stored", () => {
const { result } = renderHook(() => useFilters());

expect(result.current.filters).toEqual(DEFAULT_FILTERS);
});

test("restores filters from sessionStorage", () => {
saveFilters({ type: "electric", sort: "name-asc", onlyFavorites: true });

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

expect(result.current.filters.type).toBe("electric");
expect(result.current.filters.sort).toBe("name-asc");
expect(result.current.filters.onlyFavorites).toBe(true);
});

test("setFilter updates state and storage", () => {
const { result } = renderHook(() => useFilters());

act(() => {
result.current.setFilter({ type: "fire" });
});

expect(result.current.filters).toEqual({
...DEFAULT_FILTERS,
type: "fire",
});
expect(JSON.parse(window.sessionStorage.getItem("filters")!)).toEqual(
result.current.filters,
);
});

test("resetFilters goes back to defaults", () => {
saveFilters({ type: "ice", sort: "id-desc", onlyFavorites: true });

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

act(() => {
result.current.resetFilters();
});

expect(result.current.filters).toEqual(DEFAULT_FILTERS);
expect(JSON.parse(window.sessionStorage.getItem("filters")!)).toEqual(
DEFAULT_FILTERS,
);
});
});
28 changes: 28 additions & 0 deletions src/controllers/useFilters.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { useCallback, useEffect, useState } from "react";
import {
DEFAULT_FILTERS,
loadFilters,
saveFilters,
type FilterSettings,
} from "../models/filters";

export function useFilters() {
// 1. Lazy initialization from sessionStorage
const [filters, setFilters] = useState<FilterSettings>(loadFilters);

// 2. Keep storage in sync so the choices survive a reload
useEffect(() => {
saveFilters(filters);
}, [filters]);

// 3. Handlers passed down to the filter components
const setFilter = useCallback((changes: Partial<FilterSettings>) => {
setFilters((prev) => ({ ...prev, ...changes }));
}, []);

const resetFilters = useCallback(() => {
setFilters(DEFAULT_FILTERS);
}, []);

return { filters, setFilter, resetFilters };
}
Empty file removed src/models/.gitkeep
Empty file.
70 changes: 70 additions & 0 deletions src/models/filters.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
import {
DEFAULT_FILTERS,
loadFilters,
parseFilters,
saveFilters,
} from "./filters";

const mockFilters = {
type: "fire",
sort: "name-desc" as const,
onlyFavorites: true,
};

describe("Filters Model", () => {
beforeEach(() => {
window.sessionStorage.clear();
});

afterEach(() => {
vi.restoreAllMocks();
});

test("returns defaults when nothing is stored", () => {
expect(parseFilters(null)).toEqual(DEFAULT_FILTERS);
expect(loadFilters()).toEqual(DEFAULT_FILTERS);
});

test("returns defaults for invalid data", () => {
expect(parseFilters("{not json")).toEqual(DEFAULT_FILTERS);
expect(parseFilters("42")).toEqual(DEFAULT_FILTERS);
expect(parseFilters("[1,2]")).toEqual(DEFAULT_FILTERS);
});

test("keeps valid fields and resets invalid ones", () => {
const raw = JSON.stringify({
type: "water",
sort: "wrong",
onlyFavorites: "yes",
});

expect(parseFilters(raw)).toEqual({
type: "water",
sort: DEFAULT_FILTERS.sort,
onlyFavorites: DEFAULT_FILTERS.onlyFavorites,
});
});

test("saves and loads filters from sessionStorage", () => {
saveFilters(mockFilters);

expect(window.sessionStorage.getItem("filters")).toBe(
JSON.stringify(mockFilters),
);
expect(loadFilters()).toEqual(mockFilters);
});

test("does not crash when storage is unavailable", () => {
vi.spyOn(console, "error").mockImplementation(() => {});
vi.spyOn(Storage.prototype, "getItem").mockImplementation(() => {
throw new Error("blocked");
});
vi.spyOn(Storage.prototype, "setItem").mockImplementation(() => {
throw new Error("blocked");
});

expect(() => saveFilters(mockFilters)).not.toThrow();
expect(loadFilters()).toEqual(DEFAULT_FILTERS);
});
});
76 changes: 76 additions & 0 deletions src/models/filters.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
export type SortOption = "id-asc" | "id-desc" | "name-asc" | "name-desc";

export type FilterSettings = {
type: string | null;
sort: SortOption;
onlyFavorites: boolean;
};

export const SORT_OPTIONS: SortOption[] = [
"id-asc",
"id-desc",
"name-asc",
"name-desc",
];

export const DEFAULT_FILTERS: FilterSettings = {
type: null,
sort: "id-asc",
onlyFavorites: false,
};

const STORAGE_KEY = "filters";

function isSortOption(value: unknown): value is SortOption {
return SORT_OPTIONS.includes(value as SortOption);
}

// Validates stored data field by field so a broken value
// only resets that field and not the whole object
export function parseFilters(raw: string | null): FilterSettings {
if (!raw) {
return DEFAULT_FILTERS;
}

let data: unknown;
try {
data = JSON.parse(raw);
} catch {
return DEFAULT_FILTERS;
}

if (typeof data !== "object" || data === null || Array.isArray(data)) {
return DEFAULT_FILTERS;
}

const stored = data as Record<string, unknown>;

return {
type:
typeof stored.type === "string" && stored.type !== ""
? stored.type
: null,
sort: isSortOption(stored.sort) ? stored.sort : DEFAULT_FILTERS.sort,
onlyFavorites:
typeof stored.onlyFavorites === "boolean"
? stored.onlyFavorites
: DEFAULT_FILTERS.onlyFavorites,
};
}

export function loadFilters(): FilterSettings {
try {
return parseFilters(window.sessionStorage.getItem(STORAGE_KEY));
} catch (error) {
console.error("Error reading sessionStorage", error);
return DEFAULT_FILTERS;
}
}

export function saveFilters(filters: FilterSettings) {
try {
window.sessionStorage.setItem(STORAGE_KEY, JSON.stringify(filters));
} catch (error) {
console.error("Error writing sessionStorage", error);
}
}