fix: recover SSE connections on mobile tab visibility change (#204)

* fix: extend SSE result retention from 2 to 10 minutes for mobile recovery

* fix: check server health on tab visibility change for mobile recovery

* fix: recover feature install SSE on tab visibility change

* fix: reconnect SSE on tab visibility change in tool processor

* fix: reconnect SSE on tab visibility change in pipeline processor

* test: add visibility recovery tests for connection monitor
This commit is contained in:
SnapOtter
2026-06-05 22:28:24 +08:00
committed by GitHub
parent 01421640b5
commit 91e90b390e
6 changed files with 325 additions and 4 deletions
+1 -1
View File
@@ -194,7 +194,7 @@ export function updateSingleFileProgress(progress: Omit<SingleFileProgress, "typ
if (oldest) singleFileCompletions.delete(oldest);
}
singleFileCompletions.set(progress.jobId, event);
setTimeout(() => singleFileCompletions.delete(progress.jobId), 120_000);
setTimeout(() => singleFileCompletions.delete(progress.jobId), 600_000);
}
const subs = listeners.get(progress.jobId);
@@ -14,8 +14,15 @@ export function useConnectionMonitor() {
}
};
const handleVisibilityChange = () => {
if (document.visibilityState === "visible") {
store.getState().checkHealth();
}
};
window.addEventListener("offline", handleOffline);
window.addEventListener("online", handleOnline);
document.addEventListener("visibilitychange", handleVisibilityChange);
store.getState().checkHealth();
@@ -48,6 +55,7 @@ export function useConnectionMonitor() {
return () => {
window.removeEventListener("offline", handleOffline);
window.removeEventListener("online", handleOnline);
document.removeEventListener("visibilitychange", handleVisibilityChange);
store.getState().stopPolling();
unsubscribe();
};
+69 -1
View File
@@ -37,10 +37,71 @@ export function usePipelineProcessor() {
const xhrRef = useRef<XMLHttpRequest | null>(null);
const eventSourceRef = useRef<EventSource | null>(null);
const abortRef = useRef<AbortController | null>(null);
const activeJobIdRef = useRef<string | null>(null);
// Clean up on unmount
useEffect(() => {
const handleVisibilityChange = () => {
if (document.visibilityState !== "visible") return;
if (!activeJobIdRef.current) return;
if (eventSourceRef.current && eventSourceRef.current.readyState === EventSource.OPEN) {
return;
}
if (eventSourceRef.current) {
eventSourceRef.current.close();
eventSourceRef.current = null;
}
const jobId = activeJobIdRef.current;
setTimeout(() => {
if (!activeJobIdRef.current || activeJobIdRef.current !== jobId) return;
try {
const es = new EventSource(`/api/v1/jobs/${jobId}/progress`);
eventSourceRef.current = es;
es.onmessage = (event) => {
try {
const data = JSON.parse(event.data);
if (data.type === "single" && typeof data.percent === "number") {
const scaled = UPLOAD_WEIGHT + (data.percent / 100) * (100 - UPLOAD_WEIGHT);
setProgress((prev) => ({
...prev,
phase: "processing",
percent: Math.max(prev.percent, scaled),
stage: data.stage,
}));
}
if (data.type === "batch") {
const pct =
data.totalFiles > 0 ? 15 + (data.completedFiles / data.totalFiles) * 85 : 15;
setProgress((prev) => ({
...prev,
phase: "processing",
percent: pct,
stage: data.currentFile
? `Processing ${data.currentFile} (${data.completedFiles}/${data.totalFiles})`
: `Processing ${data.completedFiles}/${data.totalFiles}`,
}));
}
} catch {
// Ignore malformed SSE
}
};
es.onerror = () => {
es.close();
eventSourceRef.current = null;
};
} catch {
// EventSource creation failed
}
}, 500);
};
document.addEventListener("visibilitychange", handleVisibilityChange);
return () => {
document.removeEventListener("visibilitychange", handleVisibilityChange);
if (elapsedRef.current) clearInterval(elapsedRef.current);
if (eventSourceRef.current) eventSourceRef.current.close();
if (xhrRef.current) xhrRef.current.abort();
@@ -72,6 +133,7 @@ export function usePipelineProcessor() {
}, 1000);
const clientJobId = generateId();
activeJobIdRef.current = clientJobId;
// Open SSE for real-time progress from the server
try {
@@ -178,6 +240,7 @@ export function usePipelineProcessor() {
setProcessing(false);
setProgress(IDLE_PROGRESS);
activeJobIdRef.current = null;
};
xhr.onerror = () => {
@@ -189,6 +252,7 @@ export function usePipelineProcessor() {
setError("Network error - check your connection");
setProcessing(false);
setProgress(IDLE_PROGRESS);
activeJobIdRef.current = null;
};
xhr.ontimeout = () => {
@@ -200,6 +264,7 @@ export function usePipelineProcessor() {
setError("Request timed out - the server may be overloaded. Try again.");
setProcessing(false);
setProgress(IDLE_PROGRESS);
activeJobIdRef.current = null;
};
xhr.open("POST", "/api/v1/pipeline/execute");
@@ -234,6 +299,7 @@ export function usePipelineProcessor() {
}, 1000);
const clientJobId = generateId();
activeJobIdRef.current = clientJobId;
// Open SSE before upload for real-time progress
try {
@@ -355,6 +421,7 @@ export function usePipelineProcessor() {
setProcessing(false);
setProgress(IDLE_PROGRESS);
activeJobIdRef.current = null;
} catch (err) {
if (elapsedRef.current) clearInterval(elapsedRef.current);
if (eventSourceRef.current) {
@@ -364,6 +431,7 @@ export function usePipelineProcessor() {
setError(err instanceof Error ? err.message : "Batch processing failed");
setProcessing(false);
setProgress(IDLE_PROGRESS);
activeJobIdRef.current = null;
}
},
[processSingle, setProcessing, setError],
+126 -2
View File
@@ -47,20 +47,133 @@ export function useToolProcessor(toolId: string) {
const eventSourceRef = useRef<EventSource | null>(null);
const abortRef = useRef<AbortController | null>(null);
const stallTimerRef = useRef<ReturnType<typeof setTimeout> | null>(null);
const activeJobIdRef = useRef<string | null>(null);
const asyncModeRef = useRef(false);
const isAiTool = AI_PYTHON_TOOLS.has(toolId);
const toolName = TOOLS.find((t) => t.id === toolId)?.name ?? toolId;
// Clean up on unmount
const reconnectSSE = useCallback(() => {
const jobId = activeJobIdRef.current;
if (!jobId) return;
if (eventSourceRef.current && eventSourceRef.current.readyState === EventSource.OPEN) {
return;
}
if (eventSourceRef.current) {
eventSourceRef.current.close();
eventSourceRef.current = null;
}
try {
const es = new EventSource(`/api/v1/jobs/${jobId}/progress`);
eventSourceRef.current = es;
es.onmessage = (event) => {
try {
const data = JSON.parse(event.data);
if (data.type !== "single") return;
if (asyncModeRef.current && stallTimerRef.current) {
clearTimeout(stallTimerRef.current);
stallTimerRef.current = setTimeout(() => {
if (eventSourceRef.current) {
eventSourceRef.current.close();
eventSourceRef.current = null;
}
if (elapsedRef.current) clearInterval(elapsedRef.current);
activeJobIdRef.current = null;
setError(
"Processing timed out with no progress for 5 minutes. Try again or use a smaller image.",
);
setProcessing(false);
setProgress(IDLE_PROGRESS);
}, SSE_STALL_TIMEOUT_MS);
}
if (data.phase === "complete" && data.result) {
if (stallTimerRef.current) clearTimeout(stallTimerRef.current);
if (elapsedRef.current) clearInterval(elapsedRef.current);
es.close();
eventSourceRef.current = null;
activeJobIdRef.current = null;
const result = data.result as ProcessResult;
setWarning(result.warning ?? null);
const idx = useFileStore.getState().selectedIndex;
useFileStore.getState().updateEntry(idx, {
processedUrl: result.downloadUrl,
processedPreviewUrl: result.previewUrl ?? null,
processedFilename: null,
status: "completed",
originalSize: result.originalSize,
processedSize: result.processedSize,
...(result.savedFileId ? { serverFileId: result.savedFileId } : {}),
});
setProcessing(false);
setProgress(IDLE_PROGRESS);
return;
}
if (data.phase === "failed") {
if (stallTimerRef.current) clearTimeout(stallTimerRef.current);
if (elapsedRef.current) clearInterval(elapsedRef.current);
es.close();
eventSourceRef.current = null;
activeJobIdRef.current = null;
setError(data.error || "Processing failed");
setProcessing(false);
setProgress(IDLE_PROGRESS);
return;
}
if (typeof data.percent === "number") {
const scaled = UPLOAD_WEIGHT + (data.percent / 100) * (100 - UPLOAD_WEIGHT);
setProgress((prev) => ({
...prev,
phase: "processing",
percent: Math.max(prev.percent, scaled),
stage: data.stage,
}));
}
} catch {
// Ignore malformed SSE
}
};
es.onerror = () => {
if (!asyncModeRef.current) {
es.close();
eventSourceRef.current = null;
}
};
} catch {
// EventSource creation failed
}
}, [setError, setProcessing]);
// Reconnect SSE when tab becomes visible again (mobile tab recovery)
useEffect(() => {
const handleVisibilityChange = () => {
if (document.visibilityState !== "visible") return;
if (!activeJobIdRef.current) return;
if (eventSourceRef.current && eventSourceRef.current.readyState === EventSource.OPEN) {
return;
}
setTimeout(() => reconnectSSE(), 500);
};
document.addEventListener("visibilitychange", handleVisibilityChange);
return () => {
document.removeEventListener("visibilitychange", handleVisibilityChange);
if (elapsedRef.current) clearInterval(elapsedRef.current);
if (eventSourceRef.current) eventSourceRef.current.close();
if (xhrRef.current) xhrRef.current.abort();
if (abortRef.current) abortRef.current.abort();
if (stallTimerRef.current) clearTimeout(stallTimerRef.current);
};
}, []);
}, [reconnectSSE]);
const processFiles = useCallback(
(files: File[], settings: Record<string, unknown>) => {
@@ -92,6 +205,8 @@ export function useToolProcessor(toolId: string) {
}, 1000);
const clientJobId = generateId();
activeJobIdRef.current = clientJobId;
asyncModeRef.current = false;
let asyncMode = false;
const clearStallTimer = () => {
@@ -139,6 +254,7 @@ export function useToolProcessor(toolId: string) {
if (elapsedRef.current) clearInterval(elapsedRef.current);
es.close();
eventSourceRef.current = null;
activeJobIdRef.current = null;
const result = data.result as ProcessResult;
setWarning(result.warning ?? null);
@@ -161,6 +277,7 @@ export function useToolProcessor(toolId: string) {
if (elapsedRef.current) clearInterval(elapsedRef.current);
es.close();
eventSourceRef.current = null;
activeJobIdRef.current = null;
setError(data.error || "Processing failed");
setProcessing(false);
setProgress(IDLE_PROGRESS);
@@ -236,6 +353,7 @@ export function useToolProcessor(toolId: string) {
xhr.onload = () => {
if (xhr.status === 202) {
asyncMode = true;
asyncModeRef.current = true;
resetStallTimer();
return;
}
@@ -280,6 +398,7 @@ export function useToolProcessor(toolId: string) {
setProcessing(false);
setProgress(IDLE_PROGRESS);
activeJobIdRef.current = null;
};
xhr.onerror = () => {
@@ -292,6 +411,7 @@ export function useToolProcessor(toolId: string) {
setError("Processing was interrupted. Retry when reconnected.");
setProcessing(false);
setProgress(IDLE_PROGRESS);
activeJobIdRef.current = null;
};
xhr.ontimeout = () => {
@@ -304,6 +424,7 @@ export function useToolProcessor(toolId: string) {
setError("Request timed out - the server may be overloaded. Try again.");
setProcessing(false);
setProgress(IDLE_PROGRESS);
activeJobIdRef.current = null;
};
xhr.open("POST", `/api/v1/tools/${toolId}`);
@@ -338,6 +459,7 @@ export function useToolProcessor(toolId: string) {
}, 1000);
const clientJobId = generateId();
activeJobIdRef.current = clientJobId;
// Open SSE before upload for real-time progress
try {
@@ -450,6 +572,7 @@ export function useToolProcessor(toolId: string) {
setProcessing(false);
setProgress(IDLE_PROGRESS);
activeJobIdRef.current = null;
} catch (err) {
if (elapsedRef.current) clearInterval(elapsedRef.current);
if (eventSourceRef.current) {
@@ -459,6 +582,7 @@ export function useToolProcessor(toolId: string) {
setError(err instanceof Error ? err.message : "Batch processing failed");
setProcessing(false);
setProgress(IDLE_PROGRESS);
activeJobIdRef.current = null;
}
},
[toolId, processFiles, setProcessing, setError, toolName],
+20
View File
@@ -147,6 +147,26 @@ export const useFeaturesStore = create<FeaturesState>((set, get) => {
}
};
if (typeof document !== "undefined") {
document.addEventListener("visibilitychange", () => {
if (document.visibilityState !== "visible") return;
const activeIds = Object.keys(get().installing);
if (activeIds.length === 0) return;
for (const bundleId of activeIds) {
const es = esRefs[bundleId];
if (es && es.readyState === EventSource.OPEN) continue;
if (es) {
es.close();
delete esRefs[bundleId];
}
if (!pollRefs[bundleId]) {
startPolling(bundleId);
}
}
});
}
return {
bundles: [],
loaded: false,
+101
View File
@@ -0,0 +1,101 @@
// @vitest-environment jsdom
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
const fetchMock = vi.fn();
vi.stubGlobal("fetch", fetchMock);
vi.stubGlobal("localStorage", {
getItem: vi.fn(() => null),
setItem: vi.fn(),
removeItem: vi.fn(),
clear: vi.fn(),
get length() {
return 0;
},
key: vi.fn(() => null),
});
function okHealth() {
return Promise.resolve(new Response(JSON.stringify({ status: "healthy" }), { status: 200 }));
}
function simulateVisible() {
Object.defineProperty(document, "visibilityState", {
value: "visible",
writable: true,
configurable: true,
});
document.dispatchEvent(new Event("visibilitychange"));
}
function simulateHidden() {
Object.defineProperty(document, "visibilityState", {
value: "hidden",
writable: true,
configurable: true,
});
document.dispatchEvent(new Event("visibilitychange"));
}
describe("visibility recovery", () => {
beforeEach(() => {
vi.useFakeTimers();
fetchMock.mockReset();
fetchMock.mockImplementation(() => okHealth());
});
afterEach(() => {
vi.useRealTimers();
});
describe("connection monitor", () => {
it("calls checkHealth when tab becomes visible", async () => {
const { useConnectionStore } = await import("@/stores/connection-store");
const { useConnectionMonitor } = await import("@/hooks/use-connection-monitor");
const { renderHook } = await import("@testing-library/react");
useConnectionStore.setState({
status: "connected",
failedSince: null,
lastHealthCheck: null,
});
fetchMock.mockReset();
fetchMock.mockImplementation(() => okHealth());
const { unmount } = renderHook(() => useConnectionMonitor());
await vi.advanceTimersByTimeAsync(0);
const initialCalls = fetchMock.mock.calls.length;
simulateVisible();
await vi.advanceTimersByTimeAsync(0);
expect(fetchMock.mock.calls.length).toBeGreaterThan(initialCalls);
unmount();
});
it("does not call checkHealth when tab becomes hidden", async () => {
const { useConnectionStore } = await import("@/stores/connection-store");
const { useConnectionMonitor } = await import("@/hooks/use-connection-monitor");
const { renderHook } = await import("@testing-library/react");
useConnectionStore.setState({
status: "connected",
failedSince: null,
lastHealthCheck: null,
});
fetchMock.mockReset();
fetchMock.mockImplementation(() => okHealth());
const { unmount } = renderHook(() => useConnectionMonitor());
await vi.advanceTimersByTimeAsync(0);
const callsAfterMount = fetchMock.mock.calls.length;
simulateHidden();
await vi.advanceTimersByTimeAsync(0);
expect(fetchMock.mock.calls.length).toBe(callsAfterMount);
unmount();
});
});
});