fix: prevent duplicate keys in MetadatumMap arbitrary generator#47
Merged
Conversation
The property-based test generator for MetadatumMap was creating invalid metadata by allowing duplicate keys (e.g., two empty strings). When duplicate keys were added to the Map, the second insertion would overwrite the first, causing a mismatch between the expected array length and actual Map size. This caused flaky test failures in AuxiliaryData.CML.test.ts when comparing Evolution SDK CBOR output with CML CBOR output. Fixed by using FastCheck.uniqueArray with a selector function that ensures unique keys based on their string values. Fixes intermittent CI failures in test/AuxiliaryData.CML.test.ts
Contributor
There was a problem hiding this comment.
Pull Request Overview
Fixes a test flakiness issue caused by duplicate keys in the MetadatumMap property-based test generator. The generator was creating invalid metadata maps where duplicate keys would overwrite each other, causing mismatches between expected and actual map sizes during CBOR serialization comparisons.
- Changed from
FastCheck.arraytoFastCheck.uniqueArrayto prevent duplicate keys - Added a selector function that ensures uniqueness based on the TextMetadatum string values
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
The property-based test generator for MetadatumMap was creating invalid metadata by allowing duplicate keys (e.g., two empty strings). When duplicate keys were added to the Map, the second insertion would overwrite the first, causing a mismatch between the expected array length and actual Map size.
This caused flaky test failures in AuxiliaryData.CML.test.ts when comparing Evolution SDK CBOR output with CML CBOR output.
Fixed by using FastCheck.uniqueArray with a selector function that ensures unique keys based on their string values.
Fixes intermittent CI failures in test/AuxiliaryData.CML.test.ts