fix(query): stale 실패를 렌더 중에 계산하고 실패 진단이 원인을 남긴다
frontend-quality-gates / merge / static checks (pull_request) Successful in 2m26s
frontend-quality-gates / merge / tests (pull_request) Failing after 15m50s
frontend-quality-gates / merge / browser tests (pull_request) Successful in 11m10s
frontend-quality-gates / FE-GATE-017 / diagram-review (pull_request) Skipped
frontend-quality-gates / main / checker self-tests (pull_request) Skipped
frontend-quality-gates / FE-GATE-014 / config-compatibility (pull_request) Skipped
frontend-quality-gates / FE-GATE-028 / manual-accessibility-review (pull_request) Skipped
frontend-quality-gates / FE-GATE-026 / lab-performance (pull_request) Skipped
frontend-quality-gates / FE-GATE-015 / immutable-release-candidate (pull_request) Skipped
frontend-quality-gates / external-vulnerability-provider (pull_request) Skipped
frontend-quality-gates / external-provenance-provider (pull_request) Skipped
frontend-quality-gates / promote-verified-immutable-candidate (pull_request) Skipped
frontend-quality-gates / deploy-promoted-release (pull_request) Skipped
frontend-quality-gates / FE-GATE-019 / hosting-header (pull_request) Skipped
frontend-quality-gates / FE-GATE-021 / runbook-boot-config (pull_request) Skipped
frontend-quality-gates / FE-GATE-022 / runbook-chunk-mismatch (pull_request) Skipped
frontend-quality-gates / FE-GATE-023 / runbook-api-degradation (pull_request) Skipped
frontend-quality-gates / FE-GATE-024 / runbook-telemetry (pull_request) Skipped
frontend-quality-gates / FE-GATE-025 / runbook-release-rollback (pull_request) Skipped
frontend-quality-gates / FE-GATE-018 / field-web-vitals (pull_request) Skipped
frontend-quality-gates / merge / static checks (pull_request) Successful in 2m26s
frontend-quality-gates / merge / tests (pull_request) Failing after 15m50s
frontend-quality-gates / merge / browser tests (pull_request) Successful in 11m10s
frontend-quality-gates / FE-GATE-017 / diagram-review (pull_request) Skipped
frontend-quality-gates / main / checker self-tests (pull_request) Skipped
frontend-quality-gates / FE-GATE-014 / config-compatibility (pull_request) Skipped
frontend-quality-gates / FE-GATE-028 / manual-accessibility-review (pull_request) Skipped
frontend-quality-gates / FE-GATE-026 / lab-performance (pull_request) Skipped
frontend-quality-gates / FE-GATE-015 / immutable-release-candidate (pull_request) Skipped
frontend-quality-gates / external-vulnerability-provider (pull_request) Skipped
frontend-quality-gates / external-provenance-provider (pull_request) Skipped
frontend-quality-gates / promote-verified-immutable-candidate (pull_request) Skipped
frontend-quality-gates / deploy-promoted-release (pull_request) Skipped
frontend-quality-gates / FE-GATE-019 / hosting-header (pull_request) Skipped
frontend-quality-gates / FE-GATE-021 / runbook-boot-config (pull_request) Skipped
frontend-quality-gates / FE-GATE-022 / runbook-chunk-mismatch (pull_request) Skipped
frontend-quality-gates / FE-GATE-023 / runbook-api-degradation (pull_request) Skipped
frontend-quality-gates / FE-GATE-024 / runbook-telemetry (pull_request) Skipped
frontend-quality-gates / FE-GATE-025 / runbook-release-rollback (pull_request) Skipped
frontend-quality-gates / FE-GATE-018 / field-web-vitals (pull_request) Skipped
useApplicationQuery가 "데이터가 있고 마지막 조회가 실패했다"는 파생 값을 effect로 state에 복사한다. 다시 시도가 그 값을 지운 뒤 refetch해도, 조회 중에 effect가 다시 돌아 true로 되돌린다. 그래서 낡은 데이터의 다시 시도가 진행 중에도 지난 실패(stale-degraded)를 보인다(1112/01-05). query·mutation 실패 진단은 원인을 버린다. cache의 onError가 모든 실패를 cache.operation.failed로 남기는데, ApplicationQueryError에 kind가 없어 safeErrorKind가 이름(APPLICATION_QUERY_ERROR)을 쓴다. 404, 필드 거절, abort가 한 가지로 남는다. 예상 밖 throw는 정의 이름 대신 고정 문자열 (APPLICATION_QUERY, APPLICATION_MUTATION)을 쓴다(1112/01-04). 고른 방법: staleFailure를 query.isError && hasData && !isFetching으로 렌더 중에 계산하고 state와 effect를 지운다. 다시 시도 중은 refreshing이다. ApplicationQueryError가 failure.kind를 kind로 싣는다. 예상 밖 throw는 query 정의 ID와 mutation 정의 ID를 쓰고, 정의가 없는 legacy mutation만 옛 이름을 둔다. 버린 대안: cache onError가 ApplicationQueryError를 아예 세지 않기 (서버 실패를 cache 진단에서 잃는다). 위험·한계: 낡은 데이터의 배경 재조회 중에도 stale 대신 refreshing을 보인다. 진단 error_kind 값이 바뀌어 그 값을 읽는 대시보드가 있으면 바꿔야 한다(템플릿 안에는 없다). 검증: tests/component/application-query-bridge.test.tsx의 새 시험 셋이 고치기 전 코드에서 실패하고 고친 뒤 통과한다(desktop, PR 본문). Refs: 1112/01-04, 1112/01-05
This commit is contained in:
@@ -53,11 +53,17 @@ export type ApplicationResult<Value> = Result<Value>;
|
||||
|
||||
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<Value>(
|
||||
"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<Value>(
|
||||
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<Value>(
|
||||
},
|
||||
});
|
||||
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<Input, Value>(
|
||||
"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<Input, Value>(
|
||||
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<Input, Value>(
|
||||
.catch((error: unknown) => {
|
||||
const failure = withFailureEffect(
|
||||
normalizeUnknownFailure(error, {
|
||||
operationId: "APPLICATION_MUTATION",
|
||||
operationId: failureOperationId,
|
||||
}),
|
||||
"NOT_STARTED",
|
||||
);
|
||||
@@ -794,6 +802,7 @@ export function useApplicationMutation<Input, Value>(
|
||||
queryClient,
|
||||
definitionId,
|
||||
duplicatePolicy,
|
||||
failureOperationId,
|
||||
mutationIntentFactory,
|
||||
mutationOperationId,
|
||||
requiresIdempotencyKey,
|
||||
|
||||
@@ -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<string[]>) => void) | undefined;
|
||||
const execute = vi
|
||||
.fn<() => Promise<ApplicationResult<string[]>>>()
|
||||
.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<typeof useApplicationQuery<string[]>>[0]),
|
||||
{ wrapper: wrapper(queryClient()) },
|
||||
);
|
||||
|
||||
await waitFor(() => expect(hook.result.current.state.failure).toBeDefined());
|
||||
expect(hook.result.current.state.failure?.operationId).toBe("resource-list-v1");
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user