wrangler 0.0.0-ecc8b172 → 0.0.0-ecded1af1

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 (250) hide show
  1. package/README.md +17 -19
  2. package/bin/wrangler.js +24 -93
  3. package/config-schema.json +3115 -0
  4. package/package.json +197 -190
  5. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  6. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  7. package/templates/__tests__/tsconfig.json +8 -0
  8. package/templates/checked-fetch.js +19 -6
  9. package/templates/facade.d.ts +19 -0
  10. package/templates/gitignore +2 -3
  11. package/templates/init-tests/test-jest-new-worker.js +3 -5
  12. package/templates/init-tests/test-vitest-new-worker.js +4 -6
  13. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  14. package/templates/middleware/common.ts +9 -4
  15. package/templates/middleware/loader-modules.ts +94 -44
  16. package/templates/middleware/loader-sw.ts +48 -32
  17. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  18. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  19. package/templates/middleware/middleware-mock-analytics-engine.d.ts +3 -0
  20. package/templates/middleware/middleware-mock-analytics-engine.ts +30 -0
  21. package/templates/middleware/middleware-scheduled.ts +15 -1
  22. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  23. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  24. package/templates/modules-watch-stub.js +4 -0
  25. package/templates/new-worker-scheduled.ts +1 -1
  26. package/templates/new-worker.ts +4 -1
  27. package/templates/pages-dev-pipeline.ts +10 -13
  28. package/templates/pages-dev-util.ts +55 -0
  29. package/templates/pages-shim.ts +1 -1
  30. package/templates/pages-template-plugin.ts +37 -14
  31. package/templates/pages-template-worker.ts +33 -7
  32. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  33. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  34. package/templates/tsconfig-sanity.ts +11 -0
  35. package/templates/tsconfig.init.json +22 -0
  36. package/templates/tsconfig.json +5 -102
  37. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  38. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  39. package/wrangler-dist/ProxyWorker.js +241 -0
  40. package/wrangler-dist/ProxyWorker.js.map +6 -0
  41. package/wrangler-dist/cli.d.ts +26095 -471
  42. package/wrangler-dist/cli.js +178062 -122008
  43. package/wrangler-dist/wasm-sync.wasm +0 -0
  44. package/Cloudflare_CA.pem +0 -18
  45. package/import_meta_url.js +0 -3
  46. package/miniflare-config-stubs/.env.empty +0 -0
  47. package/miniflare-config-stubs/package.empty.json +0 -1
  48. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  49. package/miniflare-dist/index.mjs +0 -6310
  50. package/src/__tests__/api-dev.test.ts +0 -209
  51. package/src/__tests__/api-devregistry.test.js +0 -56
  52. package/src/__tests__/api.test.ts +0 -80
  53. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  54. package/src/__tests__/config-cache.test.ts +0 -42
  55. package/src/__tests__/configuration.test.ts +0 -3864
  56. package/src/__tests__/d1.test.ts +0 -70
  57. package/src/__tests__/delete.test.ts +0 -116
  58. package/src/__tests__/dev.test.tsx +0 -1357
  59. package/src/__tests__/dialogs.test.tsx +0 -40
  60. package/src/__tests__/generate.test.ts +0 -235
  61. package/src/__tests__/get-host-from-url.test.ts +0 -16
  62. package/src/__tests__/guess-worker-format.test.ts +0 -85
  63. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  64. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  65. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  66. package/src/__tests__/helpers/mock-bin.ts +0 -36
  67. package/src/__tests__/helpers/mock-cfetch.ts +0 -333
  68. package/src/__tests__/helpers/mock-console.ts +0 -106
  69. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  70. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -8
  71. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  72. package/src/__tests__/helpers/mock-istty.ts +0 -74
  73. package/src/__tests__/helpers/mock-known-routes.ts +0 -7
  74. package/src/__tests__/helpers/mock-kv.ts +0 -33
  75. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -252
  76. package/src/__tests__/helpers/mock-process.ts +0 -39
  77. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  78. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  79. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -104
  80. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -36
  81. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -80
  82. package/src/__tests__/helpers/msw/handlers/script.ts +0 -75
  83. package/src/__tests__/helpers/msw/handlers/user.ts +0 -63
  84. package/src/__tests__/helpers/msw/index.ts +0 -15
  85. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  86. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  87. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  88. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  89. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  90. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  91. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  92. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  93. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  94. package/src/__tests__/https-options.test.ts +0 -163
  95. package/src/__tests__/index.test.ts +0 -251
  96. package/src/__tests__/init.test.ts +0 -2816
  97. package/src/__tests__/jest.setup.ts +0 -191
  98. package/src/__tests__/kv.test.ts +0 -1675
  99. package/src/__tests__/logger.test.ts +0 -141
  100. package/src/__tests__/metrics.test.ts +0 -450
  101. package/src/__tests__/middleware.scheduled.test.ts +0 -135
  102. package/src/__tests__/middleware.test.ts +0 -726
  103. package/src/__tests__/package-manager.test.ts +0 -353
  104. package/src/__tests__/pages.test.ts +0 -2111
  105. package/src/__tests__/parse.test.ts +0 -330
  106. package/src/__tests__/paths.test.ts +0 -39
  107. package/src/__tests__/publish.test.ts +0 -7119
  108. package/src/__tests__/pubsub.test.ts +0 -367
  109. package/src/__tests__/r2.test.ts +0 -371
  110. package/src/__tests__/route.test.ts +0 -45
  111. package/src/__tests__/secret.test.ts +0 -644
  112. package/src/__tests__/tail.test.ts +0 -800
  113. package/src/__tests__/test-old-node-version.js +0 -31
  114. package/src/__tests__/user.test.ts +0 -155
  115. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  116. package/src/__tests__/validate-dev-props.test.ts +0 -56
  117. package/src/__tests__/version.test.ts +0 -35
  118. package/src/__tests__/whoami.test.tsx +0 -278
  119. package/src/__tests__/worker-namespace.test.ts +0 -321
  120. package/src/abort.d.ts +0 -3
  121. package/src/api/dev.ts +0 -208
  122. package/src/api/index.ts +0 -2
  123. package/src/bundle-reporter.tsx +0 -29
  124. package/src/bundle.ts +0 -756
  125. package/src/cfetch/index.ts +0 -160
  126. package/src/cfetch/internal.ts +0 -263
  127. package/src/cli.ts +0 -29
  128. package/src/config/README.md +0 -107
  129. package/src/config/config.ts +0 -275
  130. package/src/config/diagnostics.ts +0 -80
  131. package/src/config/environment.ts +0 -505
  132. package/src/config/index.ts +0 -293
  133. package/src/config/validation-helpers.ts +0 -597
  134. package/src/config/validation.ts +0 -1930
  135. package/src/config-cache.ts +0 -85
  136. package/src/create-worker-preview.ts +0 -275
  137. package/src/create-worker-upload-form.ts +0 -301
  138. package/src/d1/backups.tsx +0 -212
  139. package/src/d1/create.tsx +0 -54
  140. package/src/d1/delete.tsx +0 -56
  141. package/src/d1/execute.tsx +0 -294
  142. package/src/d1/formatTimeAgo.ts +0 -14
  143. package/src/d1/index.ts +0 -75
  144. package/src/d1/list.tsx +0 -48
  145. package/src/d1/options.ts +0 -12
  146. package/src/d1/types.tsx +0 -14
  147. package/src/d1/utils.ts +0 -39
  148. package/src/delete.ts +0 -86
  149. package/src/deprecated/index.ts +0 -453
  150. package/src/dev/dev-vars.ts +0 -36
  151. package/src/dev/dev.tsx +0 -575
  152. package/src/dev/get-local-persistence-path.tsx +0 -31
  153. package/src/dev/local.tsx +0 -686
  154. package/src/dev/remote.tsx +0 -601
  155. package/src/dev/start-server.ts +0 -506
  156. package/src/dev/use-esbuild.ts +0 -197
  157. package/src/dev/validate-dev-props.ts +0 -31
  158. package/src/dev-registry.tsx +0 -201
  159. package/src/dev.tsx +0 -865
  160. package/src/dialogs.tsx +0 -163
  161. package/src/dispatch-namespace.ts +0 -206
  162. package/src/durable.ts +0 -102
  163. package/src/entry.ts +0 -329
  164. package/src/environment-variables.ts +0 -50
  165. package/src/errors.ts +0 -11
  166. package/src/git-client.ts +0 -124
  167. package/src/global-wrangler-config-path.ts +0 -26
  168. package/src/https-options.ts +0 -127
  169. package/src/index.tsx +0 -582
  170. package/src/init.ts +0 -970
  171. package/src/inspect.ts +0 -747
  172. package/src/intl-polyfill.d.ts +0 -139
  173. package/src/is-ci.ts +0 -14
  174. package/src/is-interactive.ts +0 -12
  175. package/src/kv/helpers.ts +0 -430
  176. package/src/kv/index.ts +0 -645
  177. package/src/logger.ts +0 -80
  178. package/src/metrics/index.ts +0 -5
  179. package/src/metrics/metrics-config.ts +0 -239
  180. package/src/metrics/metrics-dispatcher.ts +0 -96
  181. package/src/metrics/metrics-usage-headers.ts +0 -24
  182. package/src/metrics/send-event.ts +0 -94
  183. package/src/miniflare-cli/README.md +0 -30
  184. package/src/miniflare-cli/assets.ts +0 -215
  185. package/src/miniflare-cli/index.ts +0 -208
  186. package/src/miniflare-cli/request-context.ts +0 -40
  187. package/src/module-collection.ts +0 -267
  188. package/src/open-in-browser.ts +0 -17
  189. package/src/package-manager.ts +0 -219
  190. package/src/pages/build.tsx +0 -238
  191. package/src/pages/constants.ts +0 -16
  192. package/src/pages/deployments.tsx +0 -106
  193. package/src/pages/dev.tsx +0 -689
  194. package/src/pages/errors.ts +0 -66
  195. package/src/pages/functions/buildPlugin.ts +0 -110
  196. package/src/pages/functions/buildWorker.ts +0 -156
  197. package/src/pages/functions/filepath-routing.test.ts +0 -234
  198. package/src/pages/functions/filepath-routing.ts +0 -189
  199. package/src/pages/functions/identifiers.ts +0 -78
  200. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  201. package/src/pages/functions/routes-consolidation.ts +0 -73
  202. package/src/pages/functions/routes-transformation.test.ts +0 -282
  203. package/src/pages/functions/routes-transformation.ts +0 -115
  204. package/src/pages/functions/routes-validation.test.ts +0 -403
  205. package/src/pages/functions/routes-validation.ts +0 -202
  206. package/src/pages/functions/routes.ts +0 -151
  207. package/src/pages/functions.tsx +0 -82
  208. package/src/pages/hash.tsx +0 -13
  209. package/src/pages/index.tsx +0 -94
  210. package/src/pages/projects.tsx +0 -169
  211. package/src/pages/publish.tsx +0 -436
  212. package/src/pages/types.ts +0 -49
  213. package/src/pages/upload.tsx +0 -398
  214. package/src/pages/utils.ts +0 -12
  215. package/src/parse.ts +0 -286
  216. package/src/paths.ts +0 -71
  217. package/src/proxy.ts +0 -657
  218. package/src/publish/index.ts +0 -267
  219. package/src/publish/publish.ts +0 -913
  220. package/src/pubsub/index.ts +0 -286
  221. package/src/pubsub/pubsub-commands.tsx +0 -623
  222. package/src/r2/helpers.ts +0 -131
  223. package/src/r2/index.ts +0 -277
  224. package/src/routes.ts +0 -140
  225. package/src/secret/index.ts +0 -403
  226. package/src/selfsigned.d.ts +0 -29
  227. package/src/sites.tsx +0 -372
  228. package/src/tail/createTail.ts +0 -315
  229. package/src/tail/filters.ts +0 -277
  230. package/src/tail/index.ts +0 -217
  231. package/src/tail/printing.ts +0 -107
  232. package/src/update-check.ts +0 -19
  233. package/src/user/choose-account.tsx +0 -69
  234. package/src/user/env-vars.ts +0 -46
  235. package/src/user/generate-auth-url.ts +0 -33
  236. package/src/user/generate-random-state.ts +0 -16
  237. package/src/user/index.ts +0 -3
  238. package/src/user/user.tsx +0 -1192
  239. package/src/utils/collectKeyValues.ts +0 -14
  240. package/src/whoami.tsx +0 -169
  241. package/src/worker.ts +0 -234
  242. package/src/yargs-types.ts +0 -7
  243. package/src/zones.ts +0 -165
  244. package/templates/d1-beta-facade.js +0 -174
  245. package/templates/experimental-local-cache-stubs.js +0 -27
  246. package/templates/first-party-worker-module-facade.ts +0 -18
  247. package/templates/format-dev-errors.ts +0 -32
  248. package/templates/serve-static-assets.ts +0 -63
  249. package/templates/service-bindings-module-facade.js +0 -54
  250. package/templates/service-bindings-sw-facade.js +0 -42
@@ -1,189 +0,0 @@
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
- }
@@ -1,78 +0,0 @@
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
- );
@@ -1,250 +0,0 @@
1
- import { consolidateRoutes, shortenRoute } from "./routes-consolidation";
2
-
3
- describe("route-consolidation", () => {
4
- const maxRuleLength = 100; // from constants.MAX_FUNCTIONS_ROUTES_RULE_LENGTH
5
- describe("consolidateRoutes()", () => {
6
- it("should consolidate redundant routes", () => {
7
- expect(consolidateRoutes(["/api/foo", "/api/*"])).toEqual(["/api/*"]);
8
- expect(
9
- consolidateRoutes([
10
- "/api/foo",
11
- "/api/foo/*",
12
- "/api/bar/*",
13
- "/api/*",
14
- "/foo",
15
- "/foo/bar",
16
- "/bar/*",
17
- "/bar/baz/*",
18
- "/bar/baz/hello",
19
- ])
20
- ).toEqual(["/api/*", "/foo", "/foo/bar", "/bar/*"]);
21
- });
22
- it("should consolidate thousands of redundant routes", () => {
23
- // Test to make sure the consolidator isn't horribly slow
24
- const routes: string[] = [];
25
- const limit = 1000;
26
- for (let i = 0; i < limit; i++) {
27
- // Add 3 routes per id
28
- const id = `some-id-${i}`;
29
- routes.push(`/${id}/*`, `/${id}/foo`, `/${id}/bar/*`);
30
- }
31
- const consolidated = consolidateRoutes(routes);
32
- expect(consolidated.length).toEqual(limit);
33
- // Should be all unique
34
- expect(Array.from(new Set(consolidated)).length).toEqual(limit);
35
- // Should all have pattern `/$id/*`
36
- expect(
37
- consolidated.every((route) => route.match(/\/[a-z0-9-]+\/\*/) !== null)
38
- ).toEqual(true);
39
- });
40
-
41
- it("should consolidate many redundant sub-routes", () => {
42
- const routes: string[] = [];
43
- const limit = 15;
44
-
45
- // Create $limit of top-level catch-all routes, with a lot of sub-routes
46
- for (let i = 0; i < limit; i++) {
47
- routes.push(`/foo-${i}/*`);
48
- for (let j = 0; j < limit; j++) {
49
- routes.push(`/foo-${i}/bar-${j}/hello`);
50
- for (let k = 0; k < limit; k++) {
51
- routes.push(`/foo-${i}/bar-${j}/baz-${k}/*`);
52
- routes.push(`/foo-${i}/bar-${j}/baz-${k}/profile`);
53
- }
54
- }
55
- }
56
-
57
- const consolidated = consolidateRoutes(routes);
58
- expect(consolidated.length).toEqual(limit);
59
- // Should be all unique
60
- expect(Array.from(new Set(consolidated)).length).toEqual(limit);
61
- // Should all have pattern `/$id/*`
62
- expect(
63
- consolidated.every((route) => route.match(/\/[a-z0-9-]+\/\*/) !== null)
64
- ).toEqual(true);
65
- });
66
-
67
- it("should truncate long single-level path into catch-all path, removing other paths", () => {
68
- expect(
69
- consolidateRoutes([
70
- // [/aaaaaaa, /foo] -> [/*]
71
- "/" + "a".repeat(maxRuleLength * 2),
72
- "/foo",
73
- "/bar/*",
74
- "/baz/bagel/coffee",
75
- ])
76
- ).toEqual(["/*"]);
77
- });
78
-
79
- it("should truncate long nested path, removing other paths", () => {
80
- expect(
81
- consolidateRoutes([
82
- // [/aaaaaaa, /foo] -> [/*]
83
- "/foo/" + "a".repeat(maxRuleLength * 2),
84
- "/foo/bar",
85
- ])
86
- ).toEqual(["/foo/*"]);
87
- });
88
- });
89
-
90
- describe(`shortenRoute()`, () => {
91
- it("should allow max length path", () => {
92
- const route = "/" + "a".repeat(maxRuleLength - 1);
93
- // Make sure we don't have an off-by-one error, that'd be embarrassing...
94
- expect(route.length).toEqual(maxRuleLength);
95
- expect(
96
- // Should stay the same
97
- shortenRoute(route)
98
- ).toEqual(route);
99
- });
100
-
101
- it("should allow max length path (with slash)", () => {
102
- const route = "/" + "a".repeat(maxRuleLength - 2) + "/";
103
- expect(route.length).toEqual(maxRuleLength);
104
- expect(
105
- // Should stay the same
106
- shortenRoute(route)
107
- ).toEqual(route);
108
- });
109
-
110
- it("should allow max length wildcard path", () => {
111
- const route = "/" + "a".repeat(maxRuleLength - 3) + "/*";
112
- expect(route.length).toEqual(maxRuleLength);
113
- expect(
114
- // Should stay the same
115
- shortenRoute(route)
116
- ).toEqual(route);
117
- });
118
-
119
- it("should truncate long specific path to shorter wildcard path", () => {
120
- const short = shortenRoute(
121
- // /aaa/bbb -> /aaa/*
122
- "/" +
123
- "a".repeat(maxRuleLength * 0.6) +
124
- "/" +
125
- "b".repeat(maxRuleLength * 0.6)
126
- );
127
- expect(short).toEqual("/" + "a".repeat(maxRuleLength * 0.6) + "/*");
128
- expect(short.length).toBeLessThanOrEqual(maxRuleLength);
129
- });
130
-
131
- it("should truncate long specific path (with slash) to shorter wildcard path", () => {
132
- const short = shortenRoute(
133
- // /aaa/bbb/ -> /aaa/*
134
- "/" +
135
- "a".repeat(maxRuleLength * 0.6) +
136
- "/" +
137
- "b".repeat(maxRuleLength * 0.6) +
138
- "/"
139
- );
140
- expect(short).toEqual("/" + "a".repeat(maxRuleLength * 0.6) + "/*");
141
- expect(short.length).toBeLessThanOrEqual(maxRuleLength);
142
- });
143
-
144
- it("should truncate long wildcard path to shorter wildcard path", () => {
145
- const short = shortenRoute(
146
- // /aaa/bbb/* -> /aaa/*
147
- "/" +
148
- "a".repeat(maxRuleLength * 0.6) +
149
- "/" +
150
- "b".repeat(maxRuleLength * 0.6) +
151
- "/*"
152
- );
153
- expect(short).toEqual("/" + "a".repeat(maxRuleLength * 0.6) + "/*");
154
- expect(short.length).toBeLessThanOrEqual(maxRuleLength);
155
- });
156
-
157
- it("should truncate long single-level specific path to catch-all path", () => {
158
- expect(
159
- shortenRoute(
160
- // /aaa -> /*
161
- "/" + "a".repeat(maxRuleLength * 2)
162
- )
163
- ).toEqual("/*");
164
- });
165
-
166
- it("should truncate long single-level specific path (with slash) to catch-all path", () => {
167
- expect(
168
- shortenRoute(
169
- // /aaa/ -> /*
170
- "/" + "a".repeat(maxRuleLength * 2) + "/"
171
- )
172
- ).toEqual("/*");
173
- });
174
-
175
- it("should truncate long single-level wildcard path to catch-all path", () => {
176
- expect(
177
- shortenRoute(
178
- // /aaa/* -> /*
179
- "/" + "a".repeat(maxRuleLength * 2) + "/*"
180
- )
181
- ).toEqual("/*");
182
- });
183
-
184
- it("should truncate many single-character segements", () => {
185
- const short = shortenRoute(
186
- // /a/a/a -> /a/a/*
187
- "/a".repeat(maxRuleLength) // 2x limit
188
- );
189
- expect(short).toEqual("/a".repeat(maxRuleLength / 2 - 1) + "/*");
190
- // Should be the exact max length
191
- expect(short.length).toEqual(maxRuleLength);
192
- });
193
-
194
- it("should truncate many double-character segements", () => {
195
- // === odd ===
196
- const short = shortenRoute(
197
- // /aa/aa/aa -> /aa/aa/*
198
- "/aa".repeat(maxRuleLength) // 3x limit
199
- );
200
- expect(short).toEqual("/aa".repeat(maxRuleLength / 3 - 1) + "/*");
201
- // Should be the exact max length
202
- expect(short.length).toEqual(maxRuleLength - 2); // -2 because of the odd number
203
- });
204
-
205
- it("should truncate many single-character segements with wildcard", () => {
206
- const short = shortenRoute(
207
- // /a/a/a -> /a/a/*
208
- "/a".repeat(maxRuleLength) + "/*" // 2x limit
209
- );
210
- expect(short).toEqual("/a".repeat(maxRuleLength / 2 - 1) + "/*");
211
- // Should be the exact max length
212
- expect(short.length).toEqual(maxRuleLength);
213
- });
214
-
215
- it("should truncate many double-character segements with wildcard", () => {
216
- const short = shortenRoute(
217
- // /aa/aa/aa -> /aa/*
218
- "/aa".repeat(maxRuleLength) + "/*" // 2x limit
219
- );
220
- expect(short).toEqual("/aa".repeat(maxRuleLength / 3 - 1) + "/*");
221
- // Should be the exact max length
222
- expect(short.length).toEqual(maxRuleLength - 2); // -2 because of the odd number
223
- });
224
-
225
- // This is probably the best test here - tests variable-length segments, up until the max.
226
- // This ensures that it's always able to shorten rules, without failing and returning "/*"
227
- // The other tests are great for ensuring exact sequences instead of only asserting length, though.
228
- for (const suffix of ["", "/", "/*"]) {
229
- // Test each type of path: /a, /a/a, /a/*
230
- it(`should truncate many variable-character segements (suffix="${suffix}") without truncating to /*`, () => {
231
- // "/" + 97 chars + "/*" === 100
232
- for (let i = 1; i < maxRuleLength - 2; i++) {
233
- const segment = "/" + "a".repeat(i);
234
- // make sure the segment isn't too long since we are testing not resulting to /*
235
- expect(segment.length).toBeLessThanOrEqual(maxRuleLength);
236
- const route =
237
- segment.repeat((maxRuleLength / segment.length) * 2) + suffix;
238
- // Make sure we made the rule too long
239
- expect(route.length).toBeGreaterThan(maxRuleLength);
240
- const short = shortenRoute(route);
241
-
242
- // Make sure it's not over the limit
243
- expect(short.length).toBeLessThanOrEqual(maxRuleLength);
244
- // It should never have to fall back to /*
245
- expect(short).not.toEqual("/*");
246
- }
247
- });
248
- }
249
- });
250
- });
@@ -1,73 +0,0 @@
1
- import { MAX_FUNCTIONS_ROUTES_RULE_LENGTH } from "../constants";
2
-
3
- /**
4
- * consolidateRoutes consolidates redundant routes - eg. ["/api/*"", "/api/foo"] -> ["/api/*""]
5
- * @param routes If this is the same order as Functions routes (with most-specific first),
6
- * it will be more efficient to reverse it first. Should be in the format: /api/foo, /api/*
7
- * @returns Non-redundant list of routes
8
- */
9
- export function consolidateRoutes(routes: string[]): string[] {
10
- // First we need to trim any rules that are too long and deduplicate the result
11
- const routesShortened = Array.from(
12
- new Set(routes.map((route) => shortenRoute(route)))
13
- );
14
-
15
- // create a map of the routes
16
- const routesMap = new Map<string, boolean>();
17
- for (const route of routesShortened) {
18
- routesMap.set(route, true);
19
- }
20
- // Find routes that might render other routes redundant
21
- for (const route of routesShortened.filter((r) => r.endsWith("/*"))) {
22
- // Make sure the route still exists in the map
23
- if (routesMap.has(route)) {
24
- // Remove splat at the end, leaving the /
25
- // eg. /api/* -> /api/
26
- const routeTrimmed = route.substring(0, route.length - 1);
27
- for (const nextRoute of routesMap.keys()) {
28
- // Delete any route that has the wildcard route as a prefix
29
- if (nextRoute !== route && nextRoute.startsWith(routeTrimmed)) {
30
- routesMap.delete(nextRoute);
31
- }
32
- }
33
- }
34
- }
35
- return Array.from(routesMap.keys());
36
- }
37
-
38
- /**
39
- * Shortens a route until it's within the rule length limit defined in
40
- * constants.MAX_FUNCTIONS_ROUTES_RULE_LENGTH
41
- * Eg. /aaa/bbb -> /aaa/*
42
- * @param routeToShorten Route to shorten if needed
43
- * @param maxLength Max length of route to try to shorten to
44
- */
45
- export function shortenRoute(
46
- routeToShorten: string,
47
- maxLength: number = MAX_FUNCTIONS_ROUTES_RULE_LENGTH
48
- ): string {
49
- if (routeToShorten.length <= maxLength) {
50
- return routeToShorten;
51
- }
52
-
53
- let route = routeToShorten;
54
- // May have to try multiple times for longer segments
55
- for (let i = 0; i < routeToShorten.length; i++) {
56
- // Shorten to the first slash within the limit
57
- for (let j = maxLength - 1 - i; j > 0; j--) {
58
- if (route[j] === "/") {
59
- route = route.slice(0, j) + "/*";
60
- break;
61
- }
62
- }
63
- if (route.length <= maxLength) {
64
- break;
65
- }
66
- }
67
-
68
- // If we failed to shorten it, fall back to include-all rather than breaking
69
- if (route.length > maxLength) {
70
- route = "/*";
71
- }
72
- return route;
73
- }