wrangler 0.0.0-e95e5a0 → 0.0.0-e98613f8

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 (305) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +26 -4
  3. package/bin/wrangler.js +166 -34
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +1456 -21
  6. package/package.json +191 -148
  7. package/src/__tests__/access.test.ts +25 -0
  8. package/src/__tests__/api-dev.test.ts +209 -0
  9. package/src/__tests__/api-devregistry.test.js +56 -0
  10. package/src/__tests__/api.test.ts +80 -0
  11. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  12. package/src/__tests__/config-cache.test.ts +30 -24
  13. package/src/__tests__/configuration.test.ts +3970 -3114
  14. package/src/__tests__/d1.test.ts +80 -0
  15. package/src/__tests__/delete.test.ts +263 -0
  16. package/src/__tests__/deployments.test.ts +91 -0
  17. package/src/__tests__/dev.test.tsx +1528 -737
  18. package/src/__tests__/dialogs.test.tsx +40 -0
  19. package/src/__tests__/generate.test.ts +235 -0
  20. package/src/__tests__/get-host-from-url.test.ts +16 -0
  21. package/src/__tests__/guess-worker-format.test.ts +68 -68
  22. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  23. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  24. package/src/__tests__/helpers/mock-bin.ts +20 -20
  25. package/src/__tests__/helpers/mock-cfetch.ts +216 -94
  26. package/src/__tests__/helpers/mock-console.ts +58 -39
  27. package/src/__tests__/helpers/mock-dialogs.ts +114 -51
  28. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  29. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  30. package/src/__tests__/helpers/mock-istty.ts +65 -18
  31. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  32. package/src/__tests__/helpers/mock-kv.ts +27 -27
  33. package/src/__tests__/helpers/mock-oauth-flow.ts +229 -228
  34. package/src/__tests__/helpers/mock-process.ts +39 -0
  35. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  36. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  37. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  38. package/src/__tests__/helpers/msw/handlers/deployments.ts +59 -0
  39. package/src/__tests__/helpers/msw/handlers/namespaces.ts +104 -0
  40. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  41. package/src/__tests__/helpers/msw/handlers/r2.ts +80 -0
  42. package/src/__tests__/helpers/msw/handlers/script.ts +75 -0
  43. package/src/__tests__/helpers/msw/handlers/user.ts +63 -0
  44. package/src/__tests__/helpers/msw/handlers/zones.ts +22 -0
  45. package/src/__tests__/helpers/msw/index.ts +21 -0
  46. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  47. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  48. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  49. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  50. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  51. package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
  52. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  53. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  54. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  55. package/src/__tests__/https-options.test.ts +142 -109
  56. package/src/__tests__/index.test.ts +246 -231
  57. package/src/__tests__/init.test.ts +2887 -1488
  58. package/src/__tests__/jest.setup.ts +163 -30
  59. package/src/__tests__/kv.test.ts +1660 -1439
  60. package/src/__tests__/logger.test.ts +100 -74
  61. package/src/__tests__/logout.test.ts +47 -0
  62. package/src/__tests__/metrics.test.ts +450 -0
  63. package/src/__tests__/middleware.scheduled.test.ts +135 -0
  64. package/src/__tests__/middleware.test.ts +726 -0
  65. package/src/__tests__/package-manager.test.ts +312 -165
  66. package/src/__tests__/pages-deployment-tail.test.ts +820 -0
  67. package/src/__tests__/pages.test.ts +2435 -322
  68. package/src/__tests__/parse.test.ts +253 -245
  69. package/src/__tests__/paths.test.ts +39 -0
  70. package/src/__tests__/publish.test.ts +7536 -4778
  71. package/src/__tests__/pubsub.test.ts +370 -0
  72. package/src/__tests__/queues.test.ts +522 -0
  73. package/src/__tests__/r2.test.ts +388 -209
  74. package/src/__tests__/route.test.ts +18 -18
  75. package/src/__tests__/secret.test.ts +624 -426
  76. package/src/__tests__/tail.test.ts +776 -567
  77. package/src/__tests__/test-old-node-version.js +31 -0
  78. package/src/__tests__/type-generation.test.ts +226 -0
  79. package/src/__tests__/user.test.ts +117 -119
  80. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  81. package/src/__tests__/validate-dev-props.test.ts +56 -0
  82. package/src/__tests__/version.test.ts +35 -0
  83. package/src/__tests__/whoami.test.tsx +264 -91
  84. package/src/__tests__/worker-namespace.test.ts +326 -0
  85. package/src/abort.d.ts +3 -0
  86. package/src/api/dev.ts +210 -0
  87. package/src/api/index.ts +2 -0
  88. package/src/bundle-reporter.tsx +68 -0
  89. package/src/bundle.ts +789 -135
  90. package/src/cfetch/index.ts +123 -67
  91. package/src/cfetch/internal.ts +216 -90
  92. package/src/cli.ts +23 -8
  93. package/src/config/config.ts +236 -195
  94. package/src/config/diagnostics.ts +61 -61
  95. package/src/config/environment.ts +506 -339
  96. package/src/config/index.ts +309 -38
  97. package/src/config/validation-helpers.ts +379 -357
  98. package/src/config/validation.ts +1942 -1263
  99. package/src/config-cache.ts +81 -41
  100. package/src/create-worker-preview.ts +239 -132
  101. package/src/create-worker-upload-form.ts +300 -224
  102. package/src/d1/backups.tsx +223 -0
  103. package/src/d1/constants.ts +2 -0
  104. package/src/d1/create.tsx +63 -0
  105. package/src/d1/delete.tsx +56 -0
  106. package/src/d1/execute.tsx +352 -0
  107. package/src/d1/formatTimeAgo.ts +14 -0
  108. package/src/d1/index.ts +101 -0
  109. package/src/d1/list.tsx +48 -0
  110. package/src/d1/migrations/apply.tsx +184 -0
  111. package/src/d1/migrations/create.tsx +77 -0
  112. package/src/d1/migrations/helpers.ts +147 -0
  113. package/src/d1/migrations/index.tsx +3 -0
  114. package/src/d1/migrations/list.tsx +79 -0
  115. package/src/d1/migrations/options.ts +18 -0
  116. package/src/d1/options.ts +22 -0
  117. package/src/d1/types.tsx +24 -0
  118. package/src/d1/utils.ts +48 -0
  119. package/src/delete.ts +108 -0
  120. package/src/deployments.ts +77 -0
  121. package/src/deprecated/index.ts +438 -0
  122. package/src/dev/dev-vars.ts +20 -17
  123. package/src/dev/dev.tsx +549 -353
  124. package/src/dev/get-local-persistence-path.tsx +31 -0
  125. package/src/dev/local.tsx +870 -292
  126. package/src/dev/remote.tsx +591 -201
  127. package/src/dev/start-server.ts +539 -0
  128. package/src/dev/use-esbuild.ts +183 -97
  129. package/src/dev/validate-dev-props.ts +31 -0
  130. package/src/dev-registry.tsx +201 -0
  131. package/src/dev.tsx +913 -0
  132. package/src/dialogs.tsx +146 -65
  133. package/src/dispatch-namespace.ts +207 -0
  134. package/src/durable.ts +102 -0
  135. package/src/entry.ts +248 -186
  136. package/src/environment-variables.ts +38 -23
  137. package/src/errors.ts +6 -6
  138. package/src/git-client.ts +135 -0
  139. package/src/global-wrangler-config-path.ts +26 -0
  140. package/src/https-options.ts +84 -80
  141. package/src/index.tsx +636 -2617
  142. package/src/init.ts +970 -0
  143. package/src/inspect.ts +706 -562
  144. package/src/intl-polyfill.d.ts +123 -123
  145. package/src/is-ci.ts +14 -0
  146. package/src/is-interactive.ts +16 -0
  147. package/src/kv/helpers.ts +430 -0
  148. package/src/kv/index.ts +596 -0
  149. package/src/logger.ts +67 -41
  150. package/src/metrics/index.ts +5 -0
  151. package/src/metrics/metrics-config.ts +239 -0
  152. package/src/metrics/metrics-dispatcher.ts +96 -0
  153. package/src/metrics/metrics-usage-headers.ts +24 -0
  154. package/src/metrics/send-event.ts +96 -0
  155. package/src/miniflare-cli/assets.ts +220 -0
  156. package/src/miniflare-cli/index.ts +205 -33
  157. package/src/miniflare-cli/request-context.ts +18 -18
  158. package/src/module-collection.ts +221 -212
  159. package/src/open-in-browser.ts +5 -14
  160. package/src/package-manager.ts +182 -90
  161. package/src/pages/build.tsx +270 -0
  162. package/src/pages/constants.ts +18 -0
  163. package/src/pages/deployment-tails.tsx +284 -0
  164. package/src/pages/deployments.tsx +84 -0
  165. package/src/pages/dev.tsx +706 -0
  166. package/src/pages/errors.ts +66 -0
  167. package/src/pages/functions/buildPlugin.ts +107 -0
  168. package/src/pages/functions/buildWorker.ts +166 -0
  169. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  170. package/src/pages/functions/filepath-routing.ts +189 -0
  171. package/src/pages/functions/identifiers.ts +78 -0
  172. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  173. package/src/pages/functions/routes-consolidation.ts +73 -0
  174. package/src/pages/functions/routes-transformation.test.ts +282 -0
  175. package/src/pages/functions/routes-transformation.ts +115 -0
  176. package/src/pages/functions/routes-validation.test.ts +403 -0
  177. package/src/pages/functions/routes-validation.ts +202 -0
  178. package/src/pages/functions/routes.ts +151 -0
  179. package/src/pages/functions.tsx +82 -0
  180. package/src/pages/hash.tsx +13 -0
  181. package/src/pages/index.tsx +102 -0
  182. package/src/pages/projects.tsx +169 -0
  183. package/src/pages/prompt-select-project.tsx +31 -0
  184. package/src/pages/publish.tsx +451 -0
  185. package/src/pages/types.ts +41 -0
  186. package/src/pages/upload.tsx +426 -0
  187. package/src/pages/utils.ts +23 -0
  188. package/src/parse.ts +223 -120
  189. package/src/paths.ts +53 -8
  190. package/src/proxy.ts +628 -383
  191. package/src/publish/index.ts +270 -0
  192. package/src/publish/publish.ts +1035 -0
  193. package/src/pubsub/index.ts +286 -0
  194. package/src/pubsub/pubsub-commands.tsx +624 -0
  195. package/src/queues/cli/commands/consumer/add.ts +71 -0
  196. package/src/queues/cli/commands/consumer/index.ts +22 -0
  197. package/src/queues/cli/commands/consumer/remove.ts +38 -0
  198. package/src/queues/cli/commands/create.ts +25 -0
  199. package/src/queues/cli/commands/delete.ts +26 -0
  200. package/src/queues/cli/commands/index.ts +36 -0
  201. package/src/queues/cli/commands/list.ts +25 -0
  202. package/src/queues/client.ts +135 -0
  203. package/src/queues/utils.ts +18 -0
  204. package/src/r2/constants.ts +4 -0
  205. package/src/r2/helpers.ts +131 -0
  206. package/src/r2/index.ts +289 -0
  207. package/src/routes.ts +140 -0
  208. package/src/secret/index.ts +378 -0
  209. package/src/selfsigned.d.ts +23 -23
  210. package/src/sites.tsx +281 -202
  211. package/src/tail/createTail.ts +379 -0
  212. package/src/tail/filters.ts +108 -110
  213. package/src/tail/index.ts +211 -296
  214. package/src/tail/printing.ts +86 -46
  215. package/src/type-generation.ts +173 -0
  216. package/src/update-check.ts +11 -11
  217. package/src/user/access.ts +69 -0
  218. package/src/user/choose-account.tsx +69 -0
  219. package/src/user/env-vars.ts +46 -0
  220. package/src/user/generate-auth-url.ts +33 -0
  221. package/src/user/generate-random-state.ts +16 -0
  222. package/src/user/index.ts +3 -0
  223. package/src/user/user.tsx +1198 -0
  224. package/src/utils/collectKeyValues.ts +14 -0
  225. package/src/whoami.tsx +141 -42
  226. package/src/worker.ts +174 -101
  227. package/src/yargs-types.ts +24 -0
  228. package/src/zones.ts +191 -0
  229. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  230. package/templates/checked-fetch.js +17 -0
  231. package/templates/d1-beta-facade.js +205 -0
  232. package/templates/first-party-worker-module-facade.ts +18 -0
  233. package/templates/format-dev-errors.ts +32 -0
  234. package/templates/init-tests/test-jest-new-worker.js +25 -0
  235. package/templates/init-tests/test-vitest-new-worker.js +26 -0
  236. package/templates/middleware/common.ts +62 -0
  237. package/templates/middleware/loader-modules.ts +84 -0
  238. package/templates/middleware/loader-sw.ts +227 -0
  239. package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
  240. package/templates/middleware/middleware-pretty-error.ts +40 -0
  241. package/templates/middleware/middleware-scheduled.ts +15 -0
  242. package/templates/new-worker-scheduled.js +17 -0
  243. package/templates/new-worker-scheduled.ts +32 -0
  244. package/templates/new-worker.js +3 -3
  245. package/templates/new-worker.ts +18 -3
  246. package/templates/no-op-worker.js +10 -0
  247. package/templates/pages-dev-pipeline.ts +28 -0
  248. package/templates/pages-dev-util.ts +52 -0
  249. package/templates/pages-shim.ts +9 -0
  250. package/templates/pages-template-plugin.ts +171 -0
  251. package/templates/pages-template-worker.ts +189 -0
  252. package/templates/serve-static-assets.ts +63 -0
  253. package/templates/service-bindings-module-facade.js +54 -0
  254. package/templates/service-bindings-sw-facade.js +42 -0
  255. package/templates/tsconfig.json +96 -95
  256. package/wrangler-dist/cli.d.ts +893 -0
  257. package/wrangler-dist/cli.js +95201 -44118
  258. package/pages/functions/buildPlugin.ts +0 -92
  259. package/pages/functions/buildWorker.ts +0 -138
  260. package/pages/functions/filepath-routing.ts +0 -189
  261. package/pages/functions/identifiers.ts +0 -78
  262. package/pages/functions/routes.ts +0 -156
  263. package/pages/functions/template-plugin.ts +0 -146
  264. package/pages/functions/template-worker.ts +0 -143
  265. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  266. package/src/kv.ts +0 -319
  267. package/src/miniflare-cli/enum-keys.ts +0 -17
  268. package/src/pages.tsx +0 -1866
  269. package/src/publish.ts +0 -469
  270. package/src/r2.ts +0 -50
  271. package/src/user.tsx +0 -1193
  272. package/templates/static-asset-facade.js +0 -47
  273. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  274. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  275. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  276. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  277. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  278. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  279. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  280. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  281. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  282. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  283. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  284. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  285. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  286. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  287. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  288. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  289. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  290. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  291. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  292. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  293. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  294. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  295. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  296. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  297. package/vendor/wrangler-mime/LICENSE +0 -21
  298. package/vendor/wrangler-mime/Mime.js +0 -97
  299. package/vendor/wrangler-mime/README.md +0 -187
  300. package/vendor/wrangler-mime/cli.js +0 -46
  301. package/vendor/wrangler-mime/index.js +0 -4
  302. package/vendor/wrangler-mime/lite.js +0 -4
  303. package/vendor/wrangler-mime/package.json +0 -52
  304. package/vendor/wrangler-mime/types/other.js +0 -1
  305. package/vendor/wrangler-mime/types/standard.js +0 -1
@@ -2,36 +2,36 @@ import path from "node:path";
2
2
  import TOML from "@iarna/toml";
3
3
  import { Diagnostics } from "./diagnostics";
4
4
  import {
5
- deprecated,
6
- experimental,
7
- hasProperty,
8
- inheritable,
9
- isBoolean,
10
- isObjectWith,
11
- isOneOf,
12
- isOptionalProperty,
13
- isRequiredProperty,
14
- isString,
15
- isStringArray,
16
- validateAdditionalProperties,
17
- notInheritable,
18
- validateOptionalProperty,
19
- validateOptionalTypedArray,
20
- validateRequiredProperty,
21
- validateTypedArray,
22
- all,
23
- isMutuallyExclusiveWith,
24
- inheritableInLegacyEnvironments,
25
- appendEnvName,
26
- getBindingNames,
27
- isValidName,
5
+ deprecated,
6
+ experimental,
7
+ hasProperty,
8
+ inheritable,
9
+ isBoolean,
10
+ isObjectWith,
11
+ isOneOf,
12
+ isOptionalProperty,
13
+ isRequiredProperty,
14
+ isString,
15
+ isStringArray,
16
+ validateAdditionalProperties,
17
+ notInheritable,
18
+ validateOptionalProperty,
19
+ validateOptionalTypedArray,
20
+ validateRequiredProperty,
21
+ validateTypedArray,
22
+ all,
23
+ isMutuallyExclusiveWith,
24
+ inheritableInLegacyEnvironments,
25
+ appendEnvName,
26
+ getBindingNames,
27
+ isValidName,
28
28
  } from "./validation-helpers";
29
29
  import type { Config, DevConfig, RawConfig, RawDevConfig } from "./config";
30
30
  import type {
31
- RawEnvironment,
32
- DeprecatedUpload,
33
- Environment,
34
- Rule,
31
+ RawEnvironment,
32
+ DeprecatedUpload,
33
+ Environment,
34
+ Rule,
35
35
  } from "./environment";
36
36
  import type { ValidatorFn } from "./validation-helpers";
37
37
 
@@ -46,515 +46,659 @@ const ENGLISH = new Intl.ListFormat("en");
46
46
  * Any errors or warnings from the validation are available in the returned `diagnostics` object.
47
47
  */
48
48
  export function normalizeAndValidateConfig(
49
- rawConfig: RawConfig,
50
- configPath: string | undefined,
51
- args: unknown
49
+ rawConfig: RawConfig,
50
+ configPath: string | undefined,
51
+ args: unknown
52
52
  ): {
53
- config: Config;
54
- diagnostics: Diagnostics;
53
+ config: Config;
54
+ diagnostics: Diagnostics;
55
55
  } {
56
- const diagnostics = new Diagnostics(
57
- `Processing ${
58
- configPath ? path.relative(process.cwd(), configPath) : "wrangler"
59
- } configuration:`
60
- );
61
-
62
- deprecated(
63
- diagnostics,
64
- rawConfig,
65
- "miniflare",
66
- "Wrangler does not use configuration in the `miniflare` section. Unless you are using Miniflare directly you can remove this section.",
67
- true,
68
- "😶 Ignored"
69
- );
70
-
71
- deprecated(
72
- diagnostics,
73
- rawConfig,
74
- "type",
75
- "Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
76
- true,
77
- "😶 Ignored"
78
- );
79
-
80
- deprecated(
81
- diagnostics,
82
- rawConfig,
83
- "webpack_config",
84
- "Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
85
- true,
86
- "😶 Ignored"
87
- );
88
-
89
- validateOptionalProperty(
90
- diagnostics,
91
- "",
92
- "legacy_env",
93
- rawConfig.legacy_env,
94
- "boolean"
95
- );
96
-
97
- validateOptionalProperty(
98
- diagnostics,
99
- "",
100
- "minify",
101
- rawConfig.minify,
102
- "boolean"
103
- );
104
-
105
- validateOptionalProperty(
106
- diagnostics,
107
- "",
108
- "node_compat",
109
- rawConfig.node_compat,
110
- "boolean"
111
- );
112
-
113
- // TODO: set the default to false to turn on service environments as the default
114
- const isLegacyEnv =
115
- (args as { "legacy-env": boolean | undefined })["legacy-env"] ??
116
- rawConfig.legacy_env ??
117
- true;
118
-
119
- // TODO: remove this once service environments goes GA.
120
- if (!isLegacyEnv) {
121
- diagnostics.warnings.push(
122
- "Experimental: Service environments are in beta, and their behaviour is guaranteed to change in the future. DO NOT USE IN PRODUCTION."
123
- );
124
- }
125
-
126
- const topLevelEnv = normalizeAndValidateEnvironment(
127
- diagnostics,
128
- configPath,
129
- rawConfig
130
- );
131
-
132
- //TODO: find a better way to define the type of Args that can be passed to the normalizeAndValidateConfig()
133
- const envName = (args as { env: string | undefined }).env;
134
-
135
- let activeEnv = topLevelEnv;
136
- if (envName !== undefined) {
137
- const envDiagnostics = new Diagnostics(
138
- `"env.${envName}" environment configuration`
139
- );
140
- const rawEnv = rawConfig.env?.[envName];
141
- if (rawEnv !== undefined) {
142
- activeEnv = normalizeAndValidateEnvironment(
143
- envDiagnostics,
144
- configPath,
145
- rawEnv,
146
- envName,
147
- topLevelEnv,
148
- isLegacyEnv,
149
- rawConfig
150
- );
151
- diagnostics.addChild(envDiagnostics);
152
- } else {
153
- // An environment was specified, but no configuration for it was found.
154
- // To cover any legacy environment cases, where the `envName` is used,
155
- // Let's create a fake active environment with the specified `envName`.
156
- activeEnv = normalizeAndValidateEnvironment(
157
- envDiagnostics,
158
- configPath,
159
- {},
160
- envName,
161
- topLevelEnv,
162
- isLegacyEnv,
163
- rawConfig
164
- );
165
- const envNames = rawConfig.env
166
- ? `The available configured environment names are: ${JSON.stringify(
167
- Object.keys(rawConfig.env)
168
- )}\n`
169
- : "";
170
- const message =
171
- `No environment found in configuration with name "${envName}".\n` +
172
- `Before using \`--env=${envName}\` there should be an equivalent environment section in the configuration.\n` +
173
- `${envNames}\n` +
174
- `Consider adding an environment configuration section to the wrangler.toml file:\n` +
175
- "```\n[env." +
176
- envName +
177
- "]\n```\n";
178
-
179
- if (envNames.length > 0) {
180
- diagnostics.errors.push(message);
181
- } else {
182
- // Only warn (rather than error) if there are not actually any environments configured in wrangler.toml.
183
- diagnostics.warnings.push(message);
184
- }
185
- }
186
- }
187
-
188
- // Process the top-level default environment configuration.
189
- const config: Config = {
190
- configPath,
191
- legacy_env: isLegacyEnv,
192
- ...activeEnv,
193
- dev: normalizeAndValidateDev(diagnostics, rawConfig.dev ?? {}),
194
- migrations: normalizeAndValidateMigrations(
195
- diagnostics,
196
- rawConfig.migrations ?? []
197
- ),
198
- site: normalizeAndValidateSite(
199
- diagnostics,
200
- configPath,
201
- rawConfig,
202
- activeEnv.main
203
- ),
204
- wasm_modules: normalizeAndValidateModulePaths(
205
- diagnostics,
206
- configPath,
207
- "wasm_modules",
208
- rawConfig.wasm_modules
209
- ),
210
- text_blobs: normalizeAndValidateModulePaths(
211
- diagnostics,
212
- configPath,
213
- "text_blobs",
214
- rawConfig.text_blobs
215
- ),
216
- data_blobs: normalizeAndValidateModulePaths(
217
- diagnostics,
218
- configPath,
219
- "data_blobs",
220
- rawConfig.data_blobs
221
- ),
222
- };
223
-
224
- validateBindingsHaveUniqueNames(diagnostics, config);
225
-
226
- validateAdditionalProperties(
227
- diagnostics,
228
- "top-level",
229
- Object.keys(rawConfig),
230
- [...Object.keys(config), "env"]
231
- );
232
-
233
- return { config, diagnostics };
56
+ const diagnostics = new Diagnostics(
57
+ `Processing ${
58
+ configPath ? path.relative(process.cwd(), configPath) : "wrangler"
59
+ } configuration:`
60
+ );
61
+
62
+ deprecated(
63
+ diagnostics,
64
+ rawConfig,
65
+ "miniflare",
66
+ "Wrangler does not use configuration in the `miniflare` section. Unless you are using Miniflare directly you can remove this section.",
67
+ true,
68
+ "😶 Ignored"
69
+ );
70
+
71
+ deprecated(
72
+ diagnostics,
73
+ rawConfig,
74
+ "type",
75
+ "Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
76
+ true,
77
+ "😶 Ignored"
78
+ );
79
+
80
+ deprecated(
81
+ diagnostics,
82
+ rawConfig,
83
+ "webpack_config",
84
+ "Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
85
+ true,
86
+ "😶 Ignored"
87
+ );
88
+
89
+ validateOptionalProperty(
90
+ diagnostics,
91
+ "",
92
+ "legacy_env",
93
+ rawConfig.legacy_env,
94
+ "boolean"
95
+ );
96
+
97
+ validateOptionalProperty(
98
+ diagnostics,
99
+ "",
100
+ "send_metrics",
101
+ rawConfig.send_metrics,
102
+ "boolean"
103
+ );
104
+
105
+ validateOptionalProperty(
106
+ diagnostics,
107
+ "",
108
+ "keep_vars",
109
+ rawConfig.keep_vars,
110
+ "boolean"
111
+ );
112
+
113
+ // TODO: set the default to false to turn on service environments as the default
114
+ const isLegacyEnv =
115
+ (args as { "legacy-env": boolean | undefined })["legacy-env"] ??
116
+ rawConfig.legacy_env ??
117
+ true;
118
+
119
+ // TODO: remove this once service environments goes GA.
120
+ if (!isLegacyEnv) {
121
+ diagnostics.warnings.push(
122
+ "Experimental: Service environments are in beta, and their behaviour is guaranteed to change in the future. DO NOT USE IN PRODUCTION."
123
+ );
124
+ }
125
+
126
+ const topLevelEnv = normalizeAndValidateEnvironment(
127
+ diagnostics,
128
+ configPath,
129
+ rawConfig
130
+ );
131
+
132
+ //TODO: find a better way to define the type of Args that can be passed to the normalizeAndValidateConfig()
133
+ const envName = (args as { env: string | undefined }).env;
134
+
135
+ let activeEnv = topLevelEnv;
136
+ if (envName !== undefined) {
137
+ const envDiagnostics = new Diagnostics(
138
+ `"env.${envName}" environment configuration`
139
+ );
140
+ const rawEnv = rawConfig.env?.[envName];
141
+ if (rawEnv !== undefined) {
142
+ activeEnv = normalizeAndValidateEnvironment(
143
+ envDiagnostics,
144
+ configPath,
145
+ rawEnv,
146
+ envName,
147
+ topLevelEnv,
148
+ isLegacyEnv,
149
+ rawConfig
150
+ );
151
+ diagnostics.addChild(envDiagnostics);
152
+ } else {
153
+ // An environment was specified, but no configuration for it was found.
154
+ // To cover any legacy environment cases, where the `envName` is used,
155
+ // Let's create a fake active environment with the specified `envName`.
156
+ activeEnv = normalizeAndValidateEnvironment(
157
+ envDiagnostics,
158
+ configPath,
159
+ {},
160
+ envName,
161
+ topLevelEnv,
162
+ isLegacyEnv,
163
+ rawConfig
164
+ );
165
+ const envNames = rawConfig.env
166
+ ? `The available configured environment names are: ${JSON.stringify(
167
+ Object.keys(rawConfig.env)
168
+ )}\n`
169
+ : "";
170
+ const message =
171
+ `No environment found in configuration with name "${envName}".\n` +
172
+ `Before using \`--env=${envName}\` there should be an equivalent environment section in the configuration.\n` +
173
+ `${envNames}\n` +
174
+ `Consider adding an environment configuration section to the wrangler.toml file:\n` +
175
+ "```\n[env." +
176
+ envName +
177
+ "]\n```\n";
178
+
179
+ if (envNames.length > 0) {
180
+ diagnostics.errors.push(message);
181
+ } else {
182
+ // Only warn (rather than error) if there are not actually any environments configured in wrangler.toml.
183
+ diagnostics.warnings.push(message);
184
+ }
185
+ }
186
+ }
187
+
188
+ // Process the top-level default environment configuration.
189
+ const config: Config = {
190
+ configPath,
191
+ legacy_env: isLegacyEnv,
192
+ send_metrics: rawConfig.send_metrics,
193
+ keep_vars: rawConfig.keep_vars,
194
+ ...activeEnv,
195
+ dev: normalizeAndValidateDev(diagnostics, rawConfig.dev ?? {}),
196
+ migrations: normalizeAndValidateMigrations(
197
+ diagnostics,
198
+ rawConfig.migrations ?? [],
199
+ activeEnv.durable_objects
200
+ ),
201
+ site: normalizeAndValidateSite(
202
+ diagnostics,
203
+ configPath,
204
+ rawConfig,
205
+ activeEnv.main
206
+ ),
207
+ assets: normalizeAndValidateAssets(diagnostics, configPath, rawConfig),
208
+ wasm_modules: normalizeAndValidateModulePaths(
209
+ diagnostics,
210
+ configPath,
211
+ "wasm_modules",
212
+ rawConfig.wasm_modules
213
+ ),
214
+ text_blobs: normalizeAndValidateModulePaths(
215
+ diagnostics,
216
+ configPath,
217
+ "text_blobs",
218
+ rawConfig.text_blobs
219
+ ),
220
+ data_blobs: normalizeAndValidateModulePaths(
221
+ diagnostics,
222
+ configPath,
223
+ "data_blobs",
224
+ rawConfig.data_blobs
225
+ ),
226
+ };
227
+
228
+ validateBindingsHaveUniqueNames(diagnostics, config);
229
+
230
+ validateAdditionalProperties(
231
+ diagnostics,
232
+ "top-level",
233
+ Object.keys(rawConfig),
234
+ [...Object.keys(config), "env"]
235
+ );
236
+
237
+ experimental(diagnostics, rawConfig, "assets");
238
+
239
+ return { config, diagnostics };
234
240
  }
235
241
 
236
242
  /**
237
243
  * Validate the `build` configuration and return the normalized values.
238
244
  */
239
245
  function normalizeAndValidateBuild(
240
- diagnostics: Diagnostics,
241
- rawEnv: RawEnvironment,
242
- rawBuild: Config["build"],
243
- configPath: string | undefined
246
+ diagnostics: Diagnostics,
247
+ rawEnv: RawEnvironment,
248
+ rawBuild: Config["build"],
249
+ configPath: string | undefined
244
250
  ): Config["build"] & { deprecatedUpload: DeprecatedUpload } {
245
- const { command, cwd, watch_dir, upload, ...rest } = rawBuild;
246
- const deprecatedUpload: DeprecatedUpload = { ...upload };
247
- validateAdditionalProperties(diagnostics, "build", Object.keys(rest), []);
248
-
249
- validateOptionalProperty(diagnostics, "build", "command", command, "string");
250
- validateOptionalProperty(diagnostics, "build", "cwd", cwd, "string");
251
- validateOptionalProperty(
252
- diagnostics,
253
- "build",
254
- "watch_dir",
255
- watch_dir,
256
- "string"
257
- );
258
-
259
- deprecated(
260
- diagnostics,
261
- rawEnv,
262
- "build.upload.format",
263
- "The format is inferred automatically from the code.",
264
- true
265
- );
266
-
267
- if (rawEnv.main !== undefined && rawBuild.upload?.main) {
268
- diagnostics.errors.push(
269
- `Don't define both the \`main\` and \`build.upload.main\` fields in your configuration.\n` +
270
- `They serve the same purpose: to point to the entry-point of your worker.\n` +
271
- `Delete the \`build.upload.main\` and \`build.upload.dir\` field from your config.`
272
- );
273
- } else {
274
- deprecated(
275
- diagnostics,
276
- rawEnv,
277
- "build.upload.main",
278
- `Delete the \`build.upload.main\` and \`build.upload.dir\` fields.\n` +
279
- `Then add the top level \`main\` field to your configuration file:\n` +
280
- `\`\`\`\n` +
281
- `main = "${path.join(
282
- rawBuild.upload?.dir ?? "./dist",
283
- rawBuild.upload?.main ?? "."
284
- )}"\n` +
285
- `\`\`\``,
286
- true
287
- );
288
-
289
- deprecated(
290
- diagnostics,
291
- rawEnv,
292
- "build.upload.dir",
293
- `Use the top level "main" field or a command-line argument to specify the entry-point for the Worker.`,
294
- true
295
- );
296
- }
297
-
298
- return {
299
- command,
300
- watch_dir:
301
- // - `watch_dir` only matters when `command` is defined, so we apply
302
- // a default only when `command` is defined
303
- // - `configPath` will always be defined since `build` can only
304
- // be configured in `wrangler.toml`, but who knows, that may
305
- // change in the future, so we do a check anyway
306
- command
307
- ? configPath
308
- ? path.relative(
309
- process.cwd(),
310
- path.join(path.dirname(configPath), watch_dir || "./src")
311
- )
312
- : watch_dir || "./src"
313
- : watch_dir,
314
- cwd,
315
- deprecatedUpload,
316
- };
251
+ const { command, cwd, watch_dir = "./src", upload, ...rest } = rawBuild;
252
+ const deprecatedUpload: DeprecatedUpload = { ...upload };
253
+ validateAdditionalProperties(diagnostics, "build", Object.keys(rest), []);
254
+
255
+ validateOptionalProperty(diagnostics, "build", "command", command, "string");
256
+ validateOptionalProperty(diagnostics, "build", "cwd", cwd, "string");
257
+ if (Array.isArray(watch_dir)) {
258
+ validateTypedArray(diagnostics, "build.watch_dir", watch_dir, "string");
259
+ } else {
260
+ validateOptionalProperty(
261
+ diagnostics,
262
+ "build",
263
+ "watch_dir",
264
+ watch_dir,
265
+ "string"
266
+ );
267
+ }
268
+
269
+ deprecated(
270
+ diagnostics,
271
+ rawEnv,
272
+ "build.upload.format",
273
+ "The format is inferred automatically from the code.",
274
+ true
275
+ );
276
+
277
+ if (rawEnv.main !== undefined && rawBuild.upload?.main) {
278
+ diagnostics.errors.push(
279
+ `Don't define both the \`main\` and \`build.upload.main\` fields in your configuration.\n` +
280
+ `They serve the same purpose: to point to the entry-point of your worker.\n` +
281
+ `Delete the \`build.upload.main\` and \`build.upload.dir\` field from your config.`
282
+ );
283
+ } else {
284
+ deprecated(
285
+ diagnostics,
286
+ rawEnv,
287
+ "build.upload.main",
288
+ `Delete the \`build.upload.main\` and \`build.upload.dir\` fields.\n` +
289
+ `Then add the top level \`main\` field to your configuration file:\n` +
290
+ `\`\`\`\n` +
291
+ `main = "${path.join(
292
+ rawBuild.upload?.dir ?? "./dist",
293
+ rawBuild.upload?.main ?? "."
294
+ )}"\n` +
295
+ `\`\`\``,
296
+ true
297
+ );
298
+
299
+ deprecated(
300
+ diagnostics,
301
+ rawEnv,
302
+ "build.upload.dir",
303
+ `Use the top level "main" field or a command-line argument to specify the entry-point for the Worker.`,
304
+ true
305
+ );
306
+ }
307
+
308
+ return {
309
+ command,
310
+ watch_dir:
311
+ // - `watch_dir` only matters when `command` is defined, so we apply
312
+ // a default only when `command` is defined
313
+ // - `configPath` will always be defined since `build` can only
314
+ // be configured in `wrangler.toml`, but who knows, that may
315
+ // change in the future, so we do a check anyway
316
+ command && configPath
317
+ ? Array.isArray(watch_dir)
318
+ ? watch_dir.map((dir) =>
319
+ path.relative(
320
+ process.cwd(),
321
+ path.join(path.dirname(configPath), `${dir}`)
322
+ )
323
+ )
324
+ : path.relative(
325
+ process.cwd(),
326
+ path.join(path.dirname(configPath), `${watch_dir}`)
327
+ )
328
+ : watch_dir,
329
+ cwd,
330
+ deprecatedUpload,
331
+ };
317
332
  }
318
333
 
319
334
  /**
320
335
  * Validate the `main` field and return the normalized values.
321
336
  */
322
337
  function normalizeAndValidateMainField(
323
- configPath: string | undefined,
324
- rawMain: string | undefined,
325
- deprecatedUpload: DeprecatedUpload | undefined
338
+ configPath: string | undefined,
339
+ rawMain: string | undefined,
340
+ deprecatedUpload: DeprecatedUpload | undefined
326
341
  ): string | undefined {
327
- const configDir = path.dirname(configPath ?? "wrangler.toml");
328
- if (rawMain !== undefined) {
329
- if (typeof rawMain === "string") {
330
- const directory = path.resolve(configDir);
331
- return path.resolve(directory, rawMain);
332
- } else {
333
- return rawMain;
334
- }
335
- } else if (deprecatedUpload?.main !== undefined) {
336
- const directory = path.resolve(
337
- configDir,
338
- deprecatedUpload?.dir || "./dist"
339
- );
340
- return path.resolve(directory, deprecatedUpload.main);
341
- } else {
342
- return;
343
- }
342
+ const configDir = path.dirname(configPath ?? "wrangler.toml");
343
+ if (rawMain !== undefined) {
344
+ if (typeof rawMain === "string") {
345
+ const directory = path.resolve(configDir);
346
+ return path.resolve(directory, rawMain);
347
+ } else {
348
+ return rawMain;
349
+ }
350
+ } else if (deprecatedUpload?.main !== undefined) {
351
+ const directory = path.resolve(
352
+ configDir,
353
+ deprecatedUpload?.dir || "./dist"
354
+ );
355
+ return path.resolve(directory, deprecatedUpload.main);
356
+ } else {
357
+ return;
358
+ }
344
359
  }
345
360
 
346
361
  /**
347
362
  * Validate the `dev` configuration and return the normalized values.
348
363
  */
349
364
  function normalizeAndValidateDev(
350
- diagnostics: Diagnostics,
351
- rawDev: RawDevConfig
365
+ diagnostics: Diagnostics,
366
+ rawDev: RawDevConfig
352
367
  ): DevConfig {
353
- const {
354
- ip = "localhost",
355
- port = 8787,
356
- local_protocol = "http",
357
- upstream_protocol = "https",
358
- host,
359
- ...rest
360
- } = rawDev;
361
- validateAdditionalProperties(diagnostics, "dev", Object.keys(rest), []);
362
-
363
- validateOptionalProperty(diagnostics, "dev", "ip", ip, "string");
364
- validateOptionalProperty(diagnostics, "dev", "port", port, "number");
365
- validateOptionalProperty(
366
- diagnostics,
367
- "dev",
368
- "local_protocol",
369
- local_protocol,
370
- "string",
371
- ["http", "https"]
372
- );
373
- validateOptionalProperty(
374
- diagnostics,
375
- "dev",
376
- "upstream_protocol",
377
- upstream_protocol,
378
- "string",
379
- ["http", "https"]
380
- );
381
- validateOptionalProperty(diagnostics, "dev", "host", host, "string");
382
- return { ip, port, local_protocol, upstream_protocol, host };
368
+ const {
369
+ ip = "0.0.0.0",
370
+ port,
371
+ inspector_port,
372
+ local_protocol = "http",
373
+ upstream_protocol = "https",
374
+ host,
375
+ ...rest
376
+ } = rawDev;
377
+ validateAdditionalProperties(diagnostics, "dev", Object.keys(rest), []);
378
+
379
+ validateOptionalProperty(diagnostics, "dev", "ip", ip, "string");
380
+ validateOptionalProperty(diagnostics, "dev", "port", port, "number");
381
+ validateOptionalProperty(
382
+ diagnostics,
383
+ "dev",
384
+ "inspector_port",
385
+ inspector_port,
386
+ "number"
387
+ );
388
+ validateOptionalProperty(
389
+ diagnostics,
390
+ "dev",
391
+ "local_protocol",
392
+ local_protocol,
393
+ "string",
394
+ ["http", "https"]
395
+ );
396
+ validateOptionalProperty(
397
+ diagnostics,
398
+ "dev",
399
+ "upstream_protocol",
400
+ upstream_protocol,
401
+ "string",
402
+ ["http", "https"]
403
+ );
404
+ validateOptionalProperty(diagnostics, "dev", "host", host, "string");
405
+ return { ip, port, inspector_port, local_protocol, upstream_protocol, host };
383
406
  }
384
407
 
385
408
  /**
386
409
  * Validate the `migrations` configuration and return the normalized values.
387
410
  */
388
411
  function normalizeAndValidateMigrations(
389
- diagnostics: Diagnostics,
390
- rawMigrations: Config["migrations"]
412
+ diagnostics: Diagnostics,
413
+ rawMigrations: Config["migrations"],
414
+ durableObjects: Config["durable_objects"]
391
415
  ): Config["migrations"] {
392
- if (!Array.isArray(rawMigrations)) {
393
- diagnostics.errors.push(
394
- `The optional "migrations" field should be an array, but got ${JSON.stringify(
395
- rawMigrations
396
- )}`
397
- );
398
- return [];
399
- } else {
400
- for (let i = 0; i < rawMigrations.length; i++) {
401
- const migration = rawMigrations[i];
402
- validateRequiredProperty(
403
- diagnostics,
404
- `migrations[${i}]`,
405
- `tag`,
406
- migration.tag,
407
- "string"
408
- );
409
- validateOptionalTypedArray(
410
- diagnostics,
411
- `migrations[${i}].new_classes`,
412
- migration.new_classes,
413
- "string"
414
- );
415
- if (migration.renamed_classes !== undefined) {
416
- if (!Array.isArray(migration.renamed_classes)) {
417
- diagnostics.errors.push(
418
- `Expected "migrations[${i}].renamed_classes" to be an array of "{from: string, to: string}" objects but got ${JSON.stringify(
419
- migration.renamed_classes
420
- )}.`
421
- );
422
- } else if (
423
- migration.renamed_classes.some(
424
- (c) =>
425
- typeof c !== "object" ||
426
- !isRequiredProperty(c, "from", "string") ||
427
- !isRequiredProperty(c, "to", "string")
428
- )
429
- ) {
430
- diagnostics.errors.push(
431
- `Expected "migrations[${i}].renamed_classes" to be an array of "{from: string, to: string}" objects but got ${JSON.stringify(
432
- migration.renamed_classes
433
- )}.`
434
- );
435
- }
436
- }
437
- validateOptionalTypedArray(
438
- diagnostics,
439
- `migrations[${i}].deleted_classes`,
440
- migration.deleted_classes,
441
- "string"
442
- );
443
- }
444
- return rawMigrations;
445
- }
416
+ if (!Array.isArray(rawMigrations)) {
417
+ diagnostics.errors.push(
418
+ `The optional "migrations" field should be an array, but got ${JSON.stringify(
419
+ rawMigrations
420
+ )}`
421
+ );
422
+ return [];
423
+ } else {
424
+ for (let i = 0; i < rawMigrations.length; i++) {
425
+ const { tag, new_classes, renamed_classes, deleted_classes, ...rest } =
426
+ rawMigrations[i];
427
+
428
+ validateAdditionalProperties(
429
+ diagnostics,
430
+ "migrations",
431
+ Object.keys(rest),
432
+ []
433
+ );
434
+
435
+ validateRequiredProperty(
436
+ diagnostics,
437
+ `migrations[${i}]`,
438
+ `tag`,
439
+ tag,
440
+ "string"
441
+ );
442
+ validateOptionalTypedArray(
443
+ diagnostics,
444
+ `migrations[${i}].new_classes`,
445
+ new_classes,
446
+ "string"
447
+ );
448
+ if (renamed_classes !== undefined) {
449
+ if (!Array.isArray(renamed_classes)) {
450
+ diagnostics.errors.push(
451
+ `Expected "migrations[${i}].renamed_classes" to be an array of "{from: string, to: string}" objects but got ${JSON.stringify(
452
+ renamed_classes
453
+ )}.`
454
+ );
455
+ } else if (
456
+ renamed_classes.some(
457
+ (c) =>
458
+ typeof c !== "object" ||
459
+ !isRequiredProperty(c, "from", "string") ||
460
+ !isRequiredProperty(c, "to", "string")
461
+ )
462
+ ) {
463
+ diagnostics.errors.push(
464
+ `Expected "migrations[${i}].renamed_classes" to be an array of "{from: string, to: string}" objects but got ${JSON.stringify(
465
+ renamed_classes
466
+ )}.`
467
+ );
468
+ }
469
+ }
470
+ validateOptionalTypedArray(
471
+ diagnostics,
472
+ `migrations[${i}].deleted_classes`,
473
+ deleted_classes,
474
+ "string"
475
+ );
476
+ }
477
+
478
+ if (
479
+ Array.isArray(durableObjects?.bindings) &&
480
+ durableObjects.bindings.length > 0
481
+ ) {
482
+ // intrinsic [durable_objects] implies [migrations]
483
+ const exportedDurableObjects = (durableObjects.bindings || []).filter(
484
+ (binding) => !binding.script_name
485
+ );
486
+ if (exportedDurableObjects.length > 0 && rawMigrations.length === 0) {
487
+ if (
488
+ !exportedDurableObjects.some(
489
+ (exportedDurableObject) =>
490
+ typeof exportedDurableObject.class_name !== "string"
491
+ )
492
+ ) {
493
+ const durableObjectClassnames = exportedDurableObjects.map(
494
+ (durable) => durable.class_name
495
+ );
496
+
497
+ diagnostics.warnings.push(
498
+ `In wrangler.toml, you have configured [durable_objects] exported by this Worker (${durableObjectClassnames.join(
499
+ ", "
500
+ )}), but no [migrations] for them. This may not work as expected until you add a [migrations] section to your wrangler.toml. Add this configuration to your wrangler.toml:
501
+
502
+ \`\`\`
503
+ [[migrations]]
504
+ tag = "v1" # Should be unique for each entry
505
+ new_classes = [${durableObjectClassnames
506
+ .map((name) => `"${name}"`)
507
+ .join(", ")}]
508
+ \`\`\`
509
+
510
+ Refer to https://developers.cloudflare.com/workers/learning/using-durable-objects/#durable-object-migrations-in-wranglertoml for more details.`
511
+ );
512
+ }
513
+ }
514
+ }
515
+
516
+ return rawMigrations;
517
+ }
446
518
  }
447
519
 
448
520
  /**
449
521
  * Validate the `site` configuration and return the normalized values.
450
522
  */
451
523
  function normalizeAndValidateSite(
452
- diagnostics: Diagnostics,
453
- configPath: string | undefined,
454
- rawConfig: RawConfig,
455
- mainEntryPoint: string | undefined
524
+ diagnostics: Diagnostics,
525
+ configPath: string | undefined,
526
+ rawConfig: RawConfig,
527
+ mainEntryPoint: string | undefined
456
528
  ): Config["site"] {
457
- if (rawConfig?.site !== undefined) {
458
- const { bucket, include = [], exclude = [], ...rest } = rawConfig.site;
459
-
460
- validateAdditionalProperties(diagnostics, "site", Object.keys(rest), [
461
- "entry-point",
462
- ]);
463
- validateRequiredProperty(diagnostics, "site", "bucket", bucket, "string");
464
- validateTypedArray(diagnostics, "sites.include", include, "string");
465
- validateTypedArray(diagnostics, "sites.exclude", exclude, "string");
466
- validateOptionalProperty(
467
- diagnostics,
468
- "site",
469
- "entry-point",
470
- rawConfig.site["entry-point"],
471
- "string"
472
- );
473
-
474
- deprecated(
475
- diagnostics,
476
- rawConfig,
477
- `site.entry-point`,
478
- `Delete the \`site.entry-point\` field, then add the top level \`main\` field to your configuration file:\n` +
479
- `\`\`\`\n` +
480
- `main = "${path.join(
481
- String(rawConfig.site["entry-point"]) || "workers-site",
482
- path.extname(String(rawConfig.site["entry-point"]) || "workers-site")
483
- ? ""
484
- : "index.js"
485
- )}"\n` +
486
- `\`\`\``,
487
- false,
488
- undefined,
489
- "warning"
490
- );
491
-
492
- let siteEntryPoint = rawConfig.site["entry-point"];
493
-
494
- if (!mainEntryPoint && !siteEntryPoint) {
495
- // this means that we're defaulting to "workers-site"
496
- // so let's add the deprecation warning
497
- diagnostics.warnings.push(
498
- `Because you've defined a [site] configuration, we're defaulting to "workers-site" for the deprecated \`site.entry-point\`field.\n` +
499
- `Add the top level \`main\` field to your configuration file:\n` +
500
- `\`\`\`\n` +
501
- `main = "workers-site/index.js"\n` +
502
- `\`\`\``
503
- );
504
- siteEntryPoint = "workers-site";
505
- } else if (mainEntryPoint && siteEntryPoint) {
506
- diagnostics.errors.push(
507
- `Don't define both the \`main\` and \`site.entry-point\` fields in your configuration.\n` +
508
- `They serve the same purpose: to point to the entry-point of your worker.\n` +
509
- `Delete the deprecated \`site.entry-point\` field from your config.`
510
- );
511
- }
512
-
513
- if (configPath && siteEntryPoint) {
514
- // rewrite the path to be relative to the working directory
515
- siteEntryPoint = path.relative(
516
- process.cwd(),
517
- path.join(path.dirname(configPath), siteEntryPoint)
518
- );
519
- }
520
-
521
- return {
522
- bucket,
523
- "entry-point": siteEntryPoint,
524
- include,
525
- exclude,
526
- };
527
- }
528
- return undefined;
529
+ if (rawConfig?.site !== undefined) {
530
+ const { bucket, include = [], exclude = [], ...rest } = rawConfig.site;
531
+
532
+ validateAdditionalProperties(diagnostics, "site", Object.keys(rest), [
533
+ "entry-point",
534
+ ]);
535
+ validateRequiredProperty(diagnostics, "site", "bucket", bucket, "string");
536
+ validateTypedArray(diagnostics, "sites.include", include, "string");
537
+ validateTypedArray(diagnostics, "sites.exclude", exclude, "string");
538
+ validateOptionalProperty(
539
+ diagnostics,
540
+ "site",
541
+ "entry-point",
542
+ rawConfig.site["entry-point"],
543
+ "string"
544
+ );
545
+
546
+ deprecated(
547
+ diagnostics,
548
+ rawConfig,
549
+ `site.entry-point`,
550
+ `Delete the \`site.entry-point\` field, then add the top level \`main\` field to your configuration file:\n` +
551
+ `\`\`\`\n` +
552
+ `main = "${path.join(
553
+ String(rawConfig.site["entry-point"]) || "workers-site",
554
+ path.extname(String(rawConfig.site["entry-point"]) || "workers-site")
555
+ ? ""
556
+ : "index.js"
557
+ )}"\n` +
558
+ `\`\`\``,
559
+ false,
560
+ undefined,
561
+ "warning"
562
+ );
563
+
564
+ let siteEntryPoint = rawConfig.site["entry-point"];
565
+
566
+ if (!mainEntryPoint && !siteEntryPoint) {
567
+ // this means that we're defaulting to "workers-site"
568
+ // so let's add the deprecation warning
569
+ diagnostics.warnings.push(
570
+ `Because you've defined a [site] configuration, we're defaulting to "workers-site" for the deprecated \`site.entry-point\`field.\n` +
571
+ `Add the top level \`main\` field to your configuration file:\n` +
572
+ `\`\`\`\n` +
573
+ `main = "workers-site/index.js"\n` +
574
+ `\`\`\``
575
+ );
576
+ siteEntryPoint = "workers-site";
577
+ } else if (mainEntryPoint && siteEntryPoint) {
578
+ diagnostics.errors.push(
579
+ `Don't define both the \`main\` and \`site.entry-point\` fields in your configuration.\n` +
580
+ `They serve the same purpose: to point to the entry-point of your worker.\n` +
581
+ `Delete the deprecated \`site.entry-point\` field from your config.`
582
+ );
583
+ }
584
+
585
+ if (configPath && siteEntryPoint) {
586
+ // rewrite the path to be relative to the working directory
587
+ siteEntryPoint = path.relative(
588
+ process.cwd(),
589
+ path.join(path.dirname(configPath), siteEntryPoint)
590
+ );
591
+ }
592
+
593
+ return {
594
+ bucket,
595
+ "entry-point": siteEntryPoint,
596
+ include,
597
+ exclude,
598
+ };
599
+ }
600
+ return undefined;
601
+ }
602
+
603
+ /**
604
+ * Validate the `assets` configuration and return normalized values.
605
+ */
606
+ function normalizeAndValidateAssets(
607
+ diagnostics: Diagnostics,
608
+ configPath: string | undefined,
609
+ rawConfig: RawConfig
610
+ ): Config["assets"] {
611
+ // Even though the type doesn't say it,
612
+ // we allow for a string input in the config,
613
+ // so let's normalise it
614
+ if (typeof rawConfig?.assets === "string") {
615
+ return {
616
+ bucket: rawConfig.assets,
617
+ include: [],
618
+ exclude: [],
619
+ browser_TTL: undefined,
620
+ serve_single_page_app: false,
621
+ };
622
+ }
623
+
624
+ if (rawConfig?.assets === undefined) {
625
+ return undefined;
626
+ }
627
+
628
+ if (typeof rawConfig.assets !== "object") {
629
+ diagnostics.errors.push(
630
+ `Expected the \`assets\` field to be a string or an object, but got ${typeof rawConfig.assets}.`
631
+ );
632
+ return undefined;
633
+ }
634
+
635
+ const {
636
+ bucket,
637
+ include = [],
638
+ exclude = [],
639
+ browser_TTL,
640
+ serve_single_page_app,
641
+ ...rest
642
+ } = rawConfig.assets;
643
+
644
+ validateAdditionalProperties(diagnostics, "assets", Object.keys(rest), []);
645
+
646
+ validateRequiredProperty(diagnostics, "assets", "bucket", bucket, "string");
647
+ validateTypedArray(diagnostics, "assets.include", include, "string");
648
+ validateTypedArray(diagnostics, "assets.exclude", exclude, "string");
649
+
650
+ validateOptionalProperty(
651
+ diagnostics,
652
+ "assets",
653
+ "browser_TTL",
654
+ browser_TTL,
655
+ "number"
656
+ );
657
+
658
+ validateOptionalProperty(
659
+ diagnostics,
660
+ "assets",
661
+ "serve_single_page_app",
662
+ serve_single_page_app,
663
+ "boolean"
664
+ );
665
+
666
+ return {
667
+ bucket,
668
+ include,
669
+ exclude,
670
+ browser_TTL,
671
+ serve_single_page_app,
672
+ };
529
673
  }
530
674
 
531
675
  /**
532
676
  * Map the paths of the `wasm_modules`, `text_blobs` or `data_blobs` configuration to be relative to the current working directory.
533
677
  */
534
678
  function normalizeAndValidateModulePaths(
535
- diagnostics: Diagnostics,
536
- configPath: string | undefined,
537
- field: "wasm_modules" | "text_blobs" | "data_blobs",
538
- rawMapping: Record<string, string> | undefined
679
+ diagnostics: Diagnostics,
680
+ configPath: string | undefined,
681
+ field: "wasm_modules" | "text_blobs" | "data_blobs",
682
+ rawMapping: Record<string, string> | undefined
539
683
  ): Record<string, string> | undefined {
540
- if (rawMapping === undefined) {
541
- return undefined;
542
- }
543
- const mapping: Record<string, string> = {};
544
- // Rewrite paths to be relative to the cwd, rather than the config path.
545
- for (const [name, filePath] of Object.entries(rawMapping)) {
546
- if (isString(diagnostics, `${field}['${name}']`, filePath, undefined)) {
547
- if (configPath) {
548
- mapping[name] = configPath
549
- ? path.relative(
550
- process.cwd(),
551
- path.join(path.dirname(configPath), filePath)
552
- )
553
- : filePath;
554
- }
555
- }
556
- }
557
- return mapping;
684
+ if (rawMapping === undefined) {
685
+ return undefined;
686
+ }
687
+ const mapping: Record<string, string> = {};
688
+ // Rewrite paths to be relative to the cwd, rather than the config path.
689
+ for (const [name, filePath] of Object.entries(rawMapping)) {
690
+ if (isString(diagnostics, `${field}['${name}']`, filePath, undefined)) {
691
+ if (configPath) {
692
+ mapping[name] = configPath
693
+ ? path.relative(
694
+ process.cwd(),
695
+ path.join(path.dirname(configPath), filePath)
696
+ )
697
+ : filePath;
698
+ }
699
+ }
700
+ }
701
+ return mapping;
558
702
  }
559
703
 
560
704
  /**
@@ -562,597 +706,847 @@ function normalizeAndValidateModulePaths(
562
706
  * or an object that looks like {pattern: string, zone_id: string }
563
707
  */
564
708
  function isValidRouteValue(item: unknown): boolean {
565
- return (
566
- !!item &&
567
- (typeof item === "string" ||
568
- (typeof item === "object" &&
569
- hasProperty(item, "pattern") &&
570
- typeof item.pattern === "string" &&
571
- // it could have a zone_name
572
- ((hasProperty(item, "zone_name") &&
573
- typeof item.zone_name === "string") ||
574
- // or a zone_id
575
- (hasProperty(item, "zone_id") && typeof item.zone_id === "string")) &&
576
- Object.keys(item).length === 2))
577
- );
709
+ if (!item) {
710
+ return false;
711
+ }
712
+ if (typeof item === "string") {
713
+ return true;
714
+ }
715
+ if (typeof item === "object") {
716
+ if (!hasProperty(item, "pattern") || typeof item.pattern !== "string") {
717
+ return false;
718
+ }
719
+
720
+ const otherKeys = Object.keys(item).length - 1; // minus one to subtract "pattern"
721
+
722
+ const hasZoneId =
723
+ hasProperty(item, "zone_id") && typeof item.zone_id === "string";
724
+ const hasZoneName =
725
+ hasProperty(item, "zone_name") && typeof item.zone_name === "string";
726
+ const hasCustomDomainFlag =
727
+ hasProperty(item, "custom_domain") &&
728
+ typeof item.custom_domain === "boolean";
729
+
730
+ if (otherKeys === 2 && hasCustomDomainFlag && (hasZoneId || hasZoneName)) {
731
+ return true;
732
+ } else if (
733
+ otherKeys === 1 &&
734
+ (hasZoneId || hasZoneName || hasCustomDomainFlag)
735
+ ) {
736
+ return true;
737
+ }
738
+ }
739
+ return false;
740
+ }
741
+
742
+ /**
743
+ * If account_id has been passed as an empty string, normalise it to undefined.
744
+ * This is to workaround older wrangler1-era templates that have account_id = '',
745
+ * which isn't a valid value anyway
746
+ */
747
+ function mutateEmptyStringAccountIDValue(
748
+ diagnostics: Diagnostics,
749
+ rawEnv: RawEnvironment
750
+ ) {
751
+ if (rawEnv.account_id === "") {
752
+ diagnostics.warnings.push(
753
+ `The "account_id" field in your configuration is an empty string and will be ignored.\n` +
754
+ `Please remove the "account_id" field from your configuration.`
755
+ );
756
+ rawEnv.account_id = undefined;
757
+ }
758
+ return rawEnv;
759
+ }
760
+
761
+ /**
762
+ * Normalize empty string to `undefined` by mutating rawEnv.route value.
763
+ * As part of backward compatibility with Wrangler1 converting empty string to `undefined`
764
+ */
765
+ function mutateEmptyStringRouteValue(
766
+ diagnostics: Diagnostics,
767
+ rawEnv: RawEnvironment
768
+ ): RawEnvironment {
769
+ if (rawEnv["route"] === "") {
770
+ diagnostics.warnings.push(
771
+ `The "route" field in your configuration is an empty string and will be ignored.\n` +
772
+ `Please remove the "route" field from your configuration.`
773
+ );
774
+ rawEnv["route"] = undefined;
775
+ }
776
+
777
+ return rawEnv;
578
778
  }
579
779
 
580
780
  /**
581
781
  * Validate that the field is a route.
582
782
  */
583
783
  const isRoute: ValidatorFn = (diagnostics, field, value) => {
584
- if (value !== undefined && !isValidRouteValue(value)) {
585
- diagnostics.errors.push(
586
- `Expected "${field}" to be either a string, or an object with shape { pattern, zone_id | zone_name }, but got ${JSON.stringify(
587
- value
588
- )}.`
589
- );
590
- return false;
591
- }
592
- return true;
784
+ if (value !== undefined && !isValidRouteValue(value)) {
785
+ diagnostics.errors.push(
786
+ `Expected "${field}" to be either a string, or an object with shape { pattern, custom_domain, zone_id | zone_name }, but got ${JSON.stringify(
787
+ value
788
+ )}.`
789
+ );
790
+ return false;
791
+ }
792
+ return true;
593
793
  };
594
794
 
595
795
  /**
596
796
  * Validate that the field is an array of routes.
597
797
  */
598
798
  const isRouteArray: ValidatorFn = (diagnostics, field, value) => {
599
- if (value === undefined) {
600
- return true;
601
- }
602
- if (!Array.isArray(value)) {
603
- diagnostics.errors.push(
604
- `Expected "${field}" to be an array but got ${JSON.stringify(value)}.`
605
- );
606
- return false;
607
- }
608
- const invalidRoutes = [];
609
- for (const item of value) {
610
- if (!isValidRouteValue(item)) {
611
- invalidRoutes.push(item);
612
- }
613
- }
614
- if (invalidRoutes.length > 0) {
615
- diagnostics.errors.push(
616
- `Expected "${field}" to be an array of either strings or objects with the shape { pattern, zone_id | zone_name }, but these weren't valid: ${JSON.stringify(
617
- invalidRoutes,
618
- null,
619
- 2
620
- )}.`
621
- );
622
- }
623
- return invalidRoutes.length === 0;
799
+ if (value === undefined) {
800
+ return true;
801
+ }
802
+ if (!Array.isArray(value)) {
803
+ diagnostics.errors.push(
804
+ `Expected "${field}" to be an array but got ${JSON.stringify(value)}.`
805
+ );
806
+ return false;
807
+ }
808
+ const invalidRoutes = [];
809
+ for (const item of value) {
810
+ if (!isValidRouteValue(item)) {
811
+ invalidRoutes.push(item);
812
+ }
813
+ }
814
+ if (invalidRoutes.length > 0) {
815
+ diagnostics.errors.push(
816
+ `Expected "${field}" to be an array of either strings or objects with the shape { pattern, custom_domain, zone_id | zone_name }, but these weren't valid: ${JSON.stringify(
817
+ invalidRoutes,
818
+ null,
819
+ 2
820
+ )}.`
821
+ );
822
+ }
823
+ return invalidRoutes.length === 0;
624
824
  };
625
825
 
626
- function validateRoute(
627
- diagnostics: Diagnostics,
628
- topLevelEnv: Environment | undefined,
629
- rawEnv: RawEnvironment
826
+ function normalizeAndValidateRoute(
827
+ diagnostics: Diagnostics,
828
+ topLevelEnv: Environment | undefined,
829
+ rawEnv: RawEnvironment
630
830
  ): Config["route"] {
631
- return inheritable(
632
- diagnostics,
633
- topLevelEnv,
634
- rawEnv,
635
- "route",
636
- isRoute,
637
- undefined
638
- );
831
+ return inheritable(
832
+ diagnostics,
833
+ topLevelEnv,
834
+ mutateEmptyStringRouteValue(diagnostics, rawEnv),
835
+ "route",
836
+ isRoute,
837
+ undefined
838
+ );
639
839
  }
640
840
 
641
841
  function validateRoutes(
642
- diagnostics: Diagnostics,
643
- topLevelEnv: Environment | undefined,
644
- rawEnv: RawEnvironment
842
+ diagnostics: Diagnostics,
843
+ topLevelEnv: Environment | undefined,
844
+ rawEnv: RawEnvironment
645
845
  ): Config["routes"] {
646
- return inheritable(
647
- diagnostics,
648
- topLevelEnv,
649
- rawEnv,
650
- "routes",
651
- all(isRouteArray, isMutuallyExclusiveWith(rawEnv, "route")),
652
- undefined
653
- );
846
+ return inheritable(
847
+ diagnostics,
848
+ topLevelEnv,
849
+ rawEnv,
850
+ "routes",
851
+ all(isRouteArray, isMutuallyExclusiveWith(rawEnv, "route")),
852
+ undefined
853
+ );
654
854
  }
655
855
 
656
856
  /**
657
857
  * Validate top-level environment configuration and return the normalized values.
658
858
  */
659
859
  function normalizeAndValidateEnvironment(
660
- diagnostics: Diagnostics,
661
- configPath: string | undefined,
662
- topLevelEnv: RawEnvironment
860
+ diagnostics: Diagnostics,
861
+ configPath: string | undefined,
862
+ topLevelEnv: RawEnvironment
663
863
  ): Environment;
664
864
  /**
665
865
  * Validate the named environment configuration and return the normalized values.
666
866
  */
667
867
  function normalizeAndValidateEnvironment(
668
- diagnostics: Diagnostics,
669
- configPath: string | undefined,
670
- rawEnv: RawEnvironment,
671
- envName: string,
672
- topLevelEnv: Environment,
673
- isLegacyEnv: boolean,
674
- rawConfig: RawConfig
868
+ diagnostics: Diagnostics,
869
+ configPath: string | undefined,
870
+ rawEnv: RawEnvironment,
871
+ envName: string,
872
+ topLevelEnv: Environment,
873
+ isLegacyEnv: boolean,
874
+ rawConfig: RawConfig
675
875
  ): Environment;
676
876
  function normalizeAndValidateEnvironment(
677
- diagnostics: Diagnostics,
678
- configPath: string | undefined,
679
- rawEnv: RawEnvironment,
680
- envName = "top level",
681
- topLevelEnv?: Environment | undefined,
682
- isLegacyEnv?: boolean,
683
- rawConfig?: RawConfig | undefined
877
+ diagnostics: Diagnostics,
878
+ configPath: string | undefined,
879
+ rawEnv: RawEnvironment,
880
+ envName = "top level",
881
+ topLevelEnv?: Environment | undefined,
882
+ isLegacyEnv?: boolean,
883
+ rawConfig?: RawConfig | undefined
684
884
  ): Environment {
685
- deprecated(
686
- diagnostics,
687
- rawEnv,
688
- "zone_id",
689
- "This is unnecessary since we can deduce this from routes directly.",
690
- false // We need to leave this in-place for the moment since `route` commands might use it.
691
- );
692
-
693
- // The field "experimental_services" doesn't exist anymore in the config, but we still want to error about any older usage.
694
- // TODO: remove this before GA.
695
- deprecated(
696
- diagnostics,
697
- rawEnv,
698
- "experimental_services",
699
- `The "experimental_services" field is no longer supported. Instead, use [[unsafe.bindings]] to enable experimental features. Add this to your wrangler.toml:\n` +
700
- "```\n" +
701
- TOML.stringify({
702
- unsafe: {
703
- bindings: (rawEnv?.experimental_services || []).map(
704
- (serviceDefinition) => {
705
- return {
706
- name: serviceDefinition.name,
707
- type: "service",
708
- service: serviceDefinition.service,
709
- environment: serviceDefinition.environment,
710
- };
711
- }
712
- ),
713
- },
714
- }) +
715
- "```",
716
- true
717
- );
718
-
719
- experimental(diagnostics, rawEnv, "unsafe");
720
-
721
- const route = validateRoute(diagnostics, topLevelEnv, rawEnv);
722
-
723
- const routes = validateRoutes(diagnostics, topLevelEnv, rawEnv);
724
-
725
- const workers_dev = inheritable(
726
- diagnostics,
727
- topLevelEnv,
728
- rawEnv,
729
- "workers_dev",
730
- isBoolean,
731
- undefined
732
- );
733
-
734
- const { deprecatedUpload, ...build } = normalizeAndValidateBuild(
735
- diagnostics,
736
- rawEnv,
737
- rawEnv.build ?? topLevelEnv?.build ?? {},
738
- configPath
739
- );
740
-
741
- const environment: Environment = {
742
- // Inherited fields
743
- account_id: inheritableInLegacyEnvironments(
744
- diagnostics,
745
- isLegacyEnv,
746
- topLevelEnv,
747
- rawEnv,
748
- "account_id",
749
- isString,
750
- undefined,
751
- undefined
752
- ),
753
- compatibility_date: inheritable(
754
- diagnostics,
755
- topLevelEnv,
756
- rawEnv,
757
- "compatibility_date",
758
- isString,
759
- undefined
760
- ),
761
- compatibility_flags: inheritable(
762
- diagnostics,
763
- topLevelEnv,
764
- rawEnv,
765
- "compatibility_flags",
766
- isStringArray,
767
- []
768
- ),
769
- jsx_factory: inheritable(
770
- diagnostics,
771
- topLevelEnv,
772
- rawEnv,
773
- "jsx_factory",
774
- isString,
775
- "React.createElement"
776
- ),
777
- jsx_fragment: inheritable(
778
- diagnostics,
779
- topLevelEnv,
780
- rawEnv,
781
- "jsx_fragment",
782
- isString,
783
- "React.Fragment"
784
- ),
785
- tsconfig: validateAndNormalizeTsconfig(
786
- diagnostics,
787
- topLevelEnv,
788
- rawEnv,
789
- configPath
790
- ),
791
- rules: validateAndNormalizeRules(
792
- diagnostics,
793
- topLevelEnv,
794
- rawEnv,
795
- deprecatedUpload?.rules,
796
- envName
797
- ),
798
- name: inheritableInLegacyEnvironments(
799
- diagnostics,
800
- isLegacyEnv,
801
- topLevelEnv,
802
- rawEnv,
803
- "name",
804
- isValidName,
805
- appendEnvName(envName),
806
- undefined
807
- ),
808
- main: normalizeAndValidateMainField(
809
- configPath,
810
- inheritable(
811
- diagnostics,
812
- topLevelEnv,
813
- rawEnv,
814
- "main",
815
- isString,
816
- undefined
817
- ),
818
- deprecatedUpload
819
- ),
820
- route,
821
- routes,
822
- triggers: inheritable(
823
- diagnostics,
824
- topLevelEnv,
825
- rawEnv,
826
- "triggers",
827
- isObjectWith("crons"),
828
- { crons: [] }
829
- ),
830
- usage_model: inheritable(
831
- diagnostics,
832
- topLevelEnv,
833
- rawEnv,
834
- "usage_model",
835
- isOneOf("bundled", "unbound"),
836
- undefined
837
- ),
838
- build,
839
- workers_dev,
840
- // Not inherited fields
841
- vars: notInheritable(
842
- diagnostics,
843
- topLevelEnv,
844
- rawConfig,
845
- rawEnv,
846
- envName,
847
- "vars",
848
- validateVars(envName),
849
- {}
850
- ),
851
- durable_objects: notInheritable(
852
- diagnostics,
853
- topLevelEnv,
854
- rawConfig,
855
- rawEnv,
856
- envName,
857
- "durable_objects",
858
- validateBindingsProperty(envName, validateDurableObjectBinding),
859
- {
860
- bindings: [],
861
- }
862
- ),
863
- kv_namespaces: notInheritable(
864
- diagnostics,
865
- topLevelEnv,
866
- rawConfig,
867
- rawEnv,
868
- envName,
869
- "kv_namespaces",
870
- validateBindingArray(envName, validateKVBinding),
871
- []
872
- ),
873
- r2_buckets: notInheritable(
874
- diagnostics,
875
- topLevelEnv,
876
- rawConfig,
877
- rawEnv,
878
- envName,
879
- "r2_buckets",
880
- validateBindingArray(envName, validateR2Binding),
881
- []
882
- ),
883
- unsafe: notInheritable(
884
- diagnostics,
885
- topLevelEnv,
886
- rawConfig,
887
- rawEnv,
888
- envName,
889
- "unsafe",
890
- validateBindingsProperty(envName, validateUnsafeBinding),
891
- {
892
- bindings: [],
893
- }
894
- ),
895
- zone_id: rawEnv.zone_id,
896
- minify: rawEnv.minify,
897
- node_compat: rawEnv.node_compat,
898
- };
899
-
900
- return environment;
885
+ deprecated(
886
+ diagnostics,
887
+ rawEnv,
888
+ "kv-namespaces",
889
+ `The "kv-namespaces" field is no longer supported, please rename to "kv_namespaces"`,
890
+ true
891
+ );
892
+ deprecated(
893
+ diagnostics,
894
+ rawEnv,
895
+ "zone_id",
896
+ "This is unnecessary since we can deduce this from routes directly.",
897
+ false // We need to leave this in-place for the moment since `route` commands might use it.
898
+ );
899
+
900
+ // The field "experimental_services" doesn't exist anymore in the config, but we still want to error about any older usage.
901
+
902
+ deprecated(
903
+ diagnostics,
904
+ rawEnv,
905
+ "experimental_services",
906
+ `The "experimental_services" field is no longer supported. Simply rename the [experimental_services] field to [services].`,
907
+ true
908
+ );
909
+
910
+ experimental(diagnostics, rawEnv, "unsafe");
911
+ experimental(diagnostics, rawEnv, "services");
912
+ experimental(diagnostics, rawEnv, "dispatch_namespaces");
913
+
914
+ const route = normalizeAndValidateRoute(diagnostics, topLevelEnv, rawEnv);
915
+
916
+ const account_id = inheritableInLegacyEnvironments(
917
+ diagnostics,
918
+ isLegacyEnv,
919
+ topLevelEnv,
920
+ mutateEmptyStringAccountIDValue(diagnostics, rawEnv),
921
+ "account_id",
922
+ isString,
923
+ undefined,
924
+ undefined
925
+ );
926
+
927
+ const routes = validateRoutes(diagnostics, topLevelEnv, rawEnv);
928
+
929
+ const workers_dev = inheritable(
930
+ diagnostics,
931
+ topLevelEnv,
932
+ rawEnv,
933
+ "workers_dev",
934
+ isBoolean,
935
+ undefined
936
+ );
937
+
938
+ const { deprecatedUpload, ...build } = normalizeAndValidateBuild(
939
+ diagnostics,
940
+ rawEnv,
941
+ rawEnv.build ?? topLevelEnv?.build ?? {},
942
+ configPath
943
+ );
944
+
945
+ const environment: Environment = {
946
+ // Inherited fields
947
+ account_id,
948
+ compatibility_date: inheritable(
949
+ diagnostics,
950
+ topLevelEnv,
951
+ rawEnv,
952
+ "compatibility_date",
953
+ isString,
954
+ undefined
955
+ ),
956
+ compatibility_flags: inheritable(
957
+ diagnostics,
958
+ topLevelEnv,
959
+ rawEnv,
960
+ "compatibility_flags",
961
+ isStringArray,
962
+ []
963
+ ),
964
+ jsx_factory: inheritable(
965
+ diagnostics,
966
+ topLevelEnv,
967
+ rawEnv,
968
+ "jsx_factory",
969
+ isString,
970
+ "React.createElement"
971
+ ),
972
+ jsx_fragment: inheritable(
973
+ diagnostics,
974
+ topLevelEnv,
975
+ rawEnv,
976
+ "jsx_fragment",
977
+ isString,
978
+ "React.Fragment"
979
+ ),
980
+ tsconfig: validateAndNormalizeTsconfig(
981
+ diagnostics,
982
+ topLevelEnv,
983
+ rawEnv,
984
+ configPath
985
+ ),
986
+ rules: validateAndNormalizeRules(
987
+ diagnostics,
988
+ topLevelEnv,
989
+ rawEnv,
990
+ deprecatedUpload?.rules,
991
+ envName
992
+ ),
993
+ name: inheritableInLegacyEnvironments(
994
+ diagnostics,
995
+ isLegacyEnv,
996
+ topLevelEnv,
997
+ rawEnv,
998
+ "name",
999
+ isValidName,
1000
+ appendEnvName(envName),
1001
+ undefined
1002
+ ),
1003
+ main: normalizeAndValidateMainField(
1004
+ configPath,
1005
+ inheritable(
1006
+ diagnostics,
1007
+ topLevelEnv,
1008
+ rawEnv,
1009
+ "main",
1010
+ isString,
1011
+ undefined
1012
+ ),
1013
+ deprecatedUpload
1014
+ ),
1015
+ route,
1016
+ routes,
1017
+ triggers: inheritable(
1018
+ diagnostics,
1019
+ topLevelEnv,
1020
+ rawEnv,
1021
+ "triggers",
1022
+ isObjectWith("crons"),
1023
+ { crons: [] }
1024
+ ),
1025
+ usage_model: inheritable(
1026
+ diagnostics,
1027
+ topLevelEnv,
1028
+ rawEnv,
1029
+ "usage_model",
1030
+ isOneOf("bundled", "unbound"),
1031
+ undefined
1032
+ ),
1033
+ build,
1034
+ workers_dev,
1035
+ // Not inherited fields
1036
+ vars: notInheritable(
1037
+ diagnostics,
1038
+ topLevelEnv,
1039
+ rawConfig,
1040
+ rawEnv,
1041
+ envName,
1042
+ "vars",
1043
+ validateVars(envName),
1044
+ {}
1045
+ ),
1046
+ define: notInheritable(
1047
+ diagnostics,
1048
+ topLevelEnv,
1049
+ rawConfig,
1050
+ rawEnv,
1051
+ envName,
1052
+ "define",
1053
+ validateDefines(envName),
1054
+ {}
1055
+ ),
1056
+ durable_objects: notInheritable(
1057
+ diagnostics,
1058
+ topLevelEnv,
1059
+ rawConfig,
1060
+ rawEnv,
1061
+ envName,
1062
+ "durable_objects",
1063
+ validateBindingsProperty(envName, validateDurableObjectBinding),
1064
+ {
1065
+ bindings: [],
1066
+ }
1067
+ ),
1068
+ kv_namespaces: notInheritable(
1069
+ diagnostics,
1070
+ topLevelEnv,
1071
+ rawConfig,
1072
+ rawEnv,
1073
+ envName,
1074
+ "kv_namespaces",
1075
+ validateBindingArray(envName, validateKVBinding),
1076
+ []
1077
+ ),
1078
+ queues: notInheritable(
1079
+ diagnostics,
1080
+ topLevelEnv,
1081
+ rawConfig,
1082
+ rawEnv,
1083
+ envName,
1084
+ "queues",
1085
+ validateQueues(envName),
1086
+ { producers: [], consumers: [] }
1087
+ ),
1088
+ r2_buckets: notInheritable(
1089
+ diagnostics,
1090
+ topLevelEnv,
1091
+ rawConfig,
1092
+ rawEnv,
1093
+ envName,
1094
+ "r2_buckets",
1095
+ validateBindingArray(envName, validateR2Binding),
1096
+ []
1097
+ ),
1098
+ d1_databases: notInheritable(
1099
+ diagnostics,
1100
+ topLevelEnv,
1101
+ rawConfig,
1102
+ rawEnv,
1103
+ envName,
1104
+ "d1_databases",
1105
+ validateBindingArray(envName, validateD1Binding),
1106
+ []
1107
+ ),
1108
+ services: notInheritable(
1109
+ diagnostics,
1110
+ topLevelEnv,
1111
+ rawConfig,
1112
+ rawEnv,
1113
+ envName,
1114
+ "services",
1115
+ validateBindingArray(envName, validateServiceBinding),
1116
+ []
1117
+ ),
1118
+ dispatch_namespaces: notInheritable(
1119
+ diagnostics,
1120
+ topLevelEnv,
1121
+ rawConfig,
1122
+ rawEnv,
1123
+ envName,
1124
+ "dispatch_namespaces",
1125
+ validateBindingArray(envName, validateWorkerNamespaceBinding),
1126
+ []
1127
+ ),
1128
+ logfwdr: inheritable(
1129
+ diagnostics,
1130
+ topLevelEnv,
1131
+ rawEnv,
1132
+ "logfwdr",
1133
+ validateBindingsProperty(envName, validateCflogfwdrBinding),
1134
+ {
1135
+ schema: undefined,
1136
+ bindings: [],
1137
+ }
1138
+ ),
1139
+ unsafe: notInheritable(
1140
+ diagnostics,
1141
+ topLevelEnv,
1142
+ rawConfig,
1143
+ rawEnv,
1144
+ envName,
1145
+ "unsafe",
1146
+ validateBindingsProperty(envName, validateUnsafeBinding),
1147
+ {
1148
+ bindings: [],
1149
+ }
1150
+ ),
1151
+ zone_id: rawEnv.zone_id,
1152
+ no_bundle: inheritable(
1153
+ diagnostics,
1154
+ topLevelEnv,
1155
+ rawEnv,
1156
+ "no_bundle",
1157
+ isBoolean,
1158
+ undefined
1159
+ ),
1160
+ minify: inheritable(
1161
+ diagnostics,
1162
+ topLevelEnv,
1163
+ rawEnv,
1164
+ "minify",
1165
+ isBoolean,
1166
+ undefined
1167
+ ),
1168
+ node_compat: inheritable(
1169
+ diagnostics,
1170
+ topLevelEnv,
1171
+ rawEnv,
1172
+ "node_compat",
1173
+ isBoolean,
1174
+ undefined
1175
+ ),
1176
+ first_party_worker: inheritable(
1177
+ diagnostics,
1178
+ topLevelEnv,
1179
+ rawEnv,
1180
+ "first_party_worker",
1181
+ isBoolean,
1182
+ undefined
1183
+ ),
1184
+ logpush: inheritable(
1185
+ diagnostics,
1186
+ topLevelEnv,
1187
+ rawEnv,
1188
+ "logpush",
1189
+ isBoolean,
1190
+ undefined
1191
+ ),
1192
+ };
1193
+
1194
+ return environment;
901
1195
  }
902
1196
 
903
1197
  function validateAndNormalizeTsconfig(
904
- diagnostics: Diagnostics,
905
- topLevelEnv: Environment | undefined,
906
- rawEnv: RawEnvironment,
907
- configPath: string | undefined
1198
+ diagnostics: Diagnostics,
1199
+ topLevelEnv: Environment | undefined,
1200
+ rawEnv: RawEnvironment,
1201
+ configPath: string | undefined
908
1202
  ) {
909
- const tsconfig = inheritable(
910
- diagnostics,
911
- topLevelEnv,
912
- rawEnv,
913
- "tsconfig",
914
- isString,
915
- undefined
916
- );
917
-
918
- return configPath && tsconfig
919
- ? path.relative(
920
- process.cwd(),
921
- path.join(path.dirname(configPath), tsconfig)
922
- )
923
- : tsconfig;
1203
+ const tsconfig = inheritable(
1204
+ diagnostics,
1205
+ topLevelEnv,
1206
+ rawEnv,
1207
+ "tsconfig",
1208
+ isString,
1209
+ undefined
1210
+ );
1211
+
1212
+ return configPath && tsconfig
1213
+ ? path.relative(
1214
+ process.cwd(),
1215
+ path.join(path.dirname(configPath), tsconfig)
1216
+ )
1217
+ : tsconfig;
924
1218
  }
925
1219
 
926
1220
  const validateAndNormalizeRules = (
927
- diagnostics: Diagnostics,
928
- topLevelEnv: Environment | undefined,
929
- rawEnv: RawEnvironment,
930
- deprecatedRules: Rule[] | undefined,
931
- envName: string
1221
+ diagnostics: Diagnostics,
1222
+ topLevelEnv: Environment | undefined,
1223
+ rawEnv: RawEnvironment,
1224
+ deprecatedRules: Rule[] | undefined,
1225
+ envName: string
932
1226
  ): Rule[] => {
933
- if (topLevelEnv === undefined) {
934
- // Only create errors/warnings for the top-level environment
935
- if (rawEnv.rules && deprecatedRules) {
936
- diagnostics.errors.push(
937
- `You cannot configure both [rules] and [build.upload.rules] in your wrangler.toml. Delete the \`build.upload\` section.`
938
- );
939
- } else if (deprecatedRules) {
940
- diagnostics.warnings.push(
941
- `Deprecation: The \`build.upload.rules\` config field is no longer used, the rules should be specified via the \`rules\` config field. Delete the \`build.upload\` field from the configuration file, and add this:\n` +
942
- "```\n" +
943
- TOML.stringify({ rules: deprecatedRules }) +
944
- "```"
945
- );
946
- }
947
- }
948
-
949
- return inheritable(
950
- diagnostics,
951
- topLevelEnv,
952
- rawEnv,
953
- "rules",
954
- validateRules(envName),
955
- deprecatedRules ?? []
956
- );
1227
+ if (topLevelEnv === undefined) {
1228
+ // Only create errors/warnings for the top-level environment
1229
+ if (rawEnv.rules && deprecatedRules) {
1230
+ diagnostics.errors.push(
1231
+ `You cannot configure both [rules] and [build.upload.rules] in your wrangler.toml. Delete the \`build.upload\` section.`
1232
+ );
1233
+ } else if (deprecatedRules) {
1234
+ diagnostics.warnings.push(
1235
+ `Deprecation: The \`build.upload.rules\` config field is no longer used, the rules should be specified via the \`rules\` config field. Delete the \`build.upload\` field from the configuration file, and add this:\n` +
1236
+ "```\n" +
1237
+ TOML.stringify({ rules: deprecatedRules }) +
1238
+ "```"
1239
+ );
1240
+ }
1241
+ }
1242
+
1243
+ return inheritable(
1244
+ diagnostics,
1245
+ topLevelEnv,
1246
+ rawEnv,
1247
+ "rules",
1248
+ validateRules(envName),
1249
+ deprecatedRules ?? []
1250
+ );
957
1251
  };
958
1252
 
959
1253
  const validateRules =
960
- (envName: string): ValidatorFn =>
961
- (diagnostics, field, envValue, config) => {
962
- if (!envValue) {
963
- return true;
964
- }
965
- const fieldPath =
966
- config === undefined ? `${field}` : `env.${envName}.${field}`;
967
- if (!Array.isArray(envValue)) {
968
- diagnostics.errors.push(
969
- `The field "${fieldPath}" should be an array but got ${JSON.stringify(
970
- envValue
971
- )}.`
972
- );
973
- return false;
974
- }
975
-
976
- let isValid = true;
977
- for (let i = 0; i < envValue.length; i++) {
978
- isValid =
979
- validateRule(diagnostics, `${fieldPath}[${i}]`, envValue[i], config) &&
980
- isValid;
981
- }
982
- return isValid;
983
- };
1254
+ (envName: string): ValidatorFn =>
1255
+ (diagnostics, field, envValue, config) => {
1256
+ if (!envValue) {
1257
+ return true;
1258
+ }
1259
+ const fieldPath =
1260
+ config === undefined ? `${field}` : `env.${envName}.${field}`;
1261
+ if (!Array.isArray(envValue)) {
1262
+ diagnostics.errors.push(
1263
+ `The field "${fieldPath}" should be an array but got ${JSON.stringify(
1264
+ envValue
1265
+ )}.`
1266
+ );
1267
+ return false;
1268
+ }
1269
+
1270
+ let isValid = true;
1271
+ for (let i = 0; i < envValue.length; i++) {
1272
+ isValid =
1273
+ validateRule(diagnostics, `${fieldPath}[${i}]`, envValue[i], config) &&
1274
+ isValid;
1275
+ }
1276
+ return isValid;
1277
+ };
984
1278
 
985
1279
  const validateRule: ValidatorFn = (diagnostics, field, value) => {
986
- if (typeof value !== "object" || value === null) {
987
- diagnostics.errors.push(
988
- `"${field}" should be an object but got ${JSON.stringify(value)}.`
989
- );
990
- return false;
991
- }
992
- // Rules must have a type string and glob string array, and optionally a fallthrough boolean.
993
- let isValid = true;
994
- const rule = value as Rule;
995
-
996
- if (
997
- !isRequiredProperty(rule, "type", "string", [
998
- "ESModule",
999
- "CommonJS",
1000
- "CompiledWasm",
1001
- "Text",
1002
- "Data",
1003
- ])
1004
- ) {
1005
- diagnostics.errors.push(
1006
- `bindings should have a string "type" field, which contains one of "ESModule", "CommonJS", "CompiledWasm", "Text", or "Data".`
1007
- );
1008
- isValid = false;
1009
- }
1010
-
1011
- isValid =
1012
- validateTypedArray(diagnostics, `${field}.globs`, rule.globs, "string") &&
1013
- isValid;
1014
-
1015
- if (!isOptionalProperty(rule, "fallthrough", "boolean")) {
1016
- diagnostics.errors.push(
1017
- `binding should, optionally, have a boolean "fallthrough" field.`
1018
- );
1019
- isValid = false;
1020
- }
1021
-
1022
- return isValid;
1280
+ if (typeof value !== "object" || value === null) {
1281
+ diagnostics.errors.push(
1282
+ `"${field}" should be an object but got ${JSON.stringify(value)}.`
1283
+ );
1284
+ return false;
1285
+ }
1286
+ // Rules must have a type string and glob string array, and optionally a fallthrough boolean.
1287
+ let isValid = true;
1288
+ const rule = value as Rule;
1289
+
1290
+ if (
1291
+ !isRequiredProperty(rule, "type", "string", [
1292
+ "ESModule",
1293
+ "CommonJS",
1294
+ "CompiledWasm",
1295
+ "Text",
1296
+ "Data",
1297
+ ])
1298
+ ) {
1299
+ diagnostics.errors.push(
1300
+ `bindings should have a string "type" field, which contains one of "ESModule", "CommonJS", "CompiledWasm", "Text", or "Data".`
1301
+ );
1302
+ isValid = false;
1303
+ }
1304
+
1305
+ isValid =
1306
+ validateTypedArray(diagnostics, `${field}.globs`, rule.globs, "string") &&
1307
+ isValid;
1308
+
1309
+ if (!isOptionalProperty(rule, "fallthrough", "boolean")) {
1310
+ diagnostics.errors.push(
1311
+ `the field "fallthrough", when present, should be a boolean.`
1312
+ );
1313
+ isValid = false;
1314
+ }
1315
+
1316
+ return isValid;
1023
1317
  };
1024
1318
 
1319
+ const validateDefines =
1320
+ (envName: string): ValidatorFn =>
1321
+ (diagnostics, field, value, config) => {
1322
+ let isValid = true;
1323
+ const fieldPath =
1324
+ config === undefined ? `${field}` : `env.${envName}.${field}`;
1325
+
1326
+ if (typeof value === "object" && value !== null) {
1327
+ for (const varName in value) {
1328
+ // some casting here to appease typescript
1329
+ // even though the value might not match the type
1330
+ if (typeof (value as Record<string, string>)[varName] !== "string") {
1331
+ diagnostics.errors.push(
1332
+ `The field "${fieldPath}.${varName}" should be a string but got ${JSON.stringify(
1333
+ (value as Record<string, string>)[varName]
1334
+ )}.`
1335
+ );
1336
+ isValid = false;
1337
+ }
1338
+ }
1339
+ } else {
1340
+ if (value !== undefined) {
1341
+ diagnostics.errors.push(
1342
+ `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1343
+ value
1344
+ )}.\n`
1345
+ );
1346
+ isValid = false;
1347
+ }
1348
+ }
1349
+
1350
+ const configDefines = Object.keys(config?.define ?? {});
1351
+
1352
+ // If there are no top level vars then there is nothing to do here.
1353
+ if (configDefines.length > 0) {
1354
+ if (typeof value === "object" && value !== null) {
1355
+ const configEnvDefines = config === undefined ? [] : Object.keys(value);
1356
+
1357
+ for (const varName of configDefines) {
1358
+ if (!(varName in value)) {
1359
+ diagnostics.warnings.push(
1360
+ `"define.${varName}" exists at the top level, but not on "${fieldPath}".\n` +
1361
+ `This is not what you probably want, since "define" configuration is not inherited by environments.\n` +
1362
+ `Please add "define.${varName}" to "env.${envName}".`
1363
+ );
1364
+ }
1365
+ }
1366
+ for (const varName of configEnvDefines) {
1367
+ if (!configDefines.includes(varName)) {
1368
+ diagnostics.warnings.push(
1369
+ `"${varName}" exists on "env.${envName}", but not on the top level.\n` +
1370
+ `This is not what you probably want, since "define" configuration within environments can only override existing top level "define" configuration\n` +
1371
+ `Please remove "${fieldPath}.${varName}", or add "define.${varName}".`
1372
+ );
1373
+ }
1374
+ }
1375
+ }
1376
+ }
1377
+
1378
+ return isValid;
1379
+ };
1380
+
1025
1381
  const validateVars =
1026
- (envName: string): ValidatorFn =>
1027
- (diagnostics, field, value, config) => {
1028
- let isValid = true;
1029
- const fieldPath =
1030
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1031
- const configVars = Object.keys(config?.vars ?? {});
1032
- // If there are no top level vars then there is nothing to do here.
1033
- if (configVars.length > 0) {
1034
- if (typeof value !== "object" || value === null) {
1035
- diagnostics.errors.push(
1036
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1037
- value
1038
- )}.\n`
1039
- );
1040
- isValid = false;
1041
- } else {
1042
- for (const varName of configVars) {
1043
- if (!(varName in value)) {
1044
- diagnostics.warnings.push(
1045
- `"vars.${varName}" exists at the top level, but not on "${fieldPath}".\n` +
1046
- `This is not what you probably want, since "vars" configuration is not inherited by environments.\n` +
1047
- `Please add "vars.${varName}" to "env.${envName}".`
1048
- );
1049
- }
1050
- }
1051
- }
1052
- }
1053
- return isValid;
1054
- };
1382
+ (envName: string): ValidatorFn =>
1383
+ (diagnostics, field, value, config) => {
1384
+ let isValid = true;
1385
+ const fieldPath =
1386
+ config === undefined ? `${field}` : `env.${envName}.${field}`;
1387
+ const configVars = Object.keys(config?.vars ?? {});
1388
+ // If there are no top level vars then there is nothing to do here.
1389
+ if (configVars.length > 0) {
1390
+ if (typeof value !== "object" || value === null) {
1391
+ diagnostics.errors.push(
1392
+ `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1393
+ value
1394
+ )}.\n`
1395
+ );
1396
+ isValid = false;
1397
+ } else {
1398
+ for (const varName of configVars) {
1399
+ if (!(varName in value)) {
1400
+ diagnostics.warnings.push(
1401
+ `"vars.${varName}" exists at the top level, but not on "${fieldPath}".\n` +
1402
+ `This is not what you probably want, since "vars" configuration is not inherited by environments.\n` +
1403
+ `Please add "vars.${varName}" to "env.${envName}".`
1404
+ );
1405
+ }
1406
+ }
1407
+ }
1408
+ }
1409
+ return isValid;
1410
+ };
1055
1411
 
1056
1412
  const validateBindingsProperty =
1057
- (envName: string, validateBinding: ValidatorFn): ValidatorFn =>
1058
- (diagnostics, field, value, config) => {
1059
- let isValid = true;
1060
- const fieldPath =
1061
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1062
-
1063
- if (value !== undefined) {
1064
- // Check the validity of the `value` as a bindings container.
1065
- if (typeof value !== "object" || value === null || Array.isArray(value)) {
1066
- diagnostics.errors.push(
1067
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1068
- value
1069
- )}.`
1070
- );
1071
- isValid = false;
1072
- } else if (!hasProperty(value, "bindings")) {
1073
- diagnostics.errors.push(
1074
- `The field "${fieldPath}" is missing the required "bindings" property.`
1075
- );
1076
- isValid = false;
1077
- } else if (!Array.isArray(value.bindings)) {
1078
- diagnostics.errors.push(
1079
- `The field "${fieldPath}.bindings" should be an array but got ${JSON.stringify(
1080
- value.bindings
1081
- )}.`
1082
- );
1083
- isValid = false;
1084
- } else {
1085
- for (let i = 0; i < value.bindings.length; i++) {
1086
- const binding = value.bindings[i];
1087
- const bindingDiagnostics = new Diagnostics(
1088
- `"${fieldPath}.bindings[${i}]": ${JSON.stringify(binding)}`
1089
- );
1090
- isValid =
1091
- validateBinding(
1092
- bindingDiagnostics,
1093
- `${fieldPath}.bindings[${i}]`,
1094
- binding,
1095
- config
1096
- ) && isValid;
1097
- diagnostics.addChild(bindingDiagnostics);
1098
- }
1099
- }
1100
-
1101
- const configBindingNames = getBindingNames(
1102
- config?.[field as keyof Environment]
1103
- );
1104
- if (isValid && configBindingNames.length > 0) {
1105
- // If there are top level bindings then check that they all appear in the environment.
1106
- const envBindingNames = new Set(getBindingNames(value));
1107
- const missingBindings = configBindingNames.filter(
1108
- (name) => !envBindingNames.has(name)
1109
- );
1110
- if (missingBindings.length > 0) {
1111
- diagnostics.warnings.push(
1112
- `The following bindings are at the top level, but not on "env.${envName}".\n` +
1113
- `This is not what you probably want, since "${field}" configuration is not inherited by environments.\n` +
1114
- `Please add a binding for each to "${fieldPath}.bindings":\n` +
1115
- missingBindings.map((name) => `- ${name}`).join("\n")
1116
- );
1117
- }
1118
- }
1119
- }
1120
- return isValid;
1121
- };
1413
+ (envName: string, validateBinding: ValidatorFn): ValidatorFn =>
1414
+ (diagnostics, field, value, config) => {
1415
+ let isValid = true;
1416
+ const fieldPath =
1417
+ config === undefined ? `${field}` : `env.${envName}.${field}`;
1418
+
1419
+ if (value !== undefined) {
1420
+ // Check the validity of the `value` as a bindings container.
1421
+ if (typeof value !== "object" || value === null || Array.isArray(value)) {
1422
+ diagnostics.errors.push(
1423
+ `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1424
+ value
1425
+ )}.`
1426
+ );
1427
+ isValid = false;
1428
+ } else if (!hasProperty(value, "bindings")) {
1429
+ diagnostics.errors.push(
1430
+ `The field "${fieldPath}" is missing the required "bindings" property.`
1431
+ );
1432
+ isValid = false;
1433
+ } else if (!Array.isArray(value.bindings)) {
1434
+ diagnostics.errors.push(
1435
+ `The field "${fieldPath}.bindings" should be an array but got ${JSON.stringify(
1436
+ value.bindings
1437
+ )}.`
1438
+ );
1439
+ isValid = false;
1440
+ } else {
1441
+ for (let i = 0; i < value.bindings.length; i++) {
1442
+ const binding = value.bindings[i];
1443
+ const bindingDiagnostics = new Diagnostics(
1444
+ `"${fieldPath}.bindings[${i}]": ${JSON.stringify(binding)}`
1445
+ );
1446
+ isValid =
1447
+ validateBinding(
1448
+ bindingDiagnostics,
1449
+ `${fieldPath}.bindings[${i}]`,
1450
+ binding,
1451
+ config
1452
+ ) && isValid;
1453
+ diagnostics.addChild(bindingDiagnostics);
1454
+ }
1455
+ }
1456
+
1457
+ const configBindingNames = getBindingNames(
1458
+ config?.[field as keyof Environment]
1459
+ );
1460
+ if (isValid && configBindingNames.length > 0) {
1461
+ // If there are top level bindings then check that they all appear in the environment.
1462
+ const envBindingNames = new Set(getBindingNames(value));
1463
+ const missingBindings = configBindingNames.filter(
1464
+ (name) => !envBindingNames.has(name)
1465
+ );
1466
+ if (missingBindings.length > 0) {
1467
+ diagnostics.warnings.push(
1468
+ `The following bindings are at the top level, but not on "env.${envName}".\n` +
1469
+ `This is not what you probably want, since "${field}" configuration is not inherited by environments.\n` +
1470
+ `Please add a binding for each to "${fieldPath}.bindings":\n` +
1471
+ missingBindings.map((name) => `- ${name}`).join("\n")
1472
+ );
1473
+ }
1474
+ }
1475
+ }
1476
+ return isValid;
1477
+ };
1122
1478
 
1123
1479
  /**
1124
1480
  * Check that the given field is a valid "durable_object" binding object.
1125
1481
  */
1126
1482
  const validateDurableObjectBinding: ValidatorFn = (
1127
- diagnostics,
1128
- field,
1129
- value
1483
+ diagnostics,
1484
+ field,
1485
+ value
1130
1486
  ) => {
1131
- if (typeof value !== "object" || value === null) {
1132
- diagnostics.errors.push(
1133
- `Expected "${field}" to be an object but got ${JSON.stringify(value)}`
1134
- );
1135
- return false;
1136
- }
1137
-
1138
- // Durable Object bindings must have a name and class_name, and optionally a script_name.
1139
- let isValid = true;
1140
- if (!isRequiredProperty(value, "name", "string")) {
1141
- diagnostics.errors.push(`binding should have a string "name" field.`);
1142
- isValid = false;
1143
- }
1144
- if (!isRequiredProperty(value, "class_name", "string")) {
1145
- diagnostics.errors.push(`binding should have a string "class_name" field.`);
1146
- isValid = false;
1147
- }
1148
- if (!isOptionalProperty(value, "script_name", "string")) {
1149
- diagnostics.errors.push(
1150
- `binding should, optionally, have a string "script_name" field.`
1151
- );
1152
- isValid = false;
1153
- }
1154
-
1155
- return isValid;
1487
+ if (typeof value !== "object" || value === null) {
1488
+ diagnostics.errors.push(
1489
+ `Expected "${field}" to be an object but got ${JSON.stringify(value)}`
1490
+ );
1491
+ return false;
1492
+ }
1493
+
1494
+ // Durable Object bindings must have a name and class_name, and optionally a script_name and an environment.
1495
+ let isValid = true;
1496
+ if (!isRequiredProperty(value, "name", "string")) {
1497
+ diagnostics.errors.push(`binding should have a string "name" field.`);
1498
+ isValid = false;
1499
+ }
1500
+ if (!isRequiredProperty(value, "class_name", "string")) {
1501
+ diagnostics.errors.push(`binding should have a string "class_name" field.`);
1502
+ isValid = false;
1503
+ }
1504
+ if (!isOptionalProperty(value, "script_name", "string")) {
1505
+ diagnostics.errors.push(
1506
+ `the field "script_name", when present, should be a string.`
1507
+ );
1508
+ isValid = false;
1509
+ }
1510
+ // environment requires a script_name
1511
+ if (!isOptionalProperty(value, "environment", "string")) {
1512
+ diagnostics.errors.push(
1513
+ `the field "environment", when present, should be a string.`
1514
+ );
1515
+ isValid = false;
1516
+ }
1517
+
1518
+ if ("environment" in value && !("script_name" in value)) {
1519
+ diagnostics.errors.push(
1520
+ `binding should have a "script_name" field if "environment" is present.`
1521
+ );
1522
+ isValid = false;
1523
+ }
1524
+
1525
+ return isValid;
1526
+ };
1527
+
1528
+ const validateCflogfwdrBinding: ValidatorFn = (diagnostics, field, value) => {
1529
+ if (typeof value !== "object" || value === null) {
1530
+ diagnostics.errors.push(
1531
+ `Expected "${field}" to be an object but got ${JSON.stringify(value)}`
1532
+ );
1533
+ return false;
1534
+ }
1535
+
1536
+ let isValid = true;
1537
+ if (!isRequiredProperty(value, "name", "string")) {
1538
+ diagnostics.errors.push(`binding should have a string "name" field.`);
1539
+ isValid = false;
1540
+ }
1541
+
1542
+ if (!isRequiredProperty(value, "destination", "string")) {
1543
+ diagnostics.errors.push(
1544
+ `binding should have a string "destination" field.`
1545
+ );
1546
+ isValid = false;
1547
+ }
1548
+
1549
+ return isValid;
1156
1550
  };
1157
1551
 
1158
1552
  /**
@@ -1161,168 +1555,269 @@ const validateDurableObjectBinding: ValidatorFn = (
1161
1555
  * TODO: further validation of known unsafe bindings.
1162
1556
  */
1163
1557
  const validateUnsafeBinding: ValidatorFn = (diagnostics, field, value) => {
1164
- if (typeof value !== "object" || value === null) {
1165
- diagnostics.errors.push(
1166
- `Expected ${field} to be an object but got ${JSON.stringify(value)}.`
1167
- );
1168
- return false;
1169
- }
1170
-
1171
- let isValid = true;
1172
- // Unsafe bindings must have a name and type.
1173
- if (!isRequiredProperty(value, "name", "string")) {
1174
- diagnostics.errors.push(`binding should have a string "name" field.`);
1175
- isValid = false;
1176
- }
1177
- if (isRequiredProperty(value, "type", "string")) {
1178
- const safeBindings = [
1179
- "plain_text",
1180
- "json",
1181
- "kv_namespace",
1182
- "durable_object_namespace",
1183
- ];
1184
-
1185
- if (safeBindings.includes(value.type)) {
1186
- diagnostics.warnings.push(
1187
- `The binding type "${value.type}" is directly supported by wrangler.\n` +
1188
- `Consider migrating this unsafe binding to a format for '${value.type}' bindings that is supported by wrangler for optimal support.\n` +
1189
- "For more details, see https://developers.cloudflare.com/workers/cli-wrangler/configuration"
1190
- );
1191
- }
1192
- } else {
1193
- diagnostics.errors.push(`binding should have a string "type" field.`);
1194
- isValid = false;
1195
- }
1196
- return isValid;
1558
+ if (typeof value !== "object" || value === null) {
1559
+ diagnostics.errors.push(
1560
+ `Expected ${field} to be an object but got ${JSON.stringify(value)}.`
1561
+ );
1562
+ return false;
1563
+ }
1564
+
1565
+ let isValid = true;
1566
+ // Unsafe bindings must have a name and type.
1567
+ if (!isRequiredProperty(value, "name", "string")) {
1568
+ diagnostics.errors.push(`binding should have a string "name" field.`);
1569
+ isValid = false;
1570
+ }
1571
+ if (isRequiredProperty(value, "type", "string")) {
1572
+ const safeBindings = [
1573
+ "plain_text",
1574
+ "json",
1575
+ "wasm_module",
1576
+ "data_blob",
1577
+ "text_blob",
1578
+ "kv_namespace",
1579
+ "durable_object_namespace",
1580
+ "d1_database",
1581
+ "r2_bucket",
1582
+ "service",
1583
+ "logfwdr",
1584
+ ];
1585
+
1586
+ if (safeBindings.includes(value.type)) {
1587
+ diagnostics.warnings.push(
1588
+ `The binding type "${value.type}" is directly supported by wrangler.\n` +
1589
+ `Consider migrating this unsafe binding to a format for '${value.type}' bindings that is supported by wrangler for optimal support.\n` +
1590
+ "For more details, see https://developers.cloudflare.com/workers/cli-wrangler/configuration"
1591
+ );
1592
+ }
1593
+ } else {
1594
+ diagnostics.errors.push(`binding should have a string "type" field.`);
1595
+ isValid = false;
1596
+ }
1597
+ return isValid;
1197
1598
  };
1198
1599
 
1199
1600
  /**
1200
1601
  * Check that the given environment field is a valid array of bindings.
1201
1602
  */
1202
1603
  const validateBindingArray =
1203
- (envName: string, validateBinding: ValidatorFn): ValidatorFn =>
1204
- (diagnostics, field, envValue, config) => {
1205
- if (envValue === undefined) {
1206
- return true;
1207
- }
1208
-
1209
- const fieldPath =
1210
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1211
- if (!Array.isArray(envValue)) {
1212
- diagnostics.errors.push(
1213
- `The field "${fieldPath}" should be an array but got ${JSON.stringify(
1214
- envValue
1215
- )}.`
1216
- );
1217
- return false;
1218
- }
1219
-
1220
- let isValid = true;
1221
- for (let i = 0; i < envValue.length; i++) {
1222
- isValid =
1223
- validateBinding(
1224
- diagnostics,
1225
- `${fieldPath}[${i}]`,
1226
- envValue[i],
1227
- config
1228
- ) && isValid;
1229
- }
1230
- const configValue = config?.[field as keyof Environment] as {
1231
- binding: unknown;
1232
- }[];
1233
- if (Array.isArray(configValue)) {
1234
- const configBindingNames = configValue.map((value) => value.binding);
1235
- // If there are no top level bindings then there is nothing to do here.
1236
- if (configBindingNames.length > 0) {
1237
- const envBindingNames = new Set(envValue.map((value) => value.binding));
1238
- for (const configBindingName of configBindingNames) {
1239
- if (!envBindingNames.has(configBindingName)) {
1240
- diagnostics.warnings.push(
1241
- `There is a ${field} binding with name "${configBindingName}" at the top level, but not on "env.${envName}".\n` +
1242
- `This is not what you probably want, since "${field}" configuration is not inherited by environments.\n` +
1243
- `Please add a binding for "${configBindingName}" to "env.${envName}.${field}.bindings".`
1244
- );
1245
- }
1246
- }
1247
- }
1248
- }
1249
- return isValid;
1250
- };
1604
+ (envName: string, validateBinding: ValidatorFn): ValidatorFn =>
1605
+ (diagnostics, field, envValue, config) => {
1606
+ if (envValue === undefined) {
1607
+ return true;
1608
+ }
1609
+
1610
+ const fieldPath =
1611
+ config === undefined ? `${field}` : `env.${envName}.${field}`;
1612
+ if (!Array.isArray(envValue)) {
1613
+ diagnostics.errors.push(
1614
+ `The field "${fieldPath}" should be an array but got ${JSON.stringify(
1615
+ envValue
1616
+ )}.`
1617
+ );
1618
+ return false;
1619
+ }
1620
+
1621
+ let isValid = true;
1622
+ for (let i = 0; i < envValue.length; i++) {
1623
+ isValid =
1624
+ validateBinding(
1625
+ diagnostics,
1626
+ `${fieldPath}[${i}]`,
1627
+ envValue[i],
1628
+ config
1629
+ ) && isValid;
1630
+ }
1631
+ const configValue = config?.[field as keyof Environment] as {
1632
+ binding: unknown;
1633
+ }[];
1634
+ if (Array.isArray(configValue)) {
1635
+ const configBindingNames = configValue.map((value) => value.binding);
1636
+ // If there are no top level bindings then there is nothing to do here.
1637
+ if (configBindingNames.length > 0) {
1638
+ const envBindingNames = new Set(envValue.map((value) => value.binding));
1639
+ for (const configBindingName of configBindingNames) {
1640
+ if (!envBindingNames.has(configBindingName)) {
1641
+ diagnostics.warnings.push(
1642
+ `There is a ${field} binding with name "${configBindingName}" at the top level, but not on "env.${envName}".\n` +
1643
+ `This is not what you probably want, since "${field}" configuration is not inherited by environments.\n` +
1644
+ `Please add a binding for "${configBindingName}" to "env.${envName}.${field}.bindings".`
1645
+ );
1646
+ }
1647
+ }
1648
+ }
1649
+ }
1650
+ return isValid;
1651
+ };
1251
1652
 
1252
1653
  const validateKVBinding: ValidatorFn = (diagnostics, field, value) => {
1253
- if (typeof value !== "object" || value === null) {
1254
- diagnostics.errors.push(
1255
- `"kv_namespaces" bindings should be objects, but got ${JSON.stringify(
1256
- value
1257
- )}`
1258
- );
1259
- return false;
1260
- }
1261
- let isValid = true;
1262
- // KV bindings must have a binding and id.
1263
- if (!isRequiredProperty(value, "binding", "string")) {
1264
- diagnostics.errors.push(
1265
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1266
- value
1267
- )}.`
1268
- );
1269
- isValid = false;
1270
- }
1271
- if (!isRequiredProperty(value, "id", "string")) {
1272
- diagnostics.errors.push(
1273
- `"${field}" bindings should have a string "id" field but got ${JSON.stringify(
1274
- value
1275
- )}.`
1276
- );
1277
- isValid = false;
1278
- }
1279
- if (!isOptionalProperty(value, "preview_id", "string")) {
1280
- diagnostics.errors.push(
1281
- `"${field}" bindings should, optionally, have a string "preview_id" field but got ${JSON.stringify(
1282
- value
1283
- )}.`
1284
- );
1285
- isValid = false;
1286
- }
1287
- return isValid;
1654
+ if (typeof value !== "object" || value === null) {
1655
+ diagnostics.errors.push(
1656
+ `"kv_namespaces" bindings should be objects, but got ${JSON.stringify(
1657
+ value
1658
+ )}`
1659
+ );
1660
+ return false;
1661
+ }
1662
+ let isValid = true;
1663
+ // KV bindings must have a binding and id.
1664
+ if (!isRequiredProperty(value, "binding", "string")) {
1665
+ diagnostics.errors.push(
1666
+ `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1667
+ value
1668
+ )}.`
1669
+ );
1670
+ isValid = false;
1671
+ }
1672
+ if (
1673
+ !isRequiredProperty(value, "id", "string") ||
1674
+ (value as { id: string }).id.length === 0
1675
+ ) {
1676
+ diagnostics.errors.push(
1677
+ `"${field}" bindings should have a string "id" field but got ${JSON.stringify(
1678
+ value
1679
+ )}.`
1680
+ );
1681
+ isValid = false;
1682
+ }
1683
+ if (!isOptionalProperty(value, "preview_id", "string")) {
1684
+ diagnostics.errors.push(
1685
+ `"${field}" bindings should, optionally, have a string "preview_id" field but got ${JSON.stringify(
1686
+ value
1687
+ )}.`
1688
+ );
1689
+ isValid = false;
1690
+ }
1691
+ return isValid;
1692
+ };
1693
+
1694
+ const validateQueueBinding: ValidatorFn = (diagnostics, field, value) => {
1695
+ if (typeof value !== "object" || value === null) {
1696
+ diagnostics.errors.push(
1697
+ `"queue" bindings should be objects, but got ${JSON.stringify(value)}`
1698
+ );
1699
+ return false;
1700
+ }
1701
+
1702
+ if (
1703
+ !validateAdditionalProperties(diagnostics, field, Object.keys(value), [
1704
+ "binding",
1705
+ "queue",
1706
+ ])
1707
+ ) {
1708
+ return false;
1709
+ }
1710
+
1711
+ // Queue bindings must have a binding and queue.
1712
+ let isValid = true;
1713
+ if (!isRequiredProperty(value, "binding", "string")) {
1714
+ diagnostics.errors.push(
1715
+ `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1716
+ value
1717
+ )}.`
1718
+ );
1719
+ isValid = false;
1720
+ }
1721
+ if (
1722
+ !isRequiredProperty(value, "queue", "string") ||
1723
+ (value as { queue: string }).queue.length === 0
1724
+ ) {
1725
+ diagnostics.errors.push(
1726
+ `"${field}" bindings should have a string "queue" field but got ${JSON.stringify(
1727
+ value
1728
+ )}.`
1729
+ );
1730
+ isValid = false;
1731
+ }
1732
+ return isValid;
1288
1733
  };
1289
1734
 
1290
1735
  const validateR2Binding: ValidatorFn = (diagnostics, field, value) => {
1291
- if (typeof value !== "object" || value === null) {
1292
- diagnostics.errors.push(
1293
- `"r2_buckets" bindings should be objects, but got ${JSON.stringify(
1294
- value
1295
- )}`
1296
- );
1297
- return false;
1298
- }
1299
- let isValid = true;
1300
- // R2 bindings must have a binding and bucket_name.
1301
- if (!isRequiredProperty(value, "binding", "string")) {
1302
- diagnostics.errors.push(
1303
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1304
- value
1305
- )}.`
1306
- );
1307
- isValid = false;
1308
- }
1309
- if (!isRequiredProperty(value, "bucket_name", "string")) {
1310
- diagnostics.errors.push(
1311
- `"${field}" bindings should have a string "bucket_name" field but got ${JSON.stringify(
1312
- value
1313
- )}.`
1314
- );
1315
- isValid = false;
1316
- }
1317
- if (!isOptionalProperty(value, "preview_bucket_name", "string")) {
1318
- diagnostics.errors.push(
1319
- `"${field}" bindings should, optionally, have a string "preview_bucket_name" field but got ${JSON.stringify(
1320
- value
1321
- )}.`
1322
- );
1323
- isValid = false;
1324
- }
1325
- return isValid;
1736
+ if (typeof value !== "object" || value === null) {
1737
+ diagnostics.errors.push(
1738
+ `"r2_buckets" bindings should be objects, but got ${JSON.stringify(
1739
+ value
1740
+ )}`
1741
+ );
1742
+ return false;
1743
+ }
1744
+ let isValid = true;
1745
+ // R2 bindings must have a binding and bucket_name.
1746
+ if (!isRequiredProperty(value, "binding", "string")) {
1747
+ diagnostics.errors.push(
1748
+ `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1749
+ value
1750
+ )}.`
1751
+ );
1752
+ isValid = false;
1753
+ }
1754
+ if (
1755
+ !isRequiredProperty(value, "bucket_name", "string") ||
1756
+ (value as { bucket_name: string }).bucket_name.length === 0
1757
+ ) {
1758
+ diagnostics.errors.push(
1759
+ `"${field}" bindings should have a string "bucket_name" field but got ${JSON.stringify(
1760
+ value
1761
+ )}.`
1762
+ );
1763
+ isValid = false;
1764
+ }
1765
+ if (!isOptionalProperty(value, "preview_bucket_name", "string")) {
1766
+ diagnostics.errors.push(
1767
+ `"${field}" bindings should, optionally, have a string "preview_bucket_name" field but got ${JSON.stringify(
1768
+ value
1769
+ )}.`
1770
+ );
1771
+ isValid = false;
1772
+ }
1773
+ return isValid;
1774
+ };
1775
+
1776
+ const validateD1Binding: ValidatorFn = (diagnostics, field, value) => {
1777
+ if (typeof value !== "object" || value === null) {
1778
+ diagnostics.errors.push(
1779
+ `"d1_databases" bindings should be objects, but got ${JSON.stringify(
1780
+ value
1781
+ )}`
1782
+ );
1783
+ return false;
1784
+ }
1785
+ let isValid = true;
1786
+ // D1 databases must have a binding and either a database_name or database_id.
1787
+ if (!isRequiredProperty(value, "binding", "string")) {
1788
+ diagnostics.errors.push(
1789
+ `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1790
+ value
1791
+ )}.`
1792
+ );
1793
+ isValid = false;
1794
+ }
1795
+ if (
1796
+ // TODO: allow name only, where we look up the ID dynamically
1797
+ // !isOptionalProperty(value, "database_name", "string") &&
1798
+ !isRequiredProperty(value, "database_id", "string")
1799
+ ) {
1800
+ diagnostics.errors.push(
1801
+ `"${field}" bindings must have a "database_id" field but got ${JSON.stringify(
1802
+ value
1803
+ )}.`
1804
+ );
1805
+ isValid = false;
1806
+ }
1807
+ if (!isOptionalProperty(value, "preview_database_id", "string")) {
1808
+ diagnostics.errors.push(
1809
+ `"${field}" bindings should, optionally, have a string "preview_database_id" field but got ${JSON.stringify(
1810
+ value
1811
+ )}.`
1812
+ );
1813
+ isValid = false;
1814
+ }
1815
+ if (isValid && !process.env.NO_D1_WARNING) {
1816
+ diagnostics.warnings.push(
1817
+ `D1 Bindings are currently in alpha to allow the API to evolve before general availability.\nPlease report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose\nNote: set NO_D1_WARNING=true to hide this message`
1818
+ );
1819
+ }
1820
+ return isValid;
1326
1821
  };
1327
1822
 
1328
1823
  /**
@@ -1334,91 +1829,275 @@ const validateR2Binding: ValidatorFn = (diagnostics, field, value) => {
1334
1829
  * the `DATA` global).
1335
1830
  */
1336
1831
  const validateBindingsHaveUniqueNames = (
1337
- diagnostics: Diagnostics,
1338
- {
1339
- durable_objects,
1340
- kv_namespaces,
1341
- r2_buckets,
1342
- text_blobs,
1343
- unsafe,
1344
- vars,
1345
- wasm_modules,
1346
- data_blobs,
1347
- }: Partial<Config>
1832
+ diagnostics: Diagnostics,
1833
+ {
1834
+ durable_objects,
1835
+ kv_namespaces,
1836
+ r2_buckets,
1837
+ text_blobs,
1838
+ unsafe,
1839
+ vars,
1840
+ define,
1841
+ wasm_modules,
1842
+ data_blobs,
1843
+ }: Partial<Config>
1348
1844
  ): boolean => {
1349
- let hasDuplicates = false;
1350
-
1351
- const bindingsGroupedByType = {
1352
- "Durable Object": getBindingNames(durable_objects),
1353
- "KV Namespace": getBindingNames(kv_namespaces),
1354
- "R2 Bucket": getBindingNames(r2_buckets),
1355
- "Text Blob": getBindingNames(text_blobs),
1356
- Unsafe: getBindingNames(unsafe),
1357
- "Environment Variable": getBindingNames(vars),
1358
- "WASM Module": getBindingNames(wasm_modules),
1359
- "Data Blob": getBindingNames(data_blobs),
1360
- } as Record<string, string[]>;
1361
-
1362
- const bindingsGroupedByName: Record<string, string[]> = {};
1363
-
1364
- for (const bindingType in bindingsGroupedByType) {
1365
- const bindingNames = bindingsGroupedByType[bindingType];
1366
-
1367
- for (const bindingName of bindingNames) {
1368
- if (!(bindingName in bindingsGroupedByName)) {
1369
- bindingsGroupedByName[bindingName] = [];
1370
- }
1371
-
1372
- bindingsGroupedByName[bindingName].push(bindingType);
1373
- }
1374
- }
1375
-
1376
- for (const bindingName in bindingsGroupedByName) {
1377
- const bindingTypes = bindingsGroupedByName[bindingName];
1378
- if (bindingTypes.length < 2) {
1379
- // there's only one (or zero) binding(s) with this name, which is fine, actually
1380
- continue;
1381
- }
1382
-
1383
- hasDuplicates = true;
1384
-
1385
- // there's two types of duplicates we want to look for:
1386
- // - bindings with the same name of the same type (e.g. two Durable Objects both named "OBJ")
1387
- // - bindings with the same name of different types (a KV namespace and DO both named "DATA")
1388
-
1389
- const sameType = bindingTypes
1390
- // filter once to find duplicate binding types
1391
- .filter((type, i) => bindingTypes.indexOf(type) !== i)
1392
- // filter twice to only get _unique_ duplicate binding types
1393
- .filter(
1394
- (type, i, duplicateBindingTypes) =>
1395
- duplicateBindingTypes.indexOf(type) === i
1396
- );
1397
-
1398
- const differentTypes = bindingTypes.filter(
1399
- (type, i) => bindingTypes.indexOf(type) === i
1400
- );
1401
-
1402
- if (differentTypes.length > 1) {
1403
- // we have multiple different types using the same name
1404
- diagnostics.errors.push(
1405
- `${bindingName} assigned to ${ENGLISH.format(differentTypes)} bindings.`
1406
- );
1407
- }
1408
-
1409
- sameType.forEach((bindingType) => {
1410
- diagnostics.errors.push(
1411
- `${bindingName} assigned to multiple ${bindingType} bindings.`
1412
- );
1413
- });
1414
- }
1415
-
1416
- if (hasDuplicates) {
1417
- const problem =
1418
- "Bindings must have unique names, so that they can all be referenced in the worker.";
1419
- const resolution = "Please change your bindings to have unique names.";
1420
- diagnostics.errors.push(`${problem}\n${resolution}`);
1421
- }
1422
-
1423
- return !hasDuplicates;
1845
+ let hasDuplicates = false;
1846
+
1847
+ const bindingsGroupedByType = {
1848
+ "Durable Object": getBindingNames(durable_objects),
1849
+ "KV Namespace": getBindingNames(kv_namespaces),
1850
+ "R2 Bucket": getBindingNames(r2_buckets),
1851
+ "Text Blob": getBindingNames(text_blobs),
1852
+ Unsafe: getBindingNames(unsafe),
1853
+ "Environment Variable": getBindingNames(vars),
1854
+ Definition: getBindingNames(define),
1855
+ "WASM Module": getBindingNames(wasm_modules),
1856
+ "Data Blob": getBindingNames(data_blobs),
1857
+ } as Record<string, string[]>;
1858
+
1859
+ const bindingsGroupedByName: Record<string, string[]> = {};
1860
+
1861
+ for (const bindingType in bindingsGroupedByType) {
1862
+ const bindingNames = bindingsGroupedByType[bindingType];
1863
+
1864
+ for (const bindingName of bindingNames) {
1865
+ if (!(bindingName in bindingsGroupedByName)) {
1866
+ bindingsGroupedByName[bindingName] = [];
1867
+ }
1868
+
1869
+ bindingsGroupedByName[bindingName].push(bindingType);
1870
+ }
1871
+ }
1872
+
1873
+ for (const bindingName in bindingsGroupedByName) {
1874
+ const bindingTypes = bindingsGroupedByName[bindingName];
1875
+ if (bindingTypes.length < 2) {
1876
+ // there's only one (or zero) binding(s) with this name, which is fine, actually
1877
+ continue;
1878
+ }
1879
+
1880
+ hasDuplicates = true;
1881
+
1882
+ // there's two types of duplicates we want to look for:
1883
+ // - bindings with the same name of the same type (e.g. two Durable Objects both named "OBJ")
1884
+ // - bindings with the same name of different types (a KV namespace and DO both named "DATA")
1885
+
1886
+ const sameType = bindingTypes
1887
+ // filter once to find duplicate binding types
1888
+ .filter((type, i) => bindingTypes.indexOf(type) !== i)
1889
+ // filter twice to only get _unique_ duplicate binding types
1890
+ .filter(
1891
+ (type, i, duplicateBindingTypes) =>
1892
+ duplicateBindingTypes.indexOf(type) === i
1893
+ );
1894
+
1895
+ const differentTypes = bindingTypes.filter(
1896
+ (type, i) => bindingTypes.indexOf(type) === i
1897
+ );
1898
+
1899
+ if (differentTypes.length > 1) {
1900
+ // we have multiple different types using the same name
1901
+ diagnostics.errors.push(
1902
+ `${bindingName} assigned to ${ENGLISH.format(differentTypes)} bindings.`
1903
+ );
1904
+ }
1905
+
1906
+ sameType.forEach((bindingType) => {
1907
+ diagnostics.errors.push(
1908
+ `${bindingName} assigned to multiple ${bindingType} bindings.`
1909
+ );
1910
+ });
1911
+ }
1912
+
1913
+ if (hasDuplicates) {
1914
+ const problem =
1915
+ "Bindings must have unique names, so that they can all be referenced in the worker.";
1916
+ const resolution = "Please change your bindings to have unique names.";
1917
+ diagnostics.errors.push(`${problem}\n${resolution}`);
1918
+ }
1919
+
1920
+ return !hasDuplicates;
1921
+ };
1922
+
1923
+ const validateServiceBinding: ValidatorFn = (diagnostics, field, value) => {
1924
+ if (typeof value !== "object" || value === null) {
1925
+ diagnostics.errors.push(
1926
+ `"services" bindings should be objects, but got ${JSON.stringify(value)}`
1927
+ );
1928
+ return false;
1929
+ }
1930
+ let isValid = true;
1931
+ // Service bindings must have a binding, service, and environment.
1932
+ if (!isRequiredProperty(value, "binding", "string")) {
1933
+ diagnostics.errors.push(
1934
+ `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1935
+ value
1936
+ )}.`
1937
+ );
1938
+ isValid = false;
1939
+ }
1940
+ if (!isRequiredProperty(value, "service", "string")) {
1941
+ diagnostics.errors.push(
1942
+ `"${field}" bindings should have a string "service" field but got ${JSON.stringify(
1943
+ value
1944
+ )}.`
1945
+ );
1946
+ isValid = false;
1947
+ }
1948
+ if (!isOptionalProperty(value, "environment", "string")) {
1949
+ diagnostics.errors.push(
1950
+ `"${field}" bindings should have a string "environment" field but got ${JSON.stringify(
1951
+ value
1952
+ )}.`
1953
+ );
1954
+ isValid = false;
1955
+ }
1956
+ return isValid;
1957
+ };
1958
+
1959
+ const validateWorkerNamespaceBinding: ValidatorFn = (
1960
+ diagnostics,
1961
+ field,
1962
+ value
1963
+ ) => {
1964
+ if (typeof value !== "object" || value === null) {
1965
+ diagnostics.errors.push(
1966
+ `"${field}" binding should be objects, but got ${JSON.stringify(value)}`
1967
+ );
1968
+ return false;
1969
+ }
1970
+ let isValid = true;
1971
+ // Worker namespace bindings must have a binding, and a namespace.
1972
+ if (!isRequiredProperty(value, "binding", "string")) {
1973
+ diagnostics.errors.push(
1974
+ `"${field}" should have a string "binding" field but got ${JSON.stringify(
1975
+ value
1976
+ )}.`
1977
+ );
1978
+ isValid = false;
1979
+ }
1980
+ if (!isRequiredProperty(value, "namespace", "string")) {
1981
+ diagnostics.errors.push(
1982
+ `"${field}" should have a string "namespace" field but got ${JSON.stringify(
1983
+ value
1984
+ )}.`
1985
+ );
1986
+ isValid = false;
1987
+ }
1988
+ return isValid;
1989
+ };
1990
+
1991
+ function validateQueues(envName: string): ValidatorFn {
1992
+ return (diagnostics, field, value, config) => {
1993
+ const fieldPath =
1994
+ config === undefined ? `${field}` : `env.${envName}.${field}`;
1995
+
1996
+ if (typeof value !== "object" || Array.isArray(value) || value === null) {
1997
+ diagnostics.errors.push(
1998
+ `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1999
+ value
2000
+ )}.`
2001
+ );
2002
+ return false;
2003
+ }
2004
+
2005
+ let isValid = true;
2006
+ if (
2007
+ !validateAdditionalProperties(
2008
+ diagnostics,
2009
+ fieldPath,
2010
+ Object.keys(value),
2011
+ ["consumers", "producers"]
2012
+ )
2013
+ ) {
2014
+ isValid = false;
2015
+ }
2016
+
2017
+ if (hasProperty(value, "consumers")) {
2018
+ const consumers = value.consumers;
2019
+ if (!Array.isArray(consumers)) {
2020
+ diagnostics.errors.push(
2021
+ `The field "${fieldPath}.consumers" should be an array but got ${JSON.stringify(
2022
+ consumers
2023
+ )}.`
2024
+ );
2025
+ isValid = false;
2026
+ }
2027
+
2028
+ for (let i = 0; i < consumers.length; i++) {
2029
+ const consumer = consumers[i];
2030
+ const consumerPath = `${fieldPath}.consumers[${i}]`;
2031
+ if (!validateConsumer(diagnostics, consumerPath, consumer, config)) {
2032
+ isValid = false;
2033
+ }
2034
+ }
2035
+ }
2036
+
2037
+ if (hasProperty(value, "producers")) {
2038
+ if (
2039
+ !validateBindingArray(envName, validateQueueBinding)(
2040
+ diagnostics,
2041
+ `${field}.producers`,
2042
+ value.producers,
2043
+ config
2044
+ )
2045
+ ) {
2046
+ isValid = false;
2047
+ }
2048
+ }
2049
+ return isValid;
2050
+ };
2051
+ }
2052
+
2053
+ const validateConsumer: ValidatorFn = (diagnostics, field, value, _config) => {
2054
+ if (typeof value !== "object" || value === null) {
2055
+ diagnostics.errors.push(
2056
+ `"${field}" should be a objects, but got ${JSON.stringify(value)}`
2057
+ );
2058
+ return false;
2059
+ }
2060
+
2061
+ let isValid = true;
2062
+ if (
2063
+ !validateAdditionalProperties(diagnostics, field, Object.keys(value), [
2064
+ "queue",
2065
+ "max_batch_size",
2066
+ "max_batch_timeout",
2067
+ "max_retries",
2068
+ "dead_letter_queue",
2069
+ ])
2070
+ ) {
2071
+ isValid = false;
2072
+ }
2073
+
2074
+ if (!isRequiredProperty(value, "queue", "string")) {
2075
+ diagnostics.errors.push(
2076
+ `"${field}" should have a string "queue" field but got ${JSON.stringify(
2077
+ value
2078
+ )}.`
2079
+ );
2080
+ }
2081
+
2082
+ const options: {
2083
+ key: string;
2084
+ type: "number" | "string";
2085
+ }[] = [
2086
+ { key: "max_batch_size", type: "number" },
2087
+ { key: "max_batch_timeout", type: "number" },
2088
+ { key: "max_retries", type: "number" },
2089
+ { key: "dead_letter_queue", type: "string" },
2090
+ ];
2091
+ for (const optionalOpt of options) {
2092
+ if (!isOptionalProperty(value, optionalOpt.key, optionalOpt.type)) {
2093
+ diagnostics.errors.push(
2094
+ `"${field}" should, optionally, have a ${optionalOpt.type} "${
2095
+ optionalOpt.key
2096
+ }" field but got ${JSON.stringify(value)}.`
2097
+ );
2098
+ isValid = false;
2099
+ }
2100
+ }
2101
+
2102
+ return isValid;
1424
2103
  };