mirror of
https://github.com/garrytan/gstack.git
synced 2026-08-31 18:30:39 +02:00
Garry TanandClaude Fable 5
c252f00b4c
Five files assigned process.env.GSTACK_HOME at module scope. Shard processes evaluate sibling modules before running their tests, so the assignment leaked into every other file in the shard — the damage was already visible in defensive workarounds (relink.test.ts:28 'fresh install test saw a neighbor's skill_prefix'; cdp-e2e's own comment documents a sibling's temp dir baked into artifacts). Pattern: save original, assign in beforeAll, restore in afterAll (cdp-e2e already restored but still assigned at load — its window now matches the others). GSTACK_TELEMETRY_OFF and GSTACK_PROJECT_SLUG get the same treatment where they rode along. Victim files' defenses stay in place (cheap insurance). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
78 lines
3.1 KiB
TypeScript
78 lines
3.1 KiB
TypeScript
import { describe, it, expect, beforeAll, beforeEach, afterAll } from 'bun:test';
|
|
import { promises as fs } from 'fs';
|
|
import * as path from 'path';
|
|
import * as os from 'os';
|
|
|
|
const TMP_HOME = path.join(os.tmpdir(), `gstack-telemetry-test-${process.pid}-${Date.now()}`);
|
|
const TELEMETRY_FILE = path.join(TMP_HOME, 'analytics', 'browse-telemetry.jsonl');
|
|
|
|
// Use GSTACK_HOME env to redirect telemetry writes (read each call,
|
|
// not cached at module-load).
|
|
// Scoped to this file's execution window — module-scope env assignment
|
|
// leaks into sibling files in the shard process (see
|
|
// test/gstack-home-module-scope.test.ts).
|
|
const ORIGINAL_GSTACK_HOME = process.env.GSTACK_HOME;
|
|
const ORIGINAL_TELEMETRY_OFF = process.env.GSTACK_TELEMETRY_OFF;
|
|
beforeAll(() => {
|
|
process.env.GSTACK_HOME = TMP_HOME;
|
|
process.env.GSTACK_TELEMETRY_OFF = '0';
|
|
});
|
|
afterAll(() => {
|
|
if (ORIGINAL_GSTACK_HOME === undefined) delete process.env.GSTACK_HOME;
|
|
else process.env.GSTACK_HOME = ORIGINAL_GSTACK_HOME;
|
|
if (ORIGINAL_TELEMETRY_OFF === undefined) delete process.env.GSTACK_TELEMETRY_OFF;
|
|
else process.env.GSTACK_TELEMETRY_OFF = ORIGINAL_TELEMETRY_OFF;
|
|
});
|
|
|
|
beforeEach(async () => {
|
|
await fs.rm(TMP_HOME, { recursive: true, force: true });
|
|
});
|
|
|
|
afterAll(async () => {
|
|
await fs.rm(TMP_HOME, { recursive: true, force: true });
|
|
});
|
|
|
|
async function readEvents(): Promise<any[]> {
|
|
// Wait briefly for fire-and-forget appends to flush.
|
|
await new Promise((r) => setTimeout(r, 30));
|
|
try {
|
|
const raw = await fs.readFile(TELEMETRY_FILE, 'utf8');
|
|
return raw.trim().split('\n').filter(Boolean).map((l) => JSON.parse(l));
|
|
} catch {
|
|
return [];
|
|
}
|
|
}
|
|
|
|
describe('telemetry: signals fire to ~/.gstack/analytics/browse-telemetry.jsonl', () => {
|
|
it('logTelemetry writes a JSONL line with ts injected', async () => {
|
|
const { logTelemetry, _resetTelemetryCache } = await import('../src/telemetry');
|
|
_resetTelemetryCache();
|
|
logTelemetry({ event: 'domain_skill_saved', host: 'test.com', scope: 'project', state: 'quarantined', bytes: 42 });
|
|
const events = await readEvents();
|
|
expect(events).toHaveLength(1);
|
|
expect(events[0].event).toBe('domain_skill_saved');
|
|
expect(events[0].host).toBe('test.com');
|
|
expect(events[0].bytes).toBe(42);
|
|
expect(events[0].ts).toMatch(/^\d{4}-\d{2}-\d{2}T/);
|
|
});
|
|
|
|
it('GSTACK_TELEMETRY_OFF=1 silences all events', async () => {
|
|
process.env.GSTACK_TELEMETRY_OFF = '1';
|
|
const { logTelemetry, _resetTelemetryCache } = await import('../src/telemetry');
|
|
_resetTelemetryCache();
|
|
logTelemetry({ event: 'cdp_method_called', domain: 'X', method: 'y' });
|
|
const events = await readEvents();
|
|
expect(events).toHaveLength(0);
|
|
process.env.GSTACK_TELEMETRY_OFF = '0';
|
|
});
|
|
|
|
it('telemetry never throws even if disk fails', async () => {
|
|
// Point HOME to a path that doesn't exist + can't be created (root-owned)
|
|
// — but that's hard to set up cross-platform. Just check that calling
|
|
// logTelemetry on a missing directory doesn't throw.
|
|
const { logTelemetry, _resetTelemetryCache } = await import('../src/telemetry');
|
|
_resetTelemetryCache();
|
|
expect(() => logTelemetry({ event: 'noop_test' })).not.toThrow();
|
|
});
|
|
});
|