Files
webmail-client/frontend/src/lib/ws.ts
T
lukasandClaude Opus 4.8 4c200ab94a Gmail label sync + no-dup backfill, live label/UI updates, account-delete cleanup, Sync-SPAM toggle, sidebar logo
Gmail sync (SPEC: Gmail sync):
- Provider fetches X-GM-LABELS when X-GM-EXT-1 is advertised; parses custom labels
  (system labels dropped, mUTF-7 decoded) onto RemoteMessage.
- Engine syncs only system folders + All Mail for Gmail, skips every label folder,
  and dedupes the All Mail pass by Message-ID — kills the INBOX/All-Mail duplication.
- Custom labels ride the message.new event; the labels plugin subscribes and maps
  them to chips as "<name> [Gmail]" (per-message + thread aggregate + known set),
  so labels fill in gradually with the sync window. Non-ASCII labels decode right.

Labels self-healing (message-driven reconcile):
- Per-message keys are the source of truth; t: aggregates and _labels are derived.
  Reconcile drops labels of deleted messages, regroups survivors by their current
  thread (fixing JWZ thread merges), rewrites changed t: keys, and rebuilds _labels
  from live messages — keeping user labels, dropping orphaned Gmail ones.
- New SDK reads: sdk.threads.existing / sdk.messages.threads_of. Sidebar refreshes
  live via a plugin.labels.changed WS event on new labels.

Account deletion: prune threads left empty after the cascade (they were user-scoped,
so only messages cascaded) + de-list the account from surviving cross-account threads.

Sync SPAM: opt-in per-account sync_spam (migration 0015, default off) — the engine
skips the Junk folder in backfill and poll unless enabled; wizard checkbox added.

Robustness / UX:
- WebSocket auto-reconnects with backoff and resyncs on (re)connect, and account
  add/delete invalidates threads/labels — no more hard refresh for live updates.
- Backfill banner + sidebar ring also require done < total, so a completed account
  can't leave a stuck "X of X".
- Scrub lone UTF-16 surrogates from parsed headers/bodies so bad messages no longer
  crash the backfill on Postgres text/JSONB.
- Ultimo signet logo in the Mail/Calendar/Contacts sidebar header (and at the top of
  the collapsed rail), via the shared plugin-ui.css + MailLayout.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U72FZiF1W1pb8XxyWBTREA
2026-08-05 18:04:49 +02:00

153 lines
5.3 KiB
TypeScript

// WebSocket layer (SPEC §9.2). Validates frames with zod and invalidates
// TanStack Query caches keyed on ids in the payload.
import type { QueryClient } from "@tanstack/react-query";
import { z } from "zod";
const frameSchema = z.object({
event: z.string(),
payload: z.record(z.unknown()),
});
const ALLOWED_EVENTS = new Set([
"message.new",
"message.changed",
"message.deleted",
"message.sent",
"flags.changed",
"thread.updated",
"sync.progress",
"account.state_changed",
"draft.saved",
"outbox.state_changed",
]);
// Lightweight in-process fan-out of WS frames to plugin subscribers (SPEC §11.3).
// Plugins receive plugin.{name}.* events plus any core event they subscribe to.
export type WsListener = (event: string, payload: Record<string, unknown>) => void;
const wsListeners = new Set<WsListener>();
export function subscribeWs(listener: WsListener): () => void {
wsListeners.add(listener);
return () => {
wsListeners.delete(listener);
};
}
export function connectWs(queryClient: QueryClient): () => void {
const proto = window.location.protocol === "https:" ? "wss" : "ws";
const url = `${proto}://${window.location.host}/api/ws`;
let socket: WebSocket | null = null;
let ping: number | undefined;
let reconnectTimer: number | undefined;
let attempts = 0;
let stopped = false;
// Refetch the live-updated lists — used on every (re)connect so a dropped socket
// (server restart, sleep, network blip) self-heals and catches up on missed events.
const resync = () => {
for (const key of [
["threads"],
["accounts"],
["folder-counts"],
["quota"],
["drafts-remote"],
]) {
queryClient.invalidateQueries({ queryKey: key });
}
};
const handleMessage = (event: MessageEvent) => {
let parsed: unknown;
try {
parsed = JSON.parse(event.data);
} catch {
return;
}
const result = frameSchema.safeParse(parsed);
if (!result.success) return;
const { event: name, payload } = result.data;
const isCore = ALLOWED_EVENTS.has(name);
// Fan out core + plugin.* events to plugin subscribers (a failing listener
// must not break the others or the cache invalidation below).
if (isCore || name.startsWith("plugin.")) {
for (const listener of wsListeners) {
try {
listener(name, payload);
} catch (err) {
console.error("ws listener failed", err);
}
}
}
if (!isCore) return;
// Coarse invalidation: refetch affected lists (SPEC §9.2 contract).
if (name === "sync.progress" || name.startsWith("message.") || name === "thread.updated") {
queryClient.invalidateQueries({ queryKey: ["threads"] });
queryClient.invalidateQueries({ queryKey: ["quota"] });
queryClient.invalidateQueries({ queryKey: ["drafts-remote"] });
queryClient.invalidateQueries({ queryKey: ["folder-counts"] });
// Backfill progress counters live on the account row (drives the banner).
if (name === "sync.progress") {
queryClient.invalidateQueries({ queryKey: ["accounts"] });
}
if (typeof payload.thread_id === "string") {
queryClient.invalidateQueries({ queryKey: ["thread", payload.thread_id] });
}
}
if (name === "flags.changed") {
// Read/unread changes affect the Inbox unread badge.
queryClient.invalidateQueries({ queryKey: ["folder-counts"] });
}
if (name === "account.state_changed") {
// Adding/deleting an account changes threads and (Gmail) labels wholesale —
// refetch the list, chips, and sidebar so nothing stale lingers.
queryClient.invalidateQueries({ queryKey: ["accounts"] });
queryClient.invalidateQueries({ queryKey: ["threads"] });
queryClient.invalidateQueries({ queryKey: ["thread-labels"] });
queryClient.invalidateQueries({ queryKey: ["message-labels"] });
queryClient.invalidateQueries({ queryKey: ["labels-all"] });
queryClient.invalidateQueries({ queryKey: ["folder-counts"] });
window.dispatchEvent(new Event("webmail:labels-changed"));
}
if (name === "message.sent") {
// The sent message's draft is deleted server-side; refresh the Drafts list.
queryClient.invalidateQueries({ queryKey: ["drafts"] });
queryClient.invalidateQueries({ queryKey: ["folder-counts"] });
}
};
const connect = () => {
socket = new WebSocket(url);
socket.onopen = () => {
attempts = 0;
ping = window.setInterval(() => {
if (socket?.readyState === WebSocket.OPEN) {
socket.send(JSON.stringify({ type: "ping" }));
}
}, 30000);
resync(); // catch up on anything published while we were disconnected
};
socket.onmessage = handleMessage;
socket.onclose = () => {
if (ping !== undefined) window.clearInterval(ping);
if (stopped) return;
// Exponential backoff, capped at 30s, so a downed server is retried politely.
const delay = Math.min(30000, 1000 * 2 ** attempts);
attempts += 1;
reconnectTimer = window.setTimeout(connect, delay);
};
socket.onerror = () => socket?.close(); // route errors through onclose -> reconnect
};
connect();
return () => {
stopped = true;
if (ping !== undefined) window.clearInterval(ping);
if (reconnectTimer !== undefined) window.clearTimeout(reconnectTimer);
socket?.close();
};
}