build: disable jasminewd2 types for sourcemap playground test (angular#46888)

devversion · AndrewKushnir · commit 4b1204cca7aa · 2022-07-19T09:40:54.000-07:00
The sourcemap test in the e2e playground is now using async/await code. This results in errors now with the Bazel TS compilation because it detects that `expect` is returning a promise and should be awaited. This happens due to the jasminewd2 types. We should just use the actual jasmine types and not rely on the deprecated selenium control flow, using explicit async/await in the whole test. This also solves the issue with the source-map types being async/await now. PR Close angular#46888
diff --git a/modules/playground/e2e_test/example_test.bzl b/modules/playground/e2e_test/example_test.bzl
@@ -1,18 +1,25 @@
 load("//tools:defaults.bzl", "protractor_web_test_suite", "ts_library")
 
-def example_test(name, srcs, server, data = [], deps = [], **kwargs):
+def example_test(name, srcs, server, data = [], deps = [], use_legacy_webdriver_types = True, **kwargs):
+    ts_deps = [
+        "@npm//@angular/dev-infra-private/bazel/benchmark/driver-utilities",
+        "//packages/private/testing",
+        "@npm//@types/selenium-webdriver",
+        "@npm//protractor",
+    ] + deps
+
+    # Reliance on the Control Flow in Selenium Webdriver is not recommended long-term,
+    # especially with the deprecation of Protractor. New tests should not use the legacy
+    # webdriver types but rather use the actual `@types/jasmine` types.
+    if use_legacy_webdriver_types:
+        ts_deps.append("@npm//@types/jasminewd2")
+
     ts_library(
         name = "%s_lib" % name,
         testonly = True,
         srcs = srcs,
         tsconfig = "//modules/playground:tsconfig-e2e.json",
-        deps = [
-            "@npm//@angular/dev-infra-private/bazel/benchmark/driver-utilities",
-            "//packages/private/testing",
-            "@npm//@types/jasminewd2",
-            "@npm//@types/selenium-webdriver",
-            "@npm//protractor",
-        ] + deps,
+        deps = ts_deps,
     )
 
     protractor_web_test_suite(
diff --git a/modules/playground/e2e_test/sourcemap/BUILD.bazel b/modules/playground/e2e_test/sourcemap/BUILD.bazel
@@ -8,6 +8,7 @@ example_test(
         "//modules/playground/src/sourcemap:index.ts",
     ],
     server = "//modules/playground/src/sourcemap:devserver",
+    use_legacy_webdriver_types = False,
     deps = [
         "@npm//source-map",
     ],
diff --git a/modules/playground/e2e_test/sourcemap/sourcemap_spec.ts b/modules/playground/e2e_test/sourcemap/sourcemap_spec.ts
@@ -14,40 +14,38 @@ import {RawSourceMap, SourceMapConsumer} from 'source-map';
 describe('sourcemaps', function() {
   const URL = '/';
 
-  it('should map sources', function() {
-    browser.get(URL);
-
-    $('error-app .errorButton').click();
-
-    browser.manage().logs().get(logging.Type.BROWSER).then(async function(logs: any) {
-      let errorLine: number|null = null;
-      let errorColumn: number|null = null;
-      logs.forEach(function(log: any) {
-        const match = log.message.match(/\.createError\s+\(.+:(\d+):(\d+)/m);
-        if (match) {
-          errorLine = parseInt(match[1]);
-          errorColumn = parseInt(match[2]);
-        }
-      });
-
-      expect(errorLine).not.toBeNull();
-      expect(errorColumn).not.toBeNull();
-
-      const content =
-          readFileSync(require.resolve('../../src/sourcemap/index.js')).toString('utf8');
-      const marker = '//# sourceMappingURL=data:application/json;base64,';
-      const index = content.indexOf(marker);
-      const sourceMapData =
-          Buffer.from(content.substring(index + marker.length), 'base64').toString('utf8');
-
-      const decoder = await new SourceMapConsumer(JSON.parse(sourceMapData) as RawSourceMap);
-      const originalPosition =
-          decoder.originalPositionFor({line: errorLine!, column: errorColumn!});
-      const sourceCodeLines = readFileSync(require.resolve('../../src/sourcemap/index.ts'), {
-                                encoding: 'utf-8'
-                              }).split('\n');
-      expect(sourceCodeLines[originalPosition.line! - 1])
-          .toMatch(/throw new Error\(\'Sourcemap test\'\)/);
+  it('should map sources', async function() {
+    await browser.get(URL);
+
+    await $('error-app .errorButton').click();
+
+    const logs = await browser.manage().logs().get(logging.Type.BROWSER);
+
+    let errorLine: number|null = null;
+    let errorColumn: number|null = null;
+    logs.forEach(function(log: any) {
+      const match = log.message.match(/\.createError\s+\(.+:(\d+):(\d+)/m);
+      if (match) {
+        errorLine = parseInt(match[1]);
+        errorColumn = parseInt(match[2]);
+      }
     });
+
+    expect(errorLine).not.toBeNull();
+    expect(errorColumn).not.toBeNull();
+
+    const content = readFileSync(require.resolve('../../src/sourcemap/index.js')).toString('utf8');
+    const marker = '//# sourceMappingURL=data:application/json;base64,';
+    const index = content.indexOf(marker);
+    const sourceMapData =
+        Buffer.from(content.substring(index + marker.length), 'base64').toString('utf8');
+
+    const decoder = await new SourceMapConsumer(JSON.parse(sourceMapData) as RawSourceMap);
+    const originalPosition = decoder.originalPositionFor({line: errorLine!, column: errorColumn!});
+    const sourceCodeLines = readFileSync(require.resolve('../../src/sourcemap/index.ts'), {
+                              encoding: 'utf-8'
+                            }).split('\n');
+    expect(sourceCodeLines[originalPosition.line! - 1])
+        .toMatch(/throw new Error\(\'Sourcemap test\'\)/);
   });
 });
