chromedevtools--chrome-devtools-mcp
Ergün Erdoğmuş
ee35f207eb
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.
75 行
2.3 KiB
TypeScript
75 行
2.3 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2026 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import assert from 'node:assert';
|
|
import crypto from 'node:crypto';
|
|
import {describe, it, afterEach, beforeEach} from 'node:test';
|
|
|
|
import sinon from 'sinon';
|
|
|
|
import {OsType} from '../../../src/telemetry/types.js';
|
|
import {ClearcutSender} from '../../../src/telemetry/watchdog/clearcut-sender.js';
|
|
|
|
describe('ClearcutSender', () => {
|
|
let clock: sinon.SinonFakeTimers;
|
|
let randomUUIDStub: sinon.SinonStub;
|
|
|
|
beforeEach(() => {
|
|
clock = sinon.useFakeTimers();
|
|
let uuidCounter = 0;
|
|
randomUUIDStub = sinon.stub(crypto, 'randomUUID').callsFake(() => {
|
|
return `uuid-${++uuidCounter}` as ReturnType<typeof crypto.randomUUID>;
|
|
});
|
|
});
|
|
|
|
afterEach(() => {
|
|
clock.restore();
|
|
randomUUIDStub.restore();
|
|
sinon.restore();
|
|
});
|
|
|
|
it('enriches events with app version, os type, and session id', async () => {
|
|
const sender = new ClearcutSender('1.0.0', OsType.OS_TYPE_MACOS);
|
|
const transportStub = sinon.stub(sender, 'transport');
|
|
|
|
await sender.send({mcp_client: undefined});
|
|
|
|
assert.strictEqual(transportStub.callCount, 1);
|
|
const event = transportStub.firstCall.args[0];
|
|
|
|
assert.strictEqual(event.session_id, 'uuid-1');
|
|
assert.strictEqual(event.app_version, '1.0.0');
|
|
assert.strictEqual(event.os_type, OsType.OS_TYPE_MACOS);
|
|
});
|
|
|
|
it('rotates session ID after 24 hours', async () => {
|
|
const sender = new ClearcutSender('1.0.0', OsType.OS_TYPE_MACOS);
|
|
const transportStub = sinon.stub(sender, 'transport');
|
|
|
|
await sender.send({});
|
|
assert.strictEqual(transportStub.lastCall.args[0].session_id, 'uuid-1');
|
|
|
|
clock.tick(23 * 60 * 60 * 1000);
|
|
await sender.send({});
|
|
assert.strictEqual(transportStub.lastCall.args[0].session_id, 'uuid-1');
|
|
|
|
clock.tick(2 * 60 * 60 * 1000);
|
|
await sender.send({});
|
|
assert.strictEqual(transportStub.lastCall.args[0].session_id, 'uuid-2');
|
|
});
|
|
|
|
it('sendShutdownEvent sends a server_shutdown event', async () => {
|
|
const sender = new ClearcutSender('1.0.0', OsType.OS_TYPE_MACOS);
|
|
const transportStub = sinon.stub(sender, 'transport');
|
|
|
|
await sender.sendShutdownEvent();
|
|
|
|
const event = transportStub.firstCall.args[0];
|
|
assert.ok(event.server_shutdown);
|
|
assert.strictEqual(event.server_start, undefined);
|
|
});
|
|
});
|