Fix non-deterministic field ordering in AnnotationSourceTSV annotation extraction#403
Merged
holmeso merged 3 commits intonanno_multi_genefrom Mar 3, 2026
Merged
Conversation
…erating over fieldNames.split() instead of HashMap keyset Co-authored-by: holmeso <7066552+holmeso@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] WIP Address feedback on handling multiple genes in snpeff variant reporting
Fix non-deterministic field ordering in AnnotationSourceTSV annotation extraction
Feb 27, 2026
Contributor
|
@copilot could you write a test for this please |
…nnotation output Co-authored-by: holmeso <7066552+holmeso@users.noreply.github.com>
Author
Added |
holmeso
approved these changes
Mar 3, 2026
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.
AnnotationSourceTSVwas iterating overHashMap.keySet()to build the precomputedfieldNames/fieldPositionsarrays, producing annotation output in arbitrary order rather than the user-requested field order.Changes
AnnotationSourceTSV.java: Replace keyset iteration withfieldNames.split(",")when building precomputed arrays. TheHashMapis retained for O(1) position lookups; only the iteration source changes.Since
getHeaderNameAndPositionsalso splits on","to build the map, the keys are guaranteed to match — no risk ofNullPointerExceptionat lookup time.AnnotationSourceTSVTest.java: AddedfieldOrderPreservedFromUserRequesttest that verifies fields are emitted in user-requested order. The test defines a header with fields in order (alpha,beta,gamma), requests them in reverse ("gamma,beta,alpha"), and asserts the output matches the user-requested order rather than the header/HashMap order.Type of change
Please delete options that are not relevant.
How Has This Been Tested?
AnnotationSourceTSVTestunit tests coverextractFieldsFromRecordandgetHeaderNameAndPositionsfieldOrderPreservedFromUserRequesttest verifies that annotation fields are emitted in the exact order the user requested, not in arbitraryHashMapkeyset orderAre WDL Updates Required?
No WDL changes required.
Checklist:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.