Skip to content

Commit 2f14491

Browse files
tellahoCarl
authored andcommitted
fix(link-preview): make metadata leases idempotent
Co-authored-by: Carl <acda9e433d19dcd0e6b6840f7f4b98f3a56f1fab98049d444c087019e6d36560@buzz.block.builderlab.xyz> Signed-off-by: Taylor Ho <[email protected]>
1 parent c801200 commit 2f14491

3 files changed

Lines changed: 95 additions & 4 deletions

File tree

‎desktop/src/features/messages/lib/linkPreviewPreparationStore.ts‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,11 +116,19 @@ async function buildSnapshot(
116116
onMetadataReady: (tag: string[]) => void,
117117
): Promise<string[] | null> {
118118
const metadataLoad = loadLinkPreviewMetadata(candidate.href);
119-
const cancelMetadata = () => metadataLoad.cancel();
119+
let settleAbortedMetadata: (() => void) | null = null;
120+
const abortedMetadata = new Promise<null>((resolve) => {
121+
settleAbortedMetadata = () => resolve(null);
122+
});
123+
const cancelMetadata = () => {
124+
metadataLoad.cancel();
125+
settleAbortedMetadata?.();
126+
};
120127
signal.addEventListener("abort", cancelMetadata, { once: true });
128+
if (signal.aborted) cancelMetadata();
121129
let metadata: LinkPreviewMetadata | null;
122130
try {
123-
metadata = await metadataLoad.promise;
131+
metadata = await Promise.race([metadataLoad.promise, abortedMetadata]);
124132
} catch {
125133
return null;
126134
} finally {

‎desktop/src/shared/lib/useResolvedLinkPreviews.test.mjs‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import { JSDOM } from "jsdom";
66
import {
77
__linkPreviewMetadataTest,
88
fetchBuzzEntityMetadata,
9+
loadLinkPreviewMetadata,
910
isBuzzEntityPreview,
1011
resetLinkPreviewMetadataCache,
1112
resolveLinkPreview,
@@ -33,6 +34,16 @@ function metadata(overrides = {}) {
3334
};
3435
}
3536

37+
function deferred() {
38+
let reject;
39+
let resolve;
40+
const promise = new Promise((resolvePromise, rejectPromise) => {
41+
reject = rejectPromise;
42+
resolve = resolvePromise;
43+
});
44+
return { promise, reject, resolve };
45+
}
46+
3647
test("pending external metadata reserves the image treatment", () => {
3748
assert.deepEqual(resolveLinkPreview(preview, undefined), {
3849
...preview,
@@ -976,6 +987,69 @@ test("hook clears a re-entered negative even when the shared cache holds an in-f
976987
}
977988
});
978989

990+
test("preparation abort releases only its own shared metadata lease", async () => {
991+
const { prepareLinkPreview, resetLinkPreviewPreparations } = await import(
992+
"../../features/messages/lib/linkPreviewPreparationStore.ts"
993+
);
994+
995+
resetLinkPreviewMetadataCache();
996+
resetLinkPreviewPreparations();
997+
ipcHandlers.clear();
998+
999+
const href = "https://example.com/shared-pending";
1000+
let fetchRequest;
1001+
const cancelledRequestIds = [];
1002+
ipcHandlers.set("fetch_link_preview_metadata", (args) => {
1003+
const request = deferred();
1004+
fetchRequest = { ...args, ...request };
1005+
return request.promise;
1006+
});
1007+
ipcHandlers.set("cancel_link_preview_metadata", ({ requestId }) => {
1008+
cancelledRequestIds.push(requestId);
1009+
return Promise.resolve();
1010+
});
1011+
ipcHandlers.set("release_link_preview_metadata", () => Promise.resolve());
1012+
1013+
try {
1014+
const composerLoad = loadLinkPreviewMetadata(href);
1015+
const preparation = prepareLinkPreview({ ...hookPreview, href });
1016+
await new Promise((resolve) => setImmediate(resolve));
1017+
assert.ok(fetchRequest, "shared metadata reached the native fetch seam");
1018+
1019+
resetLinkPreviewPreparations();
1020+
assert.equal(await preparation, null);
1021+
await new Promise((resolve) => setTimeout(resolve, 1_050));
1022+
assert.deepEqual(
1023+
cancelledRequestIds,
1024+
[],
1025+
"preparation listener plus finally must not release the composer lease",
1026+
);
1027+
1028+
fetchRequest.resolve(metadata());
1029+
assert.deepEqual(await composerLoad.promise, metadata());
1030+
1031+
const finalHref = `${href}/final`;
1032+
const finalLoad = loadLinkPreviewMetadata(finalHref);
1033+
await new Promise((resolve) => setImmediate(resolve));
1034+
const finalRequest = fetchRequest;
1035+
const finalRejection = assert.rejects(finalLoad.promise);
1036+
finalLoad.cancel();
1037+
finalLoad.cancel();
1038+
await new Promise((resolve) => setTimeout(resolve, 1_050));
1039+
assert.deepEqual(
1040+
cancelledRequestIds,
1041+
[finalRequest.requestId],
1042+
"one final consumer release permits native abort",
1043+
);
1044+
finalRequest.reject(new Error("cancelled by test native seam"));
1045+
await finalRejection;
1046+
} finally {
1047+
resetLinkPreviewPreparations();
1048+
resetLinkPreviewMetadataCache();
1049+
ipcHandlers.clear();
1050+
}
1051+
});
1052+
9791053
test("removing two stalled previews cancels native work and admits a third URL", async () => {
9801054
const { act, cleanup, renderHook } = await import("@testing-library/react");
9811055
const { useResolvedLinkPreviews } = await import(

‎desktop/src/shared/lib/useResolvedLinkPreviews.ts‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,15 @@ function createMetadataLoader({
229229
);
230230
};
231231

232+
const createRelease = (key: string, pending: PendingMetadataLoad) => {
233+
let released = false;
234+
return () => {
235+
if (released) return;
236+
released = true;
237+
release(key, pending);
238+
};
239+
};
240+
232241
const abortOrphanedLoads = (exceptKey: string) => {
233242
for (const [key, cached] of cache) {
234243
if (
@@ -251,7 +260,7 @@ function createMetadataLoader({
251260
cached.orphanTimer = null;
252261
cached.consumers += 1;
253262
return {
254-
cancel: () => release(key, cached),
263+
cancel: createRelease(key, cached),
255264
promise: cached.promise,
256265
};
257266
}
@@ -304,7 +313,7 @@ function createMetadataLoader({
304313
});
305314
cache.set(key, pending);
306315
return {
307-
cancel: () => release(key, pending),
316+
cancel: createRelease(key, pending),
308317
promise: pending.promise,
309318
};
310319
};

0 commit comments

Comments
 (0)