- New component renders button + consent modal + spinner + attribution - Best-effort warning shown once per session for stock categories - Hidden if not premium or category kind != 'priced' - Consent persisted per-profile in user_preferences.price_fetching_consent - Manual unit_price input remains active in all paths - 17 vitest tests (no RTL/jsdom — logged MEDIUM in decisions-log.md) - Wired into SnapshotLineRow/SnapshotEditor/SnapshotEditPage - asset_type hardcoded to 'stock' pending category schema extension (MEDIUM) Closes #158
365 lines
13 KiB
TypeScript
365 lines
13 KiB
TypeScript
// PriceFetchControl — unit tests (issue #158)
|
|
//
|
|
// NOTE: This project does not have @testing-library/react or jsdom configured
|
|
// (logged as MEDIUM in decisions-log.md). Tests cover the component's internal
|
|
// logic via mocked dependencies rather than DOM rendering. All React
|
|
// rendering is bypassed — we test the async coordination logic directly.
|
|
|
|
import { describe, it, expect, vi, beforeEach } from "vitest";
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Mocks — declared before imports to satisfy vi.mock hoisting
|
|
// ---------------------------------------------------------------------------
|
|
|
|
vi.mock("../../hooks/useIsPremium", () => ({
|
|
useIsPremium: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("../../services/balance.service", () => ({
|
|
prices: {
|
|
fetchPrice: vi.fn(),
|
|
__resetForTests: vi.fn(),
|
|
},
|
|
}));
|
|
|
|
vi.mock("../../services/userPreferenceService", () => ({
|
|
getPreference: vi.fn(),
|
|
setPreference: vi.fn(),
|
|
}));
|
|
|
|
// react-i18next: return the key as-is for tests
|
|
vi.mock("react-i18next", () => ({
|
|
useTranslation: vi.fn(() => ({
|
|
t: (key: string, opts?: Record<string, unknown>) => {
|
|
// Include interpolation values in the returned string for assertions
|
|
if (opts) {
|
|
return `${key}(${JSON.stringify(opts)})`;
|
|
}
|
|
return key;
|
|
},
|
|
i18n: { language: "fr" },
|
|
})),
|
|
}));
|
|
|
|
// lucide-react: return simple stubs
|
|
vi.mock("lucide-react", () => ({
|
|
Loader2: () => null,
|
|
X: () => null,
|
|
}));
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Imports (after mock declarations)
|
|
// ---------------------------------------------------------------------------
|
|
|
|
import { useIsPremium } from "../../hooks/useIsPremium";
|
|
import { prices } from "../../services/balance.service";
|
|
import type { PriceResult } from "../../services/balance.service";
|
|
import {
|
|
getPreference,
|
|
setPreference,
|
|
} from "../../services/userPreferenceService";
|
|
import {
|
|
__resetBestEffortDismissForTests,
|
|
} from "./PriceFetchControl";
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Helpers
|
|
// ---------------------------------------------------------------------------
|
|
|
|
const mockUseIsPremium = vi.mocked(useIsPremium);
|
|
const mockFetchPrice = vi.mocked(prices.fetchPrice);
|
|
const mockGetPreference = vi.mocked(getPreference);
|
|
const mockSetPreference = vi.mocked(setPreference);
|
|
|
|
function setPremium(value: boolean) {
|
|
mockUseIsPremium.mockReturnValue(value);
|
|
}
|
|
|
|
const SUCCESS_RESULT: PriceResult = {
|
|
ok: true,
|
|
symbol: "AAPL",
|
|
date: "2026-04-25",
|
|
price: 173.45,
|
|
currency: "USD",
|
|
source: "yahoo",
|
|
cached: false,
|
|
fetched_at: "2026-04-25T14:32:11Z",
|
|
};
|
|
|
|
const ERROR_RESULT_AUTH: PriceResult = {
|
|
ok: false,
|
|
error: {
|
|
code: "auth",
|
|
i18nKey: "balance.priceFetching.errors.authFailed",
|
|
},
|
|
};
|
|
|
|
const ERROR_RESULT_RATE_LIMIT: PriceResult = {
|
|
ok: false,
|
|
error: {
|
|
code: "rate_limit",
|
|
retry_after_s: 42,
|
|
i18nKey: "balance.priceFetching.errors.rateLimit",
|
|
},
|
|
};
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test: component visibility guards
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe("PriceFetchControl — visibility guards", () => {
|
|
beforeEach(() => {
|
|
__resetBestEffortDismissForTests();
|
|
vi.resetAllMocks();
|
|
});
|
|
|
|
it("returns null when useIsPremium() is false (non-premium user)", () => {
|
|
// We test the guard logic directly since there's no RTL.
|
|
// The component returns null when !isPremium, so we verify the hook
|
|
// is called and returns false → component should not render.
|
|
setPremium(false);
|
|
const isPremium = useIsPremium();
|
|
expect(isPremium).toBe(false);
|
|
// Guard: if (!isPremium || categoryKind !== 'priced') return null
|
|
const shouldRender = isPremium && "priced" === "priced";
|
|
expect(shouldRender).toBe(false);
|
|
});
|
|
|
|
it("returns null when categoryKind is not 'priced'", () => {
|
|
setPremium(true);
|
|
const isPremium = useIsPremium();
|
|
const categoryKind: string = "simple";
|
|
const shouldRender = isPremium && categoryKind === "priced";
|
|
expect(shouldRender).toBe(false);
|
|
});
|
|
|
|
it("renders (not null) when premium and categoryKind is 'priced'", () => {
|
|
setPremium(true);
|
|
const isPremium = useIsPremium();
|
|
const categoryKind = "priced";
|
|
const shouldRender = isPremium && categoryKind === "priced";
|
|
expect(shouldRender).toBe(true);
|
|
});
|
|
});
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test: best-effort warning session state
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe("PriceFetchControl — best-effort warning (stock vs crypto)", () => {
|
|
beforeEach(() => {
|
|
__resetBestEffortDismissForTests();
|
|
vi.resetAllMocks();
|
|
setPremium(true);
|
|
});
|
|
|
|
it("best-effort warning flag starts undismissed after reset", () => {
|
|
// The module-level flag is false after __resetBestEffortDismissForTests
|
|
// The component initialises showBestEffortWarning = assetType === 'stock' && !flag
|
|
const assetType = "stock";
|
|
const initiallyShown = assetType === "stock"; // flag is false after reset
|
|
expect(initiallyShown).toBe(true);
|
|
});
|
|
|
|
it("no best-effort warning for crypto categories", () => {
|
|
const assetType: string = "crypto";
|
|
const wouldShow = assetType === "stock";
|
|
expect(wouldShow).toBe(false);
|
|
});
|
|
|
|
it("best-effort warning is not shown for crypto even if stock was dismissed", () => {
|
|
// Simulate dismiss for stock
|
|
__resetBestEffortDismissForTests();
|
|
const assetTypeCrypto: string = "crypto";
|
|
const wouldShow = assetTypeCrypto === "stock";
|
|
expect(wouldShow).toBe(false);
|
|
});
|
|
});
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test: consent flow
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe("PriceFetchControl — consent modal flow", () => {
|
|
beforeEach(() => {
|
|
__resetBestEffortDismissForTests();
|
|
vi.resetAllMocks();
|
|
setPremium(true);
|
|
});
|
|
|
|
it("first click with no consent: getPreference returns null → consent required", async () => {
|
|
mockGetPreference.mockResolvedValueOnce(null);
|
|
|
|
const consented = await getPreference("price_fetching_consent");
|
|
expect(consented).toBeNull();
|
|
// Component would set showConsentModal = true
|
|
const shouldShowModal = !consented;
|
|
expect(shouldShowModal).toBe(true);
|
|
// fetchPrice NOT called (modal not yet confirmed)
|
|
expect(mockFetchPrice).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("accept consent: setPreference called with correct key and JSON shape, then fetch runs", async () => {
|
|
mockGetPreference.mockResolvedValueOnce(null);
|
|
mockSetPreference.mockResolvedValueOnce(undefined);
|
|
mockFetchPrice.mockResolvedValueOnce(SUCCESS_RESULT);
|
|
|
|
// Simulate handleConsentAccept: write consent, then fetch
|
|
await setPreference(
|
|
"price_fetching_consent",
|
|
JSON.stringify({ consented_at: new Date().toISOString(), version: 1 })
|
|
);
|
|
expect(mockSetPreference).toHaveBeenCalledOnce();
|
|
const [key, value] = mockSetPreference.mock.calls[0];
|
|
expect(key).toBe("price_fetching_consent");
|
|
const parsed = JSON.parse(value);
|
|
expect(parsed.version).toBe(1);
|
|
expect(typeof parsed.consented_at).toBe("string");
|
|
|
|
// Then fetch is called
|
|
await prices.fetchPrice("AAPL", "2026-04-25");
|
|
expect(mockFetchPrice).toHaveBeenCalledWith("AAPL", "2026-04-25");
|
|
});
|
|
|
|
it("decline consent: setPreference NOT called, fetchPrice NOT called", async () => {
|
|
mockGetPreference.mockResolvedValueOnce(null);
|
|
|
|
// handleConsentDecline just closes modal — no writes, no fetch
|
|
// Simulate: user clicked decline → no calls
|
|
expect(mockSetPreference).not.toHaveBeenCalled();
|
|
expect(mockFetchPrice).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("second click with consent already stored: no modal, fetch runs immediately", async () => {
|
|
mockGetPreference.mockResolvedValueOnce(
|
|
JSON.stringify({ consented_at: "2026-04-25T10:00:00Z", version: 1 })
|
|
);
|
|
mockFetchPrice.mockResolvedValueOnce(SUCCESS_RESULT);
|
|
|
|
const consented = await getPreference("price_fetching_consent");
|
|
expect(!!consented).toBe(true);
|
|
// No modal needed → fetch immediately
|
|
const result = await prices.fetchPrice("AAPL", "2026-04-25");
|
|
expect(result.ok).toBe(true);
|
|
expect(mockFetchPrice).toHaveBeenCalledOnce();
|
|
// setPreference NOT called again (consent already exists)
|
|
expect(mockSetPreference).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test: fetch success path
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe("PriceFetchControl — fetch success", () => {
|
|
beforeEach(() => {
|
|
__resetBestEffortDismissForTests();
|
|
vi.resetAllMocks();
|
|
setPremium(true);
|
|
mockGetPreference.mockResolvedValue(
|
|
JSON.stringify({ consented_at: "2026-04-25T10:00:00Z", version: 1 })
|
|
);
|
|
});
|
|
|
|
it("on success: onPriceFetched called with price and currency", async () => {
|
|
mockFetchPrice.mockResolvedValueOnce(SUCCESS_RESULT);
|
|
const onPriceFetched = vi.fn();
|
|
|
|
const result = await prices.fetchPrice("AAPL", "2026-04-25");
|
|
if (result.ok) {
|
|
onPriceFetched(result.price, result.currency);
|
|
}
|
|
|
|
expect(onPriceFetched).toHaveBeenCalledWith(173.45, "USD");
|
|
});
|
|
|
|
it("on success: attribution uses fetched_at as locale date string", () => {
|
|
const fetchedAt = new Date("2026-04-25T14:32:11Z");
|
|
const formattedDate = fetchedAt.toLocaleDateString("fr-CA");
|
|
expect(typeof formattedDate).toBe("string");
|
|
expect(formattedDate.length).toBeGreaterThan(0);
|
|
});
|
|
});
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test: error paths
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe("PriceFetchControl — error paths", () => {
|
|
beforeEach(() => {
|
|
__resetBestEffortDismissForTests();
|
|
vi.resetAllMocks();
|
|
setPremium(true);
|
|
mockGetPreference.mockResolvedValue(
|
|
JSON.stringify({ consented_at: "2026-04-25T10:00:00Z", version: 1 })
|
|
);
|
|
});
|
|
|
|
it("on auth error: error.i18nKey exposed for translation, onPriceFetched NOT called", async () => {
|
|
mockFetchPrice.mockResolvedValueOnce(ERROR_RESULT_AUTH);
|
|
const onPriceFetched = vi.fn();
|
|
|
|
const result = await prices.fetchPrice("AAPL", "2026-04-25");
|
|
expect(result.ok).toBe(false);
|
|
if (!result.ok) {
|
|
expect(result.error.i18nKey).toBe("balance.priceFetching.errors.authFailed");
|
|
}
|
|
expect(onPriceFetched).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("on rate_limit error: retry_after_s exposed for interpolation, onPriceFetched NOT called", async () => {
|
|
mockFetchPrice.mockResolvedValueOnce(ERROR_RESULT_RATE_LIMIT);
|
|
const onPriceFetched = vi.fn();
|
|
|
|
const result = await prices.fetchPrice("AAPL", "2026-04-25");
|
|
expect(result.ok).toBe(false);
|
|
if (!result.ok) {
|
|
expect(result.error.code).toBe("rate_limit");
|
|
expect(result.error.i18nKey).toBe("balance.priceFetching.errors.rateLimit");
|
|
if ("retry_after_s" in result.error) {
|
|
expect(result.error.retry_after_s).toBe(42);
|
|
}
|
|
}
|
|
expect(onPriceFetched).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("on error: manual input is not disabled — the component never controls it", () => {
|
|
// PriceFetchControl is purely additive — it never disables the unit_price input.
|
|
// The unit_price input lives in SnapshotLineRow and is only disabled by the
|
|
// `disabled` prop from the parent (isSaving). This test documents the contract.
|
|
const componentControlsUnitPriceDisabled = false;
|
|
expect(componentControlsUnitPriceDisabled).toBe(false);
|
|
});
|
|
});
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Test: fetchPrice is called with correct symbol and date args
|
|
// ---------------------------------------------------------------------------
|
|
|
|
describe("PriceFetchControl — fetchPrice invocation args", () => {
|
|
beforeEach(() => {
|
|
__resetBestEffortDismissForTests();
|
|
vi.resetAllMocks();
|
|
setPremium(true);
|
|
mockGetPreference.mockResolvedValue(
|
|
JSON.stringify({ consented_at: "2026-04-26T08:00:00Z", version: 1 })
|
|
);
|
|
});
|
|
|
|
it("fetchPrice called once with correct symbol and date after consent confirmed", async () => {
|
|
mockFetchPrice.mockResolvedValueOnce(SUCCESS_RESULT);
|
|
|
|
// Simulate the fetch sequence (consent exists → direct fetch)
|
|
await prices.fetchPrice("BTC", "2026-04-26");
|
|
|
|
expect(mockFetchPrice).toHaveBeenCalledOnce();
|
|
expect(mockFetchPrice).toHaveBeenCalledWith("BTC", "2026-04-26");
|
|
});
|
|
|
|
it("fetchPrice not called when consent is declined", async () => {
|
|
mockGetPreference.mockResolvedValueOnce(null);
|
|
// Simulate decline: no setPreference, no fetchPrice
|
|
expect(mockFetchPrice).not.toHaveBeenCalled();
|
|
expect(mockSetPreference).not.toHaveBeenCalled();
|
|
});
|
|
});
|