wrangler 0.0.0-e452a35 → 0.0.0-e464fcdb

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 (373) hide show
  1. package/README.md +24 -4
  2. package/bin/wrangler.js +170 -62
  3. package/kv-asset-handler.js +1 -0
  4. package/miniflare-dist/index.mjs +1637 -81
  5. package/package.json +198 -152
  6. package/src/__tests__/access.test.ts +25 -0
  7. package/src/__tests__/api-dev.test.ts +238 -0
  8. package/src/__tests__/api-devregistry.test.ts +121 -0
  9. package/src/__tests__/api.test.ts +102 -0
  10. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  11. package/src/__tests__/config-cache.test.ts +30 -24
  12. package/src/__tests__/configuration.test.ts +4498 -3321
  13. package/src/__tests__/constellation.test.ts +371 -0
  14. package/src/__tests__/d1/d1.test.ts +82 -0
  15. package/src/__tests__/d1/execute.test.ts +66 -0
  16. package/src/__tests__/d1/migrate.test.ts +257 -0
  17. package/src/__tests__/d1/splitter.test.ts +255 -0
  18. package/src/__tests__/delete.test.ts +272 -0
  19. package/src/__tests__/deployments.test.ts +369 -0
  20. package/src/__tests__/dev.test.tsx +1592 -874
  21. package/src/__tests__/generate.test.ts +237 -0
  22. package/src/__tests__/get-host-from-url.test.ts +16 -0
  23. package/src/__tests__/guess-worker-format.test.ts +103 -68
  24. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  25. package/src/__tests__/helpers/end-event-loop.ts +6 -0
  26. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  27. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  28. package/src/__tests__/helpers/mock-bin.ts +20 -20
  29. package/src/__tests__/helpers/mock-console.ts +64 -39
  30. package/src/__tests__/helpers/mock-dialogs.ts +104 -55
  31. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +25 -0
  32. package/src/__tests__/helpers/mock-get-zone-from-host.ts +11 -0
  33. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  34. package/src/__tests__/helpers/mock-istty.ts +65 -18
  35. package/src/__tests__/helpers/mock-known-routes.ts +12 -0
  36. package/src/__tests__/helpers/mock-kv.ts +41 -28
  37. package/src/__tests__/helpers/mock-oauth-flow.ts +241 -233
  38. package/src/__tests__/helpers/mock-process.ts +34 -0
  39. package/src/__tests__/helpers/mock-set-timeout.ts +16 -0
  40. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  41. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  42. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  43. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  44. package/src/__tests__/helpers/msw/handlers/deployments.ts +160 -0
  45. package/src/__tests__/helpers/msw/handlers/namespaces.ts +81 -0
  46. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  47. package/src/__tests__/helpers/msw/handlers/r2.ts +60 -0
  48. package/src/__tests__/helpers/msw/handlers/script.ts +56 -0
  49. package/src/__tests__/helpers/msw/handlers/user.ts +52 -0
  50. package/src/__tests__/helpers/msw/handlers/zones.ts +20 -0
  51. package/src/__tests__/helpers/msw/index.ts +52 -0
  52. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  53. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  54. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  55. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +28 -0
  56. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  57. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  58. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  59. package/src/__tests__/helpers/worker-scripts/parent-worker.js +11 -0
  60. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  61. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  62. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  63. package/src/__tests__/https-options.test.ts +142 -109
  64. package/src/__tests__/index.test.ts +262 -236
  65. package/src/__tests__/init.test.ts +3167 -1528
  66. package/src/__tests__/jest.setup.ts +152 -50
  67. package/src/__tests__/kv.test.ts +1789 -1471
  68. package/src/__tests__/logger.test.ts +167 -75
  69. package/src/__tests__/logout.test.ts +47 -0
  70. package/src/__tests__/metrics.test.ts +493 -0
  71. package/src/__tests__/middleware.scheduled.test.ts +145 -0
  72. package/src/__tests__/middleware.test.ts +816 -0
  73. package/src/__tests__/mtls-certificates.test.ts +589 -0
  74. package/src/__tests__/package-manager.test.ts +312 -165
  75. package/src/__tests__/pages/deployment-list.test.ts +80 -0
  76. package/src/__tests__/pages/functions-build.test.ts +452 -0
  77. package/src/__tests__/pages/pages.test.ts +81 -0
  78. package/src/__tests__/pages/project-create.test.ts +63 -0
  79. package/src/__tests__/pages/project-list.test.ts +110 -0
  80. package/src/__tests__/pages/project-upload.test.ts +500 -0
  81. package/src/__tests__/pages/publish.test.ts +2864 -0
  82. package/src/__tests__/pages-deployment-tail.test.ts +955 -0
  83. package/src/__tests__/parse.test.ts +358 -252
  84. package/src/__tests__/paths.test.ts +39 -0
  85. package/src/__tests__/publish.test.ts +8736 -5355
  86. package/src/__tests__/pubsub.test.ts +496 -0
  87. package/src/__tests__/queues.test.ts +532 -0
  88. package/src/__tests__/r2.test.ts +369 -228
  89. package/src/__tests__/route.test.ts +18 -18
  90. package/src/__tests__/secret.test.ts +681 -469
  91. package/src/__tests__/tail.test.ts +835 -567
  92. package/src/__tests__/test-old-node-version.js +31 -0
  93. package/src/__tests__/traverse-module-graph.test.ts +220 -0
  94. package/src/__tests__/tsconfig-sanity.ts +12 -0
  95. package/src/__tests__/tsconfig.json +8 -0
  96. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  97. package/src/__tests__/type-generation.test.ts +234 -0
  98. package/src/__tests__/user.test.ts +107 -120
  99. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  100. package/src/__tests__/validate-dev-props.test.ts +56 -0
  101. package/src/__tests__/version.test.ts +35 -0
  102. package/src/__tests__/whoami.test.tsx +165 -98
  103. package/src/__tests__/worker-namespace.test.ts +340 -0
  104. package/src/abort.d.ts +1 -1
  105. package/src/api/dev.ts +316 -0
  106. package/src/api/index.ts +11 -0
  107. package/src/api/mtls-certificate.ts +148 -0
  108. package/src/api/pages/create-worker-bundle-contents.ts +76 -0
  109. package/src/api/pages/index.ts +5 -0
  110. package/src/api/pages/publish.tsx +355 -0
  111. package/src/bundle-reporter.ts +68 -0
  112. package/src/bundle.ts +869 -161
  113. package/src/cfetch/index.ts +120 -83
  114. package/src/cfetch/internal.ts +214 -95
  115. package/src/cli.ts +23 -8
  116. package/src/config/config.ts +244 -196
  117. package/src/config/diagnostics.ts +61 -61
  118. package/src/config/environment.ts +555 -357
  119. package/src/config/index.ts +374 -196
  120. package/src/config/validation-helpers.ts +379 -357
  121. package/src/config/validation.ts +2170 -1358
  122. package/src/config-cache.ts +81 -41
  123. package/src/constellation/createProject.tsx +51 -0
  124. package/src/constellation/deleteProject.ts +51 -0
  125. package/src/constellation/deleteProjectModel.ts +68 -0
  126. package/src/constellation/index.ts +75 -0
  127. package/src/constellation/listCatalog.tsx +35 -0
  128. package/src/constellation/listModel.tsx +41 -0
  129. package/src/constellation/listProject.tsx +28 -0
  130. package/src/constellation/listRuntime.tsx +28 -0
  131. package/src/constellation/options.ts +17 -0
  132. package/src/constellation/types.ts +17 -0
  133. package/src/constellation/uploadModel.tsx +64 -0
  134. package/src/constellation/utils.ts +90 -0
  135. package/src/create-worker-preview.ts +250 -142
  136. package/src/create-worker-upload-form.ts +343 -238
  137. package/src/d1/backups.tsx +219 -0
  138. package/src/d1/constants.ts +6 -0
  139. package/src/d1/create.tsx +103 -0
  140. package/src/d1/delete.ts +53 -0
  141. package/src/d1/execute.tsx +371 -0
  142. package/src/d1/formatTimeAgo.ts +14 -0
  143. package/src/d1/index.ts +100 -0
  144. package/src/d1/list.tsx +62 -0
  145. package/src/d1/migrations/apply.tsx +235 -0
  146. package/src/d1/migrations/create.tsx +79 -0
  147. package/src/d1/migrations/helpers.ts +171 -0
  148. package/src/d1/migrations/index.ts +3 -0
  149. package/src/d1/migrations/list.tsx +95 -0
  150. package/src/d1/migrations/options.ts +23 -0
  151. package/src/d1/options.ts +22 -0
  152. package/src/d1/splitter.ts +161 -0
  153. package/src/d1/types.ts +32 -0
  154. package/src/d1/utils.ts +49 -0
  155. package/src/delete.ts +100 -0
  156. package/src/deployments.ts +368 -0
  157. package/src/deprecated/index.ts +144 -0
  158. package/src/dev/dev-vars.ts +20 -17
  159. package/src/dev/dev.tsx +533 -355
  160. package/src/dev/get-local-persistence-path.ts +31 -0
  161. package/src/dev/local.tsx +928 -298
  162. package/src/dev/remote.tsx +620 -215
  163. package/src/dev/start-server.ts +534 -0
  164. package/src/dev/use-esbuild.ts +182 -97
  165. package/src/dev/validate-dev-props.ts +40 -0
  166. package/src/dev-registry.ts +202 -0
  167. package/src/dev.tsx +929 -0
  168. package/src/dialogs.ts +136 -0
  169. package/src/dispatch-namespace.ts +211 -0
  170. package/src/docs/helpers.ts +50 -0
  171. package/src/docs/index.ts +54 -0
  172. package/src/durable.ts +87 -87
  173. package/src/entry.ts +246 -231
  174. package/src/environment-variables/factory.ts +89 -0
  175. package/src/environment-variables/misc-variables.ts +30 -0
  176. package/src/errors.ts +6 -6
  177. package/src/generate/index.ts +298 -0
  178. package/src/git-client.ts +135 -0
  179. package/src/global-wrangler-config-path.ts +26 -0
  180. package/src/https-options.ts +84 -80
  181. package/src/index.ts +768 -0
  182. package/src/init.ts +1032 -0
  183. package/src/inspect.ts +713 -593
  184. package/src/intl-polyfill.d.ts +123 -123
  185. package/src/is-ci.ts +14 -0
  186. package/src/is-interactive.ts +16 -0
  187. package/src/jest.d.ts +4 -0
  188. package/src/kv/helpers.ts +433 -0
  189. package/src/kv/index.ts +594 -0
  190. package/src/logger.ts +100 -43
  191. package/src/metrics/index.ts +5 -0
  192. package/src/metrics/metrics-config.ts +239 -0
  193. package/src/metrics/metrics-dispatcher.ts +96 -0
  194. package/src/metrics/metrics-usage-headers.ts +24 -0
  195. package/src/metrics/send-event.ts +99 -0
  196. package/src/miniflare-cli/assets.ts +251 -0
  197. package/src/miniflare-cli/index.ts +202 -33
  198. package/src/miniflare-cli/request-context.ts +18 -18
  199. package/src/miniflare-cli/tsconfig.json +9 -0
  200. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  201. package/src/miniflare-cli/types.ts +11 -0
  202. package/src/module-collection.ts +290 -215
  203. package/src/mtls-certificate/cli.ts +155 -0
  204. package/src/open-in-browser.ts +4 -6
  205. package/src/package-manager.ts +182 -90
  206. package/src/pages/build.ts +410 -0
  207. package/src/pages/buildFunctions.ts +140 -0
  208. package/src/pages/constants.ts +18 -0
  209. package/src/pages/deployment-tails.ts +281 -0
  210. package/src/pages/deployments.tsx +84 -0
  211. package/src/pages/dev.ts +716 -0
  212. package/src/pages/errors.ts +67 -0
  213. package/src/pages/functions/buildPlugin.ts +113 -0
  214. package/src/pages/functions/buildWorker.ts +291 -0
  215. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  216. package/src/pages/functions/filepath-routing.ts +189 -0
  217. package/src/pages/functions/identifiers.ts +78 -0
  218. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  219. package/src/pages/functions/routes-consolidation.ts +73 -0
  220. package/src/pages/functions/routes-transformation.test.ts +282 -0
  221. package/src/pages/functions/routes-transformation.ts +115 -0
  222. package/src/pages/functions/routes-validation.test.ts +403 -0
  223. package/src/pages/functions/routes-validation.ts +202 -0
  224. package/src/pages/functions/routes.ts +151 -0
  225. package/src/pages/functions/tsconfig.json +8 -0
  226. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  227. package/src/pages/functions.ts +86 -0
  228. package/src/pages/hash.ts +13 -0
  229. package/src/pages/index.ts +102 -0
  230. package/src/pages/projects.tsx +159 -0
  231. package/src/pages/prompt-select-project.tsx +31 -0
  232. package/src/pages/publish.tsx +267 -0
  233. package/src/pages/types.ts +46 -0
  234. package/src/pages/upload.tsx +469 -0
  235. package/src/pages/utils.ts +23 -0
  236. package/src/parse.ts +232 -126
  237. package/src/paths.ts +53 -8
  238. package/src/proxy.ts +623 -394
  239. package/src/publish/index.ts +274 -0
  240. package/src/publish/publish.ts +1060 -0
  241. package/src/pubsub/index.ts +286 -0
  242. package/src/pubsub/pubsub-commands.ts +623 -0
  243. package/src/queues/cli/commands/consumer/add.ts +71 -0
  244. package/src/queues/cli/commands/consumer/index.ts +19 -0
  245. package/src/queues/cli/commands/consumer/remove.ts +31 -0
  246. package/src/queues/cli/commands/create.ts +25 -0
  247. package/src/queues/cli/commands/delete.ts +26 -0
  248. package/src/queues/cli/commands/index.ts +35 -0
  249. package/src/queues/cli/commands/list.ts +25 -0
  250. package/src/queues/client.ts +136 -0
  251. package/src/queues/utils.ts +18 -0
  252. package/src/r2/constants.ts +4 -0
  253. package/src/r2/helpers.ts +132 -0
  254. package/src/r2/index.ts +289 -0
  255. package/src/routes.ts +140 -0
  256. package/src/secret/index.ts +376 -0
  257. package/src/selfsigned.d.ts +23 -23
  258. package/src/sites.ts +484 -0
  259. package/src/tail/createTail.ts +406 -0
  260. package/src/tail/filters.ts +109 -111
  261. package/src/tail/index.ts +208 -296
  262. package/src/tail/printing.ts +101 -46
  263. package/src/traverse-module-graph.ts +53 -0
  264. package/src/tsconfig-sanity.ts +16 -0
  265. package/src/type-generation.ts +181 -0
  266. package/src/update-check.ts +11 -11
  267. package/src/user/access.ts +68 -0
  268. package/src/user/auth-variables.ts +113 -0
  269. package/src/user/choose-account.tsx +39 -0
  270. package/src/user/generate-auth-url.ts +33 -0
  271. package/src/user/generate-random-state.ts +16 -0
  272. package/src/user/index.ts +2 -0
  273. package/src/user/user.ts +1234 -0
  274. package/src/utils/collectKeyValues.ts +14 -0
  275. package/src/utils/render.ts +93 -0
  276. package/src/whoami.ts +135 -0
  277. package/src/worker.ts +200 -106
  278. package/src/yargs-types.ts +37 -0
  279. package/src/zones.ts +191 -0
  280. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  281. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  282. package/templates/__tests__/tsconfig.json +8 -0
  283. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  284. package/templates/checked-fetch.js +23 -0
  285. package/templates/d1-beta-facade.js +244 -0
  286. package/templates/facade.d.ts +14 -0
  287. package/templates/first-party-worker-module-facade.ts +19 -0
  288. package/templates/format-dev-errors.ts +34 -0
  289. package/templates/gitignore +1 -0
  290. package/templates/init-tests/test-jest-new-worker.js +23 -0
  291. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  292. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  293. package/templates/middleware/common.ts +62 -0
  294. package/templates/middleware/loader-modules.ts +84 -0
  295. package/templates/middleware/loader-sw.ts +233 -0
  296. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  297. package/templates/middleware/middleware-pretty-error.ts +40 -0
  298. package/templates/middleware/middleware-scheduled.ts +15 -0
  299. package/templates/new-worker-scheduled.js +17 -0
  300. package/templates/new-worker-scheduled.ts +32 -0
  301. package/templates/new-worker.js +3 -3
  302. package/templates/new-worker.ts +18 -15
  303. package/templates/no-op-worker.js +10 -0
  304. package/templates/pages-dev-pipeline.ts +31 -0
  305. package/templates/pages-dev-util.ts +52 -0
  306. package/templates/pages-shim.ts +12 -0
  307. package/templates/pages-template-plugin.ts +180 -0
  308. package/templates/pages-template-worker.ts +189 -0
  309. package/templates/serve-static-assets.ts +66 -0
  310. package/templates/service-bindings-module-facade.js +55 -0
  311. package/templates/service-bindings-sw-facade.js +42 -0
  312. package/templates/tsconfig-sanity.ts +11 -0
  313. package/templates/tsconfig.init.json +105 -0
  314. package/templates/tsconfig.json +6 -103
  315. package/templates/tsconfig.tsbuildinfo +1 -0
  316. package/wrangler-dist/cli.d.ts +1641 -0
  317. package/wrangler-dist/cli.js +139681 -112322
  318. package/wrangler-dist/wasm-sync.wasm +0 -0
  319. package/pages/functions/buildPlugin.ts +0 -105
  320. package/pages/functions/buildWorker.ts +0 -151
  321. package/pages/functions/filepath-routing.ts +0 -189
  322. package/pages/functions/identifiers.ts +0 -78
  323. package/pages/functions/routes.ts +0 -156
  324. package/pages/functions/template-plugin.ts +0 -147
  325. package/pages/functions/template-worker.ts +0 -143
  326. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  327. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  328. package/src/__tests__/pages.test.ts +0 -657
  329. package/src/dialogs.tsx +0 -87
  330. package/src/environment-variables.ts +0 -35
  331. package/src/index.tsx +0 -2789
  332. package/src/kv.ts +0 -408
  333. package/src/miniflare-cli/enum-keys.ts +0 -17
  334. package/src/pages.tsx +0 -2027
  335. package/src/publish.ts +0 -583
  336. package/src/r2.ts +0 -50
  337. package/src/sites.tsx +0 -295
  338. package/src/user.tsx +0 -1203
  339. package/src/whoami.tsx +0 -70
  340. package/templates/static-asset-facade.js +0 -47
  341. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  342. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  343. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  344. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  345. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  346. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  347. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  348. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  349. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  350. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  351. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  352. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  353. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  354. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  355. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  356. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  357. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  358. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  359. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  360. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  361. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  362. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  363. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  364. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  365. package/vendor/wrangler-mime/LICENSE +0 -21
  366. package/vendor/wrangler-mime/Mime.js +0 -97
  367. package/vendor/wrangler-mime/README.md +0 -187
  368. package/vendor/wrangler-mime/cli.js +0 -46
  369. package/vendor/wrangler-mime/index.js +0 -4
  370. package/vendor/wrangler-mime/lite.js +0 -4
  371. package/vendor/wrangler-mime/package.json +0 -52
  372. package/vendor/wrangler-mime/types/other.js +0 -1
  373. package/vendor/wrangler-mime/types/standard.js +0 -1
package/src/bundle.ts CHANGED
@@ -5,196 +5,904 @@ import * as path from "node:path";
5
5
  import NodeGlobalsPolyfills from "@esbuild-plugins/node-globals-polyfill";
6
6
  import NodeModulesPolyfills from "@esbuild-plugins/node-modules-polyfill";
7
7
  import * as esbuild from "esbuild";
8
+ import tmp from "tmp-promise";
8
9
  import createModuleCollector from "./module-collection";
10
+ import { getBasePath } from "./paths";
9
11
  import type { Config } from "./config";
12
+ import type { DurableObjectBindings } from "./config/environment";
13
+ import type { WorkerRegistry } from "./dev-registry";
10
14
  import type { Entry } from "./entry";
11
15
  import type { CfModule } from "./worker";
12
16
 
13
- type BundleResult = {
14
- modules: CfModule[];
15
- resolvedEntryPointPath: string;
16
- bundleType: "esm" | "commonjs";
17
- stop: (() => void) | undefined;
17
+ export const COMMON_ESBUILD_OPTIONS = {
18
+ // Our workerd runtime uses the same V8 version as recent Chrome, which is highly ES2022 compliant: https://kangax.github.io/compat-table/es2016plus/
19
+ target: "es2022",
20
+ loader: { ".js": "jsx", ".mjs": "jsx", ".cjs": "jsx" },
21
+ } as const;
22
+
23
+ export type BundleResult = {
24
+ modules: CfModule[];
25
+ dependencies: esbuild.Metafile["outputs"][string]["inputs"];
26
+ resolvedEntryPointPath: string;
27
+ bundleType: "esm" | "commonjs";
28
+ stop: (() => void) | undefined;
29
+ sourceMapPath?: string | undefined;
18
30
  };
19
31
 
32
+ type StaticAssetsConfig =
33
+ | (Config["assets"] & {
34
+ bypassCache: boolean | undefined;
35
+ })
36
+ | undefined;
37
+
38
+ /**
39
+ * When applying the middleware facade for service workers, we need to inject
40
+ * some code at the top of the final output bundle. Applying an inject too early
41
+ * will allow esbuild to reorder the code. Additionally, we need to make sure
42
+ * user code is bundled in the final esbuild step with `watch` correctly
43
+ * configured, so code changes are detected.
44
+ *
45
+ * This type is used as the return type for the `MiddlewareFn` type representing
46
+ * a facade-applying function. Returned injects should be injected with the
47
+ * final esbuild step.
48
+ */
49
+ type EntryWithInject = Entry & { inject?: string[] };
50
+
51
+ /**
52
+ * RegExp matching against esbuild's error text when it is unable to resolve
53
+ * a Node built-in module. If we detect this when node_compat is disabled,
54
+ * we'll rewrite the error to suggest enabling it.
55
+ */
56
+ const nodeBuiltinResolveErrorText = new RegExp(
57
+ '^Could not resolve "(' +
58
+ builtinModules.join("|") +
59
+ "|" +
60
+ builtinModules.map((module) => "node:" + module).join("|") +
61
+ ')"$'
62
+ );
63
+
64
+ /**
65
+ * Returns true if the passed value looks like an esbuild BuildFailure object
66
+ */
67
+ export function isBuildFailure(err: unknown): err is esbuild.BuildFailure {
68
+ return (
69
+ typeof err === "object" &&
70
+ err !== null &&
71
+ "errors" in err &&
72
+ "warnings" in err
73
+ );
74
+ }
75
+
20
76
  /**
21
- * Searches for any uses of node's builtin modules, and throws an error if it
22
- * finds anything. This plugin is only used when nodeCompat is not enabled.
23
- * Supports both regular node builtins, and the new "node:<MODULE>" format.
77
+ * Rewrites esbuild BuildFailures for failing to resolve Node built-in modules
78
+ * to suggest enabling Node compat as opposed to `platform: "node"`.
24
79
  */
25
- const checkForNodeBuiltinsPlugin = {
26
- name: "checkForNodeBuiltins",
27
- setup(build: esbuild.PluginBuild) {
28
- build.onResolve(
29
- {
30
- filter: new RegExp(
31
- "^(" +
32
- builtinModules.join("|") +
33
- "|" +
34
- builtinModules.map((module) => "node:" + module).join("|") +
35
- ")$"
36
- ),
37
- },
38
- () => {
39
- throw new Error(
40
- `Detected a Node builtin module import while Node compatibility is disabled.\nAdd node_compat = true to your wrangler.toml file to enable Node compatibility.`
41
- );
42
- }
43
- );
44
- },
80
+ export function rewriteNodeCompatBuildFailure(err: esbuild.BuildFailure) {
81
+ for (const error of err.errors) {
82
+ const match = nodeBuiltinResolveErrorText.exec(error.text);
83
+ if (match !== null) {
84
+ error.notes = [
85
+ {
86
+ location: null,
87
+ text: `The package "${match[1]}" wasn't found on the file system but is built into node.
88
+ Add "node_compat = true" to your wrangler.toml file to enable Node compatibility.`,
89
+ },
90
+ ];
91
+ }
92
+ }
93
+ }
94
+
95
+ const nodejsCompatPlugin: esbuild.Plugin = {
96
+ name: "nodejs_compat Plugin",
97
+ setup(pluginBuild) {
98
+ pluginBuild.onResolve({ filter: /node:.*/ }, () => {
99
+ return { external: true };
100
+ });
101
+ },
102
+ };
103
+
104
+ const cloudflareJsPlugin: esbuild.Plugin = {
105
+ name: "cloudflare javascript Plugin",
106
+ setup(pluginBuild) {
107
+ pluginBuild.onResolve({ filter: /^cloudflare:.*/ }, () => {
108
+ return { external: true };
109
+ });
110
+ },
45
111
  };
46
112
 
47
113
  /**
48
114
  * Generate a bundle for the worker identified by the arguments passed in.
49
115
  */
50
116
  export async function bundleWorker(
51
- entry: Entry,
52
- destination: string,
53
- options: {
54
- serveAssetsFromWorker: boolean;
55
- jsxFactory: string | undefined;
56
- jsxFragment: string | undefined;
57
- rules: Config["rules"];
58
- watch?: esbuild.WatchMode;
59
- tsconfig: string | undefined;
60
- minify: boolean | undefined;
61
- nodeCompat: boolean | undefined;
62
- }
117
+ entry: Entry,
118
+ destination: string,
119
+ options: {
120
+ serveAssetsFromWorker: boolean;
121
+ assets?: StaticAssetsConfig;
122
+ betaD1Shims?: string[];
123
+ doBindings: DurableObjectBindings;
124
+ jsxFactory?: string;
125
+ jsxFragment?: string;
126
+ entryName?: string;
127
+ rules: Config["rules"];
128
+ watch?: esbuild.WatchMode | boolean;
129
+ tsconfig?: string;
130
+ minify?: boolean;
131
+ legacyNodeCompat?: boolean;
132
+ nodejsCompat?: boolean;
133
+ define: Config["define"];
134
+ checkFetch: boolean;
135
+ services?: Config["services"];
136
+ workerDefinitions?: WorkerRegistry;
137
+ firstPartyWorkerDevFacade?: boolean;
138
+ targetConsumer: "dev" | "publish";
139
+ local: boolean;
140
+ testScheduled?: boolean;
141
+ experimentalLocal?: boolean;
142
+ inject?: string[];
143
+ loader?: Record<string, string>;
144
+ sourcemap?: esbuild.CommonOptions["sourcemap"];
145
+ plugins?: esbuild.Plugin[];
146
+ // TODO: Rip these out https://github.com/cloudflare/workers-sdk/issues/2153
147
+ disableModuleCollection?: boolean;
148
+ isOutfile?: boolean;
149
+ }
63
150
  ): Promise<BundleResult> {
64
- const {
65
- serveAssetsFromWorker,
66
- jsxFactory,
67
- jsxFragment,
68
- rules,
69
- watch,
70
- tsconfig,
71
- minify,
72
- nodeCompat,
73
- } = options;
74
- const entryDirectory = path.dirname(entry.file);
75
- const moduleCollector = createModuleCollector({
76
- wrangler1xlegacyModuleReferences: {
77
- rootDirectory: entryDirectory,
78
- fileNames: new Set(
79
- fs
80
- .readdirSync(entryDirectory, { withFileTypes: true })
81
- .filter(
82
- (dirEntry) =>
83
- dirEntry.isFile() && dirEntry.name !== path.basename(entry.file)
84
- )
85
- .map((dirEnt) => dirEnt.name)
86
- ),
87
- },
88
- format: entry.format,
89
- rules,
90
- });
91
-
92
- const result = await esbuild.build({
93
- ...getEntryPoint(entry.file, serveAssetsFromWorker),
94
- bundle: true,
95
- absWorkingDir: entry.directory,
96
- outdir: destination,
97
- external: ["__STATIC_CONTENT_MANIFEST"],
98
- format: entry.format === "modules" ? "esm" : "iife",
99
- target: "es2020",
100
- sourcemap: true,
101
- minify,
102
- metafile: true,
103
- conditions: ["worker", "browser"],
104
- ...(process.env.NODE_ENV && {
105
- define: {
106
- "process.env.NODE_ENV": `"${process.env.NODE_ENV}"`,
107
- ...(nodeCompat ? { global: "globalThis" } : {}),
108
- },
109
- }),
110
- loader: {
111
- ".js": "jsx",
112
- ".mjs": "jsx",
113
- ".cjs": "jsx",
114
- },
115
- plugins: [
116
- moduleCollector.plugin,
117
- ...(nodeCompat
118
- ? [NodeGlobalsPolyfills({ buffer: true }), NodeModulesPolyfills()]
119
- : // we use checkForNodeBuiltinsPlugin to throw a nicer error
120
- // if we find node builtins when nodeCompat isn't turned on
121
- [checkForNodeBuiltinsPlugin]),
122
- ],
123
- ...(jsxFactory && { jsxFactory }),
124
- ...(jsxFragment && { jsxFragment }),
125
- ...(tsconfig && { tsconfig }),
126
- watch,
127
- });
128
-
129
- const entryPointOutputs = Object.entries(result.metafile.outputs).filter(
130
- ([_path, output]) => output.entryPoint !== undefined
131
- );
132
- assert(
133
- entryPointOutputs.length > 0,
134
- `Cannot find entry-point "${entry.file}" in generated bundle.` +
135
- listEntryPoints(entryPointOutputs)
136
- );
137
- assert(
138
- entryPointOutputs.length < 2,
139
- "More than one entry-point found for generated bundle." +
140
- listEntryPoints(entryPointOutputs)
141
- );
142
-
143
- const entryPointExports = entryPointOutputs[0][1].exports;
144
- const bundleType = entryPointExports.length > 0 ? "esm" : "commonjs";
145
-
146
- return {
147
- modules: moduleCollector.modules,
148
- resolvedEntryPointPath: path.resolve(
149
- entry.directory,
150
- entryPointOutputs[0][0]
151
- ),
152
- bundleType,
153
- stop: result.stop,
154
- };
151
+ const {
152
+ serveAssetsFromWorker,
153
+ betaD1Shims,
154
+ doBindings,
155
+ jsxFactory,
156
+ jsxFragment,
157
+ entryName,
158
+ rules,
159
+ watch,
160
+ tsconfig,
161
+ minify,
162
+ legacyNodeCompat,
163
+ nodejsCompat,
164
+ checkFetch,
165
+ local,
166
+ assets,
167
+ workerDefinitions,
168
+ services,
169
+ firstPartyWorkerDevFacade,
170
+ targetConsumer,
171
+ testScheduled,
172
+ experimentalLocal,
173
+ inject: injectOption,
174
+ loader,
175
+ sourcemap,
176
+ plugins,
177
+ disableModuleCollection,
178
+ isOutfile,
179
+ } = options;
180
+
181
+ // We create a temporary directory for any oneoff files we
182
+ // need to create. This is separate from the main build
183
+ // directory (`destination`).
184
+ const tmpDir = await tmp.dir({ unsafeCleanup: true });
185
+
186
+ const entryDirectory = path.dirname(entry.file);
187
+ let moduleCollector = createModuleCollector({
188
+ wrangler1xlegacyModuleReferences: {
189
+ rootDirectory: entryDirectory,
190
+ fileNames: new Set(
191
+ fs
192
+ .readdirSync(entryDirectory, { withFileTypes: true })
193
+ .filter(
194
+ (dirEntry) =>
195
+ dirEntry.isFile() && dirEntry.name !== path.basename(entry.file)
196
+ )
197
+ .map((dirEnt) => dirEnt.name)
198
+ ),
199
+ },
200
+ format: entry.format,
201
+ rules,
202
+ });
203
+ if (disableModuleCollection) {
204
+ moduleCollector = {
205
+ modules: [],
206
+ plugin: {
207
+ name: moduleCollector.plugin.name,
208
+ setup: () => {},
209
+ },
210
+ };
211
+ }
212
+
213
+ // In dev, we want to patch `fetch()` with a special version that looks
214
+ // for bad usages and can warn the user about them; so we inject
215
+ // `checked-fetch.js` to do so. However, with yarn 3 style pnp,
216
+ // we need to extract that file to an accessible place before injecting
217
+ // it in, hence this code here.
218
+
219
+ const checkedFetchFileToInject = path.join(tmpDir.path, "checked-fetch.js");
220
+
221
+ if (checkFetch && !fs.existsSync(checkedFetchFileToInject)) {
222
+ fs.mkdirSync(tmpDir.path, {
223
+ recursive: true,
224
+ });
225
+ fs.writeFileSync(
226
+ checkedFetchFileToInject,
227
+ fs.readFileSync(path.resolve(getBasePath(), "templates/checked-fetch.js"))
228
+ );
229
+ }
230
+
231
+ // At this point, we take the opportunity to "wrap" any input workers
232
+ // with any extra functionality we may want to add. This is done by
233
+ // passing the entry point through a pipeline of functions that return
234
+ // a new entry point, that we call "middleware" or "facades".
235
+ // Look at implementations of these functions to learn more.
236
+
237
+ // We also have middleware that uses a more "traditional" middleware stack,
238
+ // which is all loaded as one in a stack.
239
+ const middlewareToLoad: MiddlewareLoader[] = [];
240
+
241
+ if (testScheduled) {
242
+ middlewareToLoad.push({
243
+ path: "templates/middleware/middleware-scheduled.ts",
244
+ });
245
+ }
246
+ if (experimentalLocal) {
247
+ // In Miniflare 3, we bind the user's worker as a service binding in a
248
+ // special entry worker that handles things like injecting `Request.cf`,
249
+ // live-reload, and the pretty-error page.
250
+ //
251
+ // Unfortunately, due to a bug in `workerd`, errors thrown asynchronously by
252
+ // native APIs don't have `stack`s. This means Miniflare can't extract the
253
+ // `stack` trace from dispatching to the user worker service binding by
254
+ // `try/catch`.
255
+ //
256
+ // As a stop-gap solution, if the `MF-Experimental-Error-Stack` header is
257
+ // truthy on responses, the body will be interpreted as a JSON-error of the
258
+ // form `{ message?: string, name?: string, stack?: string }`.
259
+ //
260
+ // This middleware wraps the user's worker in a `try/catch`, and rewrites
261
+ // errors in this format so a pretty-error page can be shown.
262
+ middlewareToLoad.push({
263
+ path: "templates/middleware/middleware-miniflare3-json-error.ts",
264
+ dev: true,
265
+ });
266
+ }
267
+
268
+ type MiddlewareFn = (currentEntry: Entry) => Promise<EntryWithInject>;
269
+ const middleware: (false | undefined | MiddlewareFn)[] = [
270
+ // serve static assets
271
+ serveAssetsFromWorker &&
272
+ ((currentEntry: Entry) => {
273
+ return applyStaticAssetFacade(currentEntry, tmpDir.path, assets);
274
+ }),
275
+ // format errors nicely
276
+ // We use an env var here because we don't actually
277
+ // want to expose this to the user. It's only used internally to
278
+ // experiment with middleware as a teaching exercise.
279
+ process.env.FORMAT_WRANGLER_ERRORS === "true" &&
280
+ ((currentEntry: Entry) => {
281
+ return applyFormatDevErrorsFacade(currentEntry, tmpDir.path);
282
+ }),
283
+ // bind to other dev instances/service bindings
284
+ workerDefinitions &&
285
+ Object.keys(workerDefinitions).length > 0 &&
286
+ services &&
287
+ services.length > 0 &&
288
+ ((currentEntry: Entry) => {
289
+ return applyMultiWorkerDevFacade(
290
+ currentEntry,
291
+ tmpDir.path,
292
+ services,
293
+ workerDefinitions
294
+ );
295
+ }),
296
+ // Simulate internal environment when using first party workers in dev
297
+ firstPartyWorkerDevFacade === true &&
298
+ ((currentEntry: Entry) => {
299
+ return applyFirstPartyWorkerDevFacade(currentEntry, tmpDir.path);
300
+ }),
301
+
302
+ Array.isArray(betaD1Shims) &&
303
+ betaD1Shims.length > 0 &&
304
+ ((currentEntry: Entry) => {
305
+ return applyD1BetaFacade(
306
+ currentEntry,
307
+ tmpDir.path,
308
+ betaD1Shims,
309
+ local && !experimentalLocal,
310
+ doBindings
311
+ );
312
+ }),
313
+
314
+ // Middleware loader: to add middleware, we add the path to the middleware
315
+ // Currently for demonstration purposes we have two example middlewares
316
+ // Middlewares are togglable by changing the `publish` (default=false) and `dev` (default=true) options
317
+ // As we are not yet supporting user created middlewares yet, if no wrangler applied middleware
318
+ // are found, we will not load any middleware. We also need to check if there are middlewares compatible with
319
+ // the target consumer (dev / publish).
320
+ (middlewareToLoad.filter(
321
+ (m) =>
322
+ (m.publish && targetConsumer === "publish") ||
323
+ (m.dev !== false && targetConsumer === "dev")
324
+ ).length > 0 ||
325
+ process.env.EXPERIMENTAL_MIDDLEWARE === "true") &&
326
+ ((currentEntry: Entry) => {
327
+ return applyMiddlewareLoaderFacade(
328
+ currentEntry,
329
+ tmpDir.path,
330
+ middlewareToLoad.filter(
331
+ // We dynamically filter the middleware depending on where we are bundling for
332
+ (m) =>
333
+ (targetConsumer === "dev" && m.dev !== false) ||
334
+ (m.publish && targetConsumer === "publish")
335
+ )
336
+ );
337
+ }),
338
+ ].filter(Boolean);
339
+
340
+ const inject: string[] = injectOption ?? [];
341
+ if (checkFetch) inject.push(checkedFetchFileToInject);
342
+
343
+ let inputEntry: EntryWithInject = entry;
344
+ for (const middlewareFn of middleware as MiddlewareFn[]) {
345
+ inputEntry = await middlewareFn(inputEntry);
346
+ if (inputEntry.inject !== undefined) inject.push(...inputEntry.inject);
347
+ }
348
+
349
+ // At this point, inputEntry points to the entry point we want to build.
350
+
351
+ const buildOptions: esbuild.BuildOptions & { metafile: true } = {
352
+ entryPoints: [inputEntry.file],
353
+ bundle: true,
354
+ absWorkingDir: entry.directory,
355
+ outdir: destination,
356
+ entryNames: entryName || path.parse(entry.file).name,
357
+ ...(isOutfile
358
+ ? {
359
+ outdir: undefined,
360
+ outfile: destination,
361
+ entryNames: undefined,
362
+ }
363
+ : {}),
364
+ inject,
365
+ external: ["__STATIC_CONTENT_MANIFEST"],
366
+ format: entry.format === "modules" ? "esm" : "iife",
367
+ target: COMMON_ESBUILD_OPTIONS.target,
368
+ sourcemap: sourcemap ?? true, // this needs to use ?? to accept false
369
+ // Include a reference to the output folder in the sourcemap.
370
+ // This is omitted by default, but we need it to properly resolve source paths in error output.
371
+ sourceRoot: destination,
372
+ minify,
373
+ metafile: true,
374
+ conditions: ["workerd", "worker", "browser"],
375
+ ...(process.env.NODE_ENV && {
376
+ define: {
377
+ // use process.env["NODE_ENV" + ""] so that esbuild doesn't replace it
378
+ // when we do a build of wrangler. (re: https://github.com/cloudflare/workers-sdk/issues/1477)
379
+ "process.env.NODE_ENV": `"${process.env["NODE_ENV" + ""]}"`,
380
+ ...(legacyNodeCompat ? { global: "globalThis" } : {}),
381
+ ...(checkFetch ? { fetch: "checkedFetch" } : {}),
382
+ ...options.define,
383
+ },
384
+ }),
385
+ loader: {
386
+ ...COMMON_ESBUILD_OPTIONS.loader,
387
+ ...(loader || {}),
388
+ },
389
+ plugins: [
390
+ moduleCollector.plugin,
391
+ ...(legacyNodeCompat
392
+ ? [NodeGlobalsPolyfills({ buffer: true }), NodeModulesPolyfills()]
393
+ : []),
394
+ ...(nodejsCompat ? [nodejsCompatPlugin] : []),
395
+ ...[cloudflareJsPlugin],
396
+ ...(plugins || []),
397
+ ],
398
+ ...(jsxFactory && { jsxFactory }),
399
+ ...(jsxFragment && { jsxFragment }),
400
+ ...(tsconfig && { tsconfig }),
401
+ watch,
402
+ // The default logLevel is "warning". So that we can rewrite errors before
403
+ // logging, we disable esbuild's default logging, and log build failures
404
+ // ourselves.
405
+ logLevel: "silent",
406
+ };
407
+ let result;
408
+ try {
409
+ result = await esbuild.build(buildOptions);
410
+ } catch (e) {
411
+ if (!legacyNodeCompat && isBuildFailure(e))
412
+ rewriteNodeCompatBuildFailure(e);
413
+ throw e;
414
+ }
415
+
416
+ const entryPointOutputs = Object.entries(result.metafile.outputs).filter(
417
+ ([_path, output]) => output.entryPoint !== undefined
418
+ );
419
+ assert(
420
+ entryPointOutputs.length > 0,
421
+ `Cannot find entry-point "${entry.file}" in generated bundle.` +
422
+ listEntryPoints(entryPointOutputs)
423
+ );
424
+ assert(
425
+ entryPointOutputs.length < 2,
426
+ "More than one entry-point found for generated bundle." +
427
+ listEntryPoints(entryPointOutputs)
428
+ );
429
+
430
+ const { exports: entryPointExports, inputs: dependencies } =
431
+ entryPointOutputs[0][1];
432
+ const bundleType = entryPointExports.length > 0 ? "esm" : "commonjs";
433
+
434
+ const sourceMapPath = Object.keys(result.metafile.outputs).filter((_path) =>
435
+ _path.includes(".map")
436
+ )[0];
437
+
438
+ const resolvedEntryPointPath = path.resolve(
439
+ entry.directory,
440
+ entryPointOutputs[0][0]
441
+ );
442
+
443
+ // copy all referenced modules into the output bundle directory
444
+ for (const module of moduleCollector.modules) {
445
+ fs.writeFileSync(
446
+ path.join(path.dirname(resolvedEntryPointPath), module.name),
447
+ module.content
448
+ );
449
+ }
450
+
451
+ return {
452
+ modules: moduleCollector.modules,
453
+ dependencies,
454
+ resolvedEntryPointPath,
455
+ bundleType,
456
+ stop: result.stop,
457
+ sourceMapPath,
458
+ };
459
+ }
460
+
461
+ /**
462
+ * A simple plugin to alias modules and mark them as external
463
+ */
464
+ export function esbuildAliasExternalPlugin(
465
+ aliases: Record<string, string>
466
+ ): esbuild.Plugin {
467
+ return {
468
+ name: "alias",
469
+ setup(build) {
470
+ build.onResolve({ filter: /.*/g }, (args) => {
471
+ // If it's the entrypoint, let it be as is
472
+ if (args.kind === "entry-point") {
473
+ return {
474
+ path: args.path,
475
+ };
476
+ }
477
+ // If it's not a recognised alias, then throw an error
478
+ if (!Object.keys(aliases).includes(args.path)) {
479
+ throw new Error("unrecognized module: " + args.path);
480
+ }
481
+
482
+ // Otherwise, return the alias
483
+ return {
484
+ path: aliases[args.path as keyof typeof aliases],
485
+ external: true,
486
+ };
487
+ });
488
+ },
489
+ };
155
490
  }
156
491
 
157
- type EntryPoint =
158
- | { stdin: esbuild.StdinOptions; nodePaths: string[] }
159
- | { entryPoints: string[] };
492
+ /**
493
+ * A middleware that catches any thrown errors, and instead formats
494
+ * them to be rendered in a browser. This middleware is for demonstration
495
+ * purposes only, and is not intended to be used in production (or even dev!)
496
+ */
497
+ async function applyFormatDevErrorsFacade(
498
+ entry: Entry,
499
+ tmpDirPath: string
500
+ ): Promise<Entry> {
501
+ const targetPath = path.join(tmpDirPath, "format-dev-errors.entry.js");
502
+ await esbuild.build({
503
+ entryPoints: [
504
+ path.resolve(getBasePath(), "templates/format-dev-errors.ts"),
505
+ ],
506
+ bundle: true,
507
+ sourcemap: true,
508
+ format: "esm",
509
+ plugins: [
510
+ esbuildAliasExternalPlugin({
511
+ __ENTRY_POINT__: entry.file,
512
+ }),
513
+ ],
514
+ outfile: targetPath,
515
+ });
516
+
517
+ return {
518
+ ...entry,
519
+ file: targetPath,
520
+ };
521
+ }
522
+
523
+ /**
524
+ * A facade that acts as a "middleware loader".
525
+ * Instead of needing to apply a facade for each individual middleware, this allows
526
+ * middleware to be written in a more traditional manner and then be applied all
527
+ * at once, requiring just two esbuild steps, rather than 1 per middleware.
528
+ */
529
+
530
+ interface MiddlewareLoader {
531
+ path: string;
532
+ // By default all middleware will run on dev, but will not be run when published
533
+ publish?: boolean;
534
+ dev?: boolean;
535
+ }
536
+
537
+ async function applyMiddlewareLoaderFacade(
538
+ entry: Entry,
539
+ tmpDirPath: string,
540
+ middleware: MiddlewareLoader[] // a list of paths to middleware files
541
+ ): Promise<EntryWithInject> {
542
+ // Firstly we need to insert the middleware array into the project,
543
+ // and then we load the middleware - this insertion and loading is
544
+ // different for each format.
545
+
546
+ // Make sure we resolve all files relative to the actual temporary directory,
547
+ // otherwise we'll have issues with source maps
548
+ tmpDirPath = fs.realpathSync(tmpDirPath);
549
+
550
+ const targetPathInsertion = path.join(
551
+ tmpDirPath,
552
+ "middleware-insertion.entry.js"
553
+ );
554
+
555
+ // We need to import each of the middlewares, so we need to generate a
556
+ // random, unique identifier that we can use for the import.
557
+ // Middlewares are required to be default exports so we can import to any name.
558
+ const middlewareIdentifiers = middleware.map(
559
+ (_, index) => `__MIDDLEWARE_${index}__`
560
+ );
561
+
562
+ const dynamicFacadePath = path.join(
563
+ tmpDirPath,
564
+ "middleware-insertion-facade.js"
565
+ );
566
+
567
+ if (entry.format === "modules") {
568
+ // We use a facade to expose the required middleware alongside any user defined
569
+ // middleware on the worker object
570
+
571
+ const imports = middlewareIdentifiers
572
+ .map((m) => `import ${m} from "${m}";`)
573
+ .join("\n");
574
+
575
+ // write a file with all of the imports required
576
+ fs.writeFileSync(
577
+ dynamicFacadePath,
578
+ `import worker from "__ENTRY_POINT__";
579
+ ${imports}
580
+ const facade = {
581
+ ...worker,
582
+ middleware: [
583
+ ${middlewareIdentifiers.join(",")}${middlewareIdentifiers.length > 0 ? "," : ""}
584
+ ...(worker.middleware ? worker.middleware : []),
585
+ ]
586
+ }
587
+ export * from "__ENTRY_POINT__";
588
+ export default facade;`
589
+ );
590
+
591
+ await esbuild.build({
592
+ entryPoints: [dynamicFacadePath],
593
+ bundle: true,
594
+ sourcemap: true,
595
+ format: "esm",
596
+ plugins: [
597
+ esbuildAliasExternalPlugin({
598
+ __ENTRY_POINT__: entry.file,
599
+ ...Object.fromEntries(
600
+ middleware.map((val, index) => [
601
+ middlewareIdentifiers[index],
602
+ path.resolve(getBasePath(), val.path),
603
+ ])
604
+ ),
605
+ }),
606
+ ],
607
+ outfile: targetPathInsertion,
608
+ });
609
+ const targetPathLoader = path.join(
610
+ tmpDirPath,
611
+ "middleware-loader.entry.js"
612
+ );
613
+ const loaderPath = path.resolve(
614
+ getBasePath(),
615
+ "templates/middleware/loader-modules.ts"
616
+ );
617
+ await esbuild.build({
618
+ entryPoints: [loaderPath],
619
+ bundle: true,
620
+ sourcemap: true,
621
+ format: "esm",
622
+ plugins: [
623
+ esbuildAliasExternalPlugin({
624
+ __ENTRY_POINT__: targetPathInsertion,
625
+ "./common": path.resolve(
626
+ getBasePath(),
627
+ "templates/middleware/common.ts"
628
+ ),
629
+ }),
630
+ ],
631
+ outfile: targetPathLoader,
632
+ });
633
+ return {
634
+ ...entry,
635
+ file: targetPathLoader,
636
+ };
637
+ } else {
638
+ const imports = middlewareIdentifiers
639
+ .map((m) => `import ${m} from "${m}";`)
640
+ .join("\n");
641
+ const contents = `import { __facade_registerInternal__ } from "__LOADER__";
642
+ ${imports}
643
+ __facade_registerInternal__([${middlewareIdentifiers.join(",")}]);`;
644
+ fs.writeFileSync(dynamicFacadePath, contents);
645
+
646
+ await esbuild.build({
647
+ entryPoints: [dynamicFacadePath],
648
+ bundle: true,
649
+ sourcemap: true,
650
+ format: "iife",
651
+ plugins: [
652
+ {
653
+ name: "dynamic-facade-imports",
654
+ setup(build) {
655
+ build.onResolve({ filter: /^__LOADER__$/ }, () => {
656
+ const loaderPath = path.resolve(
657
+ getBasePath(),
658
+ "templates/middleware/loader-sw.ts"
659
+ );
660
+ return { path: loaderPath };
661
+ });
662
+ const middlewareFilter = /^__MIDDLEWARE_(\d+)__$/;
663
+ build.onResolve({ filter: middlewareFilter }, (args) => {
664
+ const match = middlewareFilter.exec(args.path);
665
+ assert(match !== null);
666
+ const middlewareIndex = parseInt(match[1]);
667
+ return {
668
+ path: path.resolve(
669
+ getBasePath(),
670
+ middleware[middlewareIndex].path
671
+ ),
672
+ };
673
+ });
674
+ },
675
+ },
676
+ ],
677
+ outfile: targetPathInsertion,
678
+ });
679
+ return {
680
+ ...entry,
681
+ inject: [targetPathInsertion],
682
+ };
683
+ }
684
+ }
160
685
 
161
686
  /**
162
- * Create an object that describes the entry point for esbuild.
687
+ * A middleware that serves static assets from a worker.
688
+ * This powers --assets / config.assets
689
+ */
690
+
691
+ async function applyStaticAssetFacade(
692
+ entry: Entry,
693
+ tmpDirPath: string,
694
+ assets: StaticAssetsConfig
695
+ ): Promise<Entry> {
696
+ const targetPath = path.join(tmpDirPath, "serve-static-assets.entry.js");
697
+
698
+ await esbuild.build({
699
+ entryPoints: [
700
+ path.resolve(getBasePath(), "templates/serve-static-assets.ts"),
701
+ ],
702
+ bundle: true,
703
+ format: "esm",
704
+ sourcemap: true,
705
+ plugins: [
706
+ esbuildAliasExternalPlugin({
707
+ __ENTRY_POINT__: entry.file,
708
+ __KV_ASSET_HANDLER__: path.join(getBasePath(), "kv-asset-handler.js"),
709
+ __STATIC_CONTENT_MANIFEST: "__STATIC_CONTENT_MANIFEST",
710
+ }),
711
+ ],
712
+ define: {
713
+ __CACHE_CONTROL_OPTIONS__: JSON.stringify(
714
+ typeof assets === "object"
715
+ ? {
716
+ browserTTL:
717
+ assets.browser_TTL || 172800 /* 2 days: 2* 60 * 60 * 24 */,
718
+ bypassCache: assets.bypassCache,
719
+ }
720
+ : {}
721
+ ),
722
+ __SERVE_SINGLE_PAGE_APP__: JSON.stringify(
723
+ typeof assets === "object" ? assets.serve_single_page_app : false
724
+ ),
725
+ },
726
+ outfile: targetPath,
727
+ });
728
+
729
+ return {
730
+ ...entry,
731
+ file: targetPath,
732
+ };
733
+ }
734
+
735
+ /**
736
+ * A middleware that enables service bindings to be used in dev,
737
+ * binding to other love wrangler dev instances
738
+ */
739
+
740
+ async function applyMultiWorkerDevFacade(
741
+ entry: Entry,
742
+ tmpDirPath: string,
743
+ services: Config["services"],
744
+ workerDefinitions: WorkerRegistry
745
+ ) {
746
+ const targetPath = path.join(tmpDirPath, "multiworker-dev-facade.entry.js");
747
+ const serviceMap = Object.fromEntries(
748
+ (services || []).map((serviceBinding) => [
749
+ serviceBinding.binding,
750
+ workerDefinitions[serviceBinding.service] || null,
751
+ ])
752
+ );
753
+
754
+ await esbuild.build({
755
+ entryPoints: [
756
+ path.join(
757
+ getBasePath(),
758
+ entry.format === "modules"
759
+ ? "templates/service-bindings-module-facade.js"
760
+ : "templates/service-bindings-sw-facade.js"
761
+ ),
762
+ ],
763
+ bundle: true,
764
+ sourcemap: true,
765
+ format: "esm",
766
+ plugins: [
767
+ esbuildAliasExternalPlugin({
768
+ __ENTRY_POINT__: entry.file,
769
+ }),
770
+ ],
771
+ define: {
772
+ __WORKERS__: JSON.stringify(serviceMap),
773
+ },
774
+ outfile: targetPath,
775
+ });
776
+
777
+ return {
778
+ ...entry,
779
+ file: targetPath,
780
+ };
781
+ }
782
+
783
+ /**
784
+ * A middleware that makes first party workers "work" in
785
+ * our dev environments. Is applied during wrangler dev
786
+ * when config.first_party_worker is true
787
+ */
788
+ async function applyFirstPartyWorkerDevFacade(
789
+ entry: Entry,
790
+ tmpDirPath: string
791
+ ) {
792
+ if (entry.format !== "modules") {
793
+ throw new Error(
794
+ "First party workers must be in the modules format. See https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/"
795
+ );
796
+ }
797
+
798
+ const targetPath = path.join(
799
+ tmpDirPath,
800
+ "first-party-worker-module-facade.entry.js"
801
+ );
802
+
803
+ await esbuild.build({
804
+ entryPoints: [
805
+ path.resolve(
806
+ getBasePath(),
807
+ "templates/first-party-worker-module-facade.ts"
808
+ ),
809
+ ],
810
+ bundle: true,
811
+ format: "esm",
812
+ sourcemap: true,
813
+ plugins: [
814
+ esbuildAliasExternalPlugin({
815
+ __ENTRY_POINT__: entry.file,
816
+ }),
817
+ ],
818
+ outfile: targetPath,
819
+ });
820
+
821
+ return {
822
+ ...entry,
823
+ file: targetPath,
824
+ };
825
+ }
826
+
827
+ /**
828
+ * A middleware that injects the beta D1 API in JS.
163
829
  *
164
- * If we are using the experimental asset handling, then the entry point is
165
- * actually a shim worker that will either return an asset from a KV store,
166
- * or delegate to the actual worker.
830
+ * This code be removed from here when the API is in Workers core,
831
+ * but moved inside Miniflare for simulating D1.
167
832
  */
168
- function getEntryPoint(
169
- entryFile: string,
170
- serveAssetsFromWorker: boolean
171
- ): EntryPoint {
172
- if (serveAssetsFromWorker) {
173
- return {
174
- stdin: {
175
- contents: fs
176
- .readFileSync(
177
- path.join(__dirname, "../templates/static-asset-facade.js"),
178
- "utf8"
179
- )
180
- .replace("__ENTRY_POINT__", entryFile),
181
- sourcefile: "static-asset-facade.js",
182
- resolveDir: path.dirname(entryFile),
183
- },
184
- nodePaths: [path.join(__dirname, "../vendor")],
185
- };
186
- } else {
187
- return { entryPoints: [entryFile] };
188
- }
833
+ async function applyD1BetaFacade(
834
+ entry: Entry,
835
+ tmpDirPath: string,
836
+ betaD1Shims: string[],
837
+ miniflare2: boolean,
838
+ doBindings: DurableObjectBindings
839
+ ): Promise<Entry> {
840
+ let entrypointPath = path.resolve(
841
+ getBasePath(),
842
+ "templates/d1-beta-facade.js"
843
+ );
844
+ if (Array.isArray(doBindings) && doBindings.length > 0) {
845
+ //we have DO bindings, so we need to shim them
846
+ const maskedDoBindings = doBindings
847
+ // Don't shim anything not local to this worker
848
+ .filter((b) => !b.script_name)
849
+ // Reexport the DO classnames
850
+ .map(
851
+ (b) =>
852
+ `export const ${b.class_name} = maskDurableObjectDefinition(OTHER_EXPORTS.${b.class_name});`
853
+ )
854
+ .join("\n");
855
+ const baseFile = fs.readFileSync(
856
+ path.resolve(getBasePath(), "templates/d1-beta-facade.js"),
857
+ "utf8"
858
+ );
859
+ //getMaskedEnv is already used to shim regular Workers
860
+ const contents = `
861
+ ${baseFile}
862
+
863
+ var maskDurableObjectDefinition = (cls) =>
864
+ class extends cls {
865
+ constructor(state, env) {
866
+ super(state, getMaskedEnv(env));
867
+ }
868
+ };
869
+ ${maskedDoBindings}`;
870
+ const doD1FacadePath = path.join(tmpDirPath, "d1-do-facade.js");
871
+ //write our shim so we can build it
872
+ fs.writeFileSync(doD1FacadePath, contents);
873
+ entrypointPath = doD1FacadePath;
874
+ }
875
+ const targetPath = path.join(tmpDirPath, "d1-beta-facade.entry.js");
876
+ await esbuild.build({
877
+ entryPoints: [entrypointPath],
878
+ bundle: true,
879
+ format: "esm",
880
+ sourcemap: true,
881
+ plugins: [
882
+ esbuildAliasExternalPlugin({
883
+ __ENTRY_POINT__: entry.file,
884
+ }),
885
+ ],
886
+ define: {
887
+ __D1_IMPORTS__: JSON.stringify(betaD1Shims),
888
+ __LOCAL_MODE__: JSON.stringify(miniflare2),
889
+ },
890
+ outfile: targetPath,
891
+ });
892
+
893
+ return {
894
+ ...entry,
895
+ file: targetPath,
896
+ };
189
897
  }
190
898
 
191
899
  /**
192
900
  * Generate a string that describes the entry-points that were identified by esbuild.
193
901
  */
194
902
  function listEntryPoints(
195
- outputs: [string, ValueOf<esbuild.Metafile["outputs"]>][]
903
+ outputs: [string, ValueOf<esbuild.Metafile["outputs"]>][]
196
904
  ): string {
197
- return outputs.map(([_input, output]) => output.entryPoint).join("\n");
905
+ return outputs.map(([_input, output]) => output.entryPoint).join("\n");
198
906
  }
199
907
 
200
908
  type ValueOf<T> = T[keyof T];