fix: mitigate Unix domain sockets path length issues #60
Conversation
This file contains 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
This diff comprehensively addresses and documents issues arising from failure to create Unix domain sockets with long names. This limitation is platform specific and could range from ~90 to ~108 characters, depending on the platform. To address this limitation we: 1. upgrade to rbmk-project/[email protected], which implements a new fsx.OverlayFS with a fsx.PrefixDirPathMapper and exposes a new fsx.NewRelativeToCwdPrefixDirPathMapper constructor using prefix paths relative to the current working directory. 2. modify `./pkg/cli/sh` to use these functionality when possible when creating new `rbmk COMMAND` internal commands and otherwise fallback to the previous behaviour. 3. document this issue for `rbmk pipe --help`, `rbmk pipe read --help`, `rbmk pipe write --help`, `rbmk sh --help`. 4. extend `rbmk timestamp` to add the `--full` flag so to create unique directory names with nanosecond precision. 5. document that scripts SHOULD use short relative paths, also taking advantage of `rbmk timestamp --full` when using named pipes and then they should move the directory once the measurement is done.
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.
This diff comprehensively addresses and documents issues arising from failure to create Unix domain sockets with long names. This limitation is platform specific and could range from ~90 to ~108 characters, depending on the platform.
To address this limitation we:
upgrade to rbmk-project/[email protected], which implements a new fsx.OverlayFS with a fsx.PrefixDirPathMapper and exposes a new fsx.NewRelativeToCwdPrefixDirPathMapper constructor using prefix paths relative to the current working directory.
modify
./pkg/cli/shto use these functionality when possible when creating newrbmk COMMANDinternal commands and otherwise fallback to the previous behaviour.document this issue for
rbmk pipe --help,rbmk pipe read --help,rbmk pipe write --help,rbmk sh --help.extend
rbmk timestampto add the--fullflag so to create unique directory names with nanosecond precision.document that scripts SHOULD use short relative paths, also taking advantage of
rbmk timestamp --fullwhen using named pipes and then they should move the directory once the measurement is done.