Stop emitting telemetry from tests and example projects (#320)

* test: dont emit telemetry events from tests

* feat: add isCi to telemetry context

* rename to is example project

packages/core/src/_test/art-gobblers/app.test.ts

@@ -29,6 +29,7 @@ const setup = async ({ context }: { context: TestContext }) => {
     ...options,
     uiEnabled: false,
     logLevel: "error",
+    telemetryDisabled: true,
   } as const;
 
   const ponder = new Ponder({

packages/core/src/_test/ens/app.test.ts

@@ -29,6 +29,7 @@ const setup = async ({ context }: { context: TestContext }) => {
     ...options,
     uiEnabled: false,
     logLevel: "error",
+    telemetryDisabled: true,
   } as const;
 
   const ponder = new Ponder({

packages/core/src/_test/setup.ts

@@ -46,7 +46,12 @@ declare module "vitest" {
 }
 
 beforeEach((context) => {
-  const options = buildOptions({ cliOptions: { configFile: "", rootDir: "" } });
+  const options = {
+    ...buildOptions({
+      cliOptions: { configFile: "", rootDir: "" },
+    }),
+    telemetryDisabled: true,
+  };
   context.common = {
     options,
     logger: new LoggerService({ level: "silent" }),

packages/core/src/config/options.ts

@@ -18,6 +18,7 @@ export type Options = {
   maxHealthcheckDuration: number;
   telemetryUrl: string;
   telemetryDisabled: boolean;
+  telemetryIsExampleProject: boolean;
 
   logLevel: LevelWithSilent;
   uiEnabled: boolean;
@@ -58,6 +59,9 @@ export const buildOptions = ({
 
     telemetryUrl: "https://ponder.sh/api/telemetry",
     telemetryDisabled: Boolean(process.env.PONDER_TELEMETRY_DISABLED),
+    telemetryIsExampleProject: Boolean(
+      process.env.PONDER_TELEMETRY_IS_EXAMPLE_PROJECT
+    ),
 
     logLevel,
     uiEnabled: true,

packages/core/src/telemetry/detached-flush.test.ts

@@ -5,7 +5,10 @@ import path from "node:path";
 import process from "node:process";
 import { expect, test } from "vitest";
 
-test("detached flush script should run without error", async ({ common }) => {
+test("detached flush script should run without error", async () => {
+  // This is a service that always responds to POST requests with a 200 OK.
+  const telemetryUrl = "https://reqres.in/api/users";
+
   const events = Array.from({ length: 5 }, () => ({
     event: "test",
     payload: {},
@@ -22,7 +25,7 @@ test("detached flush script should run without error", async ({ common }) => {
     stderr: string;
   }>((resolve) => {
     child_process.exec(
-      `${process.execPath} ${flushDetachedScriptPath} ${common.options.telemetryUrl} ${telemetryEventsFilePath}`,
+      `${process.execPath} ${flushDetachedScriptPath} ${telemetryUrl} ${telemetryEventsFilePath}`,
       (error, stdout, stderr) => resolve({ error, stdout, stderr })
     );
   });
@@ -31,6 +34,6 @@ test("detached flush script should run without error", async ({ common }) => {
   expect(stderr).toBe("");
   expect(error).toBe(null);
   expect(stdout).toContain(
-    `Sending 5 telemetry events to https://ponder.sh/api/telemetry from temporary file ${telemetryEventsFilePath}`
+    `Sending 5 telemetry events to ${telemetryUrl} from temporary file ${telemetryEventsFilePath}`
   );
 });

packages/core/src/telemetry/service.test.ts

@@ -2,42 +2,26 @@ import child_process from "node:child_process";
 import fs from "node:fs";
 import { tmpdir } from "node:os";
 import path from "path";
-import process from "process";
-import { afterAll, beforeEach, expect, test, vi } from "vitest";
+import { beforeAll, beforeEach, expect, test, vi } from "vitest";
 
-import { buildOptions } from "@/config/options";
 import { TelemetryService } from "@/telemetry/service";
 
-// Prevents the detached-flush script from sending events to API during tests.
-vi.mock("node-fetch");
-
-const fetchSpy = vi.fn().mockImplementation(() => vi.fn());
+const fetchSpy = vi.fn();
 
 beforeEach(() => {
   fetchSpy.mockReset();
   vi.stubGlobal("fetch", fetchSpy);
   return () => vi.unstubAllGlobals();
 });
 
-afterAll(() => {
-  vi.restoreAllMocks();
-});
-
-test("should be disabled if PONDER_TELEMETRY_DISABLED flag is set", async () => {
-  process.env.PONDER_TELEMETRY_DISABLED = "true";
-
-  // we're not using the options from the context because we want to test that
-  // build options will correctly set the telemetry service as disabled if the
-  // env var is set
-  const options = buildOptions({ cliOptions: { configFile: "", rootDir: "" } });
-  const telemetry = new TelemetryService({ options });
-
-  expect(telemetry.disabled).toBe(true);
-
-  delete process.env.PONDER_TELEMETRY_DISABLED;
+beforeAll(() => {
+  // Prevents the detached-flush script from sending events to API during tests.
+  vi.mock("node-fetch");
+  return () => vi.restoreAllMocks();
 });
 
-test("events are processed", async ({ common: { options } }) => {
+test("events are processed", async (context) => {
+  const options = { ...context.common.options, telemetryDisabled: false };
   const telemetry = new TelemetryService({ options });
 
   telemetry.record({ event: "test", properties: { test: "data" } });
@@ -54,22 +38,18 @@ test("events are processed", async ({ common: { options } }) => {
   });
 });
 
-test("events are not processed if telemetry is disabled", async ({
-  common: { options },
-}) => {
-  const telemetry = new TelemetryService({
-    options: { ...options, telemetryDisabled: true },
-  });
+test("events are not processed if telemetry is disabled", async (context) => {
+  const options = { ...context.common.options, telemetryDisabled: true };
+  const telemetry = new TelemetryService({ options });
 
   telemetry.record({ event: "test" });
   await telemetry.flush();
 
   expect(fetchSpy).not.toHaveBeenCalled();
 });
 
-test("events are put back in queue if telemetry service is killed", async ({
-  common: { options },
-}) => {
+test("events are put back in queue if telemetry service is killed", async (context) => {
+  const options = { ...context.common.options, telemetryDisabled: false };
   const telemetry = new TelemetryService({ options });
 
   fetchSpy.mockImplementationOnce(() => {
@@ -82,14 +62,16 @@ test("events are put back in queue if telemetry service is killed", async ({
   expect(telemetry["events"].length).toBe(1);
 });
 
-test("kill method should persist events and trigger detached flush", async ({
-  common: { options },
-}) => {
-  const options_ = { ...options, ponderDir: tmpdir() };
+test("kill method should persist events and trigger detached flush", async (context) => {
+  const options = {
+    ...context.common.options,
+    telemetryDisabled: false,
+    ponderDir: tmpdir(),
+  };
 
   const spawn = vi.spyOn(child_process, "spawn");
-  const telemetry = new TelemetryService({ options: options_ });
-  const fileName = path.join(options_.ponderDir, "telemetry-events.json");
+  const telemetry = new TelemetryService({ options });
+  const fileName = path.join(options.ponderDir, "telemetry-events.json");
 
   const writeFileSyncSpy = vi
     .spyOn(fs, "writeFileSync")

packages/core/src/telemetry/service.ts

@@ -28,20 +28,18 @@ type TelemetryDeviceConfig = {
 type TelemetryEventContext = {
   projectId: string;
   sessionId: string;
-  // package.json information
-  nodeVersion: string;
   packageManager: string;
   packageManagerVersion: string;
+  nodeVersion: string;
   ponderVersion: string;
-  // Software information
   systemPlatform: NodeJS.Platform;
   systemRelease: string;
   systemArchitecture: string;
-  // Machine information
   cpuCount: number;
   cpuModel: string | null;
   cpuSpeed: number | null;
   memoryInMb: number;
+  isExampleProject: boolean;
 };
 
 export class TelemetryService {
@@ -235,6 +233,7 @@ export class TelemetryService {
       cpuModel: cpus.length ? cpus[0].model : null,
       cpuSpeed: cpus.length ? cpus[0].speed : null,
       memoryInMb: Math.trunc(os.totalmem() / Math.pow(1024, 2)),
+      isExampleProject: this.options.telemetryIsExampleProject,
     } satisfies TelemetryEventContext;
 
     return this.context;