wrangler 0.0.0-e88a54e → 0.0.0-e8e684c7

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