Add replace_package module extension tag #2289

Mivr · 2025-07-28T16:22:18Z

Changes are visible to end-users: yes

Searched for relevant documentation and updated as needed: yes
Breaking change (forces users to change their own code or config): yes
Suggested release notes appear below: yes

feat: moved replace package to a tag class for bzlmod

Test plan

Updated old test case

CLAassistant · 2025-07-28T16:22:24Z

All committers have signed the CLA.

aspect-workflows · 2025-07-28T16:22:43Z

Test

All tests were cache hits

278 tests (100.0%) were fully cached saving 36s.

Test

e2e/bzlmod

All tests were cache hits

5 tests (100.0%) were fully cached saving 618ms.

Test

e2e/git_dep_metadata

All tests were cache hits

1 test (100.0%) was fully cached saving 31ms.

Test

e2e/gyp_no_install_script

All tests were cache hits

2 tests (100.0%) were fully cached saving 173ms.

Test

e2e/js_image_oci

All tests were cache hits

1 test (100.0%) was fully cached saving 7s.

Test

e2e/npm_link_package

All tests were cache hits

3 tests (100.0%) were fully cached saving 407ms.

Test

e2e/npm_link_package-esm

All tests were cache hits

3 tests (100.0%) were fully cached saving 484ms.

Test

e2e/npm_link_package-rerooted

All tests were cache hits

3 tests (100.0%) were fully cached saving 536ms.

Test

e2e/npm_translate_lock

All tests were cache hits

1 test (100.0%) was fully cached saving 31ms.

Test

e2e/npm_translate_lock_disable_hooks

All tests were cache hits

3 tests (100.0%) were fully cached saving 195ms.

Test

e2e/npm_translate_lock_empty

All tests were cache hits

1 test (100.0%) was fully cached saving 31ms.

Test

e2e/npm_translate_lock_exclude_package_contents

All tests were cache hits

1 test (100.0%) was fully cached saving 34ms.

Test

e2e/npm_translate_lock_multi

All tests were cache hits

2 tests (100.0%) were fully cached saving 164ms.

Test

e2e/npm_translate_lock_partial_clone

All tests were cache hits

1 test (100.0%) was fully cached saving 61ms.

Test

e2e/npm_translate_lock_replace_packages

1 test target passed

Targets

//:utils_test [k8-fastbuild]81ms

Total test execution time was 81ms. 3 tests (75.0%) were fully cached saving 406ms.

Test

e2e/npm_translate_lock_subdir_patch

All tests were cache hits

1 test (100.0%) was fully cached saving 95ms.

Test

e2e/npm_translate_package_lock

All tests were cache hits

1 test (100.0%) was fully cached saving 31ms.

Test

e2e/npm_translate_yarn_lock

All tests were cache hits

1 test (100.0%) was fully cached saving 31ms.

Test

e2e/package_json_module

All tests were cache hits

1 test (100.0%) was fully cached saving 348ms.

Test

e2e/patch_from_repo

All tests were cache hits

1 test (100.0%) was fully cached saving 31ms.

Test

e2e/pnpm_lockfiles

All tests were cache hits

67 tests (100.0%) were fully cached saving 10s.

Test

e2e/pnpm_repo_install

All tests were cache hits

1 test (100.0%) was fully cached saving 2s.

Test

e2e/pnpm_workspace

All tests were cache hits

15 tests (100.0%) were fully cached saving 3s.

Test

e2e/pnpm_workspace_deps

All tests were cache hits

3 tests (100.0%) were fully cached saving 901ms.

Test

e2e/pnpm_workspace_rerooted

All tests were cache hits

15 tests (100.0%) were fully cached saving 5s.

Test

e2e/repo_mapping

All tests were cache hits

3 tests (100.0%) were fully cached saving 454ms.

Test

e2e/rules_foo

All tests were cache hits

2 tests (100.0%) were fully cached saving 258ms.

Test

e2e/runfiles

All tests were cache hits

1 test (100.0%) was fully cached saving 118ms.

Test

e2e/stamped_package_json

All tests were cache hits

1 test (100.0%) was fully cached saving 44ms.

Test

e2e/vendored_node

All tests were cache hits

1 test (100.0%) was fully cached saving 78ms.

Test

e2e/vendored_tarfile

All tests were cache hits

1 test (100.0%) was fully cached saving 31ms.

Test

e2e/verify_patches

All tests were cache hits

2 tests (100.0%) were fully cached saving 109ms.

Test

e2e/worker

All tests were cache hits

1 test (100.0%) was fully cached saving 35ms.

Test

e2e/workspace

All tests were cache hits

1 test (100.0%) was fully cached saving 35ms.

Buildifier Format

npm/extensions.bzl

npm/private/npm_translate_lock.bzl

npm/extensions.bzl

e2e/npm_translate_lock_replace_packages/utils_module/MODULE.bazel

jbedard · 2025-08-13T18:51:11Z

e2e/npm_translate_lock_replace_packages/utils_module/test.mjs

+
+console.log('[utils_module] All tests passed ✓');
+
+export function testUtilsModule() {


e2e/npm_translate_lock_replace_packages/.bazelignore

jbedard · 2025-10-14T22:27:51Z

e2e/npm_translate_lock_replace_packages/utils_module/MODULE.bazel

+bazel_dep(name = "platforms", version = "0.0.5")
+bazel_dep(name = "aspect_rules_js", version = "0.0.0")
+bazel_dep(name = "aspect_bazel_lib", version = "2.7.7")
+bazel_dep(name = "bazel_skylib", version = "1.5.0")


Is this used?

jbedard · 2025-10-14T22:27:59Z

e2e/npm_translate_lock_replace_packages/utils_module/MODULE.bazel

+    path = "../lodash_module",
+)
+
+bazel_dep(name = "platforms", version = "0.0.5")


Is this used?

jbedard · 2025-10-14T22:31:32Z

npm/extensions.bzl

+
+If you need to replace a package in a non-root module:
+1. Move the npm_replace_package() call to your root MODULE.bazel file
+2. Alternatively, use the replace_packages attribute in npm_translate_lock() \


Probably delete this suggestion since it is deprecated?

jbedard · 2025-10-14T22:33:27Z

npm/extensions.bzl


+    # Validate that only root modules (or isolated extensions) use npm_replace_package
+    for mod in module_ctx.modules:
+        _fail_on_non_root_overrides(module_ctx, mod, "npm_replace_package")


Isn't it easier to put this in the loop below where we're already looping for attr in mod.tags.npm_replace_package:?

jbedard · 2025-10-14T22:34:59Z

npm/extensions.bzl

-    attrs.pop("exclude_package_contents")  # Use tag classes only for MODULE.bazel
+    attrs.pop("exclude_package_contents")  # Use npm_exclude_package_contents tag instead

+    # TODO(3.0): remove replace_packages attribute in favor of npm_replace_package tag


What would we do in 3.0? If the replace_packages attribute is removed I'd think there would be nothing TODO here...?

jbedard reviewed Jul 28, 2025

View reviewed changes

npm/extensions.bzl Outdated Show resolved Hide resolved

jbedard reviewed Jul 28, 2025

View reviewed changes

npm/extensions.bzl Outdated Show resolved Hide resolved

Mivr marked this pull request as ready for review August 5, 2025 17:59

jbedard reviewed Aug 5, 2025

View reviewed changes

npm/private/npm_translate_lock.bzl Show resolved Hide resolved

jbedard reviewed Aug 5, 2025

View reviewed changes

npm/extensions.bzl Outdated Show resolved Hide resolved

jbedard reviewed Aug 6, 2025

View reviewed changes

npm/extensions.bzl Outdated Show resolved Hide resolved

simoViso deleted the replace-packages-extension branch August 7, 2025 15:10

Mivr restored the replace-packages-extension branch August 11, 2025 12:18

jbedard reviewed Aug 11, 2025

View reviewed changes

e2e/npm_translate_lock_replace_packages/utils_module/MODULE.bazel Show resolved Hide resolved

jbedard reviewed Aug 13, 2025

View reviewed changes

e2e/npm_translate_lock_replace_packages/.bazelignore Show resolved Hide resolved

simoViso and others added 10 commits October 14, 2025 16:06

Add replace_package module extension tag

a56cf3a

Update documentation for replace_package tag and format code

ca3c746

Format and docs

fac04a5

PR comments

14d7f0a

format

129e4ea

PR comments

5c8b6a5

PR comments

c8469b8

Add test for submodule depending on another submodule

e8266a7

connect test from submodule to top module

025c162

format

ee5b4e4

Mivr force-pushed the replace-packages-extension branch from f1bc621 to ee5b4e4 Compare October 14, 2025 13:09

Mivr added 4 commits October 14, 2025 16:20

Update docs

2d9245a

Make tags work only on the root repo

40736bf

PR comments

5ff1786

Fix test

e2386a1

jbedard reviewed Oct 14, 2025

View reviewed changes


		console.log('[utils_module] All tests passed ✓');

		export function testUtilsModule() {

Uh oh!

Add replace_package module extension tag #2289

Are you sure you want to change the base?

Add replace_package module extension tag #2289

Uh oh!

Conversation

Mivr commented Jul 28, 2025

Changes are visible to end-users: yes

Test plan

Uh oh!

CLAassistant commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aspect-workflows bot commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

e2e/bzlmod

e2e/git_dep_metadata

e2e/gyp_no_install_script

e2e/js_image_oci

e2e/npm_link_package

e2e/npm_link_package-esm

e2e/npm_link_package-rerooted

e2e/npm_translate_lock

e2e/npm_translate_lock_disable_hooks

e2e/npm_translate_lock_empty

e2e/npm_translate_lock_exclude_package_contents

e2e/npm_translate_lock_multi

e2e/npm_translate_lock_partial_clone

e2e/npm_translate_lock_replace_packages

e2e/npm_translate_lock_subdir_patch

e2e/npm_translate_package_lock

e2e/npm_translate_yarn_lock

e2e/package_json_module

e2e/patch_from_repo

e2e/pnpm_lockfiles

e2e/pnpm_repo_install

e2e/pnpm_workspace

e2e/pnpm_workspace_deps

e2e/pnpm_workspace_rerooted

e2e/repo_mapping

e2e/rules_foo

e2e/runfiles

e2e/stamped_package_json

e2e/vendored_node

e2e/vendored_tarfile

e2e/verify_patches

e2e/worker

e2e/workspace

Buildifier Format

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CLAassistant commented Jul 28, 2025 •

edited

Loading

aspect-workflows bot commented Jul 28, 2025 •

edited

Loading