wrangler 0.0.0-e5a3814 → 0.0.0-e60dc909

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