File size: 38,840 Bytes
dbb1bf9 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 | /**
* Cloud preferences sync service.
*
* Syncs CLOUD_SYNC_KEYS to Convex via /api/user-prefs (Vercel edge).
*
* Lifecycle hooks:
* install(variant) β call once at startup (patches localStorage.setItem, wires events)
* onSignIn(userId, variant) β fetch cloud prefs and merge on sign-in
* onSignOut() β clear sync metadata on sign-out
*
* Feature flag: VITE_CLOUD_PREFS_ENABLED=true must be set.
* Desktop guard: isDesktopRuntime() always skips sync.
*/
import { CLOUD_SYNC_KEYS, type CloudSyncKey } from './sync-keys';
import { isDesktopRuntime } from '@/services/runtime';
import { getClerkToken } from '@/services/clerk';
import { FEEDS } from '@/config/feeds';
import {
applyMigrationChain,
buildMigrations,
mergeCloudWithLocalDirty,
parsePersistedDirtyKeys,
settledDirtyKeys,
} from './cloud-prefs-migrations';
import {
isTemporaryCloudPrefsStatus,
parseRetryAfterSeconds,
rearmTemporaryCloudPrefsRetry,
} from './cloud-prefs-retry';
import { applyObservableCloudPrefsFlushSuccess } from './cloud-prefs-flush';
import { SerializedAsyncQueue } from './serialized-async-queue';
import { TimeoutError, withTimeout } from './with-timeout';
import { setTrustedHtml, trustedHtml } from '@/utils/dom-utils';
export { isTemporaryCloudPrefsStatus, parseRetryAfterSeconds } from './cloud-prefs-retry';
const ENABLED = import.meta.env.VITE_CLOUD_PREFS_ENABLED === 'true';
export const CLOUD_PREFS_APPLIED_EVENT = 'wm:cloud-prefs-applied';
export interface CloudPrefsAppliedDetail {
keys: CloudSyncKey[];
}
// localStorage state keys β never uploaded to cloud
const KEY_SYNC_VERSION = 'wm-cloud-sync-version';
const KEY_LAST_SYNC_AT = 'wm-last-sync-at';
const KEY_SYNC_STATE = 'wm-cloud-sync-state';
const KEY_LAST_SIGNED_IN_AS = 'wm-last-signed-in-as';
const KEY_DIRTY_KEYS = 'wm-cloud-prefs-dirty-keys';
// Tracks the schema version of the LOCAL blob (i.e. what's in localStorage
// right now). Distinct from the cloud row's schemaVersion. Required because
// uploads can post local data without first fetching cloud (uploadNow,
// post-conflict retry, onSignIn else-branch when local is at-or-ahead of
// cloud). Without local tracking, those post sites would stamp the new
// schemaVersion onto unmigrated local data β cementing the poisoning at
// the new schema version. Defaults to 1 when missing (assumes oldest).
const KEY_LOCAL_SCHEMA_VERSION = 'wm-cloud-prefs-local-schema-version';
const CURRENT_PREFS_SCHEMA_VERSION = 2;
const CLOUD_PREFS_REQUEST_TIMEOUT_MS = 15_000;
// Migrations live in cloud-prefs-migrations.ts to keep them testable β
// cloud-prefs-sync.ts has a transitive `import.meta.env.DEV` dep via
// `@/services/clerk` β `proxy.ts` that breaks outside a Vite build. The
// migrations module is dependency-light and importable from node:test.
//
// Schema 2 (2026-05-01): one-shot recovery for the v1 free-tier source-cap
// bug. The pre-PR-3521 alphabetical-slice cap auto-disabled every source
// past position 80 alphabetically, leaving entire late-alphabet categories
// (Layoffs, Semiconductors, IPO, Funding, Product Hunt, β¦) with 100% of
// their feeds in `disabledFeeds`. PR #3521 added a per-origin localStorage
// migration to recover this, but cloud-prefs sync re-poisoned origins
// every load by overwriting localStorage with the still-bad cloud blob β
// the recovery had to live at the cloud-data layer to be permanent.
//
// This migration runs ONCE per cloud row (gated by schemaVersion < 2),
// detects categories where 100% of sources are in `disabledFeeds`, and
// re-enables them. After the migration completes, schemaVersion bumps to
// 2 and subsequent sync pulls skip recovery β so a user who explicitly
// disables every source in a category POST-migration keeps that
// preference forever.
const MIGRATIONS = buildMigrations(FEEDS);
type SyncState = 'synced' | 'pending' | 'syncing' | 'conflict' | 'offline' | 'signed-out' | 'error';
let _debounceTimer: ReturnType<typeof setTimeout> | null = null;
let _currentVariant = 'full';
let _installed = false;
let _suppressPatch = false; // prevents applyCloudBlob from re-triggering upload
let _cachedToken: string | null = null; // synchronous token cache for flush()
// Sync keys the user has mutated locally since the last clean upload. On a
// 409 CONFLICT we must NOT overwrite these with the cloud blob β they are
// the edits the user just made (e.g. a watchlist typed seconds ago). The
// install() setItem/removeItem patch records them; a clean upload clears the
// SETTLED ones. See resolveConflictWithMerge + mergeCloudWithLocalDirty.
const _dirtyKeys = new Set<CloudSyncKey>();
let _dirtyKeysUserId: string | null = null;
function persistDirtyKeys(): void {
try {
if (_dirtyKeys.size === 0) {
Storage.prototype.removeItem.call(localStorage, KEY_DIRTY_KEYS);
return;
}
if (!_dirtyKeysUserId) return;
Storage.prototype.setItem.call(localStorage, KEY_DIRTY_KEYS, JSON.stringify({
userId: _dirtyKeysUserId,
keys: [..._dirtyKeys],
}));
} catch {
// localStorage unavailable: keep the in-memory guard for this page view.
}
}
function hydrateDirtyKeysFromStorage(userId: string): void {
try {
_dirtyKeys.clear();
_dirtyKeysUserId = userId;
const raw = localStorage.getItem(KEY_DIRTY_KEYS);
for (const key of parsePersistedDirtyKeys(raw, CLOUD_SYNC_KEYS, userId)) {
_dirtyKeys.add(key as CloudSyncKey);
}
if (raw !== null && _dirtyKeys.size === 0) persistDirtyKeys();
} catch {
// localStorage unavailable: the in-memory set remains the best effort.
}
}
function markDirtyKey(key: CloudSyncKey): void {
_dirtyKeys.add(key);
persistDirtyKeys();
}
/**
* Clear dirty keys that a just-succeeded upload actually durably synced β
* NOT the whole set. A user can mutate another pref *while postCloudPrefs is
* in flight*: the setItem patch marks it dirty, but it was never in the
* posted blob. Blanket-clearing would drop that tracking, so a subsequent
* 409 would see an empty dirty set and mergeCloudWithLocalDirty would let
* applyCloudBlob clobber the just-made edit β the very bug this set exists
* to prevent.
*
* The "settled" decision is the pure `settledDirtyKeys` (testable without
* the sync runtime): a key is settled iff the posted value still equals the
* current local value.
*/
function clearSettledDirtyKeys(postedBlob: Record<string, string>): void {
let changed = false;
for (const key of settledDirtyKeys(postedBlob, buildCloudBlob(), _dirtyKeys)) {
changed = _dirtyKeys.delete(key as CloudSyncKey) || changed;
}
if (changed) persistDirtyKeys();
}
// ββ 503 retry tracking βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
//
// _retryTimer holds the single pending 503-retry setTimeout (we cancel and
// re-schedule rather than stacking; only one retry should ever be in flight).
//
// _authGeneration increments on every onSignIn entry and onSignOut so a
// scheduled retry callback can detect "I'm stale, abort." Without this guard,
// a delayed retry from user A could fire after sign-out (calling onSignIn
// with the prior userId but the now-empty Clerk token), or after user B has
// signed in (using B's token but A's userId in the retry closure) β both
// produce a misleading sync attempt and pollute Sentry with confused errors.
let _retryTimer: ReturnType<typeof setTimeout> | null = null;
let _authGeneration = 0;
const _syncOperations = new SerializedAsyncQueue();
let _activeUploadPromise: Promise<void> | null = null;
let _queuedUploadVariant = 'full';
function clearRetryTimer(): void {
if (_retryTimer !== null) {
clearTimeout(_retryTimer);
_retryTimer = null;
}
}
// ββ Guards ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function isEnabled(): boolean {
return ENABLED && !isDesktopRuntime();
}
export function isCloudSyncEnabled(): boolean {
return isEnabled();
}
// ββ State helpers βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function getSyncVersion(): number {
return parseInt(localStorage.getItem(KEY_SYNC_VERSION) ?? '0', 10) || 0;
}
function setSyncVersion(v: number): void {
// Use direct Storage.prototype.setItem to bypass our patch (state key, not a pref key)
Storage.prototype.setItem.call(localStorage, KEY_SYNC_VERSION, String(v));
}
function setState(s: SyncState): void {
Storage.prototype.setItem.call(localStorage, KEY_SYNC_STATE, s);
}
// ββ Blob helpers ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function buildCloudBlob(): Record<string, string> {
const blob: Record<string, string> = {};
for (const key of CLOUD_SYNC_KEYS) {
const val = localStorage.getItem(key);
if (val !== null) blob[key] = val;
}
return blob;
}
function dispatchCloudPrefsApplied(keys: CloudSyncKey[]): void {
if (keys.length === 0 || typeof window === 'undefined') return;
window.dispatchEvent(new CustomEvent<CloudPrefsAppliedDetail>(CLOUD_PREFS_APPLIED_EVENT, {
detail: { keys },
}));
}
function applyCloudBlob(data: Record<string, unknown>): void {
const changedKeys: CloudSyncKey[] = [];
_suppressPatch = true;
try {
for (const key of CLOUD_SYNC_KEYS) {
const val = data[key];
if (typeof val === 'string') {
if (localStorage.getItem(key) !== val) changedKeys.push(key);
localStorage.setItem(key, val);
} else if (!(key in data)) {
if (localStorage.getItem(key) !== null) changedKeys.push(key);
localStorage.removeItem(key);
}
}
} finally {
_suppressPatch = false;
}
dispatchCloudPrefsApplied(changedKeys);
}
function applyMigrations(
data: Record<string, unknown>,
fromVersion: number,
): Record<string, unknown> {
return applyMigrationChain(data, fromVersion, CURRENT_PREFS_SCHEMA_VERSION, MIGRATIONS);
}
function getLocalSchemaVersion(): number {
const raw = localStorage.getItem(KEY_LOCAL_SCHEMA_VERSION);
if (raw === null) return 1; // No marker yet β assume oldest, run migrations
const v = parseInt(raw, 10);
return Number.isFinite(v) && v > 0 ? v : 1;
}
function setLocalSchemaVersion(v: number): void {
Storage.prototype.setItem.call(localStorage, KEY_LOCAL_SCHEMA_VERSION, String(v));
}
/**
* Ensure the local blob is migrated to CURRENT_PREFS_SCHEMA_VERSION before
* upload. Idempotent β when local schema is already current, returns the
* existing blob unchanged. Otherwise runs pending migrations, writes the
* cleaned data back to localStorage, and bumps the local schema marker.
*
* Must be called before EVERY post path: onSignIn else-branch (when local
* is at-or-ahead of cloud), uploadNow normal path, uploadNow conflict
* retry. Otherwise the post would stamp CURRENT_PREFS_SCHEMA_VERSION onto
* unmigrated local data, "upgrading" the cloud row to the new schema with
* stale poisoning β the failure mode flagged in PR #3524 review.
*/
function migrateLocalBlobIfNeeded(): Record<string, string> {
const localSchema = getLocalSchemaVersion();
const blob = buildCloudBlob();
if (localSchema >= CURRENT_PREFS_SCHEMA_VERSION) return blob;
const migrated = applyMigrations(blob, localSchema) as Record<string, string>;
if (migrated !== blob) applyCloudBlob(migrated);
setLocalSchemaVersion(CURRENT_PREFS_SCHEMA_VERSION);
return migrated;
}
// ββ Toast βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function showUndoToast(prevBlobJson: string): void {
document.querySelector('.wm-sync-restore-toast')?.remove();
const toast = document.createElement('div');
toast.className = 'wm-sync-restore-toast update-toast';
setTrustedHtml(toast, trustedHtml(`
<div class="update-toast-body">
<div class="update-toast-title">Settings restored</div>
<div class="update-toast-detail">Your preferences were loaded from the cloud.</div>
</div>
<button class="update-toast-action" data-action="undo">Undo</button>
<button class="update-toast-dismiss" data-action="dismiss" aria-label="Dismiss">\u00d7</button>
`, "legacy direct innerHTML migration"));
const autoTimer = setTimeout(() => toast.remove(), 5000);
toast.addEventListener('click', (e) => {
const action = (e.target as HTMLElement).closest('[data-action]')?.getAttribute('data-action');
if (action === 'undo') {
const prev = JSON.parse(prevBlobJson) as Record<string, string>;
const restoredKeys: CloudSyncKey[] = [];
_suppressPatch = true;
try {
for (const [k, v] of Object.entries(prev)) {
if (!CLOUD_SYNC_KEYS.includes(k as CloudSyncKey)) continue;
const key = k as CloudSyncKey;
if (localStorage.getItem(key) !== v) restoredKeys.push(key);
localStorage.setItem(key, v);
}
} finally {
_suppressPatch = false;
}
dispatchCloudPrefsApplied(restoredKeys);
toast.remove();
clearTimeout(autoTimer);
} else if (action === 'dismiss') {
toast.remove();
clearTimeout(autoTimer);
}
});
document.body.appendChild(toast);
}
// ββ API helpers βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
interface CloudPrefs {
data: Record<string, unknown>;
schemaVersion: number;
syncVersion: number;
}
/**
* Typed temporary response from the edge. Callers detect
* this via `instanceof ServiceUnavailableError` and back off using
* `retryAfterSec` instead of treating it as a permanent error.
*/
export class ServiceUnavailableError extends Error {
retryAfterSec: number;
status: number;
constructor(retryAfterSec: number, status = 503) {
super(`service temporarily unavailable (${status}; retry after ${retryAfterSec}s)`);
this.name = 'ServiceUnavailableError';
this.retryAfterSec = retryAfterSec;
this.status = status;
}
}
function asTemporaryCloudPrefsError(error: unknown): never {
const name = (error as { name?: unknown } | null)?.name;
if (error instanceof TimeoutError || name === 'TimeoutError' || name === 'AbortError') {
throw new ServiceUnavailableError(parseRetryAfterSeconds(new Headers()), 504);
}
throw error;
}
async function getCloudPrefsToken(): Promise<string | null> {
try {
return await withTimeout(
getClerkToken(),
CLOUD_PREFS_REQUEST_TIMEOUT_MS,
'cloud prefs token',
);
} catch (error) {
return asTemporaryCloudPrefsError(error);
}
}
async function fetchCloudPrefs(token: string, variant: string): Promise<CloudPrefs | null> {
let res: Response;
try {
res = await fetch(`/api/user-prefs?variant=${encodeURIComponent(variant)}`, {
headers: { Authorization: `Bearer ${token}` },
signal: AbortSignal.timeout(CLOUD_PREFS_REQUEST_TIMEOUT_MS),
});
} catch (error) {
return asTemporaryCloudPrefsError(error);
}
if (res.status === 401) return null;
if (isTemporaryCloudPrefsStatus(res.status)) throw new ServiceUnavailableError(parseRetryAfterSeconds(res.headers), res.status);
if (!res.ok) throw new Error(`fetch prefs: ${res.status}`);
return (await res.json()) as CloudPrefs | null;
}
async function postCloudPrefs(
token: string,
variant: string,
data: Record<string, string>,
expectedSyncVersion: number,
): Promise<{ syncVersion: number } | { conflict: true; actualSyncVersion?: number }> {
let res: Response;
try {
res = await fetch('/api/user-prefs', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${token}`,
},
body: JSON.stringify({ variant, data, expectedSyncVersion, schemaVersion: CURRENT_PREFS_SCHEMA_VERSION }),
signal: AbortSignal.timeout(CLOUD_PREFS_REQUEST_TIMEOUT_MS),
});
} catch (error) {
return asTemporaryCloudPrefsError(error);
}
if (res.status === 409) {
// Server now echoes the row's current syncVersion in the 409 body
// (when available) so we can advance local state without a follow-up
// GET. Fall back to undefined for older edge deploys that don't yet
// include the field β the existing re-fetch path still handles those.
const body = await res.json().catch(() => ({} as Record<string, unknown>));
const actualSyncVersion = typeof body.actualSyncVersion === 'number' ? body.actualSyncVersion : undefined;
return { conflict: true, actualSyncVersion };
}
if (isTemporaryCloudPrefsStatus(res.status)) throw new ServiceUnavailableError(parseRetryAfterSeconds(res.headers), res.status);
if (!res.ok) throw new Error(`post prefs: ${res.status}`);
return (await res.json()) as { syncVersion: number };
}
// ββ Core logic ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
/**
* Resolve a 409 CONFLICT without losing local edits. Fetch the fresh cloud
* row, merge the user's locally-dirty keys over it (mergeCloudWithLocalDirty),
* apply the merge to localStorage, and re-post. On success the dirty set is
* cleared and state goes 'synced'; on a second conflict or a failed fetch the
* dirty set is preserved so the next pref change / sign-in retries.
*
* Replaces the previous "fetch cloud β applyCloudBlob β re-post buildCloudBlob"
* path, which overwrote localStorage with the cloud blob *before* rebuilding
* the post body β silently discarding the edit the user had just made (e.g. a
* watchlist typed seconds earlier, then lost on the debounced upload's 409).
*/
async function resolveConflictWithMerge(token: string, variant: string, callerGeneration: number): Promise<boolean> {
const fresh = await fetchCloudPrefs(token, variant);
if (_authGeneration !== callerGeneration) return false;
if (!fresh) {
setState('error');
return false;
}
const migratedCloud = applyMigrations(fresh.data, fresh.schemaVersion ?? 1);
const merged = mergeCloudWithLocalDirty(migratedCloud, buildCloudBlob(), _dirtyKeys);
applyCloudBlob(merged);
setSyncVersion(fresh.syncVersion);
setLocalSchemaVersion(CURRENT_PREFS_SCHEMA_VERSION);
const retry = await postCloudPrefs(token, variant, merged, fresh.syncVersion);
if (_authGeneration !== callerGeneration) return false;
if ('conflict' in retry) {
setState('conflict');
return false;
}
// Generation guard (same vector as uploadNow's success branch): if the
// signed-in user switched during the awaits above, do not clear/persist
// settled dirty keys β _dirtyKeys now belongs to another user and the
// write would durably corrupt their persisted dirty-key entry.
setSyncVersion(retry.syncVersion);
clearSettledDirtyKeys(merged);
Storage.prototype.setItem.call(localStorage, KEY_LAST_SYNC_AT, String(Date.now()));
setState('synced');
return true;
}
export function onSignIn(userId: string, variant: string): Promise<void> {
if (!isEnabled()) return Promise.resolve();
// New onSignIn entry β invalidate any pending 503 retry so a stale
// closure can't fire mid-flight, and bump generation so any timer that
// was already scheduled (and not yet caught by clearRetryTimer) bails
// when it fires.
clearRetryTimer();
_authGeneration += 1;
const myGeneration = _authGeneration;
// Establish dirty-key ownership synchronously. Preference writes may happen
// while this sign-in waits behind an older queued writer; hydrating inside
// the queued callback would then clear those new edits or attribute them to
// the previous account.
hydrateDirtyKeysFromStorage(userId);
return _syncOperations.run(async () => {
if (_authGeneration !== myGeneration) return;
_currentVariant = variant;
setState('syncing');
try {
const token = await getCloudPrefsToken();
if (_authGeneration !== myGeneration) return;
if (!token) { setState('error'); return; }
_cachedToken = token;
const cloud = await fetchCloudPrefs(token, variant);
if (_authGeneration !== myGeneration) return;
if (cloud && cloud.syncVersion > getSyncVersion()) {
const isFirstEverSync = getSyncVersion() === 0;
const prevBlobJson = isFirstEverSync ? JSON.stringify(buildCloudBlob()) : null;
const migrated = applyMigrations(cloud.data, cloud.schemaVersion ?? 1);
const migrationChanged = (cloud.schemaVersion ?? 1) < CURRENT_PREFS_SCHEMA_VERSION;
// Cloud is ahead, but the user may have un-uploaded local edits β e.g.
// onSignIn re-fired by a 503 retry after the user changed a pref. Merge
// those dirty keys over the cloud blob instead of clobbering them.
const hasDirty = _dirtyKeys.size > 0;
const toApply = hasDirty
? mergeCloudWithLocalDirty(migrated, buildCloudBlob(), _dirtyKeys)
: migrated;
applyCloudBlob(toApply);
setSyncVersion(cloud.syncVersion);
// After applyCloudBlob, local data IS at CURRENT schema (applyMigrations
// ran every step from cloud.schemaVersion to CURRENT). Mark it so the
// post paths don't redundantly re-run migrations on already-clean data.
setLocalSchemaVersion(CURRENT_PREFS_SCHEMA_VERSION);
// Force an upload when the cloud row's schemaVersion is behind (so it
// catches up β otherwise the migration re-runs every load) OR when we
// merged in local dirty keys the cloud row doesn't have yet.
if (migrationChanged || hasDirty) schedulePrefUpload(variant);
Storage.prototype.setItem.call(localStorage, KEY_LAST_SYNC_AT, String(Date.now()));
if (isFirstEverSync && prevBlobJson && Object.keys(cloud.data).length > 0) {
showUndoToast(prevBlobJson);
}
setState('synced');
} else {
// Local is at-or-ahead of cloud β post local. Migrate first so we
// never stamp CURRENT_PREFS_SCHEMA_VERSION onto unmigrated local data
// (the failure mode flagged in PR #3524 review: a user already synced
// to a poisoned cloud row would skip Branch A's inbound migration on
// subsequent sign-ins and post the bad blob back at schema 2,
// cementing the poisoning at the new schema).
const blob = migrateLocalBlobIfNeeded();
const result = await postCloudPrefs(token, variant, blob, getSyncVersion());
if (_authGeneration !== myGeneration) return;
if ('conflict' in result) {
// Merge instead of clobber β see resolveConflictWithMerge. The old
// path here applied the cloud blob over localStorage and stopped,
// discarding the local edits this branch was trying to upload.
await resolveConflictWithMerge(token, variant, myGeneration);
} else {
setSyncVersion(result.syncVersion);
clearSettledDirtyKeys(blob);
Storage.prototype.setItem.call(localStorage, KEY_LAST_SYNC_AT, String(Date.now()));
setState('synced');
}
}
if (_authGeneration === myGeneration) {
Storage.prototype.setItem.call(localStorage, KEY_LAST_SIGNED_IN_AS, userId);
}
} catch (err) {
if (_authGeneration !== myGeneration) return;
if (err instanceof ServiceUnavailableError) {
// Temporary edge response β transient. Set 'pending' (not 'error') and
// re-attempt sign-in sync after the server-suggested delay. This is
// the user-facing "transient outage shouldn't be permanent" fix
// (PR #3479): without this branch the catch would fall through to
// 'error' and the user's prefs would silently not sync until they
// reload.
//
// Generation guard: cancel any prior pending retry, then schedule a
// new one whose callback bails if `_authGeneration` has advanced
// (sign-out, user-switch, or another onSignIn invocation since this
// attempt began). Without the guard, a 5s delayed retry from user A
// could fire after sign-out (no token) or after user B signed in
// (wrong token in cache).
console.warn(`[cloud-prefs] onSignIn ${err.status}; retrying in ${err.retryAfterSec}s`);
setState('pending');
clearRetryTimer();
_retryTimer = setTimeout(() => {
_retryTimer = null;
if (_authGeneration !== myGeneration) return;
void onSignIn(userId, variant);
}, err.retryAfterSec * 1000);
return;
}
console.warn('[cloud-prefs] onSignIn failed:', err);
setState(!navigator.onLine || (err instanceof TypeError && err.message.includes('fetch')) ? 'offline' : 'error');
}
});
}
export function onSignOut(): void {
if (!isEnabled()) return;
const preservePersistedDirtyKeys = _syncOperations.busy && _dirtyKeys.size > 0;
if (_debounceTimer !== null && _cachedToken) {
// Flush pending upload synchronously before clearing credentials
clearTimeout(_debounceTimer);
_debounceTimer = null;
// Never launch a second stale-version writer while sign-in reconciliation
// or a normal upload is already running. Dirty keys remain persisted and
// the active operation / next sign-in remains the recovery path.
if (!_syncOperations.busy) {
const blob = buildCloudBlob();
const token = _cachedToken;
void _syncOperations.run(async () => {
await fetch('/api/user-prefs', {
method: 'POST',
keepalive: true,
headers: { 'Content-Type': 'application/json', Authorization: `Bearer ${token}` },
body: JSON.stringify({ variant: _currentVariant, data: blob, expectedSyncVersion: getSyncVersion(), schemaVersion: CURRENT_PREFS_SCHEMA_VERSION }),
signal: AbortSignal.timeout(CLOUD_PREFS_REQUEST_TIMEOUT_MS),
});
}).catch(() => { /* best-effort on sign-out */ });
}
} else if (_debounceTimer !== null) {
clearTimeout(_debounceTimer);
_debounceTimer = null;
}
// Cancel any pending 503 retry and bump auth-generation so a timer that's
// already scheduled (and not yet caught by clearRetryTimer) bails when it
// fires β a delayed retry from the prior auth context must not call
// onSignIn / uploadNow against the now-empty token cache or, worse, against
// a different user's token after a fast user switch.
clearRetryTimer();
_authGeneration += 1;
_cachedToken = null;
// Dirty-key tracking is user-scoped. Clear the in-memory owner on sign-out,
// but retain its persisted marker when an interrupted writer still owns
// unsynced edits; hydrateDirtyKeysFromStorage validates the user id before
// restoring it and removes mismatched markers for the next account.
_dirtyKeys.clear();
if (!preservePersistedDirtyKeys) persistDirtyKeys();
_dirtyKeysUserId = null;
// Preserve prefs; only clear sync metadata
localStorage.removeItem(KEY_SYNC_VERSION);
localStorage.removeItem(KEY_LAST_SYNC_AT);
setState('signed-out');
}
/**
* Execute one cloud write while the caller owns the serialized sync queue.
* The outcome tells the upload drain whether it may replay a mutation that
* arrived after this pass captured its snapshot.
*/
async function performUploadNow(variant: string): Promise<'completed' | 'retry-deferred' | 'stopped'> {
// Capture the auth generation at entry. If sign-out / user-switch happens
// while we're awaiting fetch, the generation guard on any 503 retry below
// will detect it and abort the scheduled retry. We do NOT increment the
// generation here β uploadNow runs WITHIN an existing auth context (it's
// called by the debounced upload path), so we want to inherit the current
// generation, not start a new one.
const myGeneration = _authGeneration;
try {
const token = await getCloudPrefsToken();
if (_authGeneration !== myGeneration) return 'stopped';
if (!token) return 'stopped';
_cachedToken = token;
setState('syncing');
const postedBlob = migrateLocalBlobIfNeeded();
const result = await postCloudPrefs(token, variant, postedBlob, getSyncVersion());
if (_authGeneration !== myGeneration) return 'stopped';
if ('conflict' in result) {
setState('conflict');
// Merge the user's locally-dirty keys over the fresh cloud row instead
// of overwriting localStorage with cloud (the old path did
// applyCloudBlob(cloud) then re-posted buildCloudBlob() β which by then
// WAS the cloud blob, so the user's just-made edit was silently lost).
if (!await resolveConflictWithMerge(token, variant, myGeneration)) return 'stopped';
} else {
// Generation guard: a sign-out / account-switch during the awaits above
// repoints _dirtyKeys and _dirtyKeysUserId to a different user. Clearing
// (and now persisting) settled keys here would durably corrupt that
// user's dirty-key entry using this upload's stale postedBlob. Match the
// 503 retry branch and the flush-success path β bail if the generation
// moved.
setSyncVersion(result.syncVersion);
clearSettledDirtyKeys(postedBlob);
Storage.prototype.setItem.call(localStorage, KEY_LAST_SYNC_AT, String(Date.now()));
setState('synced');
}
} catch (err) {
if (_authGeneration !== myGeneration) return 'stopped';
if (err instanceof ServiceUnavailableError) {
// Temporary edge response β transient. Re-queue the upload after the
// server-suggested delay so the unsaved blob isn't lost. Setting
// 'pending' state matches the existing schedulePrefUpload UX.
//
// Generation guard: same as the onSignIn branch β if the user signs
// out or switches accounts during the retry window, the timer fires
// but the closure's captured `myGeneration` no longer matches, so
// the retry aborts. Without this, the upload would re-fire against
// a now-empty token cache or a different user's token.
console.warn(`[cloud-prefs] uploadNow ${err.status}; retrying in ${err.retryAfterSec}s`);
setState('pending');
clearRetryTimer();
_retryTimer = setTimeout(() => {
_retryTimer = null;
if (_authGeneration !== myGeneration) return;
void uploadNow(variant);
}, err.retryAfterSec * 1000);
return 'retry-deferred';
}
console.warn('[cloud-prefs] uploadNow failed:', err);
setState(!navigator.onLine || (err instanceof TypeError && err.message.includes('fetch')) ? 'offline' : 'error');
return 'stopped';
}
return 'completed';
}
/**
* Coalesce upload requests behind the shared sign-in/write queue.
*
* Calls share one active promise. After a successful pass, dirty-key tracking
* determines whether a preference changed after its snapshot and needs one
* more pass; duplicate callers alone never cause a redundant POST.
*/
function uploadNow(variant: string): Promise<void> {
_queuedUploadVariant = variant;
if (_activeUploadPromise !== null) {
setState('pending');
return _activeUploadPromise;
}
const requestedGeneration = _authGeneration;
const queuedUpload = _syncOperations.run(async () => {
if (_authGeneration !== requestedGeneration) return;
while (_authGeneration === requestedGeneration) {
const outcome = await performUploadNow(_queuedUploadVariant);
if (outcome !== 'completed' || _dirtyKeys.size === 0) return;
}
});
const activeUpload = queuedUpload.finally(() => {
if (_activeUploadPromise === activeUpload) _activeUploadPromise = null;
});
_activeUploadPromise = activeUpload;
return activeUpload;
}
function schedulePrefUpload(variant: string): void {
setState('pending');
if (_debounceTimer !== null) clearTimeout(_debounceTimer);
_debounceTimer = setTimeout(async () => {
_debounceTimer = null;
await uploadNow(variant);
}, 5000);
}
export function onPrefChange(variant: string): void {
if (!isEnabled()) return;
_currentVariant = variant;
schedulePrefUpload(variant);
}
export async function syncNow(): Promise<void> {
if (!isEnabled()) return;
if (_debounceTimer !== null) {
clearTimeout(_debounceTimer);
_debounceTimer = null;
}
await uploadNow(_currentVariant);
}
export function getSyncState(): SyncState {
return (localStorage.getItem(KEY_SYNC_STATE) as SyncState) || 'signed-out';
}
export function getLastSyncAt(): number {
return parseInt(localStorage.getItem(KEY_LAST_SYNC_AT) ?? '0', 10) || 0;
}
// ββ install βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
export function install(variant: string): void {
if (!isEnabled() || _installed) return;
_installed = true;
_currentVariant = variant;
// Patch localStorage.setItem and removeItem to detect pref changes in this tab.
// Use _suppressPatch to prevent applyCloudBlob from triggering spurious uploads.
const originalSetItem = Storage.prototype.setItem;
Storage.prototype.setItem = function setItem(key: string, value: string) {
originalSetItem.call(this, key, value);
if (this === localStorage && !_suppressPatch && CLOUD_SYNC_KEYS.includes(key as CloudSyncKey)) {
markDirtyKey(key as CloudSyncKey);
schedulePrefUpload(_currentVariant);
}
};
const originalRemoveItem = Storage.prototype.removeItem;
Storage.prototype.removeItem = function removeItem(key: string) {
originalRemoveItem.call(this, key);
if (this === localStorage && !_suppressPatch && CLOUD_SYNC_KEYS.includes(key as CloudSyncKey)) {
markDirtyKey(key as CloudSyncKey);
schedulePrefUpload(_currentVariant);
}
};
// Multi-tab: another tab wrote a newer syncVersion β cancel our pending upload
window.addEventListener('storage', (e) => {
if (e.key === KEY_SYNC_VERSION && e.newValue !== null) {
const newV = parseInt(e.newValue, 10);
if (newV > getSyncVersion()) {
if (_debounceTimer !== null) {
clearTimeout(_debounceTimer);
_debounceTimer = null;
setState('synced');
}
Storage.prototype.setItem.call(localStorage, KEY_SYNC_VERSION, e.newValue);
}
}
});
// Tab close: flush pending debounce via fetch with keepalive
// (sendBeacon cannot send Authorization headers)
const flushOnUnload = (): void => {
if (_debounceTimer === null || !_cachedToken) return;
clearTimeout(_debounceTimer);
_debounceTimer = null;
// A sign-in reconciliation or upload already owns the current
// expectedSyncVersion. Fold this final snapshot into that serialized
// writer instead of launching a competing keepalive POST.
if (_syncOperations.busy) {
void uploadNow(_currentVariant);
return;
}
// Same defensive migration as the synchronous post paths β never stamp
// CURRENT_PREFS_SCHEMA_VERSION onto unmigrated local data, even on
// best-effort unload flush.
const blob = migrateLocalBlobIfNeeded();
const myGeneration = _authGeneration;
const payload = JSON.stringify({ variant: _currentVariant, data: blob, expectedSyncVersion: getSyncVersion(), schemaVersion: CURRENT_PREFS_SCHEMA_VERSION });
void _syncOperations.run(async () => {
await fetch('/api/user-prefs', {
method: 'POST',
keepalive: true,
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${_cachedToken}`,
},
body: payload,
signal: AbortSignal.timeout(CLOUD_PREFS_REQUEST_TIMEOUT_MS),
}).then(async (res) => {
// The flush's most common trigger is NOT a real unload β it's
// visibilitychangeβhidden on a tab switch, after which the tab stays
// alive. A successful flush advances the server row's syncVersion, so
// skipping the response here strands local KEY_SYNC_VERSION one
// version behind and GUARANTEES a 409 on the next pref save. Adopt
// the new version when the response is observable (true unloads never
// get here; the next boot's onSignIn GET heals those instead).
//
// Non-2xx: 409 keeps the stale version and dirty keys so the next
// upload resolves through the conflict-merge path. Temporary 429/5xx
// responses are observable during tab switches, so re-arm the normal
// retry machinery instead of stranding the final save.
if (!res.ok) {
rearmTemporaryCloudPrefsRetry({
status: res.status,
headers: res.headers,
myGeneration,
getAuthGeneration: () => _authGeneration,
setPending: () => setState('pending'),
clearRetryTimer,
setRetryTimer: (timer) => { _retryTimer = timer; },
uploadNow: () => uploadNow(_currentVariant),
});
return;
}
const body = (await res.json().catch(() => null)) as { syncVersion?: number } | null;
applyObservableCloudPrefsFlushSuccess({
syncVersion: body?.syncVersion,
myGeneration,
getAuthGeneration: () => _authGeneration,
getSyncVersion,
setSyncVersion,
clearSettledDirtyKeys: () => clearSettledDirtyKeys(blob),
setLastSyncAt: (timestampMs) => {
Storage.prototype.setItem.call(localStorage, KEY_LAST_SYNC_AT, String(timestampMs));
},
// Only claim 'synced' when no newer edit re-armed the debounce AND no
// uploadNow is active or queued (performUploadNow does not start
// until the keepalive task releases the serialized queue).
isIdle: () => _debounceTimer === null && _activeUploadPromise === null,
setSynced: () => setState('synced'),
});
});
}).catch(() => { /* best-effort on unload */ });
};
document.addEventListener('visibilitychange', () => {
if (document.visibilityState === 'hidden') flushOnUnload();
});
window.addEventListener('pagehide', flushOnUnload);
}
|