appium-xcuitest-driver/lib/device/log/ios-log.ts

Appium driver for iOS using XCUITest for backend

import {EventEmitter} from 'node:events';
import {LRUCache} from 'lru-cache';
import type {LogEntry} from '../../commands/types';
import type {AppiumLogger} from '@appium/types';
import {logger} from 'appium/support';

// We keep only the most recent log entries to avoid out of memory error
const MAX_LOG_ENTRIES_COUNT = 10000;

export interface IOSLogOptions {
  maxBufferSize?: number;
  log?: AppiumLogger;
}

export abstract class IOSLog<TRawEntry, TSerializedEntry extends object> extends EventEmitter {
  private maxBufferSize: number;
  private logs: LRUCache<number, TSerializedEntry>;
  private _log: AppiumLogger;

  constructor(opts: IOSLogOptions = {}) {
    super();
    this.maxBufferSize = opts.maxBufferSize ?? MAX_LOG_ENTRIES_COUNT;
    this.logs = new LRUCache({
      max: this.maxBufferSize,
    });
    this._log = opts.log ?? logger.getLogger(this.constructor.name);
  }

  get log(): AppiumLogger {
    return this._log;
  }

  abstract get isCapturing(): boolean;

  async getLogs(): Promise<LogEntry[]> {
    const result: LogEntry[] = [];
    for (const value of this.logs.rvalues()) {
      result.push(this._deserializeEntry(value as TSerializedEntry));
    }
    this._clearEntries();
    return result;
  }

  protected _clearEntries() {
    this.logs.clear();
  }

  protected broadcast(entry: TRawEntry): void {
    const firstKey = this.logs.keys().next().value;
    const recentIndex = typeof firstKey === 'number' ? firstKey : -1;
    const serializedEntry = this._serializeEntry(entry);
    this.logs.set(recentIndex + 1, serializedEntry);
    if (this.listenerCount('output')) {
      this.emit('output', this._deserializeEntry(serializedEntry));
    }
  }

  abstract startCapture(): Promise<void>;
  abstract stopCapture(): Promise<void>;

  protected abstract _serializeEntry(value: TRawEntry): TSerializedEntry;
  protected abstract _deserializeEntry(value: TSerializedEntry): LogEntry;
}

export default IOSLog;