appium-xcuitest-driver 7.31.0 → 7.32.0

package/lib/commands/log.js

@@ -8,7 +8,9 @@ import WebSocket from 'ws';
 import SafariConsoleLog from '../device-log/safari-console-log';
 import SafariNetworkLog from '../device-log/safari-network-log';
 import { toLogEntry } from '../device-log/helpers';
-import { NATIVE_WIN, BIDI_EVENT_NAME } from '../utils';
+import { NATIVE_WIN } from '../utils';
+import { BIDI_EVENT_NAME } from './bidi/constants';
+import { makeLogEntryAddedEvent } from './bidi/models';
 
 /**
  * Determines the websocket endpoint based on the `sessionId`
@@ -107,42 +109,6 @@ export default {
     );
   },
 
-  /**
-   * https://w3c.github.io/webdriver-bidi/#event-log-entryAdded
-   *
-   * @template {import('node:events').EventEmitter} EE
-   * @this {XCUITestDriver}
-   * @param {EE} logEmitter
-   * @param {BiDiListenerProperties} properties
-   * @returns {[EE, import('./types').LogListener]}
-   */
-  assignBiDiLogListener (logEmitter, properties) {
-    const {
-      type,
-      context = NATIVE_WIN,
-      srcEventName = 'output',
-      entryTransformer,
-    } = properties;
-    const listener = (/** @type {import('./types').LogEntry} */ logEntry) => {
-      const finalEntry = entryTransformer ? entryTransformer(logEntry) : logEntry;
-      this.eventEmitter.emit(BIDI_EVENT_NAME, {
-        context,
-        method: 'log.entryAdded',
-        params: {
-          type,
-          level: finalEntry.level,
-          source: {
-            realm: '',
-          },
-          text: finalEntry.message,
-          timestamp: finalEntry.timestamp,
-        },
-      });
-    };
-    logEmitter.on(srcEventName, listener);
-    return [logEmitter, listener];
-  },
-
   /**
    * @this {XCUITestDriver}
    */
@@ -154,7 +120,7 @@ export default {
     }
 
     if (_.isUndefined(this.logs.syslog)) {
-      [this.logs.crashlog,] = this.assignBiDiLogListener(
+      [this.logs.crashlog,] = assignBiDiLogListener.bind(this)(
         new IOSCrashLog({
           sim: /** @type {import('appium-ios-simulator').Simulator} */ (this.device),
           udid: this.isRealDevice() ? this.opts.udid : undefined,
@@ -163,7 +129,7 @@ export default {
           type: 'crashlog',
         }
       );
-      [this.logs.syslog,] = this.assignBiDiLogListener(
+      [this.logs.syslog,] = assignBiDiLogListener.bind(this)(
         this.isRealDevice()
           ? new IOSDeviceLog({
             udid: this.opts.udid,
@@ -182,7 +148,7 @@ export default {
         }
       );
       if (_.isBoolean(this.opts.showSafariConsoleLog)) {
-        [this.logs.safariConsole,] = this.assignBiDiLogListener(
+        [this.logs.safariConsole,] = assignBiDiLogListener.bind(this)(
           new SafariConsoleLog({
             showLogs: this.opts.showSafariConsoleLog,
             log: this.log,
@@ -192,7 +158,7 @@ export default {
         );
       }
       if (_.isBoolean(this.opts.showSafariNetworkLog)) {
-        [this.logs.safariNetwork,] = this.assignBiDiLogListener(
+        [this.logs.safariNetwork,] = assignBiDiLogListener.bind(this)(
           new SafariNetworkLog({
             showLogs: this.opts.showSafariNetworkLog,
             log: this.log,
@@ -202,7 +168,7 @@ export default {
         );
       }
       if (this.isFeatureEnabled(GET_SERVER_LOGS_FEATURE)) {
-        [, this._bidiServerLogListener] = this.assignBiDiLogListener(
+        [, this._bidiServerLogListener] = assignBiDiLogListener.bind(this)(
           this.log.unwrap(), {
             type: 'server',
             srcEventName: 'log',
@@ -323,14 +289,32 @@ export default {
 };
 
 /**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ * https://w3c.github.io/webdriver-bidi/#event-log-entryAdded
+ *
+ * @template {import('node:events').EventEmitter} EE
+ * @this {XCUITestDriver}
+ * @param {EE} logEmitter
+ * @param {BiDiListenerProperties} properties
+ * @returns {[EE, import('./types').LogListener]}
  */
+export function assignBiDiLogListener (logEmitter, properties) {
+  const {
+    type,
+    context = NATIVE_WIN,
+    srcEventName = 'output',
+    entryTransformer,
+  } = properties;
+  const listener = (/** @type {import('./types').LogEntry} */ logEntry) => {
+    const finalEntry = entryTransformer ? entryTransformer(logEntry) : logEntry;
+    this.eventEmitter.emit(BIDI_EVENT_NAME, makeLogEntryAddedEvent(finalEntry, context, type));
+  };
+  logEmitter.on(srcEventName, listener);
+  return [logEmitter, listener];
+}
 
 /**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
  * @typedef {keyof typeof SUPPORTED_LOG_TYPES} XCUITestDriverLogTypes
- */
-
-/**
  * @typedef {import('@appium/types').AppiumServer} AppiumServer
  */
 

package/lib/driver.js

@@ -62,6 +62,7 @@ import {
   translateDeviceName,
 } from './utils';
 import { AppInfosCache } from './app-infos-cache';
+import { notifyBiDiContextChange } from './commands/context';
 
 const SHUTDOWN_OTHER_FEAT_NAME = 'shutdown_other_sims';
 const CUSTOMIZE_RESULT_BUNDLE_PATH = 'customize_result_bundle_path';
@@ -660,6 +661,9 @@ export class XCUITestDriver extends BaseDriver {
 
     if (this.isSafari() || this.opts.autoWebview) {
       await this.activateRecentWebview();
+    } else {
+      // We want to always setup the initial context value upon session startup
+      await notifyBiDiContextChange.bind(this)();
     }
     if (this.isSafari()) {
       if (shouldSetInitialSafariUrl(this.opts)) {
@@ -2017,7 +2021,6 @@ export class XCUITestDriver extends BaseDriver {
   extractLogs = commands.logExtensions.extractLogs;
   supportedLogTypes = commands.logExtensions.supportedLogTypes;
   startLogCapture = commands.logExtensions.startLogCapture;
-  assignBiDiLogListener = commands.logExtensions.assignBiDiLogListener;
   mobileStartLogsBroadcast = commands.logExtensions.mobileStartLogsBroadcast;
   mobileStopLogsBroadcast = commands.logExtensions.mobileStopLogsBroadcast;
 

package/lib/utils.js

@@ -21,7 +21,6 @@ const XCTEST_LOG_FILES_PATTERNS = [
 ];
 const XCTEST_LOGS_CACHE_FOLDER_PREFIX = 'com.apple.dt.XCTest';
 export const NATIVE_WIN = 'NATIVE_APP';
-export const BIDI_EVENT_NAME = 'bidiEvent';
 
 /**
  * @privateRemarks Is the minimum version really Xcode 7.3?

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-xcuitest-driver",
-  "version": "7.31.0",
+  "version": "7.32.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "7.31.0",
+      "version": "7.32.0",
       "license": "Apache-2.0",
       "dependencies": {
         "@colors/colors": "^1.6.0",
@@ -118,6 +118,18 @@
       "integrity": "sha512-sviUmCE8AYdaF/KIHLDJBQgeYzPBI0vf/17NaYehBJfYD1j6/L95Slh07NlyK2iNyBNaEkb3En2jRt+a8y3xZQ==",
       "license": "MIT"
     },
+    "node_modules/@appium/base-driver/node_modules/type-fest": {
+      "version": "4.26.1",
+      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.26.1.tgz",
+      "integrity": "sha512-yOGpmOAL7CkKe/91I5O3gPICmJNLJ1G4zFYVAsRHg7M64biSnPtRj0WNQt++bRkjYOqjWXrhnUw1utzmVErAdg==",
+      "license": "(MIT OR CC0-1.0)",
+      "engines": {
+        "node": ">=16"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
     "node_modules/@appium/docutils": {
       "version": "1.0.23",
       "resolved": "https://registry.npmjs.org/@appium/docutils/-/docutils-1.0.23.tgz",
@@ -153,6 +165,18 @@
         "npm": ">=8"
       }
     },
+    "node_modules/@appium/docutils/node_modules/type-fest": {
+      "version": "4.26.1",
+      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.26.1.tgz",
+      "integrity": "sha512-yOGpmOAL7CkKe/91I5O3gPICmJNLJ1G4zFYVAsRHg7M64biSnPtRj0WNQt++bRkjYOqjWXrhnUw1utzmVErAdg==",
+      "license": "(MIT OR CC0-1.0)",
+      "engines": {
+        "node": ">=16"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
     "node_modules/@appium/logger": {
       "version": "1.6.1",
       "resolved": "https://registry.npmjs.org/@appium/logger/-/logger-1.6.1.tgz",
@@ -265,6 +289,18 @@
         "sharp": "0.33.5"
       }
     },
+    "node_modules/@appium/support/node_modules/type-fest": {
+      "version": "4.26.1",
+      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.26.1.tgz",
+      "integrity": "sha512-yOGpmOAL7CkKe/91I5O3gPICmJNLJ1G4zFYVAsRHg7M64biSnPtRj0WNQt++bRkjYOqjWXrhnUw1utzmVErAdg==",
+      "license": "(MIT OR CC0-1.0)",
+      "engines": {
+        "node": ">=16"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
     "node_modules/@appium/tsconfig": {
       "version": "0.3.3",
       "resolved": "https://registry.npmjs.org/@appium/tsconfig/-/tsconfig-0.3.3.tgz",
@@ -296,6 +332,18 @@
         "npm": ">=8"
       }
     },
+    "node_modules/@appium/types/node_modules/type-fest": {
+      "version": "4.26.1",
+      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.26.1.tgz",
+      "integrity": "sha512-yOGpmOAL7CkKe/91I5O3gPICmJNLJ1G4zFYVAsRHg7M64biSnPtRj0WNQt++bRkjYOqjWXrhnUw1utzmVErAdg==",
+      "license": "(MIT OR CC0-1.0)",
+      "engines": {
+        "node": ">=16"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
     "node_modules/@babel/code-frame": {
       "version": "7.26.2",
       "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.26.2.tgz",
@@ -3833,9 +3881,9 @@
       }
     },
     "node_modules/streamx": {
-      "version": "2.20.1",
-      "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.20.1.tgz",
-      "integrity": "sha512-uTa0mU6WUC65iUvzKH4X9hEdvSW7rbPxPtwfWiLMSj3qTdQbAiUboZTxauKfpFuGIGa1C2BYijZ7wgdUXICJhA==",
+      "version": "2.20.2",
+      "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.20.2.tgz",
+      "integrity": "sha512-aDGDLU+j9tJcUdPGOaHmVF1u/hhI+CsGkT02V3OKlHDV7IukOI+nTWAGkiZEKCO35rWN1wIr4tS7YFr1f4qSvA==",
       "license": "MIT",
       "dependencies": {
         "fast-fifo": "^1.3.2",
@@ -4041,18 +4089,6 @@
       "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==",
       "license": "0BSD"
     },
-    "node_modules/type-fest": {
-      "version": "4.26.1",
-      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.26.1.tgz",
-      "integrity": "sha512-yOGpmOAL7CkKe/91I5O3gPICmJNLJ1G4zFYVAsRHg7M64biSnPtRj0WNQt++bRkjYOqjWXrhnUw1utzmVErAdg==",
-      "license": "(MIT OR CC0-1.0)",
-      "engines": {
-        "node": ">=16"
-      },
-      "funding": {
-        "url": "https://github.com/sponsors/sindresorhus"
-      }
-    },
     "node_modules/type-is": {
       "version": "1.6.18",
       "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz",

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "7.31.0",
+  "version": "7.32.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {