fix: add schema version field to Event type for backward-compatible evolution - #1426
Open
ravimahatonp wants to merge 1 commit into
Open
ravimahatonp wants to merge 1 commit into
ravimahatonp wants to merge 1 commit into
Conversation
Contributor
|
@ravimahatonp is attempting to deploy a commit to the Mftee's projects Team on Vercel. A member of the Team first needs to authorize it. |
This branch has not been deployed
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.
Summary
Closes #1382
Problem
Events defined in
event.rshave no version field. Adding or removing fields later risks breaking existing webhook consumers and audit log parsers that expect a fixed shape, with no way to distinguish between schema revisions.Solution
version: u32field to theEventstruct with#[serde(default = "default_version")], defaulting to1.Event::new()are stamped withversion: 1.versionfield deserialize cleanly with the default, ensuring full backward compatibility.test_version_in_serialized_json— verifiesversionappears in JSON output.test_backward_compat_missing_version_defaults_to_1— verifies legacy JSON withoutversiondeserializes to version 1.version == 1.Why
#[serde(default)]?This ensures that any previously persisted events (e.g., in Redis audit trail) that lack the
versionkey can still be deserialized without errors, defaulting to schema version 1.