Skip to content

Fix reported progress around compaction #616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 2, 2025
Merged

Fix reported progress around compaction #616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10a4319
Fix reported progress around compaction
simolus3 Jun 2, 2025
b046ebe
Add changeset
simolus3 Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/poor-donuts-call.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@powersync/common': patch
---

Fix reported progress around compactions / defrags on the sync service.
28 changes: 25 additions & 3 deletions packages/common/src/client/sync/stream/AbstractStreamingSyncImplementation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,7 +666,10 @@ The next upload iteration will be delayed.`);
if (progressForBucket) {
updatedProgress[data.bucket] = {
...progressForBucket,
sinceLast: progressForBucket.sinceLast + data.data.length
sinceLast: Math.min(
progressForBucket.sinceLast + data.data.length,
progressForBucket.targetCount - progressForBucket.atLast
)
};
}
}
Expand Down Expand Up @@ -730,17 +733,36 @@ The next upload iteration will be delayed.`);
private async updateSyncStatusForStartingCheckpoint(checkpoint: Checkpoint) {
const localProgress = await this.options.adapter.getBucketOperationProgress();
const progress: InternalProgressInformation = {};
let invalidated = false;

for (const bucket of checkpoint.buckets) {
const savedProgress = localProgress[bucket.bucket];
const atLast = savedProgress?.atLast ?? 0;
const sinceLast = savedProgress?.sinceLast ?? 0;

progress[bucket.bucket] = {
// The fallback priority doesn't matter here, but 3 is the one newer versions of the sync service
// will use by default.
priority: bucket.priority ?? 3,
atLast: savedProgress?.atLast ?? 0,
sinceLast: savedProgress?.sinceLast ?? 0,
atLast: atLast,
sinceLast: sinceLast,
targetCount: bucket.count ?? 0
};

if (bucket.count != null && bucket.count < atLast + sinceLast) {
// Either due to a defrag / sync rule deploy or a compaction operation, the size
// of the bucket shrank so much that the local ops exceed the ops in the updated
// bucket. We can't prossibly report progress in this case (it would overshoot 100%).
invalidated = true;
}
}

if (invalidated) {
for (const bucket in progress) {
const bucketProgress = progress[bucket];
bucketProgress.atLast = 0;
bucketProgress.sinceLast = 0;
}
}

this.updateSyncStatus({
Expand Down
190 changes: 137 additions & 53 deletions packages/node/tests/sync.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,77 +169,124 @@ describe('Sync', () => {
});

mockSyncServiceTest('different priorities', async ({ syncService }) => {
let database = await syncService.createDatabase();
database.connect(new TestConnector(), { connectionMethod: SyncStreamConnectionMethod.HTTP });
await vi.waitFor(() => expect(syncService.connectedListeners).toHaveLength(1));

syncService.pushLine({
checkpoint: {
last_op_id: '10',
buckets: [
bucket('a', 5, {priority: 0}),
bucket('b', 5, {priority: 2}),
]
}
});

// Should be at 0/10 for total progress (which is the same as the progress for prio 2), and a 0/5 towards prio 0.
await waitForProgress(database, [0, 10], [[0, [0, 5]], [2, [0, 10]]]);

pushDataLine(syncService, 'a', 5);
await waitForProgress(database, [5, 10], [[0, [5, 5]], [2, [5, 10]]]);

pushCheckpointComplete(syncService, 0);
await waitForProgress(database, [5, 10], [[0, [5, 5]], [2, [5, 10]]]);
let database = await syncService.createDatabase();
database.connect(new TestConnector(), { connectionMethod: SyncStreamConnectionMethod.HTTP });
await vi.waitFor(() => expect(syncService.connectedListeners).toHaveLength(1));

pushDataLine(syncService, 'b', 2);
await waitForProgress(database, [7, 10], [[0, [5, 5]], [2, [7, 10]]]);
syncService.pushLine({
checkpoint: {
last_op_id: '10',
buckets: [bucket('a', 5, { priority: 0 }), bucket('b', 5, { priority: 2 })]
}
});

// Before syncing b fully, send a new checkpoint
syncService.pushLine({
checkpoint: {
last_op_id: '14',
buckets: [
bucket('a', 8, {priority: 0}),
bucket('b', 6, {priority: 2}),
]
}
});
await waitForProgress(database, [7, 14], [[0, [5, 8]], [2, [7, 14]]]);
// Should be at 0/10 for total progress (which is the same as the progress for prio 2), and a 0/5 towards prio 0.
await waitForProgress(
database,
[0, 10],
[
[0, [0, 5]],
[2, [0, 10]]
]
);

pushDataLine(syncService, 'a', 3);
await waitForProgress(database, [10, 14], [[0, [8, 8]], [2, [10, 14]]]);
pushDataLine(syncService, 'a', 5);
await waitForProgress(
database,
[5, 10],
[
[0, [5, 5]],
[2, [5, 10]]
]
);

pushCheckpointComplete(syncService, 0);
await waitForProgress(database, [10, 14], [[0, [8, 8]], [2, [10, 14]]]);
pushCheckpointComplete(syncService, 0);
await waitForProgress(
database,
[5, 10],
[
[0, [5, 5]],
[2, [5, 10]]
]
);

pushDataLine(syncService, 'b', 2);
await waitForProgress(
database,
[7, 10],
[
[0, [5, 5]],
[2, [7, 10]]
]
);

// Before syncing b fully, send a new checkpoint
syncService.pushLine({
checkpoint: {
last_op_id: '14',
buckets: [bucket('a', 8, { priority: 0 }), bucket('b', 6, { priority: 2 })]
}
});
await waitForProgress(
database,
[7, 14],
[
[0, [5, 8]],
[2, [7, 14]]
]
);

pushDataLine(syncService, 'a', 3);
await waitForProgress(
database,
[10, 14],
[
[0, [8, 8]],
[2, [10, 14]]
]
);

pushDataLine(syncService, 'b', 4);
await waitForProgress(database, [14, 14], [[0, [8, 8]], [2, [14, 14]]]);
pushCheckpointComplete(syncService, 0);
await waitForProgress(
database,
[10, 14],
[
[0, [8, 8]],
[2, [10, 14]]
]
);

pushDataLine(syncService, 'b', 4);
await waitForProgress(
database,
[14, 14],
[
[0, [8, 8]],
[2, [14, 14]]
]
);

pushCheckpointComplete(syncService);
await waitForSyncStatus(database, (s) => s.downloadProgress == null);
pushCheckpointComplete(syncService);
await waitForSyncStatus(database, (s) => s.downloadProgress == null);
});

mockSyncServiceTest('uses correct state when reconnecting', async ({syncService}) => {
mockSyncServiceTest('uses correct state when reconnecting', async ({ syncService }) => {
let database = await syncService.createDatabase();
database.connect(new TestConnector(), { connectionMethod: SyncStreamConnectionMethod.HTTP });
await vi.waitFor(() => expect(syncService.connectedListeners).toHaveLength(1));

syncService.pushLine({
checkpoint: {
last_op_id: '10',
buckets: [
bucket('a', 5, {priority: 0}),
bucket('b', 5, {priority: 3}),
]
buckets: [bucket('a', 5, { priority: 0 }), bucket('b', 5, { priority: 3 })]
}
});

// Sync priority 0 completely, start with rest
pushDataLine(syncService, 'a', 5);
pushDataLine(syncService, 'b', 1);
pushCheckpointComplete(syncService, 0);
await database.waitForFirstSync({priority: 0});
await database.waitForFirstSync({ priority: 0 });

await database.close();
await vi.waitFor(() => expect(syncService.connectedListeners).toHaveLength(0));
Expand All @@ -248,19 +295,56 @@ describe('Sync', () => {
await vi.waitFor(() => expect(syncService.connectedListeners).toHaveLength(1));

expect(syncService.connectedListeners[0].buckets).toStrictEqual([
{"name": "a", "after": "10"},
{"name": "b", "after": "6"},
{ name: 'a', after: '10' },
{ name: 'b', after: '6' }
]);
});

mockSyncServiceTest('interrupt and defrag', async ({ syncService }) => {
let database = await syncService.createDatabase();
database.connect(new TestConnector(), { connectionMethod: SyncStreamConnectionMethod.HTTP });
await vi.waitFor(() => expect(syncService.connectedListeners).toHaveLength(1));

syncService.pushLine({
checkpoint: {
last_op_id: '10',
buckets: [bucket('a', 10)]
}
});

await waitForProgress(database, [0, 10]);
pushDataLine(syncService, 'a', 5);
await waitForProgress(database, [5, 10]);

// Re-open database
await database.close();
await vi.waitFor(() => expect(syncService.connectedListeners).toHaveLength(0));
database = await syncService.createDatabase();
database.connect(new TestConnector(), { connectionMethod: SyncStreamConnectionMethod.HTTP });
await vi.waitFor(() => expect(syncService.connectedListeners).toHaveLength(1));

// A sync rule deploy could reset buckets, making the new bucket smaller than the existing one.
syncService.pushLine({
checkpoint: {
last_op_id: '14',
buckets: [bucket('a', 4)]
}
});

// In this special case, don't report 5/4 as progress.
await waitForProgress(database, [0, 4]);
pushCheckpointComplete(syncService);
await waitForSyncStatus(database, (s) => s.downloadProgress == null);
});
});
});

function bucket(name: string, count: number, options: {priority: number} = {priority: 3}): BucketChecksum {
function bucket(name: string, count: number, options: { priority: number } = { priority: 3 }): BucketChecksum {
return {
bucket: name,
count,
checksum: 0,
priority: options.priority,
priority: options.priority
};
}

Expand Down