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

Have serde serialization match strum. #7

Merged
merged 4 commits into from
Jun 21, 2024

Conversation

csasarak
Copy link
Contributor

Overview

The serialization Serde was producing didn't match what we expected it to. This PR adds renames so that our external serialization is correct as well as tests to keep them updated/in-sync.

I bumped the version to 3 since technically this change is breaking I think - even though in reality I'm not sure it actually would.

Acceptance criteria

  • lib-fingerprint outputs the new serialization for fingerprint kinds.

Testing plan

  • Test which checks that every value of the Kind enum matches a known good external serialization with no duplicates.
  • Test that serde output matches strum.

Risks

If something else depends on the serde deserialization for Kind then that code could break/data could need to be fixed.

Checklist

  • I added tests for this PR's change (or explained in the PR description why tests don't make sense).

@csasarak csasarak requested a review from jssblck June 21, 2024 19:22
@csasarak csasarak requested a review from a team as a code owner June 21, 2024 19:22
tests/it/code_vsi.rs Outdated Show resolved Hide resolved
@jssblck
Copy link
Member

jssblck commented Jun 21, 2024

I bumped the version to 3 since technically this change is breaking I think - even though in reality I'm not sure it actually would.

Yes, this is considered a breaking change since it changes the output data shape 👍🏻

Co-authored-by: Jessica Black <[email protected]>
@csasarak csasarak merged commit d7b85cb into main Jun 21, 2024
5 checks passed
@csasarak csasarak deleted the serde-renames-for-fingerprint-kinds branch June 21, 2024 19:52
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.

2 participants