wrangler 2.0.0 → 2.0.3

package/src/index.tsx

@@ -73,6 +73,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 +407,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 +723,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 +736,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 +880,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 +1011,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 +1043,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 +1224,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 +1350,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 +1504,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 +1653,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 +1665,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",
@@ -1981,7 +2016,9 @@ export async function main(argv: string[]): Promise<void> {
             const accountId = await requireAuth(config);
 
             await fetchResult<{ id: string }>(
-              `/accounts/${accountId}/storage/kv/namespaces/${id}`,
+              `/accounts/${accountId}/storage/kv/namespaces/${encodeURIComponent(
+                id
+              )}`,
               { method: "DELETE" }
             );
 
@@ -2235,7 +2272,9 @@ export async function main(argv: string[]): Promise<void> {
             const accountId = await requireAuth(config);
 
             await fetchResult(
-              `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${key}`,
+              `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
+                key
+              )}`,
               { method: "DELETE" }
             );
           }
@@ -2604,19 +2643,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

@@ -151,7 +151,9 @@ 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
   );

package/src/pages.tsx

@@ -82,6 +82,8 @@ const PAGES_CONFIG_CACHE_FILENAME = "pages.json";
 export const pagesBetaWarning =
   "🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose";
 
+const isInPagesCI = !!process.env.CF_PAGES;
+
 const CLEANUP_CALLBACKS: (() => void)[] = [];
 const CLEANUP = () => {
   CLEANUP_CALLBACKS.forEach((callback) => callback());
@@ -802,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);
@@ -842,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
     );
@@ -851,40 +853,45 @@ const createDeployment: CommandModule<
 
     const isInteractive = process.stdin.isTTY;
     if (!projectName && isInteractive) {
-      const existingOrNew = await new Promise<"new" | "existing">((resolve) => {
-        const { unmount } = render(
-          <>
-            <Text>
-              No project selected. Would you like to create one or use an
-              existing project?
-            </Text>
-            <SelectInput
-              items={[
-                {
-                  key: "new",
-                  label: "Create a new project",
-                  value: "new",
-                },
-                {
-                  key: "existing",
-                  label: "Use an existing project",
-                  value: "existing",
-                },
-              ]}
-              onSelect={async (selected) => {
-                resolve(selected.value as "new" | "existing");
-                unmount();
-              }}
-            />
-          </>
-        );
-      });
+      const projects = (await listProjects({ accountId })).filter(
+        (project) => !project.source
+      );
+
+      let existingOrNew: "existing" | "new" = "new";
+
+      if (projects.length > 0) {
+        existingOrNew = await new Promise<"new" | "existing">((resolve) => {
+          const { unmount } = render(
+            <>
+              <Text>
+                No project selected. Would you like to create one or use an
+                existing project?
+              </Text>
+              <SelectInput
+                items={[
+                  {
+                    key: "new",
+                    label: "Create a new project",
+                    value: "new",
+                  },
+                  {
+                    key: "existing",
+                    label: "Use an existing project",
+                    value: "existing",
+                  },
+                ]}
+                onSelect={async (selected) => {
+                  resolve(selected.value as "new" | "existing");
+                  unmount();
+                }}
+              />
+            </>
+          );
+        });
+      }
 
       switch (existingOrNew) {
         case "existing": {
-          const projects = (await listProjects({ accountId })).filter(
-            (project) => !project.source
-          );
           projectName = await new Promise((resolve) => {
             const { unmount } = render(
               <>
@@ -1569,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 ({
@@ -1580,9 +1591,14 @@ export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
           fallbackService,
           watch,
           plugin,
+          "build-output-directory": buildOutputDirectory,
         }) => {
-          // Beta message for `wrangler pages <commands>` usage
-          logger.log(pagesBetaWarning);
+          if (!isInPagesCI) {
+            // Beta message for `wrangler pages <commands>` usage
+            logger.log(pagesBetaWarning);
+          }
+
+          buildOutputDirectory ??= dirname(outfile);
 
           await buildFunctions({
             outfile,
@@ -1593,7 +1609,7 @@ export const pages: BuilderCallback<unknown, unknown> = (yargs) => {
             fallbackService,
             watch,
             plugin,
-            buildOutputDirectory: dirname(outfile),
+            buildOutputDirectory,
           });
         }
       )

package/src/parse.ts

@@ -77,7 +77,9 @@ type TomlError = Error & {
  */
 export function parseTOML(input: string, file?: string): TOML.JsonMap | never {
   try {
-    return TOML.parse(input);
+    // Normalize CRLF to LF to avoid hitting https://github.com/iarna/iarna-toml/issues/33.
+    const normalizedInput = input.replace(/\r\n$/g, "\n");
+    return TOML.parse(normalizedInput);
   } catch (err) {
     const { name, message, line, col } = err as TomlError;
     if (name !== TOML_ERROR_NAME) {

package/src/proxy.ts

@@ -210,6 +210,10 @@ export function usePreviewServer({
       const request = message.pipe(remote.request(headers));
       request.on("response", (responseHeaders) => {
         const status = responseHeaders[":status"] ?? 500;
+
+        // log all requests to terminal
+        logger.log(new Date().toLocaleTimeString(), method, url, status);
+
         rewriteRemoteHostToLocalHostInHeaders(
           responseHeaders,
           previewToken.host,
@@ -349,15 +353,6 @@ async function createProxyServer(
       : createHttpServer();
 
   return server
-    .on("request", function (req, res) {
-      // log all requests
-      logger.log(
-        new Date().toLocaleTimeString(),
-        req.method,
-        req.url,
-        res.statusCode
-      );
-    })
     .on("upgrade", (req) => {
       // log all websocket connections
       logger.log(

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();
 
 /**