wrangler 0.0.0-e61fba8 → 0.0.0-e665ccc3

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 (339) hide show
  1. package/README.md +24 -4
  2. package/bin/wrangler.js +170 -62
  3. package/miniflare-dist/index.mjs +1643 -83
  4. package/package.json +198 -154
  5. package/src/__tests__/access.test.ts +25 -0
  6. package/src/__tests__/api-dev.test.ts +238 -0
  7. package/src/__tests__/api-devregistry.test.ts +121 -0
  8. package/src/__tests__/api.test.ts +102 -0
  9. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  10. package/src/__tests__/config-cache.test.ts +30 -24
  11. package/src/__tests__/configuration.test.ts +4506 -3476
  12. package/src/__tests__/constellation.test.ts +371 -0
  13. package/src/__tests__/d1/d1.test.ts +82 -0
  14. package/src/__tests__/d1/execute.test.ts +66 -0
  15. package/src/__tests__/d1/migrate.test.ts +257 -0
  16. package/src/__tests__/d1/splitter.test.ts +255 -0
  17. package/src/__tests__/delete.test.ts +272 -0
  18. package/src/__tests__/deployments.test.ts +369 -0
  19. package/src/__tests__/dev.test.tsx +1590 -983
  20. package/src/__tests__/generate.test.ts +237 -0
  21. package/src/__tests__/get-host-from-url.test.ts +16 -0
  22. package/src/__tests__/guess-worker-format.test.ts +103 -68
  23. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  24. package/src/__tests__/helpers/end-event-loop.ts +6 -0
  25. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  26. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  27. package/src/__tests__/helpers/mock-bin.ts +20 -20
  28. package/src/__tests__/helpers/mock-console.ts +64 -39
  29. package/src/__tests__/helpers/mock-dialogs.ts +88 -79
  30. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +25 -0
  31. package/src/__tests__/helpers/mock-get-zone-from-host.ts +11 -0
  32. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  33. package/src/__tests__/helpers/mock-istty.ts +65 -18
  34. package/src/__tests__/helpers/mock-known-routes.ts +12 -0
  35. package/src/__tests__/helpers/mock-kv.ts +41 -28
  36. package/src/__tests__/helpers/mock-oauth-flow.ts +241 -233
  37. package/src/__tests__/helpers/mock-process.ts +34 -0
  38. package/src/__tests__/helpers/mock-set-timeout.ts +16 -0
  39. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  40. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  41. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  42. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  43. package/src/__tests__/helpers/msw/handlers/deployments.ts +160 -0
  44. package/src/__tests__/helpers/msw/handlers/namespaces.ts +81 -0
  45. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  46. package/src/__tests__/helpers/msw/handlers/r2.ts +60 -0
  47. package/src/__tests__/helpers/msw/handlers/script.ts +56 -0
  48. package/src/__tests__/helpers/msw/handlers/user.ts +52 -0
  49. package/src/__tests__/helpers/msw/handlers/zones.ts +20 -0
  50. package/src/__tests__/helpers/msw/index.ts +52 -0
  51. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  52. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  53. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  54. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +28 -0
  55. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  56. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  57. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  58. package/src/__tests__/helpers/worker-scripts/parent-worker.js +11 -0
  59. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  60. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  61. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  62. package/src/__tests__/https-options.test.ts +142 -109
  63. package/src/__tests__/index.test.ts +262 -237
  64. package/src/__tests__/init.test.ts +3167 -1608
  65. package/src/__tests__/jest.setup.ts +152 -50
  66. package/src/__tests__/kv.test.ts +1789 -1492
  67. package/src/__tests__/logger.test.ts +167 -75
  68. package/src/__tests__/logout.test.ts +47 -0
  69. package/src/__tests__/metrics.test.ts +493 -0
  70. package/src/__tests__/middleware.scheduled.test.ts +145 -0
  71. package/src/__tests__/middleware.test.ts +816 -0
  72. package/src/__tests__/mtls-certificates.test.ts +589 -0
  73. package/src/__tests__/package-manager.test.ts +303 -303
  74. package/src/__tests__/pages/deployment-list.test.ts +80 -0
  75. package/src/__tests__/pages/functions-build.test.ts +528 -0
  76. package/src/__tests__/pages/pages.test.ts +81 -0
  77. package/src/__tests__/pages/project-create.test.ts +63 -0
  78. package/src/__tests__/pages/project-list.test.ts +110 -0
  79. package/src/__tests__/pages/project-upload.test.ts +500 -0
  80. package/src/__tests__/pages/publish.test.ts +2864 -0
  81. package/src/__tests__/pages-deployment-tail.test.ts +957 -0
  82. package/src/__tests__/parse.test.ts +358 -252
  83. package/src/__tests__/paths.test.ts +39 -0
  84. package/src/__tests__/publish.test.ts +8716 -5687
  85. package/src/__tests__/pubsub.test.ts +496 -0
  86. package/src/__tests__/queues.test.ts +532 -0
  87. package/src/__tests__/r2.test.ts +369 -228
  88. package/src/__tests__/route.test.ts +18 -18
  89. package/src/__tests__/secret.test.ts +681 -469
  90. package/src/__tests__/tail.test.ts +866 -567
  91. package/src/__tests__/test-old-node-version.js +31 -0
  92. package/src/__tests__/traverse-module-graph.test.ts +220 -0
  93. package/src/__tests__/tsconfig-sanity.ts +12 -0
  94. package/src/__tests__/tsconfig.json +8 -0
  95. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  96. package/src/__tests__/type-generation.test.ts +234 -0
  97. package/src/__tests__/user.test.ts +107 -120
  98. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  99. package/src/__tests__/validate-dev-props.test.ts +56 -0
  100. package/src/__tests__/version.test.ts +35 -0
  101. package/src/__tests__/whoami.test.tsx +165 -132
  102. package/src/__tests__/worker-namespace.test.ts +340 -0
  103. package/src/abort.d.ts +1 -1
  104. package/src/api/dev.ts +321 -0
  105. package/src/api/index.ts +11 -0
  106. package/src/api/mtls-certificate.ts +148 -0
  107. package/src/api/pages/create-worker-bundle-contents.ts +77 -0
  108. package/src/api/pages/index.ts +5 -0
  109. package/src/api/pages/publish.tsx +371 -0
  110. package/src/bundle-reporter.ts +68 -0
  111. package/src/bundle.ts +890 -165
  112. package/src/cfetch/index.ts +120 -83
  113. package/src/cfetch/internal.ts +208 -92
  114. package/src/cli.ts +23 -8
  115. package/src/config/config.ts +244 -196
  116. package/src/config/diagnostics.ts +61 -61
  117. package/src/config/environment.ts +562 -357
  118. package/src/config/index.ts +374 -196
  119. package/src/config/validation-helpers.ts +379 -366
  120. package/src/config/validation.ts +2197 -1376
  121. package/src/config-cache.ts +81 -41
  122. package/src/constellation/createProject.tsx +51 -0
  123. package/src/constellation/deleteProject.ts +51 -0
  124. package/src/constellation/deleteProjectModel.ts +68 -0
  125. package/src/constellation/index.ts +75 -0
  126. package/src/constellation/listCatalog.tsx +35 -0
  127. package/src/constellation/listModel.tsx +41 -0
  128. package/src/constellation/listProject.tsx +28 -0
  129. package/src/constellation/listRuntime.tsx +28 -0
  130. package/src/constellation/options.ts +17 -0
  131. package/src/constellation/types.ts +17 -0
  132. package/src/constellation/uploadModel.tsx +64 -0
  133. package/src/constellation/utils.ts +90 -0
  134. package/src/create-worker-preview.ts +250 -142
  135. package/src/create-worker-upload-form.ts +347 -238
  136. package/src/d1/backups.tsx +219 -0
  137. package/src/d1/constants.ts +2 -0
  138. package/src/d1/create.tsx +70 -0
  139. package/src/d1/delete.ts +53 -0
  140. package/src/d1/execute.tsx +357 -0
  141. package/src/d1/formatTimeAgo.ts +14 -0
  142. package/src/d1/index.ts +100 -0
  143. package/src/d1/list.tsx +62 -0
  144. package/src/d1/migrations/apply.tsx +212 -0
  145. package/src/d1/migrations/create.tsx +79 -0
  146. package/src/d1/migrations/helpers.ts +169 -0
  147. package/src/d1/migrations/index.ts +3 -0
  148. package/src/d1/migrations/list.tsx +95 -0
  149. package/src/d1/migrations/options.ts +23 -0
  150. package/src/d1/options.ts +22 -0
  151. package/src/d1/splitter.ts +161 -0
  152. package/src/d1/types.ts +25 -0
  153. package/src/d1/utils.ts +49 -0
  154. package/src/delete.ts +100 -0
  155. package/src/deployments.ts +368 -0
  156. package/src/deprecated/index.ts +144 -0
  157. package/src/dev/dev-vars.ts +20 -17
  158. package/src/dev/dev.tsx +535 -325
  159. package/src/dev/get-local-persistence-path.ts +31 -0
  160. package/src/dev/local.tsx +932 -301
  161. package/src/dev/remote.tsx +623 -228
  162. package/src/dev/start-server.ts +545 -0
  163. package/src/dev/use-esbuild.ts +194 -94
  164. package/src/dev/validate-dev-props.ts +40 -0
  165. package/src/dev-registry.ts +202 -0
  166. package/src/dev.tsx +934 -0
  167. package/src/dialogs.ts +136 -0
  168. package/src/dispatch-namespace.ts +211 -0
  169. package/src/docs/helpers.ts +50 -0
  170. package/src/docs/index.ts +54 -0
  171. package/src/durable.ts +87 -87
  172. package/src/entry.ts +253 -231
  173. package/src/environment-variables/factory.ts +89 -0
  174. package/src/environment-variables/misc-variables.ts +30 -0
  175. package/src/errors.ts +6 -6
  176. package/src/generate/index.ts +298 -0
  177. package/src/git-client.ts +135 -0
  178. package/src/global-wrangler-config-path.ts +26 -0
  179. package/src/https-options.ts +84 -80
  180. package/src/index.ts +768 -0
  181. package/src/init.ts +1037 -0
  182. package/src/inspect.ts +816 -595
  183. package/src/intl-polyfill.d.ts +123 -123
  184. package/src/is-ci.ts +14 -0
  185. package/src/is-interactive.ts +16 -0
  186. package/src/jest.d.ts +4 -0
  187. package/src/kv/helpers.ts +433 -0
  188. package/src/kv/index.ts +594 -0
  189. package/src/logger.ts +100 -43
  190. package/src/metrics/index.ts +5 -0
  191. package/src/metrics/metrics-config.ts +239 -0
  192. package/src/metrics/metrics-dispatcher.ts +96 -0
  193. package/src/metrics/metrics-usage-headers.ts +24 -0
  194. package/src/metrics/send-event.ts +99 -0
  195. package/src/miniflare-cli/assets.ts +255 -0
  196. package/src/miniflare-cli/index.ts +202 -33
  197. package/src/miniflare-cli/request-context.ts +18 -18
  198. package/src/miniflare-cli/tsconfig.json +9 -0
  199. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  200. package/src/miniflare-cli/types.ts +11 -0
  201. package/src/module-collection.ts +290 -215
  202. package/src/mtls-certificate/cli.ts +155 -0
  203. package/src/open-in-browser.ts +4 -6
  204. package/src/package-manager.ts +173 -128
  205. package/src/pages/build.ts +423 -0
  206. package/src/pages/buildFunctions.ts +140 -0
  207. package/src/pages/constants.ts +18 -0
  208. package/src/pages/deployment-tails.ts +281 -0
  209. package/src/pages/deployments.tsx +84 -0
  210. package/src/pages/dev.ts +734 -0
  211. package/src/pages/errors.ts +67 -0
  212. package/src/pages/functions/buildPlugin.ts +114 -0
  213. package/src/pages/functions/buildWorker.ts +350 -0
  214. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  215. package/src/pages/functions/filepath-routing.ts +189 -0
  216. package/src/pages/functions/identifiers.ts +78 -0
  217. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  218. package/src/pages/functions/routes-consolidation.ts +73 -0
  219. package/src/pages/functions/routes-transformation.test.ts +282 -0
  220. package/src/pages/functions/routes-transformation.ts +115 -0
  221. package/src/pages/functions/routes-validation.test.ts +403 -0
  222. package/src/pages/functions/routes-validation.ts +202 -0
  223. package/src/pages/functions/routes.ts +151 -0
  224. package/src/pages/functions/tsconfig.json +8 -0
  225. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  226. package/src/pages/functions.ts +86 -0
  227. package/src/pages/hash.ts +13 -0
  228. package/src/pages/index.ts +102 -0
  229. package/src/pages/projects.tsx +159 -0
  230. package/src/pages/prompt-select-project.tsx +31 -0
  231. package/src/pages/publish.tsx +267 -0
  232. package/src/pages/types.ts +46 -0
  233. package/src/pages/upload.tsx +469 -0
  234. package/src/pages/utils.ts +23 -0
  235. package/src/parse.ts +225 -139
  236. package/src/paths.ts +53 -8
  237. package/src/proxy.ts +623 -407
  238. package/src/publish/index.ts +274 -0
  239. package/src/publish/publish.ts +1065 -0
  240. package/src/pubsub/index.ts +286 -0
  241. package/src/pubsub/pubsub-commands.ts +623 -0
  242. package/src/queues/cli/commands/consumer/add.ts +71 -0
  243. package/src/queues/cli/commands/consumer/index.ts +19 -0
  244. package/src/queues/cli/commands/consumer/remove.ts +31 -0
  245. package/src/queues/cli/commands/create.ts +25 -0
  246. package/src/queues/cli/commands/delete.ts +26 -0
  247. package/src/queues/cli/commands/index.ts +35 -0
  248. package/src/queues/cli/commands/list.ts +25 -0
  249. package/src/queues/client.ts +136 -0
  250. package/src/queues/utils.ts +18 -0
  251. package/src/r2/constants.ts +4 -0
  252. package/src/r2/helpers.ts +132 -0
  253. package/src/r2/index.ts +289 -0
  254. package/src/routes.ts +140 -0
  255. package/src/secret/index.ts +377 -0
  256. package/src/selfsigned.d.ts +23 -23
  257. package/src/sites.ts +484 -0
  258. package/src/tail/createTail.ts +415 -0
  259. package/src/tail/filters.ts +109 -111
  260. package/src/tail/index.ts +208 -296
  261. package/src/tail/printing.ts +116 -51
  262. package/src/traverse-module-graph.ts +54 -0
  263. package/src/tsconfig-sanity.ts +16 -0
  264. package/src/type-generation.ts +181 -0
  265. package/src/update-check.ts +11 -11
  266. package/src/user/access.ts +68 -0
  267. package/src/user/auth-variables.ts +113 -0
  268. package/src/user/choose-account.tsx +39 -0
  269. package/src/user/generate-auth-url.ts +33 -0
  270. package/src/user/generate-random-state.ts +16 -0
  271. package/src/user/index.ts +2 -0
  272. package/src/user/user.ts +1234 -0
  273. package/src/utils/collectKeyValues.ts +14 -0
  274. package/src/utils/render.ts +93 -0
  275. package/src/whoami.ts +135 -0
  276. package/src/worker.ts +205 -107
  277. package/src/yargs-types.ts +37 -0
  278. package/src/zones.ts +158 -40
  279. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  280. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  281. package/templates/__tests__/tsconfig.json +8 -0
  282. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  283. package/templates/checked-fetch.js +23 -0
  284. package/templates/d1-beta-facade.js +244 -0
  285. package/templates/facade.d.ts +14 -0
  286. package/templates/first-party-worker-module-facade.ts +19 -0
  287. package/templates/format-dev-errors.ts +34 -0
  288. package/templates/gitignore +1 -0
  289. package/templates/init-tests/test-jest-new-worker.js +23 -0
  290. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  291. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  292. package/templates/middleware/common.ts +62 -0
  293. package/templates/middleware/loader-modules.ts +84 -0
  294. package/templates/middleware/loader-sw.ts +233 -0
  295. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  296. package/templates/middleware/middleware-pretty-error.ts +40 -0
  297. package/templates/middleware/middleware-scheduled.ts +15 -0
  298. package/templates/new-worker-scheduled.js +3 -3
  299. package/templates/new-worker-scheduled.ts +15 -15
  300. package/templates/new-worker.js +3 -3
  301. package/templates/new-worker.ts +18 -15
  302. package/templates/no-op-worker.js +10 -0
  303. package/templates/pages-dev-pipeline.ts +31 -0
  304. package/templates/pages-dev-util.ts +52 -0
  305. package/templates/pages-shim.ts +12 -0
  306. package/templates/pages-template-plugin.ts +180 -0
  307. package/templates/pages-template-worker.ts +189 -0
  308. package/templates/serve-static-assets.ts +66 -0
  309. package/templates/service-bindings-module-facade.js +55 -0
  310. package/templates/service-bindings-sw-facade.js +42 -0
  311. package/templates/tsconfig-sanity.ts +11 -0
  312. package/templates/tsconfig.init.json +105 -0
  313. package/templates/tsconfig.json +6 -103
  314. package/templates/tsconfig.tsbuildinfo +1 -0
  315. package/wrangler-dist/cli.d.ts +1652 -0
  316. package/wrangler-dist/cli.js +139094 -111923
  317. package/wrangler-dist/wasm-sync.wasm +0 -0
  318. package/pages/functions/buildPlugin.ts +0 -105
  319. package/pages/functions/buildWorker.ts +0 -151
  320. package/pages/functions/filepath-routing.ts +0 -189
  321. package/pages/functions/identifiers.ts +0 -78
  322. package/pages/functions/routes.ts +0 -156
  323. package/pages/functions/template-plugin.ts +0 -147
  324. package/pages/functions/template-worker.ts +0 -143
  325. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  326. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  327. package/src/__tests__/pages.test.ts +0 -754
  328. package/src/dialogs.tsx +0 -135
  329. package/src/environment-variables.ts +0 -35
  330. package/src/index.tsx +0 -2859
  331. package/src/kv.ts +0 -408
  332. package/src/miniflare-cli/enum-keys.ts +0 -17
  333. package/src/pages.tsx +0 -2093
  334. package/src/publish.ts +0 -721
  335. package/src/r2.ts +0 -50
  336. package/src/sites.tsx +0 -326
  337. package/src/user.tsx +0 -1214
  338. package/src/whoami.tsx +0 -71
  339. package/templates/static-asset-facade.js +0 -43
@@ -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
+ );