desktop sync support

This commit is contained in:
Boof2015
2026-07-06 14:14:41 -04:00
parent 006e55422b
commit 2b19f51a49
26 changed files with 4183 additions and 208 deletions
+60 -1
View File
@@ -11,10 +11,12 @@ import {
fetchDesktopRemoteIdentity,
fetchDesktopRemoteNowPlaying,
fetchDesktopRemotePairingStatus,
fetchDesktopRemoteQueue,
parseDesktopRemoteManualInput,
parseDesktopRemotePairingInput,
requestDesktopRemotePinPairing,
sendDesktopRemoteControl,
sendDesktopRemotePlayQueueItem,
startDesktopRemoteEventStream,
} from '@/services/desktopRemoteClient';
import { normalizeDesktopRemotePinInput } from '@/services/desktopRemotePairing';
@@ -25,12 +27,16 @@ import {
setDesktopRemoteConnection,
setDesktopRemoteToken,
} from '@/services/desktopRemoteCredentials';
import { openLibraryDb } from '@/db/database';
import { clearPlaylistSyncBaselines } from '@/db/desktopSyncQueries';
import { useDesktopSyncStore } from '@/stores/desktopSyncStore';
import type {
DesktopRemoteConnection,
DesktopRemoteControlCommand,
DesktopRemoteDiscoveredDesktop,
DesktopRemoteIdentity,
DesktopRemoteNowPlayingSnapshot,
DesktopRemoteQueueSnapshot,
} from '@/types/desktopRemote';
const PAIR_POLL_INTERVAL_MS = 1500;
@@ -66,6 +72,8 @@ interface DesktopRemoteStore {
connection: DesktopRemoteConnection | null;
token: string | null;
snapshot: DesktopRemoteNowPlayingSnapshot | null;
/** Desktop queue (current + upcoming); null on protocol-1 desktops. */
queue: DesktopRemoteQueueSnapshot | null;
discovered: DesktopRemoteDiscoveredDesktop[];
discoveryAvailable: boolean;
discoveryRunning: boolean;
@@ -86,6 +94,8 @@ interface DesktopRemoteStore {
disconnect: () => void;
forget: () => Promise<void>;
sendControl: (command: DesktopRemoteControlCommand, time?: number) => Promise<void>;
refreshQueue: () => Promise<void>;
playQueueItem: (queueId: string) => Promise<void>;
}
let pairingPollTimer: ReturnType<typeof setTimeout> | null = null;
@@ -210,11 +220,15 @@ export const useDesktopRemoteStore = create<DesktopRemoteStore>((set, get) => {
if (!connection || !token || connectionState === 'connecting') return;
void fetchDesktopRemoteNowPlaying(connection.baseUrl, token).then(
(snapshot) => {
const wasConnected = get().connectionState === 'connected';
set((state) => ({
snapshot: mergeSnapshotArtwork(state.snapshot, snapshot),
connectionState: 'connected',
errorMessage: '',
}));
if (!wasConnected) {
useDesktopSyncStore.getState().maybeAutoSync('connected');
}
refreshInlineArtwork();
},
(error) => {
@@ -434,6 +448,7 @@ export const useDesktopRemoteStore = create<DesktopRemoteStore>((set, get) => {
connection: null,
token: null,
snapshot: null,
queue: null,
discovered: [],
discoveryAvailable: desktopRemoteDiscoveryAvailable,
discoveryRunning: false,
@@ -536,16 +551,27 @@ export const useDesktopRemoteStore = create<DesktopRemoteStore>((set, get) => {
message: '',
errorMessage: '',
});
useDesktopSyncStore.getState().maybeAutoSync('connected');
stopEventStream = startDesktopRemoteEventStream(connection.baseUrl, token, {
onSnapshot: (nextSnapshot) => {
const wasConnected = get().connectionState === 'connected';
set((state) => ({
snapshot: mergeSnapshotArtwork(state.snapshot, nextSnapshot),
connectionState: 'connected',
message: '',
errorMessage: '',
}));
if (!wasConnected) {
useDesktopSyncStore.getState().maybeAutoSync('connected');
}
refreshInlineArtwork();
},
onQueue: (queue) => {
set({ queue });
},
onSyncRequest: () => {
useDesktopSyncStore.getState().handleSyncRequest();
},
onUnauthorized: () => {
void get().forget();
set({ errorMessage: 'Desktop pairing was revoked.' });
@@ -556,6 +582,7 @@ export const useDesktopRemoteStore = create<DesktopRemoteStore>((set, get) => {
},
});
scheduleSnapshotPoll();
void get().refreshQueue();
return true;
} catch (error) {
if (error instanceof DesktopRemoteHttpError && error.status === 401) {
@@ -580,18 +607,23 @@ export const useDesktopRemoteStore = create<DesktopRemoteStore>((set, get) => {
disconnect: () => {
stopRealtime();
clearPairingPoll();
set({ connectionState: get().connection ? 'error' : 'unpaired', message: '', snapshot: null, pinPairing: null });
set({ connectionState: get().connection ? 'error' : 'unpaired', message: '', snapshot: null, queue: null, pinPairing: null });
},
forget: async () => {
stopRealtime();
clearPairingPoll();
await clearDesktopRemotePairing();
// Sync baselines are meaningless against a different desktop.
void openLibraryDb()
.then((db) => clearPlaylistSyncBaselines(db))
.catch(() => {});
set({
connectionState: 'unpaired',
connection: null,
token: null,
snapshot: null,
queue: null,
pairing: null,
pinPairing: null,
message: '',
@@ -618,5 +650,32 @@ export const useDesktopRemoteStore = create<DesktopRemoteStore>((set, get) => {
set({ errorMessage: errorMessage(error) });
}
},
refreshQueue: async () => {
const { connection, token } = get();
if (!connection || !token) return;
try {
const queue = await fetchDesktopRemoteQueue(connection.baseUrl, token);
set({ queue });
} catch {
// Protocol-1 desktops 404 here; the queue UI simply stays hidden.
}
},
playQueueItem: async (queueId) => {
const { connection, token } = get();
if (!connection || !token) return;
try {
await sendDesktopRemotePlayQueueItem(connection.baseUrl, token, queueId);
set({ errorMessage: '' });
} catch (error) {
if (error instanceof DesktopRemoteHttpError && error.status === 401) {
await get().forget();
set({ errorMessage: 'Desktop pairing was revoked.' });
return;
}
set({ errorMessage: errorMessage(error) });
}
},
};
});
+199
View File
@@ -0,0 +1,199 @@
// Desktop LAN sync status + triggers. The engine itself lives in
// src/services/desktopSync.ts; this store serializes runs (one at a time),
// debounces the automatic triggers, and exposes last-synced state for the UI.
// Module-scope timers (not component state) per the React Compiler rules.
import { AppState } from 'react-native';
import { create } from 'zustand';
import { openLibraryDb } from '@/db/database';
import { getSetting, setSetting } from '@/db/queries';
import {
DesktopSyncUnsupportedError,
applyDesktopSyncConflictResolution,
desktopSyncSettingKey,
runDesktopSync,
} from '@/services/desktopSync';
import { getDesktopRemoteConnection } from '@/services/desktopRemoteCredentials';
import { fetchDesktopRemoteIdentity } from '@/services/desktopRemoteClient';
import type {
DesktopSyncConflictResolution,
DesktopSyncPlaylistConflict,
DesktopSyncSummary,
} from '@/types/desktopSync';
const AUTO_SYNC_DEBOUNCE_MS = 5_000;
const AUTO_SYNC_MIN_INTERVAL_MS = 15 * 60_000;
const AUTO_SYNC_SETTING_KEY = 'desktop_sync_auto';
export type DesktopSyncStatus = 'idle' | 'syncing' | 'error';
export type DesktopSyncAutoReason = 'discovery' | 'connected' | 'foreground';
interface DesktopSyncStore {
status: DesktopSyncStatus;
/** Wall-clock ms of the last successful sync with the paired desktop. */
lastSyncAt: number | null;
lastSummary: DesktopSyncSummary | null;
/** Playlists the last run refused to resolve automatically. */
conflicts: DesktopSyncPlaylistConflict[];
/** True while a NEW conflict awaits its once-per-session popup
* (SyncConflictPrompt); set by syncNow, cleared on dismiss/resolve. */
conflictPromptVisible: boolean;
errorMessage: string;
/** False once the paired desktop reported a pre-sync protocol version. */
supported: boolean;
/** Automatic syncing (foreground/discovery). Manual + desktop-requested
* syncs run regardless. */
autoSyncEnabled: boolean;
hydrate: () => Promise<void>;
syncNow: () => Promise<void>;
dismissConflictPrompt: () => void;
setAutoSyncEnabled: (enabled: boolean) => Promise<void>;
resolveConflict: (
conflict: DesktopSyncPlaylistConflict,
resolution: DesktopSyncConflictResolution
) => Promise<void>;
maybeAutoSync: (reason: DesktopSyncAutoReason) => void;
/** Desktop clicked Sync Now (or resolved a conflict there) — sync promptly,
* bypassing the auto-sync interval limits. */
handleSyncRequest: () => void;
}
let autoSyncDebounceTimer: ReturnType<typeof setTimeout> | null = null;
// One popup per conflict per app session — dismissing must not re-nag on the
// next sync run re-detecting the same conflicts.
const promptedConflictUids = new Set<string>();
export const useDesktopSyncStore = create<DesktopSyncStore>((set, get) => ({
status: 'idle',
lastSyncAt: null,
lastSummary: null,
conflicts: [],
conflictPromptVisible: false,
errorMessage: '',
supported: true,
autoSyncEnabled: true,
hydrate: async () => {
try {
const db = await openLibraryDb();
const autoSetting = await getSetting(db, AUTO_SYNC_SETTING_KEY);
if (autoSetting !== null) {
set({ autoSyncEnabled: autoSetting !== '0' });
}
const connection = await getDesktopRemoteConnection();
if (!connection) return;
const stored = await getSetting(db, desktopSyncSettingKey(connection));
const lastSyncAt = stored ? Number(stored) : NaN;
if (Number.isFinite(lastSyncAt) && lastSyncAt > 0) {
set({ lastSyncAt });
}
} catch {
// Hydration is best-effort; the first sync will set lastSyncAt.
}
},
setAutoSyncEnabled: async (enabled) => {
set({ autoSyncEnabled: enabled });
try {
const db = await openLibraryDb();
await setSetting(db, AUTO_SYNC_SETTING_KEY, enabled ? '1' : '0');
} catch {
// The in-memory value still applies for this session.
}
},
syncNow: async () => {
if (get().status === 'syncing') return;
set({ status: 'syncing', errorMessage: '' });
try {
const summary = await runDesktopSync();
let conflictPromptVisible = get().conflictPromptVisible;
if (summary.conflicts.length === 0) {
promptedConflictUids.clear();
conflictPromptVisible = false;
} else if (summary.conflicts.some((conflict) => !promptedConflictUids.has(conflict.syncUid))) {
for (const conflict of summary.conflicts) {
promptedConflictUids.add(conflict.syncUid);
}
conflictPromptVisible = true;
}
set({
status: 'idle',
lastSyncAt: summary.finishedAt,
lastSummary: summary,
conflicts: summary.conflicts,
conflictPromptVisible,
supported: true,
});
} catch (error) {
set({
status: 'error',
errorMessage:
error instanceof Error && error.message.trim() ? error.message : 'Desktop sync failed.',
supported: !(error instanceof DesktopSyncUnsupportedError),
});
}
},
resolveConflict: async (conflict, resolution) => {
if (get().status === 'syncing') return;
try {
await applyDesktopSyncConflictResolution(conflict, resolution);
} catch (error) {
set({
status: 'error',
errorMessage:
error instanceof Error && error.message.trim()
? error.message
: 'Failed to resolve the sync conflict.',
});
return;
}
// Drop it optimistically; the follow-up sync re-detects anything unsettled.
set((state) => ({
conflicts: state.conflicts.filter((entry) => entry.syncUid !== conflict.syncUid),
}));
await get().syncNow();
},
dismissConflictPrompt: () => {
set({ conflictPromptVisible: false });
},
handleSyncRequest: () => {
const { status } = get();
if (status === 'syncing') return;
void get().syncNow();
},
maybeAutoSync: (reason) => {
const { status, lastSyncAt, supported, autoSyncEnabled } = get();
if (!supported || !autoSyncEnabled) return;
if (status === 'syncing') return;
if (AppState.currentState !== 'active') return;
if (lastSyncAt !== null && Date.now() - lastSyncAt < AUTO_SYNC_MIN_INTERVAL_MS) return;
// Discovery/connect events arrive in bursts — coalesce them.
if (autoSyncDebounceTimer !== null) clearTimeout(autoSyncDebounceTimer);
autoSyncDebounceTimer = setTimeout(() => {
autoSyncDebounceTimer = null;
void (async () => {
const state = useDesktopSyncStore.getState();
if (state.status === 'syncing') return;
if (AppState.currentState !== 'active') return;
if (state.lastSyncAt !== null && Date.now() - state.lastSyncAt < AUTO_SYNC_MIN_INTERVAL_MS) return;
// Automatic triggers are speculative — probe reachability first so an
// off-LAN desktop doesn't surface an error banner from an attempt the
// user never asked for.
const connection = await getDesktopRemoteConnection();
if (!connection) return;
const identity = await fetchDesktopRemoteIdentity(connection.baseUrl);
if (!identity) return;
void state.syncNow();
})();
}, AUTO_SYNC_DEBOUNCE_MS);
void reason;
},
}));