refactor: rename audit.ts to telemetry-helper.ts, clarify method names

Author: Hweinstock

integ-tests/add-remove-resources.test.ts

@@ -1,9 +1,9 @@
-import { assertTelemetry, createAuditContext } from '../src/test-utils/audit.js';
 import { createTestProject, readProjectConfig, runCLI } from '../src/test-utils/index.js';
 import type { TestProject } from '../src/test-utils/index.js';
+import { assertTelemetry, createTelemetryHelper } from '../src/test-utils/telemetry-helper.js';
 import { afterAll, beforeAll, describe, expect, it } from 'vitest';
 
-const audit = createAuditContext();
+const telemetry = createTelemetryHelper();
 
 describe('integration: add and remove resources', () => {
   let project: TestProject;
@@ -19,15 +19,15 @@ describe('integration: add and remove resources', () => {
 
   afterAll(async () => {
     await project.cleanup();
-    audit.cleanup();
+    telemetry.destroy();
   });
 
   describe('memory lifecycle', () => {
     const memoryName = `IntegMem${Date.now().toString().slice(-6)}`;
 
     it('adds a memory resource', async () => {
       const result = await runCLI(['add', 'memory', '--name', memoryName, '--json'], project.projectPath, {
-        env: audit.env,
+        env: telemetry.env,
       });
 
       expect(result.exitCode, `stdout: ${result.stdout}, stderr: ${result.stderr}`).toBe(0);
@@ -42,7 +42,7 @@ describe('integration: add and remove resources', () => {
       expect(found, `Memory "${memoryName}" should be in config`).toBe(true);
 
       // Verify telemetry
-      assertTelemetry(audit.readEntries(), { command: 'add.memory', exit_reason: 'success' });
+      assertTelemetry(telemetry.readEntries(), { command: 'add.memory', exit_reason: 'success' });
     });
 
     it('adds a memory with EPISODIC strategy and verifies reflectionNamespaces', async () => {
@@ -96,7 +96,7 @@ describe('integration: add and remove resources', () => {
       const result = await runCLI(
         ['add', 'credential', '--name', credentialName, '--api-key', 'test-key-integ-123', '--json'],
         project.projectPath,
-        { env: audit.env }
+        { env: telemetry.env }
       );
 
       expect(result.exitCode, `stdout: ${result.stdout}, stderr: ${result.stderr}`).toBe(0);
@@ -111,7 +111,7 @@ describe('integration: add and remove resources', () => {
       expect(found, `Credential "${credentialName}" should be in config`).toBe(true);
 
       // Verify telemetry
-      assertTelemetry(audit.readEntries(), {
+      assertTelemetry(telemetry.readEntries(), {
         command: 'add.credential',
         exit_reason: 'success',
         credential_type: 'api-key',

integ-tests/help.test.ts

@@ -1,6 +1,6 @@
-import { assertTelemetry, createAuditContext } from '../src/test-utils/audit.js';
 import { spawnAndCollect } from '../src/test-utils/cli-runner.js';
 import { runCLI } from '../src/test-utils/index.js';
+import { assertTelemetry, createTelemetryHelper } from '../src/test-utils/telemetry-helper.js';
 import { readdirSync } from 'node:fs';
 import { join } from 'node:path';
 import { afterAll, describe, expect, it } from 'vitest';
@@ -44,15 +44,15 @@ describe('CLI help', () => {
 });
 
 describe('help modes telemetry', () => {
-  const audit = createAuditContext();
+  const telemetry = createTelemetryHelper();
   const cliPath = join(__dirname, '..', 'dist', 'cli', 'index.mjs');
 
-  afterAll(() => audit.cleanup());
+  afterAll(() => telemetry.destroy());
 
   function run(args: string[], extraEnv: Record<string, string> = {}) {
     return spawnAndCollect('node', [cliPath, ...args], process.cwd(), {
       AGENTCORE_SKIP_INSTALL: '1',
-      ...audit.env,
+      ...telemetry.env,
       ...extraEnv,
     });
   }
@@ -61,7 +61,7 @@ describe('help modes telemetry', () => {
     const result = await run(['help', 'modes']);
     expect(result.exitCode).toBe(0);
 
-    const entries = audit.readEntries();
+    const entries = telemetry.readEntries();
     expect(entries).toHaveLength(1);
     assertTelemetry(entries, {
       command_group: 'help',
@@ -74,16 +74,16 @@ describe('help modes telemetry', () => {
   });
 
   it('does not write audit file when audit is not enabled', async () => {
-    audit.clear();
+    telemetry.clearEntries();
 
     const noAuditCliPath = join(__dirname, '..', 'dist', 'cli', 'index.mjs');
     const result = await spawnAndCollect('node', [noAuditCliPath, 'help', 'modes'], process.cwd(), {
       AGENTCORE_SKIP_INSTALL: '1',
-      AGENTCORE_CONFIG_DIR: audit.dir,
+      AGENTCORE_CONFIG_DIR: telemetry.dir,
     });
     expect(result.exitCode).toBe(0);
 
-    const telemetryDir = join(audit.dir, 'telemetry');
+    const telemetryDir = join(telemetry.dir, 'telemetry');
     try {
       const files = readdirSync(telemetryDir);
       expect(files).toHaveLength(0);

src/test-utils/index.ts

@@ -4,7 +4,12 @@
  */
 
 export { runCLI, spawnAndCollect, cleanSpawnEnv, type RunResult } from './cli-runner.js';
-export { createAuditContext, assertTelemetry, type AuditContext, type TelemetryEntry } from './audit.js';
+export {
+  createTelemetryHelper,
+  assertTelemetry,
+  type TelemetryHelper,
+  type TelemetryEntry,
+} from './telemetry-helper.js';
 export { exists } from './fs-helpers.js';
 export { hasCommand, hasAwsCredentials, prereqs } from './prereqs.js';
 export { createTestProject, type TestProject, type CreateTestProjectOptions } from './project-factory.js';

src/test-utils/audit.ts src/test-utils/telemetry-helper.tssrc/test-utils/audit.ts renamed to src/test-utils/telemetry-helper.ts

@@ -9,20 +9,20 @@ export interface TelemetryEntry {
   attrs: Record<string, string | number>;
 }
 
-export interface AuditContext {
+export interface TelemetryHelper {
   /** Temp directory used as AGENTCORE_CONFIG_DIR */
   dir: string;
-  /** Env vars to pass to runCLI */
+  /** Env vars to pass to runCLI to enable audit mode */
   env: { AGENTCORE_TELEMETRY_AUDIT: '1'; AGENTCORE_CONFIG_DIR: string };
   /** Read all JSONL entries from the audit telemetry directory */
   readEntries: () => TelemetryEntry[];
-  /** Delete the telemetry subdirectory */
-  clear: () => void;
-  /** Delete the entire config directory */
-  cleanup: () => void;
+  /** Delete telemetry entries only (keeps the config dir) */
+  clearEntries: () => void;
+  /** Delete the entire config directory — call in afterAll */
+  destroy: () => void;
 }
 
-export function createAuditContext(): AuditContext {
+export function createTelemetryHelper(): TelemetryHelper {
   const dir = mkdtempSync(join(tmpdir(), 'agentcore-audit-'));
   return {
     dir,
@@ -35,10 +35,10 @@ export function createAuditContext(): AuditContext {
           .map(line => JSON.parse(line) as TelemetryEntry)
       );
     },
-    clear() {
+    clearEntries() {
       rmSync(join(dir, 'telemetry'), { recursive: true, force: true });
     },
-    cleanup() {
+    destroy() {
       rmSync(dir, { recursive: true, force: true });
     },
   };