wrangler 0.0.0-e9ab55a → 0.0.0-e9e9872

package/src/__tests__/mock-cfetch.ts

@@ -1,171 +0,0 @@
-import type { RequestInit } from "node-fetch";
-import { URLSearchParams } from "node:url";
-import { pathToRegexp } from "path-to-regexp";
-import { CF_API_BASE_URL } from "../cfetch";
-import type { FetchResult } from "../cfetch";
-
-/**
- * The signature of the function that will handle a mock request.
- */
-export type MockHandler<ResponseType> = (
-  uri: RegExpExecArray,
-  init: RequestInit,
-  queryParams: URLSearchParams
-) => ResponseType;
-
-type RemoveMockFn = () => void;
-
-interface MockFetch<ResponseType> {
-  regexp: RegExp;
-  method: string | undefined;
-  handler: MockHandler<ResponseType>;
-}
-const mocks: MockFetch<unknown>[] = [];
-
-/**
- * The mock implementation of `cfApi.fetch()`.
- *
- * This function will attempt to match the given request to one of the mock handlers configured by calls to `setMock`.
- *
- * Once found the handler will be used to generate a mock response.
- */
-export async function mockFetchInternal(
-  resource: string,
-  init: RequestInit = {},
-  queryParams: URLSearchParams = new URLSearchParams()
-) {
-  for (const { regexp, method, handler } of mocks) {
-    const resourcePath = new URL(resource, CF_API_BASE_URL).pathname;
-    const uri = regexp.exec(resourcePath);
-    // Do the resource path and (if specified) the HTTP method match?
-    if (uri !== null && (!method || method === init.method)) {
-      // 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.
-    }
-  }
-  throw new Error(`no mocks found for ${init.method}: ${resource}`);
-}
-
-/**
- * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
- *
- * @param resource The path of the resource to be matched.
- * This can include wildcards whose value will be passed to the `handler`.
- * @param handler The function that will generate the mock response for this request.
- */
-export function setMockRawResponse<ResponseType>(
-  resource: string,
-  handler: MockHandler<ResponseType>
-): RemoveMockFn;
-/**
- * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
- *
- * @param resource The path of the resource to be matched.
- * This can include wildcards whose value will be passed to the `handler`.
- * @param method The HTTP method (e.g. GET, POST, etc) that the request must have to match this mock handler.
- * @param handler The function that will generate the mock response for this request.
- */
-export function setMockRawResponse<ResponseType>(
-  resource: string,
-  method: string,
-  handler: MockHandler<ResponseType>
-): RemoveMockFn;
-/**
- * Specify an expected resource path that is to be handled, resulting in a raw JSON response.
- */
-export function setMockRawResponse<ResponseType>(
-  resource: string,
-  ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
-): RemoveMockFn {
-  const handler = args.pop() as MockHandler<ResponseType>;
-  const method = args.pop() as string;
-  const mock = {
-    resource,
-    method,
-    handler,
-    regexp: pathToRegexp(resource),
-  };
-  mocks.push(mock);
-  return () => {
-    const mockIndex = mocks.indexOf(mock);
-    if (mockIndex !== -1) {
-      mocks.splice(mockIndex, 1);
-    }
-  };
-}
-
-/**
- * Specify an expected resource path that is to be handled, resulting in a `FetchRequest`.
- *
- * The mock `handler` should return the `result`, which will then be wrapped in a `FetchRequest` object.
- *
- * @param resource The path of the resource to be matched.
- * This can include wildcards whose value will be passed to the `handler`.
- * @param handler The function that will generate the mock response for this request.
- */
-export function setMockResponse<ResponseType>(
-  resource: string,
-  handler: MockHandler<ResponseType>
-): RemoveMockFn;
-/**
- * Specify an expected resource path that is to be handled, resulting in a FetchRequest..
- *
- * @param resource The path of the resource to be matched.
- * This can include wildcards whose value will be passed to the `handler`.
- * @param method The HTTP method (e.g. GET, POST, etc) that the request must have to match this mock handler.
- * @param handler The function that will generate the mock response for this request.
- */
-export function setMockResponse<ResponseType>(
-  resource: string,
-  method: string,
-  handler: MockHandler<ResponseType>
-): RemoveMockFn;
-/**
- * Specify an expected resource path that is to be handled, resulting in a FetchRequest.
- */
-export function setMockResponse<ResponseType>(
-  resource: string,
-  ...args: [string, MockHandler<ResponseType>] | [MockHandler<ResponseType>]
-): RemoveMockFn {
-  const handler = args.pop() as MockHandler<ResponseType>;
-  const method = args.pop() as string;
-  return setMockRawResponse(resource, method, (...handlerArgs) =>
-    createFetchResult(handler(...handlerArgs))
-  );
-}
-
-/**
- * A helper to make it easier to create `FetchResult` objects in tests.
- */
-export function createFetchResult<ResponseType>(
-  result: ResponseType,
-  success = true,
-  errors = [],
-  messages = [],
-  result_info?: unknown
-): FetchResult<ResponseType> {
-  return result_info
-    ? {
-        result,
-        success,
-        errors,
-        messages,
-        result_info,
-      }
-    : {
-        result,
-        success,
-        errors,
-        messages,
-      };
-}
-
-/**
- * Remove all the configured mock handlers.
- *
- * This should be called in an `afterEach()` block to ensure that mock handlers do not leak between tests.
- */
-export function unsetAllMocks() {
-  mocks.length = 0;
-}

package/src/__tests__/mock-dialogs.ts

@@ -1,65 +0,0 @@
-import { confirm, prompt } from "../dialogs";
-
-/**
- * The expected values for a confirmation request.
- */
-export interface ConfirmExpectation {
-  /** The text expected to be seen in the confirmation dialog. */
-  text: string;
-  /** The mock response send back from the confirmation dialog. */
-  result: boolean;
-}
-
-/**
- * Mock the implementation of `confirm()` that will respond with configured results
- * for configured confirmation text messages.
- *
- * If there is a call to `confirm()` that does not match any of the expectations
- * then an error is thrown.
- */
-export function mockConfirm(...expectations: ConfirmExpectation[]) {
-  (confirm as jest.Mock).mockImplementation((text: string) => {
-    for (const { text: expectedText, result } of expectations) {
-      if (text === expectedText) {
-        return Promise.resolve(result);
-      }
-    }
-    throw new Error(`Unexpected confirmation message: ${text}`);
-  });
-}
-
-/**
- * The expected values for a prompt request.
- */
-export interface PromptExpectation {
-  /** The text expected to be seen in the prompt dialog. */
-  text: string;
-  /** The type of the prompt. */
-  type: "text" | "password";
-  /** The mock response send back from the prompt dialog. */
-  result: string;
-}
-
-/**
- * Mock the implementation of `prompt()` that will respond with configured results
- * for configured prompt text messages.
- *
- * If there is a call to `prompt()` that does not match any of the expectations
- * then an error is thrown.
- */
-export function mockPrompt(...expectations: PromptExpectation[]) {
-  (prompt as jest.Mock).mockImplementation(
-    (text: string, type: "text" | "password") => {
-      for (const {
-        text: expectedText,
-        type: expectedType,
-        result,
-      } of expectations) {
-        if (text === expectedText && type == expectedType) {
-          return Promise.resolve(result);
-        }
-      }
-      throw new Error(`Unexpected confirmation message: ${text}`);
-    }
-  );
-}

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

@@ -1,19 +0,0 @@
-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

@@ -1,32 +0,0 @@
-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/api/form_data.ts

@@ -1,131 +0,0 @@
-import type {
-  CfWorkerInit,
-  CfModuleType,
-  CfModule,
-  CfDurableObjectMigrations,
-} from "./worker.js";
-import { FormData, Blob } from "formdata-node";
-
-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 });
-}
-
-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`.
- */
-export function toFormData(worker: CfWorkerInit): FormData {
-  const formData = new FormData();
-  const {
-    main,
-    modules,
-    bindings,
-    migrations,
-    usage_model,
-    compatibility_date,
-    compatibility_flags,
-  } = worker;
-
-  const metadataBindings: WorkerMetadata["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 }),
-    ...(migrations && { migrations }),
-  };
-
-  formData.set("metadata", JSON.stringify(metadata));
-
-  if (main.type === "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, main.type ?? "esm");
-    formData.set(name, blob, name);
-  }
-
-  return formData;
-}

package/src/api/preview.ts

@@ -1,128 +0,0 @@
-import fetch from "node-fetch";
-import { fetchResult } from "../cfetch";
-import { toFormData } from "./form_data";
-import type { CfAccount, CfWorkerInit } from "./worker";
-
-/**
- * A preview mode.
- *
- * * If true, then using a `workers.dev` subdomain.
- * * Otherwise, a list of routes under a single zone.
- */
-type CfPreviewMode = { workers_dev: boolean } | { routes: string[] };
-
-/**
- * A preview token.
- */
-export interface CfPreviewToken {
-  /**
-   * The header value required to trigger a preview.
-   *
-   * @example
-   * const headers = { 'cf-workers-preview-token': value }
-   * const response = await fetch('https://' + host, { headers })
-   */
-  value: string;
-  /**
-   * The host where the preview is available.
-   */
-  host: string;
-  /**
-   * A websocket url to a DevTools inspector.
-   *
-   * Workers does not have a fully-featured implementation
-   * of the Chrome DevTools protocol, but supports the following:
-   *  * `console.log()` output.
-   *  * `Error` stack traces.
-   *  * `fetch()` events.
-   *
-   * There is no support for breakpoints, but we want to implement
-   * this eventually.
-   *
-   * @link https://chromedevtools.github.io/devtools-protocol/
-   */
-  inspectorUrl: URL;
-  /**
-   * A url to prewarm the preview session.
-   *
-   * @example
-   * fetch(prewarmUrl, { method: 'POST' })
-   */
-  prewarmUrl: URL;
-}
-
-/**
- * Generates a preview session token.
- */
-async function sessionToken(account: CfAccount): Promise<CfPreviewToken> {
-  const { accountId, zoneId } = account;
-  const initUrl = zoneId
-    ? `/zones/${zoneId}/workers/edge-preview`
-    : `/accounts/${accountId}/workers/subdomain/edge-preview`;
-
-  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 };
-  const { host } = new URL(inspector_websocket);
-  const query = `cf_workers_preview_token=${token}`;
-
-  return {
-    value: token,
-    host,
-    inspectorUrl: new URL(`${inspector_websocket}?${query}`),
-    prewarmUrl: new URL(
-      `https://${host}/cdn-cgi/workers/preview/prewarm?${query}`
-    ),
-  };
-}
-
-// Credit: https://stackoverflow.com/a/2117523
-function randomId(): string {
-  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
-    const r = (Math.random() * 16) | 0,
-      v = c == "x" ? r : (r & 0x3) | 0x8;
-    return v.toString(16);
-  });
-}
-
-/**
- * Creates a preview token.
- */
-export async function previewToken(
-  account: CfAccount,
-  worker: CfWorkerInit
-): Promise<CfPreviewToken> {
-  const { value, host, inspectorUrl, prewarmUrl } = await sessionToken(account);
-
-  const { accountId, zoneId } = account;
-  const scriptId = zoneId ? randomId() : worker.name || host.split(".")[0];
-  const url = `/accounts/${accountId}/workers/scripts/${scriptId}/edge-preview`;
-
-  const mode: CfPreviewMode = zoneId
-    ? { routes: ["*/*"] }
-    : { workers_dev: true };
-
-  const formData = toFormData(worker);
-  formData.set("wrangler-session-config", JSON.stringify(mode));
-
-  const { preview_token } = await fetchResult<{ preview_token: string }>(url, {
-    method: "POST",
-    // @ts-expect-error TODO: fix this
-    body: formData,
-    headers: {
-      "cf-preview-upload-config-token": value,
-    },
-  });
-
-  return {
-    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

@@ -1,155 +0,0 @@
-import type { CfPreviewToken } from "./preview";
-import { previewToken } from "./preview";
-import fetch from "node-fetch";
-
-/**
- * A Cloudflare account.
- */
-export interface CfAccount {
-  /**
-   * An API token.
-   *
-   * @link https://api.cloudflare.com/#user-api-tokens-properties
-   */
-  apiToken: string;
-  /**
-   * An account ID.
-   */
-  accountId: string;
-  /**
-   * A zone ID, only required if not using `workers.dev`.
-   */
-  zoneId?: string;
-}
-
-/**
- * A module type.
- */
-export type CfModuleType =
-  | "esm"
-  | "commonjs"
-  | "compiled-wasm"
-  | "text"
-  | "buffer";
-
-/**
- * An imported module.
- */
-export interface CfModule {
-  /**
-   * The module name.
-   *
-   * @example
-   * './src/index.js'
-   */
-  name: string;
-  /**
-   * The module content, usually JavaScript or WASM code.
-   *
-   * @example
-   * export default {
-   *   async fetch(request) {
-   *     return new Response('Ok')
-   *   }
-   * }
-   */
-  content: string | BufferSource;
-  /**
-   * The module type.
-   *
-   * If absent, will default to the main module's type.
-   */
-  type?: CfModuleType;
-}
-
-/**
- * A map of variable names to values.
- */
-interface CfVars {
-  [key: string]: string;
-}
-
-/**
- * A KV namespace.
- */
-interface CfKvNamespace {
-  binding: string;
-  id: string;
-}
-
-/**
- * A Durable Object.
- */
-interface CfDurableObject {
-  name: string;
-  class_name: string;
-  script_name?: string;
-}
-
-/**
- * A Service.
- */
-interface CfService {
-  name: string;
-  service: string;
-  environment: string;
-}
-
-export interface CfDurableObjectMigrations {
-  old_tag?: string;
-  new_tag: string;
-  steps: {
-    new_classes?: string[];
-    renamed_classes?: string[];
-    deleted_classes?: string[];
-  }[];
-}
-
-/**
- * Options for creating a `CfWorker`.
- */
-export interface CfWorkerInit {
-  /**
-   * The name of the worker.
-   */
-  name: string | undefined;
-  /**
-   * The entrypoint module.
-   */
-  main: CfModule;
-  /**
-   * The list of additional modules.
-   */
-  modules: undefined | CfModule[];
-  /**
-   * All the bindings
-   */
-  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";
-}
-
-/**
- * A stub to create a Cloudflare Worker preview.
- *
- * @example
- * const {value, host} = await createWorker(init, acct);
- */
-export async function createWorker(
-  init: CfWorkerInit,
-  account: CfAccount
-): Promise<CfPreviewToken> {
-  const token = await previewToken(account, init);
-  const response = await fetch(token.prewarmUrl.href, { method: "POST" });
-  if (!response.ok) {
-    // console.error("worker failed to prewarm: ", response.statusText);
-  }
-  return token;
-}