wrangler 0.0.0-e3e3243 → 0.0.0-e4047cab

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 (310) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +47 -14
  3. package/bin/wrangler.js +166 -31
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +6263 -21
  6. package/package.json +191 -141
  7. package/src/__tests__/access.test.ts +25 -0
  8. package/src/__tests__/api-dev.test.ts +209 -0
  9. package/src/__tests__/api-devregistry.test.js +56 -0
  10. package/src/__tests__/api.test.ts +80 -0
  11. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  12. package/src/__tests__/config-cache.test.ts +42 -0
  13. package/src/__tests__/configuration.test.ts +3971 -2810
  14. package/src/__tests__/d1.test.ts +80 -0
  15. package/src/__tests__/delete.test.ts +263 -0
  16. package/src/__tests__/deployments.test.ts +91 -0
  17. package/src/__tests__/dev.test.tsx +1521 -526
  18. package/src/__tests__/dialogs.test.tsx +40 -0
  19. package/src/__tests__/generate.test.ts +235 -0
  20. package/src/__tests__/get-host-from-url.test.ts +16 -0
  21. package/src/__tests__/guess-worker-format.test.ts +74 -57
  22. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  23. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  24. package/src/__tests__/helpers/mock-bin.ts +20 -20
  25. package/src/__tests__/helpers/mock-cfetch.ts +219 -93
  26. package/src/__tests__/helpers/mock-console.ts +68 -32
  27. package/src/__tests__/helpers/mock-dialogs.ts +121 -33
  28. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  29. package/src/__tests__/helpers/mock-http-server.ts +46 -0
  30. package/src/__tests__/helpers/mock-istty.ts +74 -0
  31. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  32. package/src/__tests__/helpers/mock-kv.ts +27 -27
  33. package/src/__tests__/helpers/mock-oauth-flow.ts +256 -0
  34. package/src/__tests__/helpers/mock-process.ts +39 -0
  35. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  36. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  37. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  38. package/src/__tests__/helpers/msw/handlers/deployments.ts +59 -0
  39. package/src/__tests__/helpers/msw/handlers/namespaces.ts +104 -0
  40. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  41. package/src/__tests__/helpers/msw/handlers/r2.ts +80 -0
  42. package/src/__tests__/helpers/msw/handlers/script.ts +75 -0
  43. package/src/__tests__/helpers/msw/handlers/user.ts +63 -0
  44. package/src/__tests__/helpers/msw/handlers/zones.ts +22 -0
  45. package/src/__tests__/helpers/msw/index.ts +21 -0
  46. package/src/__tests__/helpers/run-in-tmp.ts +28 -22
  47. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  48. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  49. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  50. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  51. package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
  52. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  53. package/src/__tests__/helpers/write-worker-source.ts +31 -0
  54. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  55. package/src/__tests__/https-options.test.ts +144 -108
  56. package/src/__tests__/index.test.ts +248 -967
  57. package/src/__tests__/init.test.ts +2900 -0
  58. package/src/__tests__/jest.setup.ts +167 -34
  59. package/src/__tests__/kv.test.ts +1661 -1366
  60. package/src/__tests__/logger.test.ts +141 -0
  61. package/src/__tests__/logout.test.ts +36 -41
  62. package/src/__tests__/metrics.test.ts +450 -0
  63. package/src/__tests__/middleware.scheduled.test.ts +135 -0
  64. package/src/__tests__/middleware.test.ts +726 -0
  65. package/src/__tests__/package-manager.test.ts +312 -165
  66. package/src/__tests__/pages-deployment-tail.test.ts +820 -0
  67. package/src/__tests__/pages.test.ts +2437 -77
  68. package/src/__tests__/parse.test.ts +253 -245
  69. package/src/__tests__/paths.test.ts +39 -0
  70. package/src/__tests__/publish.test.ts +7569 -3445
  71. package/src/__tests__/pubsub.test.ts +370 -0
  72. package/src/__tests__/queues.test.ts +522 -0
  73. package/src/__tests__/r2.test.ts +388 -193
  74. package/src/__tests__/route.test.ts +22 -22
  75. package/src/__tests__/secret.test.ts +626 -407
  76. package/src/__tests__/tail.test.ts +779 -442
  77. package/src/__tests__/test-old-node-version.js +31 -0
  78. package/src/__tests__/type-generation.test.ts +226 -0
  79. package/src/__tests__/user.test.ts +129 -0
  80. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  81. package/src/__tests__/validate-dev-props.test.ts +56 -0
  82. package/src/__tests__/version.test.ts +35 -0
  83. package/src/__tests__/whoami.test.tsx +266 -88
  84. package/src/__tests__/worker-namespace.test.ts +326 -0
  85. package/src/abort.d.ts +3 -0
  86. package/src/api/dev.ts +210 -0
  87. package/src/api/index.ts +2 -0
  88. package/src/bundle-reporter.tsx +68 -0
  89. package/src/bundle.ts +791 -123
  90. package/src/cfetch/index.ts +123 -67
  91. package/src/cfetch/internal.ts +216 -92
  92. package/src/cli.ts +23 -14
  93. package/src/config/README.md +1 -1
  94. package/src/config/config.ts +236 -179
  95. package/src/config/diagnostics.ts +61 -61
  96. package/src/config/environment.ts +506 -316
  97. package/src/config/index.ts +310 -38
  98. package/src/config/validation-helpers.ts +385 -342
  99. package/src/config/validation.ts +1970 -1099
  100. package/src/config-cache.ts +85 -0
  101. package/src/create-worker-preview.ts +240 -124
  102. package/src/create-worker-upload-form.ts +300 -201
  103. package/src/d1/backups.tsx +223 -0
  104. package/src/d1/constants.ts +2 -0
  105. package/src/d1/create.tsx +63 -0
  106. package/src/d1/delete.tsx +56 -0
  107. package/src/d1/execute.tsx +352 -0
  108. package/src/d1/formatTimeAgo.ts +14 -0
  109. package/src/d1/index.ts +101 -0
  110. package/src/d1/list.tsx +48 -0
  111. package/src/d1/migrations/apply.tsx +184 -0
  112. package/src/d1/migrations/create.tsx +77 -0
  113. package/src/d1/migrations/helpers.ts +147 -0
  114. package/src/d1/migrations/index.tsx +3 -0
  115. package/src/d1/migrations/list.tsx +79 -0
  116. package/src/d1/migrations/options.ts +18 -0
  117. package/src/d1/options.ts +22 -0
  118. package/src/d1/types.tsx +24 -0
  119. package/src/d1/utils.ts +48 -0
  120. package/src/delete.ts +108 -0
  121. package/src/deployments.ts +77 -0
  122. package/src/deprecated/index.ts +438 -0
  123. package/src/dev/dev-vars.ts +39 -0
  124. package/src/dev/dev.tsx +550 -328
  125. package/src/dev/get-local-persistence-path.tsx +31 -0
  126. package/src/dev/local.tsx +871 -213
  127. package/src/dev/remote.tsx +592 -192
  128. package/src/dev/start-server.ts +539 -0
  129. package/src/dev/use-esbuild.ts +184 -84
  130. package/src/dev/validate-dev-props.ts +31 -0
  131. package/src/dev-registry.tsx +201 -0
  132. package/src/dev.tsx +904 -0
  133. package/src/dialogs.tsx +150 -59
  134. package/src/dispatch-namespace.ts +207 -0
  135. package/src/durable.ts +102 -0
  136. package/src/entry.ts +260 -171
  137. package/src/environment-variables.ts +40 -23
  138. package/src/errors.ts +11 -0
  139. package/src/git-client.ts +124 -0
  140. package/src/global-wrangler-config-path.ts +26 -0
  141. package/src/https-options.ts +85 -80
  142. package/src/index.tsx +639 -2341
  143. package/src/init.ts +970 -0
  144. package/src/inspect.ts +707 -557
  145. package/src/intl-polyfill.d.ts +123 -123
  146. package/src/is-ci.ts +14 -0
  147. package/src/is-interactive.ts +16 -0
  148. package/src/kv/helpers.ts +430 -0
  149. package/src/kv/index.ts +596 -0
  150. package/src/logger.ts +92 -0
  151. package/src/metrics/index.ts +5 -0
  152. package/src/metrics/metrics-config.ts +239 -0
  153. package/src/metrics/metrics-dispatcher.ts +96 -0
  154. package/src/metrics/metrics-usage-headers.ts +24 -0
  155. package/src/metrics/send-event.ts +96 -0
  156. package/src/miniflare-cli/assets.ts +220 -0
  157. package/src/miniflare-cli/index.ts +206 -30
  158. package/src/miniflare-cli/request-context.ts +40 -0
  159. package/src/module-collection.ts +222 -213
  160. package/src/open-in-browser.ts +8 -16
  161. package/src/package-manager.ts +183 -90
  162. package/src/pages/build.tsx +270 -0
  163. package/src/pages/constants.ts +18 -0
  164. package/src/pages/deployment-tails.tsx +284 -0
  165. package/src/pages/deployments.tsx +84 -0
  166. package/src/pages/dev.tsx +706 -0
  167. package/src/pages/errors.ts +66 -0
  168. package/src/pages/functions/buildPlugin.ts +107 -0
  169. package/src/pages/functions/buildWorker.ts +166 -0
  170. package/src/pages/functions/filepath-routing.test.ts +234 -0
  171. package/src/pages/functions/filepath-routing.ts +189 -0
  172. package/src/pages/functions/identifiers.ts +78 -0
  173. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  174. package/src/pages/functions/routes-consolidation.ts +73 -0
  175. package/src/pages/functions/routes-transformation.test.ts +282 -0
  176. package/src/pages/functions/routes-transformation.ts +115 -0
  177. package/src/pages/functions/routes-validation.test.ts +403 -0
  178. package/src/pages/functions/routes-validation.ts +202 -0
  179. package/src/pages/functions/routes.ts +151 -0
  180. package/src/pages/functions.tsx +82 -0
  181. package/src/pages/hash.tsx +13 -0
  182. package/src/pages/index.tsx +102 -0
  183. package/src/pages/projects.tsx +169 -0
  184. package/src/pages/prompt-select-project.tsx +31 -0
  185. package/src/pages/publish.tsx +451 -0
  186. package/src/pages/types.ts +41 -0
  187. package/src/pages/upload.tsx +426 -0
  188. package/src/pages/utils.ts +23 -0
  189. package/src/parse.ts +224 -121
  190. package/src/paths.ts +53 -8
  191. package/src/proxy.ts +629 -375
  192. package/src/publish/index.ts +270 -0
  193. package/src/publish/publish.ts +1035 -0
  194. package/src/pubsub/index.ts +286 -0
  195. package/src/pubsub/pubsub-commands.tsx +624 -0
  196. package/src/queues/cli/commands/consumer/add.ts +71 -0
  197. package/src/queues/cli/commands/consumer/index.ts +22 -0
  198. package/src/queues/cli/commands/consumer/remove.ts +38 -0
  199. package/src/queues/cli/commands/create.ts +25 -0
  200. package/src/queues/cli/commands/delete.ts +26 -0
  201. package/src/queues/cli/commands/index.ts +36 -0
  202. package/src/queues/cli/commands/list.ts +25 -0
  203. package/src/queues/client.ts +135 -0
  204. package/src/queues/utils.ts +18 -0
  205. package/src/r2/constants.ts +4 -0
  206. package/src/r2/helpers.ts +131 -0
  207. package/src/r2/index.ts +289 -0
  208. package/src/routes.ts +140 -0
  209. package/src/secret/index.ts +378 -0
  210. package/src/selfsigned.d.ts +23 -23
  211. package/src/sites.tsx +283 -191
  212. package/src/tail/createTail.ts +379 -0
  213. package/src/tail/filters.ts +108 -110
  214. package/src/tail/index.ts +211 -296
  215. package/src/tail/printing.ts +92 -47
  216. package/src/type-generation.ts +173 -0
  217. package/src/update-check.ts +19 -0
  218. package/src/user/access.ts +69 -0
  219. package/src/user/choose-account.tsx +69 -0
  220. package/src/user/env-vars.ts +46 -0
  221. package/src/user/generate-auth-url.ts +33 -0
  222. package/src/user/generate-random-state.ts +16 -0
  223. package/src/user/index.ts +3 -0
  224. package/src/user/user.tsx +1198 -0
  225. package/src/utils/collectKeyValues.ts +14 -0
  226. package/src/whoami.tsx +142 -42
  227. package/src/worker.ts +182 -100
  228. package/src/yargs-types.ts +24 -0
  229. package/src/zones.ts +191 -0
  230. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  231. package/templates/checked-fetch.js +17 -0
  232. package/templates/d1-beta-facade.js +205 -0
  233. package/templates/first-party-worker-module-facade.ts +18 -0
  234. package/templates/format-dev-errors.ts +32 -0
  235. package/templates/gitignore +171 -0
  236. package/templates/init-tests/test-jest-new-worker.js +25 -0
  237. package/templates/init-tests/test-vitest-new-worker.js +26 -0
  238. package/templates/middleware/common.ts +62 -0
  239. package/templates/middleware/loader-modules.ts +84 -0
  240. package/templates/middleware/loader-sw.ts +227 -0
  241. package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
  242. package/templates/middleware/middleware-pretty-error.ts +40 -0
  243. package/templates/middleware/middleware-scheduled.ts +15 -0
  244. package/templates/new-worker-scheduled.js +17 -0
  245. package/templates/new-worker-scheduled.ts +32 -0
  246. package/templates/new-worker.js +3 -3
  247. package/templates/new-worker.ts +18 -3
  248. package/templates/no-op-worker.js +10 -0
  249. package/templates/pages-dev-pipeline.ts +28 -0
  250. package/templates/pages-dev-util.ts +52 -0
  251. package/templates/pages-shim.ts +9 -0
  252. package/templates/pages-template-plugin.ts +171 -0
  253. package/templates/pages-template-worker.ts +189 -0
  254. package/templates/serve-static-assets.ts +63 -0
  255. package/templates/service-bindings-module-facade.js +54 -0
  256. package/templates/service-bindings-sw-facade.js +42 -0
  257. package/templates/tsconfig.json +96 -95
  258. package/wrangler-dist/cli.d.ts +893 -0
  259. package/wrangler-dist/cli.js +116816 -94969
  260. package/miniflare-dist/index.mjs.map +0 -7
  261. package/pages/functions/buildWorker.ts +0 -62
  262. package/pages/functions/filepath-routing.test.ts +0 -223
  263. package/pages/functions/filepath-routing.ts +0 -181
  264. package/pages/functions/identifiers.ts +0 -78
  265. package/pages/functions/routes.ts +0 -151
  266. package/pages/functions/template-worker.ts +0 -130
  267. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  268. package/src/__tests__/sentry.test.ts +0 -146
  269. package/src/kv.ts +0 -319
  270. package/src/miniflare-cli/enum-keys.ts +0 -17
  271. package/src/pages.tsx +0 -1061
  272. package/src/publish.ts +0 -350
  273. package/src/r2.ts +0 -50
  274. package/src/reporting.ts +0 -131
  275. package/src/user.tsx +0 -1127
  276. package/templates/static-asset-facade.js +0 -47
  277. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  278. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  279. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  280. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  281. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  282. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  283. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  284. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  285. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  286. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  287. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  288. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  289. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  290. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  291. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  292. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  293. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  294. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  295. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  296. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  297. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  298. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  299. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  300. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  301. package/vendor/wrangler-mime/LICENSE +0 -21
  302. package/vendor/wrangler-mime/Mime.js +0 -97
  303. package/vendor/wrangler-mime/README.md +0 -187
  304. package/vendor/wrangler-mime/cli.js +0 -46
  305. package/vendor/wrangler-mime/index.js +0 -4
  306. package/vendor/wrangler-mime/lite.js +0 -4
  307. package/vendor/wrangler-mime/package.json +0 -52
  308. package/vendor/wrangler-mime/types/other.js +0 -1
  309. package/vendor/wrangler-mime/types/standard.js +0 -1
  310. package/wrangler-dist/cli.js.map +0 -7
@@ -1,130 +0,0 @@
1
- import { match } from "path-to-regexp";
2
- import type { HTTPMethod } from "./routes";
3
-
4
- /* TODO: Grab these from @cloudflare/workers-types instead */
5
- type Params<P extends string = string> = Record<P, string | string[]>;
6
-
7
- type EventContext<Env, P extends string, Data> = {
8
- request: Request;
9
- waitUntil: (promise: Promise<unknown>) => void;
10
- next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
11
- env: Env & { ASSETS: { fetch: typeof fetch } };
12
- params: Params<P>;
13
- data: Data;
14
- };
15
-
16
- declare type PagesFunction<
17
- Env = unknown,
18
- P extends string = string,
19
- Data extends Record<string, unknown> = Record<string, unknown>
20
- > = (context: EventContext<Env, P, Data>) => Response | Promise<Response>;
21
- /* end @cloudflare/workers-types */
22
-
23
- type RouteHandler = {
24
- routePath: string;
25
- method?: HTTPMethod;
26
- modules: PagesFunction[];
27
- middlewares: PagesFunction[];
28
- };
29
-
30
- // inject `routes` via ESBuild
31
- declare const routes: RouteHandler[];
32
- // define `__FALLBACK_SERVICE__` via ESBuild
33
- declare const __FALLBACK_SERVICE__: string;
34
-
35
- // expect an ASSETS fetcher binding pointing to the asset-server stage
36
- type FetchEnv = {
37
- [name: string]: { fetch: typeof fetch };
38
- ASSETS: { fetch: typeof fetch };
39
- };
40
-
41
- type WorkerContext = {
42
- waitUntil: (promise: Promise<unknown>) => void;
43
- };
44
-
45
- function* executeRequest(request: Request, _env: FetchEnv) {
46
- const requestPath = new URL(request.url).pathname;
47
-
48
- // First, iterate through the routes (backwards) and execute "middlewares" on partial route matches
49
- for (const route of [...routes].reverse()) {
50
- if (route.method && route.method !== request.method) {
51
- continue;
52
- }
53
-
54
- const routeMatcher = match(route.routePath, { end: false });
55
- const matchResult = routeMatcher(requestPath);
56
- if (matchResult) {
57
- for (const handler of route.middlewares.flat()) {
58
- yield {
59
- handler,
60
- params: matchResult.params as Params,
61
- };
62
- }
63
- }
64
- }
65
-
66
- // Then look for the first exact route match and execute its "modules"
67
- for (const route of routes) {
68
- if (route.method && route.method !== request.method) {
69
- continue;
70
- }
71
-
72
- const routeMatcher = match(route.routePath, { end: true });
73
- const matchResult = routeMatcher(requestPath);
74
- if (matchResult && route.modules.length) {
75
- for (const handler of route.modules.flat()) {
76
- yield {
77
- handler,
78
- params: matchResult.params as Params,
79
- };
80
- }
81
- break;
82
- }
83
- }
84
- }
85
-
86
- export default {
87
- async fetch(request: Request, env: FetchEnv, workerContext: WorkerContext) {
88
- const handlerIterator = executeRequest(request, env);
89
- const data = {}; // arbitrary data the user can set between functions
90
- const next = async (input?: RequestInfo, init?: RequestInit) => {
91
- if (input !== undefined) {
92
- request = new Request(input, init);
93
- }
94
-
95
- const result = handlerIterator.next();
96
- // Note we can't use `!result.done` because this doesn't narrow to the correct type
97
- if (result.done == false) {
98
- const { handler, params } = result.value;
99
- const context = {
100
- request: new Request(request.clone()),
101
- next,
102
- params,
103
- data,
104
- env,
105
- waitUntil: workerContext.waitUntil.bind(workerContext),
106
- };
107
-
108
- const response = await handler(context);
109
-
110
- // https://fetch.spec.whatwg.org/#null-body-status
111
- return new Response(
112
- [101, 204, 205, 304].includes(response.status) ? null : response.body,
113
- response
114
- );
115
- } else if (__FALLBACK_SERVICE__) {
116
- // There are no more handlers so finish with the fallback service (`env.ASSETS.fetch` in Pages' case)
117
- return env[__FALLBACK_SERVICE__].fetch(request);
118
- } else {
119
- // There was not fallback service so actually make the request to the origin.
120
- return fetch(request);
121
- }
122
- };
123
-
124
- try {
125
- return next();
126
- } catch (err) {
127
- return new Response("Internal Error", { status: 500 });
128
- }
129
- },
130
- };
@@ -1,6 +0,0 @@
1
- module "faye-websocket" {
2
- /**
3
- * Standards-compliant WebSocket client and server.
4
- */
5
- export default WebSocket;
6
- }
@@ -1,146 +0,0 @@
1
- import * as fs from "node:fs";
2
- import * as fsp from "node:fs/promises";
3
- import os from "node:os";
4
- import path from "node:path";
5
- import * as TOML from "@iarna/toml";
6
- import * as Sentry from "@sentry/node";
7
- import prompts from "prompts";
8
-
9
- import { mockConsoleMethods } from "./helpers/mock-console";
10
- import { runInTempDir } from "./helpers/run-in-tmp";
11
- import { runWrangler } from "./helpers/run-wrangler";
12
- const { reportError } = jest.requireActual("../reporting");
13
-
14
- describe("Error Reporting", () => {
15
- runInTempDir({ homedir: "./home" });
16
- mockConsoleMethods();
17
- const reportingTOMLPath = ".wrangler/config/reporting.toml";
18
-
19
- const originalTTY = process.stdout.isTTY;
20
- beforeEach(() => {
21
- jest.mock("@sentry/node");
22
- jest.spyOn(Sentry, "captureException");
23
- process.stdout.isTTY = true;
24
- });
25
-
26
- afterEach(() => {
27
- jest.unmock("@sentry/node");
28
- jest.clearAllMocks();
29
- process.stdout.isTTY = originalTTY;
30
- });
31
-
32
- it("should confirm user will allow error reporting usage", async () => {
33
- jest.spyOn(prompts, "prompt").mockResolvedValue({ sentryDecision: true });
34
-
35
- await reportError(new Error("test error"), "testFalse");
36
-
37
- const { error_tracking_opt, error_tracking_opt_date } = TOML.parse(
38
- await fsp.readFile(path.join(os.homedir(), reportingTOMLPath), "utf-8")
39
- );
40
-
41
- expect(error_tracking_opt).toBe(true);
42
- expect(error_tracking_opt_date).toBeTruthy();
43
-
44
- expect(Sentry.captureException).toHaveBeenCalledWith(
45
- new Error("test error")
46
- );
47
- });
48
-
49
- it("should confirm user will disallow error reporting usage", async () => {
50
- jest.spyOn(prompts, "prompt").mockResolvedValue({ sentryDecision: false });
51
- await reportError(new Error("test error"), "testFalse");
52
-
53
- const { error_tracking_opt, error_tracking_opt_date } = TOML.parse(
54
- await fsp.readFile(path.join(os.homedir(), reportingTOMLPath), "utf-8")
55
- );
56
-
57
- expect(error_tracking_opt).toBe(false);
58
- expect(error_tracking_opt_date).toBeTruthy();
59
-
60
- expect(Sentry.captureException).not.toHaveBeenCalledWith(
61
- new Error("test error"),
62
- "testFalse"
63
- );
64
- });
65
-
66
- it("should confirm user will allow 'once' error reporting usage", async () => {
67
- jest.spyOn(prompts, "prompt").mockResolvedValue({ sentryDecision: "once" });
68
- await runWrangler();
69
- await reportError(new Error("test error"), "testFalse");
70
-
71
- expect(fs.existsSync(path.join(os.homedir(), reportingTOMLPath))).toBe(
72
- false
73
- );
74
-
75
- expect(Sentry.captureException).not.toHaveBeenCalledWith(
76
- new Error("test error"),
77
- "testFalse"
78
- );
79
- });
80
-
81
- it("should not prompt w/ subsequent Errors after user disallows error reporting", async () => {
82
- jest.spyOn(prompts, "prompt").mockResolvedValue({ sentryDecision: false });
83
- await reportError(new Error("test error"), "testFalse");
84
-
85
- expect(Sentry.captureException).not.toHaveBeenCalledWith(
86
- new Error("test error"),
87
- "testFalse"
88
- );
89
-
90
- await reportError(new Error("second test error"), "testFalse");
91
- expect(Sentry.captureException).not.toHaveBeenCalledWith(
92
- new Error("second test error"),
93
- "testFalse"
94
- );
95
- });
96
-
97
- it("should not prompt w/ subsequent Errors after user Always allows error reporting", async () => {
98
- jest.spyOn(prompts, "prompt").mockResolvedValue({ sentryDecision: true });
99
- await reportError(new Error("test error"), "testFalse");
100
-
101
- expect(Sentry.captureException).toHaveBeenCalledWith(
102
- new Error("test error")
103
- );
104
-
105
- await reportError(new Error("second test error"), "testFalse");
106
- expect(Sentry.captureException).toHaveBeenCalledWith(
107
- new Error("second test error")
108
- );
109
- });
110
-
111
- it("should prompt w/ subsequent Errors after user allows error reporting once", async () => {
112
- const promptSpy = jest
113
- .spyOn(prompts, "prompt")
114
- .mockResolvedValue({ sentryDecision: "once" });
115
- await reportError(new Error("test error"), "testFalse");
116
-
117
- expect(Sentry.captureException).toHaveBeenCalledWith(
118
- new Error("test error")
119
- );
120
-
121
- await reportError(new Error("second test error"), "testFalse");
122
- expect(Sentry.captureException).toHaveBeenCalledWith(
123
- new Error("second test error")
124
- );
125
-
126
- expect(promptSpy).toBeCalledTimes(2);
127
- });
128
-
129
- it("should not prompt in non-TTY environment", async () => {
130
- process.stdout.isTTY = false;
131
-
132
- await reportError(new Error("test error"), "testFalse");
133
-
134
- const { error_tracking_opt, error_tracking_opt_date } = TOML.parse(
135
- await fsp.readFile(path.join(os.homedir(), reportingTOMLPath), "utf-8")
136
- );
137
-
138
- expect(error_tracking_opt).toBe(false);
139
- expect(error_tracking_opt_date).toBeTruthy();
140
-
141
- expect(Sentry.captureException).not.toHaveBeenCalledWith(
142
- new Error("test error")
143
- );
144
- process.stdout.isTTY = originalTTY;
145
- });
146
- });
package/src/kv.ts DELETED
@@ -1,319 +0,0 @@
1
- import { URLSearchParams } from "node:url";
2
- import { fetchListResult, fetchResult, fetchKVGetValue } from "./cfetch";
3
- import type { Config } from "./config";
4
-
5
- /** The largest number of kv items we can pass to the API in a single request. */
6
- const API_MAX = 10000;
7
- // The const below are halved from the API's true capacity to help avoid
8
- // hammering it with large requests.
9
- const BATCH_KEY_MAX = API_MAX / 2;
10
-
11
- type KvArgs = {
12
- binding?: string;
13
- "namespace-id"?: string;
14
- preview?: boolean;
15
- };
16
-
17
- /**
18
- * Create a new namespace under the given `accountId` with the given `title`.
19
- *
20
- * @returns the generated id of the created namespace.
21
- */
22
- export async function createNamespace(
23
- accountId: string,
24
- title: string
25
- ): Promise<string> {
26
- const response = await fetchResult<{ id: string }>(
27
- `/accounts/${accountId}/storage/kv/namespaces`,
28
- {
29
- method: "POST",
30
- headers: {
31
- "Content-Type": "application/json",
32
- },
33
- body: JSON.stringify({
34
- title,
35
- }),
36
- }
37
- );
38
-
39
- return response.id;
40
- }
41
-
42
- /**
43
- * The information about a namespace that is returned from `listNamespaces()`.
44
- */
45
- export interface KVNamespaceInfo {
46
- id: string;
47
- title: string;
48
- supports_url_encoding?: boolean;
49
- }
50
-
51
- /**
52
- * Fetch a list of all the namespaces under the given `accountId`.
53
- */
54
- export async function listNamespaces(
55
- accountId: string
56
- ): Promise<KVNamespaceInfo[]> {
57
- const pageSize = 100;
58
- let page = 1;
59
- const results: KVNamespaceInfo[] = [];
60
- while (results.length % pageSize === 0) {
61
- const json = await fetchResult<KVNamespaceInfo[]>(
62
- `/accounts/${accountId}/storage/kv/namespaces`,
63
- {},
64
- new URLSearchParams({
65
- per_page: pageSize.toString(),
66
- order: "title",
67
- direction: "asc",
68
- page: page.toString(),
69
- })
70
- );
71
- page++;
72
- results.push(...json);
73
- if (json.length < pageSize) {
74
- break;
75
- }
76
- }
77
- return results;
78
- }
79
-
80
- export interface NamespaceKeyInfo {
81
- name: string;
82
- expiration?: number;
83
- metadata?: { [key: string]: unknown };
84
- }
85
-
86
- export async function listNamespaceKeys(
87
- accountId: string,
88
- namespaceId: string,
89
- prefix = ""
90
- ) {
91
- return await fetchListResult<NamespaceKeyInfo>(
92
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/keys`,
93
- {},
94
- new URLSearchParams({ prefix })
95
- );
96
- }
97
-
98
- /**
99
- * Information about a key-value pair, including its "metadata" fields.
100
- */
101
- export interface KeyValue {
102
- key: string;
103
- value: string;
104
- expiration?: number;
105
- expiration_ttl?: number;
106
- metadata?: object;
107
- base64?: boolean;
108
- }
109
-
110
- const KeyValueKeys = new Set([
111
- "key",
112
- "value",
113
- "expiration",
114
- "expiration_ttl",
115
- "metadata",
116
- "base64",
117
- ]);
118
-
119
- /**
120
- * Is the given object a valid `KeyValue` type?
121
- */
122
- export function isKeyValue(keyValue: object): keyValue is KeyValue {
123
- const props = Object.keys(keyValue);
124
- if (!props.includes("key") || !props.includes("value")) {
125
- return false;
126
- }
127
- return true;
128
- }
129
-
130
- /**
131
- * Get all the properties on the `keyValue` that are not expected.
132
- */
133
- export function unexpectedKeyValueProps(keyValue: KeyValue): string[] {
134
- const props = Object.keys(keyValue);
135
- return props.filter((prop) => !KeyValueKeys.has(prop));
136
- }
137
-
138
- export async function putKeyValue(
139
- accountId: string,
140
- namespaceId: string,
141
- keyValue: KeyValue
142
- ) {
143
- let searchParams: URLSearchParams | undefined;
144
- if (keyValue.expiration || keyValue.expiration_ttl) {
145
- searchParams = new URLSearchParams();
146
- if (keyValue.expiration) {
147
- searchParams.set("expiration", `${keyValue.expiration}`);
148
- }
149
- if (keyValue.expiration_ttl) {
150
- searchParams.set("expiration_ttl", `${keyValue.expiration_ttl}`);
151
- }
152
- }
153
- return await fetchResult(
154
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${keyValue.key}`,
155
- { method: "PUT", body: keyValue.value },
156
- searchParams
157
- );
158
- }
159
-
160
- export async function getKeyValue(
161
- accountId: string,
162
- namespaceId: string,
163
- key: string
164
- ): Promise<string> {
165
- return await fetchKVGetValue(accountId, namespaceId, key);
166
- }
167
-
168
- export async function putBulkKeyValue(
169
- accountId: string,
170
- namespaceId: string,
171
- keyValues: KeyValue[],
172
- progressCallback: (index: number, total: number) => void
173
- ) {
174
- for (let index = 0; index < keyValues.length; index += BATCH_KEY_MAX) {
175
- if (progressCallback && keyValues.length > BATCH_KEY_MAX) {
176
- progressCallback(index, keyValues.length);
177
- }
178
-
179
- await fetchResult(
180
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
181
- {
182
- method: "PUT",
183
- body: JSON.stringify(keyValues.slice(index, index + BATCH_KEY_MAX)),
184
- headers: { "Content-Type": "application/json" },
185
- }
186
- );
187
- }
188
- if (progressCallback && keyValues.length > BATCH_KEY_MAX) {
189
- progressCallback(keyValues.length, keyValues.length);
190
- }
191
- }
192
-
193
- export async function deleteBulkKeyValue(
194
- accountId: string,
195
- namespaceId: string,
196
- keys: string[],
197
- progressCallback: (index: number, total: number) => void
198
- ) {
199
- for (let index = 0; index < keys.length; index += BATCH_KEY_MAX) {
200
- if (progressCallback && keys.length > BATCH_KEY_MAX) {
201
- progressCallback(index, keys.length);
202
- }
203
-
204
- await fetchResult(
205
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
206
- {
207
- method: "DELETE",
208
- body: JSON.stringify(keys.slice(index, index + BATCH_KEY_MAX)),
209
- headers: { "Content-Type": "application/json" },
210
- }
211
- );
212
- }
213
- if (progressCallback && keys.length > BATCH_KEY_MAX) {
214
- progressCallback(keys.length, keys.length);
215
- }
216
- }
217
-
218
- export function getNamespaceId(
219
- { preview, binding, "namespace-id": namespaceId }: KvArgs,
220
- config: Config
221
- ): string {
222
- // nice
223
- if (namespaceId) {
224
- return namespaceId;
225
- }
226
-
227
- // begin pre-flight checks
228
-
229
- // `--binding` is only valid if there's a wrangler configuration.
230
- if (binding && !config) {
231
- throw new Error("--binding specified, but no config file was found.");
232
- }
233
-
234
- // there's no config. abort here
235
- if (!config) {
236
- throw new Error(
237
- "Failed to find a config file.\n" +
238
- "Either use --namespace-id to upload directly or create a configuration file with a binding."
239
- );
240
- }
241
-
242
- // there's no KV namespaces
243
- if (!config.kv_namespaces || config.kv_namespaces.length === 0) {
244
- throw new Error(
245
- "No KV Namespaces configured! Either use --namespace-id to upload directly or add a KV namespace to your wrangler config file."
246
- );
247
- }
248
-
249
- const namespace = config.kv_namespaces.find((ns) => ns.binding === binding);
250
-
251
- // we couldn't find a namespace with that binding
252
- if (!namespace) {
253
- throw new Error(
254
- `A namespace with binding name "${binding}" was not found in the configured "kv_namespaces".`
255
- );
256
- }
257
-
258
- // end pre-flight checks
259
-
260
- // we're in preview mode, `--preview true` or `--preview` was passed
261
- if (preview && namespace.preview_id) {
262
- namespaceId = namespace.preview_id;
263
- // We don't want to execute code below if preview is set to true, so we just return. Otherwise we will get errors!
264
- return namespaceId;
265
- } else if (preview) {
266
- throw new Error(
267
- `No preview ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
268
- );
269
- }
270
-
271
- // either `--preview false`, or preview wasn't passed
272
- // TODO: should we care? or should we just treat false and undefined the same
273
- const previewIsDefined = typeof preview !== "undefined";
274
-
275
- // --preview false was passed
276
- if (previewIsDefined && namespace.id) {
277
- namespaceId = namespace.id;
278
- // We don't want to execute code below if preview is set to true, so we just return. Otherwise we can get error!
279
- return namespaceId;
280
- } else if (previewIsDefined) {
281
- throw new Error(
282
- `No namespace ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
283
- );
284
- }
285
-
286
- // `--preview` wasn't passed
287
- const bindingHasOnlyOneId =
288
- (namespace.id && !namespace.preview_id) ||
289
- (!namespace.id && namespace.preview_id);
290
- if (bindingHasOnlyOneId) {
291
- namespaceId = namespace.id || namespace.preview_id;
292
- } else {
293
- throw new Error(
294
- `${binding} has both a namespace ID and a preview ID. Specify "--preview" or "--preview false" to avoid writing data to the wrong namespace.`
295
- );
296
- }
297
-
298
- // shouldn't happen. we should be able to prove this with strong typing.
299
- // TODO: when we add strongly typed commands, rewrite these checks so they're exhaustive
300
- if (!namespaceId) {
301
- throw Error(
302
- "Something went wrong trying to determine which namespace to upload to.\n" +
303
- "Please create a github issue with the command you just ran along with your wrangler configuration."
304
- );
305
- }
306
-
307
- return namespaceId;
308
- }
309
-
310
- /**
311
- * KV namespace binding names must be valid JS identifiers.
312
- */
313
- export function isValidNamespaceBinding(
314
- binding: string | undefined
315
- ): binding is string {
316
- return (
317
- typeof binding === "string" && /^[a-zA-Z_][a-zA-Z0-9_]*$/.test(binding)
318
- );
319
- }
@@ -1,17 +0,0 @@
1
- export type EnumKeys<Enum> = Exclude<keyof Enum, number>;
2
-
3
- export const enumObject = <Enum extends Record<string, number | string>>(
4
- e: Enum
5
- ) => {
6
- const copy = { ...e } as { [K in EnumKeys<Enum>]: Enum[K] };
7
- Object.values(e).forEach(
8
- (value) => typeof value === "number" && delete copy[value]
9
- );
10
- return copy;
11
- };
12
-
13
- export const enumKeys = <Enum extends Record<string, number | string>>(
14
- e: Enum
15
- ) => {
16
- return Object.keys(enumObject(e)) as EnumKeys<Enum>[];
17
- };