Allow all characters in runfile source and target paths #23331

fmeum · 2024-08-19T11:04:30Z

Adds support for spaces and newlines in source and target paths of runfiles symlinks to build-runfiles as well as to the Bash, C++, and Java runfiles libraries (the Python runfiles library has moved out of the repo).

If a symlink has spaces or newlines in its source path, it is prefixed with a space in the manifest and spaces, newlines, and backslashes in the source path are escaped with \s, \n, and \b respectively. This scheme has been chosen as it has the following properties:

There is no change to the format of manifest lines for entries whose source and target paths don't contain a space. This ensures compatibility with existing runfiles libraries.
There is even no change to the format of manifest lines for entries whose target path contains spaces but whose source path does not. These manifests previously failed in build-runfiles, but were usable on Windows and supported by the official runfiles libraries. This also ensures that the initialization snippet for the Bash runfiles library doesn't need to change, even when used on Unix with a space in the output base path.
The scheme is fully reversible and only depends on the source path, which gives runfiles libraries a choice between reversing the escaping when parsing the manifest (C++, Java) or applying the escaping when searching the manifest (Bash).

Fixes #4327

RELNOTES: Bazel now supports all characters in the rlocation and target paths of runfiles and can be run from workspaces with a space in their full path.

fmeum · 2024-08-19T20:55:14Z

@lberki I assigned you as reviewer for your general knowledge of runfiles, but feel free to redirect if needed.

fmeum · 2024-08-19T21:39:37Z

CC @meteorcloudy for Windows

meteorcloudy

Wow, this is great!

src/main/tools/build-runfiles-windows.cc

meteorcloudy · 2024-08-20T09:07:17Z

src/main/java/com/google/devtools/build/lib/runtime/BlazeOptionHandler.java

@@ -166,18 +166,6 @@ private DetailedExitCode checkCwdInWorkspace(EventHandler eventHandler) {
    }

    Path workspacePath = workspace.getWorkspace();
-    // TODO(kchodorow): Remove this once spaces are supported.


Is the runfiles path the only reason we didn't support space in workspace path? /cc @lberki

I could see missing escaping in the test setup shell script as one other source of issues. When the rest of this PR and the general approach look good to you, I could run Bazel's test suite under a path with a space to shake out these issues.

Yeah, @fmeum 's approach is reasonable; spaces in workspace paths is the kind of thing that could break in unexpected places. Yes, we should properly quote everywhere, but that doesn't mean that we do if the functionality is untested.

sgowroji · 2024-08-21T05:33:57Z

Hi @meteorcloudy, Since i can see that this PR has been approved, Please let us know whether gTech team should proceed with importing it. Thanks!

fmeum · 2024-08-21T06:48:06Z

@sgowroji I would prefer to wait for a second opinion, for example by @lberki.

matthewjh · 2024-09-19T13:46:48Z

@fmeum: is the aim to get this into Bazel 8.0.0?

lberki · 2024-09-19T14:00:42Z

In principle, adding the functionality to encode spaces in runfiles manifests is fine. I'm not sure, though, how I feel about this particular one because it's tailored to spaces and only spaces. How about implementing a scheme that could be more easily extended?

Spitballing, something like this: if a line in the runfiles manifest starts with a space, the algorithm to parse the line is as follows: the separator is between the two paths is a space, end of the line is a newline, any other character is a file name. If a file name contains a space, a newline or a backslash, these need to be escaped as \s, \n or \b, respectively, any other backslash sequences are reserved for future extension.

This is easy to implement, provably supports everything is just as incompatible with the existing system and looks more conventional than the encoding proposed in this pull request.

@fmeum WDYT? It looks like if we go through the pain of adding syntax to runfiles manifests, we could as well make it future-proof. I could also be convinced to make them some subset of JSON so that parsing them is possible with standard libraries but also with random logic so that one doesn't need to add additional dependencies.

fmeum · 2024-09-20T08:49:39Z

This is easy to implement, provably supports everything is just as incompatible with the existing system and looks more conventional than the encoding proposed in this pull request.

It lacks one important property, but we can also fix that: With this scheme in its current form, the Bash runfiles setup snippet as well as third-party runfiles libraries would need to be modified to continue to support manifest entries in which the rlocationpath contains no spaces, but the target path does (common on Windows).

We can fix that by not escaping spaces in the target paths and declaring that the first space on a line that doesn't start with a space is the separator. We would then only add a space at the beginning of a line if either the rlocationpath contains a space or newline or if the target path contains a newline.

At that point it's similar to the scheme in this PR, it just uses escape characters instead of length encoding. I agree that escaping is more conventional and probably not much harder to implement in most languages (it does change the length of the strings vs. just taking a substring, but that seems okay).

@lberki What do you think, should I go ahead and implement the modified version of your scheme?

fmeum · 2024-09-20T12:06:23Z

I implemented the scheme without support for newlines for now. They could always be supported in a follow-up, which is much simpler with the new scheme (just introduce a new escape character everywhere).

lberki · 2024-09-23T08:09:21Z

The modified scheme looks reasonable. I'm travelling today so I can't review the pull request but will do so as soon as I can.

The main question in my mind is whether we do some sort of custom encoding (like this one) or go with a standard one. Of the standard ones, JSON seems to be the most palatable given the use case (simple list of key/value pairs intended to be parseable without any dependencies), but I'm not sure if it's worth the hassle and if it is, we are probably better off having an additional file called MANIFEST.json or something like that

fmeum · 2024-09-27T16:07:18Z

@lberki This is ready for review again, I fixed all test cases.

lberki

Somewhat improbably, I actually found a bug!

lberki · 2024-09-30T11:23:17Z

tools/bash/runfiles/runfiles.bash

+    # with a space and spaces, newlines, and backslashes have to be escaped as
+    # \s, \n, and \b.
+    if [[ "$1" == *" "* || "$1" == *$'\n'* ]]; then
+      local search_prefix=" $(echo -n "$1" | sed 's/\\/\\b/g; s/ /\\s/g')"


you forgot to also escape newlines here (but you check whether there are newlines in the runfiles path in the line just above?)

Newlines are escaped in the line below. Escaping newlines with sed requires commands other than s, which I found to be too hard to read. I could replace the sed usage with Bash variable substitution entirely, if you prefer that.

Nevermind. I overlooked that. You're good to go.

lberki · 2024-09-30T11:24:31Z

tools/bash/runfiles/runfiles.bash

+          echo >&2 "INFO[runfiles.bash]: rlocation($1): looking for prefix ($prefix)"
+        fi
+        if [[ "$prefix" == *" "* || "$prefix" == *$'\n'* ]]; then
+          search_prefix=" $(echo -n "$prefix" | sed 's/\\/\\b/g; s/ /\\s/g')"


Also escape newlines here

lberki · 2024-09-30T11:39:24Z

tools/bash/runfiles/runfiles.bash

+    # with a space and spaces, newlines, and backslashes have to be escaped as
+    # \s, \n, and \b.
+    if [[ "$1" == *" "* || "$1" == *$'\n'* ]]; then
+      local search_prefix=" $(echo -n "$1" | sed 's/\\/\\b/g; s/ /\\s/g')"


Nevermind. I overlooked that. You're good to go.

Wyverald · 2024-10-03T22:02:12Z

This is a bit of a doozy -- Google disallows the usage of #include <regex>, requiring the usage of re2 instead. Given the usage of regexes in this PR seems simple enough, could you replace them with some helper methods instead?

fmeum · 2024-10-04T08:39:37Z

@Wyverald Done

fmeum force-pushed the 4327-spaces-in-runfiles branch 2 times, most recently from d4842e1 to 8a03d1b Compare August 19, 2024 11:38

fmeum requested a review from lberki August 19, 2024 20:54

fmeum marked this pull request as ready for review August 19, 2024 20:54

fmeum requested a review from a team as a code owner August 19, 2024 20:54

fmeum requested review from gregestren, a team and katre and removed request for a team, gregestren and katre August 19, 2024 20:54

github-actions bot added team-Configurability platforms, toolchains, cquery, select(), config transitions team-Rules-Java Issues for Java rules team-Rules-CPP Issues for C++ rules awaiting-review PR is awaiting review from an assigned reviewer labels Aug 19, 2024

meteorcloudy approved these changes Aug 20, 2024

View reviewed changes

fmeum force-pushed the 4327-spaces-in-runfiles branch 2 times, most recently from 605c2b5 to 34d1f84 Compare September 20, 2024 12:05

fmeum force-pushed the 4327-spaces-in-runfiles branch 2 times, most recently from 9a141b6 to 0d7a3cc Compare September 20, 2024 12:35

fmeum requested a review from lberki September 24, 2024 12:02

fmeum force-pushed the 4327-spaces-in-runfiles branch 7 times, most recently from 6384db4 to ebf84cd Compare September 24, 2024 15:39

lberki reviewed Sep 30, 2024

View reviewed changes

lberki approved these changes Sep 30, 2024

View reviewed changes

lberki added awaiting-PR-merge PR has been approved by a reviewer and is ready to be merge internally and removed awaiting-review PR is awaiting review from an assigned reviewer labels Sep 30, 2024

fmeum added 9 commits October 4, 2024 09:42

Allow spaces in runfile source and target paths

acb6606

Add comment

e6802f2

Add test

dce53c4

Fix tests

615f148

Attempt to migrate build-runfiles-windows

4212222

Delete trim

b50d4ff

New escaping scheme

aa365a8

Fix test

066ff91

Also support newlines

4cbb7a0

fmeum force-pushed the 4327-spaces-in-runfiles branch 2 times, most recently from 8775fde to 818e9af Compare October 4, 2024 08:39

fmeum force-pushed the 4327-spaces-in-runfiles branch from 818e9af to b621e65 Compare October 4, 2024 08:43

Replace <regex> with a helper function

4629915

fmeum force-pushed the 4327-spaces-in-runfiles branch from b621e65 to 4629915 Compare October 4, 2024 08:43

fmeum mentioned this pull request Oct 4, 2024

Import from Bazel bazelbuild/rules_shell#3

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow all characters in runfile source and target paths #23331

Allow all characters in runfile source and target paths #23331

fmeum commented Aug 19, 2024 •

edited

Loading

fmeum commented Aug 19, 2024

fmeum commented Aug 19, 2024

meteorcloudy left a comment

meteorcloudy Aug 20, 2024

fmeum Aug 20, 2024

lberki Sep 19, 2024

sgowroji commented Aug 21, 2024

fmeum commented Aug 21, 2024

matthewjh commented Sep 19, 2024

lberki commented Sep 19, 2024

fmeum commented Sep 20, 2024 •

edited

Loading

fmeum commented Sep 20, 2024

lberki commented Sep 23, 2024

fmeum commented Sep 27, 2024

lberki left a comment

lberki Sep 30, 2024

fmeum Sep 30, 2024

lberki Sep 30, 2024

lberki Sep 30, 2024

lberki Sep 30, 2024

Wyverald commented Oct 3, 2024

fmeum commented Oct 4, 2024

Allow all characters in runfile source and target paths #23331

Are you sure you want to change the base?

Allow all characters in runfile source and target paths #23331

Conversation

fmeum commented Aug 19, 2024 • edited Loading

fmeum commented Aug 19, 2024

fmeum commented Aug 19, 2024

meteorcloudy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sgowroji commented Aug 21, 2024

fmeum commented Aug 21, 2024

matthewjh commented Sep 19, 2024

lberki commented Sep 19, 2024

fmeum commented Sep 20, 2024 • edited Loading

fmeum commented Sep 20, 2024

lberki commented Sep 23, 2024

fmeum commented Sep 27, 2024

lberki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Wyverald commented Oct 3, 2024

fmeum commented Oct 4, 2024

fmeum commented Aug 19, 2024 •

edited

Loading

fmeum commented Sep 20, 2024 •

edited

Loading