Repository navigation
Preserve non-UTF-8 paths in NAR streams - #320
Merged
Merged
Conversation
domenkozar
marked this pull request as ready for review
August 7, 2026 21:08
Contributor
Author
Member
|
Thanks! |
Member
|
Thanks @domenkozar for making it, and thanks @sorki for already reviewing it :) |
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.
Summary
Root cause
On POSIX,
System.Directory.listDirectorydecodes undecodable filename bytes using GHC's filesystem round-trip encoding, representing them as surrogate code points inFilePath. The NAR streamer then converted the path withText.packandencodeUtf8, which cannot preserve those surrogate escapes.This occurs in practice with Debian's Latin-2 NetLock CA certificate filename, which is also handled specially by nixpkgs' cacert package, and can surface inside bundled sysroots during Cachix pushes.
The streamer now encodes paths with GHC's filesystem encoding and uses the resulting bytes for both serialization and directory ordering.
Impact
Store paths containing non-UTF-8 filenames or symlink targets can be streamed without an encoding failure, while valid UTF-8 paths retain their existing representation.
Validation
hnix-store-nartests passnix-store --dumpbyte-for-byte