wrangler 0.0.0-e6c71262 → 0.0.0-e6ddf8a7

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