refactor collectAsyncMetrics

cloudflare · Aug 22, 2024 · 543f3da · 543f3da
1 parent cf9827e
commit 543f3da
Show file tree

Hide file tree

Showing 5 changed files with 356 additions and 256 deletions.
diff --git a/packages/create-cloudflare/src/__tests__/metrics.test.ts b/packages/create-cloudflare/src/__tests__/metrics.test.ts
@@ -1,9 +1,12 @@
+import { off } from "process";
 import { CancelError } from "@cloudflare/cli/error";
 import { sendEvent } from "helpers/sparrow";
 import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
 import { collectCLIOutput, normalizeOutput } from "../../../cli/test-util";
+import { version as c3Version } from "../../package.json";
 import {
 	getDeviceId,
+	getSessionId,
 	getUserId,
 	readMetricsConfig,
 	writeMetricsConfig,
@@ -20,6 +23,11 @@ vi.mock("helpers/sparrow");
 describe("createReporter", () => {
 	const deviceId = "test-device-id";
 	const userId = "test-user-id";
+	const sessionId = "session-id-for-test-only";
+	const os = {
+		platform: process.platform,
+		arch: process.arch,
+	};
 
 	beforeEach(() => {
 		vi.useFakeTimers();
@@ -31,6 +39,7 @@ describe("createReporter", () => {
 		});
 		vi.mocked(getDeviceId).mockReturnValue(deviceId);
 		vi.mocked(getUserId).mockReturnValue(userId);
+		vi.mocked(getSessionId).mockReturnValue(sessionId);
 	});
 
 	afterEach(() => {
@@ -43,10 +52,10 @@ describe("createReporter", () => {
 		const reporter = createReporter();
 		const process = reporter.collectAsyncMetrics({
 			eventPrefix: "c3 session",
-			props: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+			startedProps: {
+				args: {
+					projectName: "app",
+				},
 			},
 			promise: () => promise,
 		});
@@ -57,9 +66,12 @@ describe("createReporter", () => {
 			userId,
 			timestamp: Date.now(),
 			properties: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+				sessionId,
+				c3Version,
+				os,
+				args: {
+					projectName: "app",
+				},
 			},
 		});
 		expect(sendEvent).toBeCalledTimes(1);
@@ -76,9 +88,12 @@ describe("createReporter", () => {
 			userId,
 			timestamp: Date.now(),
 			properties: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+				sessionId,
+				c3Version,
+				os,
+				args: {
+					projectName: "app",
+				},
 				durationMs: 1234,
 			},
 		});
@@ -90,10 +105,10 @@ describe("createReporter", () => {
 		const reporter = createReporter();
 		const process = reporter.collectAsyncMetrics({
 			eventPrefix: "c3 session",
-			props: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+			startedProps: {
+				args: {
+					projectName: "app",
+				},
 			},
 			promise: () => promise,
 		});
@@ -104,9 +119,12 @@ describe("createReporter", () => {
 			userId,
 			timestamp: Date.now(),
 			properties: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+				sessionId,
+				c3Version,
+				os,
+				args: {
+					projectName: "app",
+				},
 			},
 		});
 		expect(sendEvent).toBeCalledTimes(1);
@@ -122,9 +140,12 @@ describe("createReporter", () => {
 			userId,
 			timestamp: Date.now(),
 			properties: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+				sessionId,
+				c3Version,
+				os,
+				args: {
+					projectName: "app",
+				},
 				durationMs: 1234,
 			},
 		});
@@ -136,10 +157,8 @@ describe("createReporter", () => {
 		const reporter = createReporter();
 		const process = reporter.collectAsyncMetrics({
 			eventPrefix: "c3 session",
-			props: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+			startedProps: {
+				args: { projectName: "app" },
 			},
 			promise: () => promise,
 		});
@@ -150,9 +169,12 @@ describe("createReporter", () => {
 			userId,
 			timestamp: Date.now(),
 			properties: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+				sessionId,
+				c3Version,
+				os,
+				args: {
+					projectName: "app",
+				},
 			},
 		});
 		expect(sendEvent).toBeCalledTimes(1);
@@ -168,9 +190,12 @@ describe("createReporter", () => {
 			userId,
 			timestamp: Date.now(),
 			properties: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+				sessionId,
+				c3Version,
+				os,
+				args: {
+					projectName: "app",
+				},
 				durationMs: 1234,
 				error: {
 					message: "test error",
@@ -187,10 +212,10 @@ describe("createReporter", () => {
 
 		const run = reporter.collectAsyncMetrics({
 			eventPrefix: "c3 session",
-			props: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+			startedProps: {
+				args: {
+					projectName: "app",
+				},
 			},
 			promise: () => promise,
 		});
@@ -201,9 +226,12 @@ describe("createReporter", () => {
 			userId,
 			timestamp: Date.now(),
 			properties: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+				sessionId,
+				c3Version,
+				os,
+				args: {
+					projectName: "app",
+				},
 			},
 		});
 		expect(sendEvent).toBeCalledTimes(1);
@@ -219,9 +247,12 @@ describe("createReporter", () => {
 			userId,
 			timestamp: Date.now(),
 			properties: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+				sessionId,
+				c3Version,
+				os,
+				args: {
+					projectName: "app",
+				},
 				durationMs: 1234,
 			},
 		});
@@ -233,10 +264,10 @@ describe("createReporter", () => {
 		const reporter = createReporter();
 		const run = reporter.collectAsyncMetrics({
 			eventPrefix: "c3 session",
-			props: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+			startedProps: {
+				args: {
+					projectName: "app",
+				},
 			},
 			promise: () => promise,
 		});
@@ -247,9 +278,12 @@ describe("createReporter", () => {
 			userId,
 			timestamp: Date.now(),
 			properties: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+				sessionId,
+				c3Version,
+				os,
+				args: {
+					projectName: "app",
+				},
 			},
 		});
 		expect(sendEvent).toBeCalledTimes(1);
@@ -265,9 +299,12 @@ describe("createReporter", () => {
 			userId,
 			timestamp: Date.now(),
 			properties: {
-				sessionId: "example",
-				c3Version: "1.2.3",
-				os: { platform: "cf", arch: "test" },
+				sessionId,
+				c3Version,
+				os,
+				args: {
+					projectName: "app",
+				},
 				durationMs: 1234,
 			},
 		});

diff --git a/packages/create-cloudflare/src/cli.ts b/packages/create-cloudflare/src/cli.ts
@@ -82,7 +82,7 @@ export const main = async (argv: string[]) => {
 	} else {
 		await reporter.collectAsyncMetrics({
 			eventPrefix: "c3 session",
-			props: {
+			startedProps: {
 				args,
 			},
 			promise: () => runCli(args),