Merge pull request #1274 from gemini-testing/TESTPLANE-1032.async_events

feat: make CLI and NEW_BROWSER events async

Author: KuznetsovRoman

src/cli/index.ts

@@ -145,7 +145,7 @@ export const run = async (opts: TestplaneRunOpts = {}): Promise<void> => {
         registerCmd(program, testplane);
     }
 
-    testplane.extendCli(program);
+    await testplane.extendCli(program);
 
     program.parse(process.argv);
 };

src/testplane.ts

@@ -101,8 +101,8 @@ export class Testplane extends BaseTestplane {
         this.testsTracker = null;
     }
 
-    extendCli(parser: Command): void {
-        this.emit(MasterEvents.CLI, parser);
+    async extendCli(parser: Command): Promise<void> {
+        await this.emitAndWait(MasterEvents.CLI, parser);
     }
 
     addFileToRemove(path: string): void {

src/types/index.ts

@@ -256,7 +256,7 @@ export type MasterEventHandler<T extends BaseTestplane> = {
     (event: Events["DOM_SNAPSHOTS"], callback: (context: TestContext, data: SnapshotsData) => void): T;
     (event: Events["TEST_DEPENDENCIES"], callback: (context: TestDepsContext, data: TestDepsData) => void): T;
 
-    (event: Events["CLI"], callback: (commander: commander.CommanderStatic) => void): T;
+    (event: Events["CLI"], callback: (commander: commander.CommanderStatic) => void | Promise<void>): T;
     (event: Events["BEGIN"], callback: () => void): T;
     (event: Events["END"], callback: () => void): T;
     (event: Events["BEFORE_FILE_READ"], callback: (data: BeforeFileReadData) => void): T;
@@ -268,7 +268,6 @@ export type MasterEventHandler<T extends BaseTestplane> = {
 
     (event: Events["UPDATE_REFERENCE"], callback: (data: { state: string; refImg: RefImageInfo }) => void): T;
     (event: Events["ADD_FILE_TO_REMOVE"], callback: (path: string) => void): T;
-    (event: Events["NEW_BROWSER"], callback: SyncSessionEventCallback): T;
 };
 
 export type WorkerEventHandler<T extends BaseTestplane> = {
@@ -278,7 +277,7 @@ export type WorkerEventHandler<T extends BaseTestplane> = {
     (event: Events["AFTER_TESTS_READ"], callback: (collection: TestCollection) => void): T;
 
     (event: Events["UPDATE_REFERENCE"], callback: (data: { state: string; refImg: RefImageInfo }) => void): T;
-    (event: Events["NEW_BROWSER"], callback: SyncSessionEventCallback): T;
+    (event: Events["NEW_BROWSER"], callback: AsyncSessionEventCallback): T;
 };
 
 export type CookieSameSite = "Strict" | "Lax" | "None";

src/worker/runner/browser-pool.js

@@ -27,7 +27,10 @@ module.exports = class BrowserPool {
         try {
             await browser.init({ sessionId, sessionCaps, sessionOpts }, this._calibrator);
 
-            this._emitter.emit(WorkerEvents.NEW_BROWSER, browser.publicAPI, { browserId: browser.id, browserVersion });
+            await this._emitter.emitAndWait(WorkerEvents.NEW_BROWSER, browser.publicAPI, {
+                browserId: browser.id,
+                browserVersion,
+            });
 
             return browser;
         } catch (error) {

test/src/cli/commands/config/index.ts

@@ -11,9 +11,9 @@ describe("cli/commands/config", () => {
     let consoleInfoStub: SinonStub;
     let jsonStringifyStub: SinonSpy;
 
-    const config_ = async (options: string[] = [], cli: { run: VoidFunction } = testplaneCli): Promise<void> => {
+    const config_ = async (options: string[] = [], cli: { run: () => Promise<void> } = testplaneCli): Promise<void> => {
         process.argv = ["foo/bar/node", "foo/bar/script", "config", ...options];
-        cli.run();
+        await cli.run();
 
         await (Command.prototype.action as SinonStub).lastCall.returnValue;
     };

test/src/cli/commands/list-browsers/index.ts

@@ -14,9 +14,12 @@ describe("cli/commands/list-browsers", () => {
     let loggerErrorStub: SinonStub;
     let consoleInfoStub: SinonStub;
 
-    const listBrowsers_ = async (options: string[] = [], cli: { run: VoidFunction } = testplaneCli): Promise<void> => {
+    const listBrowsers_ = async (
+        options: string[] = [],
+        cli: { run: () => Promise<void> } = testplaneCli,
+    ): Promise<void> => {
         process.argv = ["foo/bar/node", "foo/bar/script", "list-browsers", ...options];
-        cli.run();
+        await cli.run();
 
         await (Command.prototype.action as SinonStub).lastCall.returnValue;
     };

test/src/cli/commands/list-tests/index.ts

@@ -13,9 +13,9 @@ describe("cli/commands/list-tests", () => {
     const sandbox = sinon.createSandbox();
     let testplaneCli: typeof testplaneCliOriginal;
 
-    const listTests_ = async (argv: string = "", cli: { run: VoidFunction } = testplaneCli): Promise<void> => {
+    const listTests_ = async (argv: string = "", cli: { run: () => Promise<void> } = testplaneCli): Promise<void> => {
         process.argv = ["foo/bar/node", "foo/bar/script", "list-tests", ...argv.split(" ")].filter(Boolean);
-        cli.run();
+        await cli.run();
 
         await (Command.prototype.action as SinonStub).lastCall.returnValue;
     };

test/src/testplane.js

@@ -137,14 +137,14 @@ describe("testplane", () => {
     });
 
     describe("extendCli", () => {
-        it("should emit CLI event with passed parser", () => {
+        it("should emit CLI event with passed parser", async () => {
             const testplane = mkTestplane_();
             const onCli = sinon.spy().named("onCli");
             const parser = { foo: "bar" };
 
             testplane.on(RunnerEvents.CLI, onCli);
 
-            testplane.extendCli(parser);
+            await testplane.extendCli(parser);
 
             assert.calledOnceWith(onCli, parser);
         });

test/src/worker/runner/browser-pool.js

@@ -1,11 +1,10 @@
 "use strict";
 
-const EventEmitter = require("events").EventEmitter;
 const _ = require("lodash");
 const { ExistingBrowser } = require("src/browser/existing-browser");
 const BrowserPool = require("src/worker/runner/browser-pool");
 const { Calibrator } = require("src/browser/calibrator");
-const { WorkerEvents: RunnerEvents } = require("src/events");
+const { WorkerEvents: RunnerEvents, AsyncEmitter } = require("src/events");
 const ipc = require("src/utils/ipc");
 
 describe("worker/browser-pool", () => {
@@ -20,7 +19,7 @@ describe("worker/browser-pool", () => {
     const createPool = opts => {
         opts = _.defaults(opts || {}, {
             config: stubConfig(),
-            emitter: new EventEmitter(),
+            emitter: new AsyncEmitter(),
         });
 
         return BrowserPool.create(opts.config, opts.emitter);
@@ -48,7 +47,7 @@ describe("worker/browser-pool", () => {
     describe("getBrowser", () => {
         it("should create browser with correct args", async () => {
             const config = stubConfig();
-            const emitter = new EventEmitter();
+            const emitter = new AsyncEmitter();
             const browserPool = createPool({ config, emitter });
             ExistingBrowser.create.returns(stubBrowser({ browserId: "bro-id" }));
 
@@ -81,7 +80,7 @@ describe("worker/browser-pool", () => {
         });
 
         it('should emit "NEW_BROWSER" event on creating of a browser', async () => {
-            const emitter = new EventEmitter();
+            const emitter = new AsyncEmitter();
             const onNewBrowser = sandbox.spy().named("onNewBrowser");
             const browserPool = createPool({ emitter });