wrangler 0.0.0-e043479 → 0.0.0-e0b9366

package/src/__tests__/index.test.ts

@@ -863,4 +863,129 @@ describe("wrangler", () => {
             `);
     });
   });
+
+  describe("subcommand implicit help ran on imcomplete 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();
+      expect(std.out).toMatchInlineSnapshot(`
+        "wrangler secret
+
+        🤫 Generate a secret that can be referenced in the worker script
+
+        Commands:
+          wrangler secret put <key>     Create or update a secret variable for a script
+          wrangler secret delete <key>  Delete a secret variable from a script
+          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]"
+      `);
+    });
+
+    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]
+               --legacy-env  Use legacy environments  [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]
+                     --legacy-env  Use legacy environments  [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]
+                     --legacy-env  Use legacy environments  [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]
+                     --legacy-env  Use legacy environments  [boolean]"
+            `);
+    });
+  });
+  describe("Deprecated commands", () => {
+    it("should print a deprecation message for 'generate'", async () => {
+      await runWrangler("generate").catch((err) => {
+        expect(err.message).toMatchInlineSnapshot(`
+          "DEPRECATION WARNING:
+          \`wrangler generate\` has been deprecated, please refer to https://github.com/cloudflare/wrangler2/blob/main/docs/deprecations.md#generate for alternatives"
+        `);
+      });
+    });
+    it("should print a deprecation message for 'build'", async () => {
+      await runWrangler("build").catch((err) => {
+        expect(err.message).toMatchInlineSnapshot(`
+          "DEPRECATION WARNING:
+          \`wrangler build\` has been deprecated, please refer to https://github.com/cloudflare/wrangler2/blob/main/docs/deprecations.md#build for alternatives"
+        `);
+      });
+    });
+  });
 });

package/src/__tests__/jest.setup.ts

@@ -56,7 +56,7 @@ jest.mock("../dialogs");
   );
 });
 
-jest.mock("../dev", () => {
+jest.mock("../dev/dev", () => {
   const { useApp } = jest.requireActual("ink");
   const { useEffect } = jest.requireActual("react");
   return jest.fn().mockImplementation(() => {

package/src/__tests__/kv.test.ts

@@ -673,26 +673,26 @@ describe("wrangler", () => {
 
     describe("list", () => {
       it("should list the keys of a namespace specified by namespace-id", async () => {
-        const keys = ["key-1", "key-2", "key-3"];
+        const keys = [
+          { name: "key-1" },
+          { name: "key-2", expiration: 123456789 },
+          { name: "key-3", expiration_ttl: 666 },
+        ];
         mockKeyListRequest("some-namespace-id", keys);
         await runWrangler("kv:key list --namespace-id some-namespace-id");
         expect(std.err).toMatchInlineSnapshot(`""`);
         expect(std.out).toMatchInlineSnapshot(`
           "[
             {
-              \\"name\\": \\"key-1\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-1\\"
             },
             {
               \\"name\\": \\"key-2\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"expiration\\": 123456789
             },
             {
               \\"name\\": \\"key-3\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"expiration_ttl\\": 666
             }
           ]"
         `);
@@ -700,7 +700,7 @@ describe("wrangler", () => {
 
       it("should list the keys of a namespace specified by binding", async () => {
         writeWranglerConfig();
-        const keys = ["key-1", "key-2", "key-3"];
+        const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
         mockKeyListRequest("bound-id", keys);
 
         await runWrangler("kv:key list --binding someBinding");
@@ -708,19 +708,13 @@ describe("wrangler", () => {
         expect(std.out).toMatchInlineSnapshot(`
           "[
             {
-              \\"name\\": \\"key-1\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-1\\"
             },
             {
-              \\"name\\": \\"key-2\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-2\\"
             },
             {
-              \\"name\\": \\"key-3\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-3\\"
             }
           ]"
         `);
@@ -728,26 +722,20 @@ describe("wrangler", () => {
 
       it("should list the keys of a preview namespace specified by binding", async () => {
         writeWranglerConfig();
-        const keys = ["key-1", "key-2", "key-3"];
+        const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
         mockKeyListRequest("preview-bound-id", keys);
         await runWrangler("kv:key list --binding someBinding --preview");
         expect(std.err).toMatchInlineSnapshot(`""`);
         expect(std.out).toMatchInlineSnapshot(`
           "[
             {
-              \\"name\\": \\"key-1\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-1\\"
             },
             {
-              \\"name\\": \\"key-2\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-2\\"
             },
             {
-              \\"name\\": \\"key-3\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-3\\"
             }
           ]"
         `);
@@ -755,7 +743,7 @@ describe("wrangler", () => {
 
       it("should list the keys of a namespace specified by binding, in a given environment", async () => {
         writeWranglerConfig();
-        const keys = ["key-1", "key-2", "key-3"];
+        const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
         mockKeyListRequest("env-bound-id", keys);
         await runWrangler(
           "kv:key list --binding someBinding --env some-environment"
@@ -764,19 +752,13 @@ describe("wrangler", () => {
         expect(std.out).toMatchInlineSnapshot(`
           "[
             {
-              \\"name\\": \\"key-1\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-1\\"
             },
             {
-              \\"name\\": \\"key-2\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-2\\"
             },
             {
-              \\"name\\": \\"key-3\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-3\\"
             }
           ]"
         `);
@@ -784,7 +766,7 @@ describe("wrangler", () => {
 
       it("should list the keys of a preview namespace specified by binding, in a given environment", async () => {
         writeWranglerConfig();
-        const keys = ["key-1", "key-2", "key-3"];
+        const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
         mockKeyListRequest("preview-env-bound-id", keys);
         await runWrangler(
           "kv:key list --binding someBinding --preview --env some-environment"
@@ -793,19 +775,13 @@ describe("wrangler", () => {
         expect(std.out).toMatchInlineSnapshot(`
           "[
             {
-              \\"name\\": \\"key-1\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-1\\"
             },
             {
-              \\"name\\": \\"key-2\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-2\\"
             },
             {
-              \\"name\\": \\"key-3\\",
-              \\"expiration\\": 123456789,
-              \\"metadata\\": {}
+              \\"name\\": \\"key-3\\"
             }
           ]"
         `);
@@ -822,9 +798,9 @@ describe("wrangler", () => {
         describe(`cursor - ${blankCursorValue}`, () => {
           it("should make multiple requests for paginated results", async () => {
             // Create a lot of mock keys, so that the fetch requests will be paginated
-            const keys: string[] = [];
+            const keys: NamespaceKeyInfo[] = [];
             for (let i = 0; i < 550; i++) {
-              keys.push("key-" + i);
+              keys.push({ name: "key-" + i });
             }
             // Ask for the keys in pages of size 100.
             const requests = mockKeyListRequest(
@@ -837,9 +813,7 @@ describe("wrangler", () => {
               "kv:key list --namespace-id some-namespace-id --limit 100"
             );
             expect(std.err).toMatchInlineSnapshot(`""`);
-            expect(
-              JSON.parse(std.out).map((k: NamespaceKeyInfo) => k.name)
-            ).toEqual(keys);
+            expect(JSON.parse(std.out)).toEqual(keys);
             expect(requests.count).toEqual(6);
           });
         });

package/src/__tests__/logout.test.ts

@@ -2,9 +2,12 @@ import { existsSync } from "node:fs";
 import os from "node:os";
 import path from "node:path";
 import fetchMock from "jest-fetch-mock";
-import { initialise } from "../user";
+import {
+  reinitialiseAuthTokens,
+  USER_AUTH_CONFIG_FILE,
+  writeAuthConfigFile,
+} from "../user";
 import { mockConsoleMethods } from "./helpers/mock-console";
-import { writeUserConfig } from "./helpers/mock-user";
 import { runInTempDir } from "./helpers/run-in-tmp";
 import { runWrangler } from "./helpers/run-wrangler";
 
@@ -14,14 +17,15 @@ describe("wrangler", () => {
 
   describe("logout", () => {
     it("should exit with a message stating the user is not logged in", async () => {
-      await initialise();
       await runWrangler("logout");
       expect(std.out).toMatchInlineSnapshot(`"Not logged in, exiting..."`);
     });
 
     it("should logout user that has been properly logged in", async () => {
-      writeUserConfig("some-oauth-tok", "some-refresh-tok");
-
+      writeAuthConfigFile({
+        oauth_token: "some-oauth-tok",
+        refresh_token: "some-refresh-tok",
+      });
       // Mock out the response for a request to revoke the auth tokens,
       // checking the form of the request is as expected.
       fetchMock.mockResponseOnce(async (req) => {
@@ -30,21 +34,19 @@ describe("wrangler", () => {
         return "";
       });
 
-      await initialise();
+      // Now that we have changed the auth tokens in the wrangler.toml we must reinitialize the user auth state.
+      reinitialiseAuthTokens();
       await runWrangler("logout");
 
-      expect(std.out).toMatchInlineSnapshot(`
-        "💁  Wrangler is configured with an OAuth token. The token has been successfully revoked
-        Removing ./home/.wrangler/config/default.toml.. success!"
-      `);
+      expect(std.out).toMatchInlineSnapshot(`"Successfully logged out."`);
 
       // Make sure that we made the request to logout.
       expect(fetchMock).toHaveBeenCalledTimes(1);
 
       // Make sure that logout removed the config file containing the auth tokens.
-      expect(
-        existsSync(path.join(os.homedir(), ".wrangler/config/default.toml"))
-      ).toBe(false);
+      expect(existsSync(path.join(os.homedir(), USER_AUTH_CONFIG_FILE))).toBe(
+        false
+      );
     });
   });
 });

package/src/__tests__/pages.test.ts

@@ -0,0 +1,44 @@
+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 type { PackageManager } from "../package-manager";
+
+describe("subcommand implicit help ran on imcomplete command execution", () => {
+  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();
+  function endEventLoop() {
+    return new Promise((resolve) => setImmediate(resolve));
+  }
+  it("no subcommand for 'pages' should display a list of available subcommands", async () => {
+    await runWrangler("pages");
+    await endEventLoop();
+    expect(std.out).toMatchInlineSnapshot(`
+    "wrangler pages
+
+    ⚡️ Configure Cloudflare Pages
+
+    Commands:
+      wrangler pages dev [directory] [-- command]  🧑‍💻 Develop your full-stack Pages application locally
+
+    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]"
+    `);
+  });
+});