Skip to content

feat: add sync stream context, deprecate GetMetadata #183

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
toddbaert merged 2 commits into from
Mar 19, 2025
Merged

feat: add sync stream context, deprecate GetMetadata #183

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd6e6ed
feat: add sync stream type and context
toddbaert Mar 8, 2025
7af5f1e
fixup: remove type
toddbaert Mar 13, 2025
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
12 changes: 10 additions & 2 deletions protobuf/flagd/sync/v1/sync.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ message SyncFlagsRequest {
message SyncFlagsResponse {
// flagd feature flag configuration. Must be validated to schema - https://raw.githubusercontent.com/open-feature/schemas/main/json/flagd-definitions.json
string flag_configuration = 1;
// Static context to be included in in-process evaluations (optional).
optional google.protobuf.Struct sync_context = 2;
}

// FetchAllFlagsRequest is the request to fetch all flags. Clients send this request as the client in order to resync their internal state
Expand All @@ -62,17 +64,23 @@ message FetchAllFlagsResponse {
}

// GetMetadataRequest is the request for retrieving metadata from the sync service
message GetMetadataRequest {}
message GetMetadataRequest {
option deprecated = true;
}

// GetMetadataResponse contains metadata from the sync service
// DEPRECATED; use flagd.sync.v1.SyncFlagsResponse.sync_context
message GetMetadataResponse {
reserved 1; // old key/value metadata impl
google.protobuf.Struct metadata = 2;
option deprecated = true;
}

// FlagService implements a server streaming to provide realtime flag configurations
service FlagSyncService {
rpc SyncFlags(SyncFlagsRequest) returns (stream SyncFlagsResponse) {}
rpc FetchAllFlags(FetchAllFlagsRequest) returns (FetchAllFlagsResponse) {}
rpc GetMetadata(GetMetadataRequest) returns (GetMetadataResponse) {}
rpc GetMetadata(GetMetadataRequest) returns (GetMetadataResponse) {
option deprecated = true;
}
}