wrangler 0.0.0-e29a241 → 0.0.0-e2a6fa40

package/src/kv.ts

@@ -1,319 +0,0 @@
-import { URLSearchParams } from "node:url";
-import { fetchListResult, fetchResult, fetchKVGetValue } from "./cfetch";
-import type { Config } from "./config";
-
-/** The largest number of kv items we can pass to the API in a single request. */
-const API_MAX = 10000;
-// The const below are halved from the API's true capacity to help avoid
-// hammering it with large requests.
-const BATCH_KEY_MAX = API_MAX / 2;
-
-type KvArgs = {
-  binding?: string;
-  "namespace-id"?: string;
-  preview?: boolean;
-};
-
-/**
- * Create a new namespace under the given `accountId` with the given `title`.
- *
- * @returns the generated id of the created namespace.
- */
-export async function createNamespace(
-  accountId: string,
-  title: string
-): Promise<string> {
-  const response = await fetchResult<{ id: string }>(
-    `/accounts/${accountId}/storage/kv/namespaces`,
-    {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-      },
-      body: JSON.stringify({
-        title,
-      }),
-    }
-  );
-
-  return response.id;
-}
-
-/**
- * The information about a namespace that is returned from `listNamespaces()`.
- */
-export interface KVNamespaceInfo {
-  id: string;
-  title: string;
-  supports_url_encoding?: boolean;
-}
-
-/**
- * Fetch a list of all the namespaces under the given `accountId`.
- */
-export async function listNamespaces(
-  accountId: string
-): Promise<KVNamespaceInfo[]> {
-  const pageSize = 100;
-  let page = 1;
-  const results: KVNamespaceInfo[] = [];
-  while (results.length % pageSize === 0) {
-    const json = await fetchResult<KVNamespaceInfo[]>(
-      `/accounts/${accountId}/storage/kv/namespaces`,
-      {},
-      new URLSearchParams({
-        per_page: pageSize.toString(),
-        order: "title",
-        direction: "asc",
-        page: page.toString(),
-      })
-    );
-    page++;
-    results.push(...json);
-    if (json.length < pageSize) {
-      break;
-    }
-  }
-  return results;
-}
-
-export interface NamespaceKeyInfo {
-  name: string;
-  expiration?: number;
-  metadata?: { [key: string]: unknown };
-}
-
-export async function listNamespaceKeys(
-  accountId: string,
-  namespaceId: string,
-  prefix = ""
-) {
-  return await fetchListResult<NamespaceKeyInfo>(
-    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/keys`,
-    {},
-    new URLSearchParams({ prefix })
-  );
-}
-
-/**
- * Information about a key-value pair, including its "metadata" fields.
- */
-export interface KeyValue {
-  key: string;
-  value: string;
-  expiration?: number;
-  expiration_ttl?: number;
-  metadata?: object;
-  base64?: boolean;
-}
-
-const KeyValueKeys = new Set([
-  "key",
-  "value",
-  "expiration",
-  "expiration_ttl",
-  "metadata",
-  "base64",
-]);
-
-/**
- * Is the given object a valid `KeyValue` type?
- */
-export function isKeyValue(keyValue: object): keyValue is KeyValue {
-  const props = Object.keys(keyValue);
-  if (!props.includes("key") || !props.includes("value")) {
-    return false;
-  }
-  return true;
-}
-
-/**
- * Get all the properties on the `keyValue` that are not expected.
- */
-export function unexpectedKeyValueProps(keyValue: KeyValue): string[] {
-  const props = Object.keys(keyValue);
-  return props.filter((prop) => !KeyValueKeys.has(prop));
-}
-
-export async function putKeyValue(
-  accountId: string,
-  namespaceId: string,
-  keyValue: KeyValue
-) {
-  let searchParams: URLSearchParams | undefined;
-  if (keyValue.expiration || keyValue.expiration_ttl) {
-    searchParams = new URLSearchParams();
-    if (keyValue.expiration) {
-      searchParams.set("expiration", `${keyValue.expiration}`);
-    }
-    if (keyValue.expiration_ttl) {
-      searchParams.set("expiration_ttl", `${keyValue.expiration_ttl}`);
-    }
-  }
-  return await fetchResult(
-    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${keyValue.key}`,
-    { method: "PUT", body: keyValue.value },
-    searchParams
-  );
-}
-
-export async function getKeyValue(
-  accountId: string,
-  namespaceId: string,
-  key: string
-): Promise<string> {
-  return await fetchKVGetValue(accountId, namespaceId, key);
-}
-
-export async function putBulkKeyValue(
-  accountId: string,
-  namespaceId: string,
-  keyValues: KeyValue[],
-  progressCallback: (index: number, total: number) => void
-) {
-  for (let index = 0; index < keyValues.length; index += BATCH_KEY_MAX) {
-    if (progressCallback && keyValues.length > BATCH_KEY_MAX) {
-      progressCallback(index, keyValues.length);
-    }
-
-    await fetchResult(
-      `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
-      {
-        method: "PUT",
-        body: JSON.stringify(keyValues.slice(index, index + BATCH_KEY_MAX)),
-        headers: { "Content-Type": "application/json" },
-      }
-    );
-  }
-  if (progressCallback && keyValues.length > BATCH_KEY_MAX) {
-    progressCallback(keyValues.length, keyValues.length);
-  }
-}
-
-export async function deleteBulkKeyValue(
-  accountId: string,
-  namespaceId: string,
-  keys: string[],
-  progressCallback: (index: number, total: number) => void
-) {
-  for (let index = 0; index < keys.length; index += BATCH_KEY_MAX) {
-    if (progressCallback && keys.length > BATCH_KEY_MAX) {
-      progressCallback(index, keys.length);
-    }
-
-    await fetchResult(
-      `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
-      {
-        method: "DELETE",
-        body: JSON.stringify(keys.slice(index, index + BATCH_KEY_MAX)),
-        headers: { "Content-Type": "application/json" },
-      }
-    );
-  }
-  if (progressCallback && keys.length > BATCH_KEY_MAX) {
-    progressCallback(keys.length, keys.length);
-  }
-}
-
-export function getNamespaceId(
-  { preview, binding, "namespace-id": namespaceId }: KvArgs,
-  config: Config
-): string {
-  // nice
-  if (namespaceId) {
-    return namespaceId;
-  }
-
-  // begin pre-flight checks
-
-  // `--binding` is only valid if there's a wrangler configuration.
-  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-id to upload directly or create a configuration file with a binding."
-    );
-  }
-
-  // there's no KV namespaces
-  if (!config.kv_namespaces || config.kv_namespaces.length === 0) {
-    throw new Error(
-      "No KV Namespaces configured! Either use --namespace-id to upload directly or add a KV namespace to your wrangler config file."
-    );
-  }
-
-  const namespace = config.kv_namespaces.find((ns) => ns.binding === binding);
-
-  // we couldn't find a namespace with that binding
-  if (!namespace) {
-    throw new Error(
-      `A namespace with binding name "${binding}" was not found in the configured "kv_namespaces".`
-    );
-  }
-
-  // end pre-flight checks
-
-  // we're in preview mode, `--preview true` or `--preview` was passed
-  if (preview && namespace.preview_id) {
-    namespaceId = namespace.preview_id;
-    // We don't want to execute code below if preview is set to true, so we just return. Otherwise we will get errors!
-    return namespaceId;
-  } else if (preview) {
-    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;
-    // We don't want to execute code below if preview is set to true, so we just return. Otherwise we can get error!
-    return namespaceId;
-  } else if (previewIsDefined) {
-    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;
-}
-
-/**
- * KV namespace binding names must be valid JS identifiers.
- */
-export function isValidNamespaceBinding(
-  binding: string | undefined
-): binding is string {
-  return (
-    typeof binding === "string" && /^[a-zA-Z_][a-zA-Z0-9_]*$/.test(binding)
-  );
-}

package/src/miniflare-cli/README.md

@@ -1,30 +0,0 @@
-# Custom Miniflare CLI
-
-This directory contains a simple wrapper around the programmatic Miniflare API,
-which Wrangler spawns when running `wrangler dev` in local mode.
-
-## Building
-
-This CLI is built at the same time as Wrangler by running
-
-```
-npm run -w wrangler build
-```
-
-The output of the build is `miniflare-dist/index.mjs`.
-
-## Running
-
-The CLI expects a single command line argument which is the Miniflare options formatted as a string of JSON.
-
-```bash
-node --no-warnings ./packages/wrangler/miniflare-dist/index.mjs '{"watch": true, "script": ""}' --log VERBOSE
-```
-
-The `--log` argument is optional and takes one of Miniflare's LogLevels: "NONE", "ERROR", "WARN", "INFO", "DEBUG", "VERBOSE".
-It defaults to `INFO`.
-
-## Debugging
-
-Simply place a breakpoint in the code and run the above command in the VS Code "JavaScript Debug Terminal".
-The code will stop at the breakpoint as expected.

package/src/miniflare-cli/enum-keys.ts

@@ -1,17 +0,0 @@
-export type EnumKeys<Enum> = Exclude<keyof Enum, number>;
-
-export const enumObject = <Enum extends Record<string, number | string>>(
-  e: Enum
-) => {
-  const copy = { ...e } as { [K in EnumKeys<Enum>]: Enum[K] };
-  Object.values(e).forEach(
-    (value) => typeof value === "number" && delete copy[value]
-  );
-  return copy;
-};
-
-export const enumKeys = <Enum extends Record<string, number | string>>(
-  e: Enum
-) => {
-  return Object.keys(enumObject(e)) as EnumKeys<Enum>[];
-};

package/src/miniflare-cli/index.ts

@@ -1,37 +0,0 @@
-import { Log, LogLevel, Miniflare } from "miniflare";
-import yargs from "yargs";
-import { hideBin } from "yargs/helpers";
-import { enumKeys } from "./enum-keys";
-
-async function main() {
-  const args = await yargs(hideBin(process.argv))
-    .help(false)
-    .version(false)
-    .option("log", {
-      choices: enumKeys(LogLevel),
-    }).argv;
-
-  const logLevel = LogLevel[args.log ?? "INFO"];
-  const config = {
-    ...JSON.parse((args._[0] as string) ?? "{}"),
-    log: new Log(logLevel),
-  };
-
-  if (logLevel > LogLevel.INFO) {
-    console.log("OPTIONS:\n", JSON.stringify(config, null, 2));
-  }
-
-  const mf = new Miniflare(config);
-
-  try {
-    // Start Miniflare development server
-    await mf.startServer();
-  } catch (e) {
-    mf.log.error(e as Error);
-    process.exitCode = 1;
-    // Unmount any mounted workers
-    await mf.dispose();
-  }
-}
-
-await main();

package/src/module-collection.ts

@@ -1,258 +0,0 @@
-import crypto from "node:crypto";
-import { readFile } from "node:fs/promises";
-import path from "node:path";
-import globToRegExp from "glob-to-regexp";
-import type { Config, ConfigModuleRuleType } from "./config";
-import type { CfModule, CfModuleType, CfScriptFormat } from "./worker";
-import type esbuild from "esbuild";
-
-const RuleTypeToModuleType: Record<ConfigModuleRuleType, CfModuleType> = {
-  ESModule: "esm",
-  CommonJS: "commonjs",
-  CompiledWasm: "compiled-wasm",
-  Data: "buffer",
-  Text: "text",
-};
-
-// This is a combination of an esbuild plugin and a mutable array
-// that we use to collect module references from source code.
-// There will be modules that _shouldn't_ be inlined directly into
-// the bundle. (eg. wasm modules, some text files, etc). We can include
-// those files as modules in the multi part worker form upload. This
-// plugin+array is used to collect references to these modules, reference
-// them correctly in the bundle, and add them to the form upload.
-
-export const DEFAULT_MODULE_RULES: Config["rules"] = [
-  { type: "Text", globs: ["**/*.txt", "**/*.html"] },
-  { type: "Data", globs: ["**/*.bin"] },
-  { type: "CompiledWasm", globs: ["**/*.wasm"] },
-];
-
-export default function createModuleCollector(props: {
-  format: CfScriptFormat;
-  rules?: Config["rules"];
-  // a collection of "legacy" style module references, which are just file names
-  // we will eventually deprecate this functionality, hence the verbose greppable name
-  wrangler1xlegacyModuleReferences: {
-    rootDirectory: string;
-    fileNames: Set<string>;
-  };
-}): {
-  modules: CfModule[];
-  plugin: esbuild.Plugin;
-} {
-  const rules: Config["rules"] = [
-    ...(props.rules || []),
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    ...DEFAULT_MODULE_RULES!,
-  ];
-
-  // First, we want to add some validations to the module rules
-  // We want to warn if rules are accidentally configured in such a way that
-  // subsequent rules will never match because `fallthrough` hasn't been set
-
-  const completedRuleLocations: Record<string, number> = {};
-  let index = 0;
-  const rulesToRemove: Config["rules"] = [];
-  for (const rule of rules) {
-    if (rule.type in completedRuleLocations) {
-      if (rules[completedRuleLocations[rule.type]].fallthrough !== false) {
-        if (index < (props.rules || []).length) {
-          console.warn(
-            `The module rule at position ${index} (${JSON.stringify(
-              rule
-            )}) has the same type as a previous rule (at position ${
-              completedRuleLocations[rule.type]
-            }, ${JSON.stringify(
-              rules[completedRuleLocations[rule.type]]
-            )}). This rule will be ignored. To the previous rule, add \`fallthrough = true\` to allow this one to also be used, or \`fallthrough = false\` to silence this warning.`
-          );
-        } else {
-          console.warn(
-            `The default module rule ${JSON.stringify(
-              rule
-            )} has the same type as a previous rule (at position ${
-              completedRuleLocations[rule.type]
-            }, ${JSON.stringify(
-              rules[completedRuleLocations[rule.type]]
-            )}). This rule will be ignored. To the previous rule, add \`fallthrough = true\` to allow the default one to also be used, or \`fallthrough = false\` to silence this warning.`
-          );
-        }
-      }
-
-      rulesToRemove.push(rule);
-    }
-    if (!(rule.type in completedRuleLocations) && rule.fallthrough !== true) {
-      completedRuleLocations[rule.type] = index;
-    }
-    index++;
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-  rulesToRemove.forEach((rule) => rules!.splice(rules!.indexOf(rule), 1));
-
-  const modules: CfModule[] = [];
-  return {
-    modules,
-    plugin: {
-      name: "wrangler-module-collector",
-      setup(build) {
-        build.onStart(() => {
-          // reset the module collection array
-          modules.splice(0);
-        });
-
-        // ~ start  legacy module specifier support ~
-
-        // This section detects usage of "legacy" 1.x style module specifiers
-        // and modifies them so they "work" in wrangler v2, but with a warning
-
-        const rulesMatchers = rules.flatMap((rule) => {
-          return rule.globs.map((glob) => {
-            const regex = globToRegExp(glob);
-            return {
-              regex,
-              rule,
-            };
-          });
-        });
-
-        if (props.wrangler1xlegacyModuleReferences.fileNames.size > 0) {
-          build.onResolve(
-            {
-              filter: new RegExp(
-                "^(" +
-                  [...props.wrangler1xlegacyModuleReferences.fileNames].join(
-                    "|"
-                  ) +
-                  ")$"
-              ),
-            },
-            async (args: esbuild.OnResolveArgs) => {
-              if (
-                args.kind !== "import-statement" &&
-                args.kind !== "require-call"
-              ) {
-                return;
-              }
-              // In the future, this will simply throw an error
-              console.warn(
-                `Deprecation warning: detected a legacy module import in "./${path.relative(
-                  process.cwd(),
-                  args.importer
-                )}". This will stop working in the future. Replace references to "${
-                  args.path
-                }" with "./${args.path}";`
-              );
-
-              // take the file and massage it to a
-              // transportable/manageable format
-              const filePath = path.join(
-                props.wrangler1xlegacyModuleReferences.rootDirectory,
-                args.path
-              );
-              const fileContent = await readFile(filePath);
-              const fileHash = crypto
-                .createHash("sha1")
-                .update(fileContent)
-                .digest("hex");
-              const fileName = `./${fileHash}-${path.basename(args.path)}`;
-
-              const { rule } =
-                rulesMatchers.find(({ regex }) => regex.test(fileName)) || {};
-              if (rule) {
-                // add the module to the array
-                modules.push({
-                  name: fileName,
-                  content: fileContent,
-                  type: RuleTypeToModuleType[rule.type],
-                });
-                return {
-                  path: fileName, // change the reference to the changed module
-                  external: props.format === "modules", // mark it as external in the bundle
-                  namespace: `wrangler-module-${rule.type}`, // just a tag, this isn't strictly necessary
-                  watchFiles: [filePath], // we also add the file to esbuild's watch list
-                };
-              }
-            }
-          );
-        }
-
-        // ~ end legacy module specifier support ~
-
-        rules?.forEach((rule) => {
-          if (rule.type === "ESModule" || rule.type === "CommonJS") return; // TODO: we should treat these as js files, and use the jsx loader
-
-          rule.globs.forEach((glob) => {
-            build.onResolve(
-              { filter: globToRegExp(glob) },
-              async (args: esbuild.OnResolveArgs) => {
-                // take the file and massage it to a
-                // transportable/manageable format
-
-                const filePath = path.join(args.resolveDir, args.path);
-                const fileContent = await readFile(filePath);
-                const fileHash = crypto
-                  .createHash("sha1")
-                  .update(fileContent)
-                  .digest("hex");
-                const fileName = `./${fileHash}-${path.basename(args.path)}`;
-
-                // add the module to the array
-                modules.push({
-                  name: fileName,
-                  content: fileContent,
-                  type: RuleTypeToModuleType[rule.type],
-                });
-
-                return {
-                  path: fileName, // change the reference to the changed module
-                  external: props.format === "modules", // mark it as external in the bundle
-                  namespace: `wrangler-module-${rule.type}`, // just a tag, this isn't strictly necessary
-                  watchFiles: [filePath], // we also add the file to esbuild's watch list
-                };
-              }
-            );
-
-            if (props.format === "service-worker") {
-              build.onLoad(
-                { filter: globToRegExp(glob) },
-                async (args: esbuild.OnLoadArgs) => {
-                  return {
-                    // We replace the the module with an identifier
-                    // that we'll separately add to the form upload
-                    // as part of [wasm_modules]/[text_blobs]. This identifier has to be a valid
-                    // JS identifier, so we replace all non alphanumeric characters
-                    // with an underscore.
-                    // TODO: what of "Data"?
-                    contents: `export default ${args.path.replace(
-                      /[^a-zA-Z0-9_$]/g,
-                      "_"
-                    )};`,
-                  };
-                }
-              );
-            }
-          });
-        });
-
-        rulesToRemove.forEach((rule) => {
-          rule.globs.forEach((glob) => {
-            build.onResolve(
-              { filter: globToRegExp(glob) },
-              async (args: esbuild.OnResolveArgs) => {
-                throw new Error(
-                  `The file ${
-                    args.path
-                  } matched a module rule in your configuration (${JSON.stringify(
-                    rule
-                  )}), but was ignored because a previous rule with the same type was not marked as \`fallthrough = true\`.`
-                );
-              }
-            );
-          });
-        });
-      },
-    },
-  };
-}

package/src/open-in-browser.ts

@@ -1,25 +0,0 @@
-import open from "open";
-
-/**
- * An extremely simple wrapper around the open command.
- * Specifically, it adds an 'error' event handler so that when this function
- * is called in environments where we can't open the browser (e.g. github codespaces,
- * stackblitz, remote servers), it doesn't just crash the process.
- *
- * @param url the URL to point the browser at
- * @param options open a chromium-based browser instead of the default
- */
-export default async function openInBrowser(
-  url: string,
-  { forceChromium }: { forceChromium: boolean } = { forceChromium: false }
-): Promise<void> {
-  const options: open.Options | undefined = forceChromium
-    ? {
-        app: [{ name: open.apps.chrome }, { name: open.apps.edge }],
-      }
-    : undefined;
-  const childProcess = await open(url, options);
-  childProcess.on("error", () => {
-    console.warn(`Failed to open ${url} in a browser`);
-  });
-}