Protect against merging CRAM files with different headers.#2220
Merged
Conversation
The protection of sharing incompatible references between multiple input files aren't strict enough. It was attempting to spot files with reordered references by checking the "lost_coord_sort" flag in the header translation table. However this doesn't cover the case where we are merging completely unrelated files that have no overlap in reference names. Fixes samtools#2218
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 protection of sharing incompatible references between multiple input files aren't strict enough. It was attempting to spot files with reordered references by checking the "lost_coord_sort" flag in the header translation table. However this doesn't cover the case where we are merging completely unrelated files that have no overlap in reference names.
Fixes #2218
Note there may be cases where we can share references for the output file descriptor but we're not doing so. For example if we have two files which are the same references but in different order, then the first and second inputs cannot share a reference as the ordering differs, but by the time we get to writing the translation table has brought them together again so the output could share the reference with the first input.
It's a bit of a corner case though and it's safer to simply avoid optimising the rare case. If any of the input refs can't be shared, we also don't share it to the output. (I think this was another bug in the original design)