wrangler 2.0.21 → 2.0.22

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrangler",
-	"version": "2.0.21",
+	"version": "2.0.22",
 	"description": "Command-line interface for all things Cloudflare Workers",
 	"keywords": [
 		"wrangler",
@@ -130,6 +130,7 @@
 		"ink-table": "^3.0.0",
 		"ink-testing-library": "^2.1.0",
 		"ink-text-input": "^4.0.3",
+		"is-ci": "^3.0.1",
 		"jest-fetch-mock": "^3.0.3",
 		"jest-websocket-mock": "^2.3.0",
 		"mime": "^3.0.0",

package/src/__tests__/metrics.test.ts

@@ -4,6 +4,7 @@ import { version as wranglerVersion } from "../../package.json";
 import { purgeConfigCaches, saveToConfigCache } from "../config-cache";
 import { logger } from "../logger";
 import { getMetricsDispatcher, getMetricsConfig } from "../metrics";
+import { CI } from "../metrics/is-ci";
 import {
 	CURRENT_METRICS_DATE,
 	readMetricsConfig,
@@ -200,13 +201,42 @@ describe("metrics", () => {
 	});
 
 	describe("getMetricsConfig()", () => {
+		let isCISpy: jest.SpyInstance;
+
 		const { setIsTTY } = useMockIsTTY();
 		beforeEach(() => {
 			// Default the mock TTY to interactive for all these tests.
 			setIsTTY(true);
+			isCISpy = jest.spyOn(CI, "isCI").mockReturnValue(false);
 		});
 
 		describe("enabled", () => {
+			const ORIGINAL_ENV = process.env;
+			beforeEach(() => {
+				process.env = { ...ORIGINAL_ENV };
+			});
+			afterEach(() => {
+				process.env = ORIGINAL_ENV;
+			});
+
+			it("should return the WRANGLER_SEND_METRICS environment variable for enabled if it is defined", async () => {
+				process.env.WRANGLER_SEND_METRICS = "false";
+				expect(await getMetricsConfig({})).toMatchObject({
+					enabled: false,
+				});
+				process.env.WRANGLER_SEND_METRICS = "true";
+				expect(await getMetricsConfig({})).toMatchObject({
+					enabled: true,
+				});
+			});
+
+			it("should return false if running in a CI environment", async () => {
+				isCISpy.mockReturnValue(true);
+				expect(await getMetricsConfig({})).toMatchObject({
+					enabled: false,
+				});
+			});
+
 			it("should return the sendMetrics argument for enabled if it is defined", async () => {
 				expect(
 					await getMetricsConfig({ sendMetrics: false, offline: false })

package/src/metrics/is-ci.ts

@@ -0,0 +1,14 @@
+import isCI from "is-ci";
+
+/**
+ * Use this object to find out if we are currently running in a continuous integration environment.
+ *
+ * The isCI constant imported above cannot be easily mocked for testing.
+ * By wrapping this up in a method on an object, it results in clean and testable code.
+ */
+export const CI = {
+	/** Is Wrangler currently running in a CI? */
+	isCI() {
+		return isCI;
+	},
+};

package/src/metrics/metrics-config.ts

@@ -5,9 +5,11 @@ import path from "node:path";
 import { fetchResult } from "../cfetch";
 import { getConfigCache, saveToConfigCache } from "../config-cache";
 import { confirm } from "../dialogs";
+import { getEnvironmentVariableFactory } from "../environment-variables";
 import isInteractive from "../is-interactive";
 import { logger } from "../logger";
 import { getAPIToken } from "../user";
+import { CI } from "./is-ci";
 
 /**
  * The date that the metrics being gathered was last updated in a way that would require
@@ -21,6 +23,10 @@ import { getAPIToken } from "../user";
 export const CURRENT_METRICS_DATE = new Date(2022, 6, 4);
 export const USER_ID_CACHE_PATH = "user-id.json";
 
+export const getWranglerSendMetricsFromEnv = getEnvironmentVariableFactory({
+	variableName: "WRANGLER_SEND_METRICS",
+});
+
 export interface MetricsConfigOptions {
 	/**
 	 * Defines whether to send metrics to Cloudflare:
@@ -70,6 +76,17 @@ export async function getMetricsConfig({
 	const deviceId = getDeviceId(config);
 	const userId = await getUserId(offline);
 
+	// If the WRANGLER_SEND_METRICS environment variable has been set use that
+	// and ignore everything else.
+	const sendMetricsEnv = getWranglerSendMetricsFromEnv();
+	if (sendMetricsEnv !== undefined) {
+		return {
+			enabled: sendMetricsEnv.toLowerCase() === "true",
+			deviceId,
+			userId,
+		};
+	}
+
 	// If the project is explicitly set the `send_metrics` options in `wrangler.toml`
 	// then use that and ignore any user preference.
 	if (sendMetrics !== undefined) {
@@ -89,8 +106,8 @@ export async function getMetricsConfig({
 	}
 
 	// We couldn't get the metrics permission from the project-level nor the user-level config.
-	// If we are not interactive then just bail out.
-	if (!isInteractive()) {
+	// If we are not interactive or in a CI build then just bail out.
+	if (!isInteractive() || CI.isCI()) {
 		return { enabled: false, deviceId, userId };
 	}
 

package/wrangler-dist/cli.js

@@ -11463,11 +11463,11 @@ var require_ci_info = __commonJS({
     exports2.isPR = null;
     vendors.forEach(function(vendor) {
       var envs = Array.isArray(vendor.env) ? vendor.env : [vendor.env];
-      var isCI = envs.every(function(obj) {
+      var isCI2 = envs.every(function(obj) {
         return checkEnv(obj);
       });
-      exports2[vendor.constant] = isCI;
-      if (isCI) {
+      exports2[vendor.constant] = isCI2;
+      if (isCI2) {
         exports2.name = vendor.name;
         switch (typeof vendor.pr) {
           case "string":
@@ -66376,7 +66376,7 @@ var require_ink = __commonJS({
     var dom = __importStar(require_dom());
     var instances_1 = __importDefault(require_instances());
     var App_1 = __importDefault(require_App());
-    var isCI = process.env.CI === "false" ? false : is_ci_1.default;
+    var isCI2 = process.env.CI === "false" ? false : is_ci_1.default;
     var noop = () => {
     };
     var Ink = class {
@@ -66400,7 +66400,7 @@ var require_ink = __commonJS({
             this.options.stdout.write(this.fullStaticOutput + output);
             return;
           }
-          if (isCI) {
+          if (isCI2) {
             if (hasStaticOutput) {
               this.options.stdout.write(staticOutput);
             }
@@ -66453,7 +66453,7 @@ var require_ink = __commonJS({
         if (options.patchConsole) {
           this.patchConsole();
         }
-        if (!isCI) {
+        if (!isCI2) {
           options.stdout.on("resize", this.onRender);
           this.unsubscribeResize = () => {
             options.stdout.off("resize", this.onRender);
@@ -66472,7 +66472,7 @@ var require_ink = __commonJS({
           this.options.stdout.write(data + this.fullStaticOutput + this.lastOutput);
           return;
         }
-        if (isCI) {
+        if (isCI2) {
           this.options.stdout.write(data);
           return;
         }
@@ -66489,7 +66489,7 @@ var require_ink = __commonJS({
           this.options.stdout.write(this.fullStaticOutput + this.lastOutput);
           return;
         }
-        if (isCI) {
+        if (isCI2) {
           this.options.stderr.write(data);
           return;
         }
@@ -66509,7 +66509,7 @@ var require_ink = __commonJS({
         if (typeof this.unsubscribeResize === "function") {
           this.unsubscribeResize();
         }
-        if (isCI) {
+        if (isCI2) {
           this.options.stdout.write(this.lastOutput + "\n");
         } else if (!this.options.debug) {
           this.log.done();
@@ -66533,7 +66533,7 @@ var require_ink = __commonJS({
         return this.exitPromise;
       }
       clear() {
-        if (!isCI && !this.options.debug) {
+        if (!isCI2 && !this.options.debug) {
           this.log.clear();
         }
       }
@@ -108185,6 +108185,284 @@ var require_build4 = __commonJS({
   }
 });
 
+// ../../node_modules/ci-info/vendors.json
+var require_vendors2 = __commonJS({
+  "../../node_modules/ci-info/vendors.json"(exports2, module2) {
+    module2.exports = [
+      {
+        name: "AppVeyor",
+        constant: "APPVEYOR",
+        env: "APPVEYOR",
+        pr: "APPVEYOR_PULL_REQUEST_NUMBER"
+      },
+      {
+        name: "Azure Pipelines",
+        constant: "AZURE_PIPELINES",
+        env: "SYSTEM_TEAMFOUNDATIONCOLLECTIONURI",
+        pr: "SYSTEM_PULLREQUEST_PULLREQUESTID"
+      },
+      {
+        name: "Appcircle",
+        constant: "APPCIRCLE",
+        env: "AC_APPCIRCLE"
+      },
+      {
+        name: "Bamboo",
+        constant: "BAMBOO",
+        env: "bamboo_planKey"
+      },
+      {
+        name: "Bitbucket Pipelines",
+        constant: "BITBUCKET",
+        env: "BITBUCKET_COMMIT",
+        pr: "BITBUCKET_PR_ID"
+      },
+      {
+        name: "Bitrise",
+        constant: "BITRISE",
+        env: "BITRISE_IO",
+        pr: "BITRISE_PULL_REQUEST"
+      },
+      {
+        name: "Buddy",
+        constant: "BUDDY",
+        env: "BUDDY_WORKSPACE_ID",
+        pr: "BUDDY_EXECUTION_PULL_REQUEST_ID"
+      },
+      {
+        name: "Buildkite",
+        constant: "BUILDKITE",
+        env: "BUILDKITE",
+        pr: { env: "BUILDKITE_PULL_REQUEST", ne: "false" }
+      },
+      {
+        name: "CircleCI",
+        constant: "CIRCLE",
+        env: "CIRCLECI",
+        pr: "CIRCLE_PULL_REQUEST"
+      },
+      {
+        name: "Cirrus CI",
+        constant: "CIRRUS",
+        env: "CIRRUS_CI",
+        pr: "CIRRUS_PR"
+      },
+      {
+        name: "AWS CodeBuild",
+        constant: "CODEBUILD",
+        env: "CODEBUILD_BUILD_ARN"
+      },
+      {
+        name: "Codefresh",
+        constant: "CODEFRESH",
+        env: "CF_BUILD_ID",
+        pr: { any: ["CF_PULL_REQUEST_NUMBER", "CF_PULL_REQUEST_ID"] }
+      },
+      {
+        name: "Codeship",
+        constant: "CODESHIP",
+        env: { CI_NAME: "codeship" }
+      },
+      {
+        name: "Drone",
+        constant: "DRONE",
+        env: "DRONE",
+        pr: { DRONE_BUILD_EVENT: "pull_request" }
+      },
+      {
+        name: "dsari",
+        constant: "DSARI",
+        env: "DSARI"
+      },
+      {
+        name: "Expo Application Services",
+        constant: "EAS",
+        env: "EAS_BUILD"
+      },
+      {
+        name: "GitHub Actions",
+        constant: "GITHUB_ACTIONS",
+        env: "GITHUB_ACTIONS",
+        pr: { GITHUB_EVENT_NAME: "pull_request" }
+      },
+      {
+        name: "GitLab CI",
+        constant: "GITLAB",
+        env: "GITLAB_CI",
+        pr: "CI_MERGE_REQUEST_ID"
+      },
+      {
+        name: "GoCD",
+        constant: "GOCD",
+        env: "GO_PIPELINE_LABEL"
+      },
+      {
+        name: "LayerCI",
+        constant: "LAYERCI",
+        env: "LAYERCI",
+        pr: "LAYERCI_PULL_REQUEST"
+      },
+      {
+        name: "Hudson",
+        constant: "HUDSON",
+        env: "HUDSON_URL"
+      },
+      {
+        name: "Jenkins",
+        constant: "JENKINS",
+        env: ["JENKINS_URL", "BUILD_ID"],
+        pr: { any: ["ghprbPullId", "CHANGE_ID"] }
+      },
+      {
+        name: "Magnum CI",
+        constant: "MAGNUM",
+        env: "MAGNUM"
+      },
+      {
+        name: "Netlify CI",
+        constant: "NETLIFY",
+        env: "NETLIFY",
+        pr: { env: "PULL_REQUEST", ne: "false" }
+      },
+      {
+        name: "Nevercode",
+        constant: "NEVERCODE",
+        env: "NEVERCODE",
+        pr: { env: "NEVERCODE_PULL_REQUEST", ne: "false" }
+      },
+      {
+        name: "Render",
+        constant: "RENDER",
+        env: "RENDER",
+        pr: { IS_PULL_REQUEST: "true" }
+      },
+      {
+        name: "Sail CI",
+        constant: "SAIL",
+        env: "SAILCI",
+        pr: "SAIL_PULL_REQUEST_NUMBER"
+      },
+      {
+        name: "Semaphore",
+        constant: "SEMAPHORE",
+        env: "SEMAPHORE",
+        pr: "PULL_REQUEST_NUMBER"
+      },
+      {
+        name: "Screwdriver",
+        constant: "SCREWDRIVER",
+        env: "SCREWDRIVER",
+        pr: { env: "SD_PULL_REQUEST", ne: "false" }
+      },
+      {
+        name: "Shippable",
+        constant: "SHIPPABLE",
+        env: "SHIPPABLE",
+        pr: { IS_PULL_REQUEST: "true" }
+      },
+      {
+        name: "Solano CI",
+        constant: "SOLANO",
+        env: "TDDIUM",
+        pr: "TDDIUM_PR_ID"
+      },
+      {
+        name: "Strider CD",
+        constant: "STRIDER",
+        env: "STRIDER"
+      },
+      {
+        name: "TaskCluster",
+        constant: "TASKCLUSTER",
+        env: ["TASK_ID", "RUN_ID"]
+      },
+      {
+        name: "TeamCity",
+        constant: "TEAMCITY",
+        env: "TEAMCITY_VERSION"
+      },
+      {
+        name: "Travis CI",
+        constant: "TRAVIS",
+        env: "TRAVIS",
+        pr: { env: "TRAVIS_PULL_REQUEST", ne: "false" }
+      },
+      {
+        name: "Vercel",
+        constant: "VERCEL",
+        env: "NOW_BUILDER"
+      },
+      {
+        name: "Visual Studio App Center",
+        constant: "APPCENTER",
+        env: "APPCENTER_BUILD_ID"
+      }
+    ];
+  }
+});
+
+// ../../node_modules/ci-info/index.js
+var require_ci_info2 = __commonJS({
+  "../../node_modules/ci-info/index.js"(exports2) {
+    "use strict";
+    init_import_meta_url();
+    var vendors = require_vendors2();
+    var env5 = process.env;
+    Object.defineProperty(exports2, "_vendors", {
+      value: vendors.map(function(v) {
+        return v.constant;
+      })
+    });
+    exports2.name = null;
+    exports2.isPR = null;
+    vendors.forEach(function(vendor) {
+      const envs = Array.isArray(vendor.env) ? vendor.env : [vendor.env];
+      const isCI2 = envs.every(function(obj) {
+        return checkEnv(obj);
+      });
+      exports2[vendor.constant] = isCI2;
+      if (isCI2) {
+        exports2.name = vendor.name;
+        switch (typeof vendor.pr) {
+          case "string":
+            exports2.isPR = !!env5[vendor.pr];
+            break;
+          case "object":
+            if ("env" in vendor.pr) {
+              exports2.isPR = vendor.pr.env in env5 && env5[vendor.pr.env] !== vendor.pr.ne;
+            } else if ("any" in vendor.pr) {
+              exports2.isPR = vendor.pr.any.some(function(key2) {
+                return !!env5[key2];
+              });
+            } else {
+              exports2.isPR = checkEnv(vendor.pr);
+            }
+            break;
+          default:
+            exports2.isPR = null;
+        }
+      }
+    });
+    exports2.isCI = !!(env5.CI || env5.CONTINUOUS_INTEGRATION || env5.BUILD_NUMBER || env5.RUN_ID || exports2.name || false);
+    function checkEnv(obj) {
+      if (typeof obj === "string")
+        return !!env5[obj];
+      return Object.keys(obj).every(function(k) {
+        return env5[k] === obj[k];
+      });
+    }
+  }
+});
+
+// ../../node_modules/is-ci/index.js
+var require_is_ci2 = __commonJS({
+  "../../node_modules/is-ci/index.js"(exports2, module2) {
+    "use strict";
+    init_import_meta_url();
+    module2.exports = require_ci_info2().isCI;
+  }
+});
+
 // ../../node_modules/timeago.js/lib/lang/en_US.js
 var require_en_US = __commonJS({
   "../../node_modules/timeago.js/lib/lang/en_US.js"(exports2) {
@@ -115926,7 +116204,7 @@ var import_websocket_server = __toESM(require_websocket_server2(), 1);
 var wrapper_default = import_websocket.default;
 
 // package.json
-var version = "2.0.21";
+var version = "2.0.22";
 var package_default = {
   name: "wrangler",
   version,
@@ -116059,6 +116337,7 @@ var package_default = {
     "ink-table": "^3.0.0",
     "ink-testing-library": "^2.1.0",
     "ink-text-input": "^4.0.3",
+    "is-ci": "^3.0.1",
     "jest-fetch-mock": "^3.0.3",
     "jest-websocket-mock": "^2.3.0",
     mime: "^3.0.0",
@@ -119540,9 +119819,21 @@ function select(text, options, initialIndex) {
   });
 }
 
+// src/metrics/is-ci.ts
+init_import_meta_url();
+var import_is_ci = __toESM(require_is_ci2());
+var CI = {
+  isCI() {
+    return import_is_ci.default;
+  }
+};
+
 // src/metrics/metrics-config.ts
 var CURRENT_METRICS_DATE = new Date(2022, 6, 4);
 var USER_ID_CACHE_PATH = "user-id.json";
+var getWranglerSendMetricsFromEnv = getEnvironmentVariableFactory({
+  variableName: "WRANGLER_SEND_METRICS"
+});
 async function getMetricsConfig({
   sendMetrics,
   offline = false
@@ -119550,6 +119841,14 @@ async function getMetricsConfig({
   const config = readMetricsConfig();
   const deviceId = getDeviceId(config);
   const userId = await getUserId(offline);
+  const sendMetricsEnv = getWranglerSendMetricsFromEnv();
+  if (sendMetricsEnv !== void 0) {
+    return {
+      enabled: sendMetricsEnv.toLowerCase() === "true",
+      deviceId,
+      userId
+    };
+  }
   if (sendMetrics !== void 0) {
     return { enabled: sendMetrics, deviceId, userId };
   }
@@ -119561,7 +119860,7 @@ async function getMetricsConfig({
       logger.log("Usage metrics tracking has changed since you last granted permission.");
     }
   }
-  if (!isInteractive()) {
+  if (!isInteractive() || CI.isCI()) {
     return { enabled: false, deviceId, userId };
   }
   const enabled = await confirm("Would you like to help improve Wrangler by sending usage metrics to Cloudflare?");