fix(builtin): fix for symlinked node_modules issue bazel-contrib#802

This will fix the bazel-contrib#802 case of deleting and manually re-creating node_modules by no longer writing any files under node_modules.

A few keys caveats:

1. The downside of this is that the root @npm BUILD file grows huge again as all files under node_modules need to be added to exports_files([...]). If Bazel had a method to export all files without explicitly listing them such as exports_files_all() that would solve this problem.

2. npm package that ships with BUILD files would now cause issues with labels used by yarn_install & npm_install generated targets. With this change, packages such as @bazel/typescript which install bazel workspaces now ship with _BUILD.bazel files. The bazel workspaces installer is already looking for files of this name since the current repo rule renames BUILD files for the same reason.

To solve (2), I propose publishing a tool that could be added as a postinstall step to rename all BUILD files under node_modules and prefix them with _. This should not be a common case as most npm packages don't ship with BUILD files but there are a few that do. For example, rxjs < 6.5.0 had build files for a few releases to support building it from source.

Author: gregmagolan

BUILD.bazel

@@ -38,6 +38,9 @@ npm_package(
         "defs.bzl",
         "package.bzl",
     ],
+    # Don't rename BUILD files as this package is not published to npm
+    # but is compressed in "release" below and published as a .tar.gz to GitHub
+    rename_build_files = False,
     # Don't replace the default 0.0.0-PLACEHOLDER for this npm_package since
     # we are packaging up the packager itself and this replacement will break it
     replace_with_version = "",

WORKSPACE

@@ -169,15 +169,6 @@ filegroup(
     "//unidiff/bin:BUILD.bazel",
     "//unidiff:BUILD.bazel",
     "//zone.js:BUILD.bazel",
-    "//node_modules/@angular/core:BUILD.bazel",
-    "//node_modules/@gregmagolan:BUILD.bazel",
-    "//node_modules/@gregmagolan/test-a:BUILD.bazel",
-    "//node_modules/@gregmagolan/test-b:BUILD.bazel",
-    "//node_modules/ajv:BUILD.bazel",
-    "//node_modules/jasmine:BUILD.bazel",
-    "//node_modules/rxjs:BUILD.bazel",
-    "//node_modules/unidiff:BUILD.bazel",
-    "//node_modules/zone.js:BUILD.bazel",
   ],
 )""",
     package_json = "//internal/npm_install/test:package.json",

docs/node/node.html

@@ -369,7 +369,7 @@ <h3 id="nodejs_binary_args">Attributes</h3>
     ```
     nodejs_binary(
         name = "history-server",
-        entry_point = "@npm//node_modules/history-server:modules/cli.js",
+        entry_point = "@npm//:node_modules/history-server/modules/cli.js",
         data = ["@npm//history-server"],
     )
     ```
@@ -591,7 +591,7 @@ <h3 id="nodejs_test_args">Attributes</h3>
     ```
     nodejs_binary(
         name = "history-server",
-        entry_point = "@npm//node_modules/history-server:modules/cli.js",
+        entry_point = "@npm//:node_modules/history-server/modules/cli.js",
         data = ["@npm//history-server"],
     )
     ```

e2e/bazel_bin/test.sh

@@ -27,7 +27,7 @@ else
 fi
 # --- end runfiles.bash initialization ---
 
-readonly OUT=$($(rlocation "npm/node_modules/testy/testy__bin"))
+readonly OUT=$($(rlocation "npm/testy/bin/testy"))
 
 if [ "$OUT" != "Hello world" ]; then
   echo "Expected output 'Hello world' but was $OUT"

e2e/karma_typescript/BUILD.bazel

@@ -72,7 +72,7 @@ filegroup(
     name = "rxjs_umd_modules",
     srcs = [
         # do not sort
-        "@npm//node_modules/rxjs:bundles/rxjs.umd.js",
+        "@npm//:node_modules/rxjs/bundles/rxjs.umd.js",
         ":rxjs_shims.js",
     ],
 )

e2e/karma_typescript/package.json

@@ -4,7 +4,7 @@
     "@bazel/typescript": "file:../../dist/npm_bazel_typescript",
     "@types/jasmine": "^3.3.12",
     "jasmine": "^3.4.0",
-    "rxjs": "^6.4.0",
+    "rxjs": "6.5.0",
     "typescript": "2.9.2"
   },
   "scripts": {

e2e/ts_devserver/BUILD.bazel

@@ -30,7 +30,7 @@ ts_devserver(
     entry_module = "e2e_ts_devserver/app",
     port = 8080,
     scripts = [
-        "@npm//node_modules/date-fns:date-fns.umd.js",
+        "@npm//date-fns:date-fns.umd.js",
     ],
     # We'll collect all the devmode JS sources from these TypeScript libraries
     deps = [":app"],

e2e/ts_library/WORKSPACE

@@ -30,9 +30,9 @@ yarn_install(
 filegroup(
   name = "node_modules_filegroup",
   srcs = [
-    "//node_modules/@types/hammerjs:hammerjs__files",
-    "//node_modules/@types/jasmine:jasmine__files",
-    "//node_modules/typescript:typescript__files",
+    "//@types/hammerjs:hammerjs__files",
+    "//@types/jasmine:jasmine__files",
+    "//typescript:typescript__files",
   ],
 )""",
     package_json = "//:package.json",

e2e/ts_library/googmodule/BUILD.bazel

@@ -13,7 +13,7 @@ nodejs_binary(
         "@npm//@bazel/typescript",
         "@npm//tsickle",
     ],
-    entry_point = "@npm//node_modules/@bazel/typescript:internal/tsc_wrapped/tsc_wrapped.js",
+    entry_point = "@npm//:node_modules/@bazel/typescript/internal/tsc_wrapped/tsc_wrapped.js",
     install_source_map_support = False,
 )
 

examples/protocol_buffers/BUILD.bazel

@@ -85,8 +85,8 @@ rollup_bundle(
 genrule(
     name = "protobufjs",
     srcs = [
-        "@build_bazel_rules_typescript_protobufs_compiletime_deps//node_modules/protobufjs:dist/minimal/protobuf.min.js",
-        "@build_bazel_rules_typescript_protobufs_compiletime_deps//node_modules/long:dist/long.js",
+        "@build_bazel_rules_typescript_protobufs_compiletime_deps//:node_modules/protobufjs/dist/minimal/protobuf.min.js",
+        "@build_bazel_rules_typescript_protobufs_compiletime_deps//:node_modules/long/dist/long.js",
     ],
     outs = [
         "protobuf.min.js",