Handle non-hosted types for mocha

Bug: 390535614
Change-Id: I294c2e561bfb6749173d5108fe23a99e722f8cfb
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6304927
Reviewed-by: Alex Rudenko <[email protected]>
Reviewed-by: Simon Zünd <[email protected]>
Commit-Queue: Liviu Rau <[email protected]>

Author: Liviu Rau

scripts/build/typescript/ts_library.py

@@ -268,6 +268,10 @@ def main():
     parser.add_argument('--rewrapper-binary', required=False)
     parser.add_argument('--rewrapper-cfg', required=False)
     parser.add_argument('--rewrapper-exec-root', required=False)
+    parser.add_argument('--additional-type-definitions',
+                        nargs='*',
+                        required=False,
+                        help='List of TypeScript declaration files')
     parser.add_argument('--use-esbuild', action='store_true')
     parser.add_argument('--tsconfig-only', action='store_true')
     parser.set_defaults(test_only=False,
@@ -299,6 +303,10 @@ def get_relative_path_from_output_directory(file_to_resolve):
         sources = shlex.split(opts.sources_list.read())
 
     all_ts_files = sources + GLOBAL_TYPESCRIPT_DEFINITION_FILES
+
+    if (opts.additional_type_definitions):
+        all_ts_files += opts.additional_type_definitions
+
     tsconfig['files'] = [
         get_relative_path_from_output_directory(x) for x in all_ts_files
     ]

scripts/build/typescript/typescript.gni

@@ -148,6 +148,11 @@ template("ts_library") {
       args += [ "--tsconfig-only" ]
     }
 
+    if (defined(invoker.additional_type_definitions)) {
+      args += [ "--additional-type-definitions" ] +
+              rebase_path(invoker.additional_type_definitions, root_build_dir)
+    }
+
     if (defined(invoker.sourceslist)) {
       args += [
         "--sources-list",
@@ -282,6 +287,19 @@ template("node_ts_library") {
     inputs =
         [ devtools_location_prepend + "node_modules/@types/node/index.d.ts" ]
 
+    forward_variables_from(invoker,
+                           [
+                             "sources",
+                             "visibility",
+                             "deps",
+                             "additional_type_definitions",
+                           ])
+  }
+}
+template("ts_e2e_library") {
+  node_ts_library(target_name) {
+    additional_type_definitions =
+        [ devtools_location_prepend + "test/e2e_non_hosted/types.d.ts" ]
     forward_variables_from(invoker,
                            [
                              "sources",

test/e2e_non_hosted/conductor/BUILD.gn

@@ -12,7 +12,7 @@ group("conductor") {
   ]
 }
 
-node_ts_library("implementation") {
+ts_e2e_library("implementation") {
   deps = [
     "../../conductor:implementation",
     "../shared",

test/e2e_non_hosted/conductor/mocha-interface-helpers.ts

@@ -5,29 +5,11 @@
 import type * as Mocha from 'mocha';
 
 import {AsyncScope} from '../../conductor/async-scope.js';
-import type {Platform} from '../../conductor/platform.js';
 import {ScreenshotError} from '../../conductor/screenshot-error.js';
 import {TestConfig} from '../../conductor/test_config.js';
-import type {BrowserSettings, BrowserWrapper} from '../shared/browser-helper.js';
-import type {DevToolsFronendPage, DevtoolsSettings} from '../shared/frontend-helper.js';
+import type {BrowserWrapper} from '../shared/browser-helper.js';
+import type {DevToolsFronendPage} from '../shared/frontend-helper.js';
 import type {InspectedPage} from '../shared/target-helper.js';
-declare global {
-  namespace Mocha {
-    export interface TestFunction {
-      (title: string, fn: TestCallbackWithState): void;
-
-      skipOnPlatforms: (platforms: Platform[], title: string, fn: Mocha.AsyncFunc) => void;
-    }
-    export interface Suite {
-      settings: SuiteSettings;
-      state: State;
-      browser: BrowserWrapper;
-    }
-  }
-}
-
-export type HarnessSettings = BrowserSettings&DevtoolsSettings;
-export type SuiteSettings = Partial<HarnessSettings>;
 
 export interface State {
   devToolsPage: DevToolsFronendPage;

test/e2e_non_hosted/conductor/mocha-interface.ts

@@ -11,11 +11,7 @@ import * as Path from 'path';
 import {platform, type Platform} from '../../conductor/platform.js';
 import {TestConfig} from '../../conductor/test_config.js';
 
-import {
-  makeInstrumentedTestFunction,
-  type SuiteSettings,
-  type TestCallbackWithState
-} from './mocha-interface-helpers.js';
+import {makeInstrumentedTestFunction, type TestCallbackWithState} from './mocha-interface-helpers.js';
 import {StateProvider} from './state-provider.js';
 
 type SuiteFunction = ((this: Mocha.Suite) => void)|undefined;

test/e2e_non_hosted/conductor/state-provider.ts

@@ -13,7 +13,7 @@ import {type BrowserWrapper, DEFAULT_BROWSER_SETTINGS, Launcher} from '../shared
 import {DEFAULT_DEVTOOLS_SETTINGS, setupDevToolsPage} from '../shared/frontend-helper.js';
 import {setupInspectedPage} from '../shared/target-helper.js';
 
-import type {HarnessSettings, SuiteSettings, TestCallbackWithState} from './mocha-interface-helpers.js';
+import type {TestCallbackWithState} from './mocha-interface-helpers.js';
 
 class DebugModeNotice {
   /* eslint-disable no-console */
@@ -50,7 +50,7 @@ export class StateProvider {
   static instance = new StateProvider();
 
   debugNotice: DebugModeNotice;
-  settingsCallbackMap: Map<Mocha.Suite, SuiteSettings>;
+  settingsCallbackMap: Map<Mocha.Suite, E2E.SuiteSettings>;
   browserMap: Map<string, BrowserWrapper>;
   static serverPort: Number;
 
@@ -60,7 +60,7 @@ export class StateProvider {
     this.browserMap = new Map();
   }
 
-  registerSettingsCallback(suite: Mocha.Suite, suiteSettings: SuiteSettings) {
+  registerSettingsCallback(suite: Mocha.Suite, suiteSettings: E2E.SuiteSettings) {
     this.settingsCallbackMap.set(suite, suiteSettings);
   }
 
@@ -112,7 +112,7 @@ export class StateProvider {
     return {state, browsingContext};
   }
 
-  private async getSettings(suite: Mocha.Suite): Promise<HarnessSettings> {
+  private async getSettings(suite: Mocha.Suite): Promise<E2E.HarnessSettings> {
     const settings = this.settingsCallbackMap.get(suite);
     if (settings) {
       return mergeSettings(settings, DEFAULT_SETTINGS);
@@ -138,7 +138,7 @@ export class StateProvider {
   }
 }
 
-export function mergeSettings(s1: SuiteSettings, s2: HarnessSettings): HarnessSettings {
+export function mergeSettings(s1: E2E.SuiteSettings, s2: E2E.HarnessSettings): E2E.HarnessSettings {
   function mergeAsSet<T>(arr1?: T[], arr2?: T[]) {
     return Array.from(new Set(arr1 ?? []).union(new Set(arr2 ?? [])));
   }

test/e2e_non_hosted/dummy/BUILD.gn

@@ -4,7 +4,7 @@
 
 import("../../../scripts/build/typescript/typescript.gni")
 
-node_ts_library("dummy") {
+ts_e2e_library("dummy") {
   deps = [ "../conductor:implementation" ]
   sources = [ "dummy_test.ts" ]
 }

test/e2e_non_hosted/dummy/dummy_test.ts

@@ -2,8 +2,6 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import '../conductor/mocha-interface-helpers.js';
-
 import {assert} from 'chai';
 
 describe('Dummy', function() {

test/e2e_non_hosted/shared/BUILD.gn

@@ -4,7 +4,7 @@
 
 import("../../../scripts/build/typescript/typescript.gni")
 
-node_ts_library("shared") {
+ts_e2e_library("shared") {
   deps = [
     "../../conductor:implementation",
     "../../shared",

test/e2e_non_hosted/types.d.ts

@@ -0,0 +1,35 @@
+
+import type {Platform} from '../conductor/platform.js';
+
+import type {BrowserSettings, BrowserWrapper} from './shared/browser-helper.js';
+import type {DevToolsFronendPage, DevtoolsSettings} from './shared/frontend-helper.js';
+import type {InspectedPage} from './shared/target-helper.js';
+
+
+declare global {
+  namespace Mocha {
+    export interface TestFunction {
+      (title: string, fn: E2E.TestCallbackWithState): void;
+
+      skipOnPlatforms: (platforms: Platform[], title: string, fn: Mocha.AsyncFunc) => void;
+    }
+    export interface Suite {
+      settings: E2E.SuiteSettings;
+      state: E2E.State;
+      browser: BrowserWrapper;
+    }
+  }
+  namespace E2E {
+    export type HarnessSettings = BrowserSettings&DevtoolsSettings;
+    export type SuiteSettings = Partial<HarnessSettings>;
+
+    export interface State {
+      devToolsPage: DevToolsFronendPage;
+      inspectedPage: InspectedPage;
+      browser: BrowserWrapper;
+    }
+
+    /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
+    export type TestCallbackWithState = (state: State) => PromiseLike<any>;
+  }
+}