feat(bazel): create a base jasmine_test with source map and relative path rewrite support (#3025)

PR Close #3025

Author: josephperrott

bazel/jasmine/BUILD.bazel

@@ -0,0 +1,14 @@
+load("@aspect_rules_js//js:defs.bzl", "js_library")
+
+js_library(
+    name = "stack-traces",
+    srcs = [
+        "stack-traces.mjs",
+    ],
+    visibility = [
+        "//visibility:public",
+    ],
+    deps = [
+        "//bazel:node_modules/source-map-support",
+    ],
+)

bazel/jasmine/jasmine.bzl

@@ -0,0 +1,15 @@
+load("@aspect_rules_jasmine//jasmine:defs.bzl", _jasmine_test = "jasmine_test")
+
+def jasmine_test(name, data = [], node_options = [], **kwargs):
+    _jasmine_test(
+        name = name,
+        data = data + [
+            "@devinfra//bazel/jasmine:stack-traces",
+        ],
+        size = kwargs.pop("size", "medium"),
+        node_options = [
+            "--import",
+            "$$JS_BINARY__RUNFILES/$(rlocationpath @devinfra//bazel/jasmine:stack-traces)",
+        ] + node_options,
+        **kwargs
+    )

bazel/jasmine/stack-traces.mjs

@@ -0,0 +1,19 @@
+import {install} from 'source-map-support';
+
+// Set up source map support to ensure we are logging the stack trace for the source file (i.e. .ts file) and
+// not the generated file (i.e. .js. file).
+install();
+
+/** The root path that the test files are running from within. */
+let rootPath = `${process.env.RUNFILES}/${process.env.TEST_WORKSPACE}/`;
+/** The root path match for when test files are not within the sandbox, but the executation is happening within the sandbox. */
+let sandboxPath = `/.*${process.env.JS_BINARY__WORKSPACE}/${process.env.JS_BINARY__BINDIR}/`;
+/** Regex to capture the content and name of the function in the stack trace. */
+const basePathRegex = new RegExp(`(at.*)(?:file.*${rootPath}|file.*${sandboxPath})`, 'g');
+
+// Replace the prepareStackTrace function with one which replaces the full path execution location with
+// relative paths to the base of the workspace source files.
+const originalPrepareStackTrace = Error.prepareStackTrace;
+Error.prepareStackTrace = function (e, s) {
+  return originalPrepareStackTrace(e, s).replaceAll(basePathRegex, '$1./');
+};

bazel/package.json

@@ -8,6 +8,7 @@
     "@types/selenium-webdriver": "^4.1.28",
     "@types/send": "0.17.5",
     "@types/wait-on": "^5.3.4",
+    "@types/source-map-support": "0.5.10",
     "@types/yargs": "17.0.33",
     "browser-sync": "3.0.4",
     "chalk": "5.6.0",
@@ -20,6 +21,7 @@
     "protractor": "7.0.0",
     "semver": "7.7.2",
     "selenium-webdriver": "4.35.0",
+    "source-map-support": "0.5.21",
     "tinyglobby": "0.2.14"
   }
 }

pnpm-lock.yaml

@@ -1,7 +1,6 @@
 load("@aspect_bazel_lib//lib:copy_to_bin.bzl", _copy_to_bin = "copy_to_bin")
 load("@aspect_bazel_lib//lib:write_source_files.bzl", _write_source_file = "write_source_file")
 load("@aspect_rules_esbuild//esbuild:defs.bzl", _esbuild = "esbuild")
-load("@aspect_rules_jasmine//jasmine:defs.bzl", _jasmine_test = "jasmine_test")
 load("@aspect_rules_js//js:defs.bzl", _js_binary = "js_binary")
 load("@aspect_rules_js//npm:defs.bzl", _npm_package = "npm_package")
 load("@aspect_rules_ts//ts:defs.bzl", _ts_config = "ts_config")
@@ -10,6 +9,7 @@ load("@rules_angular//src/ng_project:index.bzl", _ng_project = "ng_project")
 load("@rules_angular//src/ts_project:index.bzl", _ts_project = "ts_project")
 load("@rules_sass//src:index.bzl", _npm_sass_library = "npm_sass_library", _sass_binary = "sass_binary")
 load("//bazel:extract_types.bzl", _extract_types = "extract_types")
+load("//bazel/jasmine:jasmine.bzl", _jasmine_test = "jasmine_test")
 load("//bazel/ts_project:index.bzl", _strict_deps_test = "strict_deps_test")
 
 copy_to_bin = _copy_to_bin
@@ -110,7 +110,6 @@ def jasmine_test(name, **kwargs):
     _jasmine_test(
         name = name,
         node_modules = "//:node_modules",
-        chdir = native.package_name(),
         fixed_args = [
             "'**/*+(.|_)spec.js'",
         ],