wrangler 0.0.0-e61907d → 0.0.0-ece06ea

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

@@ -1,2 +1,36 @@
-#!/usr/bin/env node --no-warnings
-require("../wrangler-dist/index_node.js");
+#!/usr/bin/env node
+const { spawn } = require("child_process");
+const { join } = require("path");
+const semiver = require("semiver");
+
+const MIN_NODE_VERSION = "16.7.0";
+
+async function main() {
+  if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
+    // 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 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.`
+    );
+    process.exitCode = 1;
+    return;
+  }
+
+  spawn(
+    process.execPath,
+    [
+      "--no-warnings",
+      "--experimental-vm-modules",
+      ...process.execArgv,
+      join(__dirname, "../wrangler-dist/cli.js"),
+      ...process.argv.slice(2),
+    ],
+    { stdio: "inherit" }
+  ).on("exit", (code) =>
+    process.exit(code === undefined || code === null ? 0 : code)
+  );
+}
+
+void main();

package/import_meta_url.js

@@ -0,0 +1,3 @@
+// as per https://github.com/evanw/esbuild/issues/1492
+// to make some libs work
+export const import_meta_url = require("url").pathToFileURL(__filename);

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "wrangler",
-  "version": "0.0.0-e61907d",
+  "version": "0.0.0-ece06ea",
   "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,9 +36,13 @@
     "cli"
   ],
   "dependencies": {
-    "esbuild": "^0.13.12",
-    "miniflare": "^1.4.1",
-    "yargs": "^17.2.1"
+    "@cloudflare/pages-functions-compiler": "0.3.7",
+    "esbuild": "0.14.1",
+    "miniflare": "2.0.0-rc.2",
+    "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"
@@ -43,42 +50,68 @@
   "devDependencies": {
     "@iarna/toml": "^2.2.5",
     "@types/cloudflare": "^2.7.6",
-    "@types/react": "^17.0.34",
+    "@types/express": "^4.17.13",
+    "@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",
-    "cloudflare": "^2.9.1",
     "command-exists": "^1.2.9",
+    "execa": "^6.0.0",
+    "express": "^4.17.1",
     "finalhandler": "^1.1.2",
     "find-up": "^6.2.0",
     "formdata-node": "^4.3.1",
     "http-proxy": "^1.18.1",
+    "http-proxy-middleware": "^2.0.1",
     "ink": "^3.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-static": "^1.14.1",
-    "signal-exit": "^3.0.5",
+    "signal-exit": "^3.0.6",
     "tmp-promise": "^3.0.3",
-    "ws": "^8.2.3"
+    "ws": "^8.3.0",
+    "yargs": "^17.3.0"
   },
   "files": [
+    "src",
     "bin",
     "miniflare-config-stubs",
     "wrangler-dist",
     "static-asset-facade.js",
-    "vendor"
+    "vendor",
+    "import_meta_url.js"
   ],
   "scripts": {
     "clean": "rm -rf wrangler-dist",
     "bundle": "node -r esbuild-register scripts/bundle.ts",
     "build": "npm run clean && npm run bundle",
-    "start": "npm run bundle && ./bin/wrangler.js"
+    "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"
   },
   "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": {
+      "^.+\\.c?(t|j)sx?$": [
+        "esbuild-jest",
+        {
+          "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

@@ -0,0 +1,153 @@
+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";
+
+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 () => {
+    const { stdout } = await w(undefined, { tap: true });
+
+    expect(stdout).toMatchInlineSnapshot(`
+      "wrangler
+
+      Commands:
+        wrangler init [name]       📥 Create a wrangler.toml configuration file
+        wrangler dev <filename>    👂 Start a local server for developing your worker
+        wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
+        wrangler tail [name]       🦚 Starts a log tailing session for a deployed Worker.
+        wrangler secret            🤫 Generate a secret that can be referenced in the worker script
+        wrangler kv:namespace      🗂️  Interact with your Workers KV Namespaces
+        wrangler kv:key            🔑 Individually manage Workers KV key-value pairs
+        wrangler kv:bulk           💪 Interact with multiple Workers KV key-value pairs at once
+        wrangler pages             ⚡️ Configure Cloudflare Pages
+
+      Flags:
+        --config   Path to .toml configuration file  [string]
+        --help     Show help  [boolean]
+        --version  Show version number  [boolean]
+
+      Options:
+        --local  Run on my machine  [boolean] [default: false]"
+    `);
+  });
+
+  describe("init", () => {
+    const ogcwd = process.cwd();
+
+    beforeEach(() => {
+      process.chdir(path.join(__dirname, "fixtures", "init"));
+    });
+
+    afterEach(async () => {
+      await fsp.rm("./wrangler.toml");
+      process.chdir(ogcwd);
+    });
+
+    it("should create a wrangler.toml", async () => {
+      await w("init");
+      const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
+      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", { tap: true });
+      expect(stderr.endsWith("wrangler.toml already exists.")).toBe(true);
+    });
+  });
+
+  describe("kv:namespace", () => {
+    afterAll(() => {
+      unsetAllMocks();
+    });
+    let KVNamespaces: { title: string; id: string }[] = [];
+    it("can create a namespace", async () => {
+      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 () => {
+      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"
+      );
+      expect(createdNamespace.title).toBe("worker-UnitTestNamespace");
+    });
+
+    it("can delete a namespace", async () => {
+      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
+      );
+    });
+  });
+});

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

@@ -0,0 +1,158 @@
+import type {
+  CfWorkerInit,
+  CfModuleType,
+  CfVariable,
+  CfModule,
+} from "./worker.js";
+import { FormData, Blob } from "formdata-node";
+
+// Credit: https://stackoverflow.com/a/9458996
+function toBase64(source: BufferSource): string {
+  let result = "";
+  const buffer = source instanceof ArrayBuffer ? source : source.buffer;
+  const bytes = new Uint8Array(buffer);
+  for (let i = 0; i < bytes.byteLength; i++) {
+    result += String.fromCharCode(bytes[i]);
+  }
+  return btoa(result);
+}
+
+function toBinding(
+  name: string,
+  variable: CfVariable
+): Record<string, unknown> {
+  if (typeof variable === "string") {
+    return { name, type: "plain_text", text: variable };
+  }
+
+  if ("namespaceId" in variable) {
+    return {
+      name,
+      type: "kv_namespace",
+      namespace_id: variable.namespaceId,
+    };
+  }
+
+  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;
+    if (data instanceof ArrayBuffer || ArrayBuffer.isView(data)) {
+      key_base64 = toBase64(data);
+    } else {
+      key_jwk = data;
+    }
+    return {
+      name,
+      type: "secret_key",
+      format,
+      algorithm,
+      usages,
+      key_base64,
+      key_jwk,
+    };
+  }
+
+  throw new TypeError("Unsupported variable: " + variable);
+}
+
+export function toMimeType(type: CfModuleType): string {
+  switch (type) {
+    case "esm":
+      return "application/javascript+module";
+    case "commonjs":
+      return "application/javascript";
+    case "compiled-wasm":
+      return "application/wasm";
+    case "buffer":
+      return "application/octet-stream";
+    case "text":
+      return "text/plain";
+    default:
+      throw new TypeError("Unsupported module: " + type);
+  }
+}
+
+function toModule(module: CfModule, entryType?: CfModuleType): Blob {
+  const { type: moduleType, content } = module;
+  const type = toMimeType(moduleType ?? entryType);
+
+  return new Blob([content], { type });
+}
+
+/**
+ * Creates a `FormData` upload from a `CfWorkerInit`.
+ */
+export function toFormData(worker: CfWorkerInit): FormData {
+  const formData = new FormData();
+  const {
+    main,
+    modules,
+    variables,
+    migrations,
+    usage_model,
+    compatibility_date,
+    compatibility_flags,
+  } = worker;
+  const { name, type: mainType } = main;
+
+  const bindings = [];
+  for (const [name, variable] of Object.entries(variables ?? {})) {
+    const binding = toBinding(name, variable);
+    bindings.push(binding);
+  }
+
+  const metadata =
+    mainType !== "commonjs"
+      ? {
+          main_module: name,
+          bindings,
+        }
+      : {
+          body_part: name,
+          bindings,
+        };
+  if (compatibility_date) {
+    // @ts-expect-error - we should type metadata
+    metadata.compatibility_date = compatibility_date;
+  }
+  if (compatibility_flags) {
+    // @ts-expect-error - we should type metadata
+    metadata.compatibility_flags = compatibility_flags;
+  }
+  if (usage_model) {
+    // @ts-expect-error - we should type metadata
+    metadata.usage_model = usage_model;
+  }
+  if (migrations) {
+    // @ts-expect-error - we should type metadata
+    metadata.migrations = migrations;
+  }
+
+  formData.set("metadata", JSON.stringify(metadata));
+
+  if (mainType === "commonjs" && modules && modules.length > 0) {
+    throw new TypeError(
+      "More than one module can only be specified when type = 'esm'"
+    );
+  }
+
+  for (const module of [main].concat(modules || [])) {
+    const { name } = module;
+    const blob = toModule(module, mainType ?? "esm");
+    formData.set(name, blob, name);
+  }
+
+  return formData;
+}