wrangler 0.0.0-e9e9872 → 0.0.0-e9f8a2fa

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 (178) hide show
  1. package/README.md +25 -13
  2. package/bin/wrangler.js +51 -61
  3. package/config-schema.json +2939 -0
  4. package/package.json +222 -160
  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 +0 -4
  11. package/templates/init-tests/test-jest-new-worker.js +23 -0
  12. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  13. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  14. package/templates/middleware/common.ts +67 -0
  15. package/templates/middleware/loader-modules.ts +133 -0
  16. package/templates/middleware/loader-sw.ts +229 -0
  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-pretty-error.ts +40 -0
  20. package/templates/middleware/middleware-scheduled.ts +15 -0
  21. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  22. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  23. package/templates/modules-watch-stub.js +4 -0
  24. package/templates/new-worker-scheduled.ts +1 -1
  25. package/templates/new-worker.js +1 -1
  26. package/templates/new-worker.ts +4 -1
  27. package/templates/pages-dev-pipeline.ts +32 -0
  28. package/templates/pages-dev-util.ts +55 -0
  29. package/templates/pages-shim.ts +9 -0
  30. package/templates/pages-template-plugin.ts +53 -18
  31. package/templates/pages-template-worker.ts +49 -12
  32. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  33. package/templates/startDevWorker/ProxyWorker.ts +334 -0
  34. package/templates/tsconfig-sanity.ts +11 -0
  35. package/templates/tsconfig.init.json +105 -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 +240 -0
  40. package/wrangler-dist/ProxyWorker.js.map +6 -0
  41. package/wrangler-dist/cli.d.ts +23879 -146
  42. package/wrangler-dist/cli.js +186358 -107113
  43. package/wrangler-dist/wasm-sync.wasm +0 -0
  44. package/import_meta_url.js +0 -3
  45. package/miniflare-config-stubs/.env.empty +0 -0
  46. package/miniflare-config-stubs/package.empty.json +0 -1
  47. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  48. package/miniflare-dist/index.mjs +0 -4894
  49. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  50. package/src/__tests__/config-cache.test.ts +0 -42
  51. package/src/__tests__/configuration.test.ts +0 -3946
  52. package/src/__tests__/dev.test.tsx +0 -1159
  53. package/src/__tests__/guess-worker-format.test.ts +0 -85
  54. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  55. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  56. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  57. package/src/__tests__/helpers/mock-bin.ts +0 -36
  58. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  59. package/src/__tests__/helpers/mock-console.ts +0 -97
  60. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  61. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  62. package/src/__tests__/helpers/mock-istty.ts +0 -74
  63. package/src/__tests__/helpers/mock-kv.ts +0 -33
  64. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -250
  65. package/src/__tests__/helpers/mock-process.ts +0 -39
  66. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  67. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  68. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  69. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  70. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  71. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  72. package/src/__tests__/https-options.test.ts +0 -163
  73. package/src/__tests__/index.test.ts +0 -262
  74. package/src/__tests__/init.test.ts +0 -1992
  75. package/src/__tests__/jest.setup.ts +0 -120
  76. package/src/__tests__/kv.test.ts +0 -1650
  77. package/src/__tests__/logger.test.ts +0 -141
  78. package/src/__tests__/package-manager.test.ts +0 -353
  79. package/src/__tests__/pages.test.ts +0 -1254
  80. package/src/__tests__/parse.test.ts +0 -330
  81. package/src/__tests__/publish.test.ts +0 -6595
  82. package/src/__tests__/pubsub.test.ts +0 -367
  83. package/src/__tests__/r2.test.ts +0 -233
  84. package/src/__tests__/route.test.ts +0 -45
  85. package/src/__tests__/secret.test.ts +0 -492
  86. package/src/__tests__/tail.test.ts +0 -698
  87. package/src/__tests__/user.test.ts +0 -143
  88. package/src/__tests__/whoami.test.tsx +0 -230
  89. package/src/__tests__/worker-namespace.test.ts +0 -327
  90. package/src/abort.d.ts +0 -3
  91. package/src/api/dev.ts +0 -52
  92. package/src/api/index.ts +0 -1
  93. package/src/bundle-reporter.tsx +0 -29
  94. package/src/bundle.ts +0 -212
  95. package/src/cfetch/index.ts +0 -121
  96. package/src/cfetch/internal.ts +0 -149
  97. package/src/cli.ts +0 -27
  98. package/src/config/README.md +0 -107
  99. package/src/config/config.ts +0 -243
  100. package/src/config/diagnostics.ts +0 -80
  101. package/src/config/environment.ts +0 -453
  102. package/src/config/index.ts +0 -238
  103. package/src/config/validation-helpers.ts +0 -584
  104. package/src/config/validation.ts +0 -1745
  105. package/src/config-cache.ts +0 -83
  106. package/src/create-worker-preview.ts +0 -255
  107. package/src/create-worker-upload-form.ts +0 -263
  108. package/src/dev/dev-vars.ts +0 -36
  109. package/src/dev/dev.tsx +0 -417
  110. package/src/dev/local.tsx +0 -354
  111. package/src/dev/remote.tsx +0 -382
  112. package/src/dev/use-esbuild.ts +0 -150
  113. package/src/dev.tsx +0 -538
  114. package/src/dialogs.tsx +0 -135
  115. package/src/durable.ts +0 -102
  116. package/src/entry.ts +0 -328
  117. package/src/environment-variables.ts +0 -35
  118. package/src/errors.ts +0 -11
  119. package/src/faye-websocket.d.ts +0 -6
  120. package/src/generate.ts +0 -33
  121. package/src/git-client.ts +0 -42
  122. package/src/global-wrangler-config-path.ts +0 -26
  123. package/src/https-options.ts +0 -127
  124. package/src/index.tsx +0 -1896
  125. package/src/init.ts +0 -549
  126. package/src/inspect.ts +0 -662
  127. package/src/intl-polyfill.d.ts +0 -139
  128. package/src/is-interactive.ts +0 -12
  129. package/src/kv.ts +0 -430
  130. package/src/logger.ts +0 -73
  131. package/src/miniflare-cli/README.md +0 -30
  132. package/src/miniflare-cli/enum-keys.ts +0 -17
  133. package/src/miniflare-cli/index.ts +0 -53
  134. package/src/miniflare-cli/request-context.ts +0 -40
  135. package/src/module-collection.ts +0 -258
  136. package/src/open-in-browser.ts +0 -17
  137. package/src/package-manager.ts +0 -219
  138. package/src/pages/build.tsx +0 -202
  139. package/src/pages/constants.ts +0 -7
  140. package/src/pages/deployments.tsx +0 -101
  141. package/src/pages/dev.tsx +0 -964
  142. package/src/pages/functions/buildPlugin.ts +0 -105
  143. package/src/pages/functions/buildWorker.ts +0 -151
  144. package/src/pages/functions/filepath-routing.test.ts +0 -234
  145. package/src/pages/functions/filepath-routing.ts +0 -189
  146. package/src/pages/functions/identifiers.ts +0 -78
  147. package/src/pages/functions/routes.ts +0 -151
  148. package/src/pages/index.tsx +0 -84
  149. package/src/pages/projects.tsx +0 -157
  150. package/src/pages/publish.tsx +0 -335
  151. package/src/pages/types.ts +0 -40
  152. package/src/pages/upload.tsx +0 -396
  153. package/src/pages/utils.ts +0 -12
  154. package/src/parse.ts +0 -286
  155. package/src/paths.ts +0 -26
  156. package/src/preview.ts +0 -31
  157. package/src/proxy.ts +0 -476
  158. package/src/publish.ts +0 -780
  159. package/src/pubsub/index.ts +0 -286
  160. package/src/pubsub/pubsub-commands.tsx +0 -577
  161. package/src/r2.ts +0 -50
  162. package/src/selfsigned.d.ts +0 -29
  163. package/src/sites.tsx +0 -372
  164. package/src/tail/filters.ts +0 -279
  165. package/src/tail/index.ts +0 -299
  166. package/src/tail/printing.ts +0 -67
  167. package/src/update-check.ts +0 -19
  168. package/src/user/choose-account.tsx +0 -60
  169. package/src/user/env-vars.ts +0 -46
  170. package/src/user/generate-auth-url.ts +0 -33
  171. package/src/user/generate-random-state.ts +0 -16
  172. package/src/user/index.ts +0 -3
  173. package/src/user/user.tsx +0 -1170
  174. package/src/whoami.tsx +0 -90
  175. package/src/worker-namespace.ts +0 -190
  176. package/src/worker.ts +0 -191
  177. package/src/zones.ts +0 -76
  178. package/templates/static-asset-facade.js +0 -49
@@ -1,105 +0,0 @@
1
- import { access, lstat } from "node:fs/promises";
2
- import { dirname, relative, resolve } from "node:path";
3
- import NodeGlobalsPolyfills from "@esbuild-plugins/node-globals-polyfill";
4
- import NodeModulesPolyfills from "@esbuild-plugins/node-modules-polyfill";
5
- import { build } from "esbuild";
6
-
7
- type Options = {
8
- routesModule: string;
9
- outfile: string;
10
- minify?: boolean;
11
- sourcemap?: boolean;
12
- watch?: boolean;
13
- nodeCompat?: boolean;
14
- onEnd?: () => void;
15
- };
16
-
17
- export function buildPlugin({
18
- routesModule,
19
- outfile = "bundle.js",
20
- minify = false,
21
- sourcemap = false,
22
- watch = false,
23
- nodeCompat,
24
- onEnd = () => {},
25
- }: Options) {
26
- return build({
27
- entryPoints: [resolve(__dirname, "../templates/pages-template-plugin.ts")],
28
- inject: [routesModule],
29
- bundle: true,
30
- format: "esm",
31
- target: "esnext",
32
- outfile,
33
- minify,
34
- sourcemap,
35
- watch,
36
- allowOverwrite: true,
37
- define: { ...(nodeCompat ? { global: "globalThis" } : {}) },
38
- plugins: [
39
- {
40
- name: "wrangler notifier and monitor",
41
- setup(pluginBuild) {
42
- pluginBuild.onEnd((result) => {
43
- if (result.errors.length > 0) {
44
- console.error(
45
- `${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
46
- );
47
- } else if (result.warnings.length > 0) {
48
- console.warn(
49
- `${result.warnings.length} warning(s) when compiling Worker.`
50
- );
51
- onEnd();
52
- } else {
53
- console.log("Compiled Worker successfully.");
54
- onEnd();
55
- }
56
- });
57
- },
58
- },
59
- {
60
- name: "Assets",
61
- setup(pluginBuild) {
62
- if (pluginBuild.initialOptions.outfile) {
63
- const outdir = dirname(pluginBuild.initialOptions.outfile);
64
-
65
- pluginBuild.onResolve({ filter: /^assets:/ }, async (args) => {
66
- const directory = resolve(
67
- args.resolveDir,
68
- args.path.slice("assets:".length)
69
- );
70
-
71
- const exists = await access(directory)
72
- .then(() => true)
73
- .catch(() => false);
74
-
75
- const isDirectory =
76
- exists && (await lstat(directory)).isDirectory();
77
-
78
- if (!isDirectory) {
79
- return {
80
- errors: [
81
- {
82
- text: `'${directory}' does not exist or is not a directory.`,
83
- },
84
- ],
85
- };
86
- }
87
-
88
- const path = `assets:./${relative(outdir, directory)}`;
89
-
90
- return { path, external: true, namespace: "assets" };
91
- });
92
- }
93
- },
94
- },
95
- ...(nodeCompat
96
- ? [
97
- NodeGlobalsPolyfills({
98
- buffer: true,
99
- }),
100
- NodeModulesPolyfills(),
101
- ]
102
- : []),
103
- ],
104
- });
105
- }
@@ -1,151 +0,0 @@
1
- import { access, cp, lstat, rm } from "node:fs/promises";
2
- import { join, resolve } from "node:path";
3
- import NodeGlobalsPolyfills from "@esbuild-plugins/node-globals-polyfill";
4
- import NodeModulesPolyfills from "@esbuild-plugins/node-modules-polyfill";
5
- import { build } from "esbuild";
6
- import { nanoid } from "nanoid";
7
-
8
- type Options = {
9
- routesModule: string;
10
- outfile: string;
11
- minify?: boolean;
12
- sourcemap?: boolean;
13
- fallbackService?: string;
14
- watch?: boolean;
15
- onEnd?: () => void;
16
- buildOutputDirectory?: string;
17
- nodeCompat?: boolean;
18
- };
19
-
20
- export function buildWorker({
21
- routesModule,
22
- outfile = "bundle.js",
23
- minify = false,
24
- sourcemap = false,
25
- fallbackService = "ASSETS",
26
- watch = false,
27
- onEnd = () => {},
28
- buildOutputDirectory,
29
- nodeCompat,
30
- }: Options) {
31
- return build({
32
- entryPoints: [resolve(__dirname, "../templates/pages-template-worker.ts")],
33
- inject: [routesModule],
34
- bundle: true,
35
- format: "esm",
36
- target: "esnext",
37
- outfile,
38
- minify,
39
- sourcemap,
40
- watch,
41
- allowOverwrite: true,
42
- define: {
43
- __FALLBACK_SERVICE__: JSON.stringify(fallbackService),
44
- ...(nodeCompat ? { global: "globalThis" } : {}),
45
- },
46
- plugins: [
47
- {
48
- name: "wrangler notifier and monitor",
49
- setup(pluginBuild) {
50
- pluginBuild.onEnd((result) => {
51
- if (result.errors.length > 0) {
52
- console.error(
53
- `${result.errors.length} error(s) and ${result.warnings.length} warning(s) when compiling Worker.`
54
- );
55
- } else if (result.warnings.length > 0) {
56
- console.warn(
57
- `${result.warnings.length} warning(s) when compiling Worker.`
58
- );
59
- onEnd();
60
- } else {
61
- console.log("Compiled Worker successfully.");
62
- onEnd();
63
- }
64
- });
65
- },
66
- },
67
- {
68
- name: "Assets",
69
- setup(pluginBuild) {
70
- const identifiers = new Map<string, string>();
71
-
72
- pluginBuild.onResolve({ filter: /^assets:/ }, async (args) => {
73
- const directory = resolve(
74
- args.resolveDir,
75
- args.path.slice("assets:".length)
76
- );
77
-
78
- const exists = await access(directory)
79
- .then(() => true)
80
- .catch(() => false);
81
-
82
- const isDirectory =
83
- exists && (await lstat(directory)).isDirectory();
84
-
85
- if (!isDirectory) {
86
- return {
87
- errors: [
88
- {
89
- text: `'${directory}' does not exist or is not a directory.`,
90
- },
91
- ],
92
- };
93
- }
94
-
95
- // TODO: Consider hashing the contents rather than using a unique identifier every time?
96
- identifiers.set(directory, nanoid());
97
- if (!buildOutputDirectory) {
98
- console.warn(
99
- "You're attempting to import static assets as part of your Pages Functions, but have not specified a directory in which to put them. You must use 'wrangler pages dev <directory>' rather than 'wrangler pages dev -- <command>' to import static assets in Functions."
100
- );
101
- }
102
- return { path: directory, namespace: "assets" };
103
- });
104
-
105
- pluginBuild.onLoad(
106
- { filter: /.*/, namespace: "assets" },
107
- async (args) => {
108
- const identifier = identifiers.get(args.path);
109
-
110
- if (buildOutputDirectory) {
111
- const staticAssetsOutputDirectory = join(
112
- buildOutputDirectory,
113
- "cdn-cgi",
114
- "pages-plugins",
115
- identifier as string
116
- );
117
- await rm(staticAssetsOutputDirectory, {
118
- force: true,
119
- recursive: true,
120
- });
121
- await cp(args.path, staticAssetsOutputDirectory, {
122
- force: true,
123
- recursive: true,
124
- });
125
-
126
- return {
127
- // TODO: Watch args.path for changes and re-copy when updated
128
- contents: `export const onRequest = ({ request, env, functionPath }) => {
129
- const url = new URL(request.url)
130
- const relativePathname = \`/\${url.pathname.split(functionPath)[1] || ''}\`.replace(/^\\/\\//, '/');
131
- url.pathname = '/cdn-cgi/pages-plugins/${identifier}' + relativePathname
132
- request = new Request(url.toString(), request)
133
- return env.ASSETS.fetch(request)
134
- }`,
135
- };
136
- }
137
- }
138
- );
139
- },
140
- },
141
- ...(nodeCompat
142
- ? [
143
- NodeGlobalsPolyfills({
144
- buffer: true,
145
- }),
146
- NodeModulesPolyfills(),
147
- ]
148
- : []),
149
- ],
150
- });
151
- }
@@ -1,234 +0,0 @@
1
- import { writeFileSync, mkdirSync } from "fs";
2
- import { runInTempDir } from "../../__tests__/helpers/run-in-tmp";
3
- import { toUrlPath } from "../../paths";
4
- import { compareRoutes, generateConfigFromFileTree } from "./filepath-routing";
5
- import type { UrlPath } from "../../paths";
6
- import type { HTTPMethod, RouteConfig } from "./routes";
7
-
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
- `
74
- export function onRequestGet() {}
75
- export function onRequestPost() {}
76
- `
77
- );
78
- writeFileSync(
79
- "bar.ts",
80
- `
81
- export function onRequestPut() {}
82
- export function onRequestDelete() {}
83
- `
84
- );
85
-
86
- mkdirSync("todos");
87
-
88
- writeFileSync(
89
- "todos/[id].ts",
90
- `
91
- export function onRequestPost() {}
92
- export function onRequestDelete() {}
93
- `
94
- );
95
-
96
- mkdirSync("authors");
97
- mkdirSync("authors/[authorId]");
98
- mkdirSync("authors/[authorId]/todos");
99
-
100
- writeFileSync(
101
- "authors/[authorId]/todos/[todoId].ts",
102
- `
103
- export function onRequestPost() {}
104
- `
105
- );
106
-
107
- mkdirSync("books");
108
-
109
- writeFileSync(
110
- "books/[[title]].ts",
111
- `
112
- export function onRequestPost() {}
113
- `
114
- );
115
-
116
- mkdirSync("cats");
117
- mkdirSync("cats/[[breed]]");
118
-
119
- writeFileSync(
120
- "cats/[[breed]]/blah.ts",
121
- `
122
- export function onRequestPost() {}
123
- `
124
- );
125
-
126
- // This won't actually work at runtime.
127
- writeFileSync(
128
- "cats/[[breed]]/[[name]].ts",
129
- `
130
- export function onRequestPost() {}
131
- `
132
- );
133
-
134
- const entries = await generateConfigFromFileTree({
135
- baseDir: ".",
136
- baseURL: "/base" as UrlPath,
137
- });
138
- expect(entries).toMatchInlineSnapshot(`
139
- Object {
140
- "routes": Array [
141
- Object {
142
- "method": "POST",
143
- "module": Array [
144
- "authors/[authorId]/todos/[todoId].ts:onRequestPost",
145
- ],
146
- "mountPath": "/base/authors/:authorId/todos",
147
- "routePath": "/base/authors/:authorId/todos/:todoId",
148
- },
149
- Object {
150
- "method": "POST",
151
- "module": Array [
152
- "cats/[[breed]]/blah.ts:onRequestPost",
153
- ],
154
- "mountPath": "/base/cats/:breed*",
155
- "routePath": "/base/cats/:breed*/blah",
156
- },
157
- Object {
158
- "method": "POST",
159
- "module": Array [
160
- "cats/[[breed]]/[[name]].ts:onRequestPost",
161
- ],
162
- "mountPath": "/base/cats/:breed*",
163
- "routePath": "/base/cats/:breed*/:name*",
164
- },
165
- Object {
166
- "method": "DELETE",
167
- "module": Array [
168
- "todos/[id].ts:onRequestDelete",
169
- ],
170
- "mountPath": "/base/todos",
171
- "routePath": "/base/todos/:id",
172
- },
173
- Object {
174
- "method": "POST",
175
- "module": Array [
176
- "todos/[id].ts:onRequestPost",
177
- ],
178
- "mountPath": "/base/todos",
179
- "routePath": "/base/todos/:id",
180
- },
181
- Object {
182
- "method": "POST",
183
- "module": Array [
184
- "books/[[title]].ts:onRequestPost",
185
- ],
186
- "mountPath": "/base/books",
187
- "routePath": "/base/books/:title*",
188
- },
189
- Object {
190
- "method": "DELETE",
191
- "module": Array [
192
- "bar.ts:onRequestDelete",
193
- ],
194
- "mountPath": "/base/",
195
- "routePath": "/base/bar",
196
- },
197
- Object {
198
- "method": "PUT",
199
- "module": Array [
200
- "bar.ts:onRequestPut",
201
- ],
202
- "mountPath": "/base/",
203
- "routePath": "/base/bar",
204
- },
205
- Object {
206
- "method": "GET",
207
- "module": Array [
208
- "foo.ts:onRequestGet",
209
- ],
210
- "mountPath": "/base/",
211
- "routePath": "/base/foo",
212
- },
213
- Object {
214
- "method": "POST",
215
- "module": Array [
216
- "foo.ts:onRequestPost",
217
- ],
218
- "mountPath": "/base/",
219
- "routePath": "/base/foo",
220
- },
221
- ],
222
- }
223
- `);
224
- });
225
- });
226
- });
227
-
228
- function routeConfig(routePath: string, method?: string): RouteConfig {
229
- return {
230
- routePath: toUrlPath(routePath),
231
- mountPath: toUrlPath("/"),
232
- method: method as HTTPMethod,
233
- };
234
- }
@@ -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
- }