aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/client/sync/queue.ts
blob: 984edc383b0a6d52d015185e63c5b9a4ac1b1dfe (plain)
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
import {
	db,
	type LocalCard,
	type LocalDeck,
	type LocalNote,
	type LocalNoteFieldType,
	type LocalNoteFieldValue,
	type LocalNoteType,
	type LocalReviewLog,
} from "../db/index";
import {
	localCardRepository,
	localDeckRepository,
	localNoteFieldTypeRepository,
	localNoteFieldValueRepository,
	localNoteRepository,
	localNoteTypeRepository,
	localReviewLogRepository,
} from "../db/repositories";

/**
 * Sync status enum for tracking queue state
 */
export const SyncStatus = {
	Idle: "idle",
	Syncing: "syncing",
	Error: "error",
} as const;

export type SyncStatusType = (typeof SyncStatus)[keyof typeof SyncStatus];

/**
 * Pending changes to be pushed to the server
 */
export interface PendingChanges {
	decks: LocalDeck[];
	cards: LocalCard[];
	reviewLogs: LocalReviewLog[];
	noteTypes: LocalNoteType[];
	noteFieldTypes: LocalNoteFieldType[];
	notes: LocalNote[];
	noteFieldValues: LocalNoteFieldValue[];
}

/**
 * Sync queue state
 */
export interface SyncQueueState {
	status: SyncStatusType;
	pendingCount: number;
	lastSyncVersion: number;
	lastSyncAt: Date | null;
	lastError: string | null;
}

const SYNC_STATE_KEY = "kioku_sync_state";

/**
 * Load sync state from localStorage
 */
function loadSyncState(): Pick<
	SyncQueueState,
	"lastSyncVersion" | "lastSyncAt"
> {
	const stored = localStorage.getItem(SYNC_STATE_KEY);
	if (!stored) {
		return { lastSyncVersion: 0, lastSyncAt: null };
	}
	try {
		const parsed = JSON.parse(stored) as {
			lastSyncVersion?: number;
			lastSyncAt?: string;
		};
		return {
			lastSyncVersion: parsed.lastSyncVersion ?? 0,
			lastSyncAt: parsed.lastSyncAt ? new Date(parsed.lastSyncAt) : null,
		};
	} catch {
		return { lastSyncVersion: 0, lastSyncAt: null };
	}
}

/**
 * Save sync state to localStorage
 */
function saveSyncState(lastSyncVersion: number, lastSyncAt: Date): void {
	localStorage.setItem(
		SYNC_STATE_KEY,
		JSON.stringify({
			lastSyncVersion,
			lastSyncAt: lastSyncAt.toISOString(),
		}),
	);
}

/**
 * Listener type for sync queue state changes
 */
export type SyncQueueListener = (state: SyncQueueState) => void;

/**
 * Sync Queue Manager
 *
 * Manages the queue of pending changes to be synchronized with the server.
 * Provides methods to:
 * - Get pending changes count
 * - Get pending changes to push
 * - Mark items as synced after successful push
 * - Handle sync state persistence
 */
export class SyncQueue {
	private status: SyncStatusType = SyncStatus.Idle;
	private lastError: string | null = null;
	private lastSyncVersion: number;
	private lastSyncAt: Date | null;
	private listeners: Set<SyncQueueListener> = new Set();

	constructor() {
		const saved = loadSyncState();
		this.lastSyncVersion = saved.lastSyncVersion;
		this.lastSyncAt = saved.lastSyncAt;
	}

	/**
	 * Subscribe to sync queue state changes
	 */
	subscribe(listener: SyncQueueListener): () => void {
		this.listeners.add(listener);
		return () => this.listeners.delete(listener);
	}

	/**
	 * Notify all listeners of state change
	 */
	private async notifyListeners(): Promise<void> {
		const state = await this.getState();
		for (const listener of this.listeners) {
			listener(state);
		}
	}

	/**
	 * Get all pending (unsynced) changes
	 */
	async getPendingChanges(): Promise<PendingChanges> {
		const [
			decks,
			cards,
			reviewLogs,
			noteTypes,
			noteFieldTypes,
			notes,
			noteFieldValues,
		] = await Promise.all([
			localDeckRepository.findUnsynced(),
			localCardRepository.findUnsynced(),
			localReviewLogRepository.findUnsynced(),
			localNoteTypeRepository.findUnsynced(),
			localNoteFieldTypeRepository.findUnsynced(),
			localNoteRepository.findUnsynced(),
			localNoteFieldValueRepository.findUnsynced(),
		]);

		return {
			decks,
			cards,
			reviewLogs,
			noteTypes,
			noteFieldTypes,
			notes,
			noteFieldValues,
		};
	}

	/**
	 * Get count of pending changes
	 */
	async getPendingCount(): Promise<number> {
		const changes = await this.getPendingChanges();
		return (
			changes.decks.length +
			changes.cards.length +
			changes.reviewLogs.length +
			changes.noteTypes.length +
			changes.noteFieldTypes.length +
			changes.notes.length +
			changes.noteFieldValues.length
		);
	}

	/**
	 * Check if there are any pending changes
	 */
	async hasPendingChanges(): Promise<boolean> {
		return (await this.getPendingCount()) > 0;
	}

	/**
	 * Get current sync queue state
	 */
	async getState(): Promise<SyncQueueState> {
		return {
			status: this.status,
			pendingCount: await this.getPendingCount(),
			lastSyncVersion: this.lastSyncVersion,
			lastSyncAt: this.lastSyncAt,
			lastError: this.lastError,
		};
	}

	/**
	 * Get the last sync version for pull requests
	 */
	getLastSyncVersion(): number {
		return this.lastSyncVersion;
	}

	/**
	 * Set sync status to syncing
	 */
	async startSync(): Promise<void> {
		this.status = SyncStatus.Syncing;
		this.lastError = null;
		await this.notifyListeners();
	}

	/**
	 * Mark sync as completed successfully
	 */
	async completeSync(newSyncVersion: number): Promise<void> {
		this.status = SyncStatus.Idle;
		this.lastSyncVersion = newSyncVersion;
		this.lastSyncAt = new Date();
		this.lastError = null;
		saveSyncState(this.lastSyncVersion, this.lastSyncAt);
		await this.notifyListeners();
	}

	/**
	 * Mark sync as failed
	 */
	async failSync(error: string): Promise<void> {
		this.status = SyncStatus.Error;
		this.lastError = error;
		await this.notifyListeners();
	}

	/**
	 * Mark items as synced after successful push
	 */
	async markSynced(results: {
		decks: { id: string; syncVersion: number }[];
		cards: { id: string; syncVersion: number }[];
		reviewLogs: { id: string; syncVersion: number }[];
		noteTypes: { id: string; syncVersion: number }[];
		noteFieldTypes: { id: string; syncVersion: number }[];
		notes: { id: string; syncVersion: number }[];
		noteFieldValues: { id: string; syncVersion: number }[];
	}): Promise<void> {
		await db.transaction(
			"rw",
			[
				db.decks,
				db.cards,
				db.reviewLogs,
				db.noteTypes,
				db.noteFieldTypes,
				db.notes,
				db.noteFieldValues,
			],
			async () => {
				for (const deck of results.decks) {
					await localDeckRepository.markSynced(deck.id, deck.syncVersion);
				}
				for (const card of results.cards) {
					await localCardRepository.markSynced(card.id, card.syncVersion);
				}
				for (const reviewLog of results.reviewLogs) {
					await localReviewLogRepository.markSynced(
						reviewLog.id,
						reviewLog.syncVersion,
					);
				}
				for (const noteType of results.noteTypes) {
					await localNoteTypeRepository.markSynced(
						noteType.id,
						noteType.syncVersion,
					);
				}
				for (const fieldType of results.noteFieldTypes) {
					await localNoteFieldTypeRepository.markSynced(
						fieldType.id,
						fieldType.syncVersion,
					);
				}
				for (const note of results.notes) {
					await localNoteRepository.markSynced(note.id, note.syncVersion);
				}
				for (const fieldValue of results.noteFieldValues) {
					await localNoteFieldValueRepository.markSynced(
						fieldValue.id,
						fieldValue.syncVersion,
					);
				}
			},
		);
		await this.notifyListeners();
	}

	/**
	 * Apply changes pulled from server
	 */
	async applyPulledChanges(data: {
		decks: LocalDeck[];
		cards: LocalCard[];
		reviewLogs: LocalReviewLog[];
		noteTypes: LocalNoteType[];
		noteFieldTypes: LocalNoteFieldType[];
		notes: LocalNote[];
		noteFieldValues: LocalNoteFieldValue[];
	}): Promise<void> {
		await db.transaction(
			"rw",
			[
				db.decks,
				db.cards,
				db.reviewLogs,
				db.noteTypes,
				db.noteFieldTypes,
				db.notes,
				db.noteFieldValues,
			],
			async () => {
				// Apply in dependency order: NoteTypes first, then dependent entities
				for (const noteType of data.noteTypes) {
					await localNoteTypeRepository.upsertFromServer(noteType);
				}
				for (const fieldType of data.noteFieldTypes) {
					await localNoteFieldTypeRepository.upsertFromServer(fieldType);
				}
				for (const deck of data.decks) {
					await localDeckRepository.upsertFromServer(deck);
				}
				for (const note of data.notes) {
					await localNoteRepository.upsertFromServer(note);
				}
				for (const fieldValue of data.noteFieldValues) {
					await localNoteFieldValueRepository.upsertFromServer(fieldValue);
				}
				for (const card of data.cards) {
					await localCardRepository.upsertFromServer(card);
				}
				for (const reviewLog of data.reviewLogs) {
					await localReviewLogRepository.upsertFromServer(reviewLog);
				}
			},
		);
		await this.notifyListeners();
	}

	/**
	 * Reset sync state (for logout or debugging)
	 */
	async reset(): Promise<void> {
		this.status = SyncStatus.Idle;
		this.lastSyncVersion = 0;
		this.lastSyncAt = null;
		this.lastError = null;
		localStorage.removeItem(SYNC_STATE_KEY);
		await this.notifyListeners();
	}
}

/**
 * Singleton instance of the sync queue
 */
export const syncQueue = new SyncQueue();