test: add additional esm sandbox assertions

Author: jbedard

.aspect/rules/external_repository_action_cache/npm_translate_lock_LTE4Nzc1MDcwNjU=

@@ -16,8 +16,8 @@ examples/npm_deps/patches/[email protected]=-442666336
 examples/npm_package/libs/lib_a/package.json=-1377103079
 examples/npm_package/packages/pkg_a/package.json=1006424040
 examples/npm_package/packages/pkg_b/package.json=1041247977
-examples/npm_package/packages/pkg_d/package.json=1110895851
-examples/npm_package/packages/pkg_e/package.json=-2145239245
+examples/npm_package/packages/pkg_d/package.json=-1434007576
+examples/npm_package/packages/pkg_e/package.json=-336138332
 examples/runfiles/package.json=-1545884645
 examples/stack_traces/package.json=2011229626
 examples/webpack_cli/package.json=1911342006

examples/js_binary/BUILD.bazel

@@ -25,7 +25,14 @@ js_binary(
     name = "bin",
     # Reference the location where the acorn npm module was linked in the root Bazel package
     data = ["//:node_modules/acorn"],
-    entry_point = "require_acorn.js",
+    entry_point = "require_acorn.mjs",
+)
+
+js_binary(
+    name = "bin_cjs",
+    # Reference the location where the acorn npm module was linked in the root Bazel package
+    data = ["//:node_modules/acorn"],
+    entry_point = "require_acorn.cjs",
 )
 
 ####################################################
@@ -48,6 +55,22 @@ diff_test(
     file2 = "out1",
 )
 
+genrule(
+    name = "run1_cjs",
+    srcs = [],
+    outs = ["out1_cjs"],
+    # All js_binary rules need a BAZEL_BINDIR environment variable set so they can
+    # run from that directory as the working directory.
+    cmd = "BAZEL_BINDIR=$(BINDIR) $(location :bin_cjs) {}/out1_cjs".format(package_name()),
+    tools = [":bin_cjs"],
+)
+
+diff_test(
+    name = "test_js_binary_under_genrule_cjs",
+    file1 = "//examples:expected_one_ast.json",
+    file2 = "out1_cjs",
+)
+
 ####################################################
 # Use case 2
 # Using js_run_binary has some nice syntax sugar vs.
@@ -73,6 +96,26 @@ diff_test(
     file2 = "out2",
 )
 
+js_run_binary(
+    name = "run2_cjs",
+    srcs = [],
+    outs = ["out2_cjs"],
+    args = ["out2_cjs"],
+    chdir = package_name(),
+    # Request that the rules_js launcher prints extra information
+    log_level = "debug",
+    tool = ":bin_cjs",
+    # Uncomment the setting below to see debug output even on a
+    # successful run of the build action.
+    # silent_on_success = False,
+)
+
+diff_test(
+    name = "test_js_binary_under_js_run_binary_cjs",
+    file1 = "//examples:expected_one_ast.json",
+    file2 = "out2_cjs",
+)
+
 # Also test with local (no sandbox) execution by setting execution_requirements "local" to "1".
 # Bazel sets different environment variables in this case such as RUNFILES_MANIFEST_FILE.
 # This case tests for regression of the fix in https://github.com/aspect-build/rules_js/pull/323.
@@ -101,16 +144,16 @@ diff_test(
 
 # Also test with copy_data_to_bin disabled
 copy_to_bin(
-    name = "require_acorn_js",
-    srcs = ["require_acorn.js"],
+    name = "require_acorn_mjs",
+    srcs = ["require_acorn.mjs"],
 )
 
 js_binary(
     name = "bin_no_copy_data_to_bin",
     copy_data_to_bin = False,
     # Reference the location where the acorn npm module was linked in the root Bazel package
     data = ["//:node_modules/acorn"],
-    entry_point = ":require_acorn_js",
+    entry_point = ":require_acorn_mjs",
 )
 
 js_run_binary(
@@ -142,7 +185,7 @@ diff_test(
 js_test(
     name = "test_test",
     data = ["//:node_modules/@types/node"],
-    entry_point = "test.js",
+    entry_point = "test.mjs",
 )
 
 ###############################
@@ -152,11 +195,12 @@ js_test(
 
 write_file(
     name = "write4",
-    out = "case4.js",
+    out = "case4.mjs",
     content = [
-        """require('fs').writeFileSync(
+        "import { writeFileSync } from 'fs'",
+        """writeFileSync(
             process.argv[2],
-            require(process.argv[3]).toAst("1")
+            (await import(process.argv[3])).toAst("1")
         )""",
     ],
 )
@@ -167,7 +211,7 @@ js_binary(
         ":node_modules/@mycorp/pkg-a",
         "//:node_modules/@mycorp/pkg-b",
     ],
-    entry_point = "case4.js",
+    entry_point = "case4.mjs",
 )
 
 js_run_binary(
@@ -228,12 +272,13 @@ diff_test(
 
 write_file(
     name = "write5",
-    out = "case5.js",
-    content = ["""\
-require('fs').writeFileSync(
-    process.argv[2],
-    JSON.stringify(require(require('path').join(process.cwd(), "data.json")))
-)"""],
+    out = "case5.mjs",
+    content = [
+        "import { writeFileSync } from 'fs';",
+        "import { join } from 'path';",
+        "const jsonData = await import(join(process.cwd(), 'data.json'), { with: { type: 'json' } });",
+        "writeFileSync(process.argv[2], JSON.stringify(jsonData.default))",
+    ],
 )
 
 write_file(
@@ -244,7 +289,7 @@ write_file(
 
 js_binary(
     name = "bin5",
-    entry_point = "case5.js",
+    entry_point = "case5.mjs",
 )
 
 js_run_binary(
@@ -557,11 +602,13 @@ js_test(
 
 write_file(
     name = "write13",
-    out = "case13.js",
+    out = "case13.mjs",
     content = [
-        """require('fs').writeFileSync(
+        "import { writeFileSync } from 'fs';",
+        """
+           writeFileSync(
             process.argv[2],
-            JSON.stringify(require(process.argv[3]))
+            JSON.stringify((await import(process.argv[3])).default)
         )""",
     ],
 )
@@ -572,7 +619,7 @@ js_binary(
         "//:node_modules/@mycorp/pkg-c1",
         "//:node_modules/@mycorp/pkg-c2",
     ],
-    entry_point = "case13.js",
+    entry_point = "case13.mjs",
 )
 
 write_file(

examples/js_binary/require_acorn.js examples/js_binary/require_acorn.cjsexamples/js_binary/require_acorn.js renamed to examples/js_binary/require_acorn.cjs

@@ -0,0 +1,10 @@
+/**
+ * @fileoverview minimal test program that requires a third-party package from npm
+ */
+import { writeFileSync } from 'fs'
+import { parse } from 'acorn'
+
+writeFileSync(
+    process.argv[2],
+    JSON.stringify(parse('1', { ecmaVersion: 2020 })) + '\n'
+)

examples/js_binary/require_acorn.mjs

@@ -0,0 +1,2 @@
+console.log('\n\n\nThis is only a test.\n\n\n')
+console.log(import.meta.resolve('@types/node/package.json'))

examples/js_binary/test.js

@@ -22,5 +22,7 @@ def mocha_test(name, srcs, args = [], data = [], env = {}, **kwargs):
             # to the location Bazel expects.
             "MOCHA_FILE": "$$XML_OUTPUT_FILE",
         }),
+        preserve_symlinks_main = False,
+        copy_data_to_bin = False,
         **kwargs
     )

examples/js_binary/test.mjs

@@ -1,4 +1,5 @@
 const assert = require('assert')
+const { dirname } = require('node:path')
 
 describe('mocha', () => {
     it('integrates with Bazel', () => {
@@ -8,4 +9,13 @@ describe('mocha', () => {
     it('is in bazel-out', () => {
         assert.match(__dirname, /bazel-out/)
     })
+
+    it('is sandboxed', () => {
+        assert.match(__dirname, /examples\/macro\/test_\/test\.runfiles/)
+        assert.match(
+            __filename,
+            /-sandbox\/\d+\/execroot\/_main\/bazel-out\/[^/]+\/bin\/examples\/macro\/test_\/test.runfiles\/_main\/examples\/macro\/test\.js/
+        )
+        assert.equal(__dirname, dirname(__filename))
+    })
 })

examples/macro/mocha.bzl

@@ -265,31 +265,37 @@ js_test(
 
 write_file(
     name = "write9",
-    out = "case9.js",
-    content = ["require('@mycorp/pkg-d')"],
+    out = "case9.mjs",
+    content = [
+        "import { sandboxAssert } from '@mycorp/pkg-d'",
+        "sandboxAssert()",
+    ],
 )
 
 js_test(
     name = "test9",
     data = [
         ":node_modules/@mycorp/pkg-d",
     ],
-    entry_point = "case9.js",
+    entry_point = "case9.mjs",
 )
 
 #######################################
 # Case 10: use a first-party npm package a transitive dependency on a monorepo workspace from a js_library target
 
 write_file(
     name = "write10",
-    out = "case10.js",
-    content = ["require('@mycorp/pkg-e')"],
+    out = "case10.mjs",
+    content = [
+        "import { sandboxAssert } from '@mycorp/pkg-e'",
+        "sandboxAssert()",
+    ],
 )
 
 js_test(
     name = "test10",
     data = [
         ":node_modules/@mycorp/pkg-e",
     ],
-    entry_point = "case10.js",
+    entry_point = "case10.mjs",
 )

examples/macro/test.js

@@ -9,7 +9,7 @@ npm_package(
     srcs = [
         "data1/package.json",
         "data1/pkg-c.json",
-        "src/index.js",
+        "src/index.mjs",
     ],
     package = "@mycorp/pkg-c1",
     root_paths = [
@@ -25,7 +25,7 @@ npm_package(
     srcs = [
         "data2/package.json",
         "data2/pkg-c.json",
-        "src/index.js",
+        "src/index.mjs",
     ],
     package = "@mycorp/pkg-c2",
     root_paths = [