Skip to content

Add remote file change cursor and stable entry identity #3

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
zibo-chen merged 2 commits into from
Sep 24, 2026
Merged

Add remote file change cursor and stable entry identity #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b0a050
Add remote file change cursor and stable entry identity
zibo-chen Sep 24, 2026
e51fa5d
Document remote file revision and cursor semantics
zibo-chen Sep 24, 2026
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
18 changes: 18 additions & 0 deletions proto/files.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ message RemoteFileEntryInfo {
RemoteFileEntryKind kind = 3;
uint64 size = 4;
int64 modified_at_ms = 5;
// The revision changes when the entry content or metadata changes.
string revision = 6;
// The ID stays stable when the entry is renamed within the share.
string id = 7;
}

message RemoteFileListSharesRequest {}
Expand Down Expand Up @@ -135,6 +139,14 @@ message RemoteFileConditionalUploadRequest {
string expected_revision = 5;
}

// A long-poll cursor for changes to a shared folder. A new epoch means the
// caller must reconcile its previously enumerated directories before waiting.
message RemoteFileWatchChangesRequest {
string share_id = 1;
string epoch = 2;
uint64 after_sequence = 3;
}

message RemoteFileRequestFrame {
oneof body {
RemoteFileListSharesRequest list_shares = 10;
Expand All @@ -150,6 +162,7 @@ message RemoteFileRequestFrame {
RemoteFileReadRangeRequest read_range = 20;
RemoteFileConditionalUploadRequest conditional_upload = 21;
RemoteFileConditionalDeleteRequest conditional_delete = 22;
RemoteFileWatchChangesRequest watch_changes = 23;
}
}

Expand All @@ -165,6 +178,11 @@ message RemoteFileResponseFrame {
optional RemoteFileErrorCode error_code = 9;
string revision = 10;
bytes range_data = 11;
string change_epoch = 12;
// Sequence numbers are scoped to change_epoch.
uint64 change_sequence = 13;
repeated string changed_directories = 14;
bool change_reset = 15;
}

enum RemoteFileErrorCode {
Expand Down
Loading