Skip to content

Commit 6ff24d9

Browse files
authored
fix(contracts): normalize rejected cleanup in durable resource disposal (#4346)
* fix(contracts): normalize rejected cleanup in durable resource disposal The shared asyncDispose adapter let a rejection from the cleanup operation escape raw. Treat it as a cleanup-pending outcome so the facet raises its typed error, and keep the original rejection as cause. Fixes #4334 * fix(contracts): keep disposal normalization total for non-Error rejections String() throws for values such as Object.create(null), which let a TypeError escape disposal. Non-Error rejections now keep the facet's default message and the raw value as cause. Drop the unused cause parameter from the perf capture assertion: its cleanup already converts rejections into a cleanup-pending outcome, so forceCleanup() keeps returning outcomes. Remove the stale #4334 drift note from the durable resource recovery contract. * test(capture-kit): pin the default message for non-Error cleanup rejections
1 parent 8ae54a0 commit 6ff24d9

8 files changed

Lines changed: 82 additions & 16 deletions

‎packages/capture-kit/docs/durable-resource-recovery.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ A durable start returns a process-local live handle and a bounded, JSON-safe, ve
44
The facet-specific handle provides idempotent `finish()` returning `FinishOutcome`, `forceCleanup()` returning `CleanupOutcome`, and an idempotent `[Symbol.asyncDispose]` adapter that carries no typed result.
55
The adapter resolves only for confirmed cleanup or already-missing outcomes.
66
Otherwise, it rejects with a normalized `ownership-lost` or `cleanup-pending` error.
7-
Known drift: today a rejected cleanup operation escapes the shared adapter without normalization (#4334).
87

98
Each destructive finish or cleanup holds the authoritative ownership lease across fence validation, native side effect, and persisted transition, or uses a token atomically enforced by the native or provider operation.
109
A preflight check alone is insufficient.

‎packages/capture-kit/src/app-log-live-handle.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export function createAppLogLiveHandleFromFinish(
4848
});
4949
}
5050

51-
function assertConfirmedCleanup(outcome: CleanupOutcome): void {
51+
function assertConfirmedCleanup(outcome: CleanupOutcome, cause?: unknown): void {
5252
if (isConfirmedCleanup(outcome)) return;
5353
throw new AppError(
5454
'COMMAND_FAILED',
@@ -61,5 +61,6 @@ function assertConfirmedCleanup(outcome: CleanupOutcome): void {
6161
? 'Use the current resource owner or recovery record before retrying cleanup.'
6262
: 'Keep the recovery record and retry cleanup through the exact runtime owner.',
6363
},
64+
cause,
6465
);
6566
}

‎packages/capture-kit/src/app-log-runtime.test.ts‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,50 @@ test('app-log async disposal rejects when forced cleanup remains unconfirmed', a
9898
);
9999
});
100100

101+
test('app-log async disposal normalizes a rejected cleanup and keeps its cause', async () => {
102+
const transportError = new Error('transport closed');
103+
const cleanup = vi
104+
.fn<() => Promise<{ status: 'cleaned' }>>()
105+
.mockRejectedValueOnce(transportError)
106+
.mockResolvedValueOnce({ status: 'cleaned' });
107+
const handle = createAppLogLiveHandle({
108+
inspect: () => ({ backend: 'android', state: 'failed', startedAt: 12 }),
109+
finish: async () => ({ status: 'completed', result: completion }),
110+
forceCleanup: cleanup,
111+
});
112+
113+
await assert.rejects(
114+
async () => await handle[Symbol.asyncDispose](),
115+
(error: unknown) =>
116+
error instanceof AppError &&
117+
error.details?.reason === 'cleanup-unconfirmed' &&
118+
error.details.retriable === true &&
119+
error.cause === transportError,
120+
);
121+
await handle[Symbol.asyncDispose]();
122+
assert.equal(cleanup.mock.calls.length, 2);
123+
});
124+
125+
test('app-log async disposal normalizes a rejected cleanup whose value has no string form', async () => {
126+
const rejection: unknown = Object.create(null);
127+
const handle = createAppLogLiveHandle({
128+
inspect: () => ({ backend: 'android', state: 'failed', startedAt: 12 }),
129+
finish: async () => ({ status: 'completed', result: completion }),
130+
forceCleanup: async () => {
131+
throw rejection;
132+
},
133+
});
134+
135+
await assert.rejects(
136+
async () => await handle[Symbol.asyncDispose](),
137+
(error: unknown) =>
138+
error instanceof AppError &&
139+
error.details?.reason === 'cleanup-unconfirmed' &&
140+
error.message === 'Durable resource cleanup could not be confirmed' &&
141+
error.cause === rejection,
142+
);
143+
});
144+
101145
test('app-log start result retains pending ownership until explicit transfer', async () => {
102146
let cleanupCount = 0;
103147
const handle = createAppLogLiveHandle({

‎packages/capture-kit/src/audio-probe-runtime.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ async function terminateForCleanup(process: HostAudioCaptureProcess): Promise<Cl
190190
}
191191
}
192192

193-
function assertConfirmedAudioProbeCleanup(outcome: CleanupOutcome): void {
193+
function assertConfirmedAudioProbeCleanup(outcome: CleanupOutcome, cause?: unknown): void {
194194
if (isConfirmedCleanup(outcome)) return;
195195
throw new AppError(
196196
'COMMAND_FAILED',
@@ -200,6 +200,7 @@ function assertConfirmedAudioProbeCleanup(outcome: CleanupOutcome): void {
200200
retriable: outcome.reason !== 'ownership-fence-lost',
201201
hint: 'Keep audio-probe.resource.json and retry stop through its exact runtime owner.',
202202
},
203+
cause,
203204
);
204205
}
205206

‎packages/capture-kit/src/durable-capture/recovery-authority.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ test('late handle cleanup failure does not skip control disposal when diagnostic
235235
expect(forceCleanup).toHaveBeenCalledOnce();
236236
expect(cleanupFailures).toHaveBeenCalledWith(
237237
'late_handle_cleanup_failed',
238-
cleanupError,
238+
expect.objectContaining({ cause: cleanupError }),
239239
primaryError,
240240
);
241241
expect(disposeControl).toHaveBeenCalledOnce();
@@ -312,7 +312,7 @@ test('aborted recovery does not skip control disposal when late handle diagnosti
312312
expect(primaryError).toBe(cancellation);
313313
expect(cleanupFailures).toHaveBeenCalledWith(
314314
'late_handle_cleanup_failed',
315-
cleanupError,
315+
expect.objectContaining({ cause: cleanupError }),
316316
cancellation,
317317
);
318318
expect(disposeControl).toHaveBeenCalledOnce();

‎packages/capture-kit/src/screen-recording-live-handle.test.ts‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,22 @@ test.each(['rejected', 'unconfirmed'] as const)(
88
'disposal retries %s cleanup and stays inert after confirmation',
99
async (failure) => {
1010
const cleanup = vi.fn<() => Promise<CleanupOutcome>>().mockResolvedValue({ status: 'cleaned' });
11-
if (failure === 'rejected')
12-
cleanup.mockRejectedValueOnce(
13-
new AppError('COMMAND_FAILED', 'Transport unavailable', { reason: 'transport-failed' }),
14-
);
11+
const transportError = new AppError('COMMAND_FAILED', 'Transport unavailable', {
12+
reason: 'transport-failed',
13+
});
14+
if (failure === 'rejected') cleanup.mockRejectedValueOnce(transportError);
1515
else cleanup.mockResolvedValueOnce({ status: 'cleanup-pending', reason: 'transport-failed' });
1616
const finish = vi.fn(async () => completed());
1717
const handle = createScreenRecordingLiveHandle(snapshot(), { finish, forceCleanup: cleanup });
18-
await expect(Promise.resolve(handle[Symbol.asyncDispose]())).rejects.toMatchObject({
19-
code: 'COMMAND_FAILED',
20-
details: { reason: 'transport-failed' },
21-
});
18+
await expect(Promise.resolve(handle[Symbol.asyncDispose]())).rejects.toMatchObject(
19+
failure === 'rejected'
20+
? {
21+
code: 'COMMAND_FAILED',
22+
details: { reason: 'cleanup-unconfirmed' },
23+
cause: transportError,
24+
}
25+
: { code: 'COMMAND_FAILED', details: { reason: 'transport-failed' } },
26+
);
2227
handle.appendGestureEvents([{ kind: 'tap', tMs: 3, x: 4, y: 5 }]);
2328
assert.deepEqual(handle.inspect().gestureEvents, []);
2429
await Promise.all([handle[Symbol.asyncDispose](), handle[Symbol.asyncDispose]()]);

‎packages/capture-kit/src/screen-recording-live-handle.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ function freezeSnapshot(snapshot: ScreenRecordingLiveSnapshot): ScreenRecordingL
9494
return Object.freeze({ ...snapshot, gestureEvents: Object.freeze([...snapshot.gestureEvents]) });
9595
}
9696

97-
function assertConfirmedCleanup(outcome: CleanupOutcome): void {
97+
function assertConfirmedCleanup(outcome: CleanupOutcome, cause?: unknown): void {
9898
if (isConfirmedCleanup(outcome)) return;
9999
throw new AppError(
100100
'COMMAND_FAILED',
@@ -107,5 +107,6 @@ function assertConfirmedCleanup(outcome: CleanupOutcome): void {
107107
? 'Use the current recording owner or recovery record before retrying cleanup.'
108108
: 'Keep the recovery record and retry cleanup through the exact runtime owner.',
109109
},
110+
cause,
110111
);
111112
}

‎packages/contracts/src/durable-resource.ts‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export function isConfirmedCleanup(
7070
/** Shares in-flight cleanup and retains only confirmed release across cleanup and disposal. */
7171
export function createRetryableCleanup(
7272
clean: () => Promise<CleanupOutcome>,
73-
assertConfirmed: (outcome: CleanupOutcome) => void,
73+
assertConfirmed: (outcome: CleanupOutcome, cause?: unknown) => void,
7474
) {
7575
let cleanup: Promise<CleanupOutcome> | undefined;
7676
const forceCleanup = (): Promise<CleanupOutcome> =>
@@ -86,6 +86,21 @@ export function createRetryableCleanup(
8686
));
8787
return {
8888
forceCleanup,
89-
[Symbol.asyncDispose]: async () => assertConfirmed(await forceCleanup()),
89+
[Symbol.asyncDispose]: async () => {
90+
// A rejected cleanup confirms nothing, so disposal reports it as cleanup-pending.
91+
const { outcome, cause } = await forceCleanup().then(
92+
(confirmed) => ({ outcome: confirmed, cause: undefined }),
93+
(error: unknown) => ({
94+
outcome: {
95+
status: 'cleanup-pending',
96+
reason: 'cleanup-unconfirmed',
97+
// Non-Error rejections keep the facet's default message; `cause` keeps the raw value.
98+
message: error instanceof Error ? error.message : undefined,
99+
} as const,
100+
cause: error,
101+
}),
102+
);
103+
assertConfirmed(outcome, cause);
104+
},
90105
};
91106
}

0 commit comments

Comments
 (0)