diff --git a/src/presentation/adapters/query/application-query.ts b/src/presentation/adapters/query/application-query.ts index 5837e348..943488e8 100644 --- a/src/presentation/adapters/query/application-query.ts +++ b/src/presentation/adapters/query/application-query.ts @@ -53,11 +53,17 @@ export type ApplicationResult = Result; class ApplicationQueryError extends Error { readonly failure: AppFailure; + /** + * 1112/01-04. What the cache diagnostics record (`safeErrorKind` reads + * `kind` first): the failure's kind, not one name for every failure. + */ + readonly kind: AppFailure["kind"]; constructor(failure: AppFailure) { super(failure.kind); this.name = "ApplicationQueryError"; this.failure = failure; + this.kind = failure.kind; } } @@ -100,7 +106,6 @@ export function useApplicationQuery( "definitionId" in options ? options.definitionId : "APPLICATION_QUERY"; const invalidation = "invalidation" in options ? options.invalidation : undefined; - const [staleFailure, setStaleFailure] = useState(false); useEffect(() => { identity?.acquire(); return () => identity?.release(); @@ -170,9 +175,10 @@ export function useApplicationQuery( throw new DOMException("Query cancelled", "AbortError"); } if (error instanceof ApplicationQueryError) throw error; + // 1112/01-04. The definition it came from, as the other failures here. throw new ApplicationQueryError( normalizeUnknownFailure(error, { - operationId: "APPLICATION_QUERY", + operationId: queryDefinitionId, }), ); } finally { @@ -181,17 +187,13 @@ export function useApplicationQuery( }, }); const hasData = query.data !== undefined && query.data !== null; - - useEffect(() => { - if (query.isError && hasData) { - setStaleFailure(true); - } else if (query.isSuccess && !query.isFetching) { - setStaleFailure(false); - } - }, [hasData, query.isError, query.isFetching, query.isSuccess]); + // 1112/01-05. Read while rendering: the data is stale because the last + // fetch failed, and no fetch runs now. A retry that is running shows as + // refreshing; copied into state by an effect, the old failure came back + // over the retry's reset. + const staleFailure = query.isError && hasData && !query.isFetching; const retry = useCallback(async () => { - setStaleFailure(false); await query.refetch({ cancelRefetch: false }); }, [query]); @@ -368,6 +370,12 @@ export function useApplicationMutation( "definitionId" in options ? options.definitionId ?? "LEGACY_MUTATION" : "LEGACY_MUTATION"; + // 1112/01-04. An unexpected throw names the mutation definition it came + // from; a legacy mutation without one keeps the generic name. + const failureOperationId = + "definitionId" in options && options.definitionId + ? options.definitionId + : "APPLICATION_MUTATION"; const definitionVersion = "definitionVersion" in options ? options.definitionVersion : 0; const duplicatePolicy = @@ -701,7 +709,7 @@ export function useApplicationMutation( error instanceof ApplicationQueryError ? error.failure : normalizeUnknownFailure(error, { - operationId: "APPLICATION_MUTATION", + operationId: failureOperationId, }); const failure = mutationFailureWithEffect(reportedFailure); switch (failure.effect) { @@ -758,7 +766,7 @@ export function useApplicationMutation( .catch((error: unknown) => { const failure = withFailureEffect( normalizeUnknownFailure(error, { - operationId: "APPLICATION_MUTATION", + operationId: failureOperationId, }), "NOT_STARTED", ); @@ -794,6 +802,7 @@ export function useApplicationMutation( queryClient, definitionId, duplicatePolicy, + failureOperationId, mutationIntentFactory, mutationOperationId, requiresIdempotencyKey, diff --git a/tests/component/application-query-bridge.test.tsx b/tests/component/application-query-bridge.test.tsx index 5044a926..f83f61b5 100644 --- a/tests/component/application-query-bridge.test.tsx +++ b/tests/component/application-query-bridge.test.tsx @@ -8,6 +8,7 @@ import { type ApplicationResult, useApplicationQuery, } from "../../src/presentation/adapters/query/application-query.ts"; +import { createQueryClient } from "../../src/adapters/query-cache/index.ts"; import { createFailure } from "../../src/contracts/errors.ts"; import { queryClient, wrapper } from "./application-query-fixture.tsx"; @@ -250,5 +251,75 @@ describe("application query inbound bridge", () => { await waitFor(() => expect(aborted).toBe(true)); expect(client.getQueryState(["cancelled"])?.status).not.toBe("error"); }); -}); + // 1112/01-05. Whether stale data failed is the query's own state, read + // while rendering. Copied into state by an effect, it came back over the + // retry's reset, so a retry of stale data still said the old failure. + it("shows a retry of stale data as refreshing, not as the old failure", async () => { + const client = queryClient(); + let release: ((value: ApplicationResult) => void) | undefined; + const execute = vi + .fn<() => Promise>>() + .mockResolvedValueOnce({ ok: true, value: ["first"] }) + .mockResolvedValueOnce({ ok: false, error: createFailure("SERVER_FAILURE", "LIST", 0) }) + .mockImplementationOnce( + () => new Promise((resolve) => { + release = resolve; + }), + ); + const hook = renderHook( + () => useApplicationQuery({ queryKey: ["resource", "stale-retry"], execute }), + { wrapper: wrapper(client) }, + ); + await waitFor(() => expect(hook.result.current.data).toEqual(["first"])); + await act(() => hook.result.current.retry()); + await waitFor(() => expect(hook.result.current.state.indicator).toBe("stale-degraded")); + + act(() => { + void hook.result.current.retry(); + }); + + await waitFor(() => expect(hook.result.current.state.indicator).toBe("refreshing")); + await act(async () => release?.({ ok: true, value: ["recovered"] })); + await waitFor(() => expect(hook.result.current.state.indicator).toBeNull()); + }); + + // 1112/01-04. A failed query or mutation was recorded as one kind, + // APPLICATION_QUERY_ERROR, whatever it was; an unexpected throw lost the + // definition it came from. + it("names the failure's kind in the cache diagnostics", async () => { + const record = vi.fn(); + const client = createQueryClient({ diagnostics: { record } }); + renderHook( + () => + useApplicationQuery({ + queryKey: ["resource", "missing"], + execute: async () => ({ ok: false, error: createFailure("NOT_FOUND", "GET", 0) }), + }), + { wrapper: wrapper(client) }, + ); + + await waitFor(() => expect(record).toHaveBeenCalled()); + expect(record.mock.calls[0]?.[0]).toMatchObject({ + eventId: "cache.operation.failed", + context: { operation: "query", error_kind: "NOT_FOUND" }, + }); + }); + + it("names the query definition of an unexpected throw", async () => { + const hook = renderHook( + () => + useApplicationQuery({ + queryKey: ["resource", "throws"], + definitionId: "resource-list-v1", + execute: async () => { + throw new Error("boom"); + }, + } as Parameters>[0]), + { wrapper: wrapper(queryClient()) }, + ); + + await waitFor(() => expect(hook.result.current.state.failure).toBeDefined()); + expect(hook.result.current.state.failure?.operationId).toBe("resource-list-v1"); + }); +});