Merge pull request #4732 from wix/update-wix-pilot

chore: update Detox Pilot version (formerly Copilot).

Author: asafkorem

detox/detox.d.ts

@@ -9,7 +9,7 @@
 // * Dor Ben Baruch <https://github.com/Dor256>
 
 import { BunyanDebugStreamOptions } from 'bunyan-debug-stream';
-import { CopilotFacade, PromptHandler } from "detox-copilot";
+import type { Pilot, PromptHandler as _PromptHandler } from '@wix-pilot/core'
 
 declare global {
     namespace Detox {
@@ -446,7 +446,13 @@ declare global {
 
             readonly system: SystemFacade;
 
-            readonly copilot: DetoxCopilotFacade;
+            readonly pilot: PilotFacade;
+
+          /**
+           * @deprecated This API is deprecated and will be removed in the next major version.
+           * Please use `pilot` instead of `pilot`.
+           */
+            readonly copilot: PilotFacade;
 
             readonly DetoxConstants: {
                 userNotificationTriggers: {
@@ -1329,17 +1335,17 @@ declare global {
             element(systemMatcher: SystemMatcher): IndexableSystemElement;
         }
 
-        interface DetoxCopilotFacade extends Pick<CopilotFacade, "perform"> {
+        interface PilotFacade extends Pick<Pilot, "perform" | "autopilot" | "extendAPICatalog"> {
             /**
-             * Initializes the Copilot with the given prompt handler.
-             * Must be called before any other Copilot methods.
-             * @note Copilot APIs are still in experimental phase and are subject to changes in the near future.
+             * Initializes the Pilot with the given prompt handler.
+             * Must be called before any other Pilot methods.
+             * @note Wix-Pilot APIs are still in experimental phase and are subject to changes in the near future.
              * @param promptHandler The prompt handler to use.
              */
-            init: (promptHandler: DetoxCopilotPromptHandler) => void;
+            init: (promptHandler: PromptHandler) => void;
         }
 
-        interface DetoxCopilotPromptHandler extends PromptHandler {}
+        type PromptHandler = _PromptHandler;
 
         interface IndexableSystemElement extends SystemElement {
             /**

detox/globals.d.ts

@@ -10,6 +10,7 @@ declare global {
   const web: Detox.DetoxExportWrapper['web'];
   const system: Detox.DetoxExportWrapper['system'];
   const copilot: Detox.DetoxExportWrapper['copilot'];
+  const pilot: Detox.DetoxExportWrapper['pilot'];
 
   namespace NodeJS {
     interface Global {
@@ -22,6 +23,7 @@ declare global {
       web: Detox.DetoxExportWrapper['web'];
       system: Detox.DetoxExportWrapper['system'];
       copilot: Detox.DetoxExportWrapper['copilot'];
+      pilot: Detox.DetoxExportWrapper['pilot'];
     }
   }
 }

detox/jest.config.js

@@ -75,7 +75,7 @@ module.exports = {
     'src/DetoxWorker.js',
     'src/logger/utils/streamUtils.js',
     'src/realms',
-    'src/copilot',
+    'src/pilot',
   ],
   resetMocks: true,
   resetModules: true,

detox/package.json

@@ -68,12 +68,13 @@
     "wtfnode": "^0.9.1"
   },
   "dependencies": {
+    "@wix-pilot/core": "^3.1.4",
+    "@wix-pilot/detox": "^1.0.8",
     "ajv": "^8.6.3",
     "bunyan": "^1.8.12",
     "bunyan-debug-stream": "^3.1.0",
     "caf": "^15.0.1",
     "chalk": "^4.0.0",
-    "detox-copilot": "^0.0.27",
     "execa": "^5.1.1",
     "find-up": "^5.0.0",
     "fs-extra": "^11.0.0",

detox/src/DetoxWorker.js

@@ -1,12 +1,11 @@
 const CAF = require('caf');
-const copilot = require('detox-copilot').default;
 const _ = require('lodash');
 
 const Client = require('./client/Client');
-const DetoxCopilot = require('./copilot/DetoxCopilot');
 const environmentFactory = require('./environmentFactory');
 const { DetoxRuntimeErrorComposer } = require('./errors');
 const { InvocationManager } = require('./invoke');
+const DetoxPilot = require('./pilot/DetoxPilot');
 const symbols = require('./realms/symbols');
 const AsyncEmitter = require('./utils/AsyncEmitter');
 const uuid = require('./utils/uuid');
@@ -62,8 +61,8 @@ class DetoxWorker {
     this.web = null;
     /** @type {Detox.SystemFacade} */
     this.system = null;
-    /** @type {Detox.DetoxCopilotFacade} */
-    this.copilot = new DetoxCopilot();
+    /** @type {Detox.PilotFacade} */
+    this.pilot = null;
 
     this._deviceCookie = null;
 
@@ -103,14 +102,14 @@ class DetoxWorker {
     // @ts-ignore
     this._sessionConfig.sessionId = sessionConfig.sessionId || uuid.UUID();
     this._runtimeErrorComposer.appsConfig = this._appsConfig;
-
     this._client = new Client(sessionConfig);
     this._client.terminateApp = async () => {
       // @ts-ignore
       if (this.device && this.device._isAppRunning()) {
         await this.device.terminateApp();
       }
     };
+    this.pilot = new DetoxPilot();
 
     yield this._client.connect();
 
@@ -163,12 +162,19 @@ class DetoxWorker {
       const injectedGlobals = {
         ...matchers,
         device: this.device,
-        copilot: this.copilot,
+        pilot: this.pilot,
         detox: this,
       };
 
       this._injectedGlobalProperties = Object.keys(injectedGlobals);
       Object.assign(DetoxWorker.global, injectedGlobals);
+      Object.defineProperty(DetoxWorker.global, 'copilot', {
+        get: () => {
+          console.warn('Warning: "copilot" is deprecated. Please use "pilot" instead.');
+          return this.pilot;
+        },
+        configurable: true,
+      });
     }
 
     // @ts-ignore
@@ -226,8 +232,8 @@ class DetoxWorker {
   };
 
   onTestStart = function* (_signal, testSummary){
-    if (copilot.isInitialized()) {
-      copilot.start();
+    if (this.pilot.isInitialized()) {
+      this.pilot.start();
     }
 
     this._validateTestSummary('beforeEach', testSummary);
@@ -258,8 +264,8 @@ class DetoxWorker {
       testName: testSummary.fullName,
     });
 
-    if (copilot.isInitialized()) {
-      copilot.end(testSummary.status !== 'passed');
+    if (this.pilot.isInitialized()) {
+      this.pilot.end(testSummary.status === 'passed');
     }
   };
 

detox/src/DetoxWorker.test.js

@@ -1,7 +1,11 @@
 // @ts-nocheck
 const testSummaries = require('./artifacts/__mocks__/testSummaries.mock');
 const configuration = require('./configuration');
+const DetoxPilot = require('./pilot/DetoxPilot');
 const Deferred = require('./utils/Deferred');
+jest.mock('@wix-pilot/detox', () => ({
+  DetoxFrameworkDriver: jest.fn(),
+}));
 
 jest.mock('./utils/logger');
 jest.mock('./client/Client');
@@ -10,16 +14,20 @@ 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(),
-  },
-}));
+
+jest.mock('./pilot/DetoxPilot', () => {
+  return jest.fn().mockImplementation(() => {
+    return {
+      init: jest.fn(),
+      start: jest.fn(),
+      perform: jest.fn(),
+      autopilot: jest.fn(),
+      extendAPICatalog: jest.fn(),
+      end: jest.fn(),
+      isInitialized: jest.fn().mockReturnValue(false),
+    };
+  });
+});
 
 describe('DetoxWorker', () => {
   const fakeCookie = {
@@ -51,7 +59,6 @@ describe('DetoxWorker', () => {
   let runtimeDevice;
   let Detox;
   let detox;
-  let copilot;
 
   beforeEach(() => {
     mockEnvironmentFactories();
@@ -67,8 +74,6 @@ describe('DetoxWorker', () => {
   });
 
   beforeEach(async () => {
-    mockIsInitialized = false;
-
     detoxConfig = await configuration.composeDetoxConfig({
       override: {
         configurations: {
@@ -100,7 +105,6 @@ describe('DetoxWorker', () => {
       [symbols.deallocateDevice]: jest.fn(),
     };
 
-    copilot = require('detox-copilot').default;
   });
 
   describe('when DetoxWorker#init() is called', () => {
@@ -307,23 +311,21 @@ describe('DetoxWorker', () => {
       });
     });
 
-    describe('copilot initialization', () => {
-      let DetoxCopilot;
-
+    describe('pilot initialization', () => {
       beforeEach(async () => {
-        DetoxCopilot = require('./copilot/DetoxCopilot');
-
         await init();
       });
 
 
-      it('should assign the DetoxCopilot instance to the copilot property', () => {
-        expect(detox.copilot).toBeDefined();
-        expect(detox.copilot).toBeInstanceOf(DetoxCopilot);
+      it('should assign the DetoxPilot instance to the pilot property', () => {
+        expect(detox.pilot).toBeDefined();
+
+        const detoxPilot = new DetoxPilot();
+        expect(typeof detox.pilot).toBe(typeof detoxPilot);
       });
 
-      it('should not initialize the copilot', () => {
-        expect(copilot.init).not.toHaveBeenCalled();
+      it('should not initialize the pilot', () => {
+        expect(detox.pilot.init).not.toHaveBeenCalled();
       });
     });
   });
@@ -349,27 +351,29 @@ describe('DetoxWorker', () => {
     });
 
     describe('with a valid test summary', () => {
-      beforeEach(() => detox.onTestStart(testSummaries.running()));
+      beforeEach(() => {
+        detox.onTestStart(testSummaries.running());
+      });
 
       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 () => {
+      it('should not start pilot if pilot init was not called', async () => {
         try {
           await detox.onTestStart('Test');
         } catch {}
 
-        expect(copilot.start).not.toHaveBeenCalled();
+        expect(detox.pilot.start).not.toHaveBeenCalled();
       });
 
-      it('should start copilot if copilot init was called', async () => {
-        mockIsInitialized = true;
+      it('should start pilot if pilot init was called', async () => {
+        detox.pilot.isInitialized = () => true;
 
         try {
           await detox.onTestStart('Test');
         } catch {}
 
-        expect(copilot.start).toHaveBeenCalled();
+        expect(detox.pilot.start).toHaveBeenCalled();
       });
 
       it('should not relaunch app', async () => {
@@ -401,8 +405,8 @@ 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();
+      it('should not end pilot if pilot init was not called', async () => {
+        expect(detox.pilot.end).not.toHaveBeenCalled();
       });
     });
 
@@ -420,20 +424,20 @@ describe('DetoxWorker', () => {
         expect(client().dumpPendingRequests).toHaveBeenCalled());
     });
 
-    it('should end copilot with cache enabled if test has passed', async () => {
-      mockIsInitialized = true;
+    it('should end pilot with cache enabled if test has passed', async () => {
+      detox.pilot.isInitialized = () => true;
 
       await detox.onTestDone(testSummaries.passed());
 
-      expect(copilot.end).toHaveBeenCalledWith(false);
+      expect(detox.pilot.end).toHaveBeenCalledWith(true);
     });
 
-    it('should end copilot without cache if test has failed', async () => {
-      mockIsInitialized = true;
+    it('should end pilot without cache if test has failed', async () => {
+      detox.pilot.isInitialized = () => true;
 
       await detox.onTestDone(testSummaries.failed());
 
-      expect(copilot.end).toHaveBeenCalledWith(true);
+      expect(detox.pilot.end).toHaveBeenCalledWith(false);
     });
   });