Add telemetry data catalog collection to wrangler deployments

Author: dario-piotrowicz

.changeset/smooth-flowers-juggle.md

@@ -0,0 +1,7 @@
+---
+"@cloudflare/workers-utils": minor
+---
+
+Add `getTelemetryDataCatalogWorkerURL` environment variable factory
+
+Adds a new environment variable factory for `TELEMETRY_DATA_CATALOG_WORKER_URL` which configures the telemetry data catalog endpoint. Also improves PackageJSON type definitions to use `Record<string, string>` for dependencies, devDependencies, and scripts fields.

.changeset/tidy-carrots-dance.md

@@ -0,0 +1,15 @@
+---
+"wrangler": minor
+---
+
+Add telemetry data catalog collection to wrangler deployments
+
+Wrangler now sends anonymized usage data to a telemetry data catalog during `wrangler deploy`. This includes:
+
+- Account ID and Worker name
+- Wrangler version and package manager used
+- Deployment timestamp
+- Binding type counts (how many KV namespaces, R2 buckets, D1 databases, etc.)
+- Project dependency information (package names and versions from package.json)
+
+This data helps the Cloudflare team understand Wrangler usage patterns. The telemetry is disabled by default during tests and can be disabled by setting `TELEMETRY_DATA_CATALOG_WORKER_URL` to an empty string.

packages/workers-utils/src/environment-variables/factory.ts

@@ -131,7 +131,10 @@ type VariableNames =
 	| "DOCKER_HOST"
 
 	/** Environment variable used to signal that the current process is being run by the open-next deploy command. */
-	| "OPEN_NEXT_DEPLOY";
+	| "OPEN_NEXT_DEPLOY"
+
+	/** URL for the telemetry data catalog worker (defaults to `""` in vitest, the production data collector worker otherwise; falsy disables collection). */
+	| "TELEMETRY_DATA_CATALOG_WORKER_URL";
 
 type DeprecatedNames =
 	| "CF_ACCOUNT_ID"

packages/workers-utils/src/environment-variables/misc-variables.ts

@@ -392,3 +392,19 @@ export const getCfFetchPathFromEnv = getEnvironmentVariableFactory({
 export const getWranglerCacheDirFromEnv = getEnvironmentVariableFactory({
 	variableName: "WRANGLER_CACHE_DIR",
 });
+
+/**
+ * `TELEMETRY_DATA_CATALOG_WORKER_URL` specifies the URL for the telemetry data catalog worker.
+ *
+ * Defaults to `""` (disabling the data collection) when running in vitest (i.e. when `typeof vitest !== "undefined"`),
+ * otherwise defaults to the production data collector worker's URL.
+ *
+ * When the value is falsy, telemetry data catalog collection is disabled.
+ */
+export const getTelemetryDataCatalogWorkerURL = getEnvironmentVariableFactory({
+	variableName: "TELEMETRY_DATA_CATALOG_WORKER_URL",
+	defaultValue: () =>
+		typeof vitest !== "undefined"
+			? ""
+			: "https://telemetry-data-catalog-collector.devprod.workers.dev",
+});

packages/workers-utils/src/parse.ts

@@ -119,9 +119,9 @@ export function parseTOML(tomlContent: string, filePath?: string): unknown {
 export type PackageJSON = {
 	name?: string;
 	version?: string;
-	devDependencies?: Record<string, unknown>;
-	dependencies?: Record<string, unknown>;
-	scripts?: Record<string, unknown>;
+	devDependencies?: Record<string, string>;
+	dependencies?: Record<string, string>;
+	scripts?: Record<string, string>;
 };
 
 /**

packages/workers-utils/src/vitest.d.ts

@@ -0,0 +1,4 @@
+declare global {
+	const vitest: unknown;
+}
+export {};

packages/workers-utils/vitest.d.ts

@@ -0,0 +1,4 @@
+declare global {
+	const vitest: unknown;
+}
+export {};

packages/wrangler/src/__tests__/deploy/assets.test.ts

@@ -4,9 +4,9 @@ import { writeWranglerConfig } from "@cloudflare/workers-utils/test-helpers";
 import { http, HttpResponse } from "msw";
 import dedent from "ts-dedent";
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { getInstalledPackageVersion } from "../../autoconfig/frameworks/utils/packages";
 import { clearOutputFilePath } from "../../output";
 import { fetchSecrets } from "../../utils/fetch-secrets";
+import { getInstalledPackageVersion } from "../../utils/packages";
 import { mockAccountId, mockApiToken } from "../helpers/mock-account-id";
 import { mockConsoleMethods } from "../helpers/mock-console";
 import { clearDialogs } from "../helpers/mock-dialogs";
@@ -54,7 +54,7 @@ vi.mock("../../package-manager", async (importOriginal) => ({
 }));
 
 vi.mock("../../autoconfig/run");
-vi.mock("../../autoconfig/frameworks/utils/packages");
+vi.mock("../../utils/packages");
 vi.mock("../../autoconfig/c3-vendor/command");
 
 describe("deploy", () => {

packages/wrangler/src/__tests__/deploy/bindings.test.ts

@@ -8,9 +8,9 @@ import { sync } from "command-exists";
 import { http, HttpResponse } from "msw";
 import * as TOML from "smol-toml";
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { getInstalledPackageVersion } from "../../autoconfig/frameworks/utils/packages";
 import { clearOutputFilePath } from "../../output";
 import { fetchSecrets } from "../../utils/fetch-secrets";
+import { getInstalledPackageVersion } from "../../utils/packages";
 import { mockAccountId, mockApiToken } from "../helpers/mock-account-id";
 import { mockConsoleMethods } from "../helpers/mock-console";
 import { clearDialogs } from "../helpers/mock-dialogs";
@@ -55,7 +55,7 @@ vi.mock("../../package-manager", async (importOriginal) => ({
 }));
 
 vi.mock("../../autoconfig/run");
-vi.mock("../../autoconfig/frameworks/utils/packages");
+vi.mock("../../utils/packages");
 vi.mock("../../autoconfig/c3-vendor/command");
 
 describe("deploy", () => {

packages/wrangler/src/__tests__/deploy/build.test.ts

@@ -11,11 +11,11 @@ import {
 import * as esbuild from "esbuild";
 import { http, HttpResponse } from "msw";
 import { afterEach, beforeEach, describe, expect, it, test, vi } from "vitest";
-import { getInstalledPackageVersion } from "../../autoconfig/frameworks/utils/packages";
 import { printBundleSize } from "../../deployment-bundle/bundle-reporter";
 import { clearOutputFilePath } from "../../output";
 import { fetchSecrets } from "../../utils/fetch-secrets";
 import { diagnoseScriptSizeError } from "../../utils/friendly-validator-errors";
+import { getInstalledPackageVersion } from "../../utils/packages";
 import { mockAccountId, mockApiToken } from "../helpers/mock-account-id";
 import { mockConsoleMethods } from "../helpers/mock-console";
 import { clearDialogs } from "../helpers/mock-dialogs";
@@ -58,7 +58,7 @@ vi.mock("../../package-manager", async (importOriginal) => ({
 }));
 
 vi.mock("../../autoconfig/run");
-vi.mock("../../autoconfig/frameworks/utils/packages");
+vi.mock("../../utils/packages");
 vi.mock("../../autoconfig/c3-vendor/command");
 
 describe("deploy", () => {