wrangler 0.0.0-e351afcf → 0.0.0-e39e9ff4

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 (324) hide show
  1. package/README.md +10 -12
  2. package/bin/wrangler.js +13 -74
  3. package/config-schema.json +2900 -0
  4. package/package.json +224 -199
  5. package/templates/__tests__/tsconfig.json +1 -1
  6. package/templates/checked-fetch.js +10 -3
  7. package/templates/facade.d.ts +7 -2
  8. package/templates/gitignore +0 -5
  9. package/templates/init-tests/test-vitest-new-worker.js +1 -1
  10. package/templates/init-tests/test-vitest-new-worker.ts +1 -1
  11. package/templates/middleware/common.ts +9 -4
  12. package/templates/middleware/loader-modules.ts +93 -44
  13. package/templates/middleware/loader-sw.ts +6 -10
  14. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  15. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  16. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  17. package/templates/modules-watch-stub.js +4 -0
  18. package/templates/new-worker-scheduled.ts +1 -1
  19. package/templates/new-worker.ts +1 -1
  20. package/templates/pages-dev-pipeline.ts +2 -1
  21. package/templates/pages-dev-util.ts +4 -1
  22. package/templates/pages-shim.ts +0 -3
  23. package/templates/pages-template-plugin.ts +12 -2
  24. package/templates/pages-template-worker.ts +11 -2
  25. package/templates/startDevWorker/InspectorProxyWorker.ts +661 -0
  26. package/templates/startDevWorker/ProxyWorker.ts +331 -0
  27. package/templates/tsconfig.json +1 -1
  28. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  29. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  30. package/wrangler-dist/ProxyWorker.js +240 -0
  31. package/wrangler-dist/ProxyWorker.js.map +6 -0
  32. package/wrangler-dist/cli.d.ts +22636 -297
  33. package/wrangler-dist/cli.js +136177 -115703
  34. package/wrangler-dist/wasm-sync.wasm +0 -0
  35. package/import_meta_url.js +0 -3
  36. package/miniflare-config-stubs/.env.empty +0 -0
  37. package/miniflare-config-stubs/package.empty.json +0 -1
  38. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  39. package/miniflare-dist/index.mjs +0 -6442
  40. package/src/__tests__/access.test.ts +0 -25
  41. package/src/__tests__/api-dev.test.ts +0 -238
  42. package/src/__tests__/api-devregistry.test.ts +0 -121
  43. package/src/__tests__/api.test.ts +0 -102
  44. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  45. package/src/__tests__/config-cache.test.ts +0 -42
  46. package/src/__tests__/configuration.test.ts +0 -4509
  47. package/src/__tests__/constellation.test.ts +0 -371
  48. package/src/__tests__/d1/d1.test.ts +0 -82
  49. package/src/__tests__/d1/execute.test.ts +0 -66
  50. package/src/__tests__/d1/migrate.test.ts +0 -257
  51. package/src/__tests__/d1/splitter.test.ts +0 -255
  52. package/src/__tests__/delete.test.ts +0 -272
  53. package/src/__tests__/deployments.test.ts +0 -369
  54. package/src/__tests__/dev.test.tsx +0 -1617
  55. package/src/__tests__/generate.test.ts +0 -237
  56. package/src/__tests__/get-host-from-url.test.ts +0 -16
  57. package/src/__tests__/guess-worker-format.test.ts +0 -120
  58. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  59. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  60. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  61. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  62. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  63. package/src/__tests__/helpers/mock-bin.ts +0 -36
  64. package/src/__tests__/helpers/mock-console.ts +0 -112
  65. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  66. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  67. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  68. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  69. package/src/__tests__/helpers/mock-istty.ts +0 -74
  70. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  71. package/src/__tests__/helpers/mock-kv.ts +0 -46
  72. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  73. package/src/__tests__/helpers/mock-process.ts +0 -34
  74. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  75. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  76. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  77. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  78. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  79. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -160
  80. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  81. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  82. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  83. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  84. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  85. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  86. package/src/__tests__/helpers/msw/index.ts +0 -52
  87. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  88. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  89. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  90. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  91. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  92. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  93. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  94. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -11
  95. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  96. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  97. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  98. package/src/__tests__/https-options.test.ts +0 -163
  99. package/src/__tests__/index.test.ts +0 -282
  100. package/src/__tests__/init.test.ts +0 -3196
  101. package/src/__tests__/jest.setup.ts +0 -179
  102. package/src/__tests__/kv.test.ts +0 -1799
  103. package/src/__tests__/logger.test.ts +0 -207
  104. package/src/__tests__/logout.test.ts +0 -47
  105. package/src/__tests__/metrics.test.ts +0 -493
  106. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  107. package/src/__tests__/middleware.test.ts +0 -816
  108. package/src/__tests__/mtls-certificates.test.ts +0 -589
  109. package/src/__tests__/package-manager.test.ts +0 -353
  110. package/src/__tests__/pages/deployment-list.test.ts +0 -80
  111. package/src/__tests__/pages/functions-build.test.ts +0 -522
  112. package/src/__tests__/pages/pages.test.ts +0 -81
  113. package/src/__tests__/pages/project-create.test.ts +0 -63
  114. package/src/__tests__/pages/project-list.test.ts +0 -110
  115. package/src/__tests__/pages/project-upload.test.ts +0 -500
  116. package/src/__tests__/pages/publish.test.ts +0 -2864
  117. package/src/__tests__/pages-deployment-tail.test.ts +0 -955
  118. package/src/__tests__/parse.test.ts +0 -436
  119. package/src/__tests__/paths.test.ts +0 -39
  120. package/src/__tests__/publish.test.ts +0 -8849
  121. package/src/__tests__/pubsub.test.ts +0 -496
  122. package/src/__tests__/queues.test.ts +0 -532
  123. package/src/__tests__/r2.test.ts +0 -374
  124. package/src/__tests__/route.test.ts +0 -45
  125. package/src/__tests__/secret.test.ts +0 -693
  126. package/src/__tests__/tail.test.ts +0 -958
  127. package/src/__tests__/test-old-node-version.js +0 -31
  128. package/src/__tests__/traverse-module-graph.test.ts +0 -220
  129. package/src/__tests__/tsconfig-sanity.ts +0 -12
  130. package/src/__tests__/tsconfig.json +0 -8
  131. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  132. package/src/__tests__/type-generation.test.ts +0 -234
  133. package/src/__tests__/user.test.ts +0 -118
  134. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  135. package/src/__tests__/validate-dev-props.test.ts +0 -56
  136. package/src/__tests__/version.test.ts +0 -35
  137. package/src/__tests__/whoami.test.tsx +0 -172
  138. package/src/__tests__/worker-namespace.test.ts +0 -340
  139. package/src/abort.d.ts +0 -3
  140. package/src/api/dev.ts +0 -321
  141. package/src/api/index.ts +0 -11
  142. package/src/api/mtls-certificate.ts +0 -148
  143. package/src/api/pages/create-worker-bundle-contents.ts +0 -76
  144. package/src/api/pages/index.ts +0 -5
  145. package/src/api/pages/publish.tsx +0 -371
  146. package/src/bundle-reporter.ts +0 -68
  147. package/src/bundle.ts +0 -911
  148. package/src/cfetch/index.ts +0 -158
  149. package/src/cfetch/internal.ts +0 -258
  150. package/src/cli.ts +0 -28
  151. package/src/config/README.md +0 -107
  152. package/src/config/config.ts +0 -282
  153. package/src/config/diagnostics.ts +0 -80
  154. package/src/config/environment.ts +0 -618
  155. package/src/config/index.ts +0 -403
  156. package/src/config/validation-helpers.ts +0 -597
  157. package/src/config/validation.ts +0 -2342
  158. package/src/config-cache.ts +0 -85
  159. package/src/constellation/createProject.tsx +0 -51
  160. package/src/constellation/deleteProject.ts +0 -51
  161. package/src/constellation/deleteProjectModel.ts +0 -68
  162. package/src/constellation/index.ts +0 -75
  163. package/src/constellation/listCatalog.tsx +0 -35
  164. package/src/constellation/listModel.tsx +0 -41
  165. package/src/constellation/listProject.tsx +0 -28
  166. package/src/constellation/listRuntime.tsx +0 -28
  167. package/src/constellation/options.ts +0 -17
  168. package/src/constellation/types.ts +0 -17
  169. package/src/constellation/uploadModel.tsx +0 -64
  170. package/src/constellation/utils.ts +0 -90
  171. package/src/create-worker-preview.ts +0 -293
  172. package/src/create-worker-upload-form.ts +0 -359
  173. package/src/d1/backups.tsx +0 -219
  174. package/src/d1/constants.ts +0 -2
  175. package/src/d1/create.tsx +0 -70
  176. package/src/d1/delete.ts +0 -53
  177. package/src/d1/execute.tsx +0 -357
  178. package/src/d1/formatTimeAgo.ts +0 -14
  179. package/src/d1/index.ts +0 -100
  180. package/src/d1/list.tsx +0 -62
  181. package/src/d1/migrations/apply.tsx +0 -212
  182. package/src/d1/migrations/create.tsx +0 -79
  183. package/src/d1/migrations/helpers.ts +0 -169
  184. package/src/d1/migrations/index.ts +0 -3
  185. package/src/d1/migrations/list.tsx +0 -95
  186. package/src/d1/migrations/options.ts +0 -23
  187. package/src/d1/options.ts +0 -22
  188. package/src/d1/splitter.ts +0 -161
  189. package/src/d1/types.ts +0 -25
  190. package/src/d1/utils.ts +0 -49
  191. package/src/delete.ts +0 -100
  192. package/src/deployments.ts +0 -368
  193. package/src/deprecated/index.ts +0 -144
  194. package/src/dev/dev-vars.ts +0 -39
  195. package/src/dev/dev.tsx +0 -602
  196. package/src/dev/get-local-persistence-path.ts +0 -31
  197. package/src/dev/local.tsx +0 -948
  198. package/src/dev/remote.tsx +0 -632
  199. package/src/dev/start-server.ts +0 -543
  200. package/src/dev/use-esbuild.ts +0 -212
  201. package/src/dev/validate-dev-props.ts +0 -40
  202. package/src/dev-registry.ts +0 -202
  203. package/src/dev.tsx +0 -934
  204. package/src/dialogs.ts +0 -136
  205. package/src/dispatch-namespace.ts +0 -211
  206. package/src/docs/helpers.ts +0 -50
  207. package/src/docs/index.ts +0 -54
  208. package/src/durable.ts +0 -102
  209. package/src/entry.ts +0 -338
  210. package/src/environment-variables/factory.ts +0 -89
  211. package/src/environment-variables/misc-variables.ts +0 -30
  212. package/src/errors.ts +0 -11
  213. package/src/generate/index.ts +0 -298
  214. package/src/git-client.ts +0 -135
  215. package/src/global-wrangler-config-path.ts +0 -26
  216. package/src/https-options.ts +0 -127
  217. package/src/index.ts +0 -768
  218. package/src/init.ts +0 -1032
  219. package/src/inspect.ts +0 -782
  220. package/src/intl-polyfill.d.ts +0 -139
  221. package/src/is-ci.ts +0 -14
  222. package/src/is-interactive.ts +0 -16
  223. package/src/jest.d.ts +0 -4
  224. package/src/kv/helpers.ts +0 -433
  225. package/src/kv/index.ts +0 -594
  226. package/src/logger.ts +0 -123
  227. package/src/metrics/index.ts +0 -5
  228. package/src/metrics/metrics-config.ts +0 -239
  229. package/src/metrics/metrics-dispatcher.ts +0 -96
  230. package/src/metrics/metrics-usage-headers.ts +0 -24
  231. package/src/metrics/send-event.ts +0 -99
  232. package/src/miniflare-cli/README.md +0 -30
  233. package/src/miniflare-cli/assets.ts +0 -251
  234. package/src/miniflare-cli/index.ts +0 -210
  235. package/src/miniflare-cli/request-context.ts +0 -40
  236. package/src/miniflare-cli/tsconfig.json +0 -9
  237. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  238. package/src/miniflare-cli/types.ts +0 -11
  239. package/src/module-collection.ts +0 -333
  240. package/src/mtls-certificate/cli.ts +0 -155
  241. package/src/open-in-browser.ts +0 -17
  242. package/src/package-manager.ts +0 -219
  243. package/src/pages/build.ts +0 -422
  244. package/src/pages/buildFunctions.ts +0 -140
  245. package/src/pages/constants.ts +0 -18
  246. package/src/pages/deployment-tails.ts +0 -281
  247. package/src/pages/deployments.tsx +0 -84
  248. package/src/pages/dev.ts +0 -734
  249. package/src/pages/errors.ts +0 -67
  250. package/src/pages/functions/buildPlugin.ts +0 -113
  251. package/src/pages/functions/buildWorker.ts +0 -348
  252. package/src/pages/functions/filepath-routing.test.ts +0 -234
  253. package/src/pages/functions/filepath-routing.ts +0 -189
  254. package/src/pages/functions/identifiers.ts +0 -78
  255. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  256. package/src/pages/functions/routes-consolidation.ts +0 -73
  257. package/src/pages/functions/routes-transformation.test.ts +0 -282
  258. package/src/pages/functions/routes-transformation.ts +0 -115
  259. package/src/pages/functions/routes-validation.test.ts +0 -403
  260. package/src/pages/functions/routes-validation.ts +0 -202
  261. package/src/pages/functions/routes.ts +0 -151
  262. package/src/pages/functions/tsconfig.json +0 -8
  263. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  264. package/src/pages/functions.ts +0 -86
  265. package/src/pages/hash.ts +0 -13
  266. package/src/pages/index.ts +0 -102
  267. package/src/pages/projects.tsx +0 -159
  268. package/src/pages/prompt-select-project.tsx +0 -31
  269. package/src/pages/publish.tsx +0 -267
  270. package/src/pages/types.ts +0 -46
  271. package/src/pages/upload.tsx +0 -469
  272. package/src/pages/utils.ts +0 -23
  273. package/src/parse.ts +0 -308
  274. package/src/paths.ts +0 -71
  275. package/src/proxy.ts +0 -694
  276. package/src/publish/index.ts +0 -274
  277. package/src/publish/publish.ts +0 -1060
  278. package/src/pubsub/index.ts +0 -286
  279. package/src/pubsub/pubsub-commands.ts +0 -623
  280. package/src/queues/cli/commands/consumer/add.ts +0 -71
  281. package/src/queues/cli/commands/consumer/index.ts +0 -19
  282. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  283. package/src/queues/cli/commands/create.ts +0 -25
  284. package/src/queues/cli/commands/delete.ts +0 -26
  285. package/src/queues/cli/commands/index.ts +0 -35
  286. package/src/queues/cli/commands/list.ts +0 -25
  287. package/src/queues/client.ts +0 -136
  288. package/src/queues/utils.ts +0 -18
  289. package/src/r2/constants.ts +0 -4
  290. package/src/r2/helpers.ts +0 -132
  291. package/src/r2/index.ts +0 -289
  292. package/src/routes.ts +0 -140
  293. package/src/secret/index.ts +0 -376
  294. package/src/selfsigned.d.ts +0 -29
  295. package/src/sites.ts +0 -484
  296. package/src/tail/createTail.ts +0 -406
  297. package/src/tail/filters.ts +0 -277
  298. package/src/tail/index.ts +0 -211
  299. package/src/tail/printing.ts +0 -122
  300. package/src/traverse-module-graph.ts +0 -53
  301. package/src/tsconfig-sanity.ts +0 -16
  302. package/src/type-generation.ts +0 -181
  303. package/src/update-check.ts +0 -19
  304. package/src/user/access.ts +0 -68
  305. package/src/user/auth-variables.ts +0 -113
  306. package/src/user/choose-account.tsx +0 -39
  307. package/src/user/generate-auth-url.ts +0 -33
  308. package/src/user/generate-random-state.ts +0 -16
  309. package/src/user/index.ts +0 -2
  310. package/src/user/user.ts +0 -1234
  311. package/src/utils/collectKeyValues.ts +0 -14
  312. package/src/utils/render.ts +0 -93
  313. package/src/whoami.ts +0 -135
  314. package/src/worker.ts +0 -274
  315. package/src/yargs-types.ts +0 -37
  316. package/src/zones.ts +0 -191
  317. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  318. package/templates/d1-beta-facade.js +0 -244
  319. package/templates/first-party-worker-module-facade.ts +0 -19
  320. package/templates/format-dev-errors.ts +0 -34
  321. package/templates/serve-static-assets.ts +0 -66
  322. package/templates/service-bindings-module-facade.js +0 -55
  323. package/templates/service-bindings-sw-facade.js +0 -42
  324. package/templates/tsconfig.tsbuildinfo +0 -1
@@ -1,115 +0,0 @@
1
- import { join as pathJoin } from "node:path";
2
- import { toUrlPath } from "../../paths";
3
- import {
4
- MAX_FUNCTIONS_ROUTES_RULES,
5
- ROUTES_SPEC_DESCRIPTION,
6
- ROUTES_SPEC_VERSION,
7
- } from "../constants";
8
- import { consolidateRoutes } from "./routes-consolidation";
9
- import type { RouteConfig } from "./routes";
10
-
11
- /** Interface for _routes.json */
12
- export interface RoutesJSONSpec {
13
- version: typeof ROUTES_SPEC_VERSION;
14
- description?: string;
15
- include: string[];
16
- exclude: string[];
17
- }
18
-
19
- type RoutesJSONRouteInput = Pick<RouteConfig, "routePath" | "middleware">[];
20
-
21
- export function convertRoutesToGlobPatterns(
22
- routes: RoutesJSONRouteInput
23
- ): string[] {
24
- const convertedRoutes = routes.map(({ routePath, middleware }) => {
25
- const globbedRoutePath: string = routePath.replace(/:\w+\*?.*/, "*");
26
-
27
- // Middleware mountings need to end in glob so that they can handle their
28
- // own sub-path routes
29
- if (
30
- typeof middleware === "string" ||
31
- (Array.isArray(middleware) && middleware.length > 0)
32
- ) {
33
- if (!globbedRoutePath.endsWith("*")) {
34
- return toUrlPath(pathJoin(globbedRoutePath, "*"));
35
- }
36
- }
37
-
38
- return toUrlPath(globbedRoutePath);
39
- });
40
-
41
- return Array.from(new Set(convertedRoutes));
42
- }
43
-
44
- /**
45
- * Converts Functions routes like /foo/:bar to a Routing object that's used
46
- * to determine if a request should run in the Functions user-worker.
47
- * Also consolidates redundant routes such as [/foo/bar, /foo/:bar] -> /foo/*
48
- *
49
- * @returns RoutesJSONSpec to be written to _routes.json
50
- */
51
- export function convertRoutesToRoutesJSONSpec(
52
- routes: RoutesJSONRouteInput
53
- ): RoutesJSONSpec {
54
- // The initial routes coming in are sorted most-specific to least-specific.
55
- // The order doesn't have any affect on the output of this function, but
56
- // it should speed up route consolidation with less-specific routes being first.
57
- const reversedRoutes = [...routes].reverse();
58
- const include = convertRoutesToGlobPatterns(reversedRoutes);
59
- return optimizeRoutesJSONSpec({
60
- version: ROUTES_SPEC_VERSION,
61
- description: ROUTES_SPEC_DESCRIPTION,
62
- include,
63
- exclude: [],
64
- });
65
- }
66
-
67
- /**
68
- * Optimizes and returns a new Routes JSON Spec instance performing
69
- * de-duping, consolidation, truncation, and sorting
70
- */
71
- export function optimizeRoutesJSONSpec(spec: RoutesJSONSpec): RoutesJSONSpec {
72
- const optimizedSpec = { ...spec };
73
-
74
- let consolidatedRoutes = consolidateRoutes(optimizedSpec.include);
75
- if (consolidatedRoutes.length > MAX_FUNCTIONS_ROUTES_RULES) {
76
- consolidatedRoutes = ["/*"];
77
- }
78
- // Sort so that least-specific routes are first
79
- consolidatedRoutes.sort((a, b) => compareRoutes(b, a));
80
-
81
- optimizedSpec.include = consolidatedRoutes;
82
-
83
- return optimizedSpec;
84
- }
85
-
86
- /**
87
- * Simplified routes comparison (copied from the one in filepath-routing.)
88
- * This version will sort most-specific to least-specific, but the input is simplified
89
- * routes like /foo/*, /foo, etc
90
- */
91
- export function compareRoutes(routeA: string, routeB: string) {
92
- function parseRoutePath(routePath: string): string[] {
93
- return routePath.slice(1).split("/").filter(Boolean);
94
- }
95
-
96
- const segmentsA = parseRoutePath(routeA);
97
- const segmentsB = parseRoutePath(routeB);
98
-
99
- // sort routes with fewer segments after those with more segments
100
- if (segmentsA.length !== segmentsB.length) {
101
- return segmentsB.length - segmentsA.length;
102
- }
103
-
104
- for (let i = 0; i < segmentsA.length; i++) {
105
- const isWildcardA = segmentsA[i].includes("*");
106
- const isWildcardB = segmentsB[i].includes("*");
107
-
108
- // sort wildcard segments after non-wildcard segments
109
- if (isWildcardA && !isWildcardB) return 1;
110
- if (!isWildcardA && isWildcardB) return -1;
111
- }
112
-
113
- // all else equal, just sort the paths lexicographically
114
- return routeA.localeCompare(routeB);
115
- }
@@ -1,403 +0,0 @@
1
- import { FatalError } from "../../errors";
2
- import {
3
- MAX_FUNCTIONS_ROUTES_RULES,
4
- MAX_FUNCTIONS_ROUTES_RULE_LENGTH,
5
- ROUTES_SPEC_VERSION,
6
- } from "../constants";
7
- import { getRoutesValidationErrorMessage } from "../errors";
8
- import {
9
- isRoutesJSONSpec,
10
- RoutesValidationError,
11
- validateRoutes,
12
- } from "./routes-validation";
13
- import type { RoutesJSONSpec } from "./routes-transformation";
14
-
15
- describe("routes-validation", () => {
16
- describe("isRoutesJSONSpec", () => {
17
- it("should return true if the given routes are in a valid RoutesJSONSpec format", () => {
18
- const routes = {
19
- version: ROUTES_SPEC_VERSION,
20
- description: "Test routes Object",
21
- include: [],
22
- exclude: [],
23
- };
24
- const routesWithoutDescription = {
25
- version: ROUTES_SPEC_VERSION,
26
- include: [],
27
- exclude: [],
28
- };
29
-
30
- expect(isRoutesJSONSpec(routes)).toBeTruthy();
31
- expect(isRoutesJSONSpec(routesWithoutDescription)).toBeTruthy();
32
- });
33
-
34
- it("should return false otherwise", () => {
35
- const routesWithMissingVersion = {
36
- include: [],
37
- exclude: [],
38
- };
39
- const routesWithIncorrectVersionNumber = {
40
- version: 1000,
41
- include: [],
42
- exclude: [],
43
- };
44
- const routesWithIncorrectVersionType = {
45
- version: "1000",
46
- include: [],
47
- exclude: [],
48
- };
49
- const routesWithMissingInclude = {
50
- version: ROUTES_SPEC_VERSION,
51
- exclude: [],
52
- };
53
- const routesWithMissingExclude = {
54
- version: ROUTES_SPEC_VERSION,
55
- include: [],
56
- };
57
- const routesWithIncorrectIncludeType = {
58
- version: ROUTES_SPEC_VERSION,
59
- include: "[]",
60
- exclude: [],
61
- };
62
- const routesWithIncorrectExcludeType = {
63
- version: ROUTES_SPEC_VERSION,
64
- include: [],
65
- exclude: { route: "/hello" },
66
- };
67
-
68
- expect(isRoutesJSONSpec(null)).toBeFalsy();
69
- expect(isRoutesJSONSpec({})).toBeFalsy();
70
- expect(isRoutesJSONSpec([])).toBeFalsy();
71
- expect(isRoutesJSONSpec(routesWithMissingVersion)).toBeFalsy();
72
- expect(isRoutesJSONSpec(routesWithIncorrectVersionNumber)).toBeFalsy();
73
- expect(isRoutesJSONSpec(routesWithIncorrectVersionType)).toBeFalsy();
74
- expect(isRoutesJSONSpec(routesWithMissingInclude)).toBeFalsy();
75
- expect(isRoutesJSONSpec(routesWithMissingExclude)).toBeFalsy();
76
- expect(isRoutesJSONSpec(routesWithIncorrectIncludeType)).toBeFalsy();
77
- expect(isRoutesJSONSpec(routesWithIncorrectExcludeType)).toBeFalsy();
78
- });
79
- });
80
-
81
- describe("validateRoutes", () => {
82
- const testRoutesPath = "/public";
83
-
84
- const generateUniqueRoutingRules = (count: number): string[] => {
85
- let counter = 0;
86
- return Array(count)
87
- .fill("/abc")
88
- .map((route) => `${route}${counter++}`);
89
- };
90
-
91
- const generateRoutingRule = (charCount: number): string => {
92
- return `/${Array(charCount).fill("a").join("")}`;
93
- };
94
-
95
- it("should return if the given routes are valid", () => {
96
- const routes: RoutesJSONSpec = {
97
- version: ROUTES_SPEC_VERSION,
98
- description: "Test routes Object",
99
- include: ["/*"],
100
- exclude: [],
101
- };
102
- const routesWithoutDescription: RoutesJSONSpec = {
103
- version: ROUTES_SPEC_VERSION,
104
- include: ["/hello"],
105
- exclude: [],
106
- };
107
-
108
- expect(() => validateRoutes(routes, testRoutesPath)).not.toThrow();
109
- expect(() =>
110
- validateRoutes(routesWithoutDescription, testRoutesPath)
111
- ).not.toThrow();
112
- });
113
-
114
- it("should throw a fatal error if the routes are not a valid RoutesJSONSpec object", () => {
115
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
116
- // @ts-ignore: sanity check
117
- const routesWithoutVersion: RoutesJSONSpec = {
118
- include: ["/*"],
119
- exclude: [],
120
- };
121
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
122
- // @ts-ignore: sanity check
123
- const routesWithoutInclude: RoutesJSONSpec = {
124
- version: ROUTES_SPEC_VERSION,
125
- exclude: [],
126
- };
127
-
128
- expect(() =>
129
- // wrap the code in a function, otherwise the error will not be caught
130
- // and the assertion will fail
131
- validateRoutes(routesWithoutVersion, testRoutesPath)
132
- ).toThrow(FatalError);
133
- expect(() =>
134
- validateRoutes(routesWithoutVersion, testRoutesPath)
135
- ).toThrow(
136
- getRoutesValidationErrorMessage(
137
- RoutesValidationError.INVALID_JSON_SPEC,
138
- testRoutesPath
139
- )
140
- );
141
-
142
- expect(() =>
143
- validateRoutes(routesWithoutInclude, testRoutesPath)
144
- ).toThrow(FatalError);
145
- expect(() =>
146
- validateRoutes(routesWithoutInclude, testRoutesPath)
147
- ).toThrow(
148
- getRoutesValidationErrorMessage(
149
- RoutesValidationError.INVALID_JSON_SPEC,
150
- testRoutesPath
151
- )
152
- );
153
- });
154
-
155
- it("should throw a fatal error if there are no include routing rules", () => {
156
- const routesWithoutIncludeRules: RoutesJSONSpec = {
157
- version: ROUTES_SPEC_VERSION,
158
- description: "Test routes Object",
159
- include: [],
160
- exclude: [],
161
- };
162
-
163
- expect(() =>
164
- validateRoutes(routesWithoutIncludeRules, testRoutesPath)
165
- ).toThrow(FatalError);
166
- expect(() =>
167
- validateRoutes(routesWithoutIncludeRules, testRoutesPath)
168
- ).toThrow(
169
- getRoutesValidationErrorMessage(
170
- RoutesValidationError.NO_INCLUDE_RULES,
171
- testRoutesPath
172
- )
173
- );
174
- });
175
-
176
- it("should throw a fatal error if there are more than MAX_FUNCTIONS_ROUTES_RULES include and exclude routing rules combined", () => {
177
- const routesWithMaxIncludeRules: RoutesJSONSpec = {
178
- version: ROUTES_SPEC_VERSION,
179
- description: "Test routes Object",
180
- include: generateUniqueRoutingRules(MAX_FUNCTIONS_ROUTES_RULES + 1),
181
- exclude: [],
182
- };
183
- const routesWithMaxExcludeRules: RoutesJSONSpec = {
184
- version: ROUTES_SPEC_VERSION,
185
- description: "Test routes Object",
186
- include: ["/hello"],
187
- exclude: generateUniqueRoutingRules(MAX_FUNCTIONS_ROUTES_RULES + 1),
188
- };
189
- const routesWithMaxIncludeExcludeRulesCombined: RoutesJSONSpec = {
190
- version: ROUTES_SPEC_VERSION,
191
- description: "Test routes Object",
192
- include: generateUniqueRoutingRules(
193
- Math.floor(MAX_FUNCTIONS_ROUTES_RULES / 2) + 1
194
- ),
195
- exclude: generateUniqueRoutingRules(
196
- Math.floor(MAX_FUNCTIONS_ROUTES_RULES / 2)
197
- ),
198
- };
199
-
200
- expect(() =>
201
- validateRoutes(routesWithMaxIncludeRules, testRoutesPath)
202
- ).toThrow(FatalError);
203
- expect(() =>
204
- validateRoutes(routesWithMaxIncludeRules, testRoutesPath)
205
- ).toThrow(
206
- getRoutesValidationErrorMessage(
207
- RoutesValidationError.TOO_MANY_RULES,
208
- testRoutesPath
209
- )
210
- );
211
-
212
- expect(() =>
213
- validateRoutes(routesWithMaxExcludeRules, testRoutesPath)
214
- ).toThrow(FatalError);
215
- expect(() =>
216
- validateRoutes(routesWithMaxExcludeRules, testRoutesPath)
217
- ).toThrow(
218
- getRoutesValidationErrorMessage(
219
- RoutesValidationError.TOO_MANY_RULES,
220
- testRoutesPath
221
- )
222
- );
223
-
224
- expect(() =>
225
- validateRoutes(routesWithMaxIncludeExcludeRulesCombined, testRoutesPath)
226
- ).toThrow(FatalError);
227
- expect(() =>
228
- validateRoutes(routesWithMaxIncludeExcludeRulesCombined, testRoutesPath)
229
- ).toThrow(
230
- getRoutesValidationErrorMessage(
231
- RoutesValidationError.TOO_MANY_RULES,
232
- testRoutesPath
233
- )
234
- );
235
- });
236
-
237
- it("should throw a fatal error if any include or exclude routing rule is more than MAX_FUNCTIONS_ROUTES_RULE_LENGTH chars long", () => {
238
- const routesWithMaxCharLengthIncludeRules: RoutesJSONSpec = {
239
- version: ROUTES_SPEC_VERSION,
240
- description: "Test routes Object",
241
- include: [generateRoutingRule(MAX_FUNCTIONS_ROUTES_RULE_LENGTH + 1)],
242
- exclude: [],
243
- };
244
- const routesWithMaxCharLengthExcludeRules: RoutesJSONSpec = {
245
- version: ROUTES_SPEC_VERSION,
246
- description: "Test routes Object",
247
- include: ["/*"],
248
- exclude: [generateRoutingRule(MAX_FUNCTIONS_ROUTES_RULE_LENGTH + 1)],
249
- };
250
- const routesWithMaxCharLengthRules: RoutesJSONSpec = {
251
- version: ROUTES_SPEC_VERSION,
252
- description: "Test routes Object",
253
- include: [generateRoutingRule(MAX_FUNCTIONS_ROUTES_RULE_LENGTH + 1)],
254
- exclude: [generateRoutingRule(MAX_FUNCTIONS_ROUTES_RULE_LENGTH + 1)],
255
- };
256
-
257
- expect(() =>
258
- validateRoutes(routesWithMaxCharLengthIncludeRules, testRoutesPath)
259
- ).toThrow(FatalError);
260
- expect(() =>
261
- validateRoutes(routesWithMaxCharLengthIncludeRules, testRoutesPath)
262
- ).toThrow(
263
- getRoutesValidationErrorMessage(
264
- RoutesValidationError.RULE_TOO_LONG,
265
- testRoutesPath
266
- )
267
- );
268
-
269
- expect(() =>
270
- validateRoutes(routesWithMaxCharLengthExcludeRules, testRoutesPath)
271
- ).toThrow(FatalError);
272
- expect(() =>
273
- validateRoutes(routesWithMaxCharLengthExcludeRules, testRoutesPath)
274
- ).toThrow(
275
- getRoutesValidationErrorMessage(
276
- RoutesValidationError.RULE_TOO_LONG,
277
- testRoutesPath
278
- )
279
- );
280
-
281
- expect(() =>
282
- validateRoutes(routesWithMaxCharLengthRules, testRoutesPath)
283
- ).toThrow(FatalError);
284
- expect(() =>
285
- validateRoutes(routesWithMaxCharLengthRules, testRoutesPath)
286
- ).toThrow(
287
- getRoutesValidationErrorMessage(
288
- RoutesValidationError.RULE_TOO_LONG,
289
- testRoutesPath
290
- )
291
- );
292
- });
293
-
294
- it("should throw a fatal error if any include or exclude routing rule does not start with a `/`", () => {
295
- const routesWithInvalidIncludeRules: RoutesJSONSpec = {
296
- version: ROUTES_SPEC_VERSION,
297
- description: "Test routes Object",
298
- include: ["hello"],
299
- exclude: [],
300
- };
301
- const routesWithInvalidExcludeRules: RoutesJSONSpec = {
302
- version: ROUTES_SPEC_VERSION,
303
- description: "Test routes Object",
304
- include: ["/*"],
305
- exclude: ["hello"],
306
- };
307
- const routesWithInvalidRules: RoutesJSONSpec = {
308
- version: ROUTES_SPEC_VERSION,
309
- description: "Test routes Object",
310
- include: ["hello"],
311
- exclude: ["goodbye"],
312
- };
313
-
314
- expect(() =>
315
- validateRoutes(routesWithInvalidIncludeRules, testRoutesPath)
316
- ).toThrow(FatalError);
317
- expect(() =>
318
- validateRoutes(routesWithInvalidIncludeRules, testRoutesPath)
319
- ).toThrow(
320
- getRoutesValidationErrorMessage(
321
- RoutesValidationError.INVALID_RULES,
322
- testRoutesPath
323
- )
324
- );
325
-
326
- expect(() =>
327
- validateRoutes(routesWithInvalidExcludeRules, testRoutesPath)
328
- ).toThrow(FatalError);
329
- expect(() =>
330
- validateRoutes(routesWithInvalidExcludeRules, testRoutesPath)
331
- ).toThrow(
332
- getRoutesValidationErrorMessage(
333
- RoutesValidationError.INVALID_RULES,
334
- testRoutesPath
335
- )
336
- );
337
-
338
- expect(() =>
339
- validateRoutes(routesWithInvalidRules, testRoutesPath)
340
- ).toThrow(FatalError);
341
- expect(() =>
342
- validateRoutes(routesWithInvalidRules, testRoutesPath)
343
- ).toThrow(
344
- getRoutesValidationErrorMessage(
345
- RoutesValidationError.INVALID_RULES,
346
- testRoutesPath
347
- )
348
- );
349
- });
350
-
351
- it("should throw a fatal error if there are overlapping include rules or overlapping exclude rules", () => {
352
- const routesWithOverlappingIncludeRules: RoutesJSONSpec = {
353
- version: ROUTES_SPEC_VERSION,
354
- include: [
355
- "/greeting/hello",
356
- "/api/time",
357
- "/date",
358
- "/greeting/*",
359
- "/greeting/goodbye",
360
- "/api/*",
361
- ],
362
- exclude: [],
363
- };
364
- const routesWithOverlappingExcludeRules: RoutesJSONSpec = {
365
- version: ROUTES_SPEC_VERSION,
366
- include: ["/hello"],
367
- exclude: [
368
- "/greeting/hello",
369
- "/api/time",
370
- "/date",
371
- "/*",
372
- "/greeting/*",
373
- "/greeting/goodbye",
374
- "/api/*",
375
- ],
376
- };
377
-
378
- expect(() =>
379
- validateRoutes(routesWithOverlappingIncludeRules, testRoutesPath)
380
- ).toThrow(FatalError);
381
- expect(() =>
382
- validateRoutes(routesWithOverlappingIncludeRules, testRoutesPath)
383
- ).toThrow(
384
- getRoutesValidationErrorMessage(
385
- RoutesValidationError.OVERLAPPING_RULES,
386
- testRoutesPath
387
- )
388
- );
389
-
390
- expect(() =>
391
- validateRoutes(routesWithOverlappingExcludeRules, testRoutesPath)
392
- ).toThrow(FatalError);
393
- expect(() =>
394
- validateRoutes(routesWithOverlappingExcludeRules, testRoutesPath)
395
- ).toThrow(
396
- getRoutesValidationErrorMessage(
397
- RoutesValidationError.OVERLAPPING_RULES,
398
- testRoutesPath
399
- )
400
- );
401
- });
402
- });
403
- });
@@ -1,202 +0,0 @@
1
- import { FatalError } from "../../errors";
2
- import {
3
- MAX_FUNCTIONS_ROUTES_RULES,
4
- MAX_FUNCTIONS_ROUTES_RULE_LENGTH,
5
- ROUTES_SPEC_VERSION,
6
- } from "../constants";
7
- import { getRoutesValidationErrorMessage } from "../errors";
8
- import type { RoutesJSONSpec } from "./routes-transformation";
9
-
10
- /* eslint-disable-next-line no-shadow */
11
- export enum RoutesValidationError {
12
- INVALID_JSON_SPEC,
13
- NO_INCLUDE_RULES,
14
- INVALID_RULES,
15
- TOO_MANY_RULES,
16
- RULE_TOO_LONG,
17
- OVERLAPPING_RULES,
18
- }
19
-
20
- /**
21
- * Check if given routes data is a valid RoutesJSONSpec
22
- */
23
- export function isRoutesJSONSpec(data: unknown): data is RoutesJSONSpec {
24
- return (
25
- (typeof data === "object" &&
26
- data &&
27
- "version" in data &&
28
- typeof (data as RoutesJSONSpec).version === "number" &&
29
- (data as RoutesJSONSpec).version === ROUTES_SPEC_VERSION &&
30
- Array.isArray((data as RoutesJSONSpec).include) &&
31
- Array.isArray((data as RoutesJSONSpec).exclude)) ||
32
- false
33
- );
34
- }
35
-
36
- export function validateRoutes(routesJSON: RoutesJSONSpec, routesPath: string) {
37
- if (!isRoutesJSONSpec(routesJSON)) {
38
- throw new FatalError(
39
- getRoutesValidationErrorMessage(
40
- RoutesValidationError.INVALID_JSON_SPEC,
41
- routesPath
42
- ),
43
- 1
44
- );
45
- }
46
-
47
- if (!hasIncludeRules(routesJSON)) {
48
- throw new FatalError(
49
- getRoutesValidationErrorMessage(
50
- RoutesValidationError.NO_INCLUDE_RULES,
51
- routesPath
52
- ),
53
- 1
54
- );
55
- }
56
-
57
- if (!hasValidRulesCount(routesJSON)) {
58
- throw new FatalError(
59
- getRoutesValidationErrorMessage(
60
- RoutesValidationError.TOO_MANY_RULES,
61
- routesPath
62
- ),
63
- 1
64
- );
65
- }
66
-
67
- if (!hasValidRuleCharCount(routesJSON)) {
68
- throw new FatalError(
69
- getRoutesValidationErrorMessage(
70
- RoutesValidationError.RULE_TOO_LONG,
71
- routesPath
72
- ),
73
- 1
74
- );
75
- }
76
-
77
- if (!hasValidRules(routesJSON)) {
78
- throw new FatalError(
79
- getRoutesValidationErrorMessage(
80
- RoutesValidationError.INVALID_RULES,
81
- routesPath
82
- ),
83
- 1
84
- );
85
- }
86
-
87
- if (
88
- hasOverlappingRules(routesJSON.include) ||
89
- hasOverlappingRules(routesJSON.exclude)
90
- ) {
91
- throw new FatalError(
92
- getRoutesValidationErrorMessage(
93
- RoutesValidationError.OVERLAPPING_RULES,
94
- routesPath
95
- ),
96
- 1
97
- );
98
- }
99
- }
100
-
101
- /**
102
- * Returns true if the given `routingSpec` object contains at least
103
- * `MIN_FUNCTIONS_ROUTES_INCLUDE_RULES` include routing rules
104
- */
105
- function hasIncludeRules(routesJSON: RoutesJSONSpec): boolean {
106
- // sanity check
107
- // this should never be the case, because of the context from which these validation fns are
108
- // called, but let's not assume anything
109
- if (!routesJSON || !routesJSON.include) {
110
- throw new Error(
111
- "Function `hasIncludeRules` was called out of context. Attempting to validate include rules for routes that are undefined or an invalid RoutesJSONSpec"
112
- );
113
- }
114
-
115
- return routesJSON?.include?.length > 0;
116
- }
117
-
118
- /**
119
- * Returns true if the given `routesJSON` object contains at most MAX_FUNCTIONS_ROUTES_RULES
120
- * include and exclude routing rules, combined
121
- */
122
- function hasValidRulesCount(routesJSON: RoutesJSONSpec): boolean {
123
- // sanity check
124
- if (!routesJSON || !routesJSON.include || !routesJSON.exclude) {
125
- throw new Error(
126
- "Function `hasValidRulesCount` was called out of context. Attempting to validate maximum rules count for routes that are undefined or an invalid RoutesJSONSpec"
127
- );
128
- }
129
-
130
- return (
131
- routesJSON.include.length + routesJSON.exclude.length <=
132
- MAX_FUNCTIONS_ROUTES_RULES
133
- );
134
- }
135
-
136
- /**
137
- * Returns true if each individual routing rule of the given `routesJSON` object is at most
138
- * MAX_FUNCTIONS_ROUTES_RULE_LENGTH characters long
139
- */
140
- function hasValidRuleCharCount(routesJSON: RoutesJSONSpec): boolean {
141
- // sanity check
142
- if (!routesJSON || !routesJSON.include || !routesJSON.exclude) {
143
- throw new Error(
144
- "Function `hasValidRuleCharCount` was called out of context. Attempting to validate rules maximum character count for routes that are undefined or an invalid RoutesJSONSpec"
145
- );
146
- }
147
-
148
- const rules = [...routesJSON.include, ...routesJSON.exclude];
149
- return (
150
- rules.filter((rule) => rule.length > MAX_FUNCTIONS_ROUTES_RULE_LENGTH)
151
- .length === 0
152
- );
153
- }
154
-
155
- /**
156
- * Returns true if each individual routing rule of the given `routesJSON` object is valid.
157
- * We consider a rule to be valid if it is prefixed by slash ('/')
158
- */
159
- function hasValidRules(routesJSON: RoutesJSONSpec): boolean {
160
- // sanity check
161
- if (!routesJSON || !routesJSON.include || !routesJSON.exclude) {
162
- throw new Error(
163
- "Function `hasValidRules` was called out of context. Attempting to validate rules for routes that are undefined or an invalid RoutesJSONSpec"
164
- );
165
- }
166
-
167
- const rules = [...routesJSON.include, ...routesJSON.exclude];
168
- return rules.filter((rule) => !rule.match(/^\//)).length === 0;
169
- }
170
-
171
- /**
172
- * Returns true if the given routes array has overlapping routing rules (eg. ["/api/*"", "/api/foo"])
173
- *
174
- * based on `consolidateRoutes()`
175
- * 🚨 O(n2) time complexity 🚨
176
- */
177
- function hasOverlappingRules(routes: string[]): boolean {
178
- if (!routes) {
179
- throw new Error(
180
- "Function `hasverlappingRules` was called out of context. Attempting to validate rules for routes that are undefined"
181
- );
182
- }
183
-
184
- // Find routes that might render other routes redundant
185
- const endingSplatRoutes = routes.filter((route) => route.endsWith("/*"));
186
-
187
- for (let i = 0; i < endingSplatRoutes.length; i++) {
188
- const crrRoute = endingSplatRoutes[i];
189
- // Remove splat at the end, leaving the /
190
- // eg. /api/* -> /api/
191
- const crrRouteTrimmed = crrRoute.substring(0, crrRoute.length - 1);
192
-
193
- for (let j = 0; j < routes.length; j++) {
194
- const nextRoute = routes[j];
195
- if (nextRoute !== crrRoute && nextRoute.startsWith(crrRouteTrimmed)) {
196
- return true;
197
- }
198
- }
199
- }
200
-
201
- return false;
202
- }