wrangler 0.0.0-fb43821 → 0.0.0-fe5dcfd

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

@@ -0,0 +1,19 @@
+import * as os from "node:os";
+import * as path from "node:path";
+import * as fs from "fs";
+
+const originalCwd = process.cwd();
+
+export function runInTempDir() {
+  let tmpDir: string;
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "wrangler-tests"));
+    process.chdir(tmpDir);
+  });
+
+  afterEach(() => {
+    process.chdir(originalCwd);
+    fs.rmSync(tmpDir, { recursive: true });
+  });
+}

package/src/__tests__/run-wrangler.ts

@@ -0,0 +1,32 @@
+import { main } from "../index";
+
+/**
+ * Run the wrangler CLI tool in tests, capturing the logging output.
+ */
+export async function runWrangler(cmd?: string) {
+  const logSpy = jest.spyOn(console, "log").mockImplementation();
+  const errorSpy = jest.spyOn(console, "error").mockImplementation();
+  const warnSpy = jest.spyOn(console, "warn").mockImplementation();
+  try {
+    let error: unknown = undefined;
+    try {
+      await main(cmd?.split(" ") ?? []);
+    } catch (e) {
+      error = e;
+    }
+    return {
+      error,
+      stdout: captureCalls(logSpy),
+      stderr: captureCalls(errorSpy),
+      warnings: captureCalls(warnSpy),
+    };
+  } finally {
+    logSpy.mockRestore();
+    errorSpy.mockRestore();
+    warnSpy.mockRestore();
+  }
+}
+
+function captureCalls(spy: jest.SpyInstance): string {
+  return spy.mock.calls.flat(2).join("\n");
+}

package/src/__tests__/whoami.test.tsx

@@ -0,0 +1,130 @@
+import React from "react";
+import os from "node:os";
+import path from "node:path";
+import { render } from "ink-testing-library";
+import type { UserInfo } from "../whoami";
+import { getUserInfo, WhoAmI } from "../whoami";
+import { runInTempDir } from "./run-in-tmp";
+import { mkdirSync, writeFileSync } from "node:fs";
+import { setMockResponse } from "./mock-cfetch";
+import { initialise } from "../user";
+
+const ORIGINAL_CF_API_TOKEN = process.env.CF_API_TOKEN;
+const ORIGINAL_CF_ACCOUNT_ID = process.env.CF_ACCOUNT_ID;
+
+describe("getUserInfo()", () => {
+  runInTempDir();
+
+  beforeEach(() => {
+    // Clear the environment variables, so we can control them in the tests
+    delete process.env.CF_API_TOKEN;
+    delete process.env.CF_ACCOUNT_ID;
+    // Override where the home directory is so that we can specify a user config
+    mkdirSync("./home");
+    jest.spyOn(os, "homedir").mockReturnValue("./home");
+  });
+
+  afterEach(() => {
+    // Reset any changes to the environment variables
+    process.env.CF_API_TOKEN = ORIGINAL_CF_API_TOKEN;
+    process.env.CF_ACCOUNT_ID = ORIGINAL_CF_ACCOUNT_ID;
+  });
+
+  it("should return undefined if there is no config file", async () => {
+    await initialise();
+    const userInfo = await getUserInfo();
+    expect(userInfo).toBeUndefined();
+  });
+
+  it("should return undefined if there is an empty config file", async () => {
+    writeUserConfig();
+    await initialise();
+    const userInfo = await getUserInfo();
+    expect(userInfo).toBeUndefined();
+  });
+
+  it("should return the user's email and accounts if authenticated via config token", async () => {
+    writeUserConfig("some-oauth-token");
+    setMockResponse("/user", () => {
+      return { email: "user@example.com" };
+    });
+    setMockResponse("/accounts", () => {
+      return [
+        { name: "Account One", id: "account-1" },
+        { name: "Account Two", id: "account-2" },
+        { name: "Account Three", id: "account-3" },
+      ];
+    });
+
+    await initialise();
+    const userInfo = await getUserInfo();
+
+    expect(userInfo).toEqual({
+      authType: "OAuth",
+      apiToken: "some-oauth-token",
+      email: "user@example.com",
+      accounts: [
+        { name: "Account One", id: "account-1" },
+        { name: "Account Two", id: "account-2" },
+        { name: "Account Three", id: "account-3" },
+      ],
+    });
+  });
+});
+
+describe("WhoAmI component", () => {
+  it("should return undefined if there is no user", async () => {
+    const { lastFrame } = render(<WhoAmI user={undefined}></WhoAmI>);
+
+    expect(lastFrame()).toMatchInlineSnapshot(
+      `"You are not authenticated. Please run \`wrangler login\`."`
+    );
+  });
+
+  it("should display the user's email and accounts", async () => {
+    const user: UserInfo = {
+      authType: "OAuth",
+      apiToken: "some-oauth-token",
+      email: "user@example.com",
+      accounts: [
+        { name: "Account One", id: "account-1" },
+        { name: "Account Two", id: "account-2" },
+        { name: "Account Three", id: "account-3" },
+      ],
+    };
+
+    const { lastFrame } = render(<WhoAmI user={user}></WhoAmI>);
+
+    expect(lastFrame()).toContain(
+      "You are logged in with an OAuth Token, associated with the email 'user@example.com'!"
+    );
+    expect(lastFrame()).toMatch(/Account Name .+ Account ID/);
+    expect(lastFrame()).toMatch(/Account One .+ account-1/);
+    expect(lastFrame()).toMatch(/Account Two .+ account-2/);
+    expect(lastFrame()).toMatch(/Account Three .+ account-3/);
+  });
+});
+
+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/api/form_data.ts

@@ -1,72 +1,11 @@
 import type {
   CfWorkerInit,
   CfModuleType,
-  CfVariable,
   CfModule,
+  CfDurableObjectMigrations,
 } 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":
@@ -84,13 +23,36 @@ export function toMimeType(type: CfModuleType): string {
   }
 }
 
-function toModule(module: CfModule, entryType?: CfModuleType): Blob {
+function toModule(module: CfModule, entryType: CfModuleType): Blob {
   const { type: moduleType, content } = module;
   const type = toMimeType(moduleType ?? entryType);
 
   return new Blob([content], { type });
 }
 
+interface WorkerMetadata {
+  compatibility_date?: string;
+  compatibility_flags?: string[];
+  usage_model?: "bundled" | "unbound";
+  migrations?: CfDurableObjectMigrations;
+  bindings: (
+    | { type: "kv_namespace"; name: string; namespace_id: string }
+    | { type: "plain_text"; name: string; text: string }
+    | {
+        type: "durable_object_namespace";
+        name: string;
+        class_name: string;
+        script_name?: string;
+      }
+    | {
+        type: "service";
+        name: string;
+        service: string;
+        environment: string;
+      }
+  )[];
+}
+
 /**
  * Creates a `FormData` upload from a `CfWorkerInit`.
  */
@@ -99,24 +61,52 @@ export function toFormData(worker: CfWorkerInit): FormData {
   const {
     main,
     modules,
-    variables,
+    bindings,
     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 metadataBindings: WorkerMetadata["bindings"] = [];
 
-  // TODO: this object should be typed
-  const metadata = {
-    ...(mainType !== "commonjs" ? { main_module: name } : { body_part: name }),
-    bindings,
+  bindings.kv_namespaces?.forEach(({ id, binding }) => {
+    metadataBindings.push({
+      name: binding,
+      type: "kv_namespace",
+      namespace_id: id,
+    });
+  });
+
+  bindings.durable_objects?.bindings.forEach(
+    ({ name, class_name, script_name }) => {
+      metadataBindings.push({
+        name,
+        type: "durable_object_namespace",
+        class_name: class_name,
+        ...(script_name && { script_name }),
+      });
+    }
+  );
+
+  Object.entries(bindings.vars || {})?.forEach(([key, value]) => {
+    metadataBindings.push({ name: key, type: "plain_text", text: value });
+  });
+
+  bindings.services?.forEach(({ name, service, environment }) => {
+    metadataBindings.push({
+      name,
+      type: "service",
+      service,
+      environment,
+    });
+  });
+
+  const metadata: WorkerMetadata = {
+    ...(main.type !== "commonjs"
+      ? { main_module: main.name }
+      : { body_part: main.name }),
+    bindings: metadataBindings,
     ...(compatibility_date && { compatibility_date }),
     ...(compatibility_flags && { compatibility_flags }),
     ...(usage_model && { usage_model }),
@@ -125,7 +115,7 @@ export function toFormData(worker: CfWorkerInit): FormData {
 
   formData.set("metadata", JSON.stringify(metadata));
 
-  if (mainType === "commonjs" && modules && modules.length > 0) {
+  if (main.type === "commonjs" && modules && modules.length > 0) {
     throw new TypeError(
       "More than one module can only be specified when type = 'esm'"
     );
@@ -133,7 +123,7 @@ export function toFormData(worker: CfWorkerInit): FormData {
 
   for (const module of [main].concat(modules || [])) {
     const { name } = module;
-    const blob = toModule(module, mainType ?? "esm");
+    const blob = toModule(module, main.type ?? "esm");
     formData.set(name, blob, name);
   }
 

package/src/api/preview.ts

@@ -1,7 +1,7 @@
-import cfetch from "../cfetch";
+import fetch from "node-fetch";
+import { fetchResult } from "../cfetch";
 import { toFormData } from "./form_data";
 import type { CfAccount, CfWorkerInit } from "./worker";
-import fetch from "node-fetch";
 
 /**
  * A preview mode.
@@ -60,7 +60,7 @@ async function sessionToken(account: CfAccount): Promise<CfPreviewToken> {
     ? `/zones/${zoneId}/workers/edge-preview`
     : `/accounts/${accountId}/workers/subdomain/edge-preview`;
 
-  const { exchange_url } = await cfetch<{ exchange_url: string }>(initUrl);
+  const { exchange_url } = await fetchResult<{ exchange_url: string }>(initUrl);
   const { inspector_websocket, token } = (await (
     await fetch(exchange_url)
   ).json()) as { inspector_websocket: string; token: string };
@@ -106,7 +106,7 @@ export async function previewToken(
   const formData = toFormData(worker);
   formData.set("wrangler-session-config", JSON.stringify(mode));
 
-  const { preview_token } = await cfetch<{ preview_token: string }>(url, {
+  const { preview_token } = await fetchResult<{ preview_token: string }>(url, {
     method: "POST",
     // @ts-expect-error TODO: fix this
     body: formData,

package/src/api/worker.ts

@@ -62,22 +62,40 @@ export interface CfModule {
   type?: CfModuleType;
 }
 
+/**
+ * A map of variable names to values.
+ */
+interface CfVars {
+  [key: string]: string;
+}
+
 /**
  * A KV namespace.
  */
-export interface CfKvNamespace {
-  /**
-   * The namespace ID.
-   */
-  namespaceId: string;
+interface CfKvNamespace {
+  binding: string;
+  id: string;
 }
 
-export interface CfDurableObject {
+/**
+ * A Durable Object.
+ */
+interface CfDurableObject {
+  name: string;
   class_name: string;
   script_name?: string;
 }
 
-interface CfDOMigrations {
+/**
+ * A Service.
+ */
+interface CfService {
+  name: string;
+  service: string;
+  environment: string;
+}
+
+export interface CfDurableObjectMigrations {
   old_tag?: string;
   new_tag: string;
   steps: {
@@ -87,35 +105,6 @@ interface CfDOMigrations {
   }[];
 }
 
-/**
- * A `WebCrypto` key.
- *
- * @link https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey
- */
-export interface CfCryptoKey {
-  /**
-   * The format.
-   */
-  format: string;
-  /**
-   * The algorithm.
-   */
-  algorithm: string;
-  /**
-   * The usages.
-   */
-  usages: string[];
-  /**
-   * The data.
-   */
-  data: BufferSource | JsonWebKey;
-}
-
-/**
- * A variable (aka. environment variable).
- */
-export type CfVariable = string | CfKvNamespace | CfCryptoKey | CfDurableObject;
-
 /**
  * Options for creating a `CfWorker`.
  */
@@ -123,7 +112,7 @@ export interface CfWorkerInit {
   /**
    * The name of the worker.
    */
-  name: string | void;
+  name: string | undefined;
   /**
    * The entrypoint module.
    */
@@ -131,15 +120,20 @@ export interface CfWorkerInit {
   /**
    * The list of additional modules.
    */
-  modules: void | CfModule[];
+  modules: undefined | CfModule[];
   /**
-   * The map of names to variables. (aka. environment variables)
+   * All the bindings
    */
-  variables?: { [name: string]: CfVariable };
-  migrations: void | CfDOMigrations;
-  compatibility_date: string | void;
-  compatibility_flags: void | string[];
-  usage_model: void | "bundled" | "unbound";
+  bindings: {
+    kv_namespaces?: CfKvNamespace[];
+    durable_objects?: { bindings: CfDurableObject[] };
+    vars?: CfVars;
+    services?: CfService[];
+  };
+  migrations: undefined | CfDurableObjectMigrations;
+  compatibility_date: string | undefined;
+  compatibility_flags: undefined | string[];
+  usage_model: undefined | "bundled" | "unbound";
 }
 
 /**

package/src/cfetch/index.ts

@@ -0,0 +1,110 @@
+import type { RequestInit } from "node-fetch";
+import { URLSearchParams } from "url";
+import { fetchInternal } from "./internal";
+
+// Check out https://api.cloudflare.com/ for API docs.
+
+export { CF_API_BASE_URL } from "./internal";
+
+export interface FetchError {
+  code: number;
+  message: string;
+}
+export interface FetchResult<ResponseType = unknown> {
+  success: boolean;
+  result: ResponseType;
+  errors: FetchError[];
+  messages: string[];
+  result_info?: unknown;
+}
+
+/**
+ * Make a fetch request for a raw JSON value.
+ */
+export async function fetchRaw<ResponseType>(
+  resource: string,
+  init: RequestInit = {},
+  queryParams?: URLSearchParams
+): Promise<ResponseType> {
+  return fetchInternal<ResponseType>(resource, init, queryParams);
+}
+
+/**
+ * Make a fetch request, and extract the `result` from the JSON response.
+ */
+export async function fetchResult<ResponseType>(
+  resource: string,
+  init: RequestInit = {},
+  queryParams?: URLSearchParams
+): Promise<ResponseType> {
+  const json = await fetchInternal<FetchResult<ResponseType>>(
+    resource,
+    init,
+    queryParams
+  );
+  if (json.success) {
+    return json.result;
+  } else {
+    throwFetchError(resource, json);
+  }
+}
+
+/**
+ * Make a fetch request for a list of values,
+ * extracting the `result` from the JSON response,
+ * and repeating the request if the results are paginated.
+ */
+export async function fetchListResult<ResponseType>(
+  resource: string,
+  init: RequestInit = {},
+  queryParams?: URLSearchParams
+): Promise<ResponseType[]> {
+  const results: ResponseType[] = [];
+  let getMoreResults = true;
+  let cursor: string | undefined;
+  while (getMoreResults) {
+    if (cursor) {
+      queryParams = new URLSearchParams(queryParams);
+      queryParams.set("cursor", cursor);
+    }
+    const json = await fetchInternal<FetchResult<ResponseType[]>>(
+      resource,
+      init,
+      queryParams
+    );
+    if (json.success) {
+      results.push(...json.result);
+      if (hasCursor(json.result_info)) {
+        cursor = json.result_info?.cursor;
+      } else {
+        getMoreResults = false;
+      }
+    } else {
+      throwFetchError(resource, json);
+    }
+  }
+  return results;
+}
+
+function throwFetchError(
+  resource: string,
+  response: FetchResult<unknown>
+): never {
+  response.messages.forEach((message) => console.warn(message));
+  const errors = response.errors
+    .map((error) => `${error.code}: ${error.message}`)
+    .join("\n");
+  const error = new Error(`Failed to fetch ${resource} - \n${errors}`);
+  // add the first error code directly to this error
+  // so consumers can use it for specific behaviour
+  const code = response.errors[0]?.code;
+  if (code) {
+    //@ts-expect-error non-standard property on Error
+    error.code = code;
+  }
+  throw error;
+}
+
+function hasCursor(result_info: unknown): result_info is { cursor: string } {
+  return (result_info as { cursor: string } | undefined)?.cursor !== undefined;
+}

package/src/cfetch/internal.ts

@@ -0,0 +1,71 @@
+import fetch from "node-fetch";
+import type { RequestInit, HeadersInit } from "node-fetch";
+import { getAPIToken, loginOrRefreshIfRequired } from "../user";
+
+export const CF_API_BASE_URL =
+  process.env.CF_API_BASE_URL || "https://api.cloudflare.com/client/v4";
+
+/**
+ * Make a fetch request to the Cloudflare API.
+ *
+ * This function handles acquiring the API token and logging the caller in, as necessary.
+ *
+ * Check out https://api.cloudflare.com/ for API docs.
+ *
+ * This function should not be used directly, instead use the functions in `cfetch/index.ts`.
+ */
+export async function fetchInternal<ResponseType>(
+  resource: string,
+  init: RequestInit = {},
+  queryParams?: URLSearchParams
+): Promise<ResponseType> {
+  await requireLoggedIn();
+  const apiToken = requireApiToken();
+  const headers = cloneHeaders(init.headers);
+  addAuthorizationHeader(headers, apiToken);
+
+  const queryString = queryParams ? `?${queryParams.toString()}` : "";
+  const response = await fetch(`${CF_API_BASE_URL}${resource}${queryString}`, {
+    method: "GET",
+    ...init,
+    headers,
+  });
+
+  const jsonText = await response.text();
+  try {
+    const json = JSON.parse(jsonText);
+    return json as ResponseType;
+  } catch (e) {
+    throw new Error(
+      `Failed to fetch ${resource} - ${response.status}: ${response.statusText}\nInvalid JSON response:\n${jsonText}`
+    );
+  }
+}
+
+function cloneHeaders(headers: HeadersInit | undefined): HeadersInit {
+  return { ...headers };
+}
+
+async function requireLoggedIn(): Promise<void> {
+  const loggedIn = await loginOrRefreshIfRequired();
+  if (!loggedIn) {
+    throw new Error("Not logged in.");
+  }
+}
+
+function requireApiToken(): string {
+  const apiToken = getAPIToken();
+  if (!apiToken) {
+    throw new Error("No API token found.");
+  }
+  return apiToken;
+}
+
+function addAuthorizationHeader(headers: HeadersInit, apiToken: string): void {
+  if (headers["Authorization"]) {
+    throw new Error(
+      "The request already specifies an authorisation header - cannot add a new one."
+    );
+  }
+  headers["Authorization"] = `Bearer ${apiToken}`;
+}