appium-ios-remotexpc 0.11.0 → 0.13.0

package/src/lib/apple-tv/storage/pairing-storage.ts

@@ -0,0 +1,60 @@
+import { strongbox } from '@appium/strongbox';
+import { logger } from '@appium/support';
+
+import { STRONGBOX_CONTAINER_NAME } from '../../../constants.js';
+import { createXmlPlist } from '../../plist/index.js';
+import { PairingError } from '../errors.js';
+import type { PairingConfig } from '../types.js';
+import type { PairingStorageInterface } from './types.js';
+
+/** Manages persistent storage of pairing credentials as plist files */
+export class PairingStorage implements PairingStorageInterface {
+  private readonly log = logger.getLogger('PairingStorage');
+  private readonly box;
+
+  constructor(private readonly config: PairingConfig) {
+    this.box = strongbox(STRONGBOX_CONTAINER_NAME);
+  }
+
+  async save(
+    deviceId: string,
+    ltpk: Buffer,
+    ltsk: Buffer,
+    remoteUnlockHostKey = '',
+  ): Promise<string> {
+    try {
+      const itemName = `appletv_pairing_${deviceId}`;
+      const plistContent = this.createPlistContent(
+        ltpk,
+        ltsk,
+        remoteUnlockHostKey,
+      );
+
+      const item = await this.box.createItemWithValue(itemName, plistContent);
+      const itemPath = item.id;
+
+      this.log.info(`Pairing record saved to: ${itemPath}`);
+
+      return itemPath;
+    } catch (error) {
+      this.log.error('Save pairing record error:', error);
+      throw new PairingError(
+        'Failed to save pairing record',
+        'SAVE_ERROR',
+        error,
+      );
+    }
+  }
+
+  private createPlistContent(
+    publicKey: Buffer,
+    privateKey: Buffer,
+    remoteUnlockHostKey: string,
+  ): string {
+    return createXmlPlist({
+      private_key: privateKey,
+      public_key: publicKey,
+      remote_unlock_host_key: remoteUnlockHostKey,
+    });
+  }
+}

package/src/lib/apple-tv/storage/types.ts

@@ -0,0 +1,9 @@
+/** Interface for storing pairing credentials to disk */
+export interface PairingStorageInterface {
+  save(
+    deviceId: string,
+    ltpk: Buffer,
+    ltsk: Buffer,
+    remoteUnlockHostKey?: string,
+  ): Promise<string>;
+}

package/src/lib/apple-tv/types.ts

@@ -28,7 +28,6 @@ export interface PairingConfig {
   timeout: number;
   discoveryTimeout: number;
   maxRetries: number;
-  pairingDirectory: string;
 }
 
 // Represents a TLV8 data item with a type and binary data

package/src/lib/bonjour/bonjour-discovery.ts

@@ -1,10 +1,10 @@
-import { logger } from '@appium/support';
 import { type ChildProcess, spawn } from 'node:child_process';
 import { lookup } from 'node:dns/promises';
 import { EventEmitter } from 'node:events';
 import { clearTimeout, setTimeout } from 'node:timers';
 import { setTimeout as delay } from 'node:timers/promises';
 
+import { getLogger } from '../logger.js';
 import {
   BONJOUR_DEFAULT_DOMAIN,
   BONJOUR_SERVICE_TYPES,
@@ -14,7 +14,7 @@ import {
   DNS_SD_PATTERNS,
 } from './constants.js';
 
-const log = logger.getLogger('BonjourDiscovery');
+const log = getLogger('BonjourDiscovery');
 
 const DNS_SD_COMMAND = 'dns-sd';
 
@@ -522,6 +522,8 @@ export class BonjourDiscovery extends EventEmitter {
       return devices;
     } finally {
       this.stopBrowsing();
+      // Small delay to ensure cleanup logs are flushed before returning
+      await delay(100);
     }
   }
 

package/src/lib/lockdown/index.ts

@@ -1,14 +1,14 @@
-import { logger } from '@appium/support';
 import { Socket } from 'node:net';
 import tls, { type ConnectionOptions, TLSSocket } from 'tls';
 
 import { BasePlistService } from '../../base-plist-service.js';
+import { getLogger } from '../logger.js';
 import { type PairRecord } from '../pair-record/index.js';
 import { PlistService } from '../plist/plist-service.js';
 import type { PlistMessage, PlistValue } from '../types.js';
 import { RelayService, createUsbmux } from '../usbmux/index.js';
 
-const log = logger.getLogger('Lockdown');
+const log = getLogger('Lockdown');
 
 // Constants
 const LABEL = 'appium-internal';
@@ -86,7 +86,7 @@ class DeviceNotFoundError extends Error {
 
 // TLS Manager for handling TLS operations
 class TLSManager {
-  private readonly log = logger.getLogger('TLSManager');
+  private readonly log = getLogger('TLSManager');
 
   /**
    * Upgrades a socket to TLS
@@ -127,7 +127,7 @@ class TLSManager {
 
 // Device Manager for handling device operations
 class DeviceManager {
-  private readonly log = logger.getLogger('DeviceManager');
+  private readonly log = getLogger('DeviceManager');
 
   /**
    * Lists all connected devices

package/src/lib/logger.ts

@@ -0,0 +1,9 @@
+import { logger } from '@appium/support';
+
+const LOG_LEVEL = (process.env.APPIUM_IOS_REMOTEXPC_LOG_LEVEL || 'info') as any;
+
+export function getLogger(name: string) {
+  const log = logger.getLogger(name);
+  log.level = LOG_LEVEL;
+  return log;
+}

package/src/lib/pair-record/pair-record.ts

@@ -1,8 +1,9 @@
-import { logger } from '@appium/support';
 import fs from 'fs';
 import path from 'path';
 
-const log = logger.getLogger('PairRecord');
+import { getLogger } from '../logger.js';
+
+const log = getLogger('PairRecord');
 
 /**
  * Interface defining the structure of a pair record.

package/src/lib/plist/binary-plist-parser.ts

@@ -4,8 +4,7 @@
  * This module provides functionality to parse binary property lists (bplists)
  * commonly used in Apple's iOS and macOS systems.
  */
-import { logger } from '@appium/support';
-
+import { getLogger } from '../logger.js';
 import type { PlistArray, PlistDictionary, PlistValue } from '../types.js';
 import {
   APPLE_EPOCH_OFFSET,
@@ -14,7 +13,7 @@ import {
   BPLIST_TYPE,
 } from './constants.js';
 
-const log = logger.getLogger('Plist');
+const log = getLogger('Plist');
 
 /**
  * Represents a temporary object during binary plist parsing

package/src/lib/plist/length-based-splitter.ts

@@ -1,6 +1,6 @@
-import { logger } from '@appium/support';
 import { Transform, type TransformCallback } from 'stream';
 
+import { getLogger } from '../logger.js';
 import {
   BINARY_PLIST_HEADER_LENGTH,
   BINARY_PLIST_MAGIC,
@@ -16,7 +16,7 @@ import {
 } from './constants.js';
 import { isXmlPlistContent } from './utils.js';
 
-const log = logger.getLogger('Plist');
+const log = getLogger('Plist');
 
 // Constants
 const DEFAULT_MAX_FRAME_LENGTH = 100 * 1024 * 1024; // 100MB default for large IORegistry responses

package/src/lib/plist/plist-decoder.ts

@@ -1,6 +1,6 @@
-import { logger } from '@appium/support';
 import { Transform, type TransformCallback } from 'stream';
 
+import { getLogger } from '../logger.js';
 import { UTF8_ENCODING } from './constants.js';
 import { parsePlist } from './unified-plist-parser.js';
 import {
@@ -10,7 +10,7 @@ import {
   hasUnicodeReplacementCharacter,
 } from './utils.js';
 
-const log = logger.getLogger('Plist');
+const log = getLogger('Plist');
 
 /**
  * Decodes plist format data with length prefix to JavaScript objects

package/src/lib/plist/plist-parser.ts

@@ -1,6 +1,6 @@
-import { logger } from '@appium/support';
 import { DOMParser, Element, Node } from '@xmldom/xmldom';
 
+import { getLogger } from '../logger.js';
 import type { PlistArray, PlistDictionary, PlistValue } from '../types.js';
 import { PlistService } from './plist-service.js';
 import {
@@ -14,7 +14,7 @@ import {
   trimBeforeXmlDeclaration,
 } from './utils.js';
 
-const errorLog = logger.getLogger('PlistError');
+const errorLog = getLogger('PlistError');
 
 /**
  * Parses an XML plist string into a JavaScript object

package/src/lib/plist/plist-service.ts

@@ -1,14 +1,14 @@
-import { logger } from '@appium/support';
 import { Socket } from 'net';
 import { TLSSocket } from 'tls';
 
+import { getLogger } from '../logger.js';
 import type { PlistDictionary } from '../types.js';
 import { LengthBasedSplitter } from './length-based-splitter.js';
 import { PlistServiceDecoder } from './plist-decoder.js';
 import { PlistServiceEncoder } from './plist-encoder.js';
 
-const log = logger.getLogger('Plist');
-const errorLog = logger.getLogger('PlistError');
+const log = getLogger('Plist');
+const errorLog = getLogger('PlistError');
 
 const config = {
   verboseErrorLogging: false,

package/src/lib/remote-xpc/remote-xpc-connection.ts

@@ -1,9 +1,9 @@
-import { logger } from '@appium/support';
 import net from 'node:net';
 
+import { getLogger } from '../logger.js';
 import Handshake from './handshake.js';
 
-const log = logger.getLogger('RemoteXpcConnection');
+const log = getLogger('RemoteXpcConnection');
 
 // Timeout constants
 const CONNECTION_TIMEOUT_MS = 30000; // 30 seconds

package/src/lib/tss/index.ts

@@ -1,11 +1,11 @@
-import { logger } from '@appium/support';
 import axios from 'axios';
 import { randomUUID } from 'node:crypto';
 
+import { getLogger } from '../logger.js';
 import { createPlist, parsePlist } from '../plist/index.js';
 import type { PlistDictionary } from '../types.js';
 
-const log = logger.getLogger('TSSRequestor');
+const log = getLogger('TSSRequestor');
 
 // TSS Constants
 const TSS_CONTROLLER_ACTION_URL = 'http://gs.apple.com/TSS/controller?action=2';

package/src/lib/tunnel/index.ts

@@ -1,13 +1,13 @@
-import { logger } from '@appium/support';
 import {
   type TunnelConnection,
   connectToTunnelLockdown,
 } from 'appium-ios-tuntap';
 import type { TLSSocket } from 'tls';
 
+import { getLogger } from '../logger.js';
 import { RemoteXpcConnection } from '../remote-xpc/remote-xpc-connection.js';
 
-const log = logger.getLogger('TunnelManager');
+const log = getLogger('TunnelManager');
 
 /**
  * Interface for tunnel registry entry

package/src/lib/tunnel/packet-stream-client.ts

@@ -1,9 +1,10 @@
-import { logger } from '@appium/support';
 import type { PacketConsumer, PacketData } from 'appium-ios-tuntap';
 import { EventEmitter } from 'events';
 import { type Socket, createConnection } from 'net';
 
-const log = logger.getLogger('PacketStreamClient');
+import { getLogger } from '../logger.js';
+
+const log = getLogger('PacketStreamClient');
 
 /**
  * Constants for packet stream protocol

package/src/lib/tunnel/packet-stream-server.ts

@@ -1,9 +1,10 @@
-import { logger } from '@appium/support';
 import type { PacketConsumer, PacketData } from 'appium-ios-tuntap';
 import { EventEmitter } from 'events';
 import { type Server, type Socket, createServer } from 'net';
 
-const log = logger.getLogger('PacketStreamServer');
+import { getLogger } from '../logger.js';
+
+const log = getLogger('PacketStreamServer');
 
 /**
  * Interface for serialized packet message

package/src/lib/tunnel/tunnel-api-client.ts

@@ -1,8 +1,7 @@
-import { logger } from '@appium/support';
-
+import { getLogger } from '../logger.js';
 import type { TunnelRegistry, TunnelRegistryEntry } from '../types.js';
 
-const log = logger.getLogger('TunnelApiClient');
+const log = getLogger('TunnelApiClient');
 
 /**
  * API client for tunnel registry operations

package/src/lib/tunnel/tunnel-registry-server.ts

@@ -1,7 +1,7 @@
-import { logger } from '@appium/support';
 import * as http from 'node:http';
 import { URL } from 'node:url';
 
+import { getLogger } from '../logger.js';
 import type { TunnelRegistry, TunnelRegistryEntry } from '../types.js';
 
 // Constants
@@ -9,7 +9,7 @@ const DEFAULT_TUNNEL_REGISTRY_PORT = 42314;
 const API_BASE_PATH = '/remotexpc/tunnels';
 
 // Logger instance
-const log = logger.getLogger('TunnelRegistryServer');
+const log = getLogger('TunnelRegistryServer');
 
 // Helper functions
 /**

package/src/lib/usbmux/index.ts

@@ -1,8 +1,8 @@
-import { logger } from '@appium/support';
 import { Server, Socket, createConnection, createServer } from 'node:net';
 import { release } from 'node:os';
 
 import { BaseSocketService } from '../../base-socket-service.js';
+import { getLogger } from '../logger.js';
 import { type PairRecord, processPlistResponse } from '../pair-record/index.js';
 import { type RawPairRecordResponse } from '../pair-record/pair-record.js';
 import { LengthBasedSplitter, parsePlist } from '../plist/index.js';
@@ -32,7 +32,7 @@ export interface Device {
   Properties: DeviceProperties;
 }
 
-const log = logger.getLogger('Usbmux');
+const log = getLogger('Usbmux');
 
 export const USBMUXD_PORT = 27015;
 export const DEFAULT_USBMUXD_SOCKET = '/var/run/usbmuxd';

package/src/services/ios/afc/index.ts

@@ -1,10 +1,10 @@
-import { logger } from '@appium/support';
 import fs from 'node:fs';
 import net from 'node:net';
 import path from 'node:path';
 import { Readable, Writable } from 'node:stream';
 import { pipeline } from 'node:stream/promises';
 
+import { getLogger } from '../../../lib/logger.js';
 import {
   buildClosePayload,
   buildFopenPayload,
@@ -25,7 +25,7 @@ import { AFC_FOPEN_TEXTUAL_MODES, AFC_WRITE_THIS_LENGTH } from './constants.js';
 import { AfcError, AfcFileMode, AfcOpcode } from './enums.js';
 import { createAfcReadStream, createAfcWriteStream } from './stream-utils.js';
 
-const log = logger.getLogger('AfcService');
+const log = getLogger('AfcService');
 
 const NON_LISTABLE_ENTRIES = ['', '.', '..'];
 

package/src/services/ios/base-service.ts

@@ -1,8 +1,7 @@
-import { logger } from '@appium/support';
-
+import { getLogger } from '../../lib/logger.js';
 import { ServiceConnection } from '../../service-connection.js';
 
-const log = logger.getLogger('BaseService');
+const log = getLogger('BaseService');
 
 /**
  * Interface for service information

package/src/services/ios/diagnostic-service/index.ts

@@ -1,5 +1,4 @@
-import { logger } from '@appium/support';
-
+import { getLogger } from '../../../lib/logger.js';
 import { PlistServiceDecoder } from '../../../lib/plist/plist-decoder.js';
 import type {
   DiagnosticsService as DiagnosticsServiceInterface,
@@ -7,7 +6,7 @@ import type {
 } from '../../../lib/types.js';
 import { BaseService } from '../base-service.js';
 
-const log = logger.getLogger('DiagnosticService');
+const log = getLogger('DiagnosticService');
 
 /**
  * DiagnosticsService provides an API to:

package/src/services/ios/mobile-config/index.ts

@@ -1,6 +1,7 @@
-import { fs, logger } from '@appium/support';
+import { fs } from '@appium/support';
 import path from 'node:path';
 
+import { getLogger } from '../../../lib/logger.js';
 import { SUPPORTED_EXTENSIONS } from '../../../lib/plist/constants.js';
 import { createPlist, parsePlist } from '../../../lib/plist/index.js';
 import {
@@ -11,7 +12,7 @@ import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService } from '../base-service.js';
 
 const ERROR_CLOUD_CONFIGURATION_ALREADY_PRESENT = 14002;
-const log = logger.getLogger('MobileConfigService');
+const log = getLogger('MobileConfigService');
 
 /**
  * MobileConfigService provides an API to:

package/src/services/ios/mobile-image-mounter/index.ts

@@ -1,9 +1,9 @@
-import { logger } from '@appium/support';
 import { createHash } from 'crypto';
 import { Stats, promises as fs } from 'fs';
 import { performance } from 'perf_hooks';
 import { Readable } from 'stream';
 
+import { getLogger } from '../../../lib/logger.js';
 import { parseXmlPlist } from '../../../lib/plist/index.js';
 import { getManifestFromTSS } from '../../../lib/tss/index.js';
 import type {
@@ -13,7 +13,7 @@ import type {
 import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService } from '../base-service.js';
 
-const log = logger.getLogger('MobileImageMounterService');
+const log = getLogger('MobileImageMounterService');
 
 /**
  * Base interface for service responses

package/src/services/ios/notification-proxy/index.ts

@@ -1,5 +1,4 @@
-import { logger } from '@appium/support';
-
+import { getLogger } from '../../../lib/logger.js';
 import type {
   NotificationProxyService as NotificationProxyServiceInterface,
   PlistDictionary,
@@ -8,7 +7,7 @@ import type {
 import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService } from '../base-service.js';
 
-const log = logger.getLogger('NotificationProxyService');
+const log = getLogger('NotificationProxyService');
 
 export interface ObserveNotificationRequest extends PlistDictionary {
   Command: 'ObserveNotification';

package/src/services/ios/power-assertion/index.ts

@@ -1,5 +1,4 @@
-import { logger } from '@appium/support';
-
+import { getLogger } from '../../../lib/logger.js';
 import type {
   PlistDictionary,
   PowerAssertionService as PowerAssertionServiceInterface,
@@ -7,7 +6,7 @@ import type {
 import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService } from '../base-service.js';
 
-const log = logger.getLogger('PowerAssertionService');
+const log = getLogger('PowerAssertionService');
 
 /**
  * Power assertion types that can be used to prevent system sleep

package/src/services/ios/syslog-service/index.ts

@@ -1,7 +1,7 @@
-import { logger } from '@appium/support';
 import type { PacketConsumer, PacketData } from 'appium-ios-tuntap';
 import { EventEmitter } from 'events';
 
+import { getLogger } from '../../../lib/logger.js';
 import { isBinaryPlist } from '../../../lib/plist/binary-plist-parser.js';
 import { parsePlist } from '../../../lib/plist/unified-plist-parser.js';
 import type {
@@ -12,8 +12,8 @@ import type {
 import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService, type Service } from '../base-service.js';
 
-const syslogLog = logger.getLogger('SyslogMessages');
-const log = logger.getLogger('Syslog');
+const syslogLog = getLogger('SyslogMessages');
+const log = getLogger('Syslog');
 
 const MIN_PRINTABLE_RATIO = 0.5;
 const ASCII_PRINTABLE_MIN = 32;

package/src/services/ios/tunnel-service/index.ts

@@ -1,14 +1,14 @@
-import { logger } from '@appium/support';
 import { TLSSocket } from 'tls';
 
 import {
   LockdownService,
   upgradeSocketToTLS,
 } from '../../../lib/lockdown/index.js';
+import { getLogger } from '../../../lib/logger.js';
 import { PlistService } from '../../../lib/plist/plist-service.js';
 import { createUsbmux } from '../../../lib/usbmux/index.js';
 
-const log = logger.getLogger('TunnelService');
+const log = getLogger('TunnelService');
 const LABEL = 'appium-internal';
 
 /**

package/src/services/ios/webinspector/index.ts

@@ -1,12 +1,12 @@
-import { logger } from '@appium/support';
 import { randomUUID } from 'crypto';
 import { EventEmitter } from 'events';
 
+import { getLogger } from '../../../lib/logger.js';
 import type { PlistDictionary, PlistMessage } from '../../../lib/types.js';
 import { ServiceConnection } from '../../../service-connection.js';
 import { BaseService } from '../base-service.js';
 
-const log = logger.getLogger('WebInspectorService');
+const log = getLogger('WebInspectorService');
 
 /**
  * Interface for WebInspector message structure