Feat: Add public API for workers (#2115)

* Feat: Add public API for workers

* Add boostrab and teardown hooks

* Refract worker and Add tests

* Add tests and Refract worker

* Remove node 8 support

* Add share API

* Add share API review changes

Author: KMKoushik

lib/codecept.js

@@ -76,6 +76,7 @@ class Codecept {
       global.DataTable = require('./data/table');
       global.locate = locator => require('./locator').build(locator);
       global.inject = container.support;
+      global.share = container.share;
       global.secret = require('./secret').secret;
       global.codeceptjs = require('./index'); // load all objects
 

lib/command/run-workers.js

@@ -11,6 +11,7 @@ const { tryOrDefault, fileExists } = require('../utils');
 const output = require('../output');
 const event = require('../event');
 const runHook = require('../hooks');
+const WorkerStorage = require('../workerStorage');
 
 const stats = {
   suites: 0,
@@ -76,14 +77,16 @@ module.exports = function (workers, options) {
   function createWorkers(groups, options, testRoot) {
     const workers = groups.map((tests, workerIndex) => {
       workerIndex++;
-      return new Worker(pathToWorker, {
+      const worker = new Worker(pathToWorker, {
         workerData: {
           options: simplifyObject(options),
           tests,
           testRoot,
           workerIndex,
         },
       });
+      WorkerStorage.addWorker(worker);
+      return worker;
     });
 
     return workers;

lib/command/workers/runTests.js

@@ -14,6 +14,7 @@ const event = require('../../event');
 const output = require('../../output');
 const container = require('../../container');
 const { getConfig, getTestRoot } = require('../utils');
+const { tryOrDefault } = require('../../utils');
 
 let stdout = '';
 const stderr = '';
@@ -29,7 +30,13 @@ const {
 // hide worker output
 if (!options.debug && !options.verbose) process.stdout.write = (string, encoding, fd) => { stdout += string; return true; };
 
-const config = getConfig(options.config || testRoot);
+
+const overrideConfigs = tryOrDefault(() => JSON.parse(options.override), {});
+
+const config = {
+  ...getConfig(options.config || testRoot),
+  ...overrideConfigs,
+};
 
 // Load test and run
 const codecept = new Codecept(config, options);
@@ -40,6 +47,7 @@ filterTests();
 if (mocha.suite.total()) {
   codecept.runBootstrap((err) => {
     if (err) throw new Error(`Error while running bootstrap file :${err}`);
+    listenToParentThread();
     initializeListeners();
     disablePause();
     codecept.run();
@@ -139,3 +147,9 @@ function collectStats() {
 function sendToParentThread(data) {
   parentPort.postMessage(data);
 }
+
+function listenToParentThread() {
+  parentPort.on('message', (eventData) => {
+    container.append({ support: eventData.data });
+  });
+}

lib/container.js

@@ -1,11 +1,12 @@
 const glob = require('glob');
 const path = require('path');
-
 const fileExists = require('./utils').fileExists;
 const Translation = require('./translation');
 const MochaFactory = require('./mochaFactory');
 const recorder = require('./recorder');
 const event = require('./event');
+const WorkerStorage = require('./workerStorage');
+
 
 let container = {
   helpers: {},
@@ -129,6 +130,19 @@ class Container {
     container.plugins = newPlugins || {};
     container.translation = loadTranslation();
   }
+
+  /**
+   * Share data across worker threads
+   *
+   * @param {Object} data
+   * @param {Object} options - set {local: true} to not share among workers
+   */
+  static share(data, options = {}) {
+    Container.append({ support: data });
+    if (!options.local) {
+      WorkerStorage.share(data);
+    }
+  }
 }
 
 module.exports = Container;

lib/index.js

@@ -36,4 +36,6 @@ module.exports = {
   store: require('./store'),
   /** @type {typeof CodeceptJS.Locator} */
   locator: require('./locator'),
+
+  Workers: require('./workers'),
 };

lib/workerStorage.js

@@ -0,0 +1,46 @@
+const { isMainThread, parentPort } = require('worker_threads');
+
+const workerObjects = {};
+const shareEvent = 'share';
+
+const invokeWorkerListeners = (workerObj) => {
+  const { threadId } = workerObj;
+  workerObj.on('message', (messageData) => {
+    if (messageData.event === shareEvent) {
+      share(messageData.data);
+    }
+  });
+  workerObj.on('exit', () => {
+    delete workerObjects[threadId];
+  });
+};
+
+class WorkerStorage {
+  /**
+   * Add worker object
+   *
+   * @api
+   * @param {Worker} workerObj
+   */
+  static addWorker(workerObj) {
+    workerObjects[workerObj.threadId] = workerObj;
+    invokeWorkerListeners(workerObj);
+  }
+
+  /**
+   * Share data across workers
+   *
+   * @param {*} data
+   */
+  static share(data) {
+    if (isMainThread) {
+      for (const workerObj of Object.values(workerObjects)) {
+        workerObj.postMessage({ data });
+      }
+    } else {
+      parentPort.postMessage({ data, event: shareEvent });
+    }
+  }
+}
+
+module.exports = WorkerStorage;