Add boolean env var factory (#9994)

* Add boolean env var factory

* fixup! Add boolean env var factory

* fix formatting

Author: petebacondarwin

packages/wrangler/src/environment-variables/factory.ts

@@ -46,6 +46,49 @@ type DeprecatedNames =
 
 type ElementType<A> = A extends readonly (infer T)[] ? T : never;
 
+/**
+ * Create a function used to access a boolean environment variable. It may return undefined if the variable is not set.
+ *
+ * This is not memoized to allow us to change the value at runtime, such as in testing.
+ *
+ * The environment variable must be either "true" or "false" (after lowercasing), otherwise it will throw an error.
+ */
+export function getBooleanEnvironmentVariableFactory(options: {
+	variableName: VariableNames;
+}): () => boolean | undefined;
+export function getBooleanEnvironmentVariableFactory(options: {
+	variableName: VariableNames;
+	defaultValue: boolean | (() => boolean);
+}): () => boolean;
+export function getBooleanEnvironmentVariableFactory(options: {
+	variableName: VariableNames;
+	defaultValue?: boolean | (() => boolean);
+}): () => boolean | undefined {
+	return () => {
+		if (
+			!(options.variableName in process.env) ||
+			process.env[options.variableName] === undefined
+		) {
+			return typeof options.defaultValue === "function"
+				? options.defaultValue()
+				: options.defaultValue;
+		}
+
+		switch (process.env[options.variableName]?.toLowerCase()) {
+			case "true":
+				return true;
+			case "false":
+				return false;
+			default:
+				throw new UserError(
+					`Expected ${options.variableName} to be "true" or "false", but got ${JSON.stringify(
+						process.env[options.variableName]
+					)}`
+				);
+		}
+	};
+}
+
 /**
  * Create a function used to access an environment variable. It may return undefined if the variable is not set.
  *

packages/wrangler/src/environment-variables/misc-variables.ts

@@ -2,7 +2,10 @@ import path from "node:path";
 import { dedent } from "ts-dedent";
 import { UserError } from "../errors";
 import { getGlobalWranglerConfigPath } from "../global-wrangler-config-path";
-import { getEnvironmentVariableFactory } from "./factory";
+import {
+	getBooleanEnvironmentVariableFactory,
+	getEnvironmentVariableFactory,
+} from "./factory";
 import type { Config } from "../config";
 
 /**
@@ -37,9 +40,10 @@ export const getC3CommandFromEnv = getEnvironmentVariableFactory({
 /**
  * `WRANGLER_SEND_METRICS` can override whether we attempt to send metrics information to Sparrow.
  */
-export const getWranglerSendMetricsFromEnv = getEnvironmentVariableFactory({
-	variableName: "WRANGLER_SEND_METRICS",
-});
+export const getWranglerSendMetricsFromEnv =
+	getBooleanEnvironmentVariableFactory({
+		variableName: "WRANGLER_SEND_METRICS",
+	});
 
 /**
  * Set `WRANGLER_API_ENVIRONMENT` environment variable to "staging" to tell Wrangler to hit the staging APIs rather than production.
@@ -139,10 +143,10 @@ function getStagingSubdomain(): string {
  *
  * By default we do, since debug logs could be added to GitHub issues and shouldn't include sensitive information.
  */
-export const getSanitizeLogs = getEnvironmentVariableFactory({
+export const getSanitizeLogs = getBooleanEnvironmentVariableFactory({
 	variableName: "WRANGLER_LOG_SANITIZE",
 	defaultValue() {
-		return "true";
+		return true;
 	},
 });
 

packages/wrangler/src/logger.ts

@@ -109,13 +109,13 @@ export class Logger {
 
 	debug = (...args: unknown[]) => this.doLog("debug", args);
 	debugWithSanitization = (label: string, ...args: unknown[]) => {
-		if (getSanitizeLogs() === "false") {
-			this.doLog("debug", [label, ...args]);
-		} else {
+		if (getSanitizeLogs()) {
 			this.doLog("debug", [
 				label,
 				"omitted; set WRANGLER_LOG_SANITIZE=false to include sanitized data",
 			]);
+		} else {
+			this.doLog("debug", [label, ...args]);
 		}
 	};
 	info = (...args: unknown[]) => this.doLog("info", args);

packages/wrangler/src/metrics/commands.ts

@@ -61,10 +61,7 @@ export const telemetryStatusCommand = createCommand({
 		const savedConfig = readMetricsConfig();
 		const sendMetricsEnv = getWranglerSendMetricsFromEnv();
 		if (config.send_metrics !== undefined || sendMetricsEnv !== undefined) {
-			const resolvedPermission =
-				sendMetricsEnv !== undefined
-					? sendMetricsEnv === "true"
-					: config.send_metrics;
+			const resolvedPermission = sendMetricsEnv ?? config.send_metrics;
 			logger.log(
 				`Status: ${resolvedPermission ? chalk.green("Enabled") : chalk.red("Disabled")} (set by ${sendMetricsEnv !== undefined ? "environment variable" : "wrangler.toml"})\n`
 			);

packages/wrangler/src/metrics/metrics-config.ts

@@ -66,7 +66,7 @@ export function getMetricsConfig({
 	const sendMetricsEnv = getWranglerSendMetricsFromEnv();
 	if (sendMetricsEnv !== undefined) {
 		return {
-			enabled: sendMetricsEnv.toLowerCase() === "true",
+			enabled: sendMetricsEnv,
 			deviceId,
 		};
 	}