Skip to content

docs(spec): let a device leave collections out of a link - #109

Merged
A-EDev merged 1 commit into
mainfrom
docs/spec-leave-collections-out
Nov 15, 2026
Merged

A-EDev merged 1 commit into
mainfrom
docs/spec-leave-collections-out

Conversation

@A-EDev

@A-EDev A-EDev commented Nov 14, 2026

Copy link
Copy Markdown
Contributor

Summary

  • spec/protocol.md, new section "Leaving collections out": a device MAY leave collections out of a link. It writes no batches of them, drops their batches as it reads them (they still count as consumed), and writes no snapshots of that link.
  • Taking a collection back reads it from the link's newest snapshot and the later batches, the way linking a profile does, before the device sends that collection again.
  • States that while no device keeps a link whole, nothing of that link is garbage collected and the store grows until its quota, and that apps SHOULD say so.
  • Snapshots and Acknowledgements point to the new section; the stale "(Desktop has no notes)" is removed.
  • CHANGELOG line under Protocol.

Related issue

Related to Flow-Tube/Flow#1075 (choose what each device syncs).

Change type

  • Bug fix
  • Feature
  • Refactor or maintenance
  • Documentation or specification
  • Build, packaging, or CI

Validation

  • pnpm check: Checked 154 files, no fixes applied
  • pnpm typecheck: passes
  • pnpm test: protocol 230 passed; server 143 passed, 3 skipped
  • Both apps implement it (Flow-Tube/Flow and Flow-Tube/Flow-Desktop PRs). Android was checked end to end against a local server: playlists left out on one device were acked but not applied, its own new playlist was held, and taking playlists back caught up from the logs before its playlist went out.

Risk and compatibility

  • No change to any format, label or the ack payload, so devices that don't know this section keep working; a device leaving collections out simply sends fewer batches and no snapshots.

  • No test vectors: nothing encoded changes.

  • Spec, reference implementation and vectors agree (protocol changes only).

  • No content, keys, tokens or IP addresses are logged.

  • Dependency and lockfile changes are intentional and limited to this PR.

@A-EDev
A-EDev merged commit 979912d into main Nov 15, 2026
10 checks passed
@A-EDev
A-EDev deleted the docs/spec-leave-collections-out branch November 15, 2026 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant