appium-xcuitest-driver 7.25.0 → 7.26.1

package/lib/commands/log.js

@@ -4,11 +4,12 @@ import {DEFAULT_WS_PATHNAME_PREFIX} from 'appium/driver';
 import {IOSCrashLog} from '../device-log/ios-crash-log';
 import {IOSSimulatorLog} from '../device-log/ios-simulator-log';
 import {IOSDeviceLog} from '../device-log/ios-device-log';
-import log from '../logger';
 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 { util } from 'appium/support';
 
 /**
  * Determines the websocket endpoint based on the `sessionId`
@@ -20,6 +21,18 @@ const WEBSOCKET_ENDPOINT = (sessionId) =>
 
 const GET_SERVER_LOGS_FEATURE = 'get_server_logs';
 
+/**
+ *
+ * @param {Object} x
+ * @returns {import('./types').LogEntry}
+ */
+function nativeLogEntryToSeleniumEntry (x) {
+  return toLogEntry(
+    _.isEmpty(x.prefix) ? x.message : `[${x.prefix}] ${x.message}`,
+    /** @type {any} */ (x).timestamp ?? Date.now()
+  );
+}
+
 /**
  * @type {import('@appium/types').LogDefRecord}
  * @privateRemarks The return types for these getters should be specified
@@ -52,10 +65,7 @@ const SUPPORTED_LOG_TYPES = {
      */
     getter: (self) => {
       self.assertFeatureEnabled(GET_SERVER_LOGS_FEATURE);
-      return log.unwrap().record.map((x) => toLogEntry(
-        _.isEmpty(x.prefix) ? x.message : `[${x.prefix}] ${x.message}`,
-        /** @type {any} */ (x).timestamp ?? Date.now()
-      ));
+      return self.log.unwrap().record.map(nativeLogEntryToSeleniumEntry);
     },
   },
 };
@@ -97,44 +107,107 @@ 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: util.uuidV4(),
+          },
+          text: finalEntry.message,
+          timestamp: finalEntry.timestamp,
+        },
+      });
+    };
+    logEmitter.on(srcEventName, listener);
+    return [logEmitter, listener];
+  },
+
   /**
    * @this {XCUITestDriver}
    */
   async startLogCapture() {
     this.logs = this.logs || {};
     if (!_.isUndefined(this.logs.syslog) && this.logs.syslog.isCapturing) {
-      log.warn('Trying to start iOS log capture but it has already started!');
+      this.log.warn('Trying to start iOS log capture but it has already started!');
       return true;
     }
+
     if (_.isUndefined(this.logs.syslog)) {
-      this.logs.crashlog = new IOSCrashLog({
-        sim: /** @type {import('appium-ios-simulator').Simulator} */ (this.device),
-        udid: this.isRealDevice() ? this.opts.udid : undefined,
-        log: this.log,
-      });
-      this.logs.syslog = this.isRealDevice()
-        ? new IOSDeviceLog({
-          udid: this.opts.udid,
-          showLogs: this.opts.showIOSLog,
-          log: this.log,
-        })
-        : new IOSSimulatorLog({
+      [this.logs.crashlog,] = this.assignBiDiLogListener(
+        new IOSCrashLog({
           sim: /** @type {import('appium-ios-simulator').Simulator} */ (this.device),
-          showLogs: this.opts.showIOSLog,
-          iosSimulatorLogsPredicate: this.opts.iosSimulatorLogsPredicate,
+          udid: this.isRealDevice() ? this.opts.udid : undefined,
           log: this.log,
-        });
+        }), {
+          type: 'crashlog',
+        }
+      );
+      [this.logs.syslog,] = this.assignBiDiLogListener(
+        this.isRealDevice()
+          ? new IOSDeviceLog({
+            udid: this.opts.udid,
+            showLogs: this.opts.showIOSLog,
+            log: this.log,
+          })
+          : new IOSSimulatorLog({
+            sim: /** @type {import('appium-ios-simulator').Simulator} */ (this.device),
+            showLogs: this.opts.showIOSLog,
+            iosSimulatorLogsPredicate: this.opts.iosSimulatorLogsPredicate,
+            log: this.log,
+          }),
+        {
+          type: 'syslog',
+        }
+      );
       if (_.isBoolean(this.opts.showSafariConsoleLog)) {
-        this.logs.safariConsole = new SafariConsoleLog({
-          showLogs: this.opts.showSafariConsoleLog,
-          log: this.log,
-        });
+        [this.logs.safariConsole,] = this.assignBiDiLogListener(
+          new SafariConsoleLog({
+            showLogs: this.opts.showSafariConsoleLog,
+            log: this.log,
+          }), {
+            type: 'safariConsole',
+          }
+        );
       }
       if (_.isBoolean(this.opts.showSafariNetworkLog)) {
-        this.logs.safariNetwork = new SafariNetworkLog({
-          showLogs: this.opts.showSafariNetworkLog,
-          log: this.log,
-        });
+        [this.logs.safariNetwork,] = this.assignBiDiLogListener(
+          new SafariNetworkLog({
+            showLogs: this.opts.showSafariNetworkLog,
+            log: this.log,
+          }), {
+            type: 'safariNetwork',
+          }
+        );
+      }
+      if (this.isFeatureEnabled(GET_SERVER_LOGS_FEATURE)) {
+        [, this._bidiServerLogListener] = this.assignBiDiLogListener(
+          this.log.unwrap(), {
+            type: 'server',
+            srcEventName: 'log',
+            entryTransformer: nativeLogEntryToSeleniumEntry,
+          }
+        );
       }
     }
 
@@ -143,15 +216,15 @@ export default {
     const promises = [
       (async () => {
         try {
-          await this.logs.syslog.startCapture();
+          await this.logs.syslog?.startCapture();
           didStartSyslog = true;
           this.eventEmitter.emit('syslogStarted', this.logs.syslog);
         } catch (err) {
-          log.debug(err.stack);
-          log.warn(`Continuing without capturing device logs: ${err.message}`);
+          this.log.debug(err.stack);
+          this.log.warn(`Continuing without capturing device logs: ${err.message}`);
         }
       })(),
-      this.logs.crashlog.startCapture(),
+      this.logs.crashlog?.startCapture() ?? B.resolve(),
     ];
     await B.all(promises);
 
@@ -179,13 +252,13 @@ export default {
         ).getWebSocketHandlers(pathname),
       )
     ) {
-      log.debug(
+      this.log.debug(
         `The system logs broadcasting web socket server is already listening at ${pathname}`,
       );
       return;
     }
 
-    log.info(`Assigning system logs broadcasting web socket server to ${pathname}`);
+    this.log.info(`Assigning system logs broadcasting web socket server to ${pathname}`);
     // https://github.com/websockets/ws/blob/master/doc/ws.md
     const wss = new WebSocket.Server({
       noServer: true,
@@ -195,9 +268,9 @@ export default {
         const remoteIp = _.isEmpty(req.headers['x-forwarded-for'])
           ? req.connection?.remoteAddress
           : req.headers['x-forwarded-for'];
-        log.debug(`Established a new system logs listener web socket connection from ${remoteIp}`);
+        this.log.debug(`Established a new system logs listener web socket connection from ${remoteIp}`);
       } else {
-        log.debug('Established a new system logs listener web socket connection');
+        this.log.debug('Established a new system logs listener web socket connection');
       }
 
       if (_.isEmpty(this._syslogWebsocketListener)) {
@@ -207,11 +280,11 @@ export default {
           }
         };
       }
-      this.logs.syslog.on('output', this._syslogWebsocketListener);
+      this.logs.syslog?.on('output', this._syslogWebsocketListener);
 
       ws.on('close', (code, reason) => {
         if (!_.isEmpty(this._syslogWebsocketListener)) {
-          this.logs.syslog.removeListener('output', this._syslogWebsocketListener);
+          this.logs.syslog?.removeListener('output', this._syslogWebsocketListener);
           this._syslogWebsocketListener = null;
         }
 
@@ -222,7 +295,7 @@ export default {
         if (!_.isEmpty(reason)) {
           closeMsg += ` Reason: ${reason.toString()}.`;
         }
-        log.debug(closeMsg);
+        this.log.debug(closeMsg);
       });
     });
     await /** @type {AppiumServer} */ (this.server).addWebSocketHandler(
@@ -243,7 +316,7 @@ export default {
       return;
     }
 
-    log.debug('Stopping the system logs broadcasting web socket server');
+    this.log.debug('Stopping the system logs broadcasting web socket server');
     await /** @type {AppiumServer} */ (this.server).removeWebSocketHandler(pathname);
   },
 };
@@ -259,3 +332,11 @@ export default {
 /**
  * @typedef {import('@appium/types').AppiumServer} AppiumServer
  */
+
+/**
+ * @typedef {Object} BiDiListenerProperties
+ * @property {string} type
+ * @property {string} [srcEventName='output']
+ * @property {string} [context=NATIVE_WIN]
+ * @property {(x: Object) => import('./types').LogEntry} [entryTransformer]
+ */

package/lib/commands/types.ts

@@ -572,3 +572,5 @@ export interface LogEntry {
   level: string,
   message: string;
 }
+
+export type LogListener = (logEntry: LogEntry) => any;

package/lib/driver.js

@@ -266,6 +266,12 @@ export class XCUITestDriver extends BaseDriver {
   /** @type {import('appium-remote-debugger').RemoteDebugger|null} */
   remote;
 
+  /** @type {DriverLogs} */
+  logs;
+
+  /** @type {import('./commands/types').LogListener|undefined} */
+  _bidiServerLogListener;
+
   /**
    *
    * @param {XCUITestDriverOpts} opts
@@ -315,6 +321,7 @@ export class XCUITestDriver extends BaseDriver {
     this._audioRecorder = null;
     this.appInfosCache = new AppInfosCache(this.log);
     this.remote = null;
+    this.doesSupportBidi = true;
   }
 
   async onSettingsUpdate(key, value) {
@@ -977,10 +984,12 @@ export class XCUITestDriver extends BaseDriver {
       }
     }
 
-    if (!_.isEmpty(this.logs)) {
-      await this.logs.syslog.stopCapture();
-      this.logs = {};
+    await this.logs.syslog?.stopCapture();
+    _.values(this.logs).forEach((x) => x.removeAllListeners());
+    if (this._bidiServerLogListener) {
+      this.log.unwrap().off('log', this._bidiServerLogListener);
     }
+    this.logs = {};
 
     if (this.mjpegStream) {
       this.log.info('Closing MJPEG stream');
@@ -2008,6 +2017,7 @@ 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;
 
@@ -2181,3 +2191,12 @@ export default XCUITestDriver;
  * @typedef {import('appium-xcode').XcodeVersion} XcodeVersion
  * @typedef {import('appium-ios-simulator').Simulator} Simulator
  */
+
+/**
+ * @typedef {Object} DriverLogs
+ * @property {import('./device-log/ios-device-log').IOSDeviceLog|import('./device-log/ios-simulator-log').IOSSimulatorLog} [syslog]
+ * @property {import('./device-log/ios-crash-log').IOSCrashLog} [crashlog]
+ * @property {import('./device-log/safari-console-log').SafariConsoleLog} [safariConsole]
+ * @property {import('./device-log/safari-network-log').SafariNetworkLog} [safariNetwork]
+ * @property {import('./device-log/ios-performance-log').IOSPerformanceLog} [performance]
+ */

package/lib/real-device.js

@@ -314,18 +314,11 @@ export class RealDevice {
    * @param {import('./driver').XCUITestDriverOpts} opts
    * @returns {Promise<void>}
    */
-  async reset({bundleId, fullReset, platformVersion}) {
-    if (!bundleId) {
-      return;
-    }
-
-    if (bundleId === SAFARI_BUNDLE_ID) {
-      this.log.debug('Reset requested. About to terminate Safari');
-      await this.terminateApp(bundleId, String(platformVersion));
-      return;
-    }
-
-    if (!fullReset) {
+  async reset({bundleId, fullReset}) {
+    if (!bundleId || !fullReset || bundleId === SAFARI_BUNDLE_ID) {
+      // Safari cannot be removed as system app.
+      // Safari process handling will be managed by WDA
+      // with noReset, forceAppLaunch or shouldTerminateApp capabilities.
       return;
     }
 

package/lib/utils.js

@@ -20,6 +20,8 @@ const XCTEST_LOG_FILES_PATTERNS = [
   /^StandardOutputAndStandardError\.txt$/i,
 ];
 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.25.0",
+  "version": "7.26.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "7.25.0",
+      "version": "7.26.1",
       "license": "Apache-2.0",
       "dependencies": {
         "@colors/colors": "^1.6.0",
@@ -870,9 +870,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "22.5.1",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.5.1.tgz",
-      "integrity": "sha512-KkHsxej0j9IW1KKOOAA/XBA0z08UFSrRQHErzEfA3Vgq57eXIMYboIlHJuYIfd+lwCQjtKqUu3UnmKbtUc9yRw==",
+      "version": "22.5.4",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.5.4.tgz",
+      "integrity": "sha512-FDuKUJQm/ju9fT/SeX/6+gBzoPzlVCzfzmGkwKvRHQVxi4BntVbyIwf6a4Xn62mrvndLiml6z/UBXIdEVjQLXg==",
       "license": "MIT",
       "dependencies": {
         "undici-types": "~6.19.2"
@@ -990,12 +990,12 @@
       }
     },
     "node_modules/@xmldom/xmldom": {
-      "version": "0.9.0",
-      "resolved": "https://registry.npmjs.org/@xmldom/xmldom/-/xmldom-0.9.0.tgz",
-      "integrity": "sha512-Zb9MTlKGnUdxglDKF75cJwvsNp+EhPwzguLSTp/u1yeDU59lz7eA9e14S9z/sn5HHKX5NEQZaKjePl/69uqGhw==",
+      "version": "0.9.2",
+      "resolved": "https://registry.npmjs.org/@xmldom/xmldom/-/xmldom-0.9.2.tgz",
+      "integrity": "sha512-afP3lpLtalPxgNGU4bxlsru4wSDsZwdSFKnHs6PR0q3KIEWWcAlBqAdx4aWlVtP1gV1FBWlJ3d0MgaRRdj/ucA==",
       "license": "MIT",
       "engines": {
-        "node": ">=10.0.0"
+        "node": ">=14.0.0"
       }
     },
     "node_modules/abort-controller": {
@@ -1265,9 +1265,9 @@
       "license": "MIT"
     },
     "node_modules/axios": {
-      "version": "1.7.6",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.6.tgz",
-      "integrity": "sha512-Ekur6XDwhnJ5RgOCaxFnXyqlPALI3rVeukZMwOdfghW7/wGz784BYKiQq+QD8NPcr91KRo30KfHOchyijwWw7g==",
+      "version": "1.7.7",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.7.tgz",
+      "integrity": "sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==",
       "license": "MIT",
       "dependencies": {
         "follow-redirects": "^1.15.6",
@@ -1768,13 +1768,13 @@
       "license": "MIT"
     },
     "node_modules/debug": {
-      "version": "4.3.6",
-      "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz",
-      "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==",
+      "version": "4.3.7",
+      "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz",
+      "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==",
       "devOptional": true,
       "license": "MIT",
       "dependencies": {
-        "ms": "2.1.2"
+        "ms": "^2.1.3"
       },
       "engines": {
         "node": ">=6.0"
@@ -2089,9 +2089,9 @@
       }
     },
     "node_modules/follow-redirects": {
-      "version": "1.15.6",
-      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz",
-      "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==",
+      "version": "1.15.9",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.9.tgz",
+      "integrity": "sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==",
       "funding": [
         {
           "type": "individual",
@@ -2984,9 +2984,9 @@
       }
     },
     "node_modules/ms": {
-      "version": "2.1.2",
-      "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
-      "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==",
+      "version": "2.1.3",
+      "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
+      "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
       "license": "MIT"
     },
     "node_modules/mv": {
@@ -3344,9 +3344,9 @@
       "license": "MIT"
     },
     "node_modules/picocolors": {
-      "version": "1.0.1",
-      "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.1.tgz",
-      "integrity": "sha512-anP1Z8qwhkbmu7MFP5iTt+wQKXgwzf7zTyGlcdzabySa9vd0Xt392U0rVmz9poOaBj0uHJKyyo9/upk0HrEQew==",
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.0.tgz",
+      "integrity": "sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==",
       "license": "ISC"
     },
     "node_modules/pkg-dir": {
@@ -3735,12 +3735,6 @@
         "node": ">=4"
       }
     },
-    "node_modules/send/node_modules/ms": {
-      "version": "2.1.3",
-      "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
-      "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
-      "license": "MIT"
-    },
     "node_modules/serve-favicon": {
       "version": "2.5.0",
       "resolved": "https://registry.npmjs.org/serve-favicon/-/serve-favicon-2.5.0.tgz",

package/package.json

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