wrangler 0.0.0-e2a26a0 → 0.0.0-e3a458e

package/src/__tests__/guess-worker-format.test.ts

@@ -0,0 +1,58 @@
+import { writeFile } from "fs/promises";
+import path from "path";
+import guessWorkerFormat from "../entry";
+import { runInTempDir } from "./helpers/run-in-tmp";
+
+describe("guess worker format", () => {
+  runInTempDir();
+  it('should detect a "modules" worker', async () => {
+    await writeFile("./index.ts", "export default {};");
+    // Note that this isn't actually a valid worker, because it's missing
+    // a fetch handler. Regardless, our heuristic is simply to check for exports.
+    const guess = await guessWorkerFormat(
+      path.join(process.cwd(), "./index.ts"),
+      process.cwd(),
+      undefined
+    );
+    expect(guess).toBe("modules");
+  });
+
+  it('should detect a "service-worker" worker', async () => {
+    await writeFile("./index.ts", "");
+    // Note that this isn't actually a valid worker, because it's missing
+    // a fetch listener. Regardless, our heuristic is simply to check for
+    // the lack of exports.
+    const guess = await guessWorkerFormat(
+      path.join(process.cwd(), "./index.ts"),
+      process.cwd(),
+      undefined
+    );
+    expect(guess).toBe("service-worker");
+  });
+
+  it("should throw an error when the hint doesn't match the guess (modules - service-worker)", async () => {
+    await writeFile("./index.ts", "export default {};");
+    await expect(
+      guessWorkerFormat(
+        path.join(process.cwd(), "./index.ts"),
+        process.cwd(),
+        "service-worker"
+      )
+    ).rejects.toThrow(
+      "You configured this worker to be a 'service-worker', but the file you are trying to build appears to have ES module exports. Please pass `--format modules`, or simply remove the configuration."
+    );
+  });
+
+  it("should throw an error when the hint doesn't match the guess (service-worker - modules)", async () => {
+    await writeFile("./index.ts", "");
+    await expect(
+      guessWorkerFormat(
+        path.join(process.cwd(), "./index.ts"),
+        process.cwd(),
+        "modules"
+      )
+    ).rejects.toThrow(
+      "You configured this worker to be 'modules', but the file you are trying to build doesn't export a handler. Please pass `--format service-worker`, or simply remove the configuration."
+    );
+  });
+});

package/src/__tests__/helpers/faye-websocket.d.ts

@@ -0,0 +1,6 @@
+module "faye-websocket" {
+  /**
+   * Standards-compliant WebSocket client and server.
+   */
+  export default WebSocket;
+}

package/src/__tests__/helpers/mock-account-id.ts

@@ -1,30 +1,48 @@
-const ORIGINAL_CF_API_TOKEN = process.env.CF_API_TOKEN;
-const ORIGINAL_CF_ACCOUNT_ID = process.env.CF_ACCOUNT_ID;
+import { reinitialiseAuthTokens } from "../../user";
+
+const ORIGINAL_CLOUDFLARE_API_TOKEN = process.env.CLOUDFLARE_API_TOKEN;
+const ORIGINAL_CLOUDFLARE_ACCOUNT_ID = process.env.CLOUDFLARE_ACCOUNT_ID;
 
 /**
  * Mock the API token so that we don't need to read it from user configuration files.
+ *
+ * Note that you can remove any API token from the environment by setting the value to `null`.
+ * This is useful if a higher `describe()` block has already called `mockApiToken()`.
  */
 export function mockApiToken({
   apiToken = "some-api-token",
-}: { apiToken?: string } = {}) {
+}: { apiToken?: string | null } = {}) {
   beforeEach(() => {
-    process.env.CF_API_TOKEN = apiToken;
+    if (apiToken === null) {
+      delete process.env.CLOUDFLARE_API_TOKEN;
+    } else {
+      process.env.CLOUDFLARE_API_TOKEN = apiToken;
+    }
+    // Now we have updated the environment, we must reinitialize the user auth state.
+    reinitialiseAuthTokens();
   });
   afterEach(() => {
-    process.env.CF_API_TOKEN = ORIGINAL_CF_API_TOKEN;
+    process.env.CLOUDFLARE_API_TOKEN = ORIGINAL_CLOUDFLARE_API_TOKEN;
   });
 }
 
 /**
  * Mock the current account ID so that we don't need to read it from configuration files.
+ *
+ * Note that you can remove any account ID from the environment by setting the value to `null`.
+ * This is useful if a higher `describe()` block has already called `mockAccountId()`.
  */
 export function mockAccountId({
   accountId = "some-account-id",
-}: { accountId?: string } = {}) {
+}: { accountId?: string | null } = {}) {
   beforeEach(() => {
-    process.env.CF_ACCOUNT_ID = accountId;
+    if (accountId === null) {
+      delete process.env.CLOUDFLARE_ACCOUNT_ID;
+    } else {
+      process.env.CLOUDFLARE_ACCOUNT_ID = accountId;
+    }
   });
   afterEach(() => {
-    process.env.CF_ACCOUNT_ID = ORIGINAL_CF_ACCOUNT_ID;
+    process.env.CLOUDFLARE_ACCOUNT_ID = ORIGINAL_CLOUDFLARE_ACCOUNT_ID;
   });
 }

package/src/__tests__/helpers/mock-bin.ts

@@ -7,7 +7,10 @@ const nodeShebang = "#!/usr/bin/env node";
 /**
  * Create a binary file in a temp directory and make it available on the PATH.
  */
-export async function mockBinary(binaryName: string, code: string) {
+export async function mockBinary(
+  binaryName: string,
+  code: string
+): Promise<() => void> {
   // Ensure there is a directory to put the mock binary in.
   const tmpDir = resolve(mkdtempSync(".mock-binary-"));
 

package/src/__tests__/helpers/mock-cfetch.ts

@@ -1,7 +1,7 @@
 import { URL, URLSearchParams } from "node:url";
 import { pathToRegexp } from "path-to-regexp";
-import { CF_API_BASE_URL } from "../../cfetch";
-import type { FetchResult } from "../../cfetch";
+import { getCloudflareApiBaseUrl } from "../../cfetch";
+import type { FetchResult, FetchError } from "../../cfetch";
 import type { RequestInit } from "undici";
 
 /**
@@ -35,7 +35,7 @@ export async function mockFetchInternal(
   queryParams: URLSearchParams = new URLSearchParams()
 ) {
   for (const { regexp, method, handler } of mocks) {
-    const resourcePath = new URL(resource, CF_API_BASE_URL).pathname;
+    const resourcePath = new URL(resource, getCloudflareApiBaseUrl()).pathname;
     const uri = regexp.exec(resourcePath);
     // Do the resource path and (if specified) the HTTP method match?
     if (uri !== null && (!method || method === (init.method ?? "GET"))) {
@@ -143,8 +143,8 @@ export function setMockResponse<ResponseType>(
 export async function createFetchResult<ResponseType>(
   result: ResponseType | Promise<ResponseType>,
   success = true,
-  errors = [],
-  messages = [],
+  errors: FetchError[] = [],
+  messages: string[] = [],
   result_info?: unknown
 ): Promise<FetchResult<ResponseType>> {
   return result_info

package/src/__tests__/helpers/mock-console.ts

@@ -1,3 +1,5 @@
+import * as util from "node:util";
+
 /**
  * We use this module to mock console methods, and optionally
  * assert on the values they're called with in our tests.
@@ -9,20 +11,28 @@ let logSpy: jest.SpyInstance,
 
 const std = {
   get out() {
-    return normalizeSlashes(stripTimings(logSpy.mock.calls.flat(2).join("\n")));
+    return normalizeOutput(logSpy);
   },
   get err() {
-    return normalizeSlashes(
-      stripTimings(errorSpy.mock.calls.flat(2).join("\n"))
-    );
+    return normalizeOutput(errorSpy);
   },
   get warn() {
-    return normalizeSlashes(
-      stripTimings(warnSpy.mock.calls.flat(2).join("\n"))
-    );
+    return normalizeOutput(warnSpy);
   },
 };
 
+function normalizeOutput(spy: jest.SpyInstance): string {
+  return stripTrailingWhitespace(
+    normalizeSlashes(stripTimings(captureCalls(spy)))
+  );
+}
+
+function captureCalls(spy: jest.SpyInstance): string {
+  return spy.mock.calls
+    .map((args: unknown[]) => util.format("%s", ...args))
+    .join("\n");
+}
+
 export function mockConsoleMethods() {
   beforeEach(() => {
     logSpy = jest.spyOn(console, "log").mockImplementation();
@@ -54,3 +64,7 @@ export function normalizeSlashes(str: string): string {
 export function stripTimings(stdout: string): string {
   return stdout.replace(/\(\d+\.\d+ sec\)/g, "(TIMINGS)");
 }
+
+export function stripTrailingWhitespace(str: string): string {
+  return str.replace(/[^\S\n]+\n/g, "\n");
+}

package/src/__tests__/helpers/mock-kv.ts

@@ -1,18 +1,15 @@
 import { createFetchResult, setMockRawResponse } from "./mock-cfetch";
+import type { NamespaceKeyInfo } from "../../kv";
 
 export function mockKeyListRequest(
   expectedNamespaceId: string,
-  expectedKeys: string[],
+  expectedKeys: NamespaceKeyInfo[],
   keysPerRequest = 1000,
   blankCursorValue: "" | undefined | null = undefined
 ) {
   const requests = { count: 0 };
   // See https://api.cloudflare.com/#workers-kv-namespace-list-a-namespace-s-keys
-  const expectedKeyObjects = expectedKeys.map((name) => ({
-    name,
-    expiration: 123456789,
-    metadata: {},
-  }));
+
   setMockRawResponse(
     "/accounts/:accountId/storage/kv/namespaces/:namespaceId/keys",
     "GET",
@@ -20,19 +17,15 @@ export function mockKeyListRequest(
       requests.count++;
       expect(accountId).toEqual("some-account-id");
       expect(namespaceId).toEqual(expectedNamespaceId);
-      if (expectedKeyObjects.length <= keysPerRequest) {
-        return createFetchResult(expectedKeyObjects);
+      if (expectedKeys.length <= keysPerRequest) {
+        return createFetchResult(expectedKeys);
       } else {
         const start = parseInt(query.get("cursor") ?? "0") || 0;
         const end = start + keysPerRequest;
-        const cursor = end < expectedKeyObjects.length ? end : blankCursorValue;
-        return createFetchResult(
-          expectedKeyObjects.slice(start, end),
-          true,
-          [],
-          [],
-          { cursor }
-        );
+        const cursor = end < expectedKeys.length ? end : blankCursorValue;
+        return createFetchResult(expectedKeys.slice(start, end), true, [], [], {
+          cursor,
+        });
       }
     }
   );

package/src/__tests__/helpers/mock-stdin.ts

@@ -0,0 +1,103 @@
+const ORIGINAL_STDIN = process.stdin;
+
+/**
+ * Mock process.stdin so that we can pipe in text for non-interactive mode tests.
+ */
+export function useMockStdin({ isTTY }: { isTTY: boolean }) {
+  const mockStdin = new MockStdIn(isTTY);
+
+  beforeEach(() => {
+    mockStdin.reset();
+    Object.defineProperty(process, "stdin", {
+      value: mockStdin,
+      configurable: true,
+      writable: false,
+    });
+  });
+
+  afterEach(() => {
+    Object.defineProperty(process, "stdin", {
+      value: ORIGINAL_STDIN,
+      configurable: true,
+      writable: false,
+    });
+  });
+
+  return mockStdin;
+}
+
+const failCallback: (value: unknown) => void = () => {
+  throw new Error(
+    "TEST FAILURE: stdin callback called before being initialized."
+  );
+};
+
+/**
+ * A mock version of `process.std`, which can be used to simulate piping data
+ * into the wrangler process in non-interactive mode.
+ */
+class MockStdIn {
+  private endCallback = failCallback;
+  private errorCallback = failCallback;
+  private chunks: string[] = [];
+  private error: Error | undefined;
+
+  /**
+   * Set this to true if you want the stdin stream to error.
+   */
+  throwError(error: Error) {
+    this.error = error;
+  }
+
+  /**
+   * Call this to clean out the chunks that are queued for sending.
+   */
+  reset() {
+    this.chunks.length = 0;
+    this.error = undefined;
+  }
+
+  /**
+   * Queue up some chunks to be sent.
+   */
+  send(...chunks: string[]) {
+    this.chunks.push(...chunks);
+  }
+
+  constructor(
+    /**
+     * Used by wrangler to check whether stdin is interactive.
+     */
+    readonly isTTY: boolean
+  ) {}
+
+  /**
+   * Used by wrangler to add event listeners.
+   */
+  on(eventName: string, callback: () => void) {
+    switch (eventName) {
+      case "readable":
+        setImmediate(callback);
+        break;
+      case "end":
+        this.endCallback = callback;
+        break;
+      case "error":
+        this.errorCallback = callback;
+        break;
+    }
+  }
+
+  /**
+   * Used by wrangler to get the next chunk of data in the stream.
+   */
+  read() {
+    if (this.error) {
+      setImmediate(() => this.errorCallback(this.error));
+    }
+    if (this.chunks.length === 0) {
+      setImmediate(this.endCallback);
+    }
+    return this.chunks.shift() ?? null;
+  }
+}

package/src/__tests__/helpers/mock-web-socket.ts

@@ -0,0 +1,29 @@
+import { WebSocket } from "mock-socket";
+
+/**
+ * A version of the mock WebSocket that supports the methods that we use.
+ */
+export class MockWebSocket extends WebSocket {
+  on(event: string | symbol, listener: (...args: unknown[]) => void): this {
+    switch (event) {
+      case "message":
+        this.onmessage = ({ data }) => {
+          listener(data);
+        };
+        break;
+      case "open":
+        this.onopen = listener;
+        break;
+      case "close":
+        this.onclose = listener;
+        break;
+      default:
+        throw new Error("Unknown event type: " + event.toString());
+    }
+    return this;
+  }
+
+  terminate() {
+    this.close();
+  }
+}

package/src/__tests__/helpers/run-in-tmp.ts

@@ -1,6 +1,7 @@
 import * as fs from "node:fs";
 import os from "node:os";
 import * as path from "node:path";
+import { reinitialiseAuthTokens } from "../../user";
 
 const originalCwd = process.cwd();
 
@@ -19,6 +20,8 @@ export function runInTempDir({ homedir }: { homedir?: string } = {}) {
       // This is because the module gets transpiled so that the "method" `homedir()` gets converted to a
       // getter that is not configurable (and so cannot be spied upon).
       jest.spyOn(os, "homedir").mockReturnValue(homedir);
+      // Now that we have changed the home directory location, we must reinitialize the user auth state
+      reinitialiseAuthTokens();
     }
   });
 

package/src/__tests__/helpers/run-wrangler.ts

@@ -7,8 +7,10 @@ import { normalizeSlashes, stripTimings } from "./mock-console";
 export async function runWrangler(cmd?: string) {
   try {
     await main(cmd?.split(" ") ?? []);
-  } catch (e) {
-    e.message = normalizeSlashes(stripTimings(e.message));
-    throw e;
+  } catch (err) {
+    if (err instanceof Error) {
+      err.message = normalizeSlashes(stripTimings(err.message));
+    }
+    throw err;
   }
 }

package/src/__tests__/helpers/write-wrangler-toml.ts

@@ -0,0 +1,17 @@
+import * as fs from "fs";
+import TOML from "@iarna/toml";
+import type { RawConfig } from "../../config";
+
+/** Write a mock wrangler.toml file to disk. */
+export default function writeWranglerToml(config: RawConfig = {}) {
+  fs.writeFileSync(
+    "./wrangler.toml",
+    TOML.stringify({
+      compatibility_date: "2022-01-12",
+      name: "test-name",
+      ...(config as TOML.JsonMap),
+    }),
+
+    "utf-8"
+  );
+}

package/src/__tests__/https-options.test.ts

@@ -0,0 +1,127 @@
+import fs from "node:fs";
+import os from "node:os";
+import { resolve } from "node:path";
+import { getHttpsOptions } from "../https-options";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { runInTempDir } from "./helpers/run-in-tmp";
+
+describe("getHttpsOptions()", () => {
+  runInTempDir({ homedir: "./home" });
+  const std = mockConsoleMethods();
+
+  it("should use cached values if they have not expired", async () => {
+    fs.mkdirSync(resolve(os.homedir(), ".wrangler/local-cert"), {
+      recursive: true,
+    });
+    fs.writeFileSync(
+      resolve(os.homedir(), ".wrangler/local-cert/key.pem"),
+      "PRIVATE KEY"
+    );
+    fs.writeFileSync(
+      resolve(os.homedir(), ".wrangler/local-cert/cert.pem"),
+      "PUBLIC KEY"
+    );
+    const result = await getHttpsOptions();
+    expect(result.key).toEqual("PRIVATE KEY");
+    expect(result.cert).toEqual("PUBLIC KEY");
+    expect(std.out).toMatchInlineSnapshot(`""`);
+    expect(std.warn).toMatchInlineSnapshot(`""`);
+    expect(std.err).toMatchInlineSnapshot(`""`);
+  });
+
+  it("should generate and cache new keys if none are cached", async () => {
+    const result = await getHttpsOptions();
+    const key = fs.readFileSync(
+      resolve(os.homedir(), ".wrangler/local-cert/key.pem"),
+      "utf8"
+    );
+    const cert = fs.readFileSync(
+      resolve(os.homedir(), ".wrangler/local-cert/cert.pem"),
+      "utf8"
+    );
+    expect(result.key).toEqual(key);
+    expect(result.cert).toEqual(cert);
+    expect(std.out).toMatchInlineSnapshot(
+      `"Generating new self-signed certificate..."`
+    );
+    expect(std.warn).toMatchInlineSnapshot(`""`);
+    expect(std.err).toMatchInlineSnapshot(`""`);
+  });
+
+  it("should generate and cache new keys if cached files have expired", async () => {
+    fs.mkdirSync(resolve(os.homedir(), ".wrangler/local-cert"), {
+      recursive: true,
+    });
+    const ORIGINAL_KEY = "EXPIRED PRIVATE KEY";
+    const ORIGINAL_CERT = "EXPIRED PUBLIC KEY";
+    fs.writeFileSync(
+      resolve(os.homedir(), ".wrangler/local-cert/key.pem"),
+      ORIGINAL_KEY
+    );
+    fs.writeFileSync(
+      resolve(os.homedir(), ".wrangler/local-cert/cert.pem"),
+      ORIGINAL_CERT
+    );
+    mockStatSync(/\.pem$/, { mtimeMs: new Date(2000).valueOf() });
+
+    const result = await getHttpsOptions();
+    const key = fs.readFileSync(
+      resolve(os.homedir(), ".wrangler/local-cert/key.pem"),
+      "utf8"
+    );
+    const cert = fs.readFileSync(
+      resolve(os.homedir(), ".wrangler/local-cert/cert.pem"),
+      "utf8"
+    );
+    expect(key).not.toEqual(ORIGINAL_KEY);
+    expect(cert).not.toEqual(ORIGINAL_CERT);
+    expect(result.key).toEqual(key);
+    expect(result.cert).toEqual(cert);
+    expect(std.out).toMatchInlineSnapshot(
+      `"Generating new self-signed certificate..."`
+    );
+    expect(std.warn).toMatchInlineSnapshot(`""`);
+    expect(std.err).toMatchInlineSnapshot(`""`);
+  });
+
+  it("should warn if not able to write to the cache", async () => {
+    mockWriteFileSyncThrow(/\.pem$/);
+    await getHttpsOptions();
+    expect(
+      fs.existsSync(resolve(os.homedir(), ".wrangler/local-cert/key.pem"))
+    ).toBe(false);
+    expect(
+      fs.existsSync(resolve(os.homedir(), ".wrangler/local-cert/cert.pem"))
+    ).toBe(false);
+    expect(std.out).toMatchInlineSnapshot(
+      `"Generating new self-signed certificate..."`
+    );
+    expect(std.warn).toMatchInlineSnapshot(`
+      "Unable to cache generated self-signed certificate in home/.wrangler/local-cert.
+      ERROR: Cannot write file"
+    `);
+    expect(std.err).toMatchInlineSnapshot(`""`);
+  });
+});
+
+function mockStatSync(matcher: RegExp, stats: Partial<fs.Stats>) {
+  const originalStatSync = jest.requireActual("node:fs").statSync;
+  jest.spyOn(fs, "statSync").mockImplementation((statPath, options) => {
+    return matcher.test(statPath.toString())
+      ? (stats as fs.Stats)
+      : originalStatSync(statPath, options);
+  });
+}
+
+function mockWriteFileSyncThrow(matcher: RegExp) {
+  const originalWriteFileSync = jest.requireActual("node:fs").writeFileSync;
+  jest
+    .spyOn(fs, "writeFileSync")
+    .mockImplementation((filePath, data, options) => {
+      if (matcher.test(filePath.toString())) {
+        throw new Error("ERROR: Cannot write file");
+      } else {
+        return originalWriteFileSync(filePath, data, options);
+      }
+    });
+}