项目文件夹

文件
Ergün Erdoğmuş ee35f207eb chore: Implement Watchdog process for reliable telemetry (#777)
This PR implements the watchdog process architecture for the telemetry
system. It moves the `ClearcutSender` execution to a dedicated child
process, ensuring that events—especially shutdown events—are reliably
transmitted even if the main server process terminates abruptly.

Added an e2e test that runs the server, checks the log file and confirms
the telemetry logs exist and that the watchdog process is correctly
killed after sending the shutdown event once the main process is killed.

**Implementation Roadmap:**
This is the fourth in a series of PRs designed to implement the
telemetry system:
1. **CLI & Opt-out Mechanism
([Merged](https://github.com/ChromeDevTools/chrome-devtools-mcp/pull/757)):**
    *   Added `--usage-statistics` flag and transparency logging.
2. **Logger Scaffolding & Integration
([Merged](https://github.com/ChromeDevTools/chrome-devtools-mcp/pull/758)):**
    *   **`ClearcutLogger`**: Implemented the main logging entry point.
* **One-way Data Flow**: Integrated `logToolInvocation` and
`logServerStart` hooks into `main.ts` to capture events.
    *   **`ClearcutSender`**: Introduced a transport abstraction.
* **Type Definitions**: Added TypeScript definitions for the telemetry
Protocol Buffer messages.
3. **Persistence Layer
([Merged](https://github.com/ChromeDevTools/chrome-devtools-mcp/pull/766)):**
* **`FilePersistence`**: Implemented a local file-based state manager to
persist the `lastActive` timestamp.
* **Daily Active Logic**: Integrated persistence into `ClearcutLogger`
to automatically detect and log `daily_active` events (with
`days_since_last_active` calculation) via `logDailyActiveIfNeeded`.
4.  **Watchdog Process Architecture (This PR):**
* **`WatchdogClient`**: Added a client-side wrapper to spawn and
communicate with the watchdog process via `stdin`.
* **`watchdog/main.ts`**: Created the entry point for the watchdog
process. It listens for IPC messages and uses `ClearcutSender` to
transmit events.
* **Reliable Shutdown**: The watchdog monitors the parent process and
guarantees a `shutdown` event is sent when the parent exits or crashes
(detecting `stdin` closure).
* **Refactoring**: Moved `ClearcutSender` to the `watchdog` directory
and updated `ClearcutLogger` to delegate event sending to the
`WatchdogClient`.
5.  **Transport, Batching & Retries (Next):**
* Finalize `ClearcutSender` with actual HTTP transport logic, including
event batching and exponential backoff retries.
2026-01-19 13:38:58 +00:00

140 行
3.5 KiB
TypeScript

/**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import assert from 'node:assert';
import {ChildProcess} from 'node:child_process';
import {Writable} from 'node:stream';
import {describe, it, afterEach, beforeEach} from 'node:test';
import sinon from 'sinon';
import {OsType, WatchdogMessageType} from '../../src/telemetry/types.js';
import {WatchdogClient} from '../../src/telemetry/watchdog-client.js';
describe('WatchdogClient', () => {
let spawnStub: sinon.SinonStub;
let stdinStub: sinon.SinonStubbedInstance<Writable>;
let mockChildProcess: sinon.SinonStubbedInstance<ChildProcess>;
beforeEach(() => {
stdinStub = sinon.createStubInstance(Writable);
mockChildProcess = sinon.createStubInstance(ChildProcess);
spawnStub = sinon.stub().returns(mockChildProcess);
Object.defineProperty(mockChildProcess, 'stdin', {
value: stdinStub,
writable: true,
});
Object.defineProperty(mockChildProcess, 'pid', {
value: 12345,
writable: true,
});
});
afterEach(() => {
sinon.restore();
});
it('spawns watchdog process with correct arguments', () => {
new WatchdogClient(
{
parentPid: 100,
appVersion: '1.2.3',
osType: OsType.OS_TYPE_MACOS,
},
{spawn: spawnStub},
);
assert.ok(spawnStub.calledOnce, 'Expected `spawn` to be called');
const args = spawnStub.firstCall.args;
const cmdArgs = args[1];
assert.match(
cmdArgs[0],
/watchdog[/\\]main\.js$/,
'First argument should be path to watchdog/main.js',
);
assert.ok(
cmdArgs.includes('--parent-pid=100'),
'Arguments should include parent PID',
);
assert.ok(
cmdArgs.includes('--app-version=1.2.3'),
'Arguments should include app version',
);
assert.ok(
cmdArgs.includes('--os-type=2'),
'Arguments should include OS type',
);
assert.strictEqual(
spawnStub.firstCall.args[2].detached,
true,
'Process should be spawned as detached',
);
});
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},
);
const cmdArgs = spawnStub.firstCall.args[1];
assert.ok(
cmdArgs.includes('--log-file=/tmp/test.log'),
'Arguments should include log file path',
);
});
it('sends IPC messages via stdin', () => {
const client = new WatchdogClient(
{
parentPid: 100,
appVersion: '1.0.0',
osType: OsType.OS_TYPE_LINUX,
},
{spawn: spawnStub},
);
const msg = {type: WatchdogMessageType.LOG_EVENT, payload: {}};
client.send(msg);
assert.ok(
stdinStub.write.calledOnce,
'Expected `stdin.write` to be called',
);
const writtenData = stdinStub.write.firstCall.args[0];
assert.strictEqual(
writtenData.trim(),
JSON.stringify(msg),
'Written data should match expected JSON message',
);
});
it('handles write errors gracefully', () => {
const client = new WatchdogClient(
{
parentPid: 100,
appVersion: '1.0.0',
osType: OsType.OS_TYPE_LINUX,
},
{spawn: spawnStub},
);
stdinStub.write.throws(new Error('EPIPE'));
assert.doesNotThrow(() => {
client.send({type: WatchdogMessageType.LOG_EVENT, payload: {}});
}, 'Client should catch and ignore write errors');
});
});