Use magic for binary detection - #22
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates Outline’s packing pipeline to use github.com/git-pkgs/magic for content classification so that only UTF-8 text is packed while reliably skipping binary content (including files with binary signatures, disallowed control bytes, malformed UTF-8, and late NULs beyond the prior 8 KiB probe).
Changes:
- Replace the previous NUL/UTF-8 prefix probe with
magic.Detect-based text gating viaisPackableText. - Expand packing tests to cover PDF detection, UTF-16, malformed UTF-8, disallowed controls, late NUL bytes, Unicode, and empty content.
- Add the
github.com/git-pkgs/magic v0.1.0module dependency.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pack.go | Switches file packability checks from a fixed-size binary sniff to magic-based classification while preserving the "binary" skip reason. |
| pack_test.go | Adds/updates tests to validate the new classification behavior across more encodings and binary/text edge cases. |
| go.mod | Introduces the github.com/git-pkgs/magic dependency. |
| go.sum | Adds checksums for the new magic dependency. |
💡 Add Copilot custom instructions for smarter, more guided reviews. 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.
Use
github.com/git-pkgs/magicto classify files before packing. Preserve the existingbinaryskip result and accept only UTF-8 text, while catching binary signatures, disallowed controls, and NUL bytes beyond the old 8 KiB probe.Add coverage for UTF-16, malformed UTF-8, late NULs, binary formats without NUL, Unicode, and empty content.