Skip to content

Align sync-server record and CRDT transports #178

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
h4yfans merged 1 commit into from
Apr 8, 2026
Merged

Align sync-server record and CRDT transports #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
176 changes: 166 additions & 10 deletions apps/sync-server/src/routes/sync.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,20 @@ vi.mock('../services/sync', () => ({
hasMore: false,
nextCursor: 0
}),
processPushItem: vi.fn().mockResolvedValue({ accepted: true, serverCursor: 1 }),
processRecordPushBatch: vi.fn().mockResolvedValue({
accepted: ['550e8400-e29b-41d4-a716-446655440000'],
rejected: [],
serverTime: 1000,
maxCursor: 1,
outcomes: [
{
id: '550e8400-e29b-41d4-a716-446655440000',
type: 'note',
accepted: true,
serverCursor: 1
}
]
}),
pullItems: vi.fn().mockResolvedValue([]),
getItem: vi.fn().mockResolvedValue({
itemId: '550e8400-e29b-41d4-a716-446655440000',
Expand All @@ -36,6 +49,15 @@ vi.mock('../services/sync', () => ({
updateDeviceCursor: vi.fn().mockResolvedValue(undefined)
}))

vi.mock('../services/crdt', () => ({
storeUpdates: vi.fn().mockResolvedValue([1]),
getUpdates: vi.fn().mockResolvedValue({ updates: [], hasMore: false }),
getBatchUpdates: vi.fn().mockResolvedValue({}),
storeSnapshot: vi.fn().mockResolvedValue({ sequenceNum: 0 }),
getSnapshot: vi.fn().mockResolvedValue(null),
pruneUpdatesBeforeSnapshot: vi.fn().mockResolvedValue(0)
}))

vi.mock('../services/device', () => ({
updateDevice: vi.fn().mockResolvedValue(undefined)
}))
Expand Down Expand Up @@ -65,11 +87,12 @@ import {
getSyncStatus,
getManifest,
getChanges,
processPushItem,
processRecordPushBatch,
pullItems,
getItem,
updateDeviceCursor
} from '../services/sync'
import { storeUpdates } from '../services/crdt'
import { authMiddleware } from '../middleware/auth'
import { updateDevice } from '../services/device'

Expand Down Expand Up @@ -133,6 +156,24 @@ const makePushItem = (overrides: Record<string, unknown> = {}) => ({
...overrides
})

const makePushBatchResult = (
overrides: Partial<Awaited<ReturnType<typeof processRecordPushBatch>>> = {}
) => ({
accepted: [VALID_UUID],
rejected: [],
serverTime: 1000,
maxCursor: 1,
outcomes: [
{
id: VALID_UUID,
type: 'note' as const,
accepted: true,
serverCursor: 1
}
],
...overrides
})

// ============================================================================
// Tests
// ============================================================================
Expand Down Expand Up @@ -354,10 +395,21 @@ describe('sync routes', () => {

it('should collect rejected items with reasons', async () => {
// #given
vi.mocked(processPushItem).mockResolvedValueOnce({
accepted: false,
reason: 'VERSION_CONFLICT'
})
vi.mocked(processRecordPushBatch).mockResolvedValueOnce(
makePushBatchResult({
accepted: [],
rejected: [{ id: VALID_UUID, reason: 'VERSION_CONFLICT' }],
maxCursor: 0,
outcomes: [
{
id: VALID_UUID,
type: 'note',
accepted: false,
reason: 'VERSION_CONFLICT'
}
]
})
)
const body = { items: [makePushItem()] }

// #when
Expand Down Expand Up @@ -448,10 +500,21 @@ describe('sync routes', () => {

it('should not update device last_sync_at when all items rejected', async () => {
// #given
vi.mocked(processPushItem).mockResolvedValueOnce({
accepted: false,
reason: 'VERSION_CONFLICT'
})
vi.mocked(processRecordPushBatch).mockResolvedValueOnce(
makePushBatchResult({
accepted: [],
rejected: [{ id: VALID_UUID, reason: 'VERSION_CONFLICT' }],
maxCursor: 0,
outcomes: [
{
id: VALID_UUID,
type: 'note',
accepted: false,
reason: 'VERSION_CONFLICT'
}
]
})
)
const body = { items: [makePushItem()] }

// #when
Expand All @@ -468,6 +531,19 @@ describe('sync routes', () => {

it('should accept non-UUID item IDs when payload otherwise validates', async () => {
// #given
vi.mocked(processRecordPushBatch).mockResolvedValueOnce(
makePushBatchResult({
accepted: ['not-a-uuid'],
outcomes: [
{
id: 'not-a-uuid',
type: 'note',
accepted: true,
serverCursor: 1
}
]
})
)
const body = { items: [makePushItem({ id: 'not-a-uuid' })] }

// #when
Expand All @@ -488,6 +564,20 @@ describe('sync routes', () => {
})
)
})

it('should pass the parsed record batch to processRecordPushBatch', async () => {
const body = { items: [makePushItem()] }

await app.request('http://localhost/sync/push', jsonPost('/sync/push', body), env, executionCtx)

expect(processRecordPushBatch).toHaveBeenCalledWith(
env.DB,
env.STORAGE,
'user-1',
'device-1',
[makePushItem()]
)
})
})

// ==========================================================================
Expand Down Expand Up @@ -608,4 +698,70 @@ describe('sync routes', () => {
expect(json.error.code).toBe(ErrorCodes.VALIDATION_ERROR)
})
})

describe('record transport aliases', () => {
it('supports /sync/records/push while keeping legacy /sync/push intact', async () => {
const body = { items: [makePushItem()] }

const res = await app.request(
'http://localhost/sync/records/push',
jsonPost('/sync/records/push', body),
env,
executionCtx
)

expect(res.status).toBe(200)
expect(processRecordPushBatch).toHaveBeenCalledWith(
env.DB,
env.STORAGE,
'user-1',
'device-1',
[makePushItem()]
)
})

it('supports /sync/records/pull', async () => {
const body = { itemIds: [VALID_UUID] }

const res = await app.request(
'http://localhost/sync/records/pull',
jsonPost('/sync/records/pull', body),
env,
executionCtx
)

expect(res.status).toBe(200)
expect(pullItems).toHaveBeenCalledWith(env.DB, env.STORAGE, 'user-1', [VALID_UUID])
})
})

describe('CRDT transport separation', () => {
it('routes /sync/crdt/updates through CRDT services instead of record push', async () => {
const payload = { noteId: 'note_1', updates: [btoa('hello')] }

const res = await app.request(
'http://localhost/sync/crdt/updates',
jsonPost('/sync/crdt/updates', payload),
env,
executionCtx
)

expect(res.status).toBe(200)
expect(storeUpdates).toHaveBeenCalledTimes(1)
expect(processRecordPushBatch).not.toHaveBeenCalled()
})

it('returns 400 for invalid CRDT update payloads', async () => {
const res = await app.request(
'http://localhost/sync/crdt/updates',
jsonPost('/sync/crdt/updates', { noteId: 'bad note id!', updates: [] }),
env,
executionCtx
)

expect(res.status).toBe(400)
const json = (await res.json()) as { error: { code: string } }
expect(json.error.code).toBe(ErrorCodes.VALIDATION_ERROR)
})
})
})
Loading
Loading