wrangler 0.0.13 → 0.0.17

package/src/__tests__/kv.test.ts

@@ -1,16 +1,20 @@
-import { writeFileSync } from "fs";
-import type { KVNamespaceInfo } from "../kv";
+import { writeFileSync } from "node:fs";
+import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
 import {
   setMockResponse,
-  setMockRawResponse,
   unsetAllMocks,
-  createFetchResult,
-} from "./mock-cfetch";
-import { runWrangler } from "./run-wrangler";
-import { runInTempDir } from "./run-in-tmp";
-import { mockConsoleMethods } from "./mock-console";
+  unsetMockFetchKVGetValues,
+  setMockFetchKVGetValue,
+} from "./helpers/mock-cfetch";
+import { mockConsoleMethods } from "./helpers/mock-console";
+import { mockKeyListRequest } from "./helpers/mock-kv";
+import { runInTempDir } from "./helpers/run-in-tmp";
+import { runWrangler } from "./helpers/run-wrangler";
+import type { KVNamespaceInfo, NamespaceKeyInfo } from "../kv";
 
 describe("wrangler", () => {
+  mockAccountId();
+  mockApiToken();
   runInTempDir();
   const std = mockConsoleMethods();
 
@@ -34,12 +38,11 @@ describe("wrangler", () => {
       }
 
       it("should error if no namespace is given", async () => {
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:namespace create");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:namespace create")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Not enough non-option arguments: got 0, need at least 1"`
+        );
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
           "wrangler kv:namespace create <namespace>
@@ -61,18 +64,14 @@ describe("wrangler", () => {
 
           Not enough non-option arguments: got 0, need at least 1"
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: Not enough non-option arguments: got 0, need at least 1]`
-        );
       });
 
       it("should error if the namespace to create contains spaces", async () => {
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:namespace create abc def ghi");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:namespace create abc def ghi")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Unexpected additional positional arguments \\"def ghi\\"."`
+        );
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
           "wrangler kv:namespace create <namespace>
@@ -94,18 +93,14 @@ describe("wrangler", () => {
 
           Unexpected additional positional arguments \\"def ghi\\"."
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: Unexpected additional positional arguments "def ghi".]`
-        );
       });
 
       it("should error if the namespace to create is not valid", async () => {
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:namespace create abc-def");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:namespace create abc-def")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"The namespace binding name \\"abc-def\\" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number."`
+        );
 
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
@@ -128,9 +123,6 @@ describe("wrangler", () => {
 
           The namespace binding name \\"abc-def\\" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number."
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: The namespace binding name "abc-def" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number.]`
-        );
       });
 
       it("should create a namespace", async () => {
@@ -273,16 +265,11 @@ describe("wrangler", () => {
 
       it("should error if a given binding name is not in the configured kv namespaces", async () => {
         writeWranglerConfig();
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:namespace delete --binding otherBinding");
-        } catch (e) {
-          error = e;
-        }
-        expect(error).toMatchInlineSnapshot(`
-          [Error: Not able to delete namespace.
-          A namespace with binding name "otherBinding" was not found in the configured "kv_namespaces".]
-        `);
+        await expect(runWrangler("kv:namespace delete --binding otherBinding"))
+          .rejects.toThrowErrorMatchingInlineSnapshot(`
+                "Not able to delete namespace.
+                A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."
+              `);
         expect(std.err).toMatchInlineSnapshot(`
           "wrangler kv:namespace delete
 
@@ -422,21 +409,14 @@ describe("wrangler", () => {
           10,
           20
         );
-        let error: Error | undefined;
-        try {
-          await runWrangler(
-            "kv:key put my-key my-value --namespace-id some-namespace-id --expiration 10 --ttl 20"
-          );
-        } catch (e) {
-          error = e;
-        }
-
+        await runWrangler(
+          "kv:key put my-key my-value --namespace-id some-namespace-id --expiration 10 --ttl 20"
+        );
         expect(requests.count).toEqual(1);
         expect(std.out).toMatchInlineSnapshot(
           `"writing the value \\"my-value\\" to key \\"my-key\\" on namespace some-namespace-id"`
         );
         expect(std.err).toMatchInlineSnapshot(`""`);
-        expect(error).toMatchInlineSnapshot(`undefined`);
       });
 
       it("should put a key to the specified environment in a given namespace", async () => {
@@ -474,12 +454,11 @@ describe("wrangler", () => {
       });
 
       it("should error if no key is provided", async () => {
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:key put");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:key put")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Not enough non-option arguments: got 0, need at least 1"`
+        );
 
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
@@ -508,18 +487,14 @@ describe("wrangler", () => {
 
           Not enough non-option arguments: got 0, need at least 1"
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: Not enough non-option arguments: got 0, need at least 1]`
-        );
       });
 
       it("should error if no binding nor namespace is provided", async () => {
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:key put foo bar");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:key put foo bar")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Exactly one of the arguments binding and namespace-id is required"`
+        );
 
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
@@ -548,18 +523,14 @@ describe("wrangler", () => {
 
           Exactly one of the arguments binding and namespace-id is required"
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: Exactly one of the arguments binding and namespace-id is required]`
-        );
       });
 
       it("should error if both binding and namespace is provided", async () => {
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:key put foo bar --binding x --namespace-id y");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:key put foo bar --binding x --namespace-id y")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Arguments binding and namespace-id are mutually exclusive"`
+        );
 
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
@@ -588,18 +559,14 @@ describe("wrangler", () => {
 
           Arguments binding and namespace-id are mutually exclusive"
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: Arguments binding and namespace-id are mutually exclusive]`
-        );
       });
 
       it("should error if no value nor path is provided", async () => {
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:key put key --namespace-id 12345");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:key put key --namespace-id 12345")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Exactly one of the arguments value and path is required"`
+        );
 
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
@@ -628,20 +595,14 @@ describe("wrangler", () => {
 
           Exactly one of the arguments value and path is required"
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: Exactly one of the arguments value and path is required]`
-        );
       });
 
       it("should error if both value and path is provided", async () => {
-        let error: Error | undefined;
-        try {
-          await runWrangler(
-            "kv:key put key value --path xyz --namespace-id 12345"
-          );
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:key put key value --path xyz --namespace-id 12345")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Arguments value and path are mutually exclusive"`
+        );
 
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
@@ -670,19 +631,15 @@ describe("wrangler", () => {
 
           Arguments value and path are mutually exclusive"
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: Arguments value and path are mutually exclusive]`
-        );
       });
 
       it("should error if a given binding name is not in the configured kv namespaces", async () => {
         writeWranglerConfig();
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:key put key value --binding otherBinding");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:key put key value --binding otherBinding")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
+        );
 
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
@@ -691,9 +648,6 @@ describe("wrangler", () => {
           %s
           If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: A namespace with binding name "otherBinding" was not found in the configured "kv_namespaces".]`
-        );
       });
 
       it("should error if a given binding has both preview and non-preview and --preview is not specified", async () => {
@@ -703,12 +657,11 @@ describe("wrangler", () => {
           "my-key",
           "my-value"
         );
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:key put my-key my-value --binding someBinding");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:key put my-key my-value --binding someBinding")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"someBinding has both a namespace ID and a preview ID. Specify \\"--preview\\" or \\"--preview false\\" to avoid writing data to the wrong namespace."`
+        );
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
           "someBinding has both a namespace ID and a preview ID. Specify \\"--preview\\" or \\"--preview false\\" to avoid writing data to the wrong namespace.
@@ -716,9 +669,6 @@ describe("wrangler", () => {
           %s
           If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: someBinding has both a namespace ID and a preview ID. Specify "--preview" or "--preview false" to avoid writing data to the wrong namespace.]`
-        );
         expect(requests.count).toEqual(0);
       });
     });
@@ -863,32 +813,46 @@ describe("wrangler", () => {
         `);
       });
 
-      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[] = [];
-        for (let i = 0; i < 550; i++) {
-          keys.push("key-" + i);
-        }
-        // Ask for the keys in pages of size 100.
-        const requests = mockKeyListRequest("some-namespace-id", keys, 100);
-        await runWrangler(
-          "kv:key list --namespace-id some-namespace-id --limit 100"
-        );
-        expect(std.err).toMatchInlineSnapshot(`""`);
-        expect(JSON.parse(std.out).map((k) => k.name)).toEqual(keys);
-        expect(requests.count).toEqual(6);
-      });
+      // We'll run the next test with variations on the cursor
+      // that's returned on cloudflare's API after all results
+      // have been drained.
+      for (const blankCursorValue of [undefined, null, ""] as [
+        undefined,
+        null,
+        ""
+      ]) {
+        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[] = [];
+            for (let i = 0; i < 550; i++) {
+              keys.push("key-" + i);
+            }
+            // Ask for the keys in pages of size 100.
+            const requests = mockKeyListRequest(
+              "some-namespace-id",
+              keys,
+              100,
+              blankCursorValue
+            );
+            await runWrangler(
+              "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(requests.count).toEqual(6);
+          });
+        });
+      }
 
       it("should error if a given binding name is not in the configured kv namespaces", async () => {
         writeWranglerConfig();
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:key list --binding otherBinding");
-        } catch (e) {
-          error = e;
-        }
-        expect(error).toMatchInlineSnapshot(
-          `[Error: A namespace with binding name "otherBinding" was not found in the configured "kv_namespaces".]`
+        await expect(
+          runWrangler("kv:key list --binding otherBinding")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
         );
         expect(std.err).toMatchInlineSnapshot(`
           "A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
@@ -901,27 +865,13 @@ describe("wrangler", () => {
     });
 
     describe("get", () => {
-      function mockKeyGetRequest(
-        expectedNamespaceId: string,
-        expectedKey: string,
-        expectedValue: string
-      ) {
-        const requests = { count: 0 };
-        setMockRawResponse(
-          "/accounts/:accountId/storage/kv/namespaces/:namespaceId/values/:key",
-          ([_url, accountId, namespaceId, key]) => {
-            requests.count++;
-            expect(accountId).toEqual("some-account-id");
-            expect(namespaceId).toEqual(expectedNamespaceId);
-            expect(key).toEqual(expectedKey);
-            return expectedValue;
-          }
-        );
-        return requests;
-      }
+      afterEach(() => {
+        unsetMockFetchKVGetValues();
+      });
 
       it("should get a key in a given namespace specified by namespace-id", async () => {
-        const requests = mockKeyGetRequest(
+        setMockFetchKVGetValue(
+          "some-account-id",
           "some-namespace-id",
           "my-key",
           "my-value"
@@ -929,23 +879,27 @@ describe("wrangler", () => {
         await runWrangler("kv:key get my-key --namespace-id some-namespace-id");
         expect(std.out).toMatchInlineSnapshot(`"my-value"`);
         expect(std.err).toMatchInlineSnapshot(`""`);
-        expect(requests.count).toEqual(1);
       });
 
       it("should get a key in a given namespace specified by binding", async () => {
         writeWranglerConfig();
-        const requests = mockKeyGetRequest("bound-id", "my-key", "my-value");
+        setMockFetchKVGetValue(
+          "some-account-id",
+          "bound-id",
+          "my-key",
+          "my-value"
+        );
         await runWrangler(
           "kv:key get my-key --binding someBinding --preview false"
         );
         expect(std.out).toMatchInlineSnapshot(`"my-value"`);
         expect(std.err).toMatchInlineSnapshot(`""`);
-        expect(requests.count).toEqual(1);
       });
 
       it("should get a key in a given preview namespace specified by binding", async () => {
         writeWranglerConfig();
-        const requests = mockKeyGetRequest(
+        setMockFetchKVGetValue(
+          "some-account-id",
           "preview-bound-id",
           "my-key",
           "my-value"
@@ -953,12 +907,12 @@ describe("wrangler", () => {
         await runWrangler("kv:key get my-key --binding someBinding --preview");
         expect(std.out).toMatchInlineSnapshot(`"my-value"`);
         expect(std.err).toMatchInlineSnapshot(`""`);
-        expect(requests.count).toEqual(1);
       });
 
       it("should get a key for the specified environment in a given namespace", async () => {
         writeWranglerConfig();
-        const requests = mockKeyGetRequest(
+        setMockFetchKVGetValue(
+          "some-account-id",
           "env-bound-id",
           "my-key",
           "my-value"
@@ -968,16 +922,14 @@ describe("wrangler", () => {
         );
         expect(std.out).toMatchInlineSnapshot(`"my-value"`);
         expect(std.err).toMatchInlineSnapshot(`""`);
-        expect(requests.count).toEqual(1);
       });
 
       it("should error if no key is provided", async () => {
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:key get");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:key get")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Not enough non-option arguments: got 0, need at least 1"`
+        );
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
           "wrangler kv:key get <key>
@@ -1001,18 +953,14 @@ describe("wrangler", () => {
 
           Not enough non-option arguments: got 0, need at least 1"
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: Not enough non-option arguments: got 0, need at least 1]`
-        );
       });
 
       it("should error if no binding nor namespace is provided", async () => {
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:key get foo");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:key get foo")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Exactly one of the arguments binding and namespace-id is required"`
+        );
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
           "wrangler kv:key get <key>
@@ -1036,18 +984,14 @@ describe("wrangler", () => {
 
           Exactly one of the arguments binding and namespace-id is required"
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: Exactly one of the arguments binding and namespace-id is required]`
-        );
       });
 
       it("should error if both binding and namespace is provided", async () => {
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:key get foo --binding x --namespace-id y");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:key get foo --binding x --namespace-id y")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"Arguments binding and namespace-id are mutually exclusive"`
+        );
 
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
@@ -1072,19 +1016,15 @@ describe("wrangler", () => {
 
           Arguments binding and namespace-id are mutually exclusive"
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: Arguments binding and namespace-id are mutually exclusive]`
-        );
       });
 
       it("should error if a given binding name is not in the configured kv namespaces", async () => {
         writeWranglerConfig();
-        let error: Error | undefined;
-        try {
-          await runWrangler("kv:key get key --binding otherBinding");
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler("kv:key get key --binding otherBinding")
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
+        );
         expect(std.out).toMatchInlineSnapshot(`""`);
         expect(std.err).toMatchInlineSnapshot(`
           "A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
@@ -1092,9 +1032,6 @@ describe("wrangler", () => {
           %s
           If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: A namespace with binding name "otherBinding" was not found in the configured "kv_namespaces".]`
-        );
       });
     });
 
@@ -1146,12 +1083,11 @@ describe("wrangler", () => {
 
       it("should error if a given binding name is not in the configured kv namespaces", async () => {
         writeWranglerConfig();
-        let error: Error | undefined;
-        try {
-          await runWrangler(`kv:key delete --binding otherBinding someKey`);
-        } catch (e) {
-          error = e;
-        }
+        await expect(
+          runWrangler(`kv:key delete --binding otherBinding someKey`)
+        ).rejects.toThrowErrorMatchingInlineSnapshot(
+          `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
+        );
 
         expect(std.err).toMatchInlineSnapshot(`
           "A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
@@ -1159,9 +1095,6 @@ describe("wrangler", () => {
           %s
           If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new."
         `);
-        expect(error).toMatchInlineSnapshot(
-          `[Error: A namespace with binding name "otherBinding" was not found in the configured "kv_namespaces".]`
-        );
       });
 
       it("should delete a key in a namespace specified by binding name in a given environment", async () => {
@@ -1206,41 +1139,3 @@ function writeWranglerConfig() {
     "utf-8"
   );
 }
-
-export function mockKeyListRequest(
-  expectedNamespaceId: string,
-  expectedKeys: string[],
-  keysPerRequest = 1000
-) {
-  const requests = { count: 0 };
-  // See https://api.cloudflare.com/#workers-kv-namespace-list-a-namespace-s-keys
-  const expectedKeyObjects = expectedKeys.map((name) => ({
-    name,
-    expiration: 123456789,
-    metadata: {},
-  }));
-  setMockRawResponse(
-    "/accounts/:accountId/storage/kv/namespaces/:namespaceId/keys",
-    "GET",
-    ([_url, accountId, namespaceId], _init, query) => {
-      requests.count++;
-      expect(accountId).toEqual("some-account-id");
-      expect(namespaceId).toEqual(expectedNamespaceId);
-      if (expectedKeyObjects.length <= keysPerRequest) {
-        return createFetchResult(expectedKeyObjects);
-      } else {
-        const start = parseInt(query.get("cursor") ?? "0") || 0;
-        const end = start + keysPerRequest;
-        const cursor = end < expectedKeyObjects.length ? end : undefined;
-        return createFetchResult(
-          expectedKeyObjects.slice(start, end),
-          true,
-          [],
-          [],
-          { cursor }
-        );
-      }
-    }
-  );
-  return requests;
-}