`--incompatible_use_plus_in_repo_names` #23127

Wyverald · 2024-07-26T18:38:24Z

Motivation

In #22865, it was discovered that the ~ character currently used as a separator in canonical repo names can have significant performance impact on Windows.

We reviewed all potential separators and found that + could serve as a good replacement.

Description

When set to true, the flag causes the canonical repo name format to use + wherever ~ is currently used. That is:

For module repos: $NAME+
For extension repos: $MODULE+$EXTENSION_NAME+$APPARENT_REPO_NAME

Incompatible Flag

--incompatible_use_plus_in_repo_names

Migration Guide

Ideally, people should have already not been depending on the canonical repo name format, as it was declared to be unstable.

But for those who have been parsing repo names, especially those relying on the existence of a ~ character, should try to switch to other alternatives:

If you need access to the apparent repo name inside a repo rule, try passing in the apparent repo name as an explicit attr instead. (See bazelbuild/rules_java@000587f and Track whether a repo is pinned or unpinned by explicit attr bazel-contrib/rules_jvm_external#1204 for example.)
If you absolute can't avoid such parsing, try to accommodate for both ~ and +.

In which Bazel LTS version will this incompatible change be enabled?

Bazel 8

Additional Context

Note that in Bazel 8, this flag will be flipped to true by default, and the flag will immediately become a no-op (that is, setting it to false will have no effect). This is to avoid having to maintain the different repo name formats for another LTS cycle, especially as it was never a stable API to begin with.

TODO List

Implement the incompatible change at Bazel HEAD and guard it behind a flag. (Add flag --incompatible_use_plus_in_repo_names #23103)
Backport the incompatible flag to the latest LTS release. ([7.3.0] Add flag --incompatible_use_plus_in_repo_names #23141)
Test the incompatible change with downstream projects and inform broken projects.
Flip the incompatible flag at Bazel HEAD. (Use + instead of ~ as the canonical repo name separator #23098)
Delete the incompatible flag and the old behavior at Bazel HEAD. (Use + instead of ~ as the canonical repo name separator #23098)

The text was updated successfully, but these errors were encountered:

peakschris · 2024-08-02T09:20:39Z

7.3.0rc1 is working well for us, fixes #22865, thank you for your work on this!

…imiter The delimiter used in canonical repo names is changing from `~` to `+`.[^1] This logic, which tries to normalize query results for the purposes of diff-testing against golden results, label parsing seems unavoidable, so we fall back to the non-preferred approach of supporting both delimiters in our patterns. Also, refine the patterns to be more exact and better reflect the intent to only act agaisnt the repo-name part of each label: * anchor the patterns to match only at start of each label * only operate before the first `/` [^1]: bazelbuild/bazel#23127

The delimiter used in Bzlmod for repo names has never been stable and will be changing soon.[^1] String-parsing to derive shorter, user-friendly names for labels will be broken by this change and is brittle in general. Instead, passing the right values down from the contexts where the true values are known is preferred. [^1]: bazelbuild/bazel#23127

…imiter (#1211) The delimiter used in canonical repo names is changing from `~` to `+`.[^1] This logic, which tries to normalize query results for the purposes of diff-testing against golden results, label parsing seems unavoidable, so we fall back to the non-preferred approach of supporting both delimiters in our patterns. Also, refine the patterns to be more exact and better reflect the intent to only act agaisnt the repo-name part of each label: * anchor the patterns to match only at start of each label * only operate before the first `/` [^1]: bazelbuild/bazel#23127

Especially due to #23127, older marker files may contain entries that don't even parse correctly. Instead of crashing Bazel, we should just ignore such entries. Fixes #23322.

Especially due to #23127, older marker files may contain entries that don't even parse correctly. Instead of crashing Bazel, we should signal a refetch. Fixes #23322. Closes #23336. PiperOrigin-RevId: 666416942 Change-Id: Ie5507654f69825d93f9523d9c209d417fb3cdaf6

Especially due to bazelbuild#23127, older marker files may contain entries that don't even parse correctly. Instead of crashing Bazel, we should signal a refetch. Fixes bazelbuild#23322. Closes bazelbuild#23336. PiperOrigin-RevId: 666416942 Change-Id: Ie5507654f69825d93f9523d9c209d417fb3cdaf6

Especially due to #23127, older marker files may contain entries that don't even parse correctly. Instead of crashing Bazel, we should signal a refetch. Fixes #23322. Closes #23336. PiperOrigin-RevId: 666416942 Change-Id: Ie5507654f69825d93f9523d9c209d417fb3cdaf6

There is an upcoming behavior change in bzlmod --incompatible_use_plus_in_repo_names, which changes the separator character in canonical repo names from tilde `~` to plus `+` due to I/O performance issue in Windows. * bazelbuild/bazel#23127 The above flag is planned to be enabled by default in Bazel 8.0, which is expected to be released on November 2024. Let's update our custom repository rules so that they can continue working with Bazel 8.0.

There is an upcoming behavior change in bzlmod --incompatible_use_plus_in_repo_names, which changes the separator character in canonical repo names from tilde `~` to plus `+` due to I/O performance issue in Windows. * bazelbuild/bazel#23127 The above flag is planned to be enabled by default in Bazel 8.0, which is expected to be released on November 2024. Let's update our custom repository rules so that they can continue working with Bazel 8.0. PiperOrigin-RevId: 686421798

Wyverald added untriaged incompatible-change Incompatible/breaking change labels Jul 26, 2024

Wyverald assigned sgowroji, iancha1992 and satyanandak and unassigned sgowroji, iancha1992 and satyanandak Jul 26, 2024

Wyverald added P1 I'll work on this now. (Assignee required) type: process team-ExternalDeps External dependency handling, remote repositiories, WORKSPACE file. area-Bzlmod Bzlmod-specific PRs, issues, and feature requests and removed untriaged labels Jul 26, 2024

Wyverald self-assigned this Jul 26, 2024

Wyverald added the migration-ready Incompatible flag is ready for migration with Bazel rolling releases or Bazel@last_green label Jul 29, 2024

Wyverald added a commit that referenced this issue Aug 19, 2024

Ignore invalid entries in the marker file

3bab496

Especially due to #23127, older marker files may contain entries that don't even parse correctly. Instead of crashing Bazel, we should just ignore such entries. Fixes #23322.

Wyverald mentioned this issue Aug 19, 2024

Consider invalid entries in the marker file reason for refetch #23336

Closed

Wyverald added a commit that referenced this issue Aug 19, 2024

Ignore invalid entries in the marker file

0a6880d

Especially due to #23127, older marker files may contain entries that don't even parse correctly. Instead of crashing Bazel, we should just ignore such entries. Fixes #23322.

meteorcloudy mentioned this issue Aug 20, 2024

feat: add [email protected]+11140bec96 bazelbuild/bazel-central-registry#2641

Merged

peakschris mentioned this issue Aug 21, 2024

buildozer message incorrect with --incompatible_use_plus_in_repo_names bazel-contrib/rules_jvm_external#1219

Closed

albertocavalcante mentioned this issue Aug 22, 2024

Enable Flag: --incompatible_use_plus_in_repo_names albertocavalcante/garf#9

Merged

peakschris mentioned this issue Aug 25, 2024

with --incompatible_use_plus_in_repo_names, the + in repo rule leaks into messages #23418

Open

meteorcloudy added the breaking-change-8.0 label Aug 27, 2024

meteorcloudy closed this as completed Aug 27, 2024

dizzy57 mentioned this issue Sep 4, 2024

feat: implement --build_python_zip pex aspect-build/rules_py#324

Merged

bazel-io mentioned this issue Sep 10, 2024

[7.4.0] Consider invalid entries in the marker file reason for refetch #23573

Closed

meteorcloudy mentioned this issue Sep 20, 2024

[Bazel CI] Log error: 'no such package '@@rules_java//toolchains': BUILD file not found in directory 'toolchains' of external repository @@rules_java' googlecloudrobotics/core#417

Closed

kczulko mentioned this issue Sep 26, 2024

Handle --incompatible_use_plus_in_repo_names kczulko/rules_elm#60

Closed

yukawa mentioned this issue Oct 16, 2024

Make bzlmod repo rules compatible with Bazel 8 google/mozc#1083

Merged

jmhodges mentioned this issue Oct 22, 2024

goroot alias directory somehow? bazel-contrib/rules_go#4152

Open

meteorcloudy mentioned this issue Oct 30, 2024

Top BCR modules broken with Bazel 8.0.0rc8 bazelbuild/bazel-central-registry#3056

Open

lalten mentioned this issue Oct 31, 2024

Support --incompatible_use_plus_in_repo_names lalten/rules_cpan#2

Merged

mering mentioned this issue Nov 26, 2024

Bug: "invalid path" with Bazel 8 bazel-contrib/rules_oci#738

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`--incompatible_use_plus_in_repo_names` #23127

`--incompatible_use_plus_in_repo_names` #23127

Wyverald commented Jul 26, 2024 •

edited

Loading

peakschris commented Aug 2, 2024

--incompatible_use_plus_in_repo_names #23127

--incompatible_use_plus_in_repo_names #23127

Comments

Wyverald commented Jul 26, 2024 • edited Loading

Motivation

Description

Incompatible Flag

Migration Guide

In which Bazel LTS version will this incompatible change be enabled?

Additional Context

TODO List

peakschris commented Aug 2, 2024

`--incompatible_use_plus_in_repo_names` #23127

`--incompatible_use_plus_in_repo_names` #23127

Wyverald commented Jul 26, 2024 •

edited

Loading