wrangler 0.0.0-e64812e → 0.0.0-e6c9c5c0

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 (338) hide show
  1. package/README.md +23 -3
  2. package/bin/wrangler.js +170 -62
  3. package/kv-asset-handler.js +1 -0
  4. package/miniflare-dist/index.mjs +1499 -21
  5. package/package.json +193 -152
  6. package/src/__tests__/access.test.ts +25 -0
  7. package/src/__tests__/api-dev.test.ts +238 -0
  8. package/src/__tests__/api-devregistry.test.js +64 -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 +4152 -3363
  13. package/src/__tests__/d1/d1.test.ts +127 -0
  14. package/src/__tests__/d1/splitter.test.ts +255 -0
  15. package/src/__tests__/delete.test.ts +266 -0
  16. package/src/__tests__/deployments.test.ts +105 -0
  17. package/src/__tests__/dev.test.tsx +1558 -952
  18. package/src/__tests__/generate.test.ts +238 -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-auth-domain.ts +20 -0
  24. package/src/__tests__/helpers/mock-bin.ts +20 -20
  25. package/src/__tests__/helpers/mock-console.ts +58 -39
  26. package/src/__tests__/helpers/mock-dialogs.ts +88 -79
  27. package/src/__tests__/helpers/mock-get-zone-from-host.ts +11 -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 +12 -0
  31. package/src/__tests__/helpers/mock-kv.ts +41 -28
  32. package/src/__tests__/helpers/mock-oauth-flow.ts +241 -233
  33. package/src/__tests__/helpers/mock-process.ts +34 -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/blob-worker.cjs +19 -0
  37. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  38. package/src/__tests__/helpers/msw/handlers/deployments.ts +69 -0
  39. package/src/__tests__/helpers/msw/handlers/namespaces.ts +81 -0
  40. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  41. package/src/__tests__/helpers/msw/handlers/r2.ts +60 -0
  42. package/src/__tests__/helpers/msw/handlers/script.ts +56 -0
  43. package/src/__tests__/helpers/msw/handlers/user.ts +52 -0
  44. package/src/__tests__/helpers/msw/handlers/zones.ts +20 -0
  45. package/src/__tests__/helpers/msw/index.ts +50 -0
  46. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  47. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  48. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  49. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  50. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  51. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  52. package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
  53. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  54. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  55. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  56. package/src/__tests__/https-options.test.ts +142 -109
  57. package/src/__tests__/index.test.ts +245 -233
  58. package/src/__tests__/init.test.ts +3135 -1605
  59. package/src/__tests__/jest.setup.ts +148 -50
  60. package/src/__tests__/kv.test.ts +1778 -1471
  61. package/src/__tests__/logger.test.ts +100 -74
  62. package/src/__tests__/logout.test.ts +47 -0
  63. package/src/__tests__/metrics.test.ts +493 -0
  64. package/src/__tests__/middleware.scheduled.test.ts +145 -0
  65. package/src/__tests__/middleware.test.ts +750 -0
  66. package/src/__tests__/package-manager.test.ts +303 -303
  67. package/src/__tests__/pages-deployment-tail.test.ts +955 -0
  68. package/src/__tests__/pages.test.ts +2887 -743
  69. package/src/__tests__/parse.test.ts +252 -252
  70. package/src/__tests__/paths.test.ts +39 -0
  71. package/src/__tests__/publish.test.ts +8004 -5355
  72. package/src/__tests__/pubsub.test.ts +490 -0
  73. package/src/__tests__/queues.test.ts +522 -0
  74. package/src/__tests__/r2.test.ts +364 -228
  75. package/src/__tests__/route.test.ts +18 -18
  76. package/src/__tests__/secret.test.ts +681 -469
  77. package/src/__tests__/tail.test.ts +835 -567
  78. package/src/__tests__/test-old-node-version.js +31 -0
  79. package/src/__tests__/tsconfig-sanity.ts +12 -0
  80. package/src/__tests__/tsconfig.json +8 -0
  81. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  82. package/src/__tests__/type-generation.test.ts +233 -0
  83. package/src/__tests__/user.test.ts +107 -120
  84. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  85. package/src/__tests__/validate-dev-props.test.ts +56 -0
  86. package/src/__tests__/version.test.ts +35 -0
  87. package/src/__tests__/whoami.test.tsx +165 -98
  88. package/src/__tests__/worker-namespace.test.ts +334 -0
  89. package/src/abort.d.ts +1 -1
  90. package/src/api/dev.ts +259 -0
  91. package/src/api/index.ts +3 -0
  92. package/src/api/pages/index.ts +5 -0
  93. package/src/api/pages/publish.tsx +321 -0
  94. package/src/bundle-reporter.ts +68 -0
  95. package/src/bundle.ts +838 -163
  96. package/src/cfetch/index.ts +120 -83
  97. package/src/cfetch/internal.ts +210 -97
  98. package/src/cli.ts +23 -8
  99. package/src/config/config.ts +236 -195
  100. package/src/config/diagnostics.ts +61 -61
  101. package/src/config/environment.ts +516 -357
  102. package/src/config/index.ts +326 -193
  103. package/src/config/validation-helpers.ts +379 -357
  104. package/src/config/validation.ts +1979 -1367
  105. package/src/config-cache.ts +81 -41
  106. package/src/create-worker-preview.ts +239 -142
  107. package/src/create-worker-upload-form.ts +309 -238
  108. package/src/d1/backups.tsx +219 -0
  109. package/src/d1/constants.ts +2 -0
  110. package/src/d1/create.tsx +63 -0
  111. package/src/d1/delete.ts +56 -0
  112. package/src/d1/execute.tsx +323 -0
  113. package/src/d1/formatTimeAgo.ts +14 -0
  114. package/src/d1/index.ts +101 -0
  115. package/src/d1/list.tsx +48 -0
  116. package/src/d1/migrations/apply.tsx +197 -0
  117. package/src/d1/migrations/create.tsx +77 -0
  118. package/src/d1/migrations/helpers.ts +147 -0
  119. package/src/d1/migrations/index.ts +3 -0
  120. package/src/d1/migrations/list.tsx +79 -0
  121. package/src/d1/migrations/options.ts +18 -0
  122. package/src/d1/options.ts +22 -0
  123. package/src/d1/splitter.ts +161 -0
  124. package/src/d1/types.ts +24 -0
  125. package/src/d1/utils.ts +48 -0
  126. package/src/delete.ts +103 -0
  127. package/src/deployments.ts +93 -0
  128. package/src/deprecated/index.ts +145 -0
  129. package/src/dev/dev-vars.ts +20 -17
  130. package/src/dev/dev.tsx +547 -352
  131. package/src/dev/get-local-persistence-path.ts +31 -0
  132. package/src/dev/local.tsx +903 -298
  133. package/src/dev/remote.tsx +620 -215
  134. package/src/dev/start-server.ts +538 -0
  135. package/src/dev/use-esbuild.ts +184 -97
  136. package/src/dev/validate-dev-props.ts +31 -0
  137. package/src/dev-registry.ts +201 -0
  138. package/src/dev.tsx +949 -0
  139. package/src/dialogs.ts +136 -0
  140. package/src/dispatch-namespace.ts +207 -0
  141. package/src/docs/index.ts +98 -0
  142. package/src/durable.ts +87 -87
  143. package/src/entry.ts +236 -230
  144. package/src/environment-variables/factory.ts +88 -0
  145. package/src/environment-variables/misc-variables.ts +30 -0
  146. package/src/errors.ts +6 -6
  147. package/src/generate/index.ts +300 -0
  148. package/src/git-client.ts +135 -0
  149. package/src/global-wrangler-config-path.ts +26 -0
  150. package/src/https-options.ts +84 -80
  151. package/src/index.ts +694 -0
  152. package/src/init.ts +1024 -0
  153. package/src/inspect.ts +698 -593
  154. package/src/intl-polyfill.d.ts +123 -123
  155. package/src/is-ci.ts +14 -0
  156. package/src/is-interactive.ts +16 -0
  157. package/src/jest.d.ts +4 -0
  158. package/src/kv/helpers.ts +430 -0
  159. package/src/kv/index.ts +596 -0
  160. package/src/logger.ts +80 -42
  161. package/src/metrics/index.ts +5 -0
  162. package/src/metrics/metrics-config.ts +239 -0
  163. package/src/metrics/metrics-dispatcher.ts +96 -0
  164. package/src/metrics/metrics-usage-headers.ts +24 -0
  165. package/src/metrics/send-event.ts +98 -0
  166. package/src/miniflare-cli/assets.ts +250 -0
  167. package/src/miniflare-cli/index.ts +202 -33
  168. package/src/miniflare-cli/request-context.ts +18 -18
  169. package/src/miniflare-cli/tsconfig.json +9 -0
  170. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  171. package/src/miniflare-cli/types.ts +11 -0
  172. package/src/module-collection.ts +221 -212
  173. package/src/open-in-browser.ts +4 -6
  174. package/src/package-manager.ts +173 -128
  175. package/src/pages/build.ts +150 -0
  176. package/src/pages/buildFunctions.ts +129 -0
  177. package/src/pages/constants.ts +18 -0
  178. package/src/pages/deployment-tails.ts +284 -0
  179. package/src/pages/deployments.tsx +84 -0
  180. package/src/pages/dev.ts +716 -0
  181. package/src/pages/errors.ts +66 -0
  182. package/src/pages/functions/buildPlugin.ts +90 -0
  183. package/src/pages/functions/buildWorker.ts +288 -0
  184. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  185. package/src/pages/functions/filepath-routing.ts +189 -0
  186. package/src/pages/functions/identifiers.ts +78 -0
  187. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  188. package/src/pages/functions/routes-consolidation.ts +73 -0
  189. package/src/pages/functions/routes-transformation.test.ts +282 -0
  190. package/src/pages/functions/routes-transformation.ts +115 -0
  191. package/src/pages/functions/routes-validation.test.ts +403 -0
  192. package/src/pages/functions/routes-validation.ts +202 -0
  193. package/src/pages/functions/routes.ts +151 -0
  194. package/src/pages/functions/tsconfig.json +8 -0
  195. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  196. package/src/pages/functions.ts +82 -0
  197. package/src/pages/hash.ts +13 -0
  198. package/src/pages/index.ts +102 -0
  199. package/src/pages/projects.tsx +167 -0
  200. package/src/pages/prompt-select-project.tsx +31 -0
  201. package/src/pages/publish.tsx +263 -0
  202. package/src/pages/types.ts +41 -0
  203. package/src/pages/upload.tsx +447 -0
  204. package/src/pages/utils.ts +23 -0
  205. package/src/parse.ts +209 -125
  206. package/src/paths.ts +53 -8
  207. package/src/proxy.ts +623 -394
  208. package/src/publish/index.ts +270 -0
  209. package/src/publish/publish.ts +1064 -0
  210. package/src/pubsub/index.ts +286 -0
  211. package/src/pubsub/pubsub-commands.ts +624 -0
  212. package/src/queues/cli/commands/consumer/add.ts +71 -0
  213. package/src/queues/cli/commands/consumer/index.ts +22 -0
  214. package/src/queues/cli/commands/consumer/remove.ts +38 -0
  215. package/src/queues/cli/commands/create.ts +25 -0
  216. package/src/queues/cli/commands/delete.ts +26 -0
  217. package/src/queues/cli/commands/index.ts +36 -0
  218. package/src/queues/cli/commands/list.ts +25 -0
  219. package/src/queues/client.ts +135 -0
  220. package/src/queues/utils.ts +18 -0
  221. package/src/r2/constants.ts +4 -0
  222. package/src/r2/helpers.ts +131 -0
  223. package/src/r2/index.ts +289 -0
  224. package/src/routes.ts +140 -0
  225. package/src/secret/index.ts +379 -0
  226. package/src/selfsigned.d.ts +23 -23
  227. package/src/sites.ts +372 -0
  228. package/src/tail/createTail.ts +406 -0
  229. package/src/tail/filters.ts +108 -110
  230. package/src/tail/index.ts +210 -296
  231. package/src/tail/printing.ts +101 -46
  232. package/src/tsconfig-sanity.ts +16 -0
  233. package/src/type-generation.ts +181 -0
  234. package/src/update-check.ts +11 -11
  235. package/src/user/access.ts +68 -0
  236. package/src/user/auth-variables.ts +113 -0
  237. package/src/user/choose-account.tsx +39 -0
  238. package/src/user/generate-auth-url.ts +33 -0
  239. package/src/user/generate-random-state.ts +16 -0
  240. package/src/user/index.ts +2 -0
  241. package/src/user/user.ts +1232 -0
  242. package/src/utils/collectKeyValues.ts +14 -0
  243. package/src/whoami.ts +135 -0
  244. package/src/worker.ts +177 -106
  245. package/src/yargs-types.ts +24 -0
  246. package/src/zones.ts +191 -0
  247. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  248. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  249. package/templates/__tests__/tsconfig.json +8 -0
  250. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  251. package/templates/checked-fetch.js +15 -0
  252. package/templates/d1-beta-facade.js +241 -0
  253. package/templates/facade.d.ts +14 -0
  254. package/templates/first-party-worker-module-facade.ts +19 -0
  255. package/templates/format-dev-errors.ts +33 -0
  256. package/templates/init-tests/test-jest-new-worker.js +23 -0
  257. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  258. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  259. package/templates/middleware/common.ts +62 -0
  260. package/templates/middleware/loader-modules.ts +84 -0
  261. package/templates/middleware/loader-sw.ts +233 -0
  262. package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
  263. package/templates/middleware/middleware-pretty-error.ts +40 -0
  264. package/templates/middleware/middleware-scheduled.ts +15 -0
  265. package/templates/new-worker-scheduled.js +3 -3
  266. package/templates/new-worker-scheduled.ts +15 -15
  267. package/templates/new-worker.js +3 -3
  268. package/templates/new-worker.ts +15 -15
  269. package/templates/no-op-worker.js +10 -0
  270. package/templates/pages-dev-pipeline.ts +31 -0
  271. package/templates/pages-dev-util.ts +52 -0
  272. package/templates/pages-shim.ts +12 -0
  273. package/templates/pages-template-plugin.ts +176 -0
  274. package/templates/pages-template-worker.ts +189 -0
  275. package/templates/serve-static-assets.ts +65 -0
  276. package/templates/service-bindings-module-facade.js +54 -0
  277. package/templates/service-bindings-sw-facade.js +42 -0
  278. package/templates/tsconfig-sanity.ts +11 -0
  279. package/templates/tsconfig.init.json +106 -0
  280. package/templates/tsconfig.json +6 -103
  281. package/templates/tsconfig.tsbuildinfo +1 -0
  282. package/wrangler-dist/cli.d.ts +1028 -0
  283. package/wrangler-dist/cli.js +129259 -110922
  284. package/wrangler-dist/wasm-sync.wasm +0 -0
  285. package/pages/functions/buildPlugin.ts +0 -105
  286. package/pages/functions/buildWorker.ts +0 -151
  287. package/pages/functions/filepath-routing.ts +0 -189
  288. package/pages/functions/identifiers.ts +0 -78
  289. package/pages/functions/routes.ts +0 -156
  290. package/pages/functions/template-plugin.ts +0 -147
  291. package/pages/functions/template-worker.ts +0 -143
  292. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  293. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  294. package/src/dialogs.tsx +0 -135
  295. package/src/environment-variables.ts +0 -35
  296. package/src/index.tsx +0 -2864
  297. package/src/kv.ts +0 -408
  298. package/src/miniflare-cli/enum-keys.ts +0 -17
  299. package/src/pages.tsx +0 -2038
  300. package/src/publish.ts +0 -583
  301. package/src/r2.ts +0 -50
  302. package/src/sites.tsx +0 -295
  303. package/src/user.tsx +0 -1203
  304. package/src/whoami.tsx +0 -70
  305. package/templates/static-asset-facade.js +0 -47
  306. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  307. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  308. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  309. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  310. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  311. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  312. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  313. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  314. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  315. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  316. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  317. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  318. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  319. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  320. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  321. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  322. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  323. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  324. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  325. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  326. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  327. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  328. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  329. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  330. package/vendor/wrangler-mime/LICENSE +0 -21
  331. package/vendor/wrangler-mime/Mime.js +0 -97
  332. package/vendor/wrangler-mime/README.md +0 -187
  333. package/vendor/wrangler-mime/cli.js +0 -46
  334. package/vendor/wrangler-mime/index.js +0 -4
  335. package/vendor/wrangler-mime/lite.js +0 -4
  336. package/vendor/wrangler-mime/package.json +0 -52
  337. package/vendor/wrangler-mime/types/other.js +0 -1
  338. package/vendor/wrangler-mime/types/standard.js +0 -1
@@ -1,141 +1,141 @@
1
1
  import { writeFileSync, mkdirSync } from "fs";
2
- import { runInTempDir } from "../../src/__tests__/helpers/run-in-tmp";
3
- import { toUrlPath } from "../../src/paths";
2
+ import { runInTempDir } from "../../__tests__/helpers/run-in-tmp";
3
+ import { toUrlPath } from "../../paths";
4
4
  import { compareRoutes, generateConfigFromFileTree } from "./filepath-routing";
5
- import type { UrlPath } from "../../src/paths";
5
+ import type { UrlPath } from "../../paths";
6
6
  import type { HTTPMethod, RouteConfig } from "./routes";
7
7
 
8
8
  describe("filepath-routing", () => {
9
- describe("compareRoutes()", () => {
10
- test("routes / last", () => {
11
- expect(
12
- compareRoutes(routeConfig("/"), routeConfig("/foo"))
13
- ).toBeGreaterThanOrEqual(1);
14
- expect(
15
- compareRoutes(routeConfig("/"), routeConfig("/:foo"))
16
- ).toBeGreaterThanOrEqual(1);
17
- expect(
18
- compareRoutes(routeConfig("/"), routeConfig("/:foo*"))
19
- ).toBeGreaterThanOrEqual(1);
20
- });
21
-
22
- test("routes with fewer segments come after those with more segments", () => {
23
- expect(
24
- compareRoutes(routeConfig("/foo"), routeConfig("/foo/bar"))
25
- ).toBeGreaterThanOrEqual(1);
26
- expect(
27
- compareRoutes(routeConfig("/foo"), routeConfig("/foo/bar/cat"))
28
- ).toBeGreaterThanOrEqual(1);
29
- });
30
-
31
- test("routes with wildcard segments come after those without", () => {
32
- expect(compareRoutes(routeConfig("/:foo*"), routeConfig("/foo"))).toBe(1);
33
- expect(compareRoutes(routeConfig("/:foo*"), routeConfig("/:foo"))).toBe(
34
- 1
35
- );
36
- });
37
-
38
- test("routes with dynamic segments come after those without", () => {
39
- expect(compareRoutes(routeConfig("/:foo"), routeConfig("/foo"))).toBe(1);
40
- });
41
-
42
- test("routes with dynamic segments occurring earlier come after those with dynamic segments in later positions", () => {
43
- expect(
44
- compareRoutes(routeConfig("/foo/:id/bar"), routeConfig("/foo/bar/:id"))
45
- ).toBe(1);
46
- });
47
-
48
- test("routes with no HTTP method come after those specifying a method", () => {
49
- expect(
50
- compareRoutes(routeConfig("/foo"), routeConfig("/foo", "GET"))
51
- ).toBe(1);
52
- });
53
-
54
- test("two equal routes are sorted according to their original position in the list", () => {
55
- expect(
56
- compareRoutes(routeConfig("/foo", "GET"), routeConfig("/foo", "GET"))
57
- ).toBe(0);
58
- });
59
-
60
- test("it returns -1 if the first argument should appear first in the list", () => {
61
- expect(
62
- compareRoutes(routeConfig("/foo", "GET"), routeConfig("/foo"))
63
- ).toBe(-1);
64
- });
65
- });
66
-
67
- describe("generateConfigFromFileTree", () => {
68
- runInTempDir();
69
-
70
- it("should generate a route entry for each file in the tree", async () => {
71
- writeFileSync(
72
- "foo.ts",
73
- `
9
+ describe("compareRoutes()", () => {
10
+ test("routes / last", () => {
11
+ expect(
12
+ compareRoutes(routeConfig("/"), routeConfig("/foo"))
13
+ ).toBeGreaterThanOrEqual(1);
14
+ expect(
15
+ compareRoutes(routeConfig("/"), routeConfig("/:foo"))
16
+ ).toBeGreaterThanOrEqual(1);
17
+ expect(
18
+ compareRoutes(routeConfig("/"), routeConfig("/:foo*"))
19
+ ).toBeGreaterThanOrEqual(1);
20
+ });
21
+
22
+ test("routes with fewer segments come after those with more segments", () => {
23
+ expect(
24
+ compareRoutes(routeConfig("/foo"), routeConfig("/foo/bar"))
25
+ ).toBeGreaterThanOrEqual(1);
26
+ expect(
27
+ compareRoutes(routeConfig("/foo"), routeConfig("/foo/bar/cat"))
28
+ ).toBeGreaterThanOrEqual(1);
29
+ });
30
+
31
+ test("routes with wildcard segments come after those without", () => {
32
+ expect(compareRoutes(routeConfig("/:foo*"), routeConfig("/foo"))).toBe(1);
33
+ expect(compareRoutes(routeConfig("/:foo*"), routeConfig("/:foo"))).toBe(
34
+ 1
35
+ );
36
+ });
37
+
38
+ test("routes with dynamic segments come after those without", () => {
39
+ expect(compareRoutes(routeConfig("/:foo"), routeConfig("/foo"))).toBe(1);
40
+ });
41
+
42
+ test("routes with dynamic segments occurring earlier come after those with dynamic segments in later positions", () => {
43
+ expect(
44
+ compareRoutes(routeConfig("/foo/:id/bar"), routeConfig("/foo/bar/:id"))
45
+ ).toBe(1);
46
+ });
47
+
48
+ test("routes with no HTTP method come after those specifying a method", () => {
49
+ expect(
50
+ compareRoutes(routeConfig("/foo"), routeConfig("/foo", "GET"))
51
+ ).toBe(1);
52
+ });
53
+
54
+ test("two equal routes are sorted according to their original position in the list", () => {
55
+ expect(
56
+ compareRoutes(routeConfig("/foo", "GET"), routeConfig("/foo", "GET"))
57
+ ).toBe(0);
58
+ });
59
+
60
+ test("it returns -1 if the first argument should appear first in the list", () => {
61
+ expect(
62
+ compareRoutes(routeConfig("/foo", "GET"), routeConfig("/foo"))
63
+ ).toBe(-1);
64
+ });
65
+ });
66
+
67
+ describe("generateConfigFromFileTree", () => {
68
+ runInTempDir();
69
+
70
+ it("should generate a route entry for each file in the tree", async () => {
71
+ writeFileSync(
72
+ "foo.ts",
73
+ `
74
74
  export function onRequestGet() {}
75
75
  export function onRequestPost() {}
76
76
  `
77
- );
78
- writeFileSync(
79
- "bar.ts",
80
- `
77
+ );
78
+ writeFileSync(
79
+ "bar.ts",
80
+ `
81
81
  export function onRequestPut() {}
82
82
  export function onRequestDelete() {}
83
83
  `
84
- );
84
+ );
85
85
 
86
- mkdirSync("todos");
86
+ mkdirSync("todos");
87
87
 
88
- writeFileSync(
89
- "todos/[id].ts",
90
- `
88
+ writeFileSync(
89
+ "todos/[id].ts",
90
+ `
91
91
  export function onRequestPost() {}
92
92
  export function onRequestDelete() {}
93
93
  `
94
- );
94
+ );
95
95
 
96
- mkdirSync("authors");
97
- mkdirSync("authors/[authorId]");
98
- mkdirSync("authors/[authorId]/todos");
96
+ mkdirSync("authors");
97
+ mkdirSync("authors/[authorId]");
98
+ mkdirSync("authors/[authorId]/todos");
99
99
 
100
- writeFileSync(
101
- "authors/[authorId]/todos/[todoId].ts",
102
- `
100
+ writeFileSync(
101
+ "authors/[authorId]/todos/[todoId].ts",
102
+ `
103
103
  export function onRequestPost() {}
104
104
  `
105
- );
105
+ );
106
106
 
107
- mkdirSync("books");
107
+ mkdirSync("books");
108
108
 
109
- writeFileSync(
110
- "books/[[title]].ts",
111
- `
109
+ writeFileSync(
110
+ "books/[[title]].ts",
111
+ `
112
112
  export function onRequestPost() {}
113
113
  `
114
- );
114
+ );
115
115
 
116
- mkdirSync("cats");
117
- mkdirSync("cats/[[breed]]");
116
+ mkdirSync("cats");
117
+ mkdirSync("cats/[[breed]]");
118
118
 
119
- writeFileSync(
120
- "cats/[[breed]]/blah.ts",
121
- `
119
+ writeFileSync(
120
+ "cats/[[breed]]/blah.ts",
121
+ `
122
122
  export function onRequestPost() {}
123
123
  `
124
- );
124
+ );
125
125
 
126
- // This won't actually work at runtime.
127
- writeFileSync(
128
- "cats/[[breed]]/[[name]].ts",
129
- `
126
+ // This won't actually work at runtime.
127
+ writeFileSync(
128
+ "cats/[[breed]]/[[name]].ts",
129
+ `
130
130
  export function onRequestPost() {}
131
131
  `
132
- );
132
+ );
133
133
 
134
- const entries = await generateConfigFromFileTree({
135
- baseDir: ".",
136
- baseURL: "/base" as UrlPath,
137
- });
138
- expect(entries).toMatchInlineSnapshot(`
134
+ const entries = await generateConfigFromFileTree({
135
+ baseDir: ".",
136
+ baseURL: "/base" as UrlPath,
137
+ });
138
+ expect(entries).toMatchInlineSnapshot(`
139
139
  Object {
140
140
  "routes": Array [
141
141
  Object {
@@ -221,14 +221,14 @@ describe("filepath-routing", () => {
221
221
  ],
222
222
  }
223
223
  `);
224
- });
225
- });
224
+ });
225
+ });
226
226
  });
227
227
 
228
228
  function routeConfig(routePath: string, method?: string): RouteConfig {
229
- return {
230
- routePath: toUrlPath(routePath),
231
- mountPath: toUrlPath("/"),
232
- method: method as HTTPMethod,
233
- };
229
+ return {
230
+ routePath: toUrlPath(routePath),
231
+ mountPath: toUrlPath("/"),
232
+ method: method as HTTPMethod,
233
+ };
234
234
  }
@@ -0,0 +1,189 @@
1
+ import fs from "node:fs/promises";
2
+ import path from "node:path";
3
+ import { build } from "esbuild";
4
+ import { toUrlPath } from "../../paths";
5
+ import type { UrlPath } from "../../paths";
6
+ import type { HTTPMethod, RouteConfig } from "./routes";
7
+
8
+ export async function generateConfigFromFileTree({
9
+ baseDir,
10
+ baseURL,
11
+ }: {
12
+ baseDir: string;
13
+ baseURL: UrlPath;
14
+ }) {
15
+ let routeEntries: RouteConfig[] = [];
16
+
17
+ if (!baseURL.startsWith("/")) {
18
+ baseURL = `/${baseURL}` as UrlPath;
19
+ }
20
+
21
+ if (baseURL.endsWith("/")) {
22
+ baseURL = baseURL.slice(0, -1) as UrlPath;
23
+ }
24
+
25
+ await forEachFile(baseDir, async (filepath) => {
26
+ const ext = path.extname(filepath);
27
+ if (/^\.(mjs|js|ts|tsx|jsx)$/.test(ext)) {
28
+ const { metafile } = await build({
29
+ metafile: true,
30
+ write: false,
31
+ bundle: false,
32
+ entryPoints: [path.resolve(filepath)],
33
+ });
34
+ const exportNames: string[] = [];
35
+ if (metafile) {
36
+ for (const output in metafile?.outputs) {
37
+ exportNames.push(...metafile.outputs[output].exports);
38
+ }
39
+ }
40
+ for (const exportName of exportNames) {
41
+ const [match, method = ""] = (exportName.match(
42
+ /^onRequest(Get|Post|Put|Patch|Delete|Options|Head)?$/
43
+ ) ?? []) as (string | undefined)[];
44
+
45
+ if (match) {
46
+ const basename = path.basename(filepath).slice(0, -ext.length);
47
+
48
+ const isIndexFile = basename === "index";
49
+ // TODO: deprecate _middleware_ in favor of _middleware
50
+ const isMiddlewareFile =
51
+ basename === "_middleware" || basename === "_middleware_";
52
+
53
+ let routePath = path
54
+ .relative(baseDir, filepath)
55
+ .slice(0, -ext.length);
56
+ let mountPath = path.dirname(routePath);
57
+
58
+ if (isIndexFile || isMiddlewareFile) {
59
+ routePath = path.dirname(routePath);
60
+ }
61
+
62
+ if (routePath === ".") {
63
+ routePath = "";
64
+ }
65
+ if (mountPath === ".") {
66
+ mountPath = "";
67
+ }
68
+
69
+ routePath = `${baseURL}/${routePath}`;
70
+ mountPath = `${baseURL}/${mountPath}`;
71
+
72
+ routePath = routePath.replace(/\[\[([^\]]+)\]\]/g, ":$1*"); // transform [[id]] => :id*
73
+ routePath = routePath.replaceAll(/\[([^\]]+)\]/g, ":$1"); // transform [id] => :id
74
+ mountPath = mountPath.replace(/\[\[([^\]]+)\]\]/g, ":$1*"); // transform [[id]] => :id*
75
+ mountPath = mountPath.replaceAll(/\[([^\]]+)\]/g, ":$1"); // transform [id] => :id
76
+
77
+ // These are used as module specifiers so UrlPaths are okay to use even on Windows
78
+ const modulePath = toUrlPath(path.relative(baseDir, filepath));
79
+
80
+ const routeEntry: RouteConfig = {
81
+ routePath: toUrlPath(routePath),
82
+ mountPath: toUrlPath(mountPath),
83
+ method: method.toUpperCase() as HTTPMethod,
84
+ [isMiddlewareFile ? "middleware" : "module"]: [
85
+ `${modulePath}:${exportName}`,
86
+ ],
87
+ };
88
+
89
+ routeEntries.push(routeEntry);
90
+ }
91
+ }
92
+ }
93
+ });
94
+ // Combine together any routes (index routes) which contain both a module and a middleware
95
+ routeEntries = routeEntries.reduce(
96
+ (acc: typeof routeEntries, { routePath, ...rest }) => {
97
+ const existingRouteEntry = acc.find(
98
+ (routeEntry) =>
99
+ routeEntry.routePath === routePath &&
100
+ routeEntry.method === rest.method
101
+ );
102
+ if (existingRouteEntry !== undefined) {
103
+ Object.assign(existingRouteEntry, rest);
104
+ } else {
105
+ acc.push({ routePath, ...rest });
106
+ }
107
+ return acc;
108
+ },
109
+ []
110
+ );
111
+
112
+ routeEntries.sort((a, b) => compareRoutes(a, b));
113
+
114
+ return {
115
+ routes: routeEntries,
116
+ };
117
+ }
118
+
119
+ // Ensure routes are produced in order of precedence so that
120
+ // more specific routes aren't occluded from matching due to
121
+ // less specific routes appearing first in the route list.
122
+ export function compareRoutes(
123
+ { routePath: routePathA, method: methodA }: RouteConfig,
124
+ { routePath: routePathB, method: methodB }: RouteConfig
125
+ ) {
126
+ function parseRoutePath(routePath: UrlPath): string[] {
127
+ return routePath.slice(1).split("/").filter(Boolean);
128
+ }
129
+
130
+ const segmentsA = parseRoutePath(routePathA);
131
+ const segmentsB = parseRoutePath(routePathB);
132
+
133
+ // sort routes with fewer segments after those with more segments
134
+ if (segmentsA.length !== segmentsB.length) {
135
+ return segmentsB.length - segmentsA.length;
136
+ }
137
+
138
+ for (let i = 0; i < segmentsA.length; i++) {
139
+ const isWildcardA = segmentsA[i].includes("*");
140
+ const isWildcardB = segmentsB[i].includes("*");
141
+ const isParamA = segmentsA[i].includes(":");
142
+ const isParamB = segmentsB[i].includes(":");
143
+
144
+ // sort wildcard segments after non-wildcard segments
145
+ if (isWildcardA && !isWildcardB) return 1;
146
+ if (!isWildcardA && isWildcardB) return -1;
147
+
148
+ // sort dynamic param segments after non-param segments
149
+ if (isParamA && !isParamB) return 1;
150
+ if (!isParamA && isParamB) return -1;
151
+ }
152
+
153
+ // sort routes that specify an HTTP before those that don't
154
+ if (methodA && !methodB) return -1;
155
+ if (!methodA && methodB) return 1;
156
+
157
+ // all else equal, just sort the paths lexicographically
158
+ return routePathA.localeCompare(routePathB);
159
+ }
160
+
161
+ async function forEachFile<T>(
162
+ baseDir: string,
163
+ fn: (filepath: string) => T | Promise<T>
164
+ ) {
165
+ const searchPaths = [baseDir];
166
+ const returnValues: T[] = [];
167
+
168
+ while (isNotEmpty(searchPaths)) {
169
+ const cwd = searchPaths.shift();
170
+ const dir = await fs.readdir(cwd, { withFileTypes: true });
171
+ for (const entry of dir) {
172
+ const pathname = path.join(cwd, entry.name);
173
+ if (entry.isDirectory()) {
174
+ searchPaths.push(pathname);
175
+ } else if (entry.isFile()) {
176
+ returnValues.push(await fn(pathname));
177
+ }
178
+ }
179
+ }
180
+
181
+ return returnValues;
182
+ }
183
+
184
+ interface NonEmptyArray<T> extends Array<T> {
185
+ shift(): T;
186
+ }
187
+ function isNotEmpty<T>(array: T[]): array is NonEmptyArray<T> {
188
+ return array.length > 0;
189
+ }
@@ -0,0 +1,78 @@
1
+ export const RESERVED_KEYWORDS = [
2
+ "do",
3
+ "if",
4
+ "in",
5
+ "for",
6
+ "let",
7
+ "new",
8
+ "try",
9
+ "var",
10
+ "case",
11
+ "else",
12
+ "enum",
13
+ "eval",
14
+ "null",
15
+ "this",
16
+ "true",
17
+ "void",
18
+ "with",
19
+ "await",
20
+ "break",
21
+ "catch",
22
+ "class",
23
+ "const",
24
+ "false",
25
+ "super",
26
+ "throw",
27
+ "while",
28
+ "yield",
29
+ "delete",
30
+ "export",
31
+ "import",
32
+ "public",
33
+ "return",
34
+ "static",
35
+ "switch",
36
+ "typeof",
37
+ "default",
38
+ "extends",
39
+ "finally",
40
+ "package",
41
+ "private",
42
+ "continue",
43
+ "debugger",
44
+ "function",
45
+ "arguments",
46
+ "interface",
47
+ "protected",
48
+ "implements",
49
+ "instanceof",
50
+ "NaN",
51
+ "Infinity",
52
+ "undefined",
53
+ ];
54
+
55
+ export const reservedKeywordRegex = new RegExp(
56
+ `^${RESERVED_KEYWORDS.join("|")}$`
57
+ );
58
+
59
+ export const identifierStartRegex = /[$_\p{ID_Start}]/u;
60
+
61
+ export const identifierPartRegex = /[$_\u200C\u200D\p{ID_Continue}]/u;
62
+
63
+ export const identifierNameRegex =
64
+ /^(?:[$_\p{ID_Start}])(?:[$_\u200C\u200D\p{ID_Continue}])*$/u;
65
+
66
+ export const validIdentifierRegex = new RegExp(
67
+ `(?!(${reservedKeywordRegex.source})$)${identifierNameRegex.source}`,
68
+ "u"
69
+ );
70
+
71
+ export const isValidIdentifier = (identifier: string) =>
72
+ validIdentifierRegex.test(identifier);
73
+
74
+ export const normalizeIdentifier = (identifier: string) =>
75
+ identifier.replace(
76
+ /(?:^[^$_\p{ID_Start}])|[^$_\u200C\u200D\p{ID_Continue}]/gu,
77
+ "_"
78
+ );