-
Notifications
You must be signed in to change notification settings - Fork 272
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.
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
Allow syncing to/from a local file #5543
Open
ChrisPenner
wants to merge
5
commits into
trunk
Choose a base branch
from
syncv2/file-sync
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains 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
ChrisPenner
force-pushed
the
syncv2/file-sync
branch
from
January 15, 2025 00:30
d75f173
to
d95114b
Compare
ChrisPenner
force-pushed
the
syncv2/file-sync
branch
from
January 15, 2025 01:18
801bd21
to
aea122d
Compare
ChrisPenner
force-pushed
the
syncv2/file-sync
branch
from
January 15, 2025 01:22
aea122d
to
65bdfd0
Compare
ChrisPenner
commented
Jan 16, 2025
ChrisPenner
commented
Jan 16, 2025
ChrisPenner
commented
Jan 17, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This module contains the actual syncing logic.
ChrisPenner
force-pushed
the
syncv2/file-sync
branch
from
January 17, 2025 19:08
84761a4
to
b4adcb6
Compare
ChrisPenner
changed the title
[WIP] Allow syncing to/from a local file
Allow syncing to/from a local file
Jan 17, 2025
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.
One step towards syncv2 is using the syncv2 protocol for local file syncing. We can proceed from there :)
Overview
As a stepping stone to integrating SyncV2: adds
sync.to-file
,sync.from-file
andsync.from-codebase
commands.The sync-file format will be identical to the stream emitted from Share (with possible exception of the framing boundary) so the majority of this code will be re-used then.
This may also possibly help with testing Unison code in CI, since it's much faster to
sync.from-file
than it is to pull from Share in CI, however even better than that would be to pull from Share quickly directly in CI, so of course work will continue on that.Note that this will be slightly slower than it can be because I've left all the temp-entity checks in place, when/if the time comes that we can switch fully to syncv2 we can remove those and get an additional speedup.
Implementation notes
sync.to-file
,sync.from-file
andsync.from-codebase
Interesting/controversial decisions
Test coverage
I've done manual testing of the new commands, but it would be good to start using them in CI as well, maybe we can ship a version of base using a Sync-file and use that to run base's unit tests against UCM builds in prod, that would've caught at least one runtime bug I shipped.
Also added property tests for serializing and deserializing stream formats.
Loose ends
sync.from*
is currently significantly slower than it needs to be, because all the queries which save to the codebase still check temp-entities and move dependents; which we don't need to do with this format. We can remove this slowdown once UCM is fully using syncV2 against share as well.