Merge branch 'master' into feat/4175-idling-resource-refactoring

detox/package.json

@@ -74,7 +74,7 @@
     "caf": "^15.0.1",
     "chalk": "^4.0.0",
     "child-process-promise": "^2.2.0",
-    "detox-copilot": "^0.0.24",
+    "detox-copilot": "^0.0.27",
     "execa": "^5.1.1",
     "find-up": "^5.0.0",
     "fs-extra": "^11.0.0",

detox/src/DetoxWorker.js

@@ -1,4 +1,5 @@
 const CAF = require('caf');
+const copilot = require('detox-copilot').default;
 const _ = require('lodash');
 
 const Client = require('./client/Client');
@@ -62,7 +63,7 @@ class DetoxWorker {
     /** @type {Detox.SystemFacade} */
     this.system = null;
     /** @type {Detox.DetoxCopilotFacade} */
-    this.copilot = null;
+    this.copilot = new DetoxCopilot();
 
     this._deviceCookie = null;
 
@@ -126,8 +127,6 @@ class DetoxWorker {
       runtimeDeviceFactory,
     } = environmentFactory.createFactories(deviceConfig);
 
-    this.copilot = new DetoxCopilot();
-
     const envValidator = envValidatorFactory.createValidator();
     yield envValidator.validate();
 
@@ -226,9 +225,10 @@ class DetoxWorker {
     yield this._artifactsManager.onRunDescribeStart(...args);
   };
 
-  onTestStart = function* (_signal, testSummary) {
-    // Copilot is reset before each test to ensure a clean state
-    this.copilot.resetIfNeeded();
+  onTestStart = function* (_signal, testSummary){
+    if (copilot.isInitialized()) {
+      copilot.start();
+    }
 
     this._validateTestSummary('beforeEach', testSummary);
 
@@ -257,6 +257,11 @@ class DetoxWorker {
       pendingRequests: testSummary.timedOut,
       testName: testSummary.fullName,
     });
+
+    if (copilot.isInitialized()) {
+      // In case of failure, pass false to copilot, so temporary cache is not saved
+      copilot.end(testSummary.status === 'passed');
+    }
   };
 
   onRunDescribeFinish = function* (_signal, ...args) {

detox/src/DetoxWorker.test.js

@@ -3,14 +3,24 @@ const testSummaries = require('./artifacts/__mocks__/testSummaries.mock');
 const configuration = require('./configuration');
 const Deferred = require('./utils/Deferred');
 
-jest.mock('./copilot/DetoxCopilot');
 jest.mock('./utils/logger');
 jest.mock('./client/Client');
 jest.mock('./utils/AsyncEmitter');
 jest.mock('./invoke');
 jest.mock('./utils/wrapWithStackTraceCutter');
 jest.mock('./environmentFactory');
 
+let mockIsInitialized = false;
+jest.mock('detox-copilot', () => ({
+  default: {
+    init: jest.fn(),
+    isInitialized: jest.fn(() => mockIsInitialized),
+    start: jest.fn(),
+    end: jest.fn(),
+    perform: jest.fn(),
+  },
+}));
+
 describe('DetoxWorker', () => {
   const fakeCookie = {
     chocolate: 'yum',
@@ -41,6 +51,7 @@ describe('DetoxWorker', () => {
   let runtimeDevice;
   let Detox;
   let detox;
+  let copilot;
 
   beforeEach(() => {
     mockEnvironmentFactories();
@@ -56,6 +67,8 @@ describe('DetoxWorker', () => {
   });
 
   beforeEach(async () => {
+    mockIsInitialized = false;
+
     detoxConfig = await configuration.composeDetoxConfig({
       override: {
         configurations: {
@@ -86,6 +99,8 @@ describe('DetoxWorker', () => {
       [symbols.allocateDevice]: jest.fn().mockResolvedValue(fakeCookie),
       [symbols.deallocateDevice]: jest.fn(),
     };
+
+    copilot = require('detox-copilot').default;
   });
 
   describe('when DetoxWorker#init() is called', () => {
@@ -301,17 +316,14 @@ describe('DetoxWorker', () => {
         await init();
       });
 
-      it('should create a new DetoxCopilot instance', () => {
-        expect(DetoxCopilot).toHaveBeenCalledTimes(1);
-      });
 
       it('should assign the DetoxCopilot instance to the copilot property', () => {
         expect(detox.copilot).toBeDefined();
         expect(detox.copilot).toBeInstanceOf(DetoxCopilot);
       });
 
       it('should not initialize the copilot', () => {
-        expect(detox.copilot.init).not.toHaveBeenCalled();
+        expect(copilot.init).not.toHaveBeenCalled();
       });
     });
   });
@@ -334,24 +346,30 @@ describe('DetoxWorker', () => {
           status: undefined,
         })).rejects.toThrowError(/Invalid test summary status/);
       });
+    });
+
+    describe('with a valid test summary', () => {
+      beforeEach(() => detox.onTestStart(testSummaries.running()));
 
-      it('should reset copilot if needed', async () => {
+      it('should notify artifacts manager about "testStart', () =>
+        expect(artifactsManager.onTestStart).toHaveBeenCalledWith(testSummaries.running()));
+
+      it('should not start copilot if copilot init was not called', async () => {
         try {
           await detox.onTestStart('Test');
         } catch {}
 
-        expect(detox.copilot.resetIfNeeded).toHaveBeenCalled();
+        expect(copilot.start).not.toHaveBeenCalled();
       });
-    });
 
-    describe('with a valid test summary', () => {
-      beforeEach(() => detox.onTestStart(testSummaries.running()));
+      it('should start copilot if copilot init was called', async () => {
+        mockIsInitialized = true;
 
-      it('should notify artifacts manager about "testStart', () =>
-        expect(artifactsManager.onTestStart).toHaveBeenCalledWith(testSummaries.running()));
+        try {
+          await detox.onTestStart('Test');
+        } catch {}
 
-      it('should reset copilot if needed', async () => {
-        expect(detox.copilot.resetIfNeeded).toHaveBeenCalled();
+        expect(copilot.start).toHaveBeenCalled();
       });
 
       it('should not relaunch app', async () => {
@@ -382,6 +400,10 @@ describe('DetoxWorker', () => {
 
       it('should notify artifacts manager about "testDone"', () =>
         expect(artifactsManager.onTestDone).toHaveBeenCalledWith(testSummaries.passed()));
+
+      it('should not end copilot if copilot init was not called', async () => {
+        expect(copilot.end).not.toHaveBeenCalled();
+      });
     });
 
     describe('with a failed test summary (due to failed asseration)', () => {
@@ -397,6 +419,22 @@ describe('DetoxWorker', () => {
       it('should dump pending network requests', () =>
         expect(client().dumpPendingRequests).toHaveBeenCalled());
     });
+
+    it('should end copilot if copilot init was called', async () => {
+      mockIsInitialized = true;
+
+      await detox.onTestDone(testSummaries.passed());
+
+      expect(copilot.end).toHaveBeenCalledWith(true);
+    });
+
+    it('should end copilot without cache if copilot init was called', async () => {
+      mockIsInitialized = true;
+
+      await detox.onTestDone(testSummaries.failed());
+
+      expect(copilot.end).toHaveBeenCalledWith(false);
+    });
   });
 
   describe('when DetoxWorker#cleanup() is called', () => {

detox/src/copilot/DetoxCopilot.js

@@ -2,27 +2,15 @@ const copilot = require('detox-copilot').default;
 
 const detoxCopilotFrameworkDriver = require('./detoxCopilotFrameworkDriver');
 
+/**
+ * @typedef {Object} Detox.DetoxCopilotFacade
+ */
 class DetoxCopilot {
-  constructor() {
-    this.isInitialized = false;
-  }
-
   init(promptHandler) {
     copilot.init({
       frameworkDriver: detoxCopilotFrameworkDriver,
       promptHandler: promptHandler
     });
-
-    this.isInitialized = true;
-  }
-
-  resetIfNeeded() {
-    if (!this.isInitialized) {
-      // Copilot is not initialized, nothing to reset
-      return;
-    }
-
-    copilot.reset();
   }
 
   perform(...steps) {

detox/src/copilot/DetoxCopilot.test.js

@@ -6,7 +6,9 @@ const detoxCopilotFrameworkDriver = require('./detoxCopilotFrameworkDriver');
 jest.mock('detox-copilot', () => ({
   default: {
     init: jest.fn(),
-    reset: jest.fn(),
+    isInitialized: jest.fn().mockReturnValue(false),
+    start: jest.fn(),
+    end: jest.fn(),
     perform: jest.fn(),
   },
 }));
@@ -23,30 +25,13 @@ describe('DetoxCopilot', () => {
   });
 
   describe('init', () => {
-    it('should initialize copilot with correct parameters', () => {
+    it.skip('should initialize copilot with correct parameters', () => {
       detoxCopilot.init(mockPromptHandler);
 
       expect(copilot.init).toHaveBeenCalledWith({
         frameworkDriver: detoxCopilotFrameworkDriver,
         promptHandler: mockPromptHandler,
       });
-      expect(detoxCopilot.isInitialized).toBe(true);
-    });
-  });
-
-  describe('resetIfNeeded', () => {
-    it('should reset copilot if initialized', () => {
-      detoxCopilot.isInitialized = true;
-      detoxCopilot.resetIfNeeded();
-
-      expect(copilot.reset).toHaveBeenCalled();
-    });
-
-    it('should not reset copilot if not initialized', () => {
-      detoxCopilot.isInitialized = false;
-      detoxCopilot.resetIfNeeded();
-
-      expect(copilot.reset).not.toHaveBeenCalled();
     });
   });