wrangler 0.0.0-e0d2f35 → 0.0.0-e178d6fb

package/src/__tests__/index.test.ts

@@ -1,424 +1,262 @@
-import * as fsp from "node:fs/promises";
-import * as TOML from "@iarna/toml";
-import { mockConfirm } from "./mock-dialogs";
-import { runWrangler } from "./run-wrangler";
-import { runInTempDir } from "./run-in-tmp";
-import { mockConsoleMethods } from "./mock-console";
-import * as fs from "node:fs";
+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", () => {
-  runInTempDir();
-
-  const std = mockConsoleMethods();
-
-  describe("no command", () => {
-    it("should display a list of available commands", async () => {
-      await runWrangler();
-
-      expect(std.out).toMatchInlineSnapshot(`
-        "wrangler
-
-        Commands:
-          wrangler init [name]       📥 Create a wrangler.toml configuration file
-          wrangler whoami            🕵️  Retrieve your user info and test your auth config
-          wrangler dev <filename>    👂 Start a local server for developing your worker
-          wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
-          wrangler tail [name]       🦚 Starts a log tailing session for a deployed Worker.
-          wrangler secret            🤫 Generate a secret that can be referenced in the worker script
-          wrangler kv:namespace      🗂️  Interact with your Workers KV Namespaces
-          wrangler kv:key            🔑 Individually manage Workers KV key-value pairs
-          wrangler kv:bulk           💪 Interact with multiple Workers KV key-value pairs at once
-          wrangler pages             ⚡️ Configure Cloudflare Pages
-
-        Flags:
-          -c, --config   Path to .toml configuration file  [string]
-          -h, --help     Show help  [boolean]
-          -v, --version  Show version number  [boolean]
-
-        Options:
-          -l, --local  Run on my machine  [boolean] [default: false]"
-      `);
-
-      expect(std.err).toMatchInlineSnapshot(`""`);
-    });
-  });
-
-  describe("invalid command", () => {
-    it("should display an error", async () => {
-      let err: Error | undefined;
-      try {
-        await runWrangler("invalid-command");
-      } catch (e) {
-        err = e;
-      } finally {
-        expect(err?.message).toBe(`Unknown command: invalid-command.`);
-      }
-
-      expect(std.out).toMatchInlineSnapshot(`""`);
-      expect(std.err).toMatchInlineSnapshot(`
-        "wrangler
-
-        Commands:
-          wrangler init [name]       📥 Create a wrangler.toml configuration file
-          wrangler whoami            🕵️  Retrieve your user info and test your auth config
-          wrangler dev <filename>    👂 Start a local server for developing your worker
-          wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
-          wrangler tail [name]       🦚 Starts a log tailing session for a deployed Worker.
-          wrangler secret            🤫 Generate a secret that can be referenced in the worker script
-          wrangler kv:namespace      🗂️  Interact with your Workers KV Namespaces
-          wrangler kv:key            🔑 Individually manage Workers KV key-value pairs
-          wrangler kv:bulk           💪 Interact with multiple Workers KV key-value pairs at once
-          wrangler pages             ⚡️ Configure Cloudflare Pages
-
-        Flags:
-          -c, --config   Path to .toml configuration file  [string]
-          -h, --help     Show help  [boolean]
-          -v, --version  Show version number  [boolean]
-
-        Options:
-          -l, --local  Run on my machine  [boolean] [default: false]
-
-        Unknown command: invalid-command."
-      `);
-    });
-  });
-
-  describe("init", () => {
-    it("should create a wrangler.toml", async () => {
-      mockConfirm({
-        text: "No package.json found. Would you like to create one?",
-        result: false,
-      });
-      await runWrangler("init");
-      const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
-      expect(typeof parsed.compatibility_date).toBe("string");
-      expect(fs.existsSync("./package.json")).toBe(false);
-      expect(fs.existsSync("./tsconfig.json")).toBe(false);
-    });
-
-    it("should display warning when wrangler.toml already exists, and exit if user does not want to carry on", async () => {
-      fs.writeFileSync(
-        "./wrangler.toml",
-        'compatibility_date="something-else"', // use a fake value to make sure the file is not overwritten
-        "utf-8"
-      );
-      mockConfirm({
-        text: "Do you want to continue initializing this project?",
-        result: false,
-      });
-      await runWrangler("init");
-      expect(std.warn).toContain("wrangler.toml file already exists!");
-      const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
-      expect(parsed.compatibility_date).toBe("something-else");
-    });
-
-    it("should display warning when wrangler.toml already exists, but continue if user does want to carry on", async () => {
-      fs.writeFileSync(
-        "./wrangler.toml",
-        `compatibility_date="something-else"`,
-        "utf-8"
-      );
-      mockConfirm(
-        {
-          text: "Do you want to continue initializing this project?",
-          result: true,
-        },
-        {
-          text: "No package.json found. Would you like to create one?",
-          result: false,
-        }
-      );
-      await runWrangler("init");
-      expect(std.warn).toContain("wrangler.toml file already exists!");
-      const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
-      expect(parsed.compatibility_date).toBe("something-else");
-    });
-
-    it("should create a package.json if none is found and user confirms", async () => {
-      mockConfirm(
-        {
-          text: "No package.json found. Would you like to create one?",
-          result: true,
-        },
-        {
-          text: "Would you like to use typescript?",
-          result: false,
-        }
-      );
-      await runWrangler("init");
-      expect(fs.existsSync("./package.json")).toBe(true);
-      const packageJson = JSON.parse(
-        fs.readFileSync("./package.json", "utf-8")
-      );
-      expect(packageJson.name).toEqual("worker"); // TODO: should we infer the name from the directory?
-      expect(packageJson.version).toEqual("0.0.1");
-      expect(packageJson.devDependencies).toEqual({
-        wrangler: expect.any(String),
-      });
-      expect(fs.existsSync("./tsconfig.json")).toBe(false);
-    });
-
-    it("should not touch an existing package.json in the same directory", async () => {
-      mockConfirm(
-        {
-          text: "Would you like to install wrangler into your package.json?",
-          result: false,
-        },
-        {
-          text: "Would you like to use typescript?",
-          result: false,
-        }
-      );
-
-      fs.writeFileSync(
-        "./package.json",
-        JSON.stringify({ name: "test", version: "1.0.0" }),
-        "utf-8"
-      );
-
-      await runWrangler("init");
-      const packageJson = JSON.parse(
-        fs.readFileSync("./package.json", "utf-8")
-      );
-      expect(packageJson.name).toEqual("test");
-      expect(packageJson.version).toEqual("1.0.0");
-    });
-
-    it("should offer to install wrangler into an existing package.json", async () => {
-      mockConfirm(
-        {
-          text: "Would you like to install wrangler into your package.json?",
-          result: true,
-        },
-        {
-          text: "Would you like to use typescript?",
-          result: false,
-        }
-      );
-
-      fs.writeFileSync(
-        "./package.json",
-        JSON.stringify({ name: "test", version: "1.0.0" }),
-        "utf-8"
-      );
-
-      await runWrangler("init");
-      const packageJson = JSON.parse(
-        fs.readFileSync("./package.json", "utf-8")
-      );
-      expect(packageJson.name).toEqual("test");
-      expect(packageJson.version).toEqual("1.0.0");
-      expect(packageJson.devDependencies).toEqual({
-        wrangler: expect.any(String),
-      });
-    });
-
-    it("should not touch an existing package.json in an ancestor directory", async () => {
-      mockConfirm(
-        {
-          text: "Would you like to install wrangler into your package.json?",
-          result: false,
-        },
-        {
-          text: "Would you like to use typescript?",
-          result: false,
-        }
-      );
-
-      fs.writeFileSync(
-        "./package.json",
-        JSON.stringify({ name: "test", version: "1.0.0" }),
-        "utf-8"
-      );
-
-      fs.mkdirSync("./sub-1/sub-2", { recursive: true });
-      process.chdir("./sub-1/sub-2");
-
-      await runWrangler("init");
-      expect(fs.existsSync("./package.json")).toBe(false);
-      expect(fs.existsSync("../../package.json")).toBe(true);
-
-      const packageJson = JSON.parse(
-        fs.readFileSync("../../package.json", "utf-8")
-      );
-      expect(packageJson).toMatchInlineSnapshot(`
-        Object {
-          "name": "test",
-          "version": "1.0.0",
-        }
-      `);
-    });
-
-    it("should create a tsconfig.json and install `workers-types` if none is found and user confirms", async () => {
-      mockConfirm(
-        {
-          text: "No package.json found. Would you like to create one?",
-          result: true,
-        },
-        {
-          text: "Would you like to use typescript?",
-          result: true,
-        }
-      );
-      await runWrangler("init");
-      expect(fs.existsSync("./tsconfig.json")).toBe(true);
-      const tsconfigJson = JSON.parse(
-        fs.readFileSync("./tsconfig.json", "utf-8")
-      );
-      expect(tsconfigJson.compilerOptions.types).toEqual([
-        "@cloudflare/workers-types",
-      ]);
-      const packageJson = JSON.parse(
-        fs.readFileSync("./package.json", "utf-8")
-      );
-      expect(packageJson.devDependencies).toEqual({
-        "@cloudflare/workers-types": expect.any(String),
-        wrangler: expect.any(String),
-      });
-    });
-
-    it("should not touch an existing tsconfig.json in the same directory", async () => {
-      fs.writeFileSync(
-        "./package.json",
-        JSON.stringify({
-          name: "test",
-          version: "1.0.0",
-          devDependencies: {
-            wrangler: "0.0.0",
-            "@cloudflare/workers-types": "0.0.0",
-          },
-        }),
-        "utf-8"
-      );
-      fs.writeFileSync(
-        "./tsconfig.json",
-        JSON.stringify({ compilerOptions: {} }),
-        "utf-8"
-      );
-
-      await runWrangler("init");
-      const tsconfigJson = JSON.parse(
-        fs.readFileSync("./tsconfig.json", "utf-8")
-      );
-      expect(tsconfigJson.compilerOptions).toEqual({});
-    });
-
-    it("should offer to install type definitions in an existing typescript project", async () => {
-      mockConfirm(
-        {
-          text: "Would you like to install wrangler into your package.json?",
-          result: false,
-        },
-        {
-          text: "Would you like to install the type definitions for Workers into your package.json?",
-          result: true,
-        }
-      );
-      fs.writeFileSync(
-        "./package.json",
-        JSON.stringify({
-          name: "test",
-          version: "1.0.0",
-        }),
-        "utf-8"
-      );
-      fs.writeFileSync(
-        "./tsconfig.json",
-        JSON.stringify({ compilerOptions: {} }),
-        "utf-8"
-      );
-
-      await runWrangler("init");
-      const tsconfigJson = JSON.parse(
-        fs.readFileSync("./tsconfig.json", "utf-8")
-      );
-      // unchanged tsconfig
-      expect(tsconfigJson.compilerOptions).toEqual({});
-      const packageJson = JSON.parse(
-        fs.readFileSync("./package.json", "utf-8")
-      );
-      expect(packageJson.devDependencies).toEqual({
-        "@cloudflare/workers-types": expect.any(String),
-      });
-    });
-
-    it("should not touch an existing tsconfig.json in an ancestor directory", async () => {
-      fs.writeFileSync(
-        "./package.json",
-        JSON.stringify({
-          name: "test",
-          version: "1.0.0",
-          devDependencies: {
-            wrangler: "0.0.0",
-            "@cloudflare/workers-types": "0.0.0",
-          },
-        }),
-        "utf-8"
-      );
-      fs.writeFileSync(
-        "./tsconfig.json",
-        JSON.stringify({ compilerOptions: {} }),
-        "utf-8"
-      );
-
-      fs.mkdirSync("./sub-1/sub-2", { recursive: true });
-      process.chdir("./sub-1/sub-2");
-
-      await runWrangler("init");
-      expect(fs.existsSync("./tsconfig.json")).toBe(false);
-      expect(fs.existsSync("../../tsconfig.json")).toBe(true);
-
-      const tsconfigJson = JSON.parse(
-        fs.readFileSync("../../tsconfig.json", "utf-8")
-      );
-      expect(tsconfigJson.compilerOptions).toEqual({});
-    });
-
-    it("should error if `--type` is used", async () => {
-      let err: undefined | Error;
-      try {
-        await runWrangler("init --type");
-      } catch (e) {
-        err = e;
-      } finally {
-        expect(err?.message).toBe(`The --type option is no longer supported.`);
-      }
-    });
-
-    it("should error if `--type javascript` is used", async () => {
-      let err: undefined | Error;
-      try {
-        await runWrangler("init --type javascript");
-      } catch (e) {
-        err = e;
-      } finally {
-        expect(err?.message).toBe(`The --type option is no longer supported.`);
-      }
-    });
-
-    it("should error if `--type rust` is used", async () => {
-      let err: undefined | Error;
-      try {
-        await runWrangler("init --type rust");
-      } catch (e) {
-        err = e;
-      } finally {
-        expect(err?.message).toBe(`The --type option is no longer supported.`);
-      }
-    });
-
-    it("should error if `--type webpack` is used", async () => {
-      let err: undefined | Error;
-      try {
-        await runWrangler("init --type webpack");
-      } catch (e) {
-        err = e;
-      } finally {
-        expect(err?.message).toBe(
-          `The --type option is no longer supported.
-If you wish to use webpack then you will need to create a custom build.`
-        );
-      }
-    });
-  });
+	let mockPackageManager: PackageManager;
+	runInTempDir();
+
+	beforeEach(() => {
+		mockPackageManager = {
+			cwd: process.cwd(),
+			// @ts-expect-error we're making a fake package manager here
+			type: "mockpm",
+			addDevDeps: jest.fn(),
+			install: jest.fn(),
+		};
+		(getPackageManager as jest.Mock).mockResolvedValue(mockPackageManager);
+	});
+
+	const std = mockConsoleMethods();
+
+	describe("no command", () => {
+		it("should display a list of available commands", async () => {
+			await runWrangler();
+
+			expect(std.out).toMatchInlineSnapshot(`
+			"wrangler
+
+			Commands:
+			  wrangler init [name]       📥 Create a wrangler.toml configuration file
+			  wrangler dev [script]      👂 Start a local server for developing your worker
+			  wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
+			  wrangler tail [name]       🦚 Starts a log tailing session for a published Worker.
+			  wrangler secret            🤫 Generate a secret that can be referenced in a Worker
+			  wrangler kv:namespace      🗂️  Interact with your Workers KV Namespaces
+			  wrangler kv:key            🔑 Individually manage Workers KV key-value pairs
+			  wrangler kv:bulk           💪 Interact with multiple Workers KV key-value pairs at once
+			  wrangler pages             ⚡️ Configure Cloudflare Pages
+			  wrangler r2                📦 Interact with an R2 store
+			  wrangler worker-namespace  📦 Interact with a worker namespace
+			  wrangler pubsub            📮 Interact and manage Pub/Sub Brokers
+			  wrangler login             🔓 Login to Cloudflare
+			  wrangler logout            🚪 Logout from Cloudflare
+			  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]"
+		`);
+
+			expect(std.err).toMatchInlineSnapshot(`""`);
+		});
+	});
+
+	describe("invalid command", () => {
+		it("should display an error", async () => {
+			await expect(
+				runWrangler("invalid-command")
+			).rejects.toThrowErrorMatchingInlineSnapshot(
+				`"Unknown argument: invalid-command"`
+			);
+
+			expect(std.out).toMatchInlineSnapshot(`
+			"
+			wrangler
+
+			Commands:
+			  wrangler init [name]       📥 Create a wrangler.toml configuration file
+			  wrangler dev [script]      👂 Start a local server for developing your worker
+			  wrangler publish [script]  🆙 Publish your Worker to Cloudflare.
+			  wrangler tail [name]       🦚 Starts a log tailing session for a published Worker.
+			  wrangler secret            🤫 Generate a secret that can be referenced in a Worker
+			  wrangler kv:namespace      🗂️  Interact with your Workers KV Namespaces
+			  wrangler kv:key            🔑 Individually manage Workers KV key-value pairs
+			  wrangler kv:bulk           💪 Interact with multiple Workers KV key-value pairs at once
+			  wrangler pages             ⚡️ Configure Cloudflare Pages
+			  wrangler r2                📦 Interact with an R2 store
+			  wrangler worker-namespace  📦 Interact with a worker namespace
+			  wrangler pubsub            📮 Interact and manage Pub/Sub Brokers
+			  wrangler login             🔓 Login to Cloudflare
+			  wrangler logout            🚪 Logout from Cloudflare
+			  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]"
+		`);
+			expect(std.err).toMatchInlineSnapshot(`
+			        "X [ERROR] Unknown argument: invalid-command
+
+			        "
+		      `);
+		});
+	});
+
+	describe("preview", () => {
+		it("should throw an error if the deprecated command is used with positional arguments", async () => {
+			await expect(runWrangler("preview GET")).rejects
+				.toThrowErrorMatchingInlineSnapshot(`
+              "Deprecation:
+              The \`wrangler preview\` command has been deprecated.
+              Try using \`wrangler dev\` to to try out a worker during development.
+              "
+            `);
+			await expect(runWrangler(`preview GET "SomeBody"`)).rejects
+				.toThrowErrorMatchingInlineSnapshot(`
+              "Deprecation:
+              The \`wrangler preview\` command has been deprecated.
+              Try using \`wrangler dev\` to to try out a worker during development.
+              "
+            `);
+		});
+	});
+
+	describe("subcommand implicit help ran on incomplete command execution", () => {
+		it("no subcommand for 'secret' should display a list of available subcommands", async () => {
+			await runWrangler("secret");
+			await endEventLoop();
+			expect(std.out).toMatchInlineSnapshot(`
+			"wrangler secret
+
+			🤫 Generate a secret that can be referenced in a Worker
+
+			Commands:
+			  wrangler secret put <key>     Create or update a secret variable for a Worker
+			  wrangler secret delete <key>  Delete a secret variable from a Worker
+			  wrangler secret list          List all secrets for a Worker
+
+			Flags:
+			  -c, --config   Path to .toml configuration file  [string]
+			  -h, --help     Show help  [boolean]
+			  -v, --version  Show version number  [boolean]"
+		`);
+		});
+
+		it("no subcommand 'kv:namespace' should display a list of available subcommands", async () => {
+			await runWrangler("kv:namespace");
+			await endEventLoop();
+			expect(std.out).toMatchInlineSnapshot(`
+			        "wrangler kv:namespace
+
+			        🗂️  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.
+
+			        Flags:
+			          -c, --config   Path to .toml configuration file  [string]
+			          -h, --help     Show help  [boolean]
+			          -v, --version  Show version number  [boolean]"
+		      `);
+		});
+
+		it("no subcommand 'kv:key' should display a list of available subcommands", async () => {
+			await runWrangler("kv:key");
+			await endEventLoop();
+			expect(std.out).toMatchInlineSnapshot(`
+			        "wrangler kv:key
+
+			        🔑 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.
+
+			        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
+
+			        💪 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
+
+			        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
+
+			        📦 Interact with an R2 store
+
+			        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]"
+		      `);
+		});
+	});
+
+	describe("Deprecated commands", () => {
+		it("should print a deprecation message for 'generate'", async () => {
+			await runWrangler("generate").catch((err) => {
+				expect(err.message).toMatchInlineSnapshot(`
+			          "Deprecation:
+			          \`wrangler generate\` has been deprecated.
+			          Try running \`wrangler init\` to generate a basic Worker, or cloning the template repository instead:
+
+			          \`\`\`
+			          git clone https://github.com/cloudflare/worker-template
+			          \`\`\`
+
+			          Please refer to https://developers.cloudflare.com/workers/wrangler/deprecations/#generate for more information."
+		        `);
+			});
+		});
+	});
+
+	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));
+}