wrangler 0.0.0-adae8e8 → 0.0.0-b0fcc7d

package/README.md

@@ -0,0 +1,51 @@
+## 🤠 wrangler
+
+`wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/).
+
+[(Read the full stack week launch blog post.)](https://blog.cloudflare.com/wrangler-v2-beta/)
+
+**DISCLAIMER**: This is a work in progress, and is NOT recommended for use in production. We are opening this preview for feedback from the community, and to openly share our [roadmap](https://github.com/cloudflare/wrangler2/issues/12) for the future. As such, expect APIs and documentation to change before the end of the preview.
+
+Further, we will NOT do a general release until we are both feature complete, and have a full backward compatibility and incremental migration plan in place. For more details, follow the [parent roadmap issue](https://github.com/cloudflare/wrangler2/issues/12).
+
+## Quick Start
+
+```bash
+# Make a javascript file
+$ echo "export default { fetch() { return new Response('hello world') } }" > index.js
+# try it out
+$ npx wrangler@beta dev index.js
+# and then publish it
+$ npx wrangler@beta publish index.js --name my-worker
+# visit https://my-worker.<your workers subdomain>.workers.dev
+```
+
+## Installation:
+
+```bash
+$ npm install wrangler@beta
+```
+
+## Commands
+
+### `wrangler init [name]`
+
+Creates a `wrangler.toml` configuration file. For more details on the configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration).
+
+### `wrangler dev [script]`
+
+Start a local development server, with live reloading and devtools.
+
+### `wrangler publish [script] --name [name]`
+
+Publish the given script to the worldwide Cloudflare network.
+
+For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/commands).
+
+### `wrangler pages dev [directory] [-- command]`
+
+Either serves a static build asset directory, or proxies itself in front of a command.
+
+Builds and runs functions from a `./functions` directory or uses a `_worker.js` file inside the static build asset directory.
+
+For more commands and options, refer to the [documentation](https://developers.cloudflare.com/pages/platform/functions#develop-and-preview-locally) or run `wrangler pages dev --help`.

package/bin/wrangler.js

@@ -10,7 +10,7 @@ async function main() {
     // Note Volta and nvm are also recommended in the official docs:
     // https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
     console.error(
-      `Wrangler requires at least Node.js ${MIN_NODE_VERSION}. 
+      `Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}.
 You should use the latest Node.js version if possible, as Cloudflare Workers use a very up-to-date version of V8.
 Consider using a Node.js version manager such as https://volta.sh/ or https://github.com/nvm-sh/nvm.`
     );
@@ -24,7 +24,7 @@ Consider using a Node.js version manager such as https://volta.sh/ or https://gi
       "--no-warnings",
       "--experimental-vm-modules",
       ...process.execArgv,
-      join(__dirname, "../wrangler-dist/index_node.js"),
+      join(__dirname, "../wrangler-dist/cli.js"),
       ...process.argv.slice(2),
     ],
     { stdio: "inherit" }

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "wrangler",
-  "version": "0.0.0-adae8e8",
+  "version": "0.0.0-b0fcc7d",
   "author": "wrangler@cloudflare.com",
   "description": "Command-line interface for all things Cloudflare Workers",
-  "bin": "./bin/wrangler.js",
+  "bin": {
+    "wrangler": "./bin/wrangler.js",
+    "wrangler2": "./bin/wrangler.js"
+  },
   "license": "MIT OR Apache-2.0",
   "bugs": {
     "url": "https://github.com/cloudflare/wrangler/issues"
@@ -33,25 +36,28 @@
     "cli"
   ],
   "dependencies": {
-    "esbuild": "0.13.12",
-    "miniflare": "2.0.0-rc.1",
-    "semiver": "^1.1.0"
+    "@cloudflare/pages-functions-compiler": "0.3.8",
+    "esbuild": "0.14.1",
+    "miniflare": "2.0.0-rc.3",
+    "semiver": "^1.1.0",
+    "serve": "^13.0.2",
+    "@esbuild-plugins/node-globals-polyfill": "^0.1.1",
+    "@esbuild-plugins/node-modules-polyfill": "^0.1.2"
   },
   "optionalDependencies": {
     "fsevents": "~2.3.2"
   },
   "devDependencies": {
-    "@cloudflare/pages-functions-compiler": "^0.3.3",
     "@iarna/toml": "^2.2.5",
     "@types/cloudflare": "^2.7.6",
     "@types/express": "^4.17.13",
-    "@types/react": "^17.0.34",
+    "@types/react": "^17.0.37",
     "@types/signal-exit": "^3.0.1",
-    "@types/ws": "^8.2.0",
-    "@types/yargs": "^17.0.5",
+    "@types/ws": "^8.2.1",
+    "@types/yargs": "^17.0.7",
     "clipboardy": "^3.0.0",
     "command-exists": "^1.2.9",
-    "execa": "^5.1.1",
+    "execa": "^6.0.0",
     "express": "^4.17.1",
     "finalhandler": "^1.1.2",
     "find-up": "^6.2.0",
@@ -59,18 +65,18 @@
     "http-proxy": "^1.18.1",
     "http-proxy-middleware": "^2.0.1",
     "ink": "^3.2.0",
-    "ink-select-input": "^4.2.0",
+    "ink-select-input": "^4.2.1",
     "ink-table": "^3.0.0",
-    "ink-text-input": "^4.0.1",
-    "node-fetch": "github:tekwiz/node-fetch#fix/redirect-with-empty-chunked-transfer-encoding",
+    "ink-text-input": "^4.0.2",
+    "node-fetch": "^3.1.0",
     "open": "^8.4.0",
+    "path-to-regexp": "^6.2.0",
     "react": "^17.0.2",
-    "serve": "^13.0.2",
     "serve-static": "^1.14.1",
-    "signal-exit": "^3.0.5",
+    "signal-exit": "^3.0.6",
     "tmp-promise": "^3.0.3",
-    "ws": "^8.2.3",
-    "yargs": "^17.2.1"
+    "ws": "^8.3.0",
+    "yargs": "^17.3.0"
   },
   "files": [
     "src",
@@ -86,20 +92,24 @@
     "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": "npm run build && NODE_OPTIONS=--enable-source-maps jest --silent=false"
+    "test": "CF_API_TOKEN=some-api-token CF_ACCOUNT_ID=some-account-id jest --silent=false --verbose=true"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=16.7.0"
   },
   "jest": {
+    "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)"
+    ],
+    "moduleNameMapper": {
+      "clipboardy": "<rootDir>/src/__tests__/clipboardy-mock.js"
+    },
     "transform": {
-      "^.+\\.tsx?$": [
+      "^.+\\.c?(t|j)sx?$": [
         "esbuild-jest",
         {
-          "sourcemap": true,
-          "loaders": {
-            ".spec.ts": "tsx"
-          }
+          "sourcemap": true
         }
       ]
     }

package/src/__tests__/clipboardy-mock.js

@@ -0,0 +1,4 @@
+// We use this mock during tests because we're having trouble
+// properly compiling clipboardy for jest
+// We can revisit this if and when we write tests that test
+// the copying part of `dev`

package/src/__tests__/index.test.ts

@@ -1,19 +1,53 @@
-import execa from "execa";
 import * as fs from "node:fs";
 import * as fsp from "node:fs/promises";
 import * as path from "node:path";
 import * as TOML from "@iarna/toml";
+import { main } from "../index";
+// @ts-expect-error we're mocking cfetch, so of course setMock isn't a thing
+import { setMock, unsetAllMocks } from "../cfetch";
 
-async function w(cmd: string | string[] = []) {
-  return await execa(
-    path.join(__dirname, "../../bin/wrangler.js"),
-    typeof cmd === "string" ? cmd.split(" ") : cmd
-  );
+jest.mock("../cfetch", () => {
+  return jest.requireActual("./mock-cfetch");
+});
+
+async function w(cmd: void | string, options?: { tap: boolean }) {
+  const tapped = options?.tap ? tap() : undefined;
+  await main([...(cmd ? cmd.split(" ") : [])]);
+  tapped?.off();
+  return { stdout: tapped?.out, stderr: tapped?.err };
+}
+
+function tap() {
+  const oldLog = console.log;
+  const oldError = console.error;
+
+  const toReturn = {
+    off: () => {
+      console.log = oldLog;
+      console.error = oldError;
+    },
+    out: "",
+    err: "",
+  };
+
+  console.log = (...args) => {
+    toReturn.out += args.join("");
+    oldLog.apply(console, args);
+    // console.trace(...args); // use this if you want to find the true source of your console.log
+  };
+  console.error = (...args) => {
+    toReturn.err += args.join("");
+    oldError.apply(console, args);
+  };
+
+  return toReturn;
 }
 
 describe("wrangler", () => {
   it("should run", async () => {
-    expect((await w()).stdout).toMatchInlineSnapshot(`
+    const { stdout } = await w(undefined, { tap: true });
+
+    expect(stdout).toMatchInlineSnapshot(`
       "wrangler
 
       Commands:
@@ -28,12 +62,12 @@ describe("wrangler", () => {
         wrangler pages             ⚡️ Configure Cloudflare Pages
 
       Flags:
-        --config   Path to .toml configuration file  [string]
-        --help     Show help  [boolean]
-        --version  Show version number  [boolean]
+        -c, --config   Path to .toml configuration file  [string]
+        -h, --help     Show help  [boolean]
+        -v, --version  Show version number  [boolean]
 
       Options:
-        --local  Run on my machine  [boolean] [default: false]"
+        -l, --local  Run on my machine  [boolean] [default: false]"
     `);
   });
 
@@ -52,32 +86,46 @@ describe("wrangler", () => {
     it("should create a wrangler.toml", async () => {
       await w("init");
       const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
-      expect(parsed.name).toBe("init");
       expect(typeof parsed.compatibility_date).toBe("string");
     });
 
     it("should error when wrangler.toml already exists", async () => {
       fs.closeSync(fs.openSync("./wrangler.toml", "w"));
-      const { stderr } = await w("init");
+      const { stderr } = await w("init", { tap: true });
       expect(stderr.endsWith("wrangler.toml already exists.")).toBe(true);
     });
-
-    it("should create a named config", async () => {
-      await w("init xyz");
-      const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
-      expect(parsed.name).toBe("xyz");
-    });
   });
 
   describe("kv:namespace", () => {
+    afterAll(() => {
+      unsetAllMocks();
+    });
+    let KVNamespaces: { title: string; id: string }[] = [];
     it("can create a namespace", async () => {
-      const { stdout } = await w('kv:namespace create "UnitTestNamespace"');
-      expect(stdout.includes(`{ binding = "UnitTestNamespace",`)).toBe(true);
+      setMock("/accounts/:accountId/storage/kv/namespaces", (uri, init) => {
+        expect(init.method === "POST");
+        const body = JSON.parse(init.body);
+        expect(body.title).toBe("worker-UnitTestNamespace");
+        KVNamespaces.push({ title: body.title, id: "some-namespace-id" });
+        return { id: "some-namespace-id" };
+      });
+
+      await w("kv:namespace create UnitTestNamespace");
+      expect(
+        KVNamespaces.find((ns) => ns.title === `worker-UnitTestNamespace`)
+      ).toBeTruthy();
     });
 
     let createdNamespace: { id: string; title: string };
     it("can list namespaces", async () => {
-      const { stdout } = await w("kv:namespace list");
+      setMock(
+        "/accounts/:accountId/storage/kv/namespaces\\?:qs",
+        (uri, init) => {
+          expect(init).toBe(undefined);
+          return KVNamespaces;
+        }
+      );
+      const { stdout } = await w("kv:namespace list", { tap: true });
       const namespaces = JSON.parse(stdout);
       createdNamespace = namespaces.find(
         (ns) => ns.title === "worker-UnitTestNamespace"
@@ -86,37 +134,20 @@ describe("wrangler", () => {
     });
 
     it("can delete a namespace", async () => {
-      const { stdout } = await w(
-        `kv:namespace delete --namespace-id ${createdNamespace.id}`
+      const namespaceIdToDelete = createdNamespace.id;
+      setMock(
+        "/accounts/:accountId/storage/kv/namespaces/:namespaceId",
+        (uri, init) => {
+          expect(init.method).toBe("DELETE");
+          KVNamespaces = KVNamespaces.filter(
+            (ns) => ns.id !== namespaceIdToDelete
+          );
+        }
+      );
+      await w(`kv:namespace delete --namespace-id ${namespaceIdToDelete}`);
+      expect(KVNamespaces.find((ns) => ns.id === namespaceIdToDelete)).toBe(
+        undefined
       );
-      console.log(stdout);
-    });
-  });
-  describe("kv:key", () => {
-    let namespaceId: string;
-    beforeAll(async () => {
-      await w('kv:namespace create "UnitTestNamespace"');
-      namespaceId = JSON.parse((await w("kv:namespace list")).stdout).find(
-        (ns) => ns.title === "worker-UnitTestNamespace"
-      ).id;
-    });
-    afterAll(async () => {
-      await w(`kv:namespace delete --namespace-id ${namespaceId}`);
     });
-    it("stub", () => {});
-    // it("can add a key", () => {});
-    // it("can read a key", () => {});
-    // it("can list keys", () => {});
-    // it("can delete a key", () => {});
   });
-
-  // describe("login", () => {
-  //   it("should show possible scopes", async () => {
-  //     const { stdout } = await w("login --scopes-list");
-  //     // UGH jest doesn't like wide text huh
-  //     expect(stdout).toMatchInlineSnapshot();
-  //   });
-  // });
-
-  // TODO: setup a "api server" to mock requests
 });

package/src/__tests__/mock-cfetch.js

@@ -0,0 +1,46 @@
+// This file mocks ../cfetch.ts
+// so we can insert whatever responses we want from it
+
+const pathToRegexp = require("path-to-regexp");
+// TODO: add jsdoc style types here
+
+// type MockHandler = (resource: string, init?: RequestInit) => any; // TODO: use a generic here
+
+let mocks = [];
+
+function mockCfetch(resource, init) {
+  for (const { regexp, handler } of mocks) {
+    if (regexp.test(resource)) {
+      return handler(resource, init); // should we have some kind of fallthrough system? we'll see.
+    }
+  }
+  throw new Error(`no mocks found for ${resource}`);
+}
+
+function setMock(resource, handler) {
+  const mock = {
+    resource,
+    handler,
+    regexp: pathToRegexp(resource),
+  };
+  mocks.push(mock);
+  return () => {
+    mocks = mocks.filter((x) => x !== mock);
+  };
+}
+
+function unsetAllMocks() {
+  mocks = [];
+}
+
+const CF_API_BASE_URL =
+  process.env.CF_API_BASE_URL || "https://api.cloudflare.com/client/v4";
+
+Object.assign(module.exports, {
+  __esModule: true,
+  default: mockCfetch,
+  mockCfetch,
+  setMock,
+  unsetAllMocks,
+  CF_API_BASE_URL,
+});

package/src/api/form_data.ts

@@ -3,8 +3,6 @@ import type {
   CfModuleType,
   CfVariable,
   CfModule,
-  CfKvNamespace,
-  CfCryptoKey,
 } from "./worker.js";
 import { FormData, Blob } from "formdata-node";
 
@@ -27,12 +25,26 @@ function toBinding(
     return { name, type: "plain_text", text: variable };
   }
 
-  const { namespaceId } = variable as CfKvNamespace;
-  if (namespaceId) {
-    return { name, type: "kv_namespace", namespace_id: namespaceId };
+  if ("namespaceId" in variable) {
+    return {
+      name,
+      type: "kv_namespace",
+      namespace_id: variable.namespaceId,
+    };
   }
 
-  const { format, algorithm, usages, data } = variable as CfCryptoKey;
+  if ("class_name" in variable) {
+    return {
+      name,
+      type: "durable_object_namespace",
+      class_name: variable.class_name,
+      ...(variable.script_name && {
+        script_name: variable.script_name,
+      }),
+    };
+  }
+
+  const { format, algorithm, usages, data } = variable;
   if (format) {
     let key_base64;
     let key_jwk;
@@ -84,7 +96,15 @@ function toModule(module: CfModule, entryType?: CfModuleType): Blob {
  */
 export function toFormData(worker: CfWorkerInit): FormData {
   const formData = new FormData();
-  const { main, modules, variables, usage_model, compatibility_date } = worker;
+  const {
+    main,
+    modules,
+    variables,
+    migrations,
+    usage_model,
+    compatibility_date,
+    compatibility_flags,
+  } = worker;
   const { name, type: mainType } = main;
 
   const bindings = [];
@@ -93,23 +113,19 @@ export function toFormData(worker: CfWorkerInit): FormData {
     bindings.push(binding);
   }
 
-  const singleton = mainType === "commonjs";
+  // TODO: this object should be typed
   const metadata = {
-    main_module: singleton ? undefined : name,
-    body_part: singleton ? name : undefined,
+    ...(mainType !== "commonjs" ? { main_module: name } : { body_part: name }),
     bindings,
+    ...(compatibility_date && { compatibility_date }),
+    ...(compatibility_flags && { compatibility_flags }),
+    ...(usage_model && { usage_model }),
+    ...(migrations && { migrations }),
   };
-  if (compatibility_date) {
-    // @ts-expect-error - we should type metadata
-    metadata.compatibility_date = compatibility_date;
-  }
-  if (usage_model) {
-    // @ts-expect-error - we should type metadata
-    metadata.usage_model = usage_model;
-  }
+
   formData.set("metadata", JSON.stringify(metadata));
 
-  if (singleton && modules && modules.length > 0) {
+  if (mainType === "commonjs" && modules && modules.length > 0) {
     throw new TypeError(
       "More than one module can only be specified when type = 'esm'"
     );

package/src/api/preview.ts

@@ -1,7 +1,7 @@
 import cfetch from "../cfetch";
-import { fetchJson } from "../util/fetch";
 import { toFormData } from "./form_data";
 import type { CfAccount, CfWorkerInit } from "./worker";
+import fetch from "node-fetch";
 
 /**
  * A preview mode.
@@ -9,7 +9,7 @@ import type { CfAccount, CfWorkerInit } from "./worker";
  * * If true, then using a `workers.dev` subdomain.
  * * Otherwise, a list of routes under a single zone.
  */
-export type CfPreviewMode = { workers_dev: boolean } | { routes: string[] };
+type CfPreviewMode = { workers_dev: boolean } | { routes: string[] };
 
 /**
  * A preview token.
@@ -60,17 +60,17 @@ async function sessionToken(account: CfAccount): Promise<CfPreviewToken> {
     ? `/zones/${zoneId}/workers/edge-preview`
     : `/accounts/${accountId}/workers/subdomain/edge-preview`;
 
-  const { exchange_url: tokenUrl } = await cfetch<{ exchange_url: string }>(
-    initUrl
-  );
-  const { inspector_websocket: url, token } = await fetchJson()(tokenUrl);
-  const { host } = new URL(url);
+  const { exchange_url } = await cfetch<{ exchange_url: string }>(initUrl);
+  const { inspector_websocket, token } = (await (
+    await fetch(exchange_url)
+  ).json()) as { inspector_websocket: string; token: string };
+  const { host } = new URL(inspector_websocket);
   const query = `cf_workers_preview_token=${token}`;
 
   return {
     value: token,
     host,
-    inspectorUrl: new URL(`${url}?${query}`),
+    inspectorUrl: new URL(`${inspector_websocket}?${query}`),
     prewarmUrl: new URL(
       `https://${host}/cdn-cgi/workers/preview/prewarm?${query}`
     ),
@@ -96,27 +96,32 @@ export async function previewToken(
   const { value, host, inspectorUrl, prewarmUrl } = await sessionToken(account);
 
   const { accountId, zoneId } = account;
-  const scriptId = zoneId ? randomId() : host.split(".")[0];
+  const scriptId = zoneId ? randomId() : worker.name || host.split(".")[0];
   const url = `/accounts/${accountId}/workers/scripts/${scriptId}/edge-preview`;
 
-  const mode = zoneId ? { routes: ["*/*"] } : { workers_dev: true };
+  const mode: CfPreviewMode = zoneId
+    ? { routes: ["*/*"] }
+    : { workers_dev: true };
+
   const formData = toFormData(worker);
   formData.set("wrangler-session-config", JSON.stringify(mode));
 
-  const { preview_token: token } = await cfetch<{ preview_token: string }>(
-    url,
-    {
-      method: "POST",
-      // @ts-expect-error TODO: fix this
-      body: formData,
-      headers: {
-        "cf-preview-upload-config-token": value,
-      },
-    }
-  );
+  const { preview_token } = await cfetch<{ preview_token: string }>(url, {
+    method: "POST",
+    // @ts-expect-error TODO: fix this
+    body: formData,
+    headers: {
+      "cf-preview-upload-config-token": value,
+    },
+  });
+
   return {
-    value: token,
-    host,
+    value: preview_token,
+    // TODO: verify this works with zoned workers
+    host:
+      worker.name && !zoneId
+        ? `${worker.name}.${host.split(".").slice(1).join(".")}`
+        : host,
     inspectorUrl,
     prewarmUrl,
   };

package/src/api/worker.ts

@@ -72,6 +72,21 @@ export interface CfKvNamespace {
   namespaceId: string;
 }
 
+export interface CfDurableObject {
+  class_name: string;
+  script_name?: string;
+}
+
+interface CfDOMigrations {
+  old_tag?: string;
+  new_tag: string;
+  steps: {
+    new_classes?: string[];
+    renamed_classes?: string[];
+    deleted_classes?: string[];
+  }[];
+}
+
 /**
  * A `WebCrypto` key.
  *
@@ -99,12 +114,16 @@ export interface CfCryptoKey {
 /**
  * A variable (aka. environment variable).
  */
-export type CfVariable = string | CfKvNamespace | CfCryptoKey;
+export type CfVariable = string | CfKvNamespace | CfCryptoKey | CfDurableObject;
 
 /**
  * Options for creating a `CfWorker`.
  */
 export interface CfWorkerInit {
+  /**
+   * The name of the worker.
+   */
+  name: string | void;
   /**
    * The entrypoint module.
    */
@@ -117,8 +136,10 @@ export interface CfWorkerInit {
    * The map of names to variables. (aka. environment variables)
    */
   variables?: { [name: string]: CfVariable };
-  compatibility_date?: string;
-  usage_model?: void | "bundled" | "unbound";
+  migrations: void | CfDOMigrations;
+  compatibility_date: string | void;
+  compatibility_flags: void | string[];
+  usage_model: void | "bundled" | "unbound";
 }
 
 /**

package/src/{index_node.ts → cli.ts}

@@ -1,6 +1,6 @@
 import { main } from ".";
 
-main().catch((cause) => {
+main(process.argv.slice(2)).catch((cause) => {
   const { name, message } = cause;
   if (name === "CloudflareError") {
     console.error("\x1b[31m", message);