CI/CD necessary variable checks:

Added a check in CI/CD environments for `account_id`, `CLOUDFLARE_ACCOUNT_ID` and `CLOUDFLARE_API_TOKEN`. If `account_id` exists in `wrangler.toml`
then `CLOUDFLARE_ACCOUNT_ID` is not needed in CI/CD scope. The `CLOUDFLARE_API_TOKEN` is necessary in CI/CD scope and will always error if missing.

resolves #827

Author: JacobMGEvans

.changeset/eighty-yaks-jump.md

@@ -0,0 +1,8 @@
+---
+"wrangler": patch
+---
+
+feat: Added a check in CI/CD environments for `account_id`, `CLOUDFLARE_ACCOUNT_ID` and `CLOUDFLARE_API_TOKEN`. If `account_id` exists in `wrangler.toml`
+then `CLOUDFLARE_ACCOUNT_ID` is not needed in CI/CD scope. The `CLOUDFLARE_API_TOKEN` is necessary in CI/CD scope and will always error if missing.
+
+resolves #827

package-lock.json

@@ -63,6 +63,7 @@
     "@types/ws": "^8.5.3",
     "@types/yargs": "^17.0.10",
     "chokidar": "^3.5.3",
+    "ci-info": "^3.3.0",
     "clipboardy": "^3.0.0",
     "cmd-shim": "^4.1.0",
     "command-exists": "^1.2.9",

packages/wrangler/package.json

@@ -0,0 +1,91 @@
+import ci from "ci-info";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { runInTempDir } from "./helpers/run-in-tmp";
+import { runWrangler } from "./helpers/run-wrangler";
+import writeWranglerToml from "./helpers/write-wrangler-toml";
+
+const std = mockConsoleMethods();
+void std; // Keeps the console quiet
+runInTempDir();
+
+const ENV_COPY = process.env;
+
+beforeEach(() => {
+  jest.resetModules();
+  jest.mock("ci-info");
+  (ci.isCI as jest.Mocked<boolean>) = true;
+});
+
+afterEach(() => {
+  process.env = ENV_COPY;
+});
+
+afterAll(() => {
+  jest.unmock("ci-info");
+});
+
+it("should not throw an error in CI if 'CLOUDFLARE_API_TOKEN' & 'account_id' are in scope", async () => {
+  writeWranglerToml({
+    account_id: "IG-88",
+  });
+
+  process.env = {
+    CLOUDFLARE_API_TOKEN: "123456789",
+  };
+
+  await runWrangler().catch((err) => {
+    expect(err).toMatchInlineSnapshot(`""`);
+  });
+});
+
+it("should not throw an error if 'CLOUDFLARE_ACCOUNT_ID' & 'CLOUDFLARE_API_TOKEN' are in scope", async () => {
+  process.env = {
+    CLOUDFLARE_API_TOKEN: "hunter2",
+    CLOUDFLARE_ACCOUNT_ID: "IG-88",
+  };
+
+  await runWrangler().catch((err) => {
+    expect(err).toMatchInlineSnapshot(`""`);
+  });
+});
+
+it("should throw an error in CI if 'account_id' & 'CLOUDFLARE_ACCOUNT_ID' is missing", async () => {
+  writeWranglerToml({
+    account_id: undefined,
+  });
+
+  process.env = {
+    CLOUDFLARE_API_TOKEN: "hunter2",
+    CLOUDFLARE_ACCOUNT_ID: undefined,
+  };
+
+  await runWrangler().catch((err) => {
+    expect(err).toMatchInlineSnapshot(
+      `[Error: Missing "account_id" from "wrangler.toml" and "CLOUDFLARE_ACCOUNT_ID" from CI environment, one is required, please see docs for more info: TBD]`
+    );
+  });
+});
+
+it("should throw error in CI if 'CLOUDFLARE_API_TOKEN' is missing", async () => {
+  writeWranglerToml({
+    account_id: undefined,
+  });
+
+  process.env = {
+    CLOUDFLARE_API_TOKEN: undefined,
+    CLOUDFLARE_ACCOUNT_ID: "badwolf",
+  };
+  await runWrangler().catch((err) => {
+    expect(err).toMatchInlineSnapshot(
+      `[Error: Missing "CLOUDFLARE_API_TOKEN" from CI environment, please see docs for more info: TBD]`
+    );
+  });
+});
+
+it("should throw errors in CI if 'CLOUDFLARE_API_TOKEN', 'account_id' & 'CLOUDFLARE_ACCOUNT_ID is missing", async () => {
+  await runWrangler().catch((err) => {
+    expect(err).toMatchInlineSnapshot(
+      `[Error: Missing "account_id" from "wrangler.toml" and "CLOUDFLARE_ACCOUNT_ID" "CLOUDFLARE_API_TOKEN" from CI environment, please see docs for more info: TBD]`
+    );
+  });
+});

packages/wrangler/src/__tests__/ci.test.ts

@@ -131,12 +131,9 @@ describe("Error Reporting", () => {
 
     await reportError(new Error("test error"), "testFalse");
 
-    const { error_tracking_opt, error_tracking_opt_date } = TOML.parse(
-      await fsp.readFile(path.join(os.homedir(), reportingTOMLPath), "utf-8")
-    );
-
-    expect(error_tracking_opt).toBe(false);
-    expect(error_tracking_opt_date).toBeTruthy();
+    expect(
+      fs.existsSync(path.join(os.homedir(), reportingTOMLPath, "utf-8"))
+    ).toBe(false);
 
     expect(Sentry.captureException).not.toHaveBeenCalledWith(
       new Error("test error")

packages/wrangler/src/__tests__/sentry.test.ts

@@ -4,6 +4,7 @@ import path from "node:path";
 import { setTimeout } from "node:timers/promises";
 import TOML from "@iarna/toml";
 import chalk from "chalk";
+import ci from "ci-info";
 import { findUp } from "find-up";
 import getPort from "get-port";
 import { render } from "ink";

packages/wrangler/src/index.tsx

@@ -11,6 +11,7 @@ import {
   Integrations,
   setContext,
 } from "@sentry/node";
+import ci from "ci-info";
 import { execaSync } from "execa";
 import prompts from "prompts";
 import * as pkj from "../package.json";
@@ -92,7 +93,8 @@ function exceptionTransaction(error: Error, origin = "") {
 }
 
 export async function reportError(err: Error, origin = "") {
-  if (!process.stdout.isTTY) return await appendReportingDecision("false");
+  // If the user has not opted in to error reporting, we don't want to do anything in CI or non-interactive environments
+  if (!process.stdout.isTTY || ci.isCI) return;
 
   const errorTrackingOpt = await reportingPermission();
 

packages/wrangler/src/reporting.ts

@@ -214,12 +214,14 @@ import path from "node:path";
 import url from "node:url";
 import { TextEncoder } from "node:util";
 import TOML from "@iarna/toml";
+import ci from "ci-info";
 import { render, Text } from "ink";
 import SelectInput from "ink-select-input";
 import Table from "ink-table";
 import React from "react";
 import { fetch } from "undici";
 import { getCloudflareApiBaseUrl } from "./cfetch";
+import { readConfig } from "./config";
 import { getEnvironmentVariableFactory } from "./environment-variables";
 import openInBrowser from "./open-in-browser";
 import { parseTOML, readFileSync } from "./parse";
@@ -383,6 +385,38 @@ function getAuthTokens(config?: UserAuthConfig): AuthTokens {
   }
 }
 
+/**
+ * Inside a CI/CD environment, you want to check if all the required variables are in scope
+ * and if not, throw a helpful error message with missing variables and documentation link.
+ */
+function ciCheck() {
+  if (ci.isCI) {
+    const config = readConfig(undefined, {});
+
+    if (
+      !process.env.CLOUDFLARE_API_TOKEN &&
+      !config.account_id &&
+      !process.env.CLOUDFLARE_ACCOUNT_ID
+    ) {
+      throw new Error(
+        `Missing "account_id" from "wrangler.toml" and "CLOUDFLARE_ACCOUNT_ID" "CLOUDFLARE_API_TOKEN" from CI environment, please see docs for more info: TBD`
+      );
+    }
+
+    if (!process.env.CLOUDFLARE_API_TOKEN) {
+      throw new Error(
+        `Missing "CLOUDFLARE_API_TOKEN" from CI environment, please see docs for more info: TBD`
+      );
+    }
+
+    if (!config.account_id && !process.env.CLOUDFLARE_ACCOUNT_ID) {
+      throw new Error(
+        `Missing "account_id" from "wrangler.toml" and "CLOUDFLARE_ACCOUNT_ID" from CI environment, one is required, please see docs for more info: TBD`
+      );
+    }
+  }
+}
+
 /**
  * Run the initialisation of the auth state, in the case that something changed.
  *
@@ -402,6 +436,7 @@ export function reinitialiseAuthTokens(config?: UserAuthConfig): void {
 }
 
 export function getAPIToken(): string | undefined {
+  ciCheck();
   if (LocalState.apiToken) {
     console.warn(
       "It looks like you have used Wrangler 1's `config` command to login with an API token.\n" +
@@ -1071,6 +1106,7 @@ export function listScopes(message = "💁 Available scopes:"): void {
 export async function getAccountId(
   isInteractive = true
 ): Promise<string | undefined> {
+  ciCheck();
   const apiToken = getAPIToken();
   if (!apiToken) return;