Avoid throwing NotSupportedException in ReaderFactory hot path - #400
Merged
adamhathcock merged 1 commit intoJul 10, 2018
Conversation
`ReaderFactory.Open()` calls `ZipArchive.IsZipFile()` to determine if the `Stream` is a zip archive, which calls into `ZipHeaderFactory.ReadHeader()`, which throws a `NotSupportedException` when the `Stream` is not a zip archive. To be clear, this exception is caught and `IsZipFile()` returns `false`, but when called in a hot-path, these exceptions can become expensive. To address this issue, `ReadHeader` now returns `null` in the default cause instead of throwing. All callsites were already checking for and handling `null`, so no behavior changes.
Owner
|
Thanks, this does make more sense. |
This was referenced May 9, 2026
This was referenced Jul 24, 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.
ReaderFactory.Open()callsZipArchive.IsZipFile()to determine if the stream is a zip archive, which calls intoZipHeaderFactory.ReadHeader(), which throws aNotSupportedExceptionwhen the bytes do not match a valid header.To be clear, this exception is caught and
IsZipFile()returnsfalse, but when called in a hot-path, these exceptions can become expensive.To address this issue,
ReadHeadernow returnsnullin the default cause instead of throwing. All callsites were already checking for and handlingnull, so no behavior should change.