wrangler 2.0.1 → 2.0.5

package/src/index.tsx

@@ -22,17 +22,19 @@ import { confirm, prompt } from "./dialogs";
 import { getEntry } from "./entry";
 import { DeprecationError } from "./errors";
 import {
-  getNamespaceId,
-  listNamespaces,
-  listNamespaceKeys,
-  putKeyValue,
-  putBulkKeyValue,
-  deleteBulkKeyValue,
-  createNamespace,
-  isValidNamespaceBinding,
-  getKeyValue,
-  isKeyValue,
-  unexpectedKeyValueProps,
+  getKVNamespaceId,
+  listKVNamespaces,
+  listKVNamespaceKeys,
+  putKVKeyValue,
+  putKVBulkKeyValue,
+  deleteKVBulkKeyValue,
+  createKVNamespace,
+  isValidKVNamespaceBinding,
+  getKVKeyValue,
+  isKVKeyValue,
+  unexpectedKVKeyValueProps,
+  deleteKVNamespace,
+  deleteKVKeyValue,
 } from "./kv";
 import { logger } from "./logger";
 import { getPackageManager } from "./package-manager";
@@ -73,6 +75,7 @@ type ConfigPath = string | undefined;
 
 const resetColor = "\x1b[0m";
 const fgGreenColor = "\x1b[32m";
+const DEFAULT_LOCAL_PORT = 8787;
 
 function getRules(config: Config): Config["rules"] {
   const rules = config.rules ?? config.build?.upload?.rules ?? [];
@@ -406,7 +409,17 @@ export async function main(argv: string[]): Promise<void> {
       const isInsideGitProject = Boolean(
         await findUp(".git", { cwd: creationDirectory, type: "directory" })
       );
-      const isGitInstalled = (await execa("git", ["--version"])).exitCode === 0;
+      let isGitInstalled;
+      try {
+        isGitInstalled = (await execa("git", ["--version"])).exitCode === 0;
+      } catch (err) {
+        if ((err as { code: string | undefined }).code !== "ENOENT") {
+          // only throw if the error is not because git is not installed
+          throw err;
+        } else {
+          isGitInstalled = false;
+        }
+      }
       if (!isInsideGitProject && isGitInstalled) {
         const shouldInitGit =
           yesFlag ||
@@ -712,7 +725,7 @@ export async function main(argv: string[]): Promise<void> {
     () => {
       // "[DEPRECATED] 🦀 Build your project (if applicable)",
       throw new DeprecationError(
-        "`wrangler build` has been deprecated, please refer to https://github.com/cloudflare/wrangler2/blob/main/docs/deprecations.md#build for alternatives"
+        "`wrangler build` has been deprecated, please refer to https://developers.cloudflare.com/workers/wrangler/migration/deprecations/#build for alternatives"
       );
     }
   );
@@ -725,7 +738,7 @@ export async function main(argv: string[]): Promise<void> {
     () => {
       // "🕵️  Authenticate Wrangler with a Cloudflare API Token",
       throw new DeprecationError(
-        "`wrangler config` has been deprecated, please refer to https://github.com/cloudflare/wrangler2/blob/main/docs/deprecations.md#config for alternatives"
+        "`wrangler config` has been deprecated, please refer to https://developers.cloudflare.com/workers/wrangler/migration/deprecations/#config for alternatives"
       );
     }
   );
@@ -869,6 +882,11 @@ export async function main(argv: string[]): Promise<void> {
           describe: "Enable dev tools",
           type: "boolean",
           deprecated: true,
+        })
+        .option("legacy-env", {
+          type: "boolean",
+          describe: "Use legacy environments",
+          hidden: true,
         });
     },
     async (args) => {
@@ -995,7 +1013,7 @@ export async function main(argv: string[]): Promise<void> {
       const nodeCompat = args.nodeCompat ?? config.node_compat;
       if (nodeCompat) {
         logger.warn(
-          "Enabling node.js compatibility mode for builtins and globals. This is experimental and has serious tradeoffs. Please see https://github.com/ionic-team/rollup-plugin-node-polyfills/ for more details."
+          "Enabling node.js compatibility mode for built-ins and globals. This is experimental and has serious tradeoffs. Please see https://github.com/ionic-team/rollup-plugin-node-polyfills/ for more details."
         );
       }
 
@@ -1027,7 +1045,9 @@ export async function main(argv: string[]): Promise<void> {
             args.siteExclude
           )}
           port={
-            args.port || config.dev?.port || (await getPort({ port: 8787 }))
+            args.port ||
+            config.dev.port ||
+            (await getPort({ port: DEFAULT_LOCAL_PORT }))
           }
           ip={args.ip || config.dev.ip}
           inspectorPort={
@@ -1206,6 +1226,11 @@ export async function main(argv: string[]): Promise<void> {
         .option("dry-run", {
           describe: "Don't actually publish",
           type: "boolean",
+        })
+        .option("legacy-env", {
+          type: "boolean",
+          describe: "Use legacy environments",
+          hidden: true,
         });
     },
     async (args) => {
@@ -1327,6 +1352,11 @@ export async function main(argv: string[]): Promise<void> {
           default: false,
           describe:
             "If a log would have been filtered out, send it through anyway alongside the filter which would have blocked it.",
+        })
+        .option("legacy-env", {
+          type: "boolean",
+          describe: "Use legacy environments",
+          hidden: true,
         });
     },
     async (args) => {
@@ -1476,7 +1506,9 @@ export async function main(argv: string[]): Promise<void> {
           enableLocalPersistence={false}
           accountId={accountId}
           assetPaths={undefined}
-          port={config.dev?.port}
+          port={
+            config.dev.port || (await getPort({ port: DEFAULT_LOCAL_PORT }))
+          }
           ip={config.dev.ip}
           public={undefined}
           compatibilityDate={getDevCompatibilityDate(config)}
@@ -1623,7 +1655,7 @@ export async function main(argv: string[]): Promise<void> {
     },
     () => {
       throw new DeprecationError(
-        "`wrangler subdomain` has been deprecated, please refer to https://github.com/cloudflare/wrangler2/blob/main/docs/deprecations.md#subdomain for alternatives"
+        "`wrangler subdomain` has been deprecated, please refer to https://developers.cloudflare.com/workers/wrangler/migration/deprecations/#subdomain for alternatives"
       );
     }
   );
@@ -1635,6 +1667,11 @@ export async function main(argv: string[]): Promise<void> {
     (secretYargs) => {
       return secretYargs
         .command(subHelp)
+        .option("legacy-env", {
+          type: "boolean",
+          describe: "Use legacy environments",
+          hidden: true,
+        })
         .command(
           "put <key>",
           "Create or update a secret variable for a script",
@@ -1884,7 +1921,7 @@ export async function main(argv: string[]): Promise<void> {
           async (args) => {
             await printWranglerBanner();
 
-            if (!isValidNamespaceBinding(args.namespace)) {
+            if (!isValidKVNamespaceBinding(args.namespace)) {
               throw new CommandLineArgsError(
                 `The namespace binding name "${args.namespace}" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number.`
               );
@@ -1907,7 +1944,7 @@ export async function main(argv: string[]): Promise<void> {
             // TODO: generate a binding name stripping non alphanumeric chars
 
             logger.log(`🌀 Creating namespace with title "${title}"`);
-            const namespaceId = await createNamespace(accountId, title);
+            const namespaceId = await createKVNamespace(accountId, title);
 
             logger.log("✨ Success!");
             const envString = args.env ? ` under [env.${args.env}]` : "";
@@ -1934,7 +1971,7 @@ export async function main(argv: string[]): Promise<void> {
             // TODO: we should show bindings if they exist for given ids
 
             logger.log(
-              JSON.stringify(await listNamespaces(accountId), null, "  ")
+              JSON.stringify(await listKVNamespaces(accountId), null, "  ")
             );
           }
         )
@@ -1971,7 +2008,7 @@ export async function main(argv: string[]): Promise<void> {
 
             let id;
             try {
-              id = getNamespaceId(args, config);
+              id = getKVNamespaceId(args, config);
             } catch (e) {
               throw new CommandLineArgsError(
                 "Not able to delete namespace.\n" + ((e as Error).message ?? e)
@@ -1980,10 +2017,7 @@ export async function main(argv: string[]): Promise<void> {
 
             const accountId = await requireAuth(config);
 
-            await fetchResult<{ id: string }>(
-              `/accounts/${accountId}/storage/kv/namespaces/${id}`,
-              { method: "DELETE" }
-            );
+            await deleteKVNamespace(accountId, id);
 
             // TODO: recommend they remove it from wrangler.toml
 
@@ -2068,7 +2102,7 @@ export async function main(argv: string[]): Promise<void> {
           async ({ key, ttl, expiration, ...args }) => {
             await printWranglerBanner();
             const config = readConfig(args.config as ConfigPath, args);
-            const namespaceId = getNamespaceId(args, config);
+            const namespaceId = getKVNamespaceId(args, config);
             // One of `args.path` and `args.value` must be defined
             const value = args.path
               ? readFileSync(args.path)
@@ -2087,7 +2121,7 @@ export async function main(argv: string[]): Promise<void> {
 
             const accountId = await requireAuth(config);
 
-            await putKeyValue(accountId, namespaceId, {
+            await putKVKeyValue(accountId, namespaceId, {
               key,
               value,
               expiration,
@@ -2132,11 +2166,11 @@ export async function main(argv: string[]): Promise<void> {
           async ({ prefix, ...args }) => {
             // TODO: support for limit+cursor (pagination)
             const config = readConfig(args.config as ConfigPath, args);
-            const namespaceId = getNamespaceId(args, config);
+            const namespaceId = getKVNamespaceId(args, config);
 
             const accountId = await requireAuth(config);
 
-            const results = await listNamespaceKeys(
+            const results = await listKVNamespaceKeys(
               accountId,
               namespaceId,
               prefix
@@ -2184,11 +2218,11 @@ export async function main(argv: string[]): Promise<void> {
           },
           async ({ key, ...args }) => {
             const config = readConfig(args.config as ConfigPath, args);
-            const namespaceId = getNamespaceId(args, config);
+            const namespaceId = getKVNamespaceId(args, config);
 
             const accountId = await requireAuth(config);
 
-            logger.log(await getKeyValue(accountId, namespaceId, key));
+            logger.log(await getKVKeyValue(accountId, namespaceId, key));
           }
         )
         .command(
@@ -2226,7 +2260,7 @@ export async function main(argv: string[]): Promise<void> {
           async ({ key, ...args }) => {
             await printWranglerBanner();
             const config = readConfig(args.config as ConfigPath, args);
-            const namespaceId = getNamespaceId(args, config);
+            const namespaceId = getKVNamespaceId(args, config);
 
             logger.log(
               `Deleting the key "${key}" on namespace ${namespaceId}.`
@@ -2234,10 +2268,7 @@ export async function main(argv: string[]): Promise<void> {
 
             const accountId = await requireAuth(config);
 
-            await fetchResult(
-              `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${key}`,
-              { method: "DELETE" }
-            );
+            await deleteKVKeyValue(accountId, namespaceId, key);
           }
         );
     }
@@ -2289,7 +2320,7 @@ export async function main(argv: string[]): Promise<void> {
             // but we'll do that in the future if needed.
 
             const config = readConfig(args.config as ConfigPath, args);
-            const namespaceId = getNamespaceId(args, config);
+            const namespaceId = getKVNamespaceId(args, config);
             const content = parseJSON(readFileSync(filename), filename);
 
             if (!Array.isArray(content)) {
@@ -2309,12 +2340,12 @@ export async function main(argv: string[]): Promise<void> {
                     keyValue
                   )}`
                 );
-              } else if (!isKeyValue(keyValue)) {
+              } else if (!isKVKeyValue(keyValue)) {
                 errors.push(
                   `The item at index ${i} is ${JSON.stringify(keyValue)}`
                 );
               } else {
-                const props = unexpectedKeyValueProps(keyValue);
+                const props = unexpectedKVKeyValueProps(keyValue);
                 if (props.length > 0) {
                   warnings.push(
                     `The item at index ${i} contains unexpected properties: ${JSON.stringify(
@@ -2347,7 +2378,7 @@ export async function main(argv: string[]): Promise<void> {
             }
 
             const accountId = await requireAuth(config);
-            await putBulkKeyValue(
+            await putKVBulkKeyValue(
               accountId,
               namespaceId,
               content,
@@ -2399,7 +2430,7 @@ export async function main(argv: string[]): Promise<void> {
           async ({ filename, ...args }) => {
             await printWranglerBanner();
             const config = readConfig(args.config as ConfigPath, args);
-            const namespaceId = getNamespaceId(args, config);
+            const namespaceId = getKVNamespaceId(args, config);
 
             if (!args.force) {
               const result = await confirm(
@@ -2444,7 +2475,7 @@ export async function main(argv: string[]): Promise<void> {
 
             const accountId = await requireAuth(config);
 
-            await deleteBulkKeyValue(
+            await deleteKVBulkKeyValue(
               accountId,
               namespaceId,
               content,
@@ -2604,19 +2635,14 @@ export async function main(argv: string[]): Promise<void> {
     }
   );
 
-  wrangler
-    .option("legacy-env", {
-      type: "boolean",
-      describe: "Use legacy environments",
-    })
-    .option("config", {
-      alias: "c",
-      describe: "Path to .toml configuration file",
-      type: "string",
-      requiresArg: true,
-    });
+  wrangler.option("config", {
+    alias: "c",
+    describe: "Path to .toml configuration file",
+    type: "string",
+    requiresArg: true,
+  });
 
-  wrangler.group(["config", "help", "version", "legacy-env"], "Flags:");
+  wrangler.group(["config", "help", "version"], "Flags:");
   wrangler.help().alias("h", "help");
   wrangler.version(wranglerVersion).alias("v", "version");
   wrangler.exitProcess(false);

package/src/kv.ts

@@ -19,7 +19,7 @@ type KvArgs = {
  *
  * @returns the generated id of the created namespace.
  */
-export async function createNamespace(
+export async function createKVNamespace(
   accountId: string,
   title: string
 ): Promise<string> {
@@ -51,7 +51,7 @@ export interface KVNamespaceInfo {
 /**
  * Fetch a list of all the namespaces under the given `accountId`.
  */
-export async function listNamespaces(
+export async function listKVNamespaces(
   accountId: string
 ): Promise<KVNamespaceInfo[]> {
   const pageSize = 100;
@@ -83,7 +83,7 @@ export interface NamespaceKeyInfo {
   metadata?: { [key: string]: unknown };
 }
 
-export async function listNamespaceKeys(
+export async function listKVNamespaceKeys(
   accountId: string,
   namespaceId: string,
   prefix = ""
@@ -95,6 +95,16 @@ export async function listNamespaceKeys(
   );
 }
 
+export async function deleteKVNamespace(
+  accountId: string,
+  namespaceId: string
+) {
+  return await fetchResult<{ id: string }>(
+    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}`,
+    { method: "DELETE" }
+  );
+}
+
 /**
  * Information about a key-value pair, including its "metadata" fields.
  */
@@ -119,7 +129,7 @@ const KeyValueKeys = new Set([
 /**
  * Is the given object a valid `KeyValue` type?
  */
-export function isKeyValue(keyValue: object): keyValue is KeyValue {
+export function isKVKeyValue(keyValue: object): keyValue is KeyValue {
   const props = Object.keys(keyValue);
   if (!props.includes("key") || !props.includes("value")) {
     return false;
@@ -130,12 +140,12 @@ export function isKeyValue(keyValue: object): keyValue is KeyValue {
 /**
  * Get all the properties on the `keyValue` that are not expected.
  */
-export function unexpectedKeyValueProps(keyValue: KeyValue): string[] {
+export function unexpectedKVKeyValueProps(keyValue: KeyValue): string[] {
   const props = Object.keys(keyValue);
   return props.filter((prop) => !KeyValueKeys.has(prop));
 }
 
-export async function putKeyValue(
+export async function putKVKeyValue(
   accountId: string,
   namespaceId: string,
   keyValue: KeyValue
@@ -151,21 +161,36 @@ export async function putKeyValue(
     }
   }
   return await fetchResult(
-    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${keyValue.key}`,
+    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
+      keyValue.key
+    )}`,
     { method: "PUT", body: keyValue.value },
     searchParams
   );
 }
 
-export async function getKeyValue(
+export async function getKVKeyValue(
   accountId: string,
   namespaceId: string,
   key: string
 ): Promise<string> {
-  return await fetchKVGetValue(accountId, namespaceId, key);
+  return await fetchKVGetValue(accountId, namespaceId, encodeURIComponent(key));
+}
+
+export async function deleteKVKeyValue(
+  accountId: string,
+  namespaceId: string,
+  key: string
+) {
+  return await fetchResult(
+    `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
+      key
+    )}`,
+    { method: "DELETE" }
+  );
 }
 
-export async function putBulkKeyValue(
+export async function putKVBulkKeyValue(
   accountId: string,
   namespaceId: string,
   keyValues: KeyValue[],
@@ -190,7 +215,7 @@ export async function putBulkKeyValue(
   }
 }
 
-export async function deleteBulkKeyValue(
+export async function deleteKVBulkKeyValue(
   accountId: string,
   namespaceId: string,
   keys: string[],
@@ -215,7 +240,7 @@ export async function deleteBulkKeyValue(
   }
 }
 
-export function getNamespaceId(
+export function getKVNamespaceId(
   { preview, binding, "namespace-id": namespaceId }: KvArgs,
   config: Config
 ): string {
@@ -310,7 +335,7 @@ export function getNamespaceId(
 /**
  * KV namespace binding names must be valid JS identifiers.
  */
-export function isValidNamespaceBinding(
+export function isValidKVNamespaceBinding(
   binding: string | undefined
 ): binding is string {
   return (

package/src/pages.tsx

@@ -804,34 +804,30 @@ const createDeployment: CommandModule<
     return yargs
       .positional("directory", {
         type: "string",
-        default: "functions",
-        description: "The directory of Pages Functions",
+        demandOption: true,
+        description: "The directory of static files to upload",
       })
       .options({
         "project-name": {
           type: "string",
-          description:
-            "The name of the project you want to list deployments for",
+          description: "The name of the project you want to deploy to",
         },
         branch: {
           type: "string",
-          description:
-            "The branch of the project you want to list deployments for",
+          description: "The name of the branch you want to deploy to",
         },
         "commit-hash": {
           type: "string",
-          description:
-            "The branch of the project you want to list deployments for",
+          description: "The SHA to attach to this deployment",
         },
         "commit-message": {
           type: "string",
-          description:
-            "The branch of the project you want to list deployments for",
+          description: "The commit message to attach to this deployment",
         },
         "commit-dirty": {
           type: "boolean",
           description:
-            "The branch of the project you want to list deployments for",
+            "Whether or not the workspace should be considered dirty for this deployment",
         },
       })
       .epilogue(pagesBetaWarning);
@@ -844,6 +840,10 @@ const createDeployment: CommandModule<
     commitMessage,
     commitDirty,
   }) => {
+    if (!directory) {
+      throw new FatalError("Must specify a directory.", 1);
+    }
+
     const config = getConfigCache<PagesConfigCache>(
       PAGES_CONFIG_CACHE_FILENAME
     );
@@ -1576,6 +1576,10 @@ export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
                 default: false,
                 description: "Build a plugin rather than a Worker script",
               },
+              "build-output-directory": {
+                type: "string",
+                description: "The directory to output static assets to",
+              },
             })
             .epilogue(pagesBetaWarning),
         async ({
@@ -1587,12 +1591,15 @@ export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
           fallbackService,
           watch,
           plugin,
+          "build-output-directory": buildOutputDirectory,
         }) => {
           if (!isInPagesCI) {
             // Beta message for `wrangler pages <commands>` usage
             logger.log(pagesBetaWarning);
           }
 
+          buildOutputDirectory ??= dirname(outfile);
+
           await buildFunctions({
             outfile,
             outputConfigPath,
@@ -1602,7 +1609,7 @@ export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
             fallbackService,
             watch,
             plugin,
-            buildOutputDirectory: dirname(outfile),
+            buildOutputDirectory,
           });
         }
       )

package/src/sites.tsx

@@ -3,11 +3,11 @@ import * as path from "node:path";
 import ignore from "ignore";
 import xxhash from "xxhash-wasm";
 import {
-  createNamespace,
-  listNamespaceKeys,
-  listNamespaces,
-  putBulkKeyValue,
-  deleteBulkKeyValue,
+  createKVNamespace,
+  listKVNamespaceKeys,
+  listKVNamespaces,
+  putKVBulkKeyValue,
+  deleteKVBulkKeyValue,
 } from "./kv";
 import { logger } from "./logger";
 import type { Config } from "./config";
@@ -75,14 +75,14 @@ async function createKVNamespaceIfNotAlreadyExisting(
 ) {
   // check if it already exists
   // TODO: this is super inefficient, should be made better
-  const namespaces = await listNamespaces(accountId);
+  const namespaces = await listKVNamespaces(accountId);
   const found = namespaces.find((x) => x.title === title);
   if (found) {
     return { created: false, id: found.id };
   }
 
   // else we make the namespace
-  const id = await createNamespace(accountId, title);
+  const id = await createKVNamespace(accountId, title);
   logger.log(`🌀 Created namespace for Workers Site "${title}"`);
 
   return {
@@ -131,7 +131,7 @@ export async function syncAssets(
   );
 
   // let's get all the keys in this namespace
-  const namespaceKeysResponse = await listNamespaceKeys(accountId, namespace);
+  const namespaceKeysResponse = await listKVNamespaceKeys(accountId, namespace);
   const namespaceKeys = new Set(namespaceKeysResponse.map((x) => x.name));
 
   const manifest: Record<string, string> = {};
@@ -185,9 +185,9 @@ export async function syncAssets(
 
   await Promise.all([
     // upload all the new assets
-    putBulkKeyValue(accountId, namespace, toUpload, () => {}),
+    putKVBulkKeyValue(accountId, namespace, toUpload, () => {}),
     // delete all the unused assets
-    deleteBulkKeyValue(
+    deleteKVBulkKeyValue(
       accountId,
       namespace,
       Array.from(namespaceKeys),

package/src/user.tsx

@@ -214,6 +214,7 @@ import path from "node:path";
 import url from "node:url";
 import { TextEncoder } from "node:util";
 import TOML from "@iarna/toml";
+import { HostURL } from "@webcontainer/env";
 import { render, Text } from "ink";
 import SelectInput from "ink-select-input";
 import Table from "ink-table";
@@ -339,9 +340,18 @@ export function validateScopeKeys(
 const CLIENT_ID = "54d11594-84e4-41aa-b438-e81b8fa78ee7";
 const AUTH_URL = "https://dash.cloudflare.com/oauth2/auth";
 const TOKEN_URL = "https://dash.cloudflare.com/oauth2/token";
-const CALLBACK_URL = "http://localhost:8976/oauth/callback";
 const REVOKE_URL = "https://dash.cloudflare.com/oauth2/revoke";
 
+/**
+ * To allow OAuth callbacks in environments such as WebContainer we need to
+ * create a host URL which only resolves `localhost` to a WebContainer
+ * hostname if the process is running in a WebContainer. On local this will
+ * be a no-op and it leaves the URL unmodified.
+ *
+ * @see https://www.npmjs.com/package/@webcontainer/env
+ */
+const CALLBACK_URL = HostURL.parse("http://localhost:8976/oauth/callback").href;
+
 let LocalState: State = getAuthTokens();
 
 /**