wrangler 2.0.1 → 2.0.5

package/src/__tests__/pages.test.ts

@@ -30,10 +30,9 @@ describe("pages", () => {
         wrangler pages publish [directory]           🆙 Publish a directory of static assets as a Pages deployment
 
       Flags:
-        -c, --config      Path to .toml configuration file  [string]
-        -h, --help        Show help  [boolean]
-        -v, --version     Show version number  [boolean]
-            --legacy-env  Use legacy environments  [boolean]
+        -c, --config   Path to .toml configuration file  [string]
+        -h, --help     Show help  [boolean]
+        -v, --version  Show version number  [boolean]
 
       🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose"
     `);
@@ -258,20 +257,19 @@ describe("pages", () => {
         🆙 Publish a directory of static assets as a Pages deployment
 
         Positionals:
-          directory  The directory of Pages Functions  [string] [default: \\"functions\\"]
+          directory  The directory of static files to upload  [string]
 
         Flags:
-          -c, --config      Path to .toml configuration file  [string]
-          -h, --help        Show help  [boolean]
-          -v, --version     Show version number  [boolean]
-              --legacy-env  Use legacy environments  [boolean]
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]
 
         Options:
-              --project-name    The name of the project you want to list deployments for  [string]
-              --branch          The branch of the project you want to list deployments for  [string]
-              --commit-hash     The branch of the project you want to list deployments for  [string]
-              --commit-message  The branch of the project you want to list deployments for  [string]
-              --commit-dirty    The branch of the project you want to list deployments for  [boolean]
+              --project-name    The name of the project you want to deploy to  [string]
+              --branch          The name of the branch you want to deploy to  [string]
+              --commit-hash     The SHA to attach to this deployment  [string]
+              --commit-message  The commit message to attach to this deployment  [string]
+              --commit-dirty    Whether or not the workspace should be considered dirty for this deployment  [boolean]
 
         🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose"
       `);

package/src/__tests__/publish.test.ts

@@ -1,6 +1,7 @@
 import * as fs from "node:fs";
 import * as path from "node:path";
 import * as TOML from "@iarna/toml";
+import * as esbuild from "esbuild";
 import { writeAuthConfigFile } from "../user";
 import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
 import {
@@ -878,6 +879,78 @@ export default{
       expect(std.err).toMatchInlineSnapshot(`""`);
     });
 
+    it("should preserve exports on a module format worker", async () => {
+      writeWranglerToml();
+      fs.writeFileSync(
+        "index.js",
+        `
+export const abc = 123;
+export const def = "show me the money";
+export default {};`
+      );
+
+      await runWrangler("publish index.js --dry-run --outdir out");
+
+      expect(
+        (
+          await esbuild.build({
+            entryPoints: [path.resolve("./out/index.js")],
+            metafile: true,
+            write: false,
+          })
+        ).metafile?.outputs["index.js"].exports
+      ).toMatchInlineSnapshot(`
+        Array [
+          "abc",
+          "def",
+          "default",
+        ]
+      `);
+
+      expect(std).toMatchInlineSnapshot(`
+        Object {
+          "debug": "",
+          "err": "",
+          "out": "--dry-run: exiting now.",
+          "warn": "",
+        }
+      `);
+    });
+
+    it("should not preserve exports on a service-worker format worker", async () => {
+      writeWranglerToml();
+      fs.writeFileSync(
+        "index.js",
+        `
+export const abc = 123;
+export const def = "show me the money";
+addEventListener('fetch', event => {});`
+      );
+
+      await runWrangler("publish index.js --dry-run --outdir out");
+
+      expect(
+        (
+          await esbuild.build({
+            entryPoints: [path.resolve("./out/index.js")],
+            metafile: true,
+            write: false,
+          })
+        ).metafile?.outputs["index.js"].exports
+      ).toMatchInlineSnapshot(`Array []`);
+
+      expect(std).toMatchInlineSnapshot(`
+        Object {
+          "debug": "",
+          "err": "",
+          "out": "--dry-run: exiting now.",
+          "warn": "▲ [WARNING] The entrypoint index.js has exports like an ES Module, but hasn't defined a default export like a module worker normally would. Building the worker using \\"service-worker\\" format...
+
+        ",
+        }
+      `);
+    });
+
     it("should be able to transpile entry-points in sub-directories (sw)", async () => {
       writeWranglerToml();
       writeWorkerSource({ basePath: "./src", type: "sw" });
@@ -2476,18 +2549,66 @@ export default{
         },
       });
 
-      await expect(
-        runWrangler("publish index.js")
-      ).rejects.toThrowErrorMatchingInlineSnapshot(
-        `"Could not resolve \\"index.js\\" after running custom build: node -e \\"console.log('custom build');\\""`
-      );
+      await expect(runWrangler("publish index.js")).rejects
+        .toThrowErrorMatchingInlineSnapshot(`
+              "The expected output file at \\"index.js\\" was not found after running custom build: node -e \\"console.log('custom build');\\".
+              The \`main\` property in wrangler.toml should point to the file generated by the custom build."
+            `);
       expect(std.out).toMatchInlineSnapshot(`
         "Running custom build: node -e \\"console.log('custom build');\\"
 
         If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
       `);
       expect(std.err).toMatchInlineSnapshot(`
-        "X [ERROR] Could not resolve \\"index.js\\" after running custom build: node -e \\"console.log('custom build');\\"
+        "X [ERROR] The expected output file at \\"index.js\\" was not found after running custom build: node -e \\"console.log('custom build');\\".
+
+          The \`main\` property in wrangler.toml should point to the file generated by the custom build.
+
+        "
+      `);
+      expect(std.warn).toMatchInlineSnapshot(`""`);
+    });
+
+    it("should throw an error if the entry is a directory after the build finishes", async () => {
+      writeWranglerToml({
+        main: "./",
+        build: {
+          command: `node -e "console.log('custom build');"`,
+        },
+      });
+
+      fs.writeFileSync("./worker.js", "some content", "utf-8");
+      fs.mkdirSync("./dist");
+      fs.writeFileSync("./dist/index.ts", "some content", "utf-8");
+
+      await expect(runWrangler("publish")).rejects
+        .toThrowErrorMatchingInlineSnapshot(`
+              "The expected output file at \\".\\" was not found after running custom build: node -e \\"console.log('custom build');\\".
+              The \`main\` property in wrangler.toml should point to the file generated by the custom build.
+              The provided entry-point path, \\".\\", points to a directory, rather than a file.
+
+              Did you mean to set the main field to one of:
+              \`\`\`
+              main = \\"./worker.js\\"
+              main = \\"./dist/index.ts\\"
+              \`\`\`"
+            `);
+      expect(std.out).toMatchInlineSnapshot(`
+        "Running custom build: node -e \\"console.log('custom build');\\"
+
+        If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
+      `);
+      expect(std.err).toMatchInlineSnapshot(`
+        "X [ERROR] The expected output file at \\".\\" was not found after running custom build: node -e \\"console.log('custom build');\\".
+
+          The \`main\` property in wrangler.toml should point to the file generated by the custom build.
+          The provided entry-point path, \\".\\", points to a directory, rather than a file.
+
+          Did you mean to set the main field to one of:
+          \`\`\`
+          main = \\"./worker.js\\"
+          main = \\"./dist/index.ts\\"
+          \`\`\`
 
         "
       `);

package/src/__tests__/r2.test.ts

@@ -80,10 +80,9 @@ describe("wrangler", () => {
               name  The name of the new bucket  [string] [required]
 
             Flags:
-              -c, --config      Path to .toml configuration file  [string]
-              -h, --help        Show help  [boolean]
-              -v, --version     Show version number  [boolean]
-                  --legacy-env  Use legacy environments  [boolean]
+              -c, --config   Path to .toml configuration file  [string]
+              -h, --help     Show help  [boolean]
+              -v, --version  Show version number  [boolean]
             X [ERROR] Not enough non-option arguments: got 0, need at least 1
 
             "
@@ -109,10 +108,9 @@ describe("wrangler", () => {
               name  The name of the new bucket  [string] [required]
 
             Flags:
-              -c, --config      Path to .toml configuration file  [string]
-              -h, --help        Show help  [boolean]
-              -v, --version     Show version number  [boolean]
-                  --legacy-env  Use legacy environments  [boolean]
+              -c, --config   Path to .toml configuration file  [string]
+              -h, --help     Show help  [boolean]
+              -v, --version  Show version number  [boolean]
             X [ERROR] Unknown arguments: def, ghi
 
             "
@@ -164,10 +162,9 @@ describe("wrangler", () => {
               name  The name of the bucket to delete  [string] [required]
 
             Flags:
-              -c, --config      Path to .toml configuration file  [string]
-              -h, --help        Show help  [boolean]
-              -v, --version     Show version number  [boolean]
-                  --legacy-env  Use legacy environments  [boolean]
+              -c, --config   Path to .toml configuration file  [string]
+              -h, --help     Show help  [boolean]
+              -v, --version  Show version number  [boolean]
             X [ERROR] Not enough non-option arguments: got 0, need at least 1
 
             "
@@ -193,10 +190,9 @@ describe("wrangler", () => {
               name  The name of the bucket to delete  [string] [required]
 
             Flags:
-              -c, --config      Path to .toml configuration file  [string]
-              -h, --help        Show help  [boolean]
-              -v, --version     Show version number  [boolean]
-                  --legacy-env  Use legacy environments  [boolean]
+              -c, --config   Path to .toml configuration file  [string]
+              -h, --help     Show help  [boolean]
+              -v, --version  Show version number  [boolean]
             X [ERROR] Unknown arguments: def, ghi
 
             "

package/src/bundle.ts

@@ -66,7 +66,7 @@ export async function bundleWorker(
     absWorkingDir: entry.directory,
     outdir: destination,
     external: ["__STATIC_CONTENT_MANIFEST"],
-    format: "esm",
+    format: entry.format === "modules" ? "esm" : "iife",
     target: "es2020",
     sourcemap: true,
     minify,

package/src/cfetch/internal.ts

@@ -112,6 +112,9 @@ function addAuthorizationHeader(
  * doesn't return json. We inline the implementation and try not to share
  * any code with the other calls. We should push back on any new APIs that
  * try to introduce non-"standard" response structures.
+ *
+ * Note: any calls to fetchKVGetValue must call encodeURIComponent on key
+ * before passing it
  */
 
 export async function fetchKVGetValue(

package/src/config/config.ts

@@ -161,7 +161,7 @@ export interface DevConfig {
    *
    * @default `8787`
    */
-  port: number;
+  port: number | undefined;
 
   /**
    * Protocol that local wrangler dev server listens to requests on.

package/src/config/validation.ts

@@ -352,7 +352,7 @@ function normalizeAndValidateDev(
 ): DevConfig {
   const {
     ip = "localhost",
-    port = 8787,
+    port,
     local_protocol = "http",
     upstream_protocol = "https",
     host,

package/src/dev/dev.tsx

@@ -1,4 +1,5 @@
 import { spawn } from "node:child_process";
+import * as path from "node:path";
 import { watch } from "chokidar";
 import clipboardy from "clipboardy";
 import commandExists from "command-exists";
@@ -242,9 +243,11 @@ function useCustomBuild(
         persistent: true,
         ignoreInitial: true,
       }).on("all", (_event, filePath) => {
+        const relativeFile =
+          path.relative(expectedEntry.directory, expectedEntry.file) || ".";
         //TODO: we should buffer requests to the proxy until this completes
         logger.log(`The file ${filePath} changed, restarting build...`);
-        runCustomBuild(expectedEntry.file, build).catch((err) => {
+        runCustomBuild(expectedEntry.file, relativeFile, build).catch((err) => {
           logger.error("Custom build failed:", err);
         });
       });
@@ -253,7 +256,7 @@ function useCustomBuild(
     return () => {
       watcher?.close();
     };
-  }, [build, expectedEntry.file]);
+  }, [build, expectedEntry]);
 }
 
 function sleep(period: number) {

package/src/entry.ts

@@ -1,5 +1,5 @@
 import assert from "node:assert";
-import { existsSync } from "node:fs";
+import { existsSync, statSync } from "node:fs";
 import path from "node:path";
 import * as esbuild from "esbuild";
 import { execaCommand } from "execa";
@@ -45,11 +45,16 @@ export async function getEntry(
     file = path.resolve(directory, config.main);
   }
 
-  await runCustomBuild(file, config.build);
+  const relativeFile = path.relative(directory, file) || ".";
+  await runCustomBuild(file, relativeFile, config.build);
 
   if (fileExists(file) === false) {
     throw new Error(
-      `Could not resolve "${path.relative(process.cwd(), file)}".`
+      getMissingEntryPointMessage(
+        `The entry-point file at "${relativeFile}" was not found.`,
+        file,
+        relativeFile
+      )
     );
   }
   const format = await guessWorkerFormat(
@@ -90,7 +95,8 @@ export async function getEntry(
 }
 
 export async function runCustomBuild(
-  expectedEntry: string,
+  expectedEntryAbsolute: string,
+  expectedEntryRelative: string,
   build: Config["build"]
 ) {
   if (build?.command) {
@@ -105,12 +111,14 @@ export async function runCustomBuild(
       ...(build.cwd && { cwd: build.cwd }),
     });
 
-    if (fileExists(expectedEntry) === false) {
+    if (fileExists(expectedEntryAbsolute) === false) {
       throw new Error(
-        `Could not resolve "${path.relative(
-          process.cwd(),
-          expectedEntry
-        )}" after running custom build: ${build.command}`
+        getMissingEntryPointMessage(
+          `The expected output file at "${expectedEntryRelative}" was not found after running custom build: ${build.command}.\n` +
+            "The `main` property in wrangler.toml should point to the file generated by the custom build.",
+          expectedEntryAbsolute,
+          expectedEntryRelative
+        )
       );
     }
   }
@@ -265,3 +273,50 @@ function generateAddScriptNameExamples(
     })
     .join("\n");
 }
+
+/**
+ * Generate an appropriate message for when the entry-point is missing.
+ *
+ * To be more helpful to developers, we check whether there is a suitable file
+ * nearby to the expected file path.
+ */
+function getMissingEntryPointMessage(
+  message: string,
+  absoluteEntryPointPath: string,
+  relativeEntryPointPath: string
+): string {
+  if (
+    existsSync(absoluteEntryPointPath) &&
+    statSync(absoluteEntryPointPath).isDirectory()
+  ) {
+    // The expected entry-point is a directory, so offer further guidance.
+    message += `\nThe provided entry-point path, "${relativeEntryPointPath}", points to a directory, rather than a file.\n`;
+
+    // Perhaps we can even guess what the correct path should be...
+    const possiblePaths: string[] = [];
+    for (const basenamePath of [
+      "worker",
+      "dist/worker",
+      "index",
+      "dist/index",
+    ]) {
+      for (const extension of [".ts", ".tsx", ".js", ".jsx"]) {
+        const filePath = basenamePath + extension;
+        if (fileExists(path.resolve(absoluteEntryPointPath, filePath))) {
+          possiblePaths.push(path.join(relativeEntryPointPath, filePath));
+        }
+      }
+    }
+
+    if (possiblePaths.length > 0) {
+      message +=
+        `\nDid you mean to set the main field to${
+          possiblePaths.length > 1 ? " one of" : ""
+        }:\n` +
+        "```\n" +
+        possiblePaths.map((filePath) => `main = "./${filePath}"\n`).join("") +
+        "```";
+    }
+  }
+  return message;
+}