Migrates jasmine_node_test() to use @aspect_rules_js.

Refs #48. This commit includes a handful of changes which needed to be landed all at once to avoid an awkward migration period. First we need to actually change the `jasmine_node_test()` macro to use `@aspect_rules_js`. There is no `@aspect_rules_jasmine`, so this needs to be done by manually invoking the `jasmine` binary via the rule generated by `npm_translate_lock()`. It generates a config file which explicitly lists its direct dependencies as test files. This means there is no convention to follow for test files (like `_test.js` or `.spec.js`), the only requirement is that it is a direct dependency of the `jasmine_node_test()` target. The config file needs to be passed in `args`, however that only works for direct `bazel test` invocations. The `web_test_suite()` target wraps this binary and drops `args`, so they need to be repeated in that context. This breaks abstraction a little bit, but is small and simple enough to not be too big a deal. Second we need to fix the errors this casues: 1. Adds `//:node_modules/*` dependencies where needed. `@npm//*` deps are still needed to type check things, but won't resolve at runtime. These dependencies are duplicated for now which doesn't seem to cause problems. Eventually the `@npm//*` dependencies will be dropped altogether. 2. Removes `@bazel/runfiles` from `jasmine_node_test()` targets because it fails (throws "`$BAZEL_WORKSPACE` is not set" error) and because it isn't needed. Since everything in `@aspect_rules_js` is in a single file tree, runfiles are just available at their root relative paths. This removes all but one usage of `@bazel/runfiles` which is still needed for a `nodejs_binary()` target. 3. Adds `debug` dependency to `//common/testing:webdriver`. This is necessary so `devtools` (a transitive dep of `webdriverio`) can import `debug` without an explicit dependency on it. This is a workaround for a pnpm-compatibility bug in WebDriverIO which should be removed once [the fix](webdriverio/webdriverio#8542) lands.
dgp1130 · Jul 20, 2022 · c288f99 · c288f99
1 parent 30efb5b
commit c288f99
Show file tree

Hide file tree

Showing 52 changed files with 107 additions and 120 deletions.
diff --git a/common/BUILD.bazel b/common/BUILD.bazel
@@ -152,6 +152,7 @@ ts_project(
         "//common/models:prerender_annotation",
         "@npm//@types/jasmine",
         "@npm//node-html-parser",
+        "//:node_modules/node-html-parser",
     ],
 )
 

diff --git a/common/testing/BUILD.bazel b/common/testing/BUILD.bazel
@@ -36,6 +36,8 @@ ts_project(
         ":effects",
         ":test_server",
         "//common:http",
+        "//:node_modules/http-status-codes",
+        "//:node_modules/tree-kill",
         "@npm//@types/jasmine",
         "@npm//@types/node",
         "@npm//http-status-codes",
@@ -51,10 +53,10 @@ ts_project(
         ":devserver",
         ":effect_tester",
         "//common:http",
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
         "@npm//@types/node",
         "@npm//http-status-codes",
+        "//:node_modules/http-status-codes",
     ],
 )
 
@@ -229,6 +231,8 @@ ts_project(
         ":test_server",
         "@npm//@types/node",
         "@npm//webdriverio",
+        "//:node_modules/debug", # TODO(#48): Remove after WebDriver supports pnpm.
+        "//:node_modules/webdriverio",
     ],
 )
 
@@ -240,7 +244,6 @@ ts_project(
         ":devserver",
         ":webdriver",
         "effect_tester",
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
         "@npm//webdriverio",
     ],

diff --git a/common/testing/devserver_test.ts b/common/testing/devserver_test.ts
@@ -1,11 +1,10 @@
 import { URL } from 'url';
 import { StatusCodes } from 'http-status-codes';
-import { runfiles } from '@bazel/runfiles';
 import * as http from '../http';
 import { Server, useDevserver } from './devserver';
 import { EffectTester } from './effect_tester';
 
-const devserver = runfiles.resolvePackageRelative('devserver_test_server');
+const devserver = 'common/testing/devserver_test_server';
 
 describe('devserver', () => {
     describe('Server', () => {

diff --git a/common/testing/webdriver_test.ts b/common/testing/webdriver_test.ts
@@ -1,15 +1,11 @@
-import { runfiles } from '@bazel/runfiles';
 import * as webdriverio from 'webdriverio';
 import { useDevserver } from './devserver';
 import { EffectTester } from './effect_tester';
 import { useWebDriver, webDriverTestTimeout } from './webdriver';
 
-const devserverBinary =
-    runfiles.resolvePackageRelative('webdriver_test_server');
-
 describe('webdriver', () => {
     describe('useWebDriver()', () => {
-        const devserver = useDevserver(devserverBinary);
+        const devserver = useDevserver('common/testing/webdriver_test_server');
 
         it('manages a WebDriver session without a server under test', async () => {
             const remoteSpy = spyOn(webdriverio, 'remote').and.callThrough();

diff --git a/examples/components/BUILD.bazel b/examples/components/BUILD.bazel
@@ -58,7 +58,6 @@ ts_project(
     deps = [
         "//common/testing:devserver",
         "//common/testing:webdriver",
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
     ],
 )

diff --git a/examples/components/test.ts b/examples/components/test.ts
@@ -1,11 +1,8 @@
-import { runfiles } from '@bazel/runfiles';
 import { useDevserver } from '../../common/testing/devserver';
 import { useWebDriver, webDriverTestTimeout } from '../../common/testing/webdriver';
 
-const devserverBinary = runfiles.resolvePackageRelative('devserver');
-
 describe('components', () => {
-    const devserver = useDevserver(devserverBinary);
+    const devserver = useDevserver('examples/components/devserver');
     const wd = useWebDriver(devserver);
 
     it('renders', async () => {

diff --git a/examples/custom_bundling/BUILD.bazel b/examples/custom_bundling/BUILD.bazel
@@ -77,7 +77,6 @@ ts_project(
     deps = [
         "//common/testing:devserver",
         "//common/testing:webdriver",
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
     ],
 )

diff --git a/examples/custom_bundling/test.ts b/examples/custom_bundling/test.ts
@@ -1,11 +1,8 @@
-import { runfiles } from '@bazel/runfiles';
 import { useDevserver } from '../../common/testing/devserver';
 import { useWebDriver, webDriverTestTimeout } from '../../common/testing/webdriver';
 
-const devserverBinary = runfiles.resolvePackageRelative('devserver');
-
 describe('custom bundling', () => {
-    const devserver = useDevserver(devserverBinary);
+    const devserver = useDevserver('examples/custom_bundling/devserver');
     const wd = useWebDriver(devserver);
 
     it('renders a custom bundled page', async () => {

diff --git a/examples/data/BUILD.bazel b/examples/data/BUILD.bazel
@@ -28,7 +28,6 @@ ts_project(
     deps = [
         "//common/testing:devserver",
         "//common/testing:webdriver",
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
     ],
 )

diff --git a/examples/data/test.ts b/examples/data/test.ts
@@ -1,11 +1,8 @@
-import { runfiles } from '@bazel/runfiles';
 import { useDevserver } from '../../common/testing/devserver';
 import { useWebDriver, webDriverTestTimeout } from '../../common/testing/webdriver';
 
-const devserverBinary = runfiles.resolvePackageRelative('devserver');
-
 describe('data', () => {
-    const devserver = useDevserver(devserverBinary);
+    const devserver = useDevserver('examples/data/devserver');
     const wd = useWebDriver(devserver);
 
     describe('index page', () => {

diff --git a/examples/declarative_shadow_dom/BUILD.bazel b/examples/declarative_shadow_dom/BUILD.bazel
@@ -45,7 +45,6 @@ ts_project(
     deps = [
         "//common/testing:devserver",
         "//common/testing:webdriver",
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
     ],
 )

diff --git a/examples/declarative_shadow_dom/test.ts b/examples/declarative_shadow_dom/test.ts
@@ -1,11 +1,8 @@
-import { runfiles } from '@bazel/runfiles';
 import { useDevserver } from '../../common/testing/devserver';
 import { getColor, useWebDriver, webDriverTestTimeout } from '../../common/testing/webdriver';
 
-const devserverBinary = runfiles.resolvePackageRelative('devserver');
-
 describe('Declarative Shadow DOM', () => {
-    const devserver = useDevserver(devserverBinary);
+    const devserver = useDevserver('examples/declarative_shadow_dom/devserver');
     const wd = useWebDriver(devserver);
 
     it('attaches the declarative shadow root to its host', async () => {

diff --git a/examples/javascript/BUILD.bazel b/examples/javascript/BUILD.bazel
@@ -21,7 +21,6 @@ ts_project(
     deps = [
         "//common/testing:devserver",
         "//common/testing:webdriver",
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
     ],
 )

diff --git a/examples/javascript/test.ts b/examples/javascript/test.ts
@@ -1,11 +1,8 @@
-import { runfiles } from '@bazel/runfiles';
 import { useDevserver } from '../../common/testing/devserver';
 import { useWebDriver, webDriverTestTimeout } from '../../common/testing/webdriver';
 
-const devserverBinary = runfiles.resolvePackageRelative('devserver');
-
 describe('JavaScript', () => {
-    const devserver = useDevserver(devserverBinary);
+    const devserver = useDevserver('examples/javascript/devserver');
     const wd = useWebDriver(devserver);
 
     it('renders component', async () => {

diff --git a/examples/minimal/BUILD.bazel b/examples/minimal/BUILD.bazel
@@ -38,7 +38,6 @@ ts_project(
         "//common/testing:devserver",
         "//common/testing:webdriver",
         "@npm//@types/jasmine",
-        "@npm//@bazel/runfiles",
     ],
 )
 

diff --git a/examples/minimal/test.ts b/examples/minimal/test.ts
@@ -1,11 +1,8 @@
-import { runfiles } from '@bazel/runfiles';
 import { useDevserver } from '../../common/testing/devserver';
 import { useWebDriver, webDriverTestTimeout } from '../../common/testing/webdriver';
 
-const devserverBinary = runfiles.resolvePackageRelative('devserver');
-
 describe('minimal', () => {
-    const devserver = useDevserver(devserverBinary);
+    const devserver = useDevserver('examples/minimal/devserver');
     const wd = useWebDriver(devserver);
 
     it('renders', async () => {

diff --git a/examples/multi_page/BUILD.bazel b/examples/multi_page/BUILD.bazel
@@ -49,7 +49,6 @@ ts_project(
     deps = [
         "//common/testing:devserver",
         "//common/testing:webdriver",
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
     ],
 )

diff --git a/examples/multi_page/test.ts b/examples/multi_page/test.ts
@@ -1,11 +1,8 @@
-import { runfiles } from '@bazel/runfiles';
 import { useDevserver } from '../../common/testing/devserver';
 import { getColor, useWebDriver, webDriverTestTimeout } from '../../common/testing/webdriver';
 
-const devserverBinary = runfiles.resolvePackageRelative('devserver');
-
 describe('multi_page', () => {
-    const devserver = useDevserver(devserverBinary);
+    const devserver = useDevserver('examples/multi_page/devserver');
     const wd = useWebDriver(devserver);
 
     describe('index page', () => {

diff --git a/examples/prerender_resources/BUILD.bazel b/examples/prerender_resources/BUILD.bazel
@@ -20,7 +20,6 @@ ts_project(
     testonly = True,
     data = [":prerender"],
     deps = [
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
         "@npm//@types/node",
     ],

diff --git a/examples/prerender_resources/generator_test.ts b/examples/prerender_resources/generator_test.ts
@@ -1,7 +1,6 @@
 import { promises as fs } from 'fs';
-import { runfiles } from '@bazel/runfiles';
 
-const prerenderedDir = runfiles.resolvePackageRelative('prerender');
+const prerenderedDir = 'examples/prerender_resources/prerender';
 
 describe('Prerender Resources', () => {
     it('prerenders `hello.txt`', async () => {

diff --git a/examples/resources/BUILD.bazel b/examples/resources/BUILD.bazel
@@ -41,7 +41,6 @@ ts_project(
     deps = [
         "//common/testing:devserver",
         "//common/testing:webdriver",
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
     ],
 )

diff --git a/examples/resources/test.ts b/examples/resources/test.ts
@@ -1,11 +1,8 @@
-import { runfiles } from '@bazel/runfiles';
 import { useDevserver } from '../../common/testing/devserver';
 import { useWebDriver, webDriverTestTimeout } from '../../common/testing/webdriver';
 
-const devserverBinary = runfiles.resolvePackageRelative('devserver');
-
 describe('resources', () => {
-    const devserver = useDevserver(devserverBinary);
+    const devserver = useDevserver('examples/resources/devserver');
     const wd = useWebDriver(devserver);
 
     it('renders with resources', async () => {

diff --git a/examples/scripts/BUILD.bazel b/examples/scripts/BUILD.bazel
@@ -30,7 +30,6 @@ ts_project(
     deps = [
         "//common/testing:devserver",
         "//common/testing:webdriver",
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
     ],
 )

diff --git a/examples/scripts/test.ts b/examples/scripts/test.ts
@@ -1,11 +1,8 @@
-import { runfiles } from '@bazel/runfiles';
 import { useDevserver } from '../../common/testing/devserver';
 import { useWebDriver, webDriverTestTimeout } from '../../common/testing/webdriver';
 
-const devserverBinary = runfiles.resolvePackageRelative('devserver');
-
 describe('Scripts', () => {
-    const devserver = useDevserver(devserverBinary);
+    const devserver = useDevserver('examples/scripts/devserver');
     const wd = useWebDriver(devserver);
 
     it('renders with scripts', async () => {

diff --git a/examples/site/blog/BUILD.bazel b/examples/site/blog/BUILD.bazel
@@ -12,6 +12,7 @@ prerender_pages(
     lib_deps = [
         "//packages/rules_prerender",
         "//examples/site/common:links",
+        "//:node_modules/markdown-it",
         "@npm//markdown-it",
         "@npm//@types/markdown-it",
         "@npm//@types/node",
@@ -30,10 +31,13 @@ ts_project(
         ":blog_prerender_for_test",
         "@npm//@types/jasmine",
         "@npm//node-html-parser",
+        "//:node_modules/node-html-parser",
     ],
 )
 
 jasmine_node_test(
     name = "blog_test",
+    # TODO(#48): Turn on after declarative shadow DOM can be used in `@aspect_rules_js`.
+    tags = ["manual"],
     deps = [":blog_test_lib"],
 )
diff --git a/examples/site/components/base/BUILD.bazel b/examples/site/components/base/BUILD.bazel
@@ -7,7 +7,10 @@ prerender_component(
     srcs = ["base.ts"],
     tsconfig = "//:tsconfig.json",
     source_map = True,
-    lib_deps = ["//packages/rules_prerender"],
+    lib_deps = [
+        "//packages/rules_prerender",
+        "//:node_modules/rules_prerender",
+    ],
     styles = [":styles"],
     visibility = ["//examples/site:__subpackages__"],
     deps = [
@@ -30,6 +33,7 @@ ts_project(
         ":base_prerender_for_test",
         "@npm//@types/jasmine",
         "@npm//node-html-parser",
+        "//:node_modules/node-html-parser",
     ],
 )
 

diff --git a/examples/site/components/counter/BUILD.bazel b/examples/site/components/counter/BUILD.bazel
@@ -12,7 +12,10 @@ prerender_component(
     srcs = ["counter_prerender.ts"],
     tsconfig = "//:tsconfig.json",
     source_map = True,
-    lib_deps = ["//packages/rules_prerender"],
+    lib_deps = [
+        "//packages/rules_prerender",
+        "//:node_modules/rules_prerender",
+    ],
     scripts = [":scripts"],
     visibility = ["//examples/site:__subpackages__"],
 )
@@ -31,6 +34,7 @@ ts_project(
         ":counter_prerender_for_test",
         "@npm//@types/jasmine",
         "@npm//node-html-parser",
+        "//:node_modules/node-html-parser",
     ],
 )
 
@@ -62,7 +66,6 @@ ts_project(
     deps = [
         "//common/testing:devserver",
         "//common/testing:webdriver",
-        "@npm//@bazel/runfiles",
         "@npm//@types/jasmine",
     ],
 )

diff --git a/examples/site/components/counter/counter_test.ts b/examples/site/components/counter/counter_test.ts
@@ -1,12 +1,9 @@
-import { runfiles } from '@bazel/runfiles';
 import { useDevserver } from '../../../../common/testing/devserver';
 import { useWebDriver, webDriverTestTimeout } from '../../../../common/testing/webdriver';
 
-const devserverBinary =
-    runfiles.resolvePackageRelative('counter_test_cases_devserver');
-
 describe('Counter', () => {
-    const devserver = useDevserver(devserverBinary);
+    const devserver = useDevserver(
+        'examples/site/components/counter/counter_test_cases_devserver');
     const wd = useWebDriver(devserver);
 
     it('increments when the increment button is clicked', async () => {

diff --git a/examples/site/components/footer/BUILD.bazel b/examples/site/components/footer/BUILD.bazel
@@ -10,6 +10,7 @@ prerender_component(
     lib_deps = [
         "//examples/site/common:links",
         "//packages/rules_prerender",
+        "//:node_modules/rules_prerender",
     ],
     styles = [":styles"],
     visibility = ["//examples/site:__subpackages__"],
@@ -29,6 +30,7 @@ ts_project(
         ":footer_prerender_for_test",
         "@npm//@types/jasmine",
         "@npm//node-html-parser",
+        "//:node_modules/node-html-parser",
     ],
 )