Migrations/bookorbit
1
0
Fork 0
mirror of https://github.com/bookorbit/bookorbit.git synced 2026-11-03 00:11:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

fix(annotations): clear KOReader state on device removal

Browse Source 
Remove device-scoped annotation delivery state with the rest of its KOReader data so stale acknowledgements cannot block permanent deletion.

Fixes #1576
This commit is contained in:
neon
2026-09-29 00:24:27 +00:00
parent a572badecb
commit 7e3bb1892e
2 changed files with 53 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/src/modules/koreader/koreader.repository.test.ts
+19 -8
View File
@@ -1,4 +1,6 @@
import { beforeEach, describe, expect, it, vi } from 'vitest';
import type { SQL } from 'drizzle-orm';
import { PgDialect } from 'drizzle-orm/pg-core';
import { createCapturingDb } from '../../common/test-utils/capture-sql-db';
import { sqlChunkText } from '../../common/test-utils/sql-chunk-text';
import { KoreaderRepository } from './koreader.repository';
@@ -848,7 +850,7 @@ describe('KoreaderRepository', () => {
await expect(repo.getTotalSyncedBooks(42)).resolves.toBe(0);
});
it('removeDevice deletes progress/sweep/page-stat/unmatched-device-link rows and cleans up orphaned unmatched books, summing everything', async () => {
it('removeDevice deletes annotation sync state with the device data and sums every removed row', async () => {
const returning = vi
.fn()
.mockResolvedValueOnce([{ id: 1 }, { id: 2 }]) // device progress
@@ -856,20 +858,28 @@ describe('KoreaderRepository', () => {
.mockResolvedValueOnce([{ id: 5 }]) // page stats
.mockResolvedValueOnce([{ hash: 'a'.repeat(32) }]) // unmatched-book device links
.mockResolvedValueOnce([]) // device settings
.mockResolvedValueOnce([{ id: 8 }, { id: 9 }]) // annotation sync state
.mockResolvedValueOnce([{ hash: 'a'.repeat(32) }]); // orphaned unmatched books cleanup
const txDeleteBuilder = { where: vi.fn().mockReturnValue({ returning }) };
const txSelectBuilder = { from: vi.fn().mockReturnValue({ where: vi.fn().mockReturnValue('SUBQUERY') }) };
const tx = { delete: vi.fn().mockReturnValue(txDeleteBuilder), select: vi.fn().mockReturnValue(txSelectBuilder) };
db.transaction.mockImplementation(async (handler: (client: typeof tx) => Promise<number>) => handler(tx));
await expect(repo.removeDevice(42, 'device-1')).resolves.toBe(6);
await expect(repo.removeDevice(42, 'device-1')).resolves.toBe(8);
expect(db.transaction).toHaveBeenCalledTimes(1);
// Six data deletes plus the retirement marker, which is cleared without being counted.
expect(tx.delete).toHaveBeenCalledTimes(7);
expect(txDeleteBuilder.where).toHaveBeenCalledTimes(7);
expect(returning).toHaveBeenCalledTimes(6);
// Seven returning deletes plus the retirement marker, which is cleared without being counted.
expect(tx.delete).toHaveBeenCalledTimes(8);
expect(txDeleteBuilder.where).toHaveBeenCalledTimes(8);
expect(returning).toHaveBeenCalledTimes(7);
expect(tx.select).toHaveBeenCalledTimes(1);
const annotationStateFilter = txDeleteBuilder.where.mock.calls[5]![0] as SQL;
const annotationStateQuery = new PgDialect().sqlToQuery(annotationStateFilter);
expect(annotationStateQuery.sql).toContain('"annotation_sync_state"."user_id" = $1');
expect(annotationStateQuery.sql).toContain('"annotation_sync_state"."source" = $2');
expect(annotationStateQuery.sql).toContain('"annotation_sync_state"."device_id" = $3');
expect(annotationStateQuery.params).toEqual([42, 'koreader', 'device-1']);
});
it('removeDevice skips the orphaned unmatched-book cleanup when the device had no unmatched-book links', async () => {
@@ -879,14 +889,15 @@ describe('KoreaderRepository', () => {
.mockResolvedValueOnce([])
.mockResolvedValueOnce([])
.mockResolvedValueOnce([]) // no unmatched-book device links removed
.mockResolvedValueOnce([]); // no device settings removed
.mockResolvedValueOnce([]) // no device settings removed
.mockResolvedValueOnce([]); // no annotation sync state removed
const txDeleteBuilder = { where: vi.fn().mockReturnValue({ returning }) };
const tx = { delete: vi.fn().mockReturnValue(txDeleteBuilder), select: vi.fn() };
db.transaction.mockImplementation(async (handler: (client: typeof tx) => Promise<number>) => handler(tx));
await expect(repo.removeDevice(42, 'device-1')).resolves.toBe(1);
expect(tx.delete).toHaveBeenCalledTimes(6);
expect(tx.delete).toHaveBeenCalledTimes(7);
expect(tx.select).not.toHaveBeenCalled();
});
server/src/modules/koreader/koreader.repository.ts
+34 -22
View File
@@ -986,28 +986,39 @@ export class KoreaderRepository {
async removeDevice(userId: number, deviceId: string): Promise<number> {
return this.db.transaction(async (tx) => {
const [deletedProgress, deletedSweep, deletedPageStats, deletedUnmatchedDeviceLinks, deletedDeviceSettings] = await Promise.all([
tx
.delete(schema.koreaderDeviceProgress)
.where(and(eq(schema.koreaderDeviceProgress.userId, userId), eq(schema.koreaderDeviceProgress.deviceId, deviceId)))
.returning({ id: schema.koreaderDeviceProgress.id }),
tx
.delete(schema.koreaderDeviceSweeps)
.where(and(eq(schema.koreaderDeviceSweeps.userId, userId), eq(schema.koreaderDeviceSweeps.deviceId, deviceId)))
.returning({ deviceId: schema.koreaderDeviceSweeps.deviceId }),
tx
.delete(schema.koreaderPageStats)
.where(and(eq(schema.koreaderPageStats.userId, userId), eq(schema.koreaderPageStats.deviceId, deviceId)))
.returning({ id: schema.koreaderPageStats.id }),
tx
.delete(schema.koreaderUnmatchedBookDevices)
.where(and(eq(schema.koreaderUnmatchedBookDevices.userId, userId), eq(schema.koreaderUnmatchedBookDevices.deviceId, deviceId)))
.returning({ hash: schema.koreaderUnmatchedBookDevices.hash }),
tx
.delete(schema.koreaderDeviceSettings)
.where(and(eq(schema.koreaderDeviceSettings.userId, userId), eq(schema.koreaderDeviceSettings.deviceId, deviceId)))
.returning({ deviceId: schema.koreaderDeviceSettings.deviceId }),
]);
const [deletedProgress, deletedSweep, deletedPageStats, deletedUnmatchedDeviceLinks, deletedDeviceSettings, deletedAnnotationSyncState] =
await Promise.all([
tx
.delete(schema.koreaderDeviceProgress)
.where(and(eq(schema.koreaderDeviceProgress.userId, userId), eq(schema.koreaderDeviceProgress.deviceId, deviceId)))
.returning({ id: schema.koreaderDeviceProgress.id }),
tx
.delete(schema.koreaderDeviceSweeps)
.where(and(eq(schema.koreaderDeviceSweeps.userId, userId), eq(schema.koreaderDeviceSweeps.deviceId, deviceId)))
.returning({ deviceId: schema.koreaderDeviceSweeps.deviceId }),
tx
.delete(schema.koreaderPageStats)
.where(and(eq(schema.koreaderPageStats.userId, userId), eq(schema.koreaderPageStats.deviceId, deviceId)))
.returning({ id: schema.koreaderPageStats.id }),
tx
.delete(schema.koreaderUnmatchedBookDevices)
.where(and(eq(schema.koreaderUnmatchedBookDevices.userId, userId), eq(schema.koreaderUnmatchedBookDevices.deviceId, deviceId)))
.returning({ hash: schema.koreaderUnmatchedBookDevices.hash }),
tx
.delete(schema.koreaderDeviceSettings)
.where(and(eq(schema.koreaderDeviceSettings.userId, userId), eq(schema.koreaderDeviceSettings.deviceId, deviceId)))
.returning({ deviceId: schema.koreaderDeviceSettings.deviceId }),
tx
.delete(schema.annotationSyncState)
.where(
and(
eq(schema.annotationSyncState.userId, userId),
eq(schema.annotationSyncState.source, 'koreader'),
eq(schema.annotationSyncState.deviceId, deviceId),
),
)
.returning({ id: schema.annotationSyncState.id }),
]);
// Not counted towards the deleted-row total: a marker on its own never made the device listable.
await tx
@@ -1047,6 +1058,7 @@ export class KoreaderRepository {
deletedPageStats.length +
deletedUnmatchedDeviceLinks.length +
deletedDeviceSettings.length +
deletedAnnotationSyncState.length +
deletedUnmatchedBooks.length
);
});