wrangler 0.0.0-e61907d → 0.0.0-e64812e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +64 -0
  3. package/bin/wrangler.js +80 -2
  4. package/import_meta_url.js +3 -0
  5. package/miniflare-dist/index.mjs +4886 -0
  6. package/package.json +98 -28
  7. package/pages/functions/buildPlugin.ts +105 -0
  8. package/pages/functions/buildWorker.ts +151 -0
  9. package/pages/functions/filepath-routing.test.ts +234 -0
  10. package/pages/functions/filepath-routing.ts +189 -0
  11. package/pages/functions/identifiers.ts +78 -0
  12. package/pages/functions/routes.ts +156 -0
  13. package/pages/functions/template-plugin.ts +147 -0
  14. package/pages/functions/template-worker.ts +143 -0
  15. package/src/__tests__/config-cache.test.ts +36 -0
  16. package/src/__tests__/configuration.test.ts +3374 -0
  17. package/src/__tests__/dev.test.tsx +980 -0
  18. package/src/__tests__/guess-worker-format.test.ts +85 -0
  19. package/src/__tests__/helpers/clipboardy-mock.js +4 -0
  20. package/src/__tests__/helpers/cmd-shim.d.ts +11 -0
  21. package/src/__tests__/helpers/faye-websocket.d.ts +6 -0
  22. package/src/__tests__/helpers/mock-account-id.ts +48 -0
  23. package/src/__tests__/helpers/mock-bin.ts +36 -0
  24. package/src/__tests__/helpers/mock-cfetch.ts +211 -0
  25. package/src/__tests__/helpers/mock-console.ts +87 -0
  26. package/src/__tests__/helpers/mock-dialogs.ts +130 -0
  27. package/src/__tests__/helpers/mock-http-server.ts +46 -0
  28. package/src/__tests__/helpers/mock-istty.ts +27 -0
  29. package/src/__tests__/helpers/mock-kv.ts +33 -0
  30. package/src/__tests__/helpers/mock-oauth-flow.ts +255 -0
  31. package/src/__tests__/helpers/mock-stdin.ts +103 -0
  32. package/src/__tests__/helpers/mock-web-socket.ts +29 -0
  33. package/src/__tests__/helpers/run-in-tmp.ts +39 -0
  34. package/src/__tests__/helpers/run-wrangler.ts +16 -0
  35. package/src/__tests__/helpers/write-worker-source.ts +31 -0
  36. package/src/__tests__/helpers/write-wrangler-toml.ts +17 -0
  37. package/src/__tests__/https-options.test.ts +130 -0
  38. package/src/__tests__/index.test.ts +256 -0
  39. package/src/__tests__/init.test.ts +1634 -0
  40. package/src/__tests__/jest.setup.ts +77 -0
  41. package/src/__tests__/kv.test.ts +1481 -0
  42. package/src/__tests__/logger.test.ts +115 -0
  43. package/src/__tests__/package-manager.test.ts +353 -0
  44. package/src/__tests__/pages.test.ts +754 -0
  45. package/src/__tests__/parse.test.ts +330 -0
  46. package/src/__tests__/publish.test.ts +5468 -0
  47. package/src/__tests__/r2.test.ts +233 -0
  48. package/src/__tests__/route.test.ts +45 -0
  49. package/src/__tests__/secret.test.ts +481 -0
  50. package/src/__tests__/tail.test.ts +690 -0
  51. package/src/__tests__/user.test.ts +131 -0
  52. package/src/__tests__/whoami.test.tsx +105 -0
  53. package/src/abort.d.ts +3 -0
  54. package/src/bundle.ts +200 -0
  55. package/src/cfetch/index.ts +121 -0
  56. package/src/cfetch/internal.ts +145 -0
  57. package/src/cli.ts +13 -0
  58. package/src/config/README.md +107 -0
  59. package/src/config/config.ts +234 -0
  60. package/src/config/diagnostics.ts +80 -0
  61. package/src/config/environment.ts +420 -0
  62. package/src/config/index.ts +225 -0
  63. package/src/config/validation-helpers.ts +575 -0
  64. package/src/config/validation.ts +1539 -0
  65. package/src/config-cache.ts +45 -0
  66. package/src/create-worker-preview.ts +185 -0
  67. package/src/create-worker-upload-form.ts +254 -0
  68. package/src/dev/dev-vars.ts +36 -0
  69. package/src/dev/dev.tsx +419 -0
  70. package/src/dev/local.tsx +318 -0
  71. package/src/dev/remote.tsx +227 -0
  72. package/src/dev/use-esbuild.ts +118 -0
  73. package/src/dialogs.tsx +135 -0
  74. package/src/durable.ts +102 -0
  75. package/src/entry.ts +322 -0
  76. package/src/environment-variables.ts +35 -0
  77. package/src/errors.ts +11 -0
  78. package/src/https-options.ts +123 -0
  79. package/src/index.tsx +2864 -0
  80. package/src/inspect.ts +662 -0
  81. package/src/intl-polyfill.d.ts +139 -0
  82. package/src/kv.ts +408 -0
  83. package/src/logger.ts +66 -0
  84. package/src/miniflare-cli/README.md +30 -0
  85. package/src/miniflare-cli/enum-keys.ts +17 -0
  86. package/src/miniflare-cli/index.ts +41 -0
  87. package/src/miniflare-cli/request-context.ts +40 -0
  88. package/src/module-collection.ts +258 -0
  89. package/src/open-in-browser.ts +19 -0
  90. package/src/package-manager.ts +174 -0
  91. package/src/pages.tsx +2038 -0
  92. package/src/parse.ts +202 -0
  93. package/src/paths.ts +26 -0
  94. package/src/proxy.ts +465 -0
  95. package/src/publish.ts +583 -0
  96. package/src/r2.ts +50 -0
  97. package/src/selfsigned.d.ts +29 -0
  98. package/src/sites.tsx +295 -0
  99. package/src/tail/filters.ts +279 -0
  100. package/src/tail/index.ts +299 -0
  101. package/src/tail/printing.ts +67 -0
  102. package/src/update-check.ts +19 -0
  103. package/src/user.tsx +1203 -0
  104. package/src/whoami.tsx +70 -0
  105. package/src/worker.ts +180 -0
  106. package/templates/gitignore +171 -0
  107. package/templates/new-worker-scheduled.js +17 -0
  108. package/templates/new-worker-scheduled.ts +32 -0
  109. package/templates/new-worker.js +15 -0
  110. package/templates/new-worker.ts +30 -0
  111. package/{static-asset-facade.js → templates/static-asset-facade.js} +1 -1
  112. package/templates/tsconfig.json +105 -0
  113. package/wrangler-dist/cli.js +126702 -0
  114. package/wrangler-dist/index_node.js +0 -102507
  115. package/wrangler-dist/index_node.js.map +0 -7
@@ -0,0 +1,1481 @@
1
+ import { writeFileSync } from "node:fs";
2
+ import { Headers } from "undici";
3
+ import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
4
+ import {
5
+ setMockResponse,
6
+ unsetAllMocks,
7
+ unsetMockFetchKVGetValues,
8
+ setMockFetchKVGetValue,
9
+ } from "./helpers/mock-cfetch";
10
+ import { mockConsoleMethods } from "./helpers/mock-console";
11
+ import { clearConfirmMocks, mockConfirm } from "./helpers/mock-dialogs";
12
+ import { mockKeyListRequest } from "./helpers/mock-kv";
13
+ import { runInTempDir } from "./helpers/run-in-tmp";
14
+ import { runWrangler } from "./helpers/run-wrangler";
15
+ import type { KeyValue, KVNamespaceInfo, NamespaceKeyInfo } from "../kv";
16
+
17
+ describe("wrangler", () => {
18
+ mockAccountId();
19
+ mockApiToken();
20
+ runInTempDir();
21
+ const std = mockConsoleMethods();
22
+
23
+ afterEach(() => {
24
+ unsetAllMocks();
25
+ clearConfirmMocks();
26
+ });
27
+
28
+ describe("kv:namespace", () => {
29
+ describe("create", () => {
30
+ function mockCreateRequest(expectedTitle: string) {
31
+ setMockResponse(
32
+ "/accounts/:accountId/storage/kv/namespaces",
33
+ "POST",
34
+ ([_url, accountId], { body }) => {
35
+ expect(accountId).toEqual("some-account-id");
36
+ const title = JSON.parse(body as string).title;
37
+ expect(title).toEqual(expectedTitle);
38
+ return { id: "some-namespace-id" };
39
+ }
40
+ );
41
+ }
42
+
43
+ it("should error if no namespace is given", async () => {
44
+ await expect(
45
+ runWrangler("kv:namespace create")
46
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
47
+ `"Not enough non-option arguments: got 0, need at least 1"`
48
+ );
49
+ expect(std.out).toMatchInlineSnapshot(`
50
+ "
51
+ wrangler kv:namespace create <namespace>
52
+
53
+ Create a new namespace
54
+
55
+ Positionals:
56
+ namespace The name of the new namespace [string] [required]
57
+
58
+ Flags:
59
+ -c, --config Path to .toml configuration file [string]
60
+ -h, --help Show help [boolean]
61
+ -v, --version Show version number [boolean]
62
+
63
+ Options:
64
+ -e, --env Perform on a specific environment [string]
65
+ --preview Interact with a preview namespace [boolean]"
66
+ `);
67
+ expect(std.err).toMatchInlineSnapshot(`
68
+ "X [ERROR] Not enough non-option arguments: got 0, need at least 1
69
+
70
+ "
71
+ `);
72
+ });
73
+
74
+ it("should error if the namespace to create contains spaces", async () => {
75
+ await expect(
76
+ runWrangler("kv:namespace create abc def ghi")
77
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
78
+ `"Unknown arguments: def, ghi"`
79
+ );
80
+ expect(std.out).toMatchInlineSnapshot(`
81
+ "
82
+ wrangler kv:namespace create <namespace>
83
+
84
+ Create a new namespace
85
+
86
+ Positionals:
87
+ namespace The name of the new namespace [string] [required]
88
+
89
+ Flags:
90
+ -c, --config Path to .toml configuration file [string]
91
+ -h, --help Show help [boolean]
92
+ -v, --version Show version number [boolean]
93
+
94
+ Options:
95
+ -e, --env Perform on a specific environment [string]
96
+ --preview Interact with a preview namespace [boolean]"
97
+ `);
98
+ expect(std.err).toMatchInlineSnapshot(`
99
+ "X [ERROR] Unknown arguments: def, ghi
100
+
101
+ "
102
+ `);
103
+ });
104
+
105
+ it("should error if the namespace to create is not valid", async () => {
106
+ await expect(
107
+ runWrangler("kv:namespace create abc-def")
108
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
109
+ `"The namespace binding name \\"abc-def\\" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number."`
110
+ );
111
+
112
+ expect(std.out).toMatchInlineSnapshot(`
113
+ "
114
+ wrangler kv:namespace create <namespace>
115
+
116
+ Create a new namespace
117
+
118
+ Positionals:
119
+ namespace The name of the new namespace [string] [required]
120
+
121
+ Flags:
122
+ -c, --config Path to .toml configuration file [string]
123
+ -h, --help Show help [boolean]
124
+ -v, --version Show version number [boolean]
125
+
126
+ Options:
127
+ -e, --env Perform on a specific environment [string]
128
+ --preview Interact with a preview namespace [boolean]"
129
+ `);
130
+ expect(std.err).toMatchInlineSnapshot(`
131
+ "X [ERROR] The namespace binding name \\"abc-def\\" is invalid. It can only have alphanumeric and _ characters, and cannot begin with a number.
132
+
133
+ "
134
+ `);
135
+ });
136
+
137
+ it("should create a namespace", async () => {
138
+ mockCreateRequest("worker-UnitTestNamespace");
139
+ await runWrangler("kv:namespace create UnitTestNamespace");
140
+ expect(std.out).toMatchInlineSnapshot(`
141
+ "🌀 Creating namespace with title \\"worker-UnitTestNamespace\\"
142
+ ✨ Success!
143
+ Add the following to your configuration file in your kv_namespaces array:
144
+ { binding = \\"UnitTestNamespace\\", id = \\"some-namespace-id\\" }"
145
+ `);
146
+ });
147
+
148
+ it("should create a preview namespace if configured to do so", async () => {
149
+ mockCreateRequest("worker-UnitTestNamespace_preview");
150
+ await runWrangler("kv:namespace create UnitTestNamespace --preview");
151
+ expect(std.out).toMatchInlineSnapshot(`
152
+ "🌀 Creating namespace with title \\"worker-UnitTestNamespace_preview\\"
153
+ ✨ Success!
154
+ Add the following to your configuration file in your kv_namespaces array:
155
+ { binding = \\"UnitTestNamespace\\", preview_id = \\"some-namespace-id\\" }"
156
+ `);
157
+ });
158
+
159
+ it("should create a namespace using configured worker name", async () => {
160
+ writeFileSync("./wrangler.toml", 'name = "other-worker"', "utf-8");
161
+ mockCreateRequest("other-worker-UnitTestNamespace");
162
+ await runWrangler("kv:namespace create UnitTestNamespace");
163
+ expect(std.out).toMatchInlineSnapshot(`
164
+ "🌀 Creating namespace with title \\"other-worker-UnitTestNamespace\\"
165
+ ✨ Success!
166
+ Add the following to your configuration file in your kv_namespaces array:
167
+ { binding = \\"UnitTestNamespace\\", id = \\"some-namespace-id\\" }"
168
+ `);
169
+ });
170
+
171
+ it("should create a namespace in an environment if configured to do so", async () => {
172
+ mockCreateRequest("worker-customEnv-UnitTestNamespace");
173
+ await runWrangler(
174
+ "kv:namespace create UnitTestNamespace --env customEnv"
175
+ );
176
+ expect(std.out).toMatchInlineSnapshot(`
177
+ "🌀 Creating namespace with title \\"worker-customEnv-UnitTestNamespace\\"
178
+ ✨ Success!
179
+ Add the following to your configuration file in your kv_namespaces array under [env.customEnv]:
180
+ { binding = \\"UnitTestNamespace\\", id = \\"some-namespace-id\\" }"
181
+ `);
182
+ });
183
+ });
184
+
185
+ describe("list", () => {
186
+ function mockListRequest(namespaces: unknown[]) {
187
+ const requests = { count: 0 };
188
+ setMockResponse(
189
+ "/accounts/:accountId/storage/kv/namespaces",
190
+ ([_url, accountId], init, query) => {
191
+ requests.count++;
192
+ expect(accountId).toEqual("some-account-id");
193
+ expect(query.get("per_page")).toEqual("100");
194
+ expect(query.get("order")).toEqual("title");
195
+ expect(query.get("direction")).toEqual("asc");
196
+ expect(query.get("page")).toEqual(`${requests.count}`);
197
+ expect(init).toEqual({});
198
+ const pageSize = Number(query.get("per_page"));
199
+ const page = Number(query.get("page"));
200
+ return namespaces.slice((page - 1) * pageSize, page * pageSize);
201
+ }
202
+ );
203
+ return requests;
204
+ }
205
+
206
+ it("should list namespaces", async () => {
207
+ const kvNamespaces: KVNamespaceInfo[] = [
208
+ { title: "title-1", id: "id-1" },
209
+ { title: "title-2", id: "id-2" },
210
+ ];
211
+ mockListRequest(kvNamespaces);
212
+ await runWrangler("kv:namespace list");
213
+
214
+ expect(std.err).toMatchInlineSnapshot(`""`);
215
+ const namespaces = JSON.parse(std.out);
216
+ expect(namespaces).toEqual(kvNamespaces);
217
+ });
218
+
219
+ it("should make multiple requests for paginated results", async () => {
220
+ // Create a lot of mock namespaces, so that the fetch requests will be paginated
221
+ const kvNamespaces: KVNamespaceInfo[] = [];
222
+ for (let i = 0; i < 550; i++) {
223
+ kvNamespaces.push({ title: "title-" + i, id: "id-" + i });
224
+ }
225
+ const requests = mockListRequest(kvNamespaces);
226
+ await runWrangler("kv:namespace list");
227
+ const namespaces = JSON.parse(std.out);
228
+ expect(namespaces).toEqual(kvNamespaces);
229
+ expect(requests.count).toEqual(6);
230
+ });
231
+ });
232
+
233
+ describe("delete", () => {
234
+ function mockDeleteRequest(expectedNamespaceId: string) {
235
+ const requests = { count: 0 };
236
+ setMockResponse(
237
+ "/accounts/:accountId/storage/kv/namespaces/:namespaceId",
238
+ "DELETE",
239
+ ([_url, accountId, namespaceId]) => {
240
+ requests.count++;
241
+ expect(accountId).toEqual("some-account-id");
242
+ expect(namespaceId).toEqual(expectedNamespaceId);
243
+ return null;
244
+ }
245
+ );
246
+ return requests;
247
+ }
248
+
249
+ it("should delete a namespace specified by id", async () => {
250
+ const requests = mockDeleteRequest("some-namespace-id");
251
+ await runWrangler(
252
+ `kv:namespace delete --namespace-id some-namespace-id`
253
+ );
254
+ expect(requests.count).toEqual(1);
255
+ });
256
+
257
+ it("should delete a namespace specified by binding name", async () => {
258
+ writeWranglerConfig();
259
+ const requests = mockDeleteRequest("bound-id");
260
+ await runWrangler(
261
+ `kv:namespace delete --binding someBinding --preview false`
262
+ );
263
+ expect(requests.count).toEqual(1);
264
+ });
265
+
266
+ it("should delete a preview namespace specified by binding name", async () => {
267
+ writeWranglerConfig();
268
+ const requests = mockDeleteRequest("preview-bound-id");
269
+ await runWrangler(
270
+ `kv:namespace delete --binding someBinding --preview`
271
+ );
272
+ expect(requests.count).toEqual(1);
273
+ });
274
+
275
+ it("should error if a given binding name is not in the configured kv namespaces", async () => {
276
+ writeWranglerConfig();
277
+ await expect(runWrangler("kv:namespace delete --binding otherBinding"))
278
+ .rejects.toThrowErrorMatchingInlineSnapshot(`
279
+ "Not able to delete namespace.
280
+ A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."
281
+ `);
282
+ expect(std.err).toMatchInlineSnapshot(`
283
+ "X [ERROR] Not able to delete namespace.
284
+
285
+ A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
286
+
287
+ "
288
+ `);
289
+ });
290
+
291
+ it("should delete a namespace specified by binding name in a given environment", async () => {
292
+ writeWranglerConfig();
293
+ const requests = mockDeleteRequest("env-bound-id");
294
+ await runWrangler(
295
+ "kv:namespace delete --binding someBinding --env some-environment --preview false"
296
+ );
297
+
298
+ expect(std.out).toMatchInlineSnapshot(`""`);
299
+ expect(std.err).toMatchInlineSnapshot(`""`);
300
+ expect(requests.count).toEqual(1);
301
+ });
302
+
303
+ it("should delete a preview namespace specified by binding name in a given environment", async () => {
304
+ writeWranglerConfig();
305
+ const requests = mockDeleteRequest("preview-env-bound-id");
306
+ await runWrangler(
307
+ `kv:namespace delete --binding someBinding --env some-environment --preview`
308
+ );
309
+ expect(requests.count).toEqual(1);
310
+ });
311
+ });
312
+ });
313
+
314
+ describe("kv:key", () => {
315
+ describe("put", () => {
316
+ function mockKeyPutRequest(
317
+ expectedNamespaceId: string,
318
+ expectedKV: KeyValue
319
+ ) {
320
+ const requests = { count: 0 };
321
+ setMockResponse(
322
+ "/accounts/:accountId/storage/kv/namespaces/:namespaceId/values/:key",
323
+ "PUT",
324
+ ([_url, accountId, namespaceId, key], { body }, query) => {
325
+ requests.count++;
326
+ expect(accountId).toEqual("some-account-id");
327
+ expect(namespaceId).toEqual(expectedNamespaceId);
328
+ expect(key).toEqual(expectedKV.key);
329
+ expect(body).toEqual(expectedKV.value);
330
+ if (expectedKV.expiration !== undefined) {
331
+ expect(query.get("expiration")).toEqual(
332
+ `${expectedKV.expiration}`
333
+ );
334
+ } else {
335
+ expect(query.has("expiration")).toBe(false);
336
+ }
337
+ if (expectedKV.expiration_ttl) {
338
+ expect(query.get("expiration_ttl")).toEqual(
339
+ `${expectedKV.expiration_ttl}`
340
+ );
341
+ } else {
342
+ expect(query.has("expiration_ttl")).toBe(false);
343
+ }
344
+ return null;
345
+ }
346
+ );
347
+ return requests;
348
+ }
349
+
350
+ it("should put a key in a given namespace specified by namespace-id", async () => {
351
+ const requests = mockKeyPutRequest("some-namespace-id", {
352
+ key: "my-key",
353
+ value: "my-value",
354
+ });
355
+
356
+ await runWrangler(
357
+ "kv:key put my-key my-value --namespace-id some-namespace-id"
358
+ );
359
+
360
+ expect(requests.count).toEqual(1);
361
+ expect(std.out).toMatchInlineSnapshot(
362
+ `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace some-namespace-id."`
363
+ );
364
+ expect(std.err).toMatchInlineSnapshot(`""`);
365
+ });
366
+
367
+ it("should encode the key in the api request to put a value", async () => {
368
+ const requests = mockKeyPutRequest("DS9", {
369
+ key: "%2Fmy-key",
370
+ value: "my-value",
371
+ });
372
+
373
+ await runWrangler("kv:key put /my-key my-value --namespace-id DS9");
374
+
375
+ expect(requests.count).toEqual(1);
376
+ expect(std.out).toMatchInlineSnapshot(
377
+ `"Writing the value \\"my-value\\" to key \\"/my-key\\" on namespace DS9."`
378
+ );
379
+ expect(std.err).toMatchInlineSnapshot(`""`);
380
+ });
381
+
382
+ it("should put a key in a given namespace specified by binding", async () => {
383
+ writeWranglerConfig();
384
+ const requests = mockKeyPutRequest("bound-id", {
385
+ key: "my-key",
386
+ value: "my-value",
387
+ });
388
+ await runWrangler(
389
+ "kv:key put my-key my-value --binding someBinding --preview false"
390
+ );
391
+
392
+ expect(std.out).toMatchInlineSnapshot(
393
+ `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace bound-id."`
394
+ );
395
+ expect(std.err).toMatchInlineSnapshot(`""`);
396
+ expect(requests.count).toEqual(1);
397
+ });
398
+
399
+ it("should put a key in a given preview namespace specified by binding", async () => {
400
+ writeWranglerConfig();
401
+ const requests = mockKeyPutRequest("preview-bound-id", {
402
+ key: "my-key",
403
+ value: "my-value",
404
+ });
405
+
406
+ await runWrangler(
407
+ "kv:key put my-key my-value --binding someBinding --preview"
408
+ );
409
+
410
+ expect(std.out).toMatchInlineSnapshot(
411
+ `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace preview-bound-id."`
412
+ );
413
+ expect(std.err).toMatchInlineSnapshot(`""`);
414
+ expect(requests.count).toEqual(1);
415
+ });
416
+
417
+ it("should add expiration and ttl properties when putting a key", async () => {
418
+ const requests = mockKeyPutRequest("some-namespace-id", {
419
+ key: "my-key",
420
+ value: "my-value",
421
+ expiration: 10,
422
+ expiration_ttl: 20,
423
+ });
424
+ await runWrangler(
425
+ "kv:key put my-key my-value --namespace-id some-namespace-id --expiration 10 --ttl 20"
426
+ );
427
+ expect(requests.count).toEqual(1);
428
+ expect(std.out).toMatchInlineSnapshot(
429
+ `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace some-namespace-id."`
430
+ );
431
+ expect(std.err).toMatchInlineSnapshot(`""`);
432
+ });
433
+
434
+ it("should put a key to the specified environment in a given namespace", async () => {
435
+ writeWranglerConfig();
436
+ const requests = mockKeyPutRequest("env-bound-id", {
437
+ key: "my-key",
438
+ value: "my-value",
439
+ });
440
+ await runWrangler(
441
+ "kv:key put my-key my-value --binding someBinding --env some-environment --preview false"
442
+ );
443
+ expect(std.out).toMatchInlineSnapshot(
444
+ `"Writing the value \\"my-value\\" to key \\"my-key\\" on namespace env-bound-id."`
445
+ );
446
+ expect(std.err).toMatchInlineSnapshot(`""`);
447
+ expect(requests.count).toEqual(1);
448
+ });
449
+
450
+ it("should put a key with a value loaded from a given path", async () => {
451
+ writeFileSync("foo.txt", "file-contents", "utf-8");
452
+ const requests = mockKeyPutRequest("some-namespace-id", {
453
+ key: "my-key",
454
+ value: "file-contents",
455
+ });
456
+ await runWrangler(
457
+ "kv:key put my-key --namespace-id some-namespace-id --path foo.txt"
458
+ );
459
+ expect(std.out).toMatchInlineSnapshot(
460
+ `"Writing the contents of foo.txt to the key \\"my-key\\" on namespace some-namespace-id."`
461
+ );
462
+ expect(std.err).toMatchInlineSnapshot(`""`);
463
+ expect(requests.count).toEqual(1);
464
+ });
465
+
466
+ it("should error if no key is provided", async () => {
467
+ await expect(
468
+ runWrangler("kv:key put")
469
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
470
+ `"Not enough non-option arguments: got 0, need at least 1"`
471
+ );
472
+
473
+ expect(std.out).toMatchInlineSnapshot(`
474
+ "
475
+ wrangler kv:key put <key> [value]
476
+
477
+ Writes a single key/value pair to the given namespace.
478
+
479
+ Positionals:
480
+ key The key to write to [string] [required]
481
+ value The value to write [string]
482
+
483
+ Flags:
484
+ -c, --config Path to .toml configuration file [string]
485
+ -h, --help Show help [boolean]
486
+ -v, --version Show version number [boolean]
487
+
488
+ Options:
489
+ --binding The binding of the namespace to write to [string]
490
+ --namespace-id The id of the namespace to write to [string]
491
+ -e, --env Perform on a specific environment [string]
492
+ --preview Interact with a preview namespace [boolean]
493
+ --ttl Time for which the entries should be visible [number]
494
+ --expiration Time since the UNIX epoch after which the entry expires [number]
495
+ --path Read value from the file at a given path [string]"
496
+ `);
497
+ expect(std.err).toMatchInlineSnapshot(`
498
+ "X [ERROR] Not enough non-option arguments: got 0, need at least 1
499
+
500
+ "
501
+ `);
502
+ });
503
+
504
+ it("should error if no binding nor namespace is provided", async () => {
505
+ await expect(
506
+ runWrangler("kv:key put foo bar")
507
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
508
+ `"Exactly one of the arguments binding and namespace-id is required"`
509
+ );
510
+
511
+ expect(std.out).toMatchInlineSnapshot(`
512
+ "
513
+ wrangler kv:key put <key> [value]
514
+
515
+ Writes a single key/value pair to the given namespace.
516
+
517
+ Positionals:
518
+ key The key to write to [string] [required]
519
+ value The value to write [string]
520
+
521
+ Flags:
522
+ -c, --config Path to .toml configuration file [string]
523
+ -h, --help Show help [boolean]
524
+ -v, --version Show version number [boolean]
525
+
526
+ Options:
527
+ --binding The binding of the namespace to write to [string]
528
+ --namespace-id The id of the namespace to write to [string]
529
+ -e, --env Perform on a specific environment [string]
530
+ --preview Interact with a preview namespace [boolean]
531
+ --ttl Time for which the entries should be visible [number]
532
+ --expiration Time since the UNIX epoch after which the entry expires [number]
533
+ --path Read value from the file at a given path [string]"
534
+ `);
535
+ expect(std.err).toMatchInlineSnapshot(`
536
+ "X [ERROR] Exactly one of the arguments binding and namespace-id is required
537
+
538
+ "
539
+ `);
540
+ });
541
+
542
+ it("should error if both binding and namespace is provided", async () => {
543
+ await expect(
544
+ runWrangler("kv:key put foo bar --binding x --namespace-id y")
545
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
546
+ `"Arguments binding and namespace-id are mutually exclusive"`
547
+ );
548
+
549
+ expect(std.out).toMatchInlineSnapshot(`
550
+ "
551
+ wrangler kv:key put <key> [value]
552
+
553
+ Writes a single key/value pair to the given namespace.
554
+
555
+ Positionals:
556
+ key The key to write to [string] [required]
557
+ value The value to write [string]
558
+
559
+ Flags:
560
+ -c, --config Path to .toml configuration file [string]
561
+ -h, --help Show help [boolean]
562
+ -v, --version Show version number [boolean]
563
+
564
+ Options:
565
+ --binding The binding of the namespace to write to [string]
566
+ --namespace-id The id of the namespace to write to [string]
567
+ -e, --env Perform on a specific environment [string]
568
+ --preview Interact with a preview namespace [boolean]
569
+ --ttl Time for which the entries should be visible [number]
570
+ --expiration Time since the UNIX epoch after which the entry expires [number]
571
+ --path Read value from the file at a given path [string]"
572
+ `);
573
+ expect(std.err).toMatchInlineSnapshot(`
574
+ "X [ERROR] Arguments binding and namespace-id are mutually exclusive
575
+
576
+ "
577
+ `);
578
+ });
579
+
580
+ it("should error if no value nor path is provided", async () => {
581
+ await expect(
582
+ runWrangler("kv:key put key --namespace-id 12345")
583
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
584
+ `"Exactly one of the arguments value and path is required"`
585
+ );
586
+
587
+ expect(std.out).toMatchInlineSnapshot(`
588
+ "
589
+ wrangler kv:key put <key> [value]
590
+
591
+ Writes a single key/value pair to the given namespace.
592
+
593
+ Positionals:
594
+ key The key to write to [string] [required]
595
+ value The value to write [string]
596
+
597
+ Flags:
598
+ -c, --config Path to .toml configuration file [string]
599
+ -h, --help Show help [boolean]
600
+ -v, --version Show version number [boolean]
601
+
602
+ Options:
603
+ --binding The binding of the namespace to write to [string]
604
+ --namespace-id The id of the namespace to write to [string]
605
+ -e, --env Perform on a specific environment [string]
606
+ --preview Interact with a preview namespace [boolean]
607
+ --ttl Time for which the entries should be visible [number]
608
+ --expiration Time since the UNIX epoch after which the entry expires [number]
609
+ --path Read value from the file at a given path [string]"
610
+ `);
611
+ expect(std.err).toMatchInlineSnapshot(`
612
+ "X [ERROR] Exactly one of the arguments value and path is required
613
+
614
+ "
615
+ `);
616
+ });
617
+
618
+ it("should error if both value and path is provided", async () => {
619
+ await expect(
620
+ runWrangler("kv:key put key value --path xyz --namespace-id 12345")
621
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
622
+ `"Arguments value and path are mutually exclusive"`
623
+ );
624
+
625
+ expect(std.out).toMatchInlineSnapshot(`
626
+ "
627
+ wrangler kv:key put <key> [value]
628
+
629
+ Writes a single key/value pair to the given namespace.
630
+
631
+ Positionals:
632
+ key The key to write to [string] [required]
633
+ value The value to write [string]
634
+
635
+ Flags:
636
+ -c, --config Path to .toml configuration file [string]
637
+ -h, --help Show help [boolean]
638
+ -v, --version Show version number [boolean]
639
+
640
+ Options:
641
+ --binding The binding of the namespace to write to [string]
642
+ --namespace-id The id of the namespace to write to [string]
643
+ -e, --env Perform on a specific environment [string]
644
+ --preview Interact with a preview namespace [boolean]
645
+ --ttl Time for which the entries should be visible [number]
646
+ --expiration Time since the UNIX epoch after which the entry expires [number]
647
+ --path Read value from the file at a given path [string]"
648
+ `);
649
+ expect(std.err).toMatchInlineSnapshot(`
650
+ "X [ERROR] Arguments value and path are mutually exclusive
651
+
652
+ "
653
+ `);
654
+ });
655
+
656
+ it("should error if a given binding name is not in the configured kv namespaces", async () => {
657
+ writeWranglerConfig();
658
+ await expect(
659
+ runWrangler("kv:key put key value --binding otherBinding")
660
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
661
+ `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
662
+ );
663
+
664
+ expect(std.out).toMatchInlineSnapshot(`
665
+ "
666
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
667
+ `);
668
+ expect(std.err).toMatchInlineSnapshot(`
669
+ "X [ERROR] A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
670
+
671
+ "
672
+ `);
673
+ });
674
+
675
+ it("should error if a given binding has both preview and non-preview and --preview is not specified", async () => {
676
+ writeWranglerConfig();
677
+ const requests = mockKeyPutRequest("preview-bound-id", {
678
+ key: "my-key",
679
+ value: "my-value",
680
+ });
681
+ await expect(
682
+ runWrangler("kv:key put my-key my-value --binding someBinding")
683
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
684
+ `"someBinding has both a namespace ID and a preview ID. Specify \\"--preview\\" or \\"--preview false\\" to avoid writing data to the wrong namespace."`
685
+ );
686
+ expect(std.out).toMatchInlineSnapshot(`
687
+ "
688
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
689
+ `);
690
+ expect(std.err).toMatchInlineSnapshot(`
691
+ "X [ERROR] someBinding has both a namespace ID and a preview ID. Specify \\"--preview\\" or \\"--preview false\\" to avoid writing data to the wrong namespace.
692
+
693
+ "
694
+ `);
695
+ expect(requests.count).toEqual(0);
696
+ });
697
+ });
698
+
699
+ describe("list", () => {
700
+ it("should list the keys of a namespace specified by namespace-id", async () => {
701
+ const keys = [
702
+ { name: "key-1" },
703
+ { name: "key-2", expiration: 123456789 },
704
+ { name: "key-3", expiration_ttl: 666 },
705
+ ];
706
+ mockKeyListRequest("some-namespace-id", keys);
707
+ await runWrangler("kv:key list --namespace-id some-namespace-id");
708
+ expect(std.err).toMatchInlineSnapshot(`""`);
709
+ expect(std.out).toMatchInlineSnapshot(`
710
+ "[
711
+ {
712
+ \\"name\\": \\"key-1\\"
713
+ },
714
+ {
715
+ \\"name\\": \\"key-2\\",
716
+ \\"expiration\\": 123456789
717
+ },
718
+ {
719
+ \\"name\\": \\"key-3\\",
720
+ \\"expiration_ttl\\": 666
721
+ }
722
+ ]"
723
+ `);
724
+ });
725
+
726
+ it("should list the keys of a namespace specified by binding", async () => {
727
+ writeWranglerConfig();
728
+ const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
729
+ mockKeyListRequest("bound-id", keys);
730
+
731
+ await runWrangler("kv:key list --binding someBinding");
732
+ expect(std.err).toMatchInlineSnapshot(`""`);
733
+ expect(std.out).toMatchInlineSnapshot(`
734
+ "[
735
+ {
736
+ \\"name\\": \\"key-1\\"
737
+ },
738
+ {
739
+ \\"name\\": \\"key-2\\"
740
+ },
741
+ {
742
+ \\"name\\": \\"key-3\\"
743
+ }
744
+ ]"
745
+ `);
746
+ });
747
+
748
+ it("should list the keys of a preview namespace specified by binding", async () => {
749
+ writeWranglerConfig();
750
+ const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
751
+ mockKeyListRequest("preview-bound-id", keys);
752
+ await runWrangler("kv:key list --binding someBinding --preview");
753
+ expect(std.err).toMatchInlineSnapshot(`""`);
754
+ expect(std.out).toMatchInlineSnapshot(`
755
+ "[
756
+ {
757
+ \\"name\\": \\"key-1\\"
758
+ },
759
+ {
760
+ \\"name\\": \\"key-2\\"
761
+ },
762
+ {
763
+ \\"name\\": \\"key-3\\"
764
+ }
765
+ ]"
766
+ `);
767
+ });
768
+
769
+ it("should list the keys of a namespace specified by binding, in a given environment", async () => {
770
+ writeWranglerConfig();
771
+ const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
772
+ mockKeyListRequest("env-bound-id", keys);
773
+ await runWrangler(
774
+ "kv:key list --binding someBinding --env some-environment"
775
+ );
776
+ expect(std.err).toMatchInlineSnapshot(`""`);
777
+ expect(std.out).toMatchInlineSnapshot(`
778
+ "[
779
+ {
780
+ \\"name\\": \\"key-1\\"
781
+ },
782
+ {
783
+ \\"name\\": \\"key-2\\"
784
+ },
785
+ {
786
+ \\"name\\": \\"key-3\\"
787
+ }
788
+ ]"
789
+ `);
790
+ });
791
+
792
+ it("should list the keys of a preview namespace specified by binding, in a given environment", async () => {
793
+ writeWranglerConfig();
794
+ const keys = [{ name: "key-1" }, { name: "key-2" }, { name: "key-3" }];
795
+ mockKeyListRequest("preview-env-bound-id", keys);
796
+ await runWrangler(
797
+ "kv:key list --binding someBinding --preview --env some-environment"
798
+ );
799
+ expect(std.err).toMatchInlineSnapshot(`""`);
800
+ expect(std.out).toMatchInlineSnapshot(`
801
+ "[
802
+ {
803
+ \\"name\\": \\"key-1\\"
804
+ },
805
+ {
806
+ \\"name\\": \\"key-2\\"
807
+ },
808
+ {
809
+ \\"name\\": \\"key-3\\"
810
+ }
811
+ ]"
812
+ `);
813
+ });
814
+
815
+ // We'll run the next test with variations on the cursor
816
+ // that's returned on cloudflare's API after all results
817
+ // have been drained.
818
+ for (const blankCursorValue of [undefined, null, ""] as [
819
+ undefined,
820
+ null,
821
+ ""
822
+ ]) {
823
+ describe(`cursor - ${blankCursorValue}`, () => {
824
+ it("should make multiple requests for paginated results", async () => {
825
+ // Create a lot of mock keys, so that the fetch requests will be paginated
826
+ const keys: NamespaceKeyInfo[] = [];
827
+ for (let i = 0; i < 550; i++) {
828
+ keys.push({ name: "key-" + i });
829
+ }
830
+ // Ask for the keys in pages of size 100.
831
+ const requests = mockKeyListRequest(
832
+ "some-namespace-id",
833
+ keys,
834
+ 100,
835
+ blankCursorValue
836
+ );
837
+ await runWrangler("kv:key list --namespace-id some-namespace-id");
838
+ expect(std.err).toMatchInlineSnapshot(`""`);
839
+ expect(JSON.parse(std.out)).toEqual(keys);
840
+ expect(requests.count).toEqual(6);
841
+ });
842
+ });
843
+ }
844
+
845
+ it("should error if a given binding name is not in the configured kv namespaces", async () => {
846
+ writeWranglerConfig();
847
+ await expect(
848
+ runWrangler("kv:key list --binding otherBinding")
849
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
850
+ `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
851
+ );
852
+ expect(std.err).toMatchInlineSnapshot(`
853
+ "X [ERROR] A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
854
+
855
+ "
856
+ `);
857
+ expect(std.out).toMatchInlineSnapshot(`
858
+ "
859
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
860
+ `);
861
+ });
862
+ });
863
+
864
+ describe("get", () => {
865
+ afterEach(() => {
866
+ unsetMockFetchKVGetValues();
867
+ });
868
+
869
+ it("should get a key in a given namespace specified by namespace-id", async () => {
870
+ setMockFetchKVGetValue(
871
+ "some-account-id",
872
+ "some-namespace-id",
873
+ "my-key",
874
+ "my-value"
875
+ );
876
+ await runWrangler("kv:key get my-key --namespace-id some-namespace-id");
877
+ expect(std.out).toMatchInlineSnapshot(`"my-value"`);
878
+ expect(std.err).toMatchInlineSnapshot(`""`);
879
+ });
880
+
881
+ it("should get a key in a given namespace specified by binding", async () => {
882
+ writeWranglerConfig();
883
+ setMockFetchKVGetValue(
884
+ "some-account-id",
885
+ "bound-id",
886
+ "my-key",
887
+ "my-value"
888
+ );
889
+ await runWrangler(
890
+ "kv:key get my-key --binding someBinding --preview false"
891
+ );
892
+ expect(std.out).toMatchInlineSnapshot(`"my-value"`);
893
+ expect(std.err).toMatchInlineSnapshot(`""`);
894
+ });
895
+
896
+ it("should get a key in a given preview namespace specified by binding", async () => {
897
+ writeWranglerConfig();
898
+ setMockFetchKVGetValue(
899
+ "some-account-id",
900
+ "preview-bound-id",
901
+ "my-key",
902
+ "my-value"
903
+ );
904
+ await runWrangler("kv:key get my-key --binding someBinding --preview");
905
+ expect(std.out).toMatchInlineSnapshot(`"my-value"`);
906
+ expect(std.err).toMatchInlineSnapshot(`""`);
907
+ });
908
+
909
+ it("should get a key for the specified environment in a given namespace", async () => {
910
+ writeWranglerConfig();
911
+ setMockFetchKVGetValue(
912
+ "some-account-id",
913
+ "env-bound-id",
914
+ "my-key",
915
+ "my-value"
916
+ );
917
+ await runWrangler(
918
+ "kv:key get my-key --binding someBinding --env some-environment --preview false"
919
+ );
920
+ expect(std.out).toMatchInlineSnapshot(`"my-value"`);
921
+ expect(std.err).toMatchInlineSnapshot(`""`);
922
+ });
923
+
924
+ it("should encode the key in the api request to get a value", async () => {
925
+ setMockFetchKVGetValue(
926
+ "some-account-id",
927
+ "some-namespace-id",
928
+ "%2Fmy%2Ckey",
929
+ "my-value"
930
+ );
931
+ await runWrangler(
932
+ "kv:key get /my,key --namespace-id some-namespace-id"
933
+ );
934
+ expect(std.out).toMatchInlineSnapshot(`"my-value"`);
935
+ expect(std.err).toMatchInlineSnapshot(`""`);
936
+ });
937
+
938
+ it("should error if no key is provided", async () => {
939
+ await expect(
940
+ runWrangler("kv:key get")
941
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
942
+ `"Not enough non-option arguments: got 0, need at least 1"`
943
+ );
944
+ expect(std.out).toMatchInlineSnapshot(`
945
+ "
946
+ wrangler kv:key get <key>
947
+
948
+ Reads a single value by key from the given namespace.
949
+
950
+ Positionals:
951
+ key The key value to get. [string] [required]
952
+
953
+ Flags:
954
+ -c, --config Path to .toml configuration file [string]
955
+ -h, --help Show help [boolean]
956
+ -v, --version Show version number [boolean]
957
+
958
+ Options:
959
+ --binding The name of the namespace to get from [string]
960
+ --namespace-id The id of the namespace to get from [string]
961
+ -e, --env Perform on a specific environment [string]
962
+ --preview Interact with a preview namespace [boolean] [default: false]"
963
+ `);
964
+ expect(std.err).toMatchInlineSnapshot(`
965
+ "X [ERROR] Not enough non-option arguments: got 0, need at least 1
966
+
967
+ "
968
+ `);
969
+ });
970
+
971
+ it("should error if no binding nor namespace is provided", async () => {
972
+ await expect(
973
+ runWrangler("kv:key get foo")
974
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
975
+ `"Exactly one of the arguments binding and namespace-id is required"`
976
+ );
977
+ expect(std.out).toMatchInlineSnapshot(`
978
+ "
979
+ wrangler kv:key get <key>
980
+
981
+ Reads a single value by key from the given namespace.
982
+
983
+ Positionals:
984
+ key The key value to get. [string] [required]
985
+
986
+ Flags:
987
+ -c, --config Path to .toml configuration file [string]
988
+ -h, --help Show help [boolean]
989
+ -v, --version Show version number [boolean]
990
+
991
+ Options:
992
+ --binding The name of the namespace to get from [string]
993
+ --namespace-id The id of the namespace to get from [string]
994
+ -e, --env Perform on a specific environment [string]
995
+ --preview Interact with a preview namespace [boolean] [default: false]"
996
+ `);
997
+ expect(std.err).toMatchInlineSnapshot(`
998
+ "X [ERROR] Exactly one of the arguments binding and namespace-id is required
999
+
1000
+ "
1001
+ `);
1002
+ });
1003
+
1004
+ it("should error if both binding and namespace is provided", async () => {
1005
+ await expect(
1006
+ runWrangler("kv:key get foo --binding x --namespace-id y")
1007
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
1008
+ `"Arguments binding and namespace-id are mutually exclusive"`
1009
+ );
1010
+
1011
+ expect(std.out).toMatchInlineSnapshot(`
1012
+ "
1013
+ wrangler kv:key get <key>
1014
+
1015
+ Reads a single value by key from the given namespace.
1016
+
1017
+ Positionals:
1018
+ key The key value to get. [string] [required]
1019
+
1020
+ Flags:
1021
+ -c, --config Path to .toml configuration file [string]
1022
+ -h, --help Show help [boolean]
1023
+ -v, --version Show version number [boolean]
1024
+
1025
+ Options:
1026
+ --binding The name of the namespace to get from [string]
1027
+ --namespace-id The id of the namespace to get from [string]
1028
+ -e, --env Perform on a specific environment [string]
1029
+ --preview Interact with a preview namespace [boolean] [default: false]"
1030
+ `);
1031
+ expect(std.err).toMatchInlineSnapshot(`
1032
+ "X [ERROR] Arguments binding and namespace-id are mutually exclusive
1033
+
1034
+ "
1035
+ `);
1036
+ });
1037
+
1038
+ it("should error if a given binding name is not in the configured kv namespaces", async () => {
1039
+ writeWranglerConfig();
1040
+ await expect(
1041
+ runWrangler("kv:key get key --binding otherBinding")
1042
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
1043
+ `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
1044
+ );
1045
+ expect(std.out).toMatchInlineSnapshot(`
1046
+ "
1047
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
1048
+ `);
1049
+ expect(std.err).toMatchInlineSnapshot(`
1050
+ "X [ERROR] A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
1051
+
1052
+ "
1053
+ `);
1054
+ });
1055
+ });
1056
+
1057
+ describe("delete", () => {
1058
+ function mockDeleteRequest(
1059
+ expectedNamespaceId: string,
1060
+ expectedKey: string
1061
+ ) {
1062
+ const requests = { count: 0 };
1063
+ setMockResponse(
1064
+ "/accounts/:accountId/storage/kv/namespaces/:namespaceId/values/:key",
1065
+ "DELETE",
1066
+ ([_url, accountId, namespaceId, key]) => {
1067
+ requests.count++;
1068
+ expect(accountId).toEqual("some-account-id");
1069
+ expect(namespaceId).toEqual(expectedNamespaceId);
1070
+ expect(key).toEqual(expectedKey);
1071
+ return null;
1072
+ }
1073
+ );
1074
+ return requests;
1075
+ }
1076
+
1077
+ it("should delete a key in a namespace specified by id", async () => {
1078
+ const requests = mockDeleteRequest("some-namespace-id", "someKey");
1079
+ await runWrangler(
1080
+ `kv:key delete --namespace-id some-namespace-id someKey`
1081
+ );
1082
+ expect(requests.count).toEqual(1);
1083
+ });
1084
+
1085
+ it("should encode the key in the api request to delete a value", async () => {
1086
+ const requests = mockDeleteRequest("voyager", "%2FNCC-74656");
1087
+ await runWrangler(`kv:key delete --namespace-id voyager /NCC-74656`);
1088
+ expect(requests.count).toEqual(1);
1089
+ expect(std.out).toMatchInlineSnapshot(
1090
+ `"Deleting the key \\"/NCC-74656\\" on namespace voyager."`
1091
+ );
1092
+ expect(std.err).toMatchInlineSnapshot(`""`);
1093
+ });
1094
+
1095
+ it("should delete a key in a namespace specified by binding name", async () => {
1096
+ writeWranglerConfig();
1097
+ const requests = mockDeleteRequest("bound-id", "someKey");
1098
+ await runWrangler(
1099
+ `kv:key delete --binding someBinding --preview false someKey`
1100
+ );
1101
+ expect(requests.count).toEqual(1);
1102
+ });
1103
+
1104
+ it("should delete a key in a preview namespace specified by binding name", async () => {
1105
+ writeWranglerConfig();
1106
+ const requests = mockDeleteRequest("preview-bound-id", "someKey");
1107
+ await runWrangler(
1108
+ `kv:key delete --binding someBinding --preview someKey`
1109
+ );
1110
+ expect(requests.count).toEqual(1);
1111
+ });
1112
+
1113
+ it("should error if a given binding name is not in the configured kv namespaces", async () => {
1114
+ writeWranglerConfig();
1115
+ await expect(
1116
+ runWrangler(`kv:key delete --binding otherBinding someKey`)
1117
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
1118
+ `"A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\"."`
1119
+ );
1120
+
1121
+ expect(std.err).toMatchInlineSnapshot(`
1122
+ "X [ERROR] A namespace with binding name \\"otherBinding\\" was not found in the configured \\"kv_namespaces\\".
1123
+
1124
+ "
1125
+ `);
1126
+ });
1127
+
1128
+ it("should delete a key in a namespace specified by binding name in a given environment", async () => {
1129
+ writeWranglerConfig();
1130
+ const requests = mockDeleteRequest("env-bound-id", "someKey");
1131
+ await runWrangler(
1132
+ `kv:key delete --binding someBinding --env some-environment --preview false someKey`
1133
+ );
1134
+ expect(std.out).toMatchInlineSnapshot(
1135
+ `"Deleting the key \\"someKey\\" on namespace env-bound-id."`
1136
+ );
1137
+ expect(std.err).toMatchInlineSnapshot(`""`);
1138
+ expect(requests.count).toEqual(1);
1139
+ });
1140
+
1141
+ it("should delete a key in a preview namespace specified by binding name in a given environment", async () => {
1142
+ writeWranglerConfig();
1143
+ const requests = mockDeleteRequest("preview-env-bound-id", "someKey");
1144
+ await runWrangler(
1145
+ `kv:key delete --binding someBinding --env some-environment --preview someKey`
1146
+ );
1147
+ expect(requests.count).toEqual(1);
1148
+ });
1149
+ });
1150
+ });
1151
+
1152
+ describe("kv:bulk", () => {
1153
+ describe("put", () => {
1154
+ function mockPutRequest(
1155
+ expectedNamespaceId: string,
1156
+ expectedKeyValues: KeyValue[]
1157
+ ) {
1158
+ const requests = { count: 0 };
1159
+ setMockResponse(
1160
+ "/accounts/:accountId/storage/kv/namespaces/:namespaceId/bulk",
1161
+ "PUT",
1162
+ ([_url, accountId, namespaceId], { body }) => {
1163
+ requests.count++;
1164
+ expect(accountId).toEqual("some-account-id");
1165
+ expect(namespaceId).toEqual(expectedNamespaceId);
1166
+ expect(JSON.parse(body as string)).toEqual(
1167
+ expectedKeyValues.slice(
1168
+ (requests.count - 1) * 5000,
1169
+ requests.count * 5000
1170
+ )
1171
+ );
1172
+ return null;
1173
+ }
1174
+ );
1175
+ return requests;
1176
+ }
1177
+
1178
+ it("should put the key-values parsed from a file", async () => {
1179
+ const keyValues: KeyValue[] = [
1180
+ { key: "someKey1", value: "someValue1" },
1181
+ { key: "ns:someKey2", value: "123", base64: true },
1182
+ { key: "someKey3", value: "someValue3", expiration: 100 },
1183
+ { key: "someKey4", value: "someValue4", expiration_ttl: 500 },
1184
+ ];
1185
+ writeFileSync("./keys.json", JSON.stringify(keyValues));
1186
+ const requests = mockPutRequest("some-namespace-id", keyValues);
1187
+ await runWrangler(
1188
+ `kv:bulk put --namespace-id some-namespace-id keys.json`
1189
+ );
1190
+ expect(requests.count).toEqual(1);
1191
+ expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1192
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1193
+ expect(std.err).toMatchInlineSnapshot(`""`);
1194
+ });
1195
+
1196
+ it("should put the key-values in batches of 5000 parsed from a file", async () => {
1197
+ const keyValues: KeyValue[] = new Array(12000).fill({
1198
+ key: "someKey1",
1199
+ value: "someValue1",
1200
+ });
1201
+ writeFileSync("./keys.json", JSON.stringify(keyValues));
1202
+ const requests = mockPutRequest("some-namespace-id", keyValues);
1203
+ await runWrangler(
1204
+ `kv:bulk put --namespace-id some-namespace-id keys.json`
1205
+ );
1206
+ expect(requests.count).toEqual(3);
1207
+ expect(std.out).toMatchInlineSnapshot(`
1208
+ "Uploaded 0% (0 out of 12,000)
1209
+ Uploaded 41% (5,000 out of 12,000)
1210
+ Uploaded 83% (10,000 out of 12,000)
1211
+ Uploaded 100% (12,000 out of 12,000)
1212
+ Success!"
1213
+ `);
1214
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1215
+ expect(std.err).toMatchInlineSnapshot(`""`);
1216
+ });
1217
+
1218
+ it("should error if the file is not a JSON array", async () => {
1219
+ const keyValues = { key: "someKey1", value: "someValue1" };
1220
+ writeFileSync("./keys.json", JSON.stringify(keyValues));
1221
+ await expect(
1222
+ runWrangler(`kv:bulk put --namespace-id some-namespace-id keys.json`)
1223
+ ).rejects.toThrowErrorMatchingInlineSnapshot(`
1224
+ "Unexpected JSON input from \\"keys.json\\".
1225
+ Expected an array of key-value objects but got type \\"object\\"."
1226
+ `);
1227
+ expect(std.out).toMatchInlineSnapshot(`
1228
+ "
1229
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
1230
+ `);
1231
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1232
+ });
1233
+
1234
+ it("should error if the array contains items that are not key-value objects", async () => {
1235
+ const keyValues = [
1236
+ 123,
1237
+ "a string",
1238
+ { key: "someKey" },
1239
+ { value: "someValue" },
1240
+ // add a valid object here to make sure it's not included
1241
+ { key: "someKey1", value: "someValue1" },
1242
+ // this one will only add a warning
1243
+ { key: "someKey1", value: "someValue1", invalid: true },
1244
+ // back to the invalid ones
1245
+ { key: 123, value: "somevalue" },
1246
+ { key: "somekey", value: 123 },
1247
+ { key: "someKey1", value: "someValue1", expiration: "string" },
1248
+ { key: "someKey1", value: "someValue1", expiration_ttl: "string" },
1249
+ {
1250
+ key: 123,
1251
+ value: {
1252
+ a: {
1253
+ nested: "object",
1254
+ },
1255
+ },
1256
+ },
1257
+ { key: "someKey1", value: "someValue1", metadata: 123 },
1258
+ { key: "someKey1", value: "someValue1", base64: "string" },
1259
+ ];
1260
+ writeFileSync("./keys.json", JSON.stringify(keyValues));
1261
+ await expect(
1262
+ runWrangler(`kv:bulk put --namespace-id some-namespace-id keys.json`)
1263
+ ).rejects.toThrowErrorMatchingInlineSnapshot(`
1264
+ "Unexpected JSON input from \\"keys.json\\".
1265
+ Each item in the array should be an object that matches:
1266
+
1267
+ interface KeyValue {
1268
+ key: string;
1269
+ value: string;
1270
+ expiration?: number;
1271
+ expiration_ttl?: number;
1272
+ metadata?: object;
1273
+ base64?: boolean;
1274
+ }
1275
+
1276
+ The item at index 0 is 123
1277
+ The item at index 1 is \\"a string\\"
1278
+ The item at index 2 is {\\"key\\":\\"someKey\\"}
1279
+ The item at index 3 is {\\"value\\":\\"someValue\\"}
1280
+ The item at index 6 is {\\"key\\":123,\\"value\\":\\"somevalue\\"}
1281
+ The item at index 7 is {\\"key\\":\\"somekey\\",\\"value\\":123}
1282
+ The item at index 8 is {\\"key\\":\\"someKey1\\",\\"value\\":\\"someValue1\\",\\"expiration\\":\\"string\\"}
1283
+ The item at index 9 is {\\"key\\":\\"someKey1\\",\\"value\\":\\"someValue1\\",\\"expiration_ttl\\":\\"string\\"}
1284
+ The item at index 10 is {\\"key\\":123,\\"value\\":{\\"a\\":{\\"nested\\":\\"object\\"}}}
1285
+ The item at index 11 is {\\"key\\":\\"someKey1\\",\\"value\\":\\"someValue1\\",\\"metadata\\":123}
1286
+ The item at index 12 is {\\"key\\":\\"someKey1\\",\\"value\\":\\"someValue1\\",\\"base64\\":\\"string\\"}"
1287
+ `);
1288
+
1289
+ expect(std.out).toMatchInlineSnapshot(`
1290
+ "
1291
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
1292
+ `);
1293
+ expect(std.warn).toMatchInlineSnapshot(`
1294
+ "▲ [WARNING] Unexpected key-value properties in \\"keys.json\\".
1295
+
1296
+ The item at index 5 contains unexpected properties: [\\"invalid\\"].
1297
+
1298
+ "
1299
+ `);
1300
+ });
1301
+ });
1302
+
1303
+ describe("delete", () => {
1304
+ function mockDeleteRequest(
1305
+ expectedNamespaceId: string,
1306
+ expectedKeys: string[]
1307
+ ) {
1308
+ const requests = { count: 0 };
1309
+ setMockResponse(
1310
+ "/accounts/:accountId/storage/kv/namespaces/:namespaceId/bulk",
1311
+ "DELETE",
1312
+ ([_url, accountId, namespaceId], { headers, body }) => {
1313
+ requests.count++;
1314
+ expect(accountId).toEqual("some-account-id");
1315
+ expect(namespaceId).toEqual(expectedNamespaceId);
1316
+ expect(new Headers(headers ?? []).get("Content-Type")).toEqual(
1317
+ "application/json"
1318
+ );
1319
+ expect(JSON.parse(body as string)).toEqual(
1320
+ expectedKeys.slice(
1321
+ (requests.count - 1) * 5000,
1322
+ requests.count * 5000
1323
+ )
1324
+ );
1325
+ return null;
1326
+ }
1327
+ );
1328
+ return requests;
1329
+ }
1330
+
1331
+ it("should delete the keys parsed from a file", async () => {
1332
+ const keys = ["someKey1", "ns:someKey2"];
1333
+ writeFileSync("./keys.json", JSON.stringify(keys));
1334
+ mockConfirm({
1335
+ text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1336
+ result: true,
1337
+ });
1338
+ const requests = mockDeleteRequest("some-namespace-id", keys);
1339
+ await runWrangler(
1340
+ `kv:bulk delete --namespace-id some-namespace-id keys.json`
1341
+ );
1342
+ expect(requests.count).toEqual(1);
1343
+ expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1344
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1345
+ expect(std.err).toMatchInlineSnapshot(`""`);
1346
+ });
1347
+
1348
+ it("should delete the keys in batches of 5000 parsed from a file", async () => {
1349
+ const keys = new Array(12000).fill("some-key");
1350
+ writeFileSync("./keys.json", JSON.stringify(keys));
1351
+ mockConfirm({
1352
+ text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1353
+ result: true,
1354
+ });
1355
+ const requests = mockDeleteRequest("some-namespace-id", keys);
1356
+ await runWrangler(
1357
+ `kv:bulk delete --namespace-id some-namespace-id keys.json`
1358
+ );
1359
+ expect(requests.count).toEqual(3);
1360
+ expect(std.out).toMatchInlineSnapshot(`
1361
+ "Deleted 0% (0 out of 12,000)
1362
+ Deleted 41% (5,000 out of 12,000)
1363
+ Deleted 83% (10,000 out of 12,000)
1364
+ Deleted 100% (12,000 out of 12,000)
1365
+ Success!"
1366
+ `);
1367
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1368
+ expect(std.err).toMatchInlineSnapshot(`""`);
1369
+ });
1370
+
1371
+ it("should not delete the keys if the user confirms no", async () => {
1372
+ const keys = ["someKey1", "ns:someKey2"];
1373
+ writeFileSync("./keys.json", JSON.stringify(keys));
1374
+ mockConfirm({
1375
+ text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1376
+ result: false,
1377
+ });
1378
+ await runWrangler(
1379
+ `kv:bulk delete --namespace-id some-namespace-id keys.json`
1380
+ );
1381
+ expect(std.out).toMatchInlineSnapshot(
1382
+ `"Not deleting keys read from \\"keys.json\\"."`
1383
+ );
1384
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1385
+ expect(std.err).toMatchInlineSnapshot(`""`);
1386
+ });
1387
+
1388
+ it("should delete the keys without asking if --force is provided", async () => {
1389
+ const keys = ["someKey1", "ns:someKey2"];
1390
+ writeFileSync("./keys.json", JSON.stringify(keys));
1391
+ const requests = mockDeleteRequest("some-namespace-id", keys);
1392
+ await runWrangler(
1393
+ `kv:bulk delete --namespace-id some-namespace-id keys.json --force`
1394
+ );
1395
+ expect(requests.count).toEqual(1);
1396
+ expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1397
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1398
+ expect(std.err).toMatchInlineSnapshot(`""`);
1399
+ });
1400
+
1401
+ it("should delete the keys without asking if -f is provided", async () => {
1402
+ const keys = ["someKey1", "ns:someKey2"];
1403
+ writeFileSync("./keys.json", JSON.stringify(keys));
1404
+ const requests = mockDeleteRequest("some-namespace-id", keys);
1405
+ await runWrangler(
1406
+ `kv:bulk delete --namespace-id some-namespace-id keys.json -f`
1407
+ );
1408
+ expect(requests.count).toEqual(1);
1409
+ expect(std.out).toMatchInlineSnapshot(`"Success!"`);
1410
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1411
+ expect(std.err).toMatchInlineSnapshot(`""`);
1412
+ });
1413
+
1414
+ it("should error if the file is not a JSON array", async () => {
1415
+ const keys = 12354;
1416
+ writeFileSync("./keys.json", JSON.stringify(keys));
1417
+ mockConfirm({
1418
+ text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1419
+ result: true,
1420
+ });
1421
+ await expect(
1422
+ runWrangler(
1423
+ `kv:bulk delete --namespace-id some-namespace-id keys.json`
1424
+ )
1425
+ ).rejects.toThrowErrorMatchingInlineSnapshot(`
1426
+ "Unexpected JSON input from \\"keys.json\\".
1427
+ Expected an array of strings but got:
1428
+ 12354"
1429
+ `);
1430
+ expect(std.out).toMatchInlineSnapshot(`
1431
+ "
1432
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
1433
+ `);
1434
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1435
+ });
1436
+
1437
+ it("should error if the file contains non-string items", async () => {
1438
+ const keys = ["good", 12354, { key: "someKey" }, null];
1439
+ writeFileSync("./keys.json", JSON.stringify(keys));
1440
+ mockConfirm({
1441
+ text: `Are you sure you want to delete all the keys read from "keys.json" from kv-namespace with id "some-namespace-id"?`,
1442
+ result: true,
1443
+ });
1444
+ await expect(
1445
+ runWrangler(
1446
+ `kv:bulk delete --namespace-id some-namespace-id keys.json`
1447
+ )
1448
+ ).rejects.toThrowErrorMatchingInlineSnapshot(`
1449
+ "Unexpected JSON input from \\"keys.json\\".
1450
+ Expected an array of strings.
1451
+ The item at index 1 is type: \\"number\\" - 12354
1452
+ The item at index 2 is type: \\"object\\" - {\\"key\\":\\"someKey\\"}
1453
+ The item at index 3 is type: \\"object\\" - null"
1454
+ `);
1455
+ expect(std.out).toMatchInlineSnapshot(`
1456
+ "
1457
+ If you think this is a bug then please create an issue at https://github.com/cloudflare/wrangler2/issues/new/choose"
1458
+ `);
1459
+ expect(std.warn).toMatchInlineSnapshot(`""`);
1460
+ });
1461
+ });
1462
+ });
1463
+ });
1464
+
1465
+ function writeWranglerConfig() {
1466
+ writeFileSync(
1467
+ "./wrangler.toml",
1468
+ [
1469
+ 'name = "other-worker"',
1470
+ "kv_namespaces = [",
1471
+ ' { binding = "someBinding", id = "bound-id", preview_id = "preview-bound-id" }',
1472
+ "]",
1473
+ "",
1474
+ "[env.some-environment]",
1475
+ "kv_namespaces = [",
1476
+ ' { binding = "someBinding", id = "env-bound-id", preview_id = "preview-env-bound-id" }',
1477
+ "]",
1478
+ ].join("\n"),
1479
+ "utf-8"
1480
+ );
1481
+ }