Skip to content

Commit c801200

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

8 files changed

Lines changed: 593 additions & 74 deletions

File tree

‎desktop/src-tauri/src/commands/link_preview.rs‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ use reqwest::{
1010
use serde::Serialize;
1111
use url::Url;
1212

13+
#[path = "link_preview_cancellation.rs"]
14+
mod cancellation;
1315
#[path = "link_preview_image_retry.rs"]
1416
mod image_retry;
1517
#[path = "link_preview_rate_limit.rs"]
@@ -59,8 +61,32 @@ pub struct LinkPreviewMetadata {
5961
#[tauri::command]
6062
pub async fn fetch_link_preview_metadata(
6163
href: String,
64+
request_id: Option<String>,
6265
) -> Result<Option<LinkPreviewMetadata>, String> {
63-
fetch_link_preview_metadata_for_url(href).await
66+
let cancellation = cancellation::begin(request_id.as_deref());
67+
let result = match cancellation {
68+
Some(cancellation) => {
69+
tokio::select! {
70+
result = fetch_link_preview_metadata_for_url(href) => result,
71+
() = cancellation.cancelled() => Err("link preview request cancelled".to_string()),
72+
}
73+
}
74+
None => fetch_link_preview_metadata_for_url(href).await,
75+
};
76+
cancellation::finish(request_id.as_deref());
77+
result
78+
}
79+
80+
/// Cancel renderer-owned metadata work, including an in-flight response body.
81+
#[tauri::command]
82+
pub fn cancel_link_preview_metadata(request_id: String) {
83+
cancellation::cancel(&request_id);
84+
}
85+
86+
/// Release a renderer's cancellation record after its invocation settles.
87+
#[tauri::command]
88+
pub fn release_link_preview_metadata(request_id: String) {
89+
cancellation::finish(Some(&request_id));
6490
}
6591

6692
async fn fetch_link_preview_metadata_for_url(
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
use std::{
2+
collections::HashMap,
3+
sync::{LazyLock, Mutex},
4+
};
5+
6+
use tokio_util::sync::CancellationToken;
7+
8+
#[derive(Default)]
9+
struct LinkPreviewCancellations {
10+
tokens: HashMap<String, CancellationToken>,
11+
}
12+
13+
impl LinkPreviewCancellations {
14+
fn begin(&mut self, request_id: &str) -> CancellationToken {
15+
if let Some(cancellation) = self.tokens.get(request_id).cloned() {
16+
return cancellation;
17+
}
18+
let cancellation = CancellationToken::new();
19+
self.tokens
20+
.insert(request_id.to_string(), cancellation.clone());
21+
cancellation
22+
}
23+
24+
fn cancel(&mut self, request_id: &str) {
25+
self.tokens
26+
.entry(request_id.to_string())
27+
.or_default()
28+
.cancel();
29+
}
30+
31+
fn finish(&mut self, request_id: &str) {
32+
self.tokens.remove(request_id);
33+
}
34+
}
35+
36+
static LINK_PREVIEW_CANCELLATIONS: LazyLock<Mutex<LinkPreviewCancellations>> =
37+
LazyLock::new(|| Mutex::new(LinkPreviewCancellations::default()));
38+
39+
pub(super) fn begin(request_id: Option<&str>) -> Option<CancellationToken> {
40+
let request_id = request_id?;
41+
LINK_PREVIEW_CANCELLATIONS
42+
.lock()
43+
.ok()
44+
.map(|mut fetches| fetches.begin(request_id))
45+
}
46+
47+
pub(super) fn cancel(request_id: &str) {
48+
if let Ok(mut fetches) = LINK_PREVIEW_CANCELLATIONS.lock() {
49+
fetches.cancel(request_id);
50+
}
51+
}
52+
53+
pub(super) fn finish(request_id: Option<&str>) {
54+
let Some(request_id) = request_id else {
55+
return;
56+
};
57+
if let Ok(mut fetches) = LINK_PREVIEW_CANCELLATIONS.lock() {
58+
fetches.finish(request_id);
59+
}
60+
}
61+
62+
#[cfg(test)]
63+
mod tests {
64+
use super::*;
65+
66+
#[test]
67+
fn cancellation_before_begin_is_retained() {
68+
let mut fetches = LinkPreviewCancellations::default();
69+
fetches.cancel("cancel-before-begin");
70+
71+
let cancellation = fetches.begin("cancel-before-begin");
72+
73+
assert!(cancellation.is_cancelled());
74+
fetches.finish("cancel-before-begin");
75+
assert!(fetches.tokens.is_empty());
76+
}
77+
78+
#[test]
79+
fn cancellation_reaches_active_owner() {
80+
let mut fetches = LinkPreviewCancellations::default();
81+
let cancellation = fetches.begin("active-fetch");
82+
83+
fetches.cancel("active-fetch");
84+
85+
assert!(cancellation.is_cancelled());
86+
fetches.finish("active-fetch");
87+
assert!(fetches.tokens.is_empty());
88+
}
89+
}

‎desktop/src-tauri/src/commands/link_preview_tests.rs‎

Lines changed: 53 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
use super::rate_limit::MAX_IMAGE_RETRY_AFTER;
22
use super::{
3-
apply_image_result, declares_animation, extract_favicon_url, extract_image_url,
4-
extract_link_preview_metadata, fetch_link_preview_metadata, fetch_sanitized_image_using,
5-
is_html_response, read_bytes_prefix, retry_after_duration, retryable_image_cooldown,
6-
sanitize_image, ImageFetchError, LinkPreviewImageFetchState, LinkPreviewMetadata,
7-
MAX_INLINE_IMAGE_COOLDOWN, MAX_METADATA_DESCRIPTION_CHARS,
3+
apply_image_result, cancel_link_preview_metadata, declares_animation, extract_favicon_url,
4+
extract_image_url, extract_link_preview_metadata, fetch_link_preview_metadata,
5+
fetch_sanitized_image_using, is_html_response, read_bytes_prefix, retry_after_duration,
6+
retryable_image_cooldown, sanitize_image, ImageFetchError, LinkPreviewImageFetchState,
7+
LinkPreviewMetadata, MAX_INLINE_IMAGE_COOLDOWN, MAX_METADATA_DESCRIPTION_CHARS,
88
};
99
use axum::{body::Body, http::Response, routing::get, Router};
1010
use base64::Engine as _;
@@ -66,7 +66,7 @@ async fn metadata_pipeline_remains_pending_beyond_former_aggregate_deadline() {
6666
.await;
6767
let fetch = tokio::spawn(super::METADATA_TEST_SERVER.scope(
6868
address,
69-
fetch_link_preview_metadata("https://user-paced.example/preview".to_string()),
69+
fetch_link_preview_metadata("https://user-paced.example/preview".to_string(), None),
7070
));
7171

7272
request_started_rx.await.unwrap();
@@ -78,6 +78,53 @@ async fn metadata_pipeline_remains_pending_beyond_former_aggregate_deadline() {
7878
assert_eq!(metadata.title, "User-paced metadata");
7979
}
8080

81+
#[tokio::test]
82+
async fn metadata_command_cancellation_drops_an_in_flight_response() {
83+
let (request_started_tx, request_started_rx) = oneshot::channel::<()>();
84+
let request_started_tx = Arc::new(Mutex::new(Some(request_started_tx)));
85+
let (_release_response_tx, release_response_rx) = oneshot::channel::<()>();
86+
let release_response_rx = Arc::new(Mutex::new(Some(release_response_rx)));
87+
let address = start_test_server(Router::new().route(
88+
"/preview",
89+
get(move || {
90+
let request_started_tx = Arc::clone(&request_started_tx);
91+
let release_response_rx = Arc::clone(&release_response_rx);
92+
async move {
93+
request_started_tx
94+
.lock()
95+
.unwrap()
96+
.take()
97+
.unwrap()
98+
.send(())
99+
.unwrap();
100+
let release_response_rx = release_response_rx.lock().unwrap().take().unwrap();
101+
let _ = release_response_rx.await;
102+
Response::builder()
103+
.header("content-type", "text/html")
104+
.body(Body::from("<title>Too late</title>"))
105+
.unwrap()
106+
}
107+
}),
108+
))
109+
.await;
110+
let request_id = "cancel-in-flight".to_string();
111+
let fetch = tokio::spawn(super::METADATA_TEST_SERVER.scope(
112+
address,
113+
fetch_link_preview_metadata(
114+
"https://cancel.example/preview".to_string(),
115+
Some(request_id.clone()),
116+
),
117+
));
118+
119+
request_started_rx.await.unwrap();
120+
cancel_link_preview_metadata(request_id);
121+
122+
assert_eq!(
123+
fetch.await.unwrap(),
124+
Err("link preview request cancelled".to_string())
125+
);
126+
}
127+
81128
#[tokio::test(start_paused = true)]
82129
async fn first_rate_limit_and_queued_host_request_share_one_cooldown_boundary() {
83130
let cooldown = std::time::Duration::from_secs(20);

‎desktop/src-tauri/src/lib.rs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -600,6 +600,8 @@ pub fn run() {
600600
get_relay_http_url,
601601
get_media_proxy_port,
602602
fetch_link_preview_metadata,
603+
cancel_link_preview_metadata,
604+
release_link_preview_metadata,
603605
discover_acp_auth_methods,
604606
discover_acp_providers,
605607
discover_git_bash_prerequisite,

‎desktop/src/features/messages/lib/linkPreviewPreparationStore.test.mjs‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,3 +272,18 @@ test("reset cancels pending preparations instead of authorizing send", async ()
272272

273273
assert.deepEqual(await preparation.promise, { status: "cancelled" });
274274
});
275+
276+
test("Skip aborts an abandoned in-flight preview job", async () => {
277+
const pending = deferred();
278+
seed(first, pending.promise);
279+
const job = __linkPreviewPreparationTest.jobs.get(first.href);
280+
281+
const preparation = prepareBackgroundLinkPreviews([first], 1_000);
282+
assert.ok(preparation);
283+
preparation.skip();
284+
285+
assert.deepEqual(await preparation.promise, { status: "ready", tags: [] });
286+
assert.equal(job.controller.signal.aborted, true);
287+
assert.equal(__linkPreviewPreparationTest.jobs.has(first.href), false);
288+
pending.resolve(null);
289+
});

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

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import {
99
} from "@/shared/lib/linkPreviewSnapshot";
1010
import {
1111
loadLinkPreviewMetadata,
12+
type LinkPreviewMetadata,
1213
resolveLinkPreview,
1314
} from "@/shared/lib/useResolvedLinkPreviews";
1415

@@ -27,6 +28,7 @@ type PreviewJob = {
2728

2829
type BackgroundPreviewTask = {
2930
cancel: () => void;
31+
hrefs: Set<string>;
3032
id: number;
3133
skip: () => void;
3234
};
@@ -113,7 +115,18 @@ async function buildSnapshot(
113115
signal: AbortSignal,
114116
onMetadataReady: (tag: string[]) => void,
115117
): Promise<string[] | null> {
116-
const metadata = await loadLinkPreviewMetadata(candidate.href);
118+
const metadataLoad = loadLinkPreviewMetadata(candidate.href);
119+
const cancelMetadata = () => metadataLoad.cancel();
120+
signal.addEventListener("abort", cancelMetadata, { once: true });
121+
let metadata: LinkPreviewMetadata | null;
122+
try {
123+
metadata = await metadataLoad.promise;
124+
} catch {
125+
return null;
126+
} finally {
127+
signal.removeEventListener("abort", cancelMetadata);
128+
metadataLoad.cancel();
129+
}
117130
if (signal.aborted || !metadata) return null;
118131
const preview = resolveLinkPreview(candidate, metadata);
119132
if (!preview.snapshotReady) return null;
@@ -288,24 +301,42 @@ export function prepareBackgroundLinkPreviews(
288301
let finish: ((result: BackgroundLinkPreviewResult) => void) | null = null;
289302
let terminal = false;
290303
let timer: ReturnType<typeof setTimeout> | null = null;
291-
const complete = (result: BackgroundLinkPreviewResult) => {
304+
const complete = (
305+
result: BackgroundLinkPreviewResult,
306+
abortUnobservedJobs = false,
307+
) => {
292308
if (terminal) return;
293309
terminal = true;
294310
if (timer !== null) clearTimeout(timer);
295311
tasks.delete(taskId);
312+
if (abortUnobservedJobs) {
313+
for (const candidate of external) {
314+
const observedByAnotherSend = [...tasks.values()].some((task) =>
315+
task.hrefs.has(candidate.href),
316+
);
317+
if (!observedByAnotherSend) {
318+
invalidateLinkPreviewPreparation(candidate.href);
319+
}
320+
}
321+
}
296322
publishSnapshot();
297323
finish?.(result);
298324
};
299325
const promise = new Promise<BackgroundLinkPreviewResult>((resolve) => {
300326
finish = resolve;
301327
});
302-
const cancel = () => complete({ status: "cancelled" });
303-
const skip = () => complete({ status: "ready", tags: [] });
304-
tasks.set(taskId, { cancel, id: taskId, skip });
328+
const cancel = () => complete({ status: "cancelled" }, true);
329+
const skip = () => complete({ status: "ready", tags: [] }, true);
330+
tasks.set(taskId, {
331+
cancel,
332+
hrefs: new Set(external.map((candidate) => candidate.href)),
333+
id: taskId,
334+
skip,
335+
});
305336
publishSnapshot();
306337

307338
timer = setTimeout(
308-
() => complete({ status: "ready", tags: availableTags() }),
339+
() => complete({ status: "ready", tags: availableTags() }, true),
309340
timeoutMs,
310341
);
311342
void Promise.all(external.map(prepareLinkPreview)).then((tags) => {

0 commit comments

Comments
 (0)