Escape tilde more gracefully #16560
Closed
Escape tilde more gracefully #16560
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
Tilde needs to be escaped only when it's the first character after the white space. Otherwise, we can keep the string unescaped. This supports bzlmod better, because tilde is used in the directory names. Users often already escape location function, for example `SJ="$(location @bazel_tools//tools/jdk:singlejar)"; $SJ`. Without the change this becomes ``"'external/repo~name/singlejar'"` and the script fails (no file found). Location function shouldn't be escaped. But without this change we risk a lot of users will need to fix their scripts.
fmeum
approved these changes
Oct 26, 2022
| @@ -41,6 +41,8 @@ public void shellEscape() throws Exception { | |||
| assertThat(escapeString("\\'foo\\'")).isEqualTo("'\\'\\''foo\\'\\'''"); | |||
| assertThat(escapeString("${filename%.c}.o")).isEqualTo("'${filename%.c}.o'"); | |||
| assertThat(escapeString("<html!>")).isEqualTo("'<html!>'"); | |||
| assertThat(escapeString("~not_home")).isEqualTo("'~not_home'"); | |||
| assertThat(escapeString("external/protobuf~3.19.6/src/google")).isEqualTo("external/protobuf~3.19.6/src/google"); | |||
There was a problem hiding this comment.
Just to be safe, could you add a test case for external/~install_dev_dependencies~foo/pkg? This is a path that Bzlmod can generate and it's slightly more special as the tilde is the first character of a path segment.
There was a problem hiding this comment.
I added a unit tests, but this doesn't tell us much. I tested manually:
~$ mkdir tmp
~$ mkdir tmp/~tilde
~$ cd tmp/~tilde/
~/tmp/~tilde$ cd ..
~/tmp$ cd ~tilde
bash: cd: /usr/local/google/home/tilde: No such file or directory
i~/tmp$ cd '~tilde'
~/tmp/~tilde$
There was a problem hiding this comment.
Luckily, I don't think that Bazel will generate paths where the first segment starts with a tilde in any situation. At the moment that is, I think that this may change with --experimental_sibling_repository_layout, where paths can start with repository names. These paths would not work without escaping.
@Wyverald Do you see other cases where this could be problematic?
Edit: This actually means that the output of $(rlocationpath //label) from #16428 may end up being escaped.
@Wyverald Could we ensure that repositories generated by the main module are prefixed with _main~ rather than just ~? That would probably solve this problem for good, even with --experimental_sibling_repository_layout.
There was a problem hiding this comment.
Bash seems to consider paths starting with '~' special: https://www.gnu.org/software/bash/manual/html_node/Tilde-Expansion.html
There was a problem hiding this comment.
#16564 should ensure that paths emitted by Bazel never start with ~.
|
@bazel-io flag |
bazel-io
added
the
potential release blocker
sgowroji
added
team-ExternalDeps
Wyverald
approved these changes
Oct 26, 2022
Wyverald
added
awaiting-PR-merge
|
@bazel-io flag |
fmeum
pushed a commit
to fmeum/bazel
that referenced
this pull request
Oct 27, 2022
Tilde needs to be escaped only when it's the first character after the white space. Otherwise, we can keep the string unescaped. This supports bzlmod better, because tilde is used in the directory names. Users often already escape location function, for example `SJ="$(location @bazel_tools//tools/jdk:singlejar)"; $SJ`. Without the change this becomes `'external/repo~name/singlejar'` and the script fails (no file found). Location function shouldn't be escaped. But without this change we risk a lot of users will need to fix their scripts. Closes bazelbuild#16560. PiperOrigin-RevId: 484226256 Change-Id: I6b71f89a649f8494b76a4446b8f6384421eb89d1
sgowroji
removed
the
awaiting-PR-merge
copybara-service bot
pushed a commit
that referenced
this pull request
Oct 27, 2022
By ensuring that repository names do not start with `~`, runfiles paths are certain not to begin with tildes, which means that they don't need to be shell escaped. Prevents #16560 (comment) Closes #16564. PiperOrigin-RevId: 484232215 Change-Id: Ie70940aa709f6c7a886564189a3579780731dca6
fmeum
added a commit
to fmeum/bazel
that referenced
this pull request
Oct 27, 2022
By ensuring that repository names do not start with `~`, runfiles paths are certain not to begin with tildes, which means that they don't need to be shell escaped. Prevents bazelbuild#16560 (comment) Closes bazelbuild#16564. PiperOrigin-RevId: 484232215 Change-Id: Ie70940aa709f6c7a886564189a3579780731dca6
ShreeM01
pushed a commit
that referenced
this pull request
Oct 27, 2022
By ensuring that repository names do not start with `~`, runfiles paths are certain not to begin with tildes, which means that they don't need to be shell escaped. Prevents #16560 (comment) Closes #16564. PiperOrigin-RevId: 484232215 Change-Id: Ie70940aa709f6c7a886564189a3579780731dca6
ShreeM01
added a commit
that referenced
this pull request
Oct 27, 2022
Tilde needs to be escaped only when it's the first character after the white space. Otherwise, we can keep the string unescaped. This supports bzlmod better, because tilde is used in the directory names. Users often already escape location function, for example `SJ="$(location @bazel_tools//tools/jdk:singlejar)"; $SJ`. Without the change this becomes `'external/repo~name/singlejar'` and the script fails (no file found). Location function shouldn't be escaped. But without this change we risk a lot of users will need to fix their scripts. Closes #16560. PiperOrigin-RevId: 484226256 Change-Id: I6b71f89a649f8494b76a4446b8f6384421eb89d1 Co-authored-by: Ivo List <ilist@google.com> Co-authored-by: kshyanashree <109167932+kshyanashree@users.noreply.github.com>
Wyverald
removed
the
potential release blocker
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.
Tilde needs to be escaped only when it's the first character after the white space. Otherwise, we can keep the string unescaped.
This supports bzlmod better, because tilde is used in the directory names.
Users often already escape location function, for example
SJ="$(location @bazel_tools//tools/jdk:singlejar)"; $SJ. Without the change this becomes'external/repo~name/singlejar'and the script fails (no file found).Location function shouldn't be escaped. But without this change we risk a lot of users will need to fix their scripts.