wrangler 0.0.0-e2f9bb2 → 0.0.0-e322475

package/src/__tests__/helpers/mock-dialogs.ts

@@ -1,4 +1,5 @@
-import { confirm, prompt } from "../../dialogs";
+import { confirm, prompt, select } from "../../dialogs";
+import { normalizeSlashes } from "./mock-console";
 
 /**
  * The expected values for a confirmation request.
@@ -19,13 +20,22 @@ export interface ConfirmExpectation {
  */
 export function mockConfirm(...expectations: ConfirmExpectation[]) {
   (confirm as jest.Mock).mockImplementation((text: string) => {
-    for (const { text: expectedText, result } of expectations) {
-      if (text === expectedText) {
-        return Promise.resolve(result);
+    for (const expectation of expectations) {
+      if (normalizeSlashes(text) === normalizeSlashes(expectation.text)) {
+        expectations = expectations.filter((e) => e !== expectation);
+        return Promise.resolve(expectation.result);
       }
     }
     throw new Error(`Unexpected confirmation message: ${text}`);
   });
+  return () => {
+    if (expectations.length > 0) {
+      throw new Error(
+        "The following expected confirmation dialogs were not used:\n" +
+          expectations.map((e) => `- "${e.text}"`).join("\n")
+      );
+    }
+  };
 }
 
 export function clearConfirmMocks() {
@@ -62,18 +72,23 @@ export interface PromptExpectation {
 export function mockPrompt(...expectations: PromptExpectation[]) {
   (prompt as jest.Mock).mockImplementation(
     (text: string, type: "text" | "password") => {
-      for (const {
-        text: expectedText,
-        type: expectedType,
-        result,
-      } of expectations) {
-        if (text === expectedText && type == expectedType) {
-          return Promise.resolve(result);
+      for (const expectation of expectations) {
+        if (text === expectation.text && type == expectation.type) {
+          expectations = expectations.filter((e) => e !== expectation);
+          return Promise.resolve(expectation.result);
         }
       }
       throw new Error(`Unexpected confirmation message: ${text}`);
     }
   );
+  return () => {
+    if (expectations.length > 0) {
+      throw new Error(
+        "The following expected prompt dialogs were not used:\n" +
+          expectations.map((e) => `- "${e.text}"`).join("\n")
+      );
+    }
+  };
 }
 
 export function clearPromptMocks() {
@@ -87,3 +102,52 @@ export function clearPromptMocks() {
     );
   });
 }
+
+/**
+ * The expected values for a select request.
+ */
+export interface SelectExpectation {
+  /** The text expected to be seen in the select dialog. */
+  text: string;
+  /** The mock response send back from the select dialog. */
+  result: string;
+}
+
+/**
+ * Mock the implementation of `select()` that will respond with configured results
+ * for configured select text messages.
+ *
+ * If there is a call to `select()` that does not match any of the expectations
+ * then an error is thrown.
+ */
+export function mockSelect(...expectations: SelectExpectation[]) {
+  (select as jest.Mock).mockImplementation((text: string) => {
+    for (const expectation of expectations) {
+      if (normalizeSlashes(text) === normalizeSlashes(expectation.text)) {
+        expectations = expectations.filter((e) => e !== expectation);
+        return Promise.resolve(expectation.result);
+      }
+    }
+    throw new Error(`Unexpected select message: ${text}`);
+  });
+  return () => {
+    if (expectations.length > 0) {
+      throw new Error(
+        "The following expected select dialogs were not used:\n" +
+          expectations.map((e) => `- "${e.text}"`).join("\n")
+      );
+    }
+  };
+}
+
+export function clearSelectMocks() {
+  (select as jest.Mock).mockReset();
+  // Because select was originally a spy, calling mockReset will simply reset
+  // it as a function with no return value (!), so we need to additionally reset
+  // the mock implementation to the one that throws (from jest.setup.js).
+  (select as jest.Mock).mockImplementation((text: string) => {
+    throw new Error(
+      `Unexpected call to \`select("${text}")\`.\nYou should use \`mockSelect()\` to mock calls to \`select()\` with expectations. Search the codebase for \`mockSelect\` to learn more.`
+    );
+  });
+}

package/src/__tests__/helpers/mock-process.ts

@@ -0,0 +1,24 @@
+/**
+ * We use this module to mock process methods (write only for now),
+ * and optionally assert on the values they're called with in our tests.
+ */
+
+let writeSpy: jest.SpyInstance;
+
+function captureWriteCall(spy: jest.SpyInstance): Buffer {
+  return spy.mock.calls[0]?.[0] ?? Buffer.alloc(0);
+}
+
+export function mockProcess() {
+  beforeEach(() => {
+    writeSpy = jest.spyOn(process.stdout, "write").mockImplementation();
+  });
+  afterEach(() => {
+    writeSpy.mockRestore();
+  });
+  return {
+    get write() {
+      return captureWriteCall(writeSpy);
+    },
+  };
+}

package/src/__tests__/index.test.ts

@@ -2,6 +2,8 @@ import { getPackageManager } from "../package-manager";
 import { mockConsoleMethods } from "./helpers/mock-console";
 import { runInTempDir } from "./helpers/run-in-tmp";
 import { runWrangler } from "./helpers/run-wrangler";
+import { writeWorkerSource } from "./helpers/write-worker-source";
+import writeWranglerToml from "./helpers/write-wrangler-toml";
 import type { PackageManager } from "../package-manager";
 
 describe("wrangler", () => {
@@ -44,10 +46,9 @@ describe("wrangler", () => {
           wrangler whoami            🕵️  Retrieve your user info and test your auth config
 
         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]"
       `);
 
       expect(std.err).toMatchInlineSnapshot(`""`);
@@ -64,10 +65,7 @@ describe("wrangler", () => {
 
       expect(std.out).toMatchInlineSnapshot(`
         "
-        "
-      `);
-      expect(std.err).toMatchInlineSnapshot(`
-        "wrangler
+        wrangler
 
         Commands:
           wrangler init [name]       📥 Create a wrangler.toml configuration file
@@ -85,11 +83,12 @@ describe("wrangler", () => {
           wrangler whoami            🕵️  Retrieve your user info and test your auth config
 
         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]
-        X [ERROR] Unknown argument: invalid-command
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
+      `);
+      expect(std.err).toMatchInlineSnapshot(`
+        "X [ERROR] Unknown argument: invalid-command
 
         "
       `);
@@ -116,9 +115,6 @@ describe("wrangler", () => {
   });
 
   describe("subcommand implicit help ran on incomplete command execution", () => {
-    function endEventLoop() {
-      return new Promise((resolve) => setImmediate(resolve));
-    }
     it("no subcommand for 'secret' should display a list of available subcommands", async () => {
       await runWrangler("secret");
       await endEventLoop();
@@ -133,10 +129,9 @@ describe("wrangler", () => {
           wrangler secret list          List all secrets for a script
 
         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]"
       `);
     });
 
@@ -144,20 +139,19 @@ describe("wrangler", () => {
       await runWrangler("kv:namespace");
       await endEventLoop();
       expect(std.out).toMatchInlineSnapshot(`
-         "wrangler kv:namespace
+        "wrangler kv:namespace
 
-         🗂️  Interact with your Workers KV Namespaces
+        🗂️  Interact with your Workers KV Namespaces
 
-         Commands:
-           wrangler kv:namespace create <namespace>  Create a new namespace
-           wrangler kv:namespace list                Outputs a list of all KV namespaces associated with your account id.
-           wrangler kv:namespace delete              Deletes a given namespace.
+        Commands:
+          wrangler kv:namespace create <namespace>  Create a new namespace
+          wrangler kv:namespace list                Outputs a list of all KV namespaces associated with your account id.
+          wrangler kv:namespace delete              Deletes a given namespace.
 
-         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]"
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
       `);
     });
 
@@ -165,62 +159,61 @@ describe("wrangler", () => {
       await runWrangler("kv:key");
       await endEventLoop();
       expect(std.out).toMatchInlineSnapshot(`
-               "wrangler kv:key
+        "wrangler kv:key
 
-               🔑 Individually manage Workers KV key-value pairs
+        🔑 Individually manage Workers KV key-value pairs
 
-               Commands:
-                 wrangler kv:key put <key> [value]  Writes a single key/value pair to the given namespace.
-                 wrangler kv:key list               Outputs a list of all keys in a given namespace.
-                 wrangler kv:key get <key>          Reads a single value by key from the given namespace.
-                 wrangler kv:key delete <key>       Removes a single key value pair from the given namespace.
+        Commands:
+          wrangler kv:key put <key> [value]  Writes a single key/value pair to the given namespace.
+          wrangler kv:key list               Outputs a list of all keys in a given namespace.
+          wrangler kv:key get <key>          Reads a single value by key from the given namespace.
+          wrangler kv:key delete <key>       Removes a single key value pair from the given namespace.
 
-               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]"
-            `);
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
+      `);
     });
 
     it("no subcommand 'kv:bulk' should display a list of available subcommands", async () => {
       await runWrangler("kv:bulk");
       await endEventLoop();
       expect(std.out).toMatchInlineSnapshot(`
-               "wrangler kv:bulk
+        "wrangler kv:bulk
 
-               💪 Interact with multiple Workers KV key-value pairs at once
+        💪 Interact with multiple Workers KV key-value pairs at once
 
-               Commands:
-                 wrangler kv:bulk put <filename>     Upload multiple key-value pairs to a namespace
-                 wrangler kv:bulk delete <filename>  Delete multiple key-value pairs from a namespace
+        Commands:
+          wrangler kv:bulk put <filename>     Upload multiple key-value pairs to a namespace
+          wrangler kv:bulk delete <filename>  Delete multiple key-value pairs from a namespace
 
-               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]"
-            `);
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
+      `);
     });
+
     it("no subcommand 'r2' should display a list of available subcommands", async () => {
       await runWrangler("r2");
       await endEventLoop();
       expect(std.out).toMatchInlineSnapshot(`
-               "wrangler r2
+        "wrangler r2
 
-               📦 Interact with an R2 store
+        📦 Interact with an R2 store
 
-               Commands:
-                 wrangler r2 bucket  Manage R2 buckets
+        Commands:
+          wrangler r2 bucket  Manage R2 buckets
 
-               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]"
-            `);
+        Flags:
+          -c, --config   Path to .toml configuration file  [string]
+          -h, --help     Show help  [boolean]
+          -v, --version  Show version number  [boolean]"
+      `);
     });
   });
+
   describe("Deprecated commands", () => {
     it("should print a deprecation message for 'generate'", async () => {
       await runWrangler("generate").catch((err) => {
@@ -237,13 +230,29 @@ describe("wrangler", () => {
         `);
       });
     });
-    it("should print a deprecation message for 'build'", async () => {
-      await runWrangler("build").catch((err) => {
-        expect(err.message).toMatchInlineSnapshot(`
-          "Deprecation:
-          \`wrangler build\` has been deprecated, please refer to https://github.com/cloudflare/wrangler2/blob/main/docs/deprecations.md#build for alternatives"
-        `);
-      });
+  });
+
+  it("should print a deprecation message for 'build' and then try to run `publish --dry-run --outdir`", async () => {
+    writeWranglerToml({
+      main: "index.js",
     });
+    writeWorkerSource();
+    await runWrangler("build");
+    await endEventLoop();
+    expect(std.out).toMatchInlineSnapshot(`
+      "▲ [WARNING] Deprecation: \`wrangler build\` has been deprecated.
+
+        Please refer to https://developers.cloudflare.com/workers/wrangler/migration/deprecations/#build
+        for more information.
+        Attempting to run \`wrangler publish --dry-run --outdir=dist\` for you instead:
+
+
+      --dry-run: exiting now.
+      Total Upload: 0xx KiB / gzip: 0xx KiB"
+    `);
   });
 });
+
+function endEventLoop() {
+  return new Promise((resolve) => setImmediate(resolve));
+}