Change-feed endpoint: GET /api/v1/changes (unblocks near-instant desktop sync) #478
Closed
opened 2026-09-10 17:56:06 +00:00 by Cordy
·
2 comments
No Branch/Tag specified
main
b12v07
b11v07
b10v07
ci-rc-publish
fx15-s3dry
b9v07
b8v07
bench742
b7v07
legal-texts-v0.2
b6v07
b5v07
b4v07
b3v07
sx1139
st742
b2v07
ix1102
fu1098
zp1097
wd1099
tr1100
qf1077
nc1070
ci1
rp1072
lk1073
ab1071
fi1074
si1070
ra1054
wo1056
oc1057
tf1055
sv1063
fg1059
st1058
fs929
mu1039
ls1033
cf975
lf835
dx1023
ml896
a11y2
av1022
r913
r7
r6
r5
r45
r23
r1
b10
b9
fix-b5
fix-b4
fix-b3
fix-b2
fix-b1
fix-922
fix-923
fix-911
fix-343b
batch-a
v0.6.413
v0.6.412
v0.6.411
v0.6.410
v0.6.409
v0.6.408
v0.6.407
v0.6.406
v0.6.405
v0.6.404
v0.6.403
v0.6.402
v0.6.401
v0.6.400
v0.6.399
v0.6.398
v0.6.397
v0.6.396
v0.6.395
v0.6.394
v0.6.393
v0.6.392
v0.6.391
v0.6.390
v0.6.389
v0.6.388
v0.6.387
v0.6.386
v0.6.385
v0.6.384
v0.6.383
v0.6.382
v0.6.381
v0.6.380
v0.6.379
v0.6.378
v0.6.377
v0.6.376
v0.6.375
v0.6.374
v0.6.373
v0.6.372
v0.6.371
v0.6.370
v0.6.369
v0.6.368
v0.6.367
v0.6.366
v0.6.365
v0.6.364
v0.6.363
v0.6.362
v0.6.361
v0.6.360
v0.6.359
v0.6.358
v0.6.357
v0.6.356
v0.6.355
v0.6.354
v0.6.353
v0.6.352
v0.6.351
v0.6.350
v0.6.349
v0.6.348
v0.6.347
v0.6.346
v0.6.345
v0.6.344
v0.6.343
v0.6.342
v0.6.341
v0.6.340
v0.6.339
v0.6.338
v0.6.337
v0.6.336
v0.6.335
v0.6.334
v0.6.333
v0.6.332
v0.6.331
v0.6.330
v0.6.329
v0.6.328
v0.6.327
v0.6.326
v0.6.325
v0.6.324
v0.6.323
v0.6.322
v0.6.321
v0.6.320
v0.6.319
v0.6.318
v0.6.317
v0.6.316
v0.6.315
v0.6.314
v0.6.313
v0.6.312
v0.6.311
v0.6.310
v0.6.309
v0.6.308
v0.6.307
v0.6.306
v0.6.305
v0.6.304
v0.6.303
v0.6.302
v0.6.301
v0.6.300
v0.6.299
v0.6.298
v0.6.297
v0.6.296
v0.6.295
v0.6.294
v0.6.293
v0.6.292
v0.6.291
v0.6.290
v0.6.289
v0.6.288
v0.6.287
v0.6.286
v0.6.285
v0.6.284
v0.6.283
v0.6.282
v0.6.281
v0.6.280
v0.6.279
v0.6.278
v0.6.277
v0.6.276
v0.6.275
v0.6.274
v0.6.273
v0.6.272
v0.6.271
v0.6.270
v0.6.269
v0.6.268
v0.6.267
v0.6.266
v0.6.265
v0.6.264
v0.6.263
v0.6.262
v0.6.261
v0.6.260
v0.6.259
v0.6.258
v0.6.257
v0.6.256
v0.6.255
v0.6.254
v0.6.253
v0.6.252
v0.6.251
v0.6.250
v0.6.249
v0.6.248
v0.6.247
v0.6.246
v0.6.245
v0.6.244
v0.6.243
v0.6.242
v0.6.241
v0.6.240
v0.6.239
v0.6.238
v0.6.237
v0.6.236
v0.6.235
v0.6.234
v0.6.233
v0.6.232
v0.6.231
v0.6.230
v0.6.229
v0.6.228
v0.6.227
v0.6.226
v0.6.225
v0.6.224
v0.6.223
v0.6.222
v0.6.221
v0.6.220
v0.6.219
v0.6.218
v0.6.217
v0.6.216
v0.6.215
v0.6.214
v0.6.213
v0.6.212
v0.6.211
v0.6.210
v0.6.209
v0.6.208
v0.6.207
v0.6.206
v0.6.205
v0.6.204
v0.6.203
v0.6.202
v0.6.201
v0.6.200
v0.6.199
v0.6.198
v0.6.197
v0.6.196
v0.6.195
v0.6.194
v0.6.193
v0.6.192
v0.6.191
v0.6.190
v0.6.189
v0.6.188
v0.6.187
v0.6.186
v0.6.185
v0.6.184
v0.6.183
v0.6.182
v0.6.181
v0.6.180
v0.6.179
v0.6.178
v0.6.177
v0.6.176
v0.6.175
v0.6.174
v0.6.173
v0.6.172
v0.6.171
v0.6.170
v0.6.169
v0.6.168
v0.6.167
v0.6.166
v0.6.165
v0.6.164
v0.6.163
v0.6.162
v0.6.161
v0.6.160
v0.6.159
v0.6.158
v0.6.157
v0.6.156
v0.6.155
v0.6.154
v0.6.153
v0.6.152
v0.6.151
v0.6.150
v0.6.149
v0.6.148
v0.6.147
v0.6.146
v0.6.145
v0.6.144
v0.6.143
v0.6.142
v0.6.141
v0.6.140
v0.6.139
v0.6.138
v0.6.137
v0.6.136
v0.6.135
v0.6.134
v0.6.133
v0.6.132
v0.6.131
v0.6.130
v0.6.129
v0.6.128
v0.6.127
v0.6.126
v0.6.125
v0.6.124
v0.6.123
v0.6.122
v0.6.121
v0.6.120
v0.6.119
v0.6.118
v0.6.117
v0.6.116
v0.6.115
v0.6.114
v0.6.113
v0.6.112
v0.6.111
v0.6.110
v0.6.109
v0.6.108
v0.6.107
v0.6.106
v0.6.105
v0.6.104
v0.6.103
v0.6.102
v0.6.101
v0.6.100
v0.6.99
v0.6.98
v0.6.97
v0.6.96
v0.6.95
v0.6.94
v0.6.93
v0.6.92
v0.6.91
v0.6.90
v0.6.89
v0.6.88
v0.6.87
v0.6.86
v0.6.85
v0.6.84
v0.6.83
v0.6.82
v0.6.81
v0.6.80
v0.6.79
v0.6.78
v0.6.77
v0.6.76
v0.6.75
v0.6.74
v0.6.73
v0.6.72
v0.6.71
v0.6.70
v0.6.69
v0.6.68
v0.6.67
v0.6.66
v0.6.65
v0.6.64
v0.6.63
v0.6.62
v0.6.61
v0.6.60
v0.6.59
v0.6.58
v0.6.57
v0.6.56
v0.6.55
v0.6.54
v0.6.53
v0.6.52
v0.6.51
v0.6.50
v0.6.49
v0.6.48
v0.6.47
v0.6.46
v0.6.45
v0.6.44
v0.6.43
v0.6.42
v0.6.41
v0.6.40
v0.6.39
v0.6.38
v0.6.37
v0.6.36
v0.6.35
v0.6.34
v0.6.33
v0.6.32
v0.6.31
v0.6.30
v0.6.29
v0.6.28
v0.6.25
v0.6.24
v0.6.23
v0.6.22
v0.6.21
v0.6.20
v0.6.19
v0.6.18
v0.6.17
v0.6.16
v0.6.15
v0.6.14
v0.6.12
v0.6.11
v0.6.10
v0.6.9
v0.6.8
v0.6.7
v0.6.6
v0.6.5
v0.6.4
v0.6.3
v0.6.2
v0.6.1
v0.6.0
v0.5.7
v0.5.6
v0.5.5
v0.5.4
v0.5.3
v0.5.2
v0.5.1
v0.5.0
v0.4.12
v0.4.11
v0.4.10
v0.4.9
v0.4.8
v0.4.7
v0.4.6
v0.4.5
v0.4.4
v0.4.3
v0.4.2
v0.4.1
v0.3.30
v0.3.29
v0.3.28
v0.3.27
v0.3.26
v0.3.25
v0.3.24
v0.3.23
v0.3.22
v0.3.21
v0.3.20
v0.3.19
v0.3.18
v0.3.17
v0.3.16
v0.3.15
v0.3.14
v0.3.13
v0.3.12
v0.3.11
v0.3.10
v0.3.9
v0.3.8
v0.3.7
v0.3.6
v0.3.5
v0.3.4
v0.3.3
v0.3.2
v0.3.1
v0.3.0
v0.2.7
v0.2.6
v0.2.5
v0.2.4
v0.2.3
v0.2.2
v0.2.1
v0.2.0
v0.0.3
v0.0.2
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".
No due date set.
Dependencies
No dependencies set.
Reference: Cordy/Cairn#478
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Why
The desktop client (
Cordy/cairn-desktop) syncs over WebDAV, and plain WebDAV has no change feed. The client's only option is toPROPFINDthe whole tree on a timer. On a large tree that is expensive for the server and slow to react — a change made on machine A appears on machine B "sometime in the next 30 seconds", and the cost scales with tree size rather than with change volume.A cheap cursor-based delta endpoint fixes both. This is a small addition to an existing API surface, not a new subsystem, and it is what makes sync feel instant rather than eventually-consistent.
Referenced as a known gap in
cairn-desktop/docs/design-spec.md§3 and §10. The client ships poll-only in v1 and adopts this when it exists — so this is not a blocker for the client, it is an upgrade.Proposed shape
sinceomitted → return only the current cursor with an empty change list, so a fresh client can establish a starting point without replaying history.more: true→ the client should immediately request again with the new cursor.Three design points that matter
1. Scope it to the caller. Changes must be filtered to what that user can actually see — their home, their group spaces, honouring the same read-only and app-owned rules
internal/storage/scopealready enforces. A global feed would leak the existence and names of other users' files. This is the security-relevant part of the issue.2. Cursor expiry is mandatory, not optional. The journal will be pruned. A client that has been offline longer than the retention window must be told so explicitly rather than silently receiving an incomplete delta:
On
expired, the client falls back to a full reconciliation. Getting this wrong is a silent-divergence bug — the worst class for a sync product, because nothing appears to fail.3. The feed is advisory, never authoritative. Cairn's whole thesis is that the directory tree on disk is the data model, so files legitimately change underneath us —
rsync, a ZFS rollback, an S3 tool, an admin withmv. Those changes never pass through Cairn and cannot appear in a journal. The endpoint must therefore be documented as an optimisation over periodic full reconciliation, not a replacement for it. The client is already built this way: watchers are a hint, the full rescan is the backstop.Where the data comes from
Cairn already writes an append-only per-object access log in
internal/auditcovering writes, deletes and renames (never listings) — the same events this feed needs. Two options worth weighing in the design pass:I lean to the second, but it is worth a look at the audit driver before deciding.
Interaction with v0.6 (#138)
A change journal is runtime state, so it falls squarely under the state-in-backend work. Build it consistent with whatever #138 lands: if runtime state lives in
.cairn-state/, the journal lives there too. Sequencing is already right — this is v0.7, after v0.6 closes — but do not design the journal in isolation from #138's storage decisions.Also worth confirming against #138's two-writer analysis: if two pods can ever serve the same bucket, the cursor must remain monotonic across both, or clients will see changes go backwards.
Acceptance criteria
expired: truerather than a partial list.internal/api, following the existing patterns there.Out of scope
Push notification (WebSocket/SSE). Polling this endpoint is already dramatically cheaper than polling
PROPFIND, and push adds a connection-management problem for a fraction of the remaining benefit. Revisit only if the beta shows polling latency is still the complaint.Design assessment (2026-09-11, pre-build — recorded now, build deferred; the client ships poll-only v1 regardless):
Feasible cleanly, and the sequencing concern is already resolved. #138 closed 2026-08-10 and
internal/statestoreexists, so the journal has its settled home in encrypted.cairn-state/from day one — no need to design around an unlanded dependency.1. Journal source: separate lightweight journal, as leaned. The decorator precedent already sits at exactly the right layer — quota and the #423 marks decorator both wrap the shared
storage.Driver, the single chokepoint for API uploads, WebDAV PUT/DELETE/MOVE, tus finalisation and peering inbox delivery. A journal decorator recordingwrite/delete/move(Rename supplies from/to) is a small, well-trodden pattern. The journal needs no actor identity — filtering happens at read time — which cleanly sidesteps the audit-log privacy/retention coupling. Deriving from audit is rejected.2. Persistence tension + resolution: epoch cursors. The statestore persists whole JSON objects; a journal persisted append-per-write would rewrite the whole object on every file mutation (an extra S3 PUT per write). Resolution follows from this issue's own point 3 (advisory, never authoritative): in-memory ring buffer, debounced flush (every few seconds / N entries), and the cursor carries an epoch — journal loss or unclean shutdown bumps the epoch, and any old-epoch cursor answers
{"expired": true}, triggering the client's full reconciliation. Incompleteness is always declared, never partial, so the silent-divergence class is structurally closed rather than merely tested against.3. The bulk of the work is the visibility filter, as predicted here. Mapping backend-absolute journal paths to the caller's view (own home, member spaces, app-owned exclusions,
.cairn-state/never) and translating into the caller's namespace is the security-critical part and where most of the TDD effort belongs. Ingredients exist (internal/storage/scoperules,Spaces.Members). One decision to record when building: a newly joined space's history is not replayed — the client's reconciliation covers it; replaying pre-membership history would be both complex and a mild disclosure.4. Bonus since this issue was written: the #476 SSE hub now exists. Push stays out of scope as stated, but when the beta wants it, it is one
Publish(user, "changes")from the same decorator plus a topic case in the already-deployed client wiring — the cost of "revisit later" has dropped to near zero.Cursor shape: opaque base64 of
(epoch, seq), monotonic within an epoch; single-replicaRecreatekeeps monotonicity trivially today, and the #138 two-writer caveat carries over unchanged (multi-replica would need a shared sequencer — recorded, not built).No conflicts with the current tree. Effort estimate: one normal house TDD pass — decorator + ring/flush + epoch store (statestore), the
/api/v1/changeshandler with scope filtering, handbook section stating the advisory contract and reconciliation backstop, tests ininternal/apiper the acceptance list above.Shipped in v0.6.163 (PR #489, merged; live on the dogfood —
cairn_build_info{version="v0.6.163"}).What was built (per the design assessment above, all points held):
internal/changes— journal + decorator:Seq, entries{seq, at, type write|delete|move, path, from?}with backend-absolute paths and no actor identity.(epoch, seq)cursors. Any cursor from another epoch, from a pruned region of the ring, or from the future answers expired — never a partial list.changes.json, added to the s3 statePaths list so it lives in.cairn-state/. A clean shutdown resumes the epoch (changeJournal.Close()wired into the graceful-shutdown path), so cursors survive ordinary rollouts; a crash or lost journal starts a fresh epoch — the state is re-marked dirty immediately on resume, so only a properly closed journal is ever resumed.unscopedStore: REST, WebDAV, TUS, peering deliveries and public-share uploads are all recorded; deletes are recorded logically (above trash); only successful operations land — a hold/lock/read-only refusal never appears..cairn-state/writes are structurally excluded (statestore binds the raw driver) plus a defensive path skip.GET /api/v1/changes?since=&limit=500(internal/api/changes.go):since→{changes:[], cursor, more:false}(client does its own first scan)./home/<user>/x → /home/x; member spaces (IdP groups,-roread-only groups, app-owned via spacestore RoleFor) unchanged; other homes,/.trash/, state never. A move with one end out of view degrades honestly: moved away →deleteat the old path, moved in →writeat the new one. Invisible spans are drained server-side so pages are never empty whilemoreis true.docs/handbook/change-feed.md— protocol, what the feed contains, the advisory contract (backend-direct changes never appear; no space-history replay; reconciliation backstop required), operational notes.TDD: 13 tests (8 journal/decorator, 5 endpoint incl. scope filter, move degradation, epoch expiry, dirty-crash epoch bump, clean-close resume), witnessed red on the runner before implementation, full suite green.
Known gaps, documented as the advisory contract: admin trash restores call the trash driver below the journal wrap and are not recorded (they are backend-direct from the feed's point of view); SSE
changestopic push and the multi-replica sequencer stay deferred as agreed.Closing.