feat: add configurable log levels via LOG_LEVEL env var (#92)

Author: harsha509

README.md

@@ -42,6 +42,34 @@ npm install appium-ios-remotexpc
 - **Pair Record Management**: Read and write device pairing records.
 - **Packet Streaming**: Stream packets between host and device for service communication.
 
+## Configuration
+
+### Environment Variables
+
+#### APPIUM_IOS_REMOTEXPC_LOG_LEVEL
+
+Controls the logging verbosity of the library.
+
+- **Default**: `info`
+- **Possible values**: Standard log levels supported by @appium/support logger
+  - `silly` - Most verbose, logs everything
+  - `verbose` - Very detailed logs
+  - `debug` - Detailed debugging information
+  - `info` - General informational messages (default)
+  - `warn` - Warning messages
+  - `error` - Error messages only
+- **Usage**:
+
+```bash
+# Set log level to debug for verbose output
+APPIUM_IOS_REMOTEXPC_LOG_LEVEL=debug npm test
+
+# Set log level to error for minimal output
+APPIUM_IOS_REMOTEXPC_LOG_LEVEL=error node your-script.js
+```
+
+This is particularly useful for debugging issues or reducing log noise in production environments.
+
 ## Architecture Flow
 
 The following diagram illustrates the high-level flow of how the tunnel is created:

src/lib/apple-tv/encryption/chacha20-poly1305.ts

@@ -1,9 +1,9 @@
-import { logger } from '@appium/support';
 import { createCipheriv, createDecipheriv } from 'node:crypto';
 
+import { getLogger } from '../../logger.js';
 import { CryptographyError } from '../errors.js';
 
-const log = logger.getLogger('ChaCha20Poly1305');
+const log = getLogger('ChaCha20Poly1305');
 
 export interface ChaCha20Poly1305Params {
   plaintext?: Buffer;

src/lib/apple-tv/encryption/ed25519.ts

@@ -1,14 +1,14 @@
-import { logger } from '@appium/support';
 import {
   type KeyPairKeyObjectResult,
   generateKeyPairSync,
   sign,
 } from 'node:crypto';
 
+import { getLogger } from '../../logger.js';
 import { CryptographyError } from '../errors.js';
 import type { PairingKeys } from '../types.js';
 
-const log = logger.getLogger('Ed25519');
+const log = getLogger('Ed25519');
 
 const ED25519_PUBLIC_KEY_LENGTH = 32;
 const ED25519_PRIVATE_KEY_LENGTH = 32;

src/lib/apple-tv/encryption/hkdf.ts

@@ -1,10 +1,10 @@
-import { logger } from '@appium/support';
 import { createHmac } from 'node:crypto';
 
+import { getLogger } from '../../logger.js';
 import { HKDF_HASH_ALGORITHM, HKDF_HASH_LENGTH } from '../constants.js';
 import { CryptographyError } from '../errors.js';
 
-const log = logger.getLogger('HKDF');
+const log = getLogger('HKDF');
 
 export interface HKDFParams {
   ikm: Buffer;

src/lib/apple-tv/srp/srp-client.ts

@@ -1,6 +1,6 @@
-import { logger } from '@appium/support';
 import { randomBytes } from 'node:crypto';
 
+import { getLogger } from '../../logger.js';
 import {
   SRP_GENERATOR,
   SRP_KEY_LENGTH_BYTES,
@@ -22,7 +22,7 @@ import {
   hash,
 } from './crypto-utils.js';
 
-const log = logger.getLogger('SRPClient');
+const log = getLogger('SRPClient');
 
 /**
  * SRP (Secure Remote Password) client implementation following RFC 5054.

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';
 

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

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;
+}

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.

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