wrangler 0.0.0-ece06ea → 0.0.0-ecfbb0c

package/src/api/preview.ts

@@ -1,123 +0,0 @@
-import cfetch from "../cfetch";
-import { fetchJson } from "../util/fetch";
-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.
- */
-export 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: tokenUrl } = await cfetch<{ exchange_url: string }>(
-    initUrl
-  );
-  const { inspector_websocket: url, token } = await fetchJson()(tokenUrl);
-  const { host } = new URL(url);
-  const query = `cf_workers_preview_token=${token}`;
-
-  return {
-    value: token,
-    host,
-    inspectorUrl: new URL(`${url}?${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() : host.split(".")[0];
-  const url = `/accounts/${accountId}/workers/scripts/${scriptId}/edge-preview`;
-
-  const mode = 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,
-      },
-    }
-  );
-  return {
-    value: token,
-    host,
-    inspectorUrl,
-    prewarmUrl,
-  };
-}

package/src/api/worker.ts

@@ -1,161 +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 KV namespace.
- */
-export interface CfKvNamespace {
-  /**
-   * The namespace ID.
-   */
-  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.
- *
- * @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`.
- */
-export interface CfWorkerInit {
-  /**
-   * The name of the worker.
-   */
-  name: string;
-  /**
-   * The entrypoint module.
-   */
-  main: CfModule;
-  /**
-   * The list of additional modules.
-   */
-  modules: void | CfModule[];
-  /**
-   * The map of names to variables. (aka. environment variables)
-   */
-  variables?: { [name: string]: CfVariable };
-  migrations: void | CfDOMigrations;
-  compatibility_date: string | void;
-  compatibility_flags: void | string[];
-  usage_model: void | "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;
-}

package/src/cfetch.ts

@@ -1,72 +0,0 @@
-import fetch from "node-fetch";
-import type { RequestInit } from "node-fetch";
-import { getAPIToken } from "./user";
-import { loginOrRefreshIfRequired } from "./user";
-
-export const CF_API_BASE_URL =
-  process.env.CF_API_BASE_URL || "https://api.cloudflare.com/client/v4";
-
-export default async function fetchWithAuthAndLoginIfRequired<ResponseType>(
-  resource: string,
-  init: RequestInit = {}
-): Promise<ResponseType> {
-  const loggedIn = await loginOrRefreshIfRequired();
-  if (!loggedIn) {
-    throw new Error("Not logged in");
-  }
-  const apiToken = getAPIToken();
-  if (!apiToken) {
-    throw new Error("No API token found");
-  }
-  // @ts-expect-error Authorization isn't non HeadersInit, annoyingly
-  if (init.headers?.Authorization) {
-    throw new Error(
-      "fetchWithAuthAndLoginIfRequired will not add an authorisation header a request that already specifies it"
-    );
-  }
-  // should I bother with response code?
-  // maybe I can just throw the json error?
-
-  const response = await fetch(`${CF_API_BASE_URL}${resource}`, {
-    method: "GET",
-    ...init,
-    headers: {
-      ...(init.headers || {}),
-      Authorization: `Bearer ${apiToken}`,
-    },
-  });
-  const text = await response.text();
-  let json;
-  try {
-    json = JSON.parse(text);
-  } catch (parseError) {
-    // hate this edge case
-    // the only api call I know that doesn't return json is kv:key get <key>
-
-    // maybe it's a plain response
-    if (response.ok) {
-      // @ts-expect-error bleh
-      return text;
-    } else {
-      // UGH.
-      throw new Error(`${response.status}: ${response.statusText}`);
-    }
-  }
-
-  if (json.success) {
-    return json.result;
-  } else {
-    const errorDesc = json.errors?.[0];
-    if (errorDesc) {
-      // TODO: map .message to real human readable strings
-      const error = new Error(`${errorDesc.code}: ${errorDesc.message}`);
-      // @ts-expect-error hacksss
-      error.code = errorDesc.code;
-      throw error;
-    } else {
-      // This should almost never happen.
-      // ... which means it'll probably happen, lol.
-      throw new Error(`${response.status}: ${response.statusText}`);
-    }
-  }
-}

package/src/config.ts

@@ -1,124 +0,0 @@
-// we're going to manually write both the type definition AND
-// the validator for the config, so that we can give better error messages
-
-type DOMigration = {
-  tag: string;
-  new_classes?: string[];
-  renamed_classes?: string[];
-  deleted_classes?: string[];
-};
-
-type Project = "webpack" | "javascript" | "rust";
-
-type Site = {
-  // inherited
-  bucket: string;
-  "entry-point": string;
-  include?: string[];
-  exclude?: string[];
-};
-
-type Dev = {
-  ip?: string;
-  port?: number;
-  local_protocol?: string;
-  upstream_protocol?: string;
-};
-
-type Vars = { [key: string]: string };
-
-type Cron = string; // TODO: we should be able to parse a cron pattern with ts
-
-type KVNamespace = {
-  binding?: string;
-  preview_id: string;
-  id: string;
-};
-
-type DurableObject = {
-  name: string;
-  class_name: string;
-  script_name?: string;
-};
-
-type Build = {
-  command?: string;
-  cwd?: string;
-  watch_dir?: string;
-} & (
-  | {
-      upload?: {
-        format: "service-worker";
-        main: string;
-      };
-    }
-  | {
-      upload?: {
-        format: "modules";
-        dir?: string;
-        main?: string;
-        rules?: {
-          type: "ESModule" | "CommonJS" | "Text" | "Data" | "CompiledWasm";
-          globs: string[]; // can we use typescript for these patterns?
-          fallthrough?: boolean;
-        };
-      };
-    }
-);
-
-type UsageModel = "bundled" | "unbound";
-
-type Env = {
-  name?: string; // inherited
-  account_id?: string; // inherited
-  workers_dev?: boolean; // inherited
-  compatibility_date?: string; // inherited
-  compatibility_flags?: string[]; // inherited
-  zone_id?: string; // inherited
-  routes?: string[]; // inherited
-  route?: string; // inherited
-  webpack_config?: string; // inherited
-  site?: Site;
-  jsx_factory?: string; // inherited
-  jsx_fragment?: string; // inherited
-  polyfill_node?: boolean; //inherited
-  // we should use typescript to parse cron patterns
-  triggers?: { crons: Cron[] }; // inherited
-  vars?: Vars;
-  durable_objects?: { bindings: DurableObject[] };
-  kv_namespaces?: KVNamespace[];
-  usage_model?: UsageModel; // inherited
-};
-
-export type Config = {
-  name?: string; // inherited
-  account_id?: string; // inherited
-  // @deprecated Don't use this
-  type?: Project; // top level
-  compatibility_date?: string; // inherited
-  compatibility_flags?: string[]; // inherited
-  // -- there's some mutually exclusive logic for this next block,
-  // but I didn't bother for now
-  workers_dev?: boolean; // inherited
-  zone_id?: string; // inherited
-  routes?: string[]; // inherited
-  route?: string; // inherited
-  // -- end mutually exclusive stuff
-  // @deprecated Don't use this
-  webpack_config?: string; // inherited
-  jsx_factory?: string; // inherited
-  jsx_fragment?: string; // inherited
-  polyfill_node?: boolean; //inherited
-  vars?: Vars;
-  migrations?: DOMigration[];
-  durable_objects?: { bindings: DurableObject[] };
-  kv_namespaces?: KVNamespace[];
-  site?: Site; // inherited
-  // we should use typescript to parse cron patterns
-  triggers?: { crons: Cron[] }; // inherited
-  dev?: Dev;
-  usage_model?: UsageModel; // inherited
-  // top level
-  build?: Build;
-  env?: { [envName: string]: void | Env };
-};

package/src/kv.tsx

@@ -1,211 +0,0 @@
-import type { Config } from "./config";
-import cfetch from "./cfetch";
-import qs from "node:querystring";
-
-type KvArgs = {
-  binding?: string;
-  "namespace-id"?: string;
-  env?: string;
-  preview?: boolean;
-  config?: Config;
-};
-
-export async function listNamespaces(accountId: string) {
-  let page = 1,
-    done = false,
-    results = [];
-  while (!(done || results.length % 100 !== 0)) {
-    const json = await cfetch<
-      { id: string; title: string; supports_url_encoding: boolean }[]
-    >(
-      `/accounts/${accountId}/storage/kv/namespaces?per_page=100&order=title&direction=asc&page=${page}`
-    );
-    page++;
-    results = [...results, ...json];
-    if (json.length === 0) {
-      done = true;
-    }
-  }
-  return results;
-}
-
-export async function listNamespaceKeys(
-  accountId: string,
-  namespaceId: string,
-  prefix?: string,
-  limit?: number
-) {
-  // TODO: this doesn't appear to do pagination
-  return await cfetch<
-    { name: string; expiration: number; metadata: { [key: string]: unknown } }[]
-  >(
-    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/keys?${qs.stringify(
-      { prefix, limit }
-    )}`
-  );
-}
-
-export async function putKeyValue(
-  accountId: string,
-  namespaceId: string,
-  key: string,
-  value: string,
-  args?: { expiration?: number; expiration_ttl?: number }
-) {
-  return await cfetch(
-    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${key}?${
-      args
-        ? qs.stringify({
-            expiration: args.expiration,
-            expiration_ttl: args.expiration_ttl,
-          })
-        : ""
-    }`,
-    { method: "PUT", body: value }
-  );
-}
-
-export async function putBulkKeyValue(
-  accountId: string,
-  namespaceId: string,
-  keyvalueStr: string
-) {
-  return await cfetch(
-    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
-    {
-      method: "PUT",
-      body: keyvalueStr,
-      headers: { "Content-Type": "application/json" },
-    }
-  );
-}
-
-export async function deleteBulkKeyValue(
-  accountId: string,
-  namespaceId: string,
-  keyStr: string
-) {
-  return await cfetch(
-    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
-    {
-      method: "DELETE",
-      body: keyStr,
-      headers: { "Content-Type": "application/json" },
-    }
-  );
-}
-
-export function getNamespaceId({
-  preview,
-  binding,
-  config,
-  "namespace-id": namespaceId,
-  env,
-}: KvArgs): string {
-  // nice
-  if (namespaceId) {
-    return namespaceId;
-  }
-
-  // begin pre-flight checks
-
-  // `--binding` is only valid if there's a wrangler configuration file.
-  if (binding && !config) {
-    throw new Error("--binding specified, but no config file was found.");
-  }
-
-  // there's no config. abort here
-  if (!config) {
-    throw new Error(
-      "Failed to find a config file.\n" +
-        "Either use --namespace to upload directly or create a configuration file with a binding."
-    );
-  }
-
-  // they want to use an environment, actually
-  if (env) {
-    if (!config.env || !config.env[env]) {
-      throw new Error(
-        `Failed to find environment "${env}" in configuration file!`
-      );
-    }
-
-    // TODO: either a bespoke arg type for this function to avoid undefineds or a EnvOrConfig type
-    return getNamespaceId({
-      binding,
-      "namespace-id": namespaceId,
-      env: undefined,
-      preview,
-      config: {
-        env: undefined,
-        build: undefined,
-        name: undefined,
-        account_id: undefined,
-        ...config.env[env],
-      },
-    });
-  }
-
-  // there's no KV namespaces
-  if (!config.kv_namespaces || config.kv_namespaces.length === 0) {
-    throw new Error(
-      "No KV Namespace to upload to! Either use --namespace to upload directly or add a KV namespace to your wrangler config file."
-    );
-  }
-
-  const namespace = config.kv_namespaces.find(
-    (namespace) => namespace.binding === binding
-  );
-
-  // we couldn't find a namespace with that binding
-  if (!namespace) {
-    throw new Error(`No KV Namespaces found with binding ${binding}!`);
-  }
-
-  // end pre-flight checks
-
-  // we're in preview mode, `--preview true` or `--preivew` was passed
-  if (preview && namespace.preview_id) {
-    namespaceId = namespace.preview_id;
-  } else {
-    throw new Error(
-      `No preview ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
-    );
-  }
-
-  // either `--preview false`, or preview wasn't passed
-  // TODO: should we care? or should we just treat false and undefined the same
-  const previewIsDefined = typeof preview !== "undefined";
-
-  // --preview false was passed
-  if (previewIsDefined && namespace.id) {
-    namespaceId = namespace.id;
-  } else {
-    throw new Error(
-      `No namespace ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
-    );
-  }
-
-  // `--preview` wasn't passed
-  const bindingHasOnlyOneId =
-    (namespace.id && !namespace.preview_id) ||
-    (!namespace.id && namespace.preview_id);
-  if (bindingHasOnlyOneId) {
-    namespaceId = namespace.id || namespace.preview_id;
-  } else {
-    throw new Error(
-      `${binding} has both a namespace ID and a preview ID. Specify "--preview" or "--preview false" to avoid writing data to the wrong namespace.`
-    );
-  }
-
-  // shouldn't happen. we should be able to prove this with strong typing.
-  // TODO: when we add strongly typed commands, rewrite these checks so they're exhaustive
-  if (!namespaceId) {
-    throw Error(
-      "Something went wrong trying to determine which namespace to upload to.\n" +
-        "Please create a github issue with the command you just ran along with your wrangler configuration."
-    );
-  }
-
-  return namespaceId;
-}