wrangler 0.0.0-b63efe6 → 0.0.0-b8a3e78

package/bin/wrangler.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-const { spawn } = require("child_process");
-const { join } = require("path");
+const { spawn } = require("node:child_process");
+const { join } = require("node:path");
 const semiver = require("semiver");
 
 const MIN_NODE_VERSION = "16.7.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wrangler",
-  "version": "0.0.0-b63efe6",
+  "version": "0.0.0-b8a3e78",
   "author": "wrangler@cloudflare.com",
   "description": "Command-line interface for all things Cloudflare Workers",
   "bin": {
@@ -36,7 +36,7 @@
     "cli"
   ],
   "dependencies": {
-    "esbuild": "0.14.1",
+    "esbuild": "0.14.14",
     "miniflare": "2.2.0",
     "path-to-regexp": "^6.2.0",
     "semiver": "^1.1.0",
@@ -65,22 +65,21 @@
     "faye-websocket": "^0.11.4",
     "finalhandler": "^1.1.2",
     "find-up": "^6.2.0",
-    "formdata-node": "^4.3.1",
     "ignore": "^5.2.0",
     "ink": "^3.2.0",
     "ink-select-input": "^4.2.1",
     "ink-table": "^3.0.0",
     "ink-testing-library": "^2.1.0",
     "ink-text-input": "^4.0.2",
+    "jest-fetch-mock": "^3.0.3",
     "mime": "^3.0.0",
-    "node-fetch": "3.1.1",
     "open": "^8.4.0",
     "react": "^17.0.2",
     "react-error-boundary": "^3.1.4",
     "serve-static": "^1.14.1",
     "signal-exit": "^3.0.6",
     "tmp-promise": "^3.0.3",
-    "undici": "^4.11.1",
+    "undici": "4.13.0",
     "ws": "^8.3.0",
     "yargs": "^17.3.0"
   },
@@ -99,7 +98,7 @@
     "bundle": "node -r esbuild-register scripts/bundle.ts",
     "build": "npm run clean && npm run bundle",
     "start": "npm run bundle && NODE_OPTIONS=--enable-source-maps ./bin/wrangler.js",
-    "test": "CF_API_TOKEN=some-api-token CF_ACCOUNT_ID=some-account-id jest --silent=false --verbose=true",
+    "test": "jest --silent=false --verbose=true",
     "test-watch": "npm run test -- --runInBand --testTimeout=50000 --watch"
   },
   "engines": {
@@ -107,12 +106,13 @@
   },
   "jest": {
     "restoreMocks": true,
+    "testTimeout": 30000,
     "testRegex": ".*.(test|spec)\\.[jt]sx?$",
     "transformIgnorePatterns": [
-      "node_modules/(?!node-fetch|fetch-blob|find-up|locate-path|p-locate|p-limit|yocto-queue|path-exists|data-uri-to-buffer|formdata-polyfill|execa|strip-final-newline|npm-run-path|path-key|onetime|mimic-fn|human-signals|is-stream)"
+      "node_modules/(?!find-up|locate-path|p-locate|p-limit|yocto-queue|path-exists|execa|strip-final-newline|npm-run-path|path-key|onetime|mimic-fn|human-signals|is-stream)"
     ],
     "moduleNameMapper": {
-      "clipboardy": "<rootDir>/src/__tests__/clipboardy-mock.js"
+      "clipboardy": "<rootDir>/src/__tests__/helpers/clipboardy-mock.js"
     },
     "transform": {
       "^.+\\.c?(t|j)sx?$": [

package/pages/functions/buildWorker.ts

@@ -1,4 +1,4 @@
-import path from "path";
+import path from "node:path";
 import { build } from "esbuild";
 
 type Options = {

package/pages/functions/filepath-routing.ts

@@ -1,8 +1,8 @@
-import path from "path";
-import fs from "fs/promises";
-import { transform } from "esbuild";
+import fs from "node:fs/promises";
+import path from "node:path";
 import * as acorn from "acorn";
 import * as acornWalk from "acorn-walk";
+import { transform } from "esbuild";
 import type { Config, RouteConfig } from "./routes";
 import type { ExportNamedDeclaration, Identifier } from "estree";
 

package/pages/functions/routes.ts

@@ -1,5 +1,5 @@
-import path from "path";
-import fs from "fs/promises";
+import fs from "node:fs/promises";
+import path from "node:path";
 import { isValidIdentifier, normalizeIdentifier } from "./identifiers";
 
 export const HTTP_METHODS = [

package/src/__tests__/dev.test.tsx

@@ -44,11 +44,14 @@ function renderDev({
   compatibilityFlags,
   usageModel,
   buildCommand = {},
+  enableLocalPersistence = false,
+  env = undefined,
 }: Partial<DevProps>) {
   return render(
     <Dev
       name={name}
       entry={entry}
+      env={env}
       port={port}
       buildCommand={buildCommand}
       format={format}
@@ -62,6 +65,7 @@ function renderDev({
       compatibilityFlags={compatibilityFlags}
       usageModel={usageModel}
       bindings={bindings}
+      enableLocalPersistence={enableLocalPersistence}
     />
   );
 }

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

@@ -0,0 +1,30 @@
+const ORIGINAL_CF_API_TOKEN = process.env.CF_API_TOKEN;
+const ORIGINAL_CF_ACCOUNT_ID = process.env.CF_ACCOUNT_ID;
+
+/**
+ * Mock the API token so that we don't need to read it from user configuration files.
+ */
+export function mockApiToken({
+  apiToken = "some-api-token",
+}: { apiToken?: string } = {}) {
+  beforeEach(() => {
+    process.env.CF_API_TOKEN = apiToken;
+  });
+  afterEach(() => {
+    process.env.CF_API_TOKEN = ORIGINAL_CF_API_TOKEN;
+  });
+}
+
+/**
+ * Mock the current account ID so that we don't need to read it from configuration files.
+ */
+export function mockAccountId({
+  accountId = "some-account-id",
+}: { accountId?: string } = {}) {
+  beforeEach(() => {
+    process.env.CF_ACCOUNT_ID = accountId;
+  });
+  afterEach(() => {
+    process.env.CF_ACCOUNT_ID = ORIGINAL_CF_ACCOUNT_ID;
+  });
+}

package/src/__tests__/{mock-cfetch.ts → helpers/mock-cfetch.ts}

@@ -1,8 +1,8 @@
-import type { RequestInit } from "node-fetch";
-import { URLSearchParams } from "node:url";
+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 { CF_API_BASE_URL } from "../../cfetch";
+import type { FetchResult } from "../../cfetch";
+import type { RequestInit } from "undici";
 
 /**
  * The signature of the function that will handle a mock request.
@@ -11,7 +11,7 @@ export type MockHandler<ResponseType> = (
   uri: RegExpExecArray,
   init: RequestInit,
   queryParams: URLSearchParams
-) => ResponseType;
+) => ResponseType | Promise<ResponseType>;
 
 type RemoveMockFn = () => void;
 
@@ -41,7 +41,7 @@ export async function mockFetchInternal(
     if (uri !== null && (!method || method === (init.method ?? "GET"))) {
       // The `resource` regular expression will extract the labelled groups from the URL.
       // These are passed through to the `handler` call, to allow it to do additional checks or behaviour.
-      return handler(uri, init, queryParams); // TODO: should we have some kind of fallthrough system? we'll see.
+      return await handler(uri, init, queryParams); // TODO: should we have some kind of fallthrough system? we'll see.
     }
   }
   throw new Error(

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

@@ -0,0 +1,56 @@
+/**
+ * We use this module to mock console methods, and optionally
+ * assert on the values they're called with in our tests.
+ */
+
+let logSpy: jest.SpyInstance,
+  errorSpy: jest.SpyInstance,
+  warnSpy: jest.SpyInstance;
+
+const std = {
+  get out() {
+    return normalizeSlashes(stripTimings(logSpy.mock.calls.flat(2).join("\n")));
+  },
+  get err() {
+    return normalizeSlashes(
+      stripTimings(errorSpy.mock.calls.flat(2).join("\n"))
+    );
+  },
+  get warn() {
+    return normalizeSlashes(
+      stripTimings(warnSpy.mock.calls.flat(2).join("\n"))
+    );
+  },
+};
+
+export function mockConsoleMethods() {
+  beforeEach(() => {
+    logSpy = jest.spyOn(console, "log").mockImplementation();
+    errorSpy = jest.spyOn(console, "error").mockImplementation();
+    warnSpy = jest.spyOn(console, "warn").mockImplementation();
+  });
+  afterEach(() => {
+    logSpy.mockRestore();
+    errorSpy.mockRestore();
+    warnSpy.mockRestore();
+  });
+  return std;
+}
+
+/**
+ * Ensure slashes in the `str` are OS file-system agnostic.
+ *
+ * Use this in snapshot tests to be resilient to file-system differences.
+ */
+export function normalizeSlashes(str: string): string {
+  return str.replace(/\\/g, "/");
+}
+
+/**
+ * Strip "timing data" out of the `stdout` string, since this is not always deterministic.
+ *
+ * Use this in snapshot tests to be resilient to slight changes in timing of processing.
+ */
+export function stripTimings(stdout: string): string {
+  return stdout.replace(/\(\d+\.\d+ sec\)/g, "(TIMINGS)");
+}

package/src/__tests__/{mock-dialogs.ts → helpers/mock-dialogs.ts}

@@ -1,4 +1,4 @@
-import { confirm, prompt } from "../dialogs";
+import { confirm, prompt } from "../../dialogs";
 
 /**
  * The expected values for a confirmation request.

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

@@ -0,0 +1,40 @@
+import { createFetchResult, setMockRawResponse } from "./mock-cfetch";
+
+export function mockKeyListRequest(
+  expectedNamespaceId: string,
+  expectedKeys: string[],
+  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",
+    ([_url, accountId, namespaceId], _init, query) => {
+      requests.count++;
+      expect(accountId).toEqual("some-account-id");
+      expect(namespaceId).toEqual(expectedNamespaceId);
+      if (expectedKeyObjects.length <= keysPerRequest) {
+        return createFetchResult(expectedKeyObjects);
+      } 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 }
+        );
+      }
+    }
+  );
+  return requests;
+}

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

@@ -0,0 +1,27 @@
+import { mkdirSync, writeFileSync } from "node:fs";
+import os from "node:os";
+import path from "node:path";
+
+export function writeUserConfig(
+  oauth_token?: string,
+  refresh_token?: string,
+  expiration_time?: string
+) {
+  const lines: string[] = [];
+  if (oauth_token) {
+    lines.push(`oauth_token = "${oauth_token}"`);
+  }
+  if (refresh_token) {
+    lines.push(`refresh_token = "${refresh_token}"`);
+  }
+  if (expiration_time) {
+    lines.push(`expiration_time = "${expiration_time}"`);
+  }
+  const configPath = path.join(os.homedir(), ".wrangler/config");
+  mkdirSync(configPath, { recursive: true });
+  writeFileSync(
+    path.join(configPath, "default.toml"),
+    lines.join("\n"),
+    "utf-8"
+  );
+}

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

@@ -0,0 +1,29 @@
+import * as fs from "node:fs";
+import os from "node:os";
+import * as path from "node:path";
+
+const originalCwd = process.cwd();
+
+export function runInTempDir({ homedir }: { homedir?: string } = {}) {
+  let tmpDir: string;
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "wrangler-tests"));
+    process.chdir(tmpDir);
+    if (homedir !== undefined) {
+      // Override where the home directory is so that we can write our own user config,
+      // without destroying the real thing.
+      fs.mkdirSync(homedir);
+      // Note it is very important that we use the "default" value from "node:os" (e.g. `import os from "node:os";`)
+      // rather than an alias to the module (e.g. `import * as os from "node:os";`).
+      // 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);
+    }
+  });
+
+  afterEach(() => {
+    process.chdir(originalCwd);
+    fs.rmSync(tmpDir, { recursive: true });
+  });
+}

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

@@ -0,0 +1,14 @@
+import { main } from "../../index";
+import { normalizeSlashes, stripTimings } from "./mock-console";
+
+/**
+ * A helper to 'run' wrangler commands for tests.
+ */
+export async function runWrangler(cmd?: string) {
+  try {
+    await main(cmd?.split(" ") ?? []);
+  } catch (e) {
+    e.message = normalizeSlashes(stripTimings(e.message));
+    throw e;
+  }
+}