fix(ios): preserve logs after device.resetContentAndSettings() (#4215)

detox/src/devices/allocation/drivers/ios/SimulatorAllocDriver.js

@@ -20,12 +20,10 @@ class SimulatorAllocDriver {
    * @param {import('../../DeviceRegistry')} options.deviceRegistry
    * @param {DetoxInternals.RuntimeConfig} options.detoxConfig
    * @param {import('../../../common/drivers/ios/tools/AppleSimUtils')} options.applesimutils
-   * @param {import('./SimulatorLauncher')} options.simulatorLauncher
    */
-  constructor({ detoxConfig, deviceRegistry, applesimutils, simulatorLauncher }) {
+  constructor({ detoxConfig, deviceRegistry, applesimutils }) {
     this._deviceRegistry = deviceRegistry;
     this._applesimutils = applesimutils;
-    this._simulatorLauncher = simulatorLauncher;
     this._launchInfo = {};
     this._shouldShutdown = detoxConfig.behavior.cleanup.shutdownDevice;
   }
@@ -61,7 +59,7 @@ class SimulatorAllocDriver {
   async postAllocate(deviceCookie) {
     const { udid } = deviceCookie;
     const { deviceConfig } = this._launchInfo[udid];
-    await this._simulatorLauncher.launch(udid, deviceConfig.type, deviceConfig.bootArgs, deviceConfig.headless);
+    await this._applesimutils.boot(udid, deviceConfig.bootArgs, deviceConfig.headless);
 
     return {
       id: udid,
@@ -105,7 +103,7 @@ class SimulatorAllocDriver {
    */
   async _doShutdown(udid) {
     try {
-      await this._simulatorLauncher.shutdown(udid);
+      await this._applesimutils.shutdown(udid);
     } catch (err) {
       log.warn({ err }, `Failed to shutdown simulator ${udid}`);
     }

detox/src/devices/allocation/factories/ios.js

@@ -9,11 +9,8 @@ class IosSimulator extends DeviceAllocatorFactory {
     const DeviceRegistry = require('../../../devices/allocation/DeviceRegistry');
     const deviceRegistry = new DeviceRegistry({ sessionId: detoxSession.id });
 
-    const SimulatorLauncher = require('../drivers/ios/SimulatorLauncher');
-    const simulatorLauncher = new SimulatorLauncher({ applesimutils, eventEmitter });
-
     const SimulatorAllocDriver = require('../drivers/ios/SimulatorAllocDriver');
-    return new SimulatorAllocDriver({ detoxConfig, deviceRegistry, applesimutils, simulatorLauncher });
+    return new SimulatorAllocDriver({ detoxConfig, deviceRegistry, applesimutils });
   }
 }
 

detox/src/devices/runtime/drivers/ios/SimulatorDriver.js

@@ -14,7 +14,6 @@ const IosDriver = require('./IosDriver');
 
 /**
  * @typedef SimulatorDriverDeps { DeviceDriverDeps }
- * @property simulatorLauncher { SimulatorLauncher }
  * @property applesimutils { AppleSimUtils }
  */
 
@@ -38,7 +37,6 @@ class SimulatorDriver extends IosDriver {
     this._bootArgs = bootArgs;
     this._headless = headless;
     this._deviceName = `${udid} (${this._type})`;
-    this._simulatorLauncher = deps.simulatorLauncher;
     this._applesimutils = deps.applesimutils;
   }
 
@@ -150,9 +148,12 @@ class SimulatorDriver extends IosDriver {
   }
 
   async resetContentAndSettings() {
-    await this._simulatorLauncher.shutdown(this.udid);
+    await this.emitter.emit('beforeShutdownDevice', { deviceId: this.udid });
+    await this._applesimutils.shutdown(this.udid);
+    await this.emitter.emit('shutdownDevice', { deviceId: this.udid });
     await this._applesimutils.resetContentAndSettings(this.udid);
-    await this._simulatorLauncher.launch(this.udid, this._type, this._bootArgs, this._headless);
+    await this._applesimutils.boot(this.udid, this._bootArgs, this._headless);
+    await this.emitter.emit('bootDevice', { deviceId: this.udid });
   }
 
   getLogsPaths() {

detox/src/devices/runtime/drivers/ios/SimulatorDriver.test.js

@@ -9,7 +9,6 @@ describe('IOS simulator driver', () => {
   let client;
   let eventEmitter;
   let applesimutils;
-  let simulatorLauncher;
   let uut;
   beforeEach(() => {
     const AsyncEmitter = require('../../../../utils/AsyncEmitter');
@@ -24,12 +23,9 @@ describe('IOS simulator driver', () => {
     const AppleSimUtils = jest.genMockFromModule('../../../common/drivers/ios/tools/AppleSimUtils');
     applesimutils = new AppleSimUtils();
 
-    const SimulatorLauncher = jest.genMockFromModule('../../../allocation/drivers/ios/SimulatorLauncher');
-    simulatorLauncher = new SimulatorLauncher();
-
     const SimulatorDriver = require('./SimulatorDriver');
     uut = new SimulatorDriver(
-      { simulatorLauncher, applesimutils, client, eventEmitter },
+      { applesimutils, client, eventEmitter },
       { udid, type, bootArgs, headless }
     );
   });
@@ -74,7 +70,7 @@ describe('IOS simulator driver', () => {
   describe('.resetContentAndSettings', () => {
     it('should shut the device down', async () => {
       await uut.resetContentAndSettings();
-      expect(simulatorLauncher.shutdown).toHaveBeenCalledWith(udid);
+      expect(applesimutils.shutdown).toHaveBeenCalledWith(udid);
     });
 
     it('should reset via apple-sim-utils', async () => {
@@ -84,7 +80,7 @@ describe('IOS simulator driver', () => {
 
     it('should relaunch the simulator', async () => {
       await uut.resetContentAndSettings();
-      expect(simulatorLauncher.launch).toHaveBeenCalledWith(udid, type, bootArgs, true);
+      expect(applesimutils.boot).toHaveBeenCalledWith(udid, bootArgs, true);
     });
   });
 

detox/src/devices/runtime/factories/ios.js

@@ -7,11 +7,9 @@ class RuntimeDriverFactoryIos extends RuntimeDeviceFactory {
     const AppleSimUtils = require('../../../devices/common/drivers/ios/tools/AppleSimUtils');
     const applesimutils = new AppleSimUtils();
 
-    const SimulatorLauncher = require('../../allocation/drivers/ios/SimulatorLauncher');
     return {
       ...commonDeps,
       applesimutils,
-      simulatorLauncher: new SimulatorLauncher({ applesimutils, eventEmitter }),
     };
   }
 }