wrangler 0.0.0-e151223 → 0.0.0-e1e2ee5c

package/pages/functions/template-worker.ts

@@ -1,136 +0,0 @@
-import { match } from "path-to-regexp";
-import type { HTTPMethod } from "./routes";
-
-/* TODO: Grab these from @cloudflare/workers-types instead */
-type Params<P extends string = string> = Record<P, string | string[]>;
-
-type EventContext<Env, P extends string, Data> = {
-  request: Request;
-  waitUntil: (promise: Promise<unknown>) => void;
-  next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
-  env: Env & { ASSETS: { fetch: typeof fetch } };
-  params: Params<P>;
-  data: Data;
-};
-
-declare type PagesFunction<
-  Env = unknown,
-  P extends string = string,
-  Data extends Record<string, unknown> = Record<string, unknown>
-> = (context: EventContext<Env, P, Data>) => Response | Promise<Response>;
-/* end @cloudflare/workers-types */
-
-type RouteHandler = {
-  routePath: string;
-  methods: HTTPMethod[];
-  modules: PagesFunction[];
-  middlewares: PagesFunction[];
-};
-
-// inject `routes` via ESBuild
-declare const routes: RouteHandler[];
-// define `__FALLBACK_SERVICE__` via ESBuild
-declare const __FALLBACK_SERVICE__: string;
-
-// expect an ASSETS fetcher binding pointing to the asset-server stage
-type FetchEnv = {
-  [name: string]: { fetch: typeof fetch };
-  ASSETS: { fetch: typeof fetch };
-};
-
-type WorkerContext = {
-  waitUntil: (promise: Promise<unknown>) => void;
-};
-
-function* executeRequest(request: Request, _env: FetchEnv) {
-  const requestPath = new URL(request.url).pathname;
-
-  // First, iterate through the routes (backwards) and execute "middlewares" on partial route matches
-  for (const route of [...routes].reverse()) {
-    if (
-      route.methods.length &&
-      !route.methods.includes(request.method as HTTPMethod)
-    ) {
-      continue;
-    }
-
-    const routeMatcher = match(route.routePath, { end: false });
-    const matchResult = routeMatcher(requestPath);
-    if (matchResult) {
-      for (const handler of route.middlewares.flat()) {
-        yield {
-          handler,
-          params: matchResult.params as Params,
-        };
-      }
-    }
-  }
-
-  // Then look for the first exact route match and execute its "modules"
-  for (const route of routes) {
-    if (
-      route.methods.length &&
-      !route.methods.includes(request.method as HTTPMethod)
-    ) {
-      continue;
-    }
-
-    const routeMatcher = match(route.routePath, { end: true });
-    const matchResult = routeMatcher(requestPath);
-    if (matchResult && route.modules.length) {
-      for (const handler of route.modules.flat()) {
-        yield {
-          handler,
-          params: matchResult.params as Params,
-        };
-      }
-      break;
-    }
-  }
-}
-
-export default {
-  async fetch(request: Request, env: FetchEnv, workerContext: WorkerContext) {
-    const handlerIterator = executeRequest(request, env);
-    const data = {}; // arbitrary data the user can set between functions
-    const next = async (input?: RequestInfo, init?: RequestInit) => {
-      if (input !== undefined) {
-        request = new Request(input, init);
-      }
-
-      const result = handlerIterator.next();
-      // Note we can't use `!result.done` because this doesn't narrow to the correct type
-      if (result.done == false) {
-        const { handler, params } = result.value;
-        const context = {
-          request: new Request(request.clone()),
-          next,
-          params,
-          data,
-          env,
-          waitUntil: workerContext.waitUntil.bind(workerContext),
-        };
-
-        const response = await handler(context);
-
-        // https://fetch.spec.whatwg.org/#null-body-status
-        return new Response(
-          [101, 204, 205, 304].includes(response.status) ? null : response.body,
-          response
-        );
-      } else if (__FALLBACK_SERVICE__) {
-        // There are no more handlers so finish with the fallback service (`env.ASSETS.fetch` in Pages' case)
-        return env[__FALLBACK_SERVICE__].fetch(request);
-      } else {
-        // There was not fallback service so actually make the request to the origin.
-        return fetch(request);
-      }
-    };
-
-    try {
-      return next();
-    } catch (err) {
-      return new Response("Internal Error", { status: 500 });
-    }
-  },
-};

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

@@ -1,27 +0,0 @@
-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__/logout.test.ts

@@ -1,50 +0,0 @@
-import { existsSync } from "node:fs";
-import os from "node:os";
-import path from "node:path";
-import fetchMock from "jest-fetch-mock";
-import { initialise } from "../user";
-import { mockConsoleMethods } from "./helpers/mock-console";
-import { writeUserConfig } from "./helpers/mock-user";
-import { runInTempDir } from "./helpers/run-in-tmp";
-import { runWrangler } from "./helpers/run-wrangler";
-
-describe("wrangler", () => {
-  runInTempDir({ homedir: "./home" });
-  const std = mockConsoleMethods();
-
-  describe("logout", () => {
-    it("should exit with a message stating the user is not logged in", async () => {
-      await initialise();
-      await runWrangler("logout");
-      expect(std.out).toMatchInlineSnapshot(`"Not logged in, exiting..."`);
-    });
-
-    it("should logout user that has been properly logged in", async () => {
-      writeUserConfig("some-oauth-tok", "some-refresh-tok");
-
-      // Mock out the response for a request to revoke the auth tokens,
-      // checking the form of the request is as expected.
-      fetchMock.mockResponseOnce(async (req) => {
-        expect(req.url).toEqual("https://dash.cloudflare.com/oauth2/revoke");
-        expect(req.method).toEqual("POST");
-        return "";
-      });
-
-      await initialise();
-      await runWrangler("logout");
-
-      expect(std.out).toMatchInlineSnapshot(`
-        "💁  Wrangler is configured with an OAuth token. The token has been successfully revoked
-        Removing ./home/.wrangler/config/default.toml.. success!"
-      `);
-
-      // Make sure that we made the request to logout.
-      expect(fetchMock).toHaveBeenCalledTimes(1);
-
-      // Make sure that logout removed the config file containing the auth tokens.
-      expect(
-        existsSync(path.join(os.homedir(), ".wrangler/config/default.toml"))
-      ).toBe(false);
-    });
-  });
-});

package/src/api/form_data.ts

@@ -1,134 +0,0 @@
-import { FormData, File } from "undici";
-import type {
-  CfWorkerInit,
-  CfModuleType,
-  CfModule,
-  CfDurableObjectMigrations,
-} from "./worker.js";
-
-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): File {
-  const { type: moduleType, content } = module;
-  const type = toMimeType(moduleType ?? entryType);
-  return new File([content], module.name, { type });
-}
-
-export interface WorkerMetadata {
-  /** The name of the entry point module. Only exists when the worker is in the ES module format */
-  main_module?: string;
-  /** The name of the entry point module. Only exists when the worker is in the Service Worker format */
-  body_part?: string;
-  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 file = toModule(module, main.type ?? "esm");
-    formData.set(name, file);
-  }
-
-  return formData;
-}

package/src/api/preview.ts

@@ -1,128 +0,0 @@
-import { URL } from "node:url";
-import { fetch } from "undici";
-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",
-    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 { fetch } from "undici";
-import { previewToken } from "./preview";
-import type { CfPreviewToken } from "./preview";
-
-/**
- * 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 | Buffer;
-  /**
-   * 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;
-}