Fix formatting and linting issues

ergunsh · ergunsh · commit 98100982c8c3 · 2026-01-15T21:37:37.000+01:00
- Add comment to empty catch block in logger.ts
- Fix no-explicit-any in clearcut-sender.test.ts
- Apply prettier formatting to various files
diff --git a/IMPLEMENTATION_PLAN.md b/IMPLEMENTATION_PLAN.md
@@ -5,19 +5,20 @@ This document specifies the architecture for isolating telemetry into a separate
 ## Architecture
 
 The system consists of two processes:
+
 1.  **Main Process (Client)**: The DevTools MCP server. Spawns the Watchdog and sends raw telemetry events via IPC (Stdin).
 2.  **Watchdog Process (Server)**: A simplified Node.js process. Manages Session IDs, enriches events, and handles the reliable transmission of `server_shutdown` upon detecting Main Process death.
 
 ## Phase 1: Shared Core & Types (src/telemetry/types.ts)
 
 Define the IPC protocol between Master and Watchdog.
 
-*   **Modify** `src/telemetry/types.ts`:
-    *   `IpcMessageType` enum: `DATA = 'data'`.
-    *   `TelemetryEvent` interface: `{ type: IpcMessageType, payload: ChromeDevToolsMcpExtension }`.
-    *   Ensure `ChromeDevToolsMcpExtension` (Protobuf mapping) is exported.
-    *   Add `ServerShutdown` interface: `export interface ServerShutdown {}`.
-    *   Update `ChromeDevToolsMcpExtension` to include `server_shutdown?: ServerShutdown`.
+- **Modify** `src/telemetry/types.ts`:
+  - `IpcMessageType` enum: `DATA = 'data'`.
+  - `TelemetryEvent` interface: `{ type: IpcMessageType, payload: ChromeDevToolsMcpExtension }`.
+  - Ensure `ChromeDevToolsMcpExtension` (Protobuf mapping) is exported.
+  - Add `ServerShutdown` interface: `export interface ServerShutdown {}`.
+  - Update `ChromeDevToolsMcpExtension` to include `server_shutdown?: ServerShutdown`.
 
 ## Phase 2: Watchdog Process (The Sidecar)
 
@@ -28,91 +29,100 @@ Location: `src/telemetry/watchdog/`
 A stateful class responsible for session management and transport.
 
 **State:**
-*   `#appVersion`: string
-*   `#osType`: OsType
-*   `#sessionId`: string (Hex string)
-*   `#sessionCreated`: number (Timestamp)
+
+- `#appVersion`: string
+- `#osType`: OsType
+- `#sessionId`: string (Hex string)
+- `#sessionCreated`: number (Timestamp)
 
 **Behavior:**
-*   **Initialization**:
-    *   Generate initial `#sessionId` using `crypto.randomUUID()`.
-    *   Set `#sessionCreated = Date.now()`.
-*   **`send(event: ChromeDevToolsMcpExtension)`**:
-    1.  **Session Rotation**:
-        *   Check `Date.now() - #sessionCreated > 24 * 60 * 60 * 1000` (24 hours).
-        *   If expired: Generate new `#sessionId` (UUID), reset `#sessionCreated`.
-    2.  **Enrichment**: deeply clone `event`. Populate:
-        *   `client_info.client_type`
-        *   `session_id` (from state)
-        *   `app_version` (from state)
-        *   `os_type` (from state)
-    3.  **Transport**:
-        *   Log the JSON stringified event using the `logger` from `../../logger.js`.
-*   **`sendShutdownEvent()`**:
-    *   Construct `server_shutdown` event.
-    *   **CRITICAL**: Do *not* include `flag_usage` (Main process might not have sent it if crashed).
-    *   Calls `this.send(shutdownEvent)`.
+
+- **Initialization**:
+  - Generate initial `#sessionId` using `crypto.randomUUID()`.
+  - Set `#sessionCreated = Date.now()`.
+- **`send(event: ChromeDevToolsMcpExtension)`**:
+  1.  **Session Rotation**:
+      - Check `Date.now() - #sessionCreated > 24 * 60 * 60 * 1000` (24 hours).
+      - If expired: Generate new `#sessionId` (UUID), reset `#sessionCreated`.
+  2.  **Enrichment**: deeply clone `event`. Populate:
+      - `client_info.client_type`
+      - `session_id` (from state)
+      - `app_version` (from state)
+      - `os_type` (from state)
+  3.  **Transport**:
+      - Log the JSON stringified event using the `logger` from `../../logger.js`.
+- **`sendShutdownEvent()`**:
+  - Construct `server_shutdown` event.
+  - **CRITICAL**: Do _not_ include `flag_usage` (Main process might not have sent it if crashed).
+  - Calls `this.send(shutdownEvent)`.
 
 ### 2.2 Watchdog Entry Point (`src/telemetry/watchdog/main.ts`)
 
 The executable script.
 
 **Inputs (CLI Args):**
-*   `--parent-pid`: PID of the Main Process to monitor.
-*   `--app-version`: String.
-*   `--os-type`: Integer (OsType).
-*   `--log-file`: Absolute path for debugging logs (optional).
+
+- `--parent-pid`: PID of the Main Process to monitor.
+- `--app-version`: String.
+- `--os-type`: Integer (OsType).
+- `--log-file`: Absolute path for debugging logs (optional).
 
 **Logic Flow:**
+
 1.  **Bootstrap**:
-    *   **Arg Parsing**: Use `yargs` to parse command line arguments widely.
-    *   Setup internal logging (to file if `--log-file` provided, otherwise silent/stderr).
-    *   Instantiate `ClearcutSender`.
+    - **Arg Parsing**: Use `yargs` to parse command line arguments widely.
+    - Setup internal logging (to file if `--log-file` provided, otherwise silent/stderr).
+    - Instantiate `ClearcutSender`.
 2.  **IPC Handling (Stdin)**:
-    *   `process.stdin.resume()` and set encoding `utf8`.
-    *   Stream parser (using `readline` or buffer splitting) for newline-delimited JSON.
-    *   On valid message: `sender.send(payload)`.
+    - `process.stdin.resume()` and set encoding `utf8`.
+    - Stream parser (using `readline` or buffer splitting) for newline-delimited JSON.
+    - On valid message: `sender.send(payload)`.
 3.  **Death Detection**:
-    *   **Mechanism**: Listen for `process.stdin.on('end')` and `('close')`.
-    *   **Trigger**: On either event:
-        1.  Log "Parent death detected".
-        2.  `await sender.sendShutdownEvent()`.
-        3.  `process.exit(0)`.
+    - **Mechanism**: Listen for `process.stdin.on('end')` and `('close')`.
+    - **Trigger**: On either event:
+      1.  Log "Parent death detected".
+      2.  `await sender.sendShutdownEvent()`.
+      3.  `process.exit(0)`.
 4.  **Disconnect**: Handle `process.on('disconnect')` similarly to death.
 
 ## Phase 3: Main Process Client (`src/telemetry/watchdog-client.ts`)
 
 Abstracts the sidecar management.
 
 **Class: `WatchdogClient`**
-*   **Constructor**:
-    *   `parentPid`, `appVersion`, `osType`, `logFile`.
-*   **Spawning Logic**:
-    *   **Path Resolution**: Use `import.meta.url` to resolve the absolute path to `watchdog/main.js`.
-        ```javascript
-        const watchdogPath = fileURLToPath(new URL('./watchdog/main.js', import.meta.url));
-        ```
-    *   **Spawn**: `child_process.spawn(process.execPath, [watchdogPath, ...dependencies])`.
-    *   **Stdio Config**: `['pipe', 'ignore', 'ignore']` (Strictly ignore output, rely on `--log-file`).
-    *   **Lifecycle**: `unref()` the child so it doesn't block Main Process exit.
-*   **`send(message: TelemetryEvent)`**:
-    *   JSON-stringify `event`.
-    *   Append `\n`.
-    *   Write to `child.stdin`.
-    *   Handle errors (EPIPE) gracefully (log warning, do not crash).
+
+- **Constructor**:
+  - `parentPid`, `appVersion`, `osType`, `logFile`.
+- **Spawning Logic**:
+  - **Path Resolution**: Use `import.meta.url` to resolve the absolute path to `watchdog/main.js`.
+    ```javascript
+    const watchdogPath = fileURLToPath(
+      new URL('./watchdog/main.js', import.meta.url),
+    );
+    ```
+  - **Spawn**: `child_process.spawn(process.execPath, [watchdogPath, ...dependencies])`.
+  - **Stdio Config**: `['pipe', 'ignore', 'ignore']` (Strictly ignore output, rely on `--log-file`).
+  - **Lifecycle**: `unref()` the child so it doesn't block Main Process exit.
+- **`send(message: TelemetryEvent)`**:
+  - JSON-stringify `event`.
+  - Append `\n`.
+  - Write to `child.stdin`.
+  - Handle errors (EPIPE) gracefully (log warning, do not crash).
 
 ## Phase 4: Integration & Testing
 
 ### 4.1 Refactor `ClearcutLogger`
-*   Remove direct `ClearcutSender` usage.
-*   Instantiate `WatchdogClient` in constructor.
-*   Proxy methods (`logToolInvocation`, etc.) to `client.send()`.
+
+- Remove direct `ClearcutSender` usage.
+- Instantiate `WatchdogClient` in constructor.
+- Proxy methods (`logToolInvocation`, etc.) to `client.send()`.
 
 ### 4.2 Verification Plan
+
 1.  **Unit Tests**:
-    *   `clearcut-sender.test.ts`: Verify enrichment and session rotation logic mocking Date.
+    - `clearcut-sender.test.ts`: Verify enrichment and session rotation logic mocking Date.
 2.  **Integration Tests (`spawn-kill-verify`)**:
-    *   Script: Spawn Main Process (mock).
-    *   Main Process spawns Watchdog.
-    *   Main Process kills itself (`kill -9`).
-    *   **Assert**: Watchdog writes `server_shutdown` to log/transport before exiting.
+    - Script: Spawn Main Process (mock).
+    - Main Process spawns Watchdog.
+    - Main Process kills itself (`kill -9`).
+    - **Assert**: Watchdog writes `server_shutdown` to log/transport before exiting.
diff --git a/src/logger.ts b/src/logger.ts
@@ -32,7 +32,6 @@ export function saveLogsToFile(fileName: string): fs.WriteStream {
 }
 
 export function saveLogsToFileSync(fileName: string): void {
-
   debug.enable(namespacesToEnable.join(','));
 
   let fd: number | undefined;
@@ -47,7 +46,8 @@ export function saveLogsToFileSync(fileName: string): void {
     if (fd !== undefined) {
       try {
         fs.writeSync(fd, `${chunks.join(' ')}\n`);
-      } catch (e) {
+      } catch {
+        // Ignore write errors in watchdog - process may be shutting down
       }
     }
   };
diff --git a/src/telemetry/watchdog-client.ts b/src/telemetry/watchdog-client.ts
@@ -46,7 +46,7 @@ export class WatchdogClient {
 
     this.#childProcess.unref();
 
-    this.#childProcess.on('error', (err) => {
+    this.#childProcess.on('error', err => {
       logger('Watchdog process error:', err);
     });
 
diff --git a/tests/telemetry/clearcut-logger.test.ts b/tests/telemetry/clearcut-logger.test.ts
@@ -68,10 +68,7 @@ describe('ClearcutLogger', () => {
       assert(mockWatchdogClient.send.calledOnce);
       const msg = mockWatchdogClient.send.firstCall.args[0];
       assert.strictEqual(msg.type, IpcMessageType.EVENT);
-      assert.strictEqual(
-        msg.payload.server_start?.flag_usage?.headless,
-        true,
-      );
+      assert.strictEqual(msg.payload.server_start?.flag_usage?.headless, true);
     });
   });
 
@@ -96,7 +93,7 @@ describe('ClearcutLogger', () => {
       const msg = mockWatchdogClient.send.firstCall.args[0];
       assert.strictEqual(msg.type, IpcMessageType.EVENT);
       assert.ok(msg.payload.daily_active);
-      
+
       assert(mockPersistence.saveState.called);
     });
 
@@ -133,10 +130,7 @@ describe('ClearcutLogger', () => {
       assert(mockWatchdogClient.send.calledOnce);
       const msg = mockWatchdogClient.send.firstCall.args[0];
       assert.strictEqual(msg.type, IpcMessageType.EVENT);
-      assert.strictEqual(
-        msg.payload.daily_active?.days_since_last_active,
-        -1,
-      );
+      assert.strictEqual(msg.payload.daily_active?.days_since_last_active, -1);
       assert(mockPersistence.saveState.called);
     });
   });
diff --git a/tests/telemetry/watchdog-client.test.ts b/tests/telemetry/watchdog-client.test.ts
@@ -6,7 +6,7 @@
 
 import assert from 'node:assert';
 import type {spawn} from 'node:child_process';
-import { type ChildProcess} from 'node:child_process';
+import {type ChildProcess} from 'node:child_process';
 import EventEmitter from 'node:events';
 import {Writable} from 'node:stream';
 import {describe, it, afterEach, beforeEach} from 'node:test';
@@ -23,9 +23,9 @@ describe('WatchdogClient', () => {
   beforeEach(() => {
     const eventEmitter = new EventEmitter();
     const stdin = new Writable({
-        write(_chunk, _encoding, callback) {
-            callback();
-        }
+      write(_chunk, _encoding, callback) {
+        callback();
+      },
     });
     sinon.stub(stdin, 'write');
 
@@ -37,7 +37,10 @@ describe('WatchdogClient', () => {
       kill: sinon.stub(),
       unref: sinon.stub(),
       destroyed: false,
-    } as unknown as ChildProcess) as ChildProcess & {stdin: Writable; kill: sinon.SinonStub};
+    } as unknown as ChildProcess) as ChildProcess & {
+      stdin: Writable;
+      kill: sinon.SinonStub;
+    };
 
     spawnStub = sinon.stub().returns(mockChildProcess);
   });
@@ -47,16 +50,19 @@ describe('WatchdogClient', () => {
   });
 
   it('spawns watchdog process with correct arguments', () => {
-     new WatchdogClient({
-      parentPid: 100,
-      appVersion: '1.2.3',
-      osType: OsType.OS_TYPE_MACOS,
-    }, {spawn: spawnStub as unknown as typeof spawn});
+    new WatchdogClient(
+      {
+        parentPid: 100,
+        appVersion: '1.2.3',
+        osType: OsType.OS_TYPE_MACOS,
+      },
+      {spawn: spawnStub as unknown as typeof spawn},
+    );
 
     assert.strictEqual(spawnStub.calledOnce, true);
     const args = spawnStub.firstCall.args;
     const cmdArgs = args[1];
-    
+
     assert.match(cmdArgs[0], /watchdog\/main\.js$/);
     assert.strictEqual(cmdArgs.includes('--parent-pid=100'), true);
     assert.strictEqual(cmdArgs.includes('--app-version=1.2.3'), true);
@@ -65,47 +71,57 @@ describe('WatchdogClient', () => {
   });
 
   it('passes log-file argument if provided', () => {
-     new WatchdogClient({
-      parentPid: 100,
-      appVersion: '1.0.0',
-      osType: OsType.OS_TYPE_LINUX,
-      logFile: '/tmp/test.log',
-    }, {spawn: spawnStub as unknown as typeof spawn});
+    new WatchdogClient(
+      {
+        parentPid: 100,
+        appVersion: '1.0.0',
+        osType: OsType.OS_TYPE_LINUX,
+        logFile: '/tmp/test.log',
+      },
+      {spawn: spawnStub as unknown as typeof spawn},
+    );
 
     const cmdArgs = spawnStub.firstCall.args[1];
     assert.strictEqual(cmdArgs.includes('--log-file=/tmp/test.log'), true);
   });
 
   it('sends IPC messages via stdin', () => {
-    const client = new WatchdogClient({
-      parentPid: 100,
-      appVersion: '1.0.0',
-      osType: OsType.OS_TYPE_LINUX,
-    }, {spawn: spawnStub as unknown as typeof spawn});
+    const client = new WatchdogClient(
+      {
+        parentPid: 100,
+        appVersion: '1.0.0',
+        osType: OsType.OS_TYPE_LINUX,
+      },
+      {spawn: spawnStub as unknown as typeof spawn},
+    );
 
     const msg = {type: IpcMessageType.EVENT, payload: {}};
     client.send(msg);
 
     const writeSpy = mockChildProcess.stdin.write as sinon.SinonSpy;
     assert.strictEqual(writeSpy.calledOnce, true);
-    
+
     const writtenData = writeSpy.firstCall.args[0];
     assert.strictEqual(writtenData.trim(), JSON.stringify(msg));
   });
 
   it('handles write errors gracefully', () => {
-    const client = new WatchdogClient({
+    const client = new WatchdogClient(
+      {
         parentPid: 100,
         appVersion: '1.0.0',
         osType: OsType.OS_TYPE_LINUX,
-      }, {spawn: spawnStub as unknown as typeof spawn});
+      },
+      {spawn: spawnStub as unknown as typeof spawn},
+    );
 
-    const writeStub = mockChildProcess.stdin.write as unknown as sinon.SinonStub;
+    const writeStub = mockChildProcess.stdin
+      .write as unknown as sinon.SinonStub;
     writeStub.throws(new Error('EPIPE'));
 
     // Should not throw
     assert.doesNotThrow(() => {
-        client.send({type: IpcMessageType.EVENT, payload: {}});
+      client.send({type: IpcMessageType.EVENT, payload: {}});
     });
   });
 });
diff --git a/tests/telemetry/watchdog/clearcut-sender.test.ts b/tests/telemetry/watchdog/clearcut-sender.test.ts

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,6 @@ export function saveLogsToFile(fileName: string): fs.WriteStream {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`export function saveLogsToFileSync(fileName: string): void {`
`35`		`-`
`36`	`35`	`debug.enable(namespacesToEnable.join(','));`
`37`	`36`
`38`	`37`	`let fd: number \| undefined;`
`@@ -47,7 +46,8 @@ export function saveLogsToFileSync(fileName: string): void {`
`47`	`46`	`if (fd !== undefined) {`
`48`	`47`	`try {`
`49`	`48`	fs.writeSync(fd, `${chunks.join(' ')}\n`);
`50`		`- } catch (e) {`
	`49`	`+ } catch {`
	`50`	`+ // Ignore write errors in watchdog - process may be shutting down`
`51`	`51`	`}`
`52`	`52`	`}`
`53`	`53`	`};`