wrangler 0.0.0-e978986 → 0.0.0-e98613f8

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 (304) hide show
  1. package/README.md +23 -3
  2. package/bin/wrangler.js +162 -62
  3. package/kv-asset-handler.js +1 -0
  4. package/miniflare-dist/index.mjs +1456 -21
  5. package/package.json +191 -152
  6. package/src/__tests__/access.test.ts +25 -0
  7. package/src/__tests__/api-dev.test.ts +209 -0
  8. package/src/__tests__/api-devregistry.test.js +56 -0
  9. package/src/__tests__/api.test.ts +80 -0
  10. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  11. package/src/__tests__/config-cache.test.ts +30 -24
  12. package/src/__tests__/configuration.test.ts +3970 -3363
  13. package/src/__tests__/d1.test.ts +80 -0
  14. package/src/__tests__/delete.test.ts +263 -0
  15. package/src/__tests__/deployments.test.ts +91 -0
  16. package/src/__tests__/dev.test.tsx +1524 -951
  17. package/src/__tests__/dialogs.test.tsx +40 -0
  18. package/src/__tests__/generate.test.ts +235 -0
  19. package/src/__tests__/get-host-from-url.test.ts +16 -0
  20. package/src/__tests__/guess-worker-format.test.ts +68 -68
  21. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  22. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  23. package/src/__tests__/helpers/mock-bin.ts +20 -20
  24. package/src/__tests__/helpers/mock-cfetch.ts +216 -94
  25. package/src/__tests__/helpers/mock-console.ts +58 -39
  26. package/src/__tests__/helpers/mock-dialogs.ts +94 -71
  27. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  28. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  29. package/src/__tests__/helpers/mock-istty.ts +65 -18
  30. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  31. package/src/__tests__/helpers/mock-kv.ts +27 -27
  32. package/src/__tests__/helpers/mock-oauth-flow.ts +229 -228
  33. package/src/__tests__/helpers/mock-process.ts +39 -0
  34. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  35. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  36. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  37. package/src/__tests__/helpers/msw/handlers/deployments.ts +59 -0
  38. package/src/__tests__/helpers/msw/handlers/namespaces.ts +104 -0
  39. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  40. package/src/__tests__/helpers/msw/handlers/r2.ts +80 -0
  41. package/src/__tests__/helpers/msw/handlers/script.ts +75 -0
  42. package/src/__tests__/helpers/msw/handlers/user.ts +63 -0
  43. package/src/__tests__/helpers/msw/handlers/zones.ts +22 -0
  44. package/src/__tests__/helpers/msw/index.ts +21 -0
  45. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  46. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  47. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  48. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  49. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  50. package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
  51. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  52. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  53. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  54. package/src/__tests__/https-options.test.ts +142 -109
  55. package/src/__tests__/index.test.ts +241 -233
  56. package/src/__tests__/init.test.ts +2884 -1536
  57. package/src/__tests__/jest.setup.ts +159 -34
  58. package/src/__tests__/kv.test.ts +1660 -1466
  59. package/src/__tests__/logger.test.ts +100 -74
  60. package/src/__tests__/logout.test.ts +47 -0
  61. package/src/__tests__/metrics.test.ts +450 -0
  62. package/src/__tests__/middleware.scheduled.test.ts +135 -0
  63. package/src/__tests__/middleware.test.ts +726 -0
  64. package/src/__tests__/package-manager.test.ts +303 -303
  65. package/src/__tests__/pages-deployment-tail.test.ts +820 -0
  66. package/src/__tests__/pages.test.ts +2423 -638
  67. package/src/__tests__/parse.test.ts +252 -252
  68. package/src/__tests__/paths.test.ts +39 -0
  69. package/src/__tests__/publish.test.ts +7516 -5351
  70. package/src/__tests__/pubsub.test.ts +370 -0
  71. package/src/__tests__/queues.test.ts +522 -0
  72. package/src/__tests__/r2.test.ts +388 -228
  73. package/src/__tests__/route.test.ts +18 -18
  74. package/src/__tests__/secret.test.ts +622 -459
  75. package/src/__tests__/tail.test.ts +776 -567
  76. package/src/__tests__/test-old-node-version.js +31 -0
  77. package/src/__tests__/type-generation.test.ts +226 -0
  78. package/src/__tests__/user.test.ts +117 -119
  79. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  80. package/src/__tests__/validate-dev-props.test.ts +56 -0
  81. package/src/__tests__/version.test.ts +35 -0
  82. package/src/__tests__/whoami.test.tsx +264 -91
  83. package/src/__tests__/worker-namespace.test.ts +326 -0
  84. package/src/abort.d.ts +1 -1
  85. package/src/api/dev.ts +210 -0
  86. package/src/api/index.ts +2 -0
  87. package/src/bundle-reporter.tsx +68 -0
  88. package/src/bundle.ts +785 -162
  89. package/src/cfetch/index.ts +120 -81
  90. package/src/cfetch/internal.ts +209 -91
  91. package/src/cli.ts +23 -8
  92. package/src/config/config.ts +236 -195
  93. package/src/config/diagnostics.ts +61 -61
  94. package/src/config/environment.ts +498 -357
  95. package/src/config/index.ts +302 -193
  96. package/src/config/validation-helpers.ts +379 -357
  97. package/src/config/validation.ts +1931 -1367
  98. package/src/config-cache.ts +81 -41
  99. package/src/create-worker-preview.ts +239 -142
  100. package/src/create-worker-upload-form.ts +300 -238
  101. package/src/d1/backups.tsx +223 -0
  102. package/src/d1/constants.ts +2 -0
  103. package/src/d1/create.tsx +63 -0
  104. package/src/d1/delete.tsx +56 -0
  105. package/src/d1/execute.tsx +352 -0
  106. package/src/d1/formatTimeAgo.ts +14 -0
  107. package/src/d1/index.ts +101 -0
  108. package/src/d1/list.tsx +48 -0
  109. package/src/d1/migrations/apply.tsx +184 -0
  110. package/src/d1/migrations/create.tsx +77 -0
  111. package/src/d1/migrations/helpers.ts +147 -0
  112. package/src/d1/migrations/index.tsx +3 -0
  113. package/src/d1/migrations/list.tsx +79 -0
  114. package/src/d1/migrations/options.ts +18 -0
  115. package/src/d1/options.ts +22 -0
  116. package/src/d1/types.tsx +24 -0
  117. package/src/d1/utils.ts +48 -0
  118. package/src/delete.ts +108 -0
  119. package/src/deployments.ts +77 -0
  120. package/src/deprecated/index.ts +438 -0
  121. package/src/dev/dev-vars.ts +20 -17
  122. package/src/dev/dev.tsx +547 -352
  123. package/src/dev/get-local-persistence-path.tsx +31 -0
  124. package/src/dev/local.tsx +870 -298
  125. package/src/dev/remote.tsx +591 -215
  126. package/src/dev/start-server.ts +539 -0
  127. package/src/dev/use-esbuild.ts +183 -97
  128. package/src/dev/validate-dev-props.ts +31 -0
  129. package/src/dev-registry.tsx +201 -0
  130. package/src/dev.tsx +913 -0
  131. package/src/dialogs.tsx +132 -99
  132. package/src/dispatch-namespace.ts +207 -0
  133. package/src/durable.ts +87 -87
  134. package/src/entry.ts +235 -228
  135. package/src/environment-variables.ts +38 -23
  136. package/src/errors.ts +6 -6
  137. package/src/git-client.ts +135 -0
  138. package/src/global-wrangler-config-path.ts +26 -0
  139. package/src/https-options.ts +84 -80
  140. package/src/index.tsx +630 -2791
  141. package/src/init.ts +970 -0
  142. package/src/inspect.ts +698 -593
  143. package/src/intl-polyfill.d.ts +123 -123
  144. package/src/is-ci.ts +14 -0
  145. package/src/is-interactive.ts +16 -0
  146. package/src/kv/helpers.ts +430 -0
  147. package/src/kv/index.ts +596 -0
  148. package/src/logger.ts +67 -41
  149. package/src/metrics/index.ts +5 -0
  150. package/src/metrics/metrics-config.ts +239 -0
  151. package/src/metrics/metrics-dispatcher.ts +96 -0
  152. package/src/metrics/metrics-usage-headers.ts +24 -0
  153. package/src/metrics/send-event.ts +96 -0
  154. package/src/miniflare-cli/assets.ts +220 -0
  155. package/src/miniflare-cli/index.ts +205 -33
  156. package/src/miniflare-cli/request-context.ts +18 -18
  157. package/src/module-collection.ts +221 -212
  158. package/src/open-in-browser.ts +4 -6
  159. package/src/package-manager.ts +173 -128
  160. package/src/pages/build.tsx +270 -0
  161. package/src/pages/constants.ts +18 -0
  162. package/src/pages/deployment-tails.tsx +284 -0
  163. package/src/pages/deployments.tsx +84 -0
  164. package/src/pages/dev.tsx +706 -0
  165. package/src/pages/errors.ts +66 -0
  166. package/src/pages/functions/buildPlugin.ts +107 -0
  167. package/src/pages/functions/buildWorker.ts +166 -0
  168. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  169. package/src/pages/functions/filepath-routing.ts +189 -0
  170. package/src/pages/functions/identifiers.ts +78 -0
  171. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  172. package/src/pages/functions/routes-consolidation.ts +73 -0
  173. package/src/pages/functions/routes-transformation.test.ts +282 -0
  174. package/src/pages/functions/routes-transformation.ts +115 -0
  175. package/src/pages/functions/routes-validation.test.ts +403 -0
  176. package/src/pages/functions/routes-validation.ts +202 -0
  177. package/src/pages/functions/routes.ts +151 -0
  178. package/src/pages/functions.tsx +82 -0
  179. package/src/pages/hash.tsx +13 -0
  180. package/src/pages/index.tsx +102 -0
  181. package/src/pages/projects.tsx +169 -0
  182. package/src/pages/prompt-select-project.tsx +31 -0
  183. package/src/pages/publish.tsx +451 -0
  184. package/src/pages/types.ts +41 -0
  185. package/src/pages/upload.tsx +426 -0
  186. package/src/pages/utils.ts +23 -0
  187. package/src/parse.ts +209 -125
  188. package/src/paths.ts +53 -8
  189. package/src/proxy.ts +623 -394
  190. package/src/publish/index.ts +270 -0
  191. package/src/publish/publish.ts +1035 -0
  192. package/src/pubsub/index.ts +286 -0
  193. package/src/pubsub/pubsub-commands.tsx +624 -0
  194. package/src/queues/cli/commands/consumer/add.ts +71 -0
  195. package/src/queues/cli/commands/consumer/index.ts +22 -0
  196. package/src/queues/cli/commands/consumer/remove.ts +38 -0
  197. package/src/queues/cli/commands/create.ts +25 -0
  198. package/src/queues/cli/commands/delete.ts +26 -0
  199. package/src/queues/cli/commands/index.ts +36 -0
  200. package/src/queues/cli/commands/list.ts +25 -0
  201. package/src/queues/client.ts +135 -0
  202. package/src/queues/utils.ts +18 -0
  203. package/src/r2/constants.ts +4 -0
  204. package/src/r2/helpers.ts +131 -0
  205. package/src/r2/index.ts +289 -0
  206. package/src/routes.ts +140 -0
  207. package/src/secret/index.ts +378 -0
  208. package/src/selfsigned.d.ts +23 -23
  209. package/src/sites.tsx +280 -203
  210. package/src/tail/createTail.ts +379 -0
  211. package/src/tail/filters.ts +108 -110
  212. package/src/tail/index.ts +211 -296
  213. package/src/tail/printing.ts +86 -46
  214. package/src/type-generation.ts +173 -0
  215. package/src/update-check.ts +11 -11
  216. package/src/user/access.ts +69 -0
  217. package/src/user/choose-account.tsx +69 -0
  218. package/src/user/env-vars.ts +46 -0
  219. package/src/user/generate-auth-url.ts +33 -0
  220. package/src/user/generate-random-state.ts +16 -0
  221. package/src/user/index.ts +3 -0
  222. package/src/user/user.tsx +1198 -0
  223. package/src/utils/collectKeyValues.ts +14 -0
  224. package/src/whoami.tsx +141 -42
  225. package/src/worker.ts +171 -106
  226. package/src/yargs-types.ts +24 -0
  227. package/src/zones.ts +191 -0
  228. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  229. package/templates/checked-fetch.js +17 -0
  230. package/templates/d1-beta-facade.js +205 -0
  231. package/templates/first-party-worker-module-facade.ts +18 -0
  232. package/templates/format-dev-errors.ts +32 -0
  233. package/templates/init-tests/test-jest-new-worker.js +25 -0
  234. package/templates/init-tests/test-vitest-new-worker.js +26 -0
  235. package/templates/middleware/common.ts +62 -0
  236. package/templates/middleware/loader-modules.ts +84 -0
  237. package/templates/middleware/loader-sw.ts +227 -0
  238. package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
  239. package/templates/middleware/middleware-pretty-error.ts +40 -0
  240. package/templates/middleware/middleware-scheduled.ts +15 -0
  241. package/templates/new-worker-scheduled.js +4 -4
  242. package/templates/new-worker-scheduled.ts +16 -16
  243. package/templates/new-worker.js +3 -3
  244. package/templates/new-worker.ts +15 -15
  245. package/templates/no-op-worker.js +10 -0
  246. package/templates/pages-dev-pipeline.ts +28 -0
  247. package/templates/pages-dev-util.ts +52 -0
  248. package/templates/pages-shim.ts +9 -0
  249. package/templates/pages-template-plugin.ts +171 -0
  250. package/templates/pages-template-worker.ts +189 -0
  251. package/templates/serve-static-assets.ts +63 -0
  252. package/templates/service-bindings-module-facade.js +54 -0
  253. package/templates/service-bindings-sw-facade.js +42 -0
  254. package/templates/tsconfig.json +96 -95
  255. package/wrangler-dist/cli.d.ts +893 -0
  256. package/wrangler-dist/cli.js +146463 -108710
  257. package/pages/functions/buildPlugin.ts +0 -105
  258. package/pages/functions/buildWorker.ts +0 -151
  259. package/pages/functions/filepath-routing.ts +0 -189
  260. package/pages/functions/identifiers.ts +0 -78
  261. package/pages/functions/routes.ts +0 -156
  262. package/pages/functions/template-plugin.ts +0 -147
  263. package/pages/functions/template-worker.ts +0 -143
  264. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  265. package/src/kv.ts +0 -408
  266. package/src/miniflare-cli/enum-keys.ts +0 -17
  267. package/src/pages.tsx +0 -2027
  268. package/src/publish.ts +0 -583
  269. package/src/r2.ts +0 -50
  270. package/src/user.tsx +0 -1203
  271. package/templates/static-asset-facade.js +0 -47
  272. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  273. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  274. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  275. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  276. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  277. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  278. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  279. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  280. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  281. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  282. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  283. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  284. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  285. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  286. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  287. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  288. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  289. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  290. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  291. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  292. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  293. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  294. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  295. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  296. package/vendor/wrangler-mime/LICENSE +0 -21
  297. package/vendor/wrangler-mime/Mime.js +0 -97
  298. package/vendor/wrangler-mime/README.md +0 -187
  299. package/vendor/wrangler-mime/cli.js +0 -46
  300. package/vendor/wrangler-mime/index.js +0 -4
  301. package/vendor/wrangler-mime/lite.js +0 -4
  302. package/vendor/wrangler-mime/package.json +0 -52
  303. package/vendor/wrangler-mime/types/other.js +0 -1
  304. package/vendor/wrangler-mime/types/standard.js +0 -1
@@ -1,147 +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
- functionPath: string;
10
- waitUntil: (promise: Promise<unknown>) => void;
11
- next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
12
- env: Env & { ASSETS: { fetch: typeof fetch } };
13
- params: Params<P>;
14
- data: Data;
15
- };
16
-
17
- type EventPluginContext<Env, P extends string, Data, PluginArgs> = {
18
- request: Request;
19
- functionPath: string;
20
- waitUntil: (promise: Promise<unknown>) => void;
21
- next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
22
- env: Env & { ASSETS: { fetch: typeof fetch } };
23
- params: Params<P>;
24
- data: Data;
25
- pluginArgs: PluginArgs;
26
- };
27
-
28
- declare type PagesFunction<
29
- Env = unknown,
30
- P extends string = string,
31
- Data extends Record<string, unknown> = Record<string, unknown>
32
- > = (context: EventContext<Env, P, Data>) => Response | Promise<Response>;
33
-
34
- declare type PagesPluginFunction<
35
- Env = unknown,
36
- P extends string = string,
37
- Data extends Record<string, unknown> = Record<string, unknown>,
38
- PluginArgs = unknown
39
- > = (
40
- context: EventPluginContext<Env, P, Data, PluginArgs>
41
- ) => Response | Promise<Response>;
42
- /* end @cloudflare/workers-types */
43
-
44
- type RouteHandler = {
45
- routePath: string;
46
- mountPath: string;
47
- method?: HTTPMethod;
48
- modules: PagesFunction[];
49
- middlewares: PagesFunction[];
50
- };
51
-
52
- // inject `routes` via ESBuild
53
- declare const routes: RouteHandler[];
54
-
55
- function* executeRequest(request: Request, relativePathname: string) {
56
- // First, iterate through the routes (backwards) and execute "middlewares" on partial route matches
57
- for (const route of [...routes].reverse()) {
58
- if (route.method && route.method !== request.method) {
59
- continue;
60
- }
61
-
62
- const routeMatcher = match(route.routePath, { end: false });
63
- const mountMatcher = match(route.mountPath, { end: false });
64
- const matchResult = routeMatcher(relativePathname);
65
- const mountMatchResult = mountMatcher(relativePathname);
66
- if (matchResult && mountMatchResult) {
67
- for (const handler of route.middlewares.flat()) {
68
- yield {
69
- handler,
70
- params: matchResult.params as Params,
71
- path: mountMatchResult.path,
72
- };
73
- }
74
- }
75
- }
76
-
77
- // Then look for the first exact route match and execute its "modules"
78
- for (const route of routes) {
79
- if (route.method && route.method !== request.method) {
80
- continue;
81
- }
82
-
83
- const routeMatcher = match(route.routePath, { end: true });
84
- const mountMatcher = match(route.mountPath, { end: false });
85
- const matchResult = routeMatcher(relativePathname);
86
- const mountMatchResult = mountMatcher(relativePathname);
87
- if (matchResult && mountMatchResult && route.modules.length) {
88
- for (const handler of route.modules.flat()) {
89
- yield {
90
- handler,
91
- params: matchResult.params as Params,
92
- path: matchResult.path,
93
- };
94
- }
95
- break;
96
- }
97
- }
98
- }
99
-
100
- export default function (pluginArgs) {
101
- const onRequest: PagesPluginFunction = async (workerContext) => {
102
- let { request } = workerContext;
103
- const { env, next, data } = workerContext;
104
-
105
- const url = new URL(request.url);
106
- const relativePathname = `/${
107
- url.pathname.split(workerContext.functionPath)[1] || ""
108
- }`.replace(/^\/\//, "/");
109
-
110
- const handlerIterator = executeRequest(request, relativePathname);
111
- const pluginNext = async (input?: RequestInfo, init?: RequestInit) => {
112
- if (input !== undefined) {
113
- request = new Request(input, init);
114
- }
115
-
116
- const result = handlerIterator.next();
117
- // Note we can't use `!result.done` because this doesn't narrow to the correct type
118
- if (result.done === false) {
119
- const { handler, params, path } = result.value;
120
- const context = {
121
- request,
122
- functionPath: workerContext.functionPath + path,
123
- next: pluginNext,
124
- params,
125
- data,
126
- pluginArgs,
127
- env,
128
- waitUntil: workerContext.waitUntil.bind(workerContext),
129
- };
130
-
131
- const response = await handler(context);
132
-
133
- // https://fetch.spec.whatwg.org/#null-body-status
134
- return new Response(
135
- [101, 204, 205, 304].includes(response.status) ? null : response.body,
136
- { ...response, headers: new Headers(response.headers) }
137
- );
138
- } else {
139
- return next();
140
- }
141
- };
142
-
143
- return pluginNext();
144
- };
145
-
146
- return onRequest;
147
- }
@@ -1,143 +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
- functionPath: string;
10
- waitUntil: (promise: Promise<unknown>) => void;
11
- next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
12
- env: Env & { ASSETS: { fetch: typeof fetch } };
13
- params: Params<P>;
14
- data: Data;
15
- };
16
-
17
- declare type PagesFunction<
18
- Env = unknown,
19
- P extends string = string,
20
- Data extends Record<string, unknown> = Record<string, unknown>
21
- > = (context: EventContext<Env, P, Data>) => Response | Promise<Response>;
22
- /* end @cloudflare/workers-types */
23
-
24
- type RouteHandler = {
25
- routePath: string;
26
- mountPath: string;
27
- method?: HTTPMethod;
28
- modules: PagesFunction[];
29
- middlewares: PagesFunction[];
30
- };
31
-
32
- // inject `routes` via ESBuild
33
- declare const routes: RouteHandler[];
34
- // define `__FALLBACK_SERVICE__` via ESBuild
35
- declare const __FALLBACK_SERVICE__: string;
36
-
37
- // expect an ASSETS fetcher binding pointing to the asset-server stage
38
- type FetchEnv = {
39
- [name: string]: { fetch: typeof fetch };
40
- ASSETS: { fetch: typeof fetch };
41
- };
42
-
43
- type WorkerContext = {
44
- waitUntil: (promise: Promise<unknown>) => void;
45
- };
46
-
47
- function* executeRequest(request: Request) {
48
- const requestPath = new URL(request.url).pathname;
49
-
50
- // First, iterate through the routes (backwards) and execute "middlewares" on partial route matches
51
- for (const route of [...routes].reverse()) {
52
- if (route.method && route.method !== request.method) {
53
- continue;
54
- }
55
-
56
- const routeMatcher = match(route.routePath, { end: false });
57
- const mountMatcher = match(route.mountPath, { end: false });
58
- const matchResult = routeMatcher(requestPath);
59
- const mountMatchResult = mountMatcher(requestPath);
60
- if (matchResult && mountMatchResult) {
61
- for (const handler of route.middlewares.flat()) {
62
- yield {
63
- handler,
64
- params: matchResult.params as Params,
65
- path: mountMatchResult.path,
66
- };
67
- }
68
- }
69
- }
70
-
71
- // Then look for the first exact route match and execute its "modules"
72
- for (const route of routes) {
73
- if (route.method && route.method !== request.method) {
74
- continue;
75
- }
76
-
77
- const routeMatcher = match(route.routePath, { end: true });
78
- const mountMatcher = match(route.mountPath, { end: false });
79
- const matchResult = routeMatcher(requestPath);
80
- const mountMatchResult = mountMatcher(requestPath);
81
- if (matchResult && mountMatchResult && route.modules.length) {
82
- for (const handler of route.modules.flat()) {
83
- yield {
84
- handler,
85
- params: matchResult.params as Params,
86
- path: matchResult.path,
87
- };
88
- }
89
- break;
90
- }
91
- }
92
- }
93
-
94
- export default {
95
- async fetch(request: Request, env: FetchEnv, workerContext: WorkerContext) {
96
- const handlerIterator = executeRequest(request);
97
- const data = {}; // arbitrary data the user can set between functions
98
- const next = async (input?: RequestInfo, init?: RequestInit) => {
99
- if (input !== undefined) {
100
- let url = input;
101
- if (typeof input === "string") {
102
- url = new URL(input, request.url).toString();
103
- }
104
- request = new Request(url, init);
105
- }
106
-
107
- const result = handlerIterator.next();
108
- // Note we can't use `!result.done` because this doesn't narrow to the correct type
109
- if (result.done === false) {
110
- const { handler, params, path } = result.value;
111
- const context = {
112
- request: new Request(request.clone()),
113
- functionPath: path,
114
- next,
115
- params,
116
- data,
117
- env,
118
- waitUntil: workerContext.waitUntil.bind(workerContext),
119
- };
120
-
121
- const response = await handler(context);
122
-
123
- // https://fetch.spec.whatwg.org/#null-body-status
124
- return new Response(
125
- [101, 204, 205, 304].includes(response.status) ? null : response.body,
126
- { ...response, headers: new Headers(response.headers) }
127
- );
128
- } else if (__FALLBACK_SERVICE__) {
129
- // There are no more handlers so finish with the fallback service (`env.ASSETS.fetch` in Pages' case)
130
- return env[__FALLBACK_SERVICE__].fetch(request);
131
- } else {
132
- // There was not fallback service so actually make the request to the origin.
133
- return fetch(request);
134
- }
135
- };
136
-
137
- try {
138
- return next();
139
- } catch (err) {
140
- return new Response("Internal Error", { status: 500 });
141
- }
142
- },
143
- };
@@ -1,6 +0,0 @@
1
- module "faye-websocket" {
2
- /**
3
- * Standards-compliant WebSocket client and server.
4
- */
5
- export default WebSocket;
6
- }
package/src/kv.ts DELETED
@@ -1,408 +0,0 @@
1
- import { URLSearchParams } from "node:url";
2
- import { fetchListResult, fetchResult, fetchKVGetValue } from "./cfetch";
3
- import { logger } from "./logger";
4
- import type { Config } from "./config";
5
-
6
- /** The largest number of kv items we can pass to the API in a single request. */
7
- const API_MAX = 10000;
8
- // The const below are halved from the API's true capacity to help avoid
9
- // hammering it with large requests.
10
- const BATCH_KEY_MAX = API_MAX / 2;
11
-
12
- type KvArgs = {
13
- binding?: string;
14
- "namespace-id"?: string;
15
- preview?: boolean;
16
- };
17
-
18
- /**
19
- * Create a new namespace under the given `accountId` with the given `title`.
20
- *
21
- * @returns the generated id of the created namespace.
22
- */
23
- export async function createKVNamespace(
24
- accountId: string,
25
- title: string
26
- ): Promise<string> {
27
- const response = await fetchResult<{ id: string }>(
28
- `/accounts/${accountId}/storage/kv/namespaces`,
29
- {
30
- method: "POST",
31
- headers: {
32
- "Content-Type": "application/json",
33
- },
34
- body: JSON.stringify({
35
- title,
36
- }),
37
- }
38
- );
39
-
40
- return response.id;
41
- }
42
-
43
- /**
44
- * The information about a namespace that is returned from `listNamespaces()`.
45
- */
46
- export interface KVNamespaceInfo {
47
- id: string;
48
- title: string;
49
- supports_url_encoding?: boolean;
50
- }
51
-
52
- /**
53
- * Fetch a list of all the namespaces under the given `accountId`.
54
- */
55
- export async function listKVNamespaces(
56
- accountId: string
57
- ): Promise<KVNamespaceInfo[]> {
58
- const pageSize = 100;
59
- let page = 1;
60
- const results: KVNamespaceInfo[] = [];
61
- while (results.length % pageSize === 0) {
62
- const json = await fetchResult<KVNamespaceInfo[]>(
63
- `/accounts/${accountId}/storage/kv/namespaces`,
64
- {},
65
- new URLSearchParams({
66
- per_page: pageSize.toString(),
67
- order: "title",
68
- direction: "asc",
69
- page: page.toString(),
70
- })
71
- );
72
- page++;
73
- results.push(...json);
74
- if (json.length < pageSize) {
75
- break;
76
- }
77
- }
78
- return results;
79
- }
80
-
81
- export interface NamespaceKeyInfo {
82
- name: string;
83
- expiration?: number;
84
- metadata?: { [key: string]: unknown };
85
- }
86
-
87
- export async function listKVNamespaceKeys(
88
- accountId: string,
89
- namespaceId: string,
90
- prefix = ""
91
- ) {
92
- return await fetchListResult<NamespaceKeyInfo>(
93
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/keys`,
94
- {},
95
- new URLSearchParams({ prefix })
96
- );
97
- }
98
-
99
- export async function deleteKVNamespace(
100
- accountId: string,
101
- namespaceId: string
102
- ) {
103
- return await fetchResult<{ id: string }>(
104
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}`,
105
- { method: "DELETE" }
106
- );
107
- }
108
-
109
- /**
110
- * Information about a key-value pair, including its "metadata" fields.
111
- */
112
- export interface KeyValue {
113
- key: string;
114
- value: string;
115
- expiration?: number;
116
- expiration_ttl?: number;
117
- metadata?: object;
118
- base64?: boolean;
119
- }
120
-
121
- const KeyValueKeys = new Set([
122
- "key",
123
- "value",
124
- "expiration",
125
- "expiration_ttl",
126
- "metadata",
127
- "base64",
128
- ]);
129
-
130
- /**
131
- * The object has the specified property.
132
- */
133
- function hasProperty<T extends object>(
134
- obj: object,
135
- property: keyof T
136
- ): obj is T {
137
- return property in obj;
138
- }
139
-
140
- /**
141
- * The object has a required property of the specified type.
142
- */
143
- function hasTypedProperty<T extends object>(
144
- obj: object,
145
- property: keyof T,
146
- type: string
147
- ): obj is T {
148
- return hasProperty(obj, property) && typeof obj[property] === type;
149
- }
150
-
151
- /**
152
- * The object an optional property, of the specified type.
153
- */
154
- function hasOptionalTypedProperty<T extends object>(
155
- obj: object,
156
- property: keyof T,
157
- type: string
158
- ): obj is Omit<T, typeof property> | T {
159
- return !hasProperty(obj, property) || typeof obj[property] === type;
160
- }
161
-
162
- /**
163
- * Is the given object a valid `KeyValue` type?
164
- */
165
- export function isKVKeyValue(keyValue: unknown): keyValue is KeyValue {
166
- if (
167
- keyValue === null ||
168
- typeof keyValue !== "object" ||
169
- !hasTypedProperty(keyValue, "key", "string") ||
170
- !hasTypedProperty(keyValue, "value", "string") ||
171
- !hasOptionalTypedProperty(keyValue, "expiration", "number") ||
172
- !hasOptionalTypedProperty(keyValue, "expiration_ttl", "number") ||
173
- !hasOptionalTypedProperty(keyValue, "base64", "boolean") ||
174
- !hasOptionalTypedProperty(keyValue, "metadata", "object")
175
- ) {
176
- return false;
177
- }
178
- return true;
179
- }
180
-
181
- /**
182
- * Get all the properties on the `keyValue` that are not expected.
183
- */
184
- export function unexpectedKVKeyValueProps(keyValue: KeyValue): string[] {
185
- const props = Object.keys(keyValue);
186
- return props.filter((prop) => !KeyValueKeys.has(prop));
187
- }
188
-
189
- export async function putKVKeyValue(
190
- accountId: string,
191
- namespaceId: string,
192
- keyValue: KeyValue
193
- ) {
194
- let searchParams: URLSearchParams | undefined;
195
- if (keyValue.expiration || keyValue.expiration_ttl) {
196
- searchParams = new URLSearchParams();
197
- if (keyValue.expiration) {
198
- searchParams.set("expiration", `${keyValue.expiration}`);
199
- }
200
- if (keyValue.expiration_ttl) {
201
- searchParams.set("expiration_ttl", `${keyValue.expiration_ttl}`);
202
- }
203
- }
204
- return await fetchResult(
205
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
206
- keyValue.key
207
- )}`,
208
- { method: "PUT", body: keyValue.value },
209
- searchParams
210
- );
211
- }
212
-
213
- export async function getKVKeyValue(
214
- accountId: string,
215
- namespaceId: string,
216
- key: string
217
- ): Promise<string> {
218
- return await fetchKVGetValue(accountId, namespaceId, encodeURIComponent(key));
219
- }
220
-
221
- export async function deleteKVKeyValue(
222
- accountId: string,
223
- namespaceId: string,
224
- key: string
225
- ) {
226
- return await fetchResult(
227
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
228
- key
229
- )}`,
230
- { method: "DELETE" }
231
- );
232
- }
233
-
234
- /**
235
- * Formatter for converting e.g. 5328 --> 5,328
236
- */
237
- const formatNumber = new Intl.NumberFormat("en-US", {
238
- notation: "standard",
239
- }).format;
240
-
241
- /**
242
- * Helper function for bulk requests, logs ongoing output to console.
243
- */
244
- function logBulkProgress(
245
- operation: "put" | "delete",
246
- index: number,
247
- total: number
248
- ) {
249
- logger.log(
250
- `${operation === "put" ? "Uploaded" : "Deleted"} ${Math.floor(
251
- (100 * index) / total
252
- )}% (${formatNumber(index)} out of ${formatNumber(total)})`
253
- );
254
- }
255
-
256
- export async function putKVBulkKeyValue(
257
- accountId: string,
258
- namespaceId: string,
259
- keyValues: KeyValue[],
260
- quiet = false
261
- ) {
262
- for (let index = 0; index < keyValues.length; index += BATCH_KEY_MAX) {
263
- if (!quiet && keyValues.length > BATCH_KEY_MAX) {
264
- logBulkProgress("put", index, keyValues.length);
265
- }
266
-
267
- await fetchResult(
268
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
269
- {
270
- method: "PUT",
271
- body: JSON.stringify(keyValues.slice(index, index + BATCH_KEY_MAX)),
272
- headers: { "Content-Type": "application/json" },
273
- }
274
- );
275
- }
276
-
277
- if (!quiet && keyValues.length > BATCH_KEY_MAX) {
278
- logBulkProgress("put", keyValues.length, keyValues.length);
279
- }
280
- }
281
-
282
- export async function deleteKVBulkKeyValue(
283
- accountId: string,
284
- namespaceId: string,
285
- keys: string[],
286
- quiet = false
287
- ) {
288
- for (let index = 0; index < keys.length; index += BATCH_KEY_MAX) {
289
- if (!quiet && keys.length > BATCH_KEY_MAX) {
290
- logBulkProgress("delete", index, keys.length);
291
- }
292
-
293
- await fetchResult(
294
- `/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
295
- {
296
- method: "DELETE",
297
- body: JSON.stringify(keys.slice(index, index + BATCH_KEY_MAX)),
298
- headers: { "Content-Type": "application/json" },
299
- }
300
- );
301
- }
302
- if (!quiet && keys.length > BATCH_KEY_MAX) {
303
- logBulkProgress("delete", keys.length, keys.length);
304
- }
305
- }
306
-
307
- export function getKVNamespaceId(
308
- { preview, binding, "namespace-id": namespaceId }: KvArgs,
309
- config: Config
310
- ): string {
311
- // nice
312
- if (namespaceId) {
313
- return namespaceId;
314
- }
315
-
316
- // begin pre-flight checks
317
-
318
- // `--binding` is only valid if there's a wrangler configuration.
319
- if (binding && !config) {
320
- throw new Error("--binding specified, but no config file was found.");
321
- }
322
-
323
- // there's no config. abort here
324
- if (!config) {
325
- throw new Error(
326
- "Failed to find a config file.\n" +
327
- "Either use --namespace-id to upload directly or create a configuration file with a binding."
328
- );
329
- }
330
-
331
- // there's no KV namespaces
332
- if (!config.kv_namespaces || config.kv_namespaces.length === 0) {
333
- throw new Error(
334
- "No KV Namespaces configured! Either use --namespace-id to upload directly or add a KV namespace to your wrangler config file."
335
- );
336
- }
337
-
338
- const namespace = config.kv_namespaces.find((ns) => ns.binding === binding);
339
-
340
- // we couldn't find a namespace with that binding
341
- if (!namespace) {
342
- throw new Error(
343
- `A namespace with binding name "${binding}" was not found in the configured "kv_namespaces".`
344
- );
345
- }
346
-
347
- // end pre-flight checks
348
-
349
- // we're in preview mode, `--preview true` or `--preview` was passed
350
- if (preview && namespace.preview_id) {
351
- namespaceId = namespace.preview_id;
352
- // We don't want to execute code below if preview is set to true, so we just return. Otherwise we will get errors!
353
- return namespaceId;
354
- } else if (preview) {
355
- throw new Error(
356
- `No preview ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
357
- );
358
- }
359
-
360
- // either `--preview false`, or preview wasn't passed
361
- // TODO: should we care? or should we just treat false and undefined the same
362
- const previewIsDefined = typeof preview !== "undefined";
363
-
364
- // --preview false was passed
365
- if (previewIsDefined && namespace.id) {
366
- namespaceId = namespace.id;
367
- // We don't want to execute code below if preview is set to true, so we just return. Otherwise we can get error!
368
- return namespaceId;
369
- } else if (previewIsDefined) {
370
- throw new Error(
371
- `No namespace ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
372
- );
373
- }
374
-
375
- // `--preview` wasn't passed
376
- const bindingHasOnlyOneId =
377
- (namespace.id && !namespace.preview_id) ||
378
- (!namespace.id && namespace.preview_id);
379
- if (bindingHasOnlyOneId) {
380
- namespaceId = namespace.id || namespace.preview_id;
381
- } else {
382
- throw new Error(
383
- `${binding} has both a namespace ID and a preview ID. Specify "--preview" or "--preview false" to avoid writing data to the wrong namespace.`
384
- );
385
- }
386
-
387
- // shouldn't happen. we should be able to prove this with strong typing.
388
- // TODO: when we add strongly typed commands, rewrite these checks so they're exhaustive
389
- if (!namespaceId) {
390
- throw Error(
391
- "Something went wrong trying to determine which namespace to upload to.\n" +
392
- "Please create a github issue with the command you just ran along with your wrangler configuration."
393
- );
394
- }
395
-
396
- return namespaceId;
397
- }
398
-
399
- /**
400
- * KV namespace binding names must be valid JS identifiers.
401
- */
402
- export function isValidKVNamespaceBinding(
403
- binding: string | undefined
404
- ): binding is string {
405
- return (
406
- typeof binding === "string" && /^[a-zA-Z_][a-zA-Z0-9_]*$/.test(binding)
407
- );
408
- }