feat: versioned objects and migrations for syft-client - #9464
Draft
bitsofsteve wants to merge 16 commits into
Draft
feat: versioned objects and migrations for syft-client#9464bitsofsteve wants to merge 16 commits into
bitsofsteve wants to merge 16 commits into
Conversation
pjwerneck
approved these changes
Jul 24, 2026
pjwerneck
left a comment
Collaborator
There was a problem hiding this comment.
No major issues found. Excellent PR.
Some high-level concerns:
- The PeerManager - storage coupling via a shared mutable dict is fragile, and apparently already caused a bug fixed in this PR (the
peer_schemas or {}check). The assumption that the dict must not be copied is an unwritten contract easy to overlook. - Every peer of every version must be capable of parsing every future version file, and
VersionInfosays changes must be additive-only, but there's nothing enforcing that. It's a convention that everything new must be optional, but there's nothing preventing someone from adding aVersionInfoV3with a new required field, breaking old readers. I'd add a hard check, like a__init_subclass__method that verifies newVersionInfosubclasses on creation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Versioned objects for syft-client with migrations, plus peer protocol-schema exchange wired into JobStorage and DatasetStorage.
VersionInfo(SYFT_version.json): V1 + V2. V2 advertises slim protocol schemas for syft-client/syft-job/syft-dataset; first migrations (v1<->v2).ProposedFileChangesMessage(msgv2) andFileChangeEventsMessage: envelopes are the migratable units; items stay unregistered so checkpoint/cache payloads are unchanged.PeerManager.live_peer_schemas(protocol)feeds live peer schemas intoJobStorage/DatasetStorage: jobs negotiate per peer, datasets per audience. Also fixespeer_schemas or {}dropping the shared reference in both storages.Out of scope: checkpoints,
Peer/SYFT_peers.json, local caches, the semver handshake (unchanged).One wave per commit; green at every commit.