wrangler 0.0.0-e98613f8 → 0.0.0-e9a45766c

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 (244) hide show
  1. package/README.md +10 -4
  2. package/bin/wrangler.js +10 -2
  3. package/miniflare-dist/index.mjs +257 -132
  4. package/package.json +26 -19
  5. package/src/__tests__/api-dev.test.ts +65 -36
  6. package/src/__tests__/api-devregistry.test.ts +121 -0
  7. package/src/__tests__/api.test.ts +27 -5
  8. package/src/__tests__/configuration.test.ts +575 -39
  9. package/src/__tests__/constellation.test.ts +371 -0
  10. package/src/__tests__/d1/d1.test.ts +82 -0
  11. package/src/__tests__/d1/execute.test.ts +66 -0
  12. package/src/__tests__/d1/migrate.test.ts +257 -0
  13. package/src/__tests__/d1/splitter.test.ts +255 -0
  14. package/src/__tests__/delete.test.ts +11 -2
  15. package/src/__tests__/deployments.test.ts +330 -52
  16. package/src/__tests__/dev.test.tsx +146 -82
  17. package/src/__tests__/generate.test.ts +10 -8
  18. package/src/__tests__/guess-worker-format.test.ts +35 -0
  19. package/src/__tests__/helpers/end-event-loop.ts +6 -0
  20. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  21. package/src/__tests__/helpers/mock-console.ts +6 -0
  22. package/src/__tests__/helpers/mock-dialogs.ts +71 -85
  23. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +25 -0
  24. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -5
  25. package/src/__tests__/helpers/mock-known-routes.ts +7 -2
  26. package/src/__tests__/helpers/mock-kv.ts +29 -16
  27. package/src/__tests__/helpers/mock-oauth-flow.ts +99 -92
  28. package/src/__tests__/helpers/mock-process.ts +8 -13
  29. package/src/__tests__/helpers/mock-set-timeout.ts +16 -0
  30. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  31. package/src/__tests__/helpers/msw/handlers/deployments.ts +127 -26
  32. package/src/__tests__/helpers/msw/handlers/namespaces.ts +18 -41
  33. package/src/__tests__/helpers/msw/handlers/r2.ts +14 -34
  34. package/src/__tests__/helpers/msw/handlers/script.ts +9 -28
  35. package/src/__tests__/helpers/msw/handlers/user.ts +13 -24
  36. package/src/__tests__/helpers/msw/handlers/zones.ts +6 -8
  37. package/src/__tests__/helpers/msw/index.ts +32 -1
  38. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  39. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +28 -0
  40. package/src/__tests__/helpers/worker-scripts/parent-worker.js +4 -1
  41. package/src/__tests__/index.test.ts +92 -74
  42. package/src/__tests__/init.test.ts +909 -628
  43. package/src/__tests__/jest.setup.ts +19 -42
  44. package/src/__tests__/kv.test.ts +355 -231
  45. package/src/__tests__/logger.test.ts +68 -2
  46. package/src/__tests__/logout.test.ts +1 -1
  47. package/src/__tests__/metrics.test.ts +93 -50
  48. package/src/__tests__/middleware.scheduled.test.ts +42 -32
  49. package/src/__tests__/middleware.test.ts +212 -122
  50. package/src/__tests__/mtls-certificates.test.ts +589 -0
  51. package/src/__tests__/pages/deployment-list.test.ts +80 -0
  52. package/src/__tests__/pages/functions-build.test.ts +528 -0
  53. package/src/__tests__/pages/pages.test.ts +81 -0
  54. package/src/__tests__/pages/project-create.test.ts +63 -0
  55. package/src/__tests__/pages/project-list.test.ts +110 -0
  56. package/src/__tests__/pages/project-upload.test.ts +500 -0
  57. package/src/__tests__/pages/publish.test.ts +2864 -0
  58. package/src/__tests__/pages-deployment-tail.test.ts +239 -102
  59. package/src/__tests__/parse.test.ts +106 -0
  60. package/src/__tests__/publish.test.ts +2218 -1002
  61. package/src/__tests__/pubsub.test.ts +226 -100
  62. package/src/__tests__/queues.test.ts +42 -32
  63. package/src/__tests__/r2.test.ts +37 -56
  64. package/src/__tests__/secret.test.ts +179 -130
  65. package/src/__tests__/tail.test.ts +113 -23
  66. package/src/__tests__/test-old-node-version.js +3 -3
  67. package/src/__tests__/traverse-module-graph.test.ts +220 -0
  68. package/src/__tests__/tsconfig-sanity.ts +12 -0
  69. package/src/__tests__/tsconfig.json +8 -0
  70. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  71. package/src/__tests__/type-generation.test.ts +8 -0
  72. package/src/__tests__/user.test.ts +7 -18
  73. package/src/__tests__/whoami.test.tsx +8 -114
  74. package/src/__tests__/worker-namespace.test.ts +83 -69
  75. package/src/api/dev.ts +172 -61
  76. package/src/api/index.ts +10 -1
  77. package/src/api/mtls-certificate.ts +148 -0
  78. package/src/api/pages/create-worker-bundle-contents.ts +77 -0
  79. package/src/api/pages/index.ts +5 -0
  80. package/src/api/pages/publish.tsx +371 -0
  81. package/src/bundle.ts +139 -33
  82. package/src/cfetch/index.ts +0 -2
  83. package/src/cfetch/internal.ts +16 -21
  84. package/src/cli.ts +4 -4
  85. package/src/config/config.ts +14 -7
  86. package/src/config/environment.ts +80 -16
  87. package/src/config/index.ts +99 -30
  88. package/src/config/validation-helpers.ts +1 -1
  89. package/src/config/validation.ts +275 -9
  90. package/src/constellation/createProject.tsx +51 -0
  91. package/src/constellation/deleteProject.ts +51 -0
  92. package/src/constellation/deleteProjectModel.ts +68 -0
  93. package/src/constellation/index.ts +75 -0
  94. package/src/constellation/listCatalog.tsx +35 -0
  95. package/src/constellation/listModel.tsx +41 -0
  96. package/src/constellation/listProject.tsx +28 -0
  97. package/src/constellation/listRuntime.tsx +28 -0
  98. package/src/constellation/options.ts +17 -0
  99. package/src/constellation/types.ts +17 -0
  100. package/src/constellation/uploadModel.tsx +64 -0
  101. package/src/constellation/utils.ts +90 -0
  102. package/src/create-worker-preview.ts +19 -8
  103. package/src/create-worker-upload-form.ts +52 -5
  104. package/src/d1/backups.tsx +40 -44
  105. package/src/d1/create.tsx +50 -43
  106. package/src/d1/{delete.tsx → delete.ts} +8 -11
  107. package/src/d1/execute.tsx +171 -166
  108. package/src/d1/index.ts +5 -6
  109. package/src/d1/list.tsx +27 -13
  110. package/src/d1/migrations/apply.tsx +92 -64
  111. package/src/d1/migrations/create.tsx +31 -29
  112. package/src/d1/migrations/helpers.ts +66 -44
  113. package/src/d1/migrations/list.tsx +47 -31
  114. package/src/d1/migrations/options.ts +7 -2
  115. package/src/d1/options.ts +3 -3
  116. package/src/d1/splitter.ts +161 -0
  117. package/src/d1/{types.tsx → types.ts} +1 -0
  118. package/src/d1/utils.ts +2 -1
  119. package/src/delete.ts +8 -16
  120. package/src/deployments.ts +333 -42
  121. package/src/deprecated/index.ts +8 -302
  122. package/src/dev/dev.tsx +13 -22
  123. package/src/dev/local.tsx +131 -69
  124. package/src/dev/remote.tsx +35 -3
  125. package/src/dev/start-server.ts +83 -77
  126. package/src/dev/use-esbuild.ts +63 -52
  127. package/src/dev/validate-dev-props.ts +9 -0
  128. package/src/{dev-registry.tsx → dev-registry.ts} +9 -8
  129. package/src/dev.tsx +131 -110
  130. package/src/dialogs.ts +136 -0
  131. package/src/dispatch-namespace.ts +21 -17
  132. package/src/docs/helpers.ts +50 -0
  133. package/src/docs/index.ts +54 -0
  134. package/src/entry.ts +26 -11
  135. package/src/environment-variables/factory.ts +89 -0
  136. package/src/environment-variables/misc-variables.ts +30 -0
  137. package/src/generate/index.ts +298 -0
  138. package/src/{index.tsx → index.ts} +137 -56
  139. package/src/init.ts +254 -187
  140. package/src/inspect.ts +170 -9
  141. package/src/jest.d.ts +4 -0
  142. package/src/kv/helpers.ts +7 -4
  143. package/src/kv/index.ts +15 -17
  144. package/src/logger.ts +36 -5
  145. package/src/metrics/metrics-config.ts +1 -1
  146. package/src/metrics/send-event.ts +4 -1
  147. package/src/miniflare-cli/assets.ts +66 -31
  148. package/src/miniflare-cli/index.ts +5 -8
  149. package/src/miniflare-cli/tsconfig.json +9 -0
  150. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  151. package/src/miniflare-cli/types.ts +11 -0
  152. package/src/module-collection.ts +92 -26
  153. package/src/mtls-certificate/cli.ts +155 -0
  154. package/src/pages/build.ts +423 -0
  155. package/src/pages/buildFunctions.ts +140 -0
  156. package/src/pages/{deployment-tails.tsx → deployment-tails.ts} +7 -10
  157. package/src/pages/deployments.tsx +9 -9
  158. package/src/pages/{dev.tsx → dev.ts} +167 -139
  159. package/src/pages/errors.ts +1 -0
  160. package/src/pages/functions/buildPlugin.ts +61 -54
  161. package/src/pages/functions/buildWorker.ts +217 -33
  162. package/src/pages/functions/tsconfig.json +8 -0
  163. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  164. package/src/pages/{functions.tsx → functions.ts} +8 -4
  165. package/src/pages/{index.tsx → index.ts} +3 -3
  166. package/src/pages/projects.tsx +12 -22
  167. package/src/pages/publish.tsx +43 -227
  168. package/src/pages/types.ts +5 -0
  169. package/src/pages/upload.tsx +57 -14
  170. package/src/pages/utils.ts +1 -1
  171. package/src/parse.ts +23 -1
  172. package/src/paths.ts +1 -1
  173. package/src/publish/index.ts +20 -16
  174. package/src/publish/publish.ts +76 -46
  175. package/src/pubsub/{pubsub-commands.tsx → pubsub-commands.ts} +19 -20
  176. package/src/queues/cli/commands/consumer/add.ts +24 -24
  177. package/src/queues/cli/commands/consumer/index.ts +3 -6
  178. package/src/queues/cli/commands/consumer/remove.ts +11 -18
  179. package/src/queues/cli/commands/create.ts +8 -8
  180. package/src/queues/cli/commands/delete.ts +8 -8
  181. package/src/queues/cli/commands/index.ts +3 -4
  182. package/src/queues/cli/commands/list.ts +8 -8
  183. package/src/queues/client.ts +1 -0
  184. package/src/r2/helpers.ts +1 -0
  185. package/src/r2/index.ts +28 -28
  186. package/src/secret/index.ts +15 -16
  187. package/src/{sites.tsx → sites.ts} +165 -53
  188. package/src/tail/createTail.ts +37 -1
  189. package/src/tail/filters.ts +1 -1
  190. package/src/tail/index.ts +8 -11
  191. package/src/tail/printing.ts +25 -0
  192. package/src/traverse-module-graph.ts +54 -0
  193. package/src/tsconfig-sanity.ts +16 -0
  194. package/src/type-generation.ts +11 -3
  195. package/src/user/access.ts +0 -1
  196. package/src/user/auth-variables.ts +113 -0
  197. package/src/user/choose-account.tsx +1 -31
  198. package/src/user/index.ts +0 -1
  199. package/src/user/{user.tsx → user.ts} +114 -77
  200. package/src/utils/render.ts +93 -0
  201. package/src/{whoami.tsx → whoami.ts} +37 -71
  202. package/src/worker.ts +35 -1
  203. package/src/yargs-types.ts +18 -5
  204. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  205. package/templates/__tests__/tsconfig.json +8 -0
  206. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  207. package/templates/checked-fetch.js +9 -3
  208. package/templates/d1-beta-facade.js +42 -3
  209. package/templates/facade.d.ts +14 -0
  210. package/templates/first-party-worker-module-facade.ts +4 -3
  211. package/templates/format-dev-errors.ts +8 -6
  212. package/templates/gitignore +1 -0
  213. package/templates/init-tests/test-jest-new-worker.js +3 -5
  214. package/templates/init-tests/test-vitest-new-worker.js +3 -5
  215. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  216. package/templates/middleware/loader-modules.ts +2 -2
  217. package/templates/middleware/loader-sw.ts +6 -0
  218. package/templates/middleware/middleware-miniflare3-json-error.ts +17 -5
  219. package/templates/new-worker.ts +3 -0
  220. package/templates/pages-dev-pipeline.ts +4 -1
  221. package/templates/pages-shim.ts +4 -1
  222. package/templates/pages-template-plugin.ts +19 -10
  223. package/templates/serve-static-assets.ts +17 -14
  224. package/templates/service-bindings-module-facade.js +1 -0
  225. package/templates/tsconfig-sanity.ts +11 -0
  226. package/templates/tsconfig.init.json +105 -0
  227. package/templates/tsconfig.json +5 -103
  228. package/templates/tsconfig.tsbuildinfo +1 -0
  229. package/wrangler-dist/cli.d.ts +871 -73
  230. package/wrangler-dist/cli.js +80512 -90686
  231. package/wrangler-dist/wasm-sync.wasm +0 -0
  232. package/src/__tests__/api-devregistry.test.js +0 -56
  233. package/src/__tests__/d1.test.ts +0 -80
  234. package/src/__tests__/dialogs.test.tsx +0 -40
  235. package/src/__tests__/helpers/mock-cfetch.ts +0 -333
  236. package/src/__tests__/pages.test.ts +0 -2442
  237. package/src/dialogs.tsx +0 -168
  238. package/src/environment-variables.ts +0 -50
  239. package/src/pages/build.tsx +0 -270
  240. package/src/user/env-vars.ts +0 -46
  241. /package/src/{bundle-reporter.tsx → bundle-reporter.ts} +0 -0
  242. /package/src/d1/migrations/{index.tsx → index.ts} +0 -0
  243. /package/src/dev/{get-local-persistence-path.tsx → get-local-persistence-path.ts} +0 -0
  244. /package/src/pages/{hash.tsx → hash.ts} +0 -0
@@ -0,0 +1,371 @@
1
+ import { existsSync, lstatSync, readFileSync } from "node:fs";
2
+ import { tmpdir } from "node:os";
3
+ import { join, resolve as resolvePath } from "node:path";
4
+ import { cwd } from "node:process";
5
+ import { File, FormData } from "undici";
6
+ import { fetchResult } from "../../cfetch";
7
+ import { FatalError } from "../../errors";
8
+ import { logger } from "../../logger";
9
+ import { buildFunctions } from "../../pages/buildFunctions";
10
+ import {
11
+ FunctionsNoRoutesError,
12
+ getFunctionsNoRoutesWarning,
13
+ } from "../../pages/errors";
14
+ import {
15
+ buildRawWorker,
16
+ checkRawWorker,
17
+ traverseAndBuildWorkerJSDirectory,
18
+ } from "../../pages/functions/buildWorker";
19
+ import { validateRoutes } from "../../pages/functions/routes-validation";
20
+ import { upload } from "../../pages/upload";
21
+ import { createUploadWorkerBundleContents } from "./create-worker-bundle-contents";
22
+ import type { BundleResult } from "../../bundle";
23
+ import type { Project, Deployment } from "@cloudflare/types";
24
+
25
+ interface PagesPublishOptions {
26
+ /**
27
+ * Path to static assets to publish to Pages
28
+ */
29
+ directory: string;
30
+ /**
31
+ * The Cloudflare Account ID that owns the project that's
32
+ * being published
33
+ */
34
+ accountId: string;
35
+ /**
36
+ * The name of the project to be published
37
+ */
38
+ projectName: string;
39
+ /**
40
+ * Branch name to use. Defaults to production branch
41
+ */
42
+ branch?: string;
43
+ /**
44
+ * Whether or not to skip local file upload result caching
45
+ */
46
+ skipCaching?: boolean;
47
+ /**
48
+ * Commit message associated to deployment
49
+ */
50
+ commitMessage?: string;
51
+ /**
52
+ * Commit hash associated to deployment
53
+ */
54
+ commitHash?: string;
55
+ /**
56
+ * Whether or not the deployment should be considered to be
57
+ * in a dirty commit state
58
+ */
59
+ commitDirty?: boolean;
60
+ /**
61
+ * Path to the project's functions directory. Default uses
62
+ * the current working directory + /functions since this is
63
+ * typically called in a CLI
64
+ */
65
+ functionsDirectory?: string;
66
+
67
+ /**
68
+ * Whether to run bundling on `_worker.js` before deploying.
69
+ * Default: true
70
+ */
71
+ bundle?: boolean;
72
+
73
+ // TODO: Allow passing in the API key and plumb it through
74
+ // to the API calls so that the publish function does not
75
+ // rely on the `CLOUDFLARE_API_KEY` environment variable
76
+ }
77
+
78
+ /**
79
+ * Publish a directory to an account/project.
80
+ * NOTE: You will need the `CLOUDFLARE_API_KEY` environment
81
+ * variable set
82
+ */
83
+ export async function publish({
84
+ directory,
85
+ accountId,
86
+ projectName,
87
+ branch,
88
+ skipCaching,
89
+ commitMessage,
90
+ commitHash,
91
+ commitDirty,
92
+ functionsDirectory: customFunctionsDirectory,
93
+ bundle,
94
+ }: PagesPublishOptions) {
95
+ let _headers: string | undefined,
96
+ _redirects: string | undefined,
97
+ _routesGenerated: string | undefined,
98
+ _routesCustom: string | undefined,
99
+ _workerJSIsDirectory = false,
100
+ _workerJS: string | undefined;
101
+
102
+ bundle = bundle ?? true;
103
+
104
+ const _workerPath = resolvePath(directory, "_worker.js");
105
+
106
+ try {
107
+ _headers = readFileSync(join(directory, "_headers"), "utf-8");
108
+ } catch {}
109
+
110
+ try {
111
+ _redirects = readFileSync(join(directory, "_redirects"), "utf-8");
112
+ } catch {}
113
+
114
+ try {
115
+ /**
116
+ * Developers can specify a custom _routes.json file, for projects with Pages
117
+ * Functions or projects in Advanced Mode
118
+ */
119
+ _routesCustom = readFileSync(join(directory, "_routes.json"), "utf-8");
120
+ } catch {}
121
+
122
+ try {
123
+ _workerJSIsDirectory = lstatSync(_workerPath).isDirectory();
124
+ if (!_workerJSIsDirectory) {
125
+ _workerJS = readFileSync(_workerPath, "utf-8");
126
+ }
127
+ } catch {}
128
+
129
+ // Grab the bindings from the API, we need these for shims and other such hacky inserts
130
+ const project = await fetchResult<Project>(
131
+ `/accounts/${accountId}/pages/projects/${projectName}`
132
+ );
133
+ let isProduction = true;
134
+ if (branch) {
135
+ isProduction = project.production_branch === branch;
136
+ }
137
+
138
+ const deploymentConfig =
139
+ project.deployment_configs[isProduction ? "production" : "preview"];
140
+ const nodejsCompat =
141
+ deploymentConfig.compatibility_flags?.includes("nodejs_compat");
142
+
143
+ /**
144
+ * Evaluate if this is an Advanced Mode or Pages Functions project. If Advanced Mode, we'll
145
+ * go ahead and upload `_worker.js` as is, but if Pages Functions, we need to attempt to build
146
+ * Functions first and exit if it failed
147
+ */
148
+ let builtFunctions: string | undefined = undefined;
149
+ let workerBundle: BundleResult | undefined = undefined;
150
+
151
+ const functionsDirectory =
152
+ customFunctionsDirectory || join(cwd(), "functions");
153
+ const routesOutputPath = !existsSync(join(directory, "_routes.json"))
154
+ ? join(tmpdir(), `_routes-${Math.random()}.json`)
155
+ : undefined;
156
+
157
+ // Routing configuration displayed in the Functions tab of a deployment in Dash
158
+ let filepathRoutingConfig: string | undefined;
159
+
160
+ const d1Databases = Object.keys(
161
+ project.deployment_configs[isProduction ? "production" : "preview"]
162
+ .d1_databases ?? {}
163
+ );
164
+
165
+ if (!_workerJS && existsSync(functionsDirectory)) {
166
+ const outputConfigPath = join(
167
+ tmpdir(),
168
+ `functions-filepath-routing-config-${Math.random()}.json`
169
+ );
170
+
171
+ try {
172
+ workerBundle = await buildFunctions({
173
+ outputConfigPath,
174
+ functionsDirectory,
175
+ onEnd: () => {},
176
+ buildOutputDirectory: directory,
177
+ routesOutputPath,
178
+ local: false,
179
+ d1Databases,
180
+ nodejsCompat,
181
+ });
182
+
183
+ builtFunctions = readFileSync(
184
+ workerBundle.resolvedEntryPointPath,
185
+ "utf-8"
186
+ );
187
+ filepathRoutingConfig = readFileSync(outputConfigPath, "utf-8");
188
+ } catch (e) {
189
+ if (e instanceof FunctionsNoRoutesError) {
190
+ logger.warn(
191
+ getFunctionsNoRoutesWarning(functionsDirectory, "skipping")
192
+ );
193
+ } else {
194
+ throw e;
195
+ }
196
+ }
197
+ }
198
+
199
+ const manifest = await upload({
200
+ directory,
201
+ accountId,
202
+ projectName,
203
+ skipCaching: skipCaching ?? false,
204
+ });
205
+
206
+ const formData = new FormData();
207
+
208
+ formData.append("manifest", JSON.stringify(manifest));
209
+
210
+ if (branch) {
211
+ formData.append("branch", branch);
212
+ }
213
+
214
+ if (commitMessage) {
215
+ formData.append("commit_message", commitMessage);
216
+ }
217
+
218
+ if (commitHash) {
219
+ formData.append("commit_hash", commitHash);
220
+ }
221
+
222
+ if (commitDirty !== undefined) {
223
+ formData.append("commit_dirty", commitDirty);
224
+ }
225
+
226
+ if (_headers) {
227
+ formData.append("_headers", new File([_headers], "_headers"));
228
+ logger.log(`✨ Uploading _headers`);
229
+ }
230
+
231
+ if (_redirects) {
232
+ formData.append("_redirects", new File([_redirects], "_redirects"));
233
+ logger.log(`✨ Uploading _redirects`);
234
+ }
235
+
236
+ if (filepathRoutingConfig) {
237
+ formData.append(
238
+ "functions-filepath-routing-config.json",
239
+ new File(
240
+ [filepathRoutingConfig],
241
+ "functions-filepath-routing-config.json"
242
+ )
243
+ );
244
+ }
245
+
246
+ /**
247
+ * Advanced Mode
248
+ * https://developers.cloudflare.com/pages/platform/functions/#advanced-mode
249
+ *
250
+ * When using a _worker.js file or _worker.js/ directory, the entire /functions directory is ignored
251
+ * – this includes its routing and middleware characteristics.
252
+ */
253
+ if (_workerJSIsDirectory) {
254
+ workerBundle = await traverseAndBuildWorkerJSDirectory({
255
+ workerJSDirectory: _workerPath,
256
+ buildOutputDirectory: directory,
257
+ d1Databases,
258
+ nodejsCompat,
259
+ });
260
+ } else if (_workerJS) {
261
+ if (bundle) {
262
+ const outfile = join(tmpdir(), `./bundledWorker-${Math.random()}.mjs`);
263
+ workerBundle = await buildRawWorker({
264
+ workerScriptPath: _workerPath,
265
+ outfile,
266
+ directory,
267
+ local: false,
268
+ sourcemap: true,
269
+ watch: false,
270
+ onEnd: () => {},
271
+ betaD1Shims: d1Databases,
272
+ nodejsCompat,
273
+ });
274
+ } else {
275
+ await checkRawWorker(_workerPath, () => {});
276
+ // TODO: Let users configure this in the future.
277
+ workerBundle = {
278
+ modules: [],
279
+ dependencies: {},
280
+ stop: undefined,
281
+ resolvedEntryPointPath: _workerPath,
282
+ bundleType: "esm",
283
+ };
284
+ }
285
+ }
286
+
287
+ if (_workerJS || _workerJSIsDirectory) {
288
+ const workerBundleContents = await createUploadWorkerBundleContents(
289
+ workerBundle as BundleResult
290
+ );
291
+
292
+ formData.append(
293
+ "_worker.bundle",
294
+ new File([workerBundleContents], "_worker.bundle")
295
+ );
296
+ logger.log(`✨ Uploading Worker bundle`);
297
+
298
+ if (_routesCustom) {
299
+ // user provided a custom _routes.json file
300
+ try {
301
+ const routesCustomJSON = JSON.parse(_routesCustom);
302
+ validateRoutes(routesCustomJSON, join(directory, "_routes.json"));
303
+
304
+ formData.append(
305
+ "_routes.json",
306
+ new File([_routesCustom], "_routes.json")
307
+ );
308
+ logger.log(`✨ Uploading _routes.json`);
309
+ } catch (err) {
310
+ if (err instanceof FatalError) {
311
+ throw err;
312
+ }
313
+ }
314
+ }
315
+ }
316
+
317
+ /**
318
+ * Pages Functions
319
+ * https://developers.cloudflare.com/pages/platform/functions/
320
+ */
321
+ if (builtFunctions && !_workerJS && !_workerJSIsDirectory) {
322
+ const workerBundleContents = await createUploadWorkerBundleContents(
323
+ workerBundle as BundleResult
324
+ );
325
+
326
+ formData.append(
327
+ "_worker.bundle",
328
+ new File([workerBundleContents], "_worker.bundle")
329
+ );
330
+ logger.log(`✨ Uploading Functions bundle`);
331
+
332
+ if (_routesCustom) {
333
+ // user provided a custom _routes.json file
334
+ try {
335
+ const routesCustomJSON = JSON.parse(_routesCustom);
336
+ validateRoutes(routesCustomJSON, join(directory, "_routes.json"));
337
+
338
+ formData.append(
339
+ "_routes.json",
340
+ new File([_routesCustom], "_routes.json")
341
+ );
342
+ logger.log(`✨ Uploading _routes.json`);
343
+ } catch (err) {
344
+ if (err instanceof FatalError) {
345
+ throw err;
346
+ }
347
+ }
348
+ } else if (routesOutputPath) {
349
+ // no custom _routes.json file found, so fallback to the generated one
350
+ try {
351
+ _routesGenerated = readFileSync(routesOutputPath, "utf-8");
352
+
353
+ if (_routesGenerated) {
354
+ formData.append(
355
+ "_routes.json",
356
+ new File([_routesGenerated], "_routes.json")
357
+ );
358
+ }
359
+ } catch {}
360
+ }
361
+ }
362
+
363
+ const deploymentResponse = await fetchResult<Deployment>(
364
+ `/accounts/${accountId}/pages/projects/${projectName}/deployments`,
365
+ {
366
+ method: "POST",
367
+ body: formData,
368
+ }
369
+ );
370
+ return deploymentResponse;
371
+ }
package/src/bundle.ts CHANGED
@@ -7,12 +7,20 @@ import NodeModulesPolyfills from "@esbuild-plugins/node-modules-polyfill";
7
7
  import * as esbuild from "esbuild";
8
8
  import tmp from "tmp-promise";
9
9
  import createModuleCollector from "./module-collection";
10
- import { getBasePath, toUrlPath } from "./paths";
10
+ import { getBasePath } from "./paths";
11
11
  import type { Config } from "./config";
12
+ import type { DurableObjectBindings } from "./config/environment";
12
13
  import type { WorkerRegistry } from "./dev-registry";
13
14
  import type { Entry } from "./entry";
15
+ import type { SourceMapMetadata } from "./inspect";
14
16
  import type { CfModule } from "./worker";
15
17
 
18
+ export const COMMON_ESBUILD_OPTIONS = {
19
+ // Our workerd runtime uses the same V8 version as recent Chrome, which is highly ES2022 compliant: https://kangax.github.io/compat-table/es2016plus/
20
+ target: "es2022",
21
+ loader: { ".js": "jsx", ".mjs": "jsx", ".cjs": "jsx" },
22
+ } as const;
23
+
16
24
  export type BundleResult = {
17
25
  modules: CfModule[];
18
26
  dependencies: esbuild.Metafile["outputs"][string]["inputs"];
@@ -20,6 +28,7 @@ export type BundleResult = {
20
28
  bundleType: "esm" | "commonjs";
21
29
  stop: (() => void) | undefined;
22
30
  sourceMapPath?: string | undefined;
31
+ sourceMapMetadata?: SourceMapMetadata | undefined;
23
32
  };
24
33
 
25
34
  type StaticAssetsConfig =
@@ -70,21 +79,49 @@ export function isBuildFailure(err: unknown): err is esbuild.BuildFailure {
70
79
  * Rewrites esbuild BuildFailures for failing to resolve Node built-in modules
71
80
  * to suggest enabling Node compat as opposed to `platform: "node"`.
72
81
  */
73
- export function rewriteNodeCompatBuildFailure(err: esbuild.BuildFailure) {
82
+ export function rewriteNodeCompatBuildFailure(
83
+ err: esbuild.BuildFailure,
84
+ forPages = false
85
+ ) {
74
86
  for (const error of err.errors) {
75
87
  const match = nodeBuiltinResolveErrorText.exec(error.text);
76
88
  if (match !== null) {
89
+ const issue = `The package "${match[1]}" wasn't found on the file system but is built into node.`;
90
+
91
+ const instructionForUser = `${
92
+ forPages
93
+ ? 'Add the "nodejs_compat" compatibility flag to your Pages project'
94
+ : 'Add "node_compat = true" to your wrangler.toml file'
95
+ } to enable Node.js compatibility.`;
96
+
77
97
  error.notes = [
78
98
  {
79
99
  location: null,
80
- text: `The package "${match[1]}" wasn't found on the file system but is built into node.
81
- Add "node_compat = true" to your wrangler.toml file to enable Node compatibility.`,
100
+ text: `${issue}\n${instructionForUser}`,
82
101
  },
83
102
  ];
84
103
  }
85
104
  }
86
105
  }
87
106
 
107
+ const nodejsCompatPlugin: esbuild.Plugin = {
108
+ name: "nodejs_compat Plugin",
109
+ setup(pluginBuild) {
110
+ pluginBuild.onResolve({ filter: /node:.*/ }, () => {
111
+ return { external: true };
112
+ });
113
+ },
114
+ };
115
+
116
+ const cloudflareJsPlugin: esbuild.Plugin = {
117
+ name: "cloudflare javascript Plugin",
118
+ setup(pluginBuild) {
119
+ pluginBuild.onResolve({ filter: /^cloudflare:.*/ }, () => {
120
+ return { external: true };
121
+ });
122
+ },
123
+ };
124
+
88
125
  /**
89
126
  * Generate a bundle for the worker identified by the arguments passed in.
90
127
  */
@@ -92,16 +129,21 @@ export async function bundleWorker(
92
129
  entry: Entry,
93
130
  destination: string,
94
131
  options: {
132
+ // When `bundle` is set to false, we apply shims to the Worker, but won't pull in any imports
133
+ bundle?: boolean;
95
134
  serveAssetsFromWorker: boolean;
96
135
  assets?: StaticAssetsConfig;
97
136
  betaD1Shims?: string[];
137
+ doBindings: DurableObjectBindings;
98
138
  jsxFactory?: string;
99
139
  jsxFragment?: string;
140
+ entryName?: string;
100
141
  rules: Config["rules"];
101
142
  watch?: esbuild.WatchMode | boolean;
102
143
  tsconfig?: string;
103
144
  minify?: boolean;
104
- nodeCompat?: boolean;
145
+ legacyNodeCompat?: boolean;
146
+ nodejsCompat?: boolean;
105
147
  define: Config["define"];
106
148
  checkFetch: boolean;
107
149
  services?: Config["services"];
@@ -115,21 +157,26 @@ export async function bundleWorker(
115
157
  loader?: Record<string, string>;
116
158
  sourcemap?: esbuild.CommonOptions["sourcemap"];
117
159
  plugins?: esbuild.Plugin[];
118
- // TODO: Rip these out https://github.com/cloudflare/wrangler2/issues/2153
160
+ // TODO: Rip these out https://github.com/cloudflare/workers-sdk/issues/2153
119
161
  disableModuleCollection?: boolean;
120
162
  isOutfile?: boolean;
163
+ forPages?: boolean;
121
164
  }
122
165
  ): Promise<BundleResult> {
123
166
  const {
167
+ bundle = true,
124
168
  serveAssetsFromWorker,
125
169
  betaD1Shims,
170
+ doBindings,
126
171
  jsxFactory,
127
172
  jsxFragment,
173
+ entryName,
128
174
  rules,
129
175
  watch,
130
176
  tsconfig,
131
177
  minify,
132
- nodeCompat,
178
+ legacyNodeCompat,
179
+ nodejsCompat,
133
180
  checkFetch,
134
181
  local,
135
182
  assets,
@@ -145,6 +192,7 @@ export async function bundleWorker(
145
192
  plugins,
146
193
  disableModuleCollection,
147
194
  isOutfile,
195
+ forPages,
148
196
  } = options;
149
197
 
150
198
  // We create a temporary directory for any oneoff files we
@@ -271,7 +319,13 @@ export async function bundleWorker(
271
319
  Array.isArray(betaD1Shims) &&
272
320
  betaD1Shims.length > 0 &&
273
321
  ((currentEntry: Entry) => {
274
- return applyD1BetaFacade(currentEntry, tmpDir.path, betaD1Shims, local);
322
+ return applyD1BetaFacade(
323
+ currentEntry,
324
+ tmpDir.path,
325
+ betaD1Shims,
326
+ local && !experimentalLocal,
327
+ doBindings
328
+ );
275
329
  }),
276
330
 
277
331
  // Middleware loader: to add middleware, we add the path to the middleware
@@ -313,47 +367,49 @@ export async function bundleWorker(
313
367
 
314
368
  const buildOptions: esbuild.BuildOptions & { metafile: true } = {
315
369
  entryPoints: [inputEntry.file],
316
- bundle: true,
370
+ bundle,
317
371
  absWorkingDir: entry.directory,
318
372
  outdir: destination,
373
+ entryNames: entryName || path.parse(entry.file).name,
319
374
  ...(isOutfile
320
375
  ? {
321
376
  outdir: undefined,
322
377
  outfile: destination,
378
+ entryNames: undefined,
323
379
  }
324
380
  : {}),
325
381
  inject,
326
- external: ["__STATIC_CONTENT_MANIFEST"],
382
+ external: bundle ? ["__STATIC_CONTENT_MANIFEST"] : undefined,
327
383
  format: entry.format === "modules" ? "esm" : "iife",
328
- target: "es2020",
329
- sourcemap: sourcemap ?? true, // this needs to use ?? to accept false
384
+ target: COMMON_ESBUILD_OPTIONS.target,
385
+ sourcemap: sourcemap ?? true,
330
386
  // Include a reference to the output folder in the sourcemap.
331
387
  // This is omitted by default, but we need it to properly resolve source paths in error output.
332
388
  sourceRoot: destination,
333
389
  minify,
334
390
  metafile: true,
335
- conditions: ["worker", "browser"],
391
+ conditions: ["workerd", "worker", "browser"],
336
392
  ...(process.env.NODE_ENV && {
337
393
  define: {
338
394
  // use process.env["NODE_ENV" + ""] so that esbuild doesn't replace it
339
- // when we do a build of wrangler. (re: https://github.com/cloudflare/wrangler2/issues/1477)
395
+ // when we do a build of wrangler. (re: https://github.com/cloudflare/workers-sdk/issues/1477)
340
396
  "process.env.NODE_ENV": `"${process.env["NODE_ENV" + ""]}"`,
341
- ...(nodeCompat ? { global: "globalThis" } : {}),
397
+ ...(legacyNodeCompat ? { global: "globalThis" } : {}),
342
398
  ...(checkFetch ? { fetch: "checkedFetch" } : {}),
343
399
  ...options.define,
344
400
  },
345
401
  }),
346
402
  loader: {
347
- ".js": "jsx",
348
- ".mjs": "jsx",
349
- ".cjs": "jsx",
403
+ ...COMMON_ESBUILD_OPTIONS.loader,
350
404
  ...(loader || {}),
351
405
  },
352
406
  plugins: [
353
407
  moduleCollector.plugin,
354
- ...(nodeCompat
408
+ ...(legacyNodeCompat
355
409
  ? [NodeGlobalsPolyfills({ buffer: true }), NodeModulesPolyfills()]
356
410
  : []),
411
+ ...(nodejsCompat ? [nodejsCompatPlugin] : []),
412
+ ...[cloudflareJsPlugin],
357
413
  ...(plugins || []),
358
414
  ],
359
415
  ...(jsxFactory && { jsxFactory }),
@@ -369,7 +425,8 @@ export async function bundleWorker(
369
425
  try {
370
426
  result = await esbuild.build(buildOptions);
371
427
  } catch (e) {
372
- if (!nodeCompat && isBuildFailure(e)) rewriteNodeCompatBuildFailure(e);
428
+ if (!legacyNodeCompat && isBuildFailure(e))
429
+ rewriteNodeCompatBuildFailure(e, forPages);
373
430
  throw e;
374
431
  }
375
432
 
@@ -395,16 +452,30 @@ export async function bundleWorker(
395
452
  _path.includes(".map")
396
453
  )[0];
397
454
 
455
+ const resolvedEntryPointPath = path.resolve(
456
+ entry.directory,
457
+ entryPointOutputs[0][0]
458
+ );
459
+
460
+ // copy all referenced modules into the output bundle directory
461
+ for (const module of moduleCollector.modules) {
462
+ fs.writeFileSync(
463
+ path.join(path.dirname(resolvedEntryPointPath), module.name),
464
+ module.content
465
+ );
466
+ }
467
+
398
468
  return {
399
469
  modules: moduleCollector.modules,
400
470
  dependencies,
401
- resolvedEntryPointPath: path.resolve(
402
- entry.directory,
403
- entryPointOutputs[0][0]
404
- ),
471
+ resolvedEntryPointPath,
405
472
  bundleType,
406
473
  stop: result.stop,
407
474
  sourceMapPath,
475
+ sourceMapMetadata: {
476
+ tmpDir: tmpDir.path,
477
+ entryDirectory: entry.directory,
478
+ },
408
479
  };
409
480
  }
410
481
 
@@ -549,16 +620,17 @@ async function applyMiddlewareLoaderFacade(
549
620
  ...Object.fromEntries(
550
621
  middleware.map((val, index) => [
551
622
  middlewareIdentifiers[index],
552
- toUrlPath(path.resolve(getBasePath(), val.path)),
623
+ path.resolve(getBasePath(), val.path),
553
624
  ])
554
625
  ),
555
626
  }),
556
627
  ],
557
628
  outfile: targetPathInsertion,
558
629
  });
559
-
560
- let targetPathLoader = path.join(tmpDirPath, path.basename(entry.file));
561
- if (path.extname(entry.file) === "") targetPathLoader += ".js";
630
+ const targetPathLoader = path.join(
631
+ tmpDirPath,
632
+ "middleware-loader.entry.js"
633
+ );
562
634
  const loaderPath = path.resolve(
563
635
  getBasePath(),
564
636
  "templates/middleware/loader-modules.ts"
@@ -779,17 +851,51 @@ async function applyFirstPartyWorkerDevFacade(
779
851
  * This code be removed from here when the API is in Workers core,
780
852
  * but moved inside Miniflare for simulating D1.
781
853
  */
782
-
783
854
  async function applyD1BetaFacade(
784
855
  entry: Entry,
785
856
  tmpDirPath: string,
786
857
  betaD1Shims: string[],
787
- local: boolean
858
+ miniflare2: boolean,
859
+ doBindings: DurableObjectBindings
788
860
  ): Promise<Entry> {
861
+ let entrypointPath = path.resolve(
862
+ getBasePath(),
863
+ "templates/d1-beta-facade.js"
864
+ );
865
+ if (Array.isArray(doBindings) && doBindings.length > 0) {
866
+ //we have DO bindings, so we need to shim them
867
+ const maskedDoBindings = doBindings
868
+ // Don't shim anything not local to this worker
869
+ .filter((b) => !b.script_name)
870
+ // Reexport the DO classnames
871
+ .map(
872
+ (b) =>
873
+ `export const ${b.class_name} = maskDurableObjectDefinition(OTHER_EXPORTS.${b.class_name});`
874
+ )
875
+ .join("\n");
876
+ const baseFile = fs.readFileSync(
877
+ path.resolve(getBasePath(), "templates/d1-beta-facade.js"),
878
+ "utf8"
879
+ );
880
+ //getMaskedEnv is already used to shim regular Workers
881
+ const contents = `
882
+ ${baseFile}
883
+
884
+ var maskDurableObjectDefinition = (cls) =>
885
+ class extends cls {
886
+ constructor(state, env) {
887
+ super(state, getMaskedEnv(env));
888
+ }
889
+ };
890
+ ${maskedDoBindings}`;
891
+ const doD1FacadePath = path.join(tmpDirPath, "d1-do-facade.js");
892
+ //write our shim so we can build it
893
+ fs.writeFileSync(doD1FacadePath, contents);
894
+ entrypointPath = doD1FacadePath;
895
+ }
789
896
  const targetPath = path.join(tmpDirPath, "d1-beta-facade.entry.js");
790
-
791
897
  await esbuild.build({
792
- entryPoints: [path.resolve(getBasePath(), "templates/d1-beta-facade.js")],
898
+ entryPoints: [entrypointPath],
793
899
  bundle: true,
794
900
  format: "esm",
795
901
  sourcemap: true,
@@ -800,7 +906,7 @@ async function applyD1BetaFacade(
800
906
  ],
801
907
  define: {
802
908
  __D1_IMPORTS__: JSON.stringify(betaD1Shims),
803
- __LOCAL_MODE__: JSON.stringify(local),
909
+ __LOCAL_MODE__: JSON.stringify(miniflare2),
804
910
  },
805
911
  outfile: targetPath,
806
912
  });