Support backwards compatibility in from_avro_map/1 #40
Conversation
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
emiliano-at-prima
previously approved these changes
Feb 2, 2026
emiliano-at-prima
left a comment
emiliano-at-prima
left a comment
There was a problem hiding this comment.
the pr looks very good to me ❤️, if you need to release a new version quickly add a suite-py bump commit with a new minor
emiliano-at-prima
approved these changes
Feb 2, 2026
emiliano-at-prima
deleted the
support-backwards-compatibility-in-from-map
branch
|
released with 0.11.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The goal of this PR is to allow Avrogen-generated modules to be backwards compatible.
The problem with the current implementation is that, if a schema is evolved in a backwards-compatible way (e.g. a new nullable field is added), the
from_avro_map/1function generated from the new schema won't be able to decode payloads encoded with the old version of the schema. This happens because old payloads won't have the new nullable field, butfrom_avro_map/1is pattern matching all the map fields.With this PR, nullable fields are not matched in the function signature. This way, newer versions of modules can read payloads encoded with older versions.