wip: revive worker context

detox/local-cli/test.js

@@ -1,5 +1,5 @@
 // @ts-nocheck
-const realm = require('../realms/root');
+const realm = require('../realms/primary');
 
 const TestRunnerCommand = require('./testCommand/TestRunnerCommand');
 

detox/local-cli/test.test.js

@@ -169,7 +169,7 @@ describe('CLI', () => {
  });
 
  test.each([['-R'], ['--retries']])('%s <value> should execute unsuccessful run N extra times', async (__retries) => {
- const context = require('../realms/root');
+ const context = require('../realms/primary');
  jest.spyOn(context, 'lastFailedTests', 'get')
  .mockReturnValueOnce(['e2e/failing1.test.js', 'e2e/failing2.test.js'])
  .mockReturnValueOnce(['e2e/failing2.test.js']);
@@ -188,7 +188,7 @@ describe('CLI', () => {
  });
 
  test.each([['-R'], ['--retries']])('%s <value> should not restart test runner if there are no failing tests paths', async (__retries) => {
- const context = require('../realms/root');
+ const context = require('../realms/primary');
  jest.spyOn(context, 'lastFailedTests', 'get')
  .mockReturnValueOnce([]);
  cp.execSync.mockImplementation(() => { throw new Error; });
@@ -199,7 +199,7 @@ describe('CLI', () => {
  });
 
  test.each([['-R'], ['--retries']])('%s <value> should retain -- <...explicitPassthroughArgs>', async (__retries) => {
- const context = require('../realms/root');
+ const context = require('../realms/primary');
  jest.spyOn(context, 'lastFailedTests', 'get')
  .mockReturnValueOnce(['tests/failing.test.js']);
  cp.execSync.mockImplementation(() => { throw new Error; });

detox/local-cli/testCommand/TestRunnerCommand.js

@@ -4,7 +4,7 @@ const os = require('os');
 const _ = require('lodash');
 const unparse = require('yargs-unparser');
 
-const context = require('../../realms/root');
+const context = require('../../realms/primary');
 const { printEnvironmentVariables, prependNodeModulesBinToPATH } = require('../../src/utils/envUtils');
 const { quote } = require('../../src/utils/shellQuote');
 
@@ -126,14 +126,16 @@ class TestRunnerCommand {
  printEnvironmentVariables(this._envHint) + fullCommand
  );
 
- cp.execSync(fullCommand, {
- stdio: 'inherit',
- env: _({})
- .assign(process.env)
- .assign(this._env)
- .omitBy(_.isUndefined)
- .tap(prependNodeModulesBinToPATH)
- .value()
+ return new Promise((resolve, reject) => {
+ cp.spawn(command, fullCommand.split(' ').slice(1), {
+ stdio: 'inherit',
+ env: _({})
+ .assign(process.env)
+ .assign(this._env)
+ .omitBy(_.isUndefined)
+ .tap(prependNodeModulesBinToPATH)
+ .value()
+ }).on('exit', (code) => code === 0 ? resolve() : reject(code));
  });
  }
 }

detox/package.json

@@ -35,6 +35,7 @@
  "@types/child-process-promise": "^2.2.1",
  "@types/jest": "^27.0.3",
  "@types/node": "^12.20.37",
+ "@types/node-ipc": "^9.2.0",
  "@types/ws": "^7.4.0",
  "@typescript-eslint/eslint-plugin": "^5.4.0",
  "@typescript-eslint/parser": "^5.4.0",
@@ -63,7 +64,7 @@
  "ini": "^1.3.4",
  "lodash": "^4.17.5",
  "minimist": "^1.2.0",
- "node-ipc": "^10.1.0",
+ "node-ipc": "^9.2.1",
  "proper-lockfile": "^3.0.2",
  "resolve-from": "^5.0.0",
  "sanitize-filename": "^1.6.1",

detox/realms/index.js

@@ -1,13 +1,5 @@
 function current() {
- if (process.env.JEST_WORKER_ID) {
- return require('./worker');
- }
-
- if (process.env.DETOX_IPC_SERVER_ID) {
- return require('./runner');
- }
-
- return require('./root');
+ return process.env.DETOX_IPC_SERVER_ID ? require('./secondary') : require('./primary');
 }
 
 module.exports = current();

detox/realms/root/DetoxRootContext.js → detox/realms/primary/DetoxRootContext.js

@@ -7,6 +7,7 @@ const _ = require('lodash');
 const configuration = require('../../src/configuration');
 const DeviceRegistry = require('../../src/devices/DeviceRegistry');
 const GenyDeviceRegistryFactory = require('../../src/devices/allocation/drivers/android/genycloud/GenyDeviceRegistryFactory');
+const environmentFactory = require('../../src/environmentFactory');
 const NullLogger = require('../../src/logger/NullLogger');
 const DetoxServer = require('../../src/server/DetoxServer');
 
@@ -19,6 +20,7 @@ class DetoxRootContext {
  this._wss = null;
  this._ipc = null;
  this._logger = new NullLogger();
+ this._globalLifecycleHandler = null;
 
  this.setup = this.setup.bind(this);
  this.teardown = this.teardown.bind(this);
@@ -48,6 +50,10 @@ class DetoxRootContext {
  this._wss = null;
  }
 
+ if (this._globalLifecycleHandler) {
+ await this._globalLifecycleHandler.globalCleanup();
+ }
+
  // TODO: move the artifacts
  }
 
@@ -66,6 +72,7 @@ class DetoxRootContext {
 
  async _doSetup() {
  const config = this._config;
+
  this._logger = new BunyanLogger({
  loglevel: config.cliConfig.loglevel || 'info',
  });
@@ -84,13 +91,21 @@ class DetoxRootContext {
  );
 
  this._ipc = new IPCServer({
- sessionId: `detox-${process.pid}`,
+ id: 'detox-' + process.pid,
  detoxConfig: this._config,
  logger: this._logger,
  });
 
+ process.env.DETOX_IPC_SERVER_ID = this._ipc.id;
  await this._ipc.start();
- const { cliConfig, sessionConfig } = config;
+
+ const { cliConfig, deviceConfig, sessionConfig } = config;
+
+ this._globalLifecycleHandler = await environmentFactory.createGlobalLifecycleHandler(deviceConfig);
+
+ if (this._globalLifecycleHandler) {
+ await this._globalLifecycleHandler.globalInit();
+ }
 
  if (!cliConfig.keepLockFile) {
  await this._resetLockFile();

detox/realms/primary/IPCServer.js

@@ -0,0 +1,53 @@
+const { upperFirst, camelCase } = require('lodash');
+
+const { DetoxInternalError } = require('../../src/errors');
+
+class IPCServer {
+ constructor({ id, logger, detoxConfig }) {
+ this._id = id;
+ this._logger = logger;
+ this._state = {
+ workers: 0,
+ detoxConfig,
+ };
+ this._ipc = null;
+ }
+
+ get id() {
+ return this._id;
+ }
+
+ async start() {
+ this._ipc = require('node-ipc');
+ this._ipc.config.id = this._id;
+ this._ipc.config.retry = 1500;
+ // this._ipc.config.silent = true;
+ await new Promise((resolve) => {
+ // TODO: handle reject
+ this._ipc.serve(() => resolve());
+ this._ipc.server.on('registerWorker', this.onRegisterWorker.bind(this));
+ this._ipc.server.on('log', this.onLog.bind(this));
+ this._ipc.server.start();
+ });
+ }
+
+ async stop() {
+ return new Promise((resolve, reject) =>{
+ // @ts-ignore
+ this._ipc.server.server.close(e => e ? reject(e) : resolve());
+ });
+ }
+
+ onRegisterWorker({ workerId }, socket) {
+ const workersCount = this._state.workers = Math.max(this._state.workers, +workerId);
+ const detoxConfig = this._state.detoxConfig;
+ socket.emit('detoxConfig', detoxConfig);
+ this._ipc.server.broadcast('workersCount', { value: workersCount });
+ }
+
+ onLog({ level, args }) {
+ this._logger[level](args);
+ }
+}
+
+module.exports = IPCServer;

detox/realms/secondary/DetoxRunnerContext.js

@@ -0,0 +1,42 @@
+const ipcClient = require('../../src/ipc/client');
+const IPCLogger = require('../../src/logger/IPCLogger');
+const NullLogger = require('../../src/logger/NullLogger');
+
+class DetoxRunnerContext {
+ constructor() {
+ this.setup = this.setup.bind(this);
+ this.teardown = this.teardown.bind(this);
+ /** @type {NullLogger | IPCLogger} */
+ this._logger = new NullLogger();
+ this._fingerprint = Math.random();
+ this._ready = false;
+ this._config = null;
+ }
+
+ async setup() {
+ if (this._ready) {
+ return;
+ }
+
+ await ipcClient.init();
+ this._config = await ipcClient.getDetoxConfig();
+ this._logger = new IPCLogger({
+ level: this._config.cliConfig.loglevel,
+ });
+ this._ready = true;
+ }
+
+ async teardown() {
+ this._ready = false;
+ }
+
+ get config() {
+ return this._config;
+ }
+
+ get log() {
+ return this._logger;
+ }
+}
+
+module.exports = DetoxRunnerContext;

detox/realms/secondary/index.js

@@ -0,0 +1,2 @@
+const DetoxRunnerContext = require('./DetoxRunnerContext');
+module.exports = new DetoxRunnerContext();

detox/runners/jest-circus/environment/index.js

@@ -0,0 +1 @@
+module.exports = require('../../migration')(__filename);