Skip to content
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

feat(platform)!: document serialization across versions #1594

Merged
merged 31 commits into from Nov 23, 2023

Conversation

QuantumExplorer
Copy link
Contributor

@QuantumExplorer QuantumExplorer commented Nov 22, 2023

Issue being fixed or feature implemented

If one would update a data contract by adding fields, the document serialization and deserialization would break.

What was done?

We added a position for each property in a document.
Deserialization now will work with and pair of document_type/version. For example if you deserialize a document serialized with version 1 with the document type of the contract version 3 the additional new fields will just be None.

How Has This Been Tested?

Wrote a few tests to verify this all worked.

Breaking Changes

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

@QuantumExplorer QuantumExplorer changed the title feat: document serialization across versions feat!: document serialization across versions Nov 23, 2023
@QuantumExplorer QuantumExplorer changed the title feat!: document serialization across versions feat(platform)!: document serialization across versions Nov 23, 2023
@QuantumExplorer QuantumExplorer merged commit fadd522 into v1.0-dev Nov 23, 2023
94 of 95 checks passed
@QuantumExplorer QuantumExplorer deleted the feat/documentSerializationAccrossVersions branch November 23, 2023 23:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants