wrangler 0.0.0-e6e1daba → 0.0.0-e739b7fe

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 (311) hide show
  1. package/README.md +10 -12
  2. package/bin/wrangler.js +14 -75
  3. package/package.json +226 -194
  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/gitignore +0 -4
  8. package/templates/init-tests/test-vitest-new-worker.js +1 -1
  9. package/templates/init-tests/test-vitest-new-worker.ts +1 -1
  10. package/templates/middleware/common.ts +9 -4
  11. package/templates/middleware/loader-modules.ts +67 -15
  12. package/templates/middleware/loader-sw.ts +6 -10
  13. package/templates/middleware/middleware-d1-beta.d.ts +3 -0
  14. package/templates/middleware/middleware-ensure-req-body-drained.ts +19 -0
  15. package/templates/middleware/middleware-miniflare3-json-error.ts +18 -5
  16. package/templates/middleware/middleware-multiworker-dev.d.ts +4 -0
  17. package/templates/middleware/middleware-multiworker-dev.ts +68 -0
  18. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  19. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  20. package/templates/modules-watch-stub.js +4 -0
  21. package/templates/new-worker-scheduled.ts +1 -1
  22. package/templates/new-worker.ts +1 -1
  23. package/templates/pages-dev-pipeline.ts +2 -1
  24. package/templates/pages-dev-util.ts +4 -1
  25. package/templates/pages-shim.ts +0 -3
  26. package/templates/pages-template-plugin.ts +12 -2
  27. package/templates/pages-template-worker.ts +11 -2
  28. package/templates/startDevWorker/InspectorProxyWorker.ts +661 -0
  29. package/templates/startDevWorker/ProxyWorker.ts +326 -0
  30. package/templates/tsconfig.init.json +1 -2
  31. package/templates/tsconfig.json +1 -1
  32. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  33. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  34. package/wrangler-dist/ProxyWorker.js +237 -0
  35. package/wrangler-dist/ProxyWorker.js.map +6 -0
  36. package/wrangler-dist/cli.d.ts +22647 -337
  37. package/wrangler-dist/cli.js +137196 -118219
  38. package/wrangler-dist/wasm-sync.wasm +0 -0
  39. package/import_meta_url.js +0 -3
  40. package/miniflare-config-stubs/.env.empty +0 -0
  41. package/miniflare-config-stubs/package.empty.json +0 -1
  42. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  43. package/miniflare-dist/index.mjs +0 -6368
  44. package/src/__tests__/access.test.ts +0 -25
  45. package/src/__tests__/api-dev.test.ts +0 -238
  46. package/src/__tests__/api-devregistry.test.js +0 -64
  47. package/src/__tests__/api.test.ts +0 -80
  48. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  49. package/src/__tests__/config-cache.test.ts +0 -42
  50. package/src/__tests__/configuration.test.ts +0 -4233
  51. package/src/__tests__/d1/d1.test.ts +0 -82
  52. package/src/__tests__/d1/execute.test.ts +0 -64
  53. package/src/__tests__/d1/migrate.test.ts +0 -155
  54. package/src/__tests__/d1/splitter.test.ts +0 -255
  55. package/src/__tests__/delete.test.ts +0 -266
  56. package/src/__tests__/deployments.test.ts +0 -129
  57. package/src/__tests__/dev.test.tsx +0 -1587
  58. package/src/__tests__/generate.test.ts +0 -238
  59. package/src/__tests__/get-host-from-url.test.ts +0 -16
  60. package/src/__tests__/guess-worker-format.test.ts +0 -120
  61. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  62. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  63. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  64. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  65. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  66. package/src/__tests__/helpers/mock-bin.ts +0 -36
  67. package/src/__tests__/helpers/mock-console.ts +0 -106
  68. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  69. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  70. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  71. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  72. package/src/__tests__/helpers/mock-istty.ts +0 -74
  73. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  74. package/src/__tests__/helpers/mock-kv.ts +0 -46
  75. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  76. package/src/__tests__/helpers/mock-process.ts +0 -34
  77. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  78. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  79. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  80. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  81. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  82. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -93
  83. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  84. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  85. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  86. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  87. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  88. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  89. package/src/__tests__/helpers/msw/index.ts +0 -50
  90. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  91. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  92. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  93. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  94. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  95. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  96. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  97. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  98. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  99. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  100. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  101. package/src/__tests__/https-options.test.ts +0 -163
  102. package/src/__tests__/index.test.ts +0 -274
  103. package/src/__tests__/init.test.ts +0 -3164
  104. package/src/__tests__/jest.setup.ts +0 -175
  105. package/src/__tests__/kv.test.ts +0 -1799
  106. package/src/__tests__/logger.test.ts +0 -141
  107. package/src/__tests__/logout.test.ts +0 -47
  108. package/src/__tests__/metrics.test.ts +0 -493
  109. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  110. package/src/__tests__/middleware.test.ts +0 -815
  111. package/src/__tests__/mtls-certificates.test.ts +0 -585
  112. package/src/__tests__/package-manager.test.ts +0 -353
  113. package/src/__tests__/pages/deployment-list.test.ts +0 -78
  114. package/src/__tests__/pages/functions-build.test.ts +0 -402
  115. package/src/__tests__/pages/pages.test.ts +0 -81
  116. package/src/__tests__/pages/project-create.test.ts +0 -63
  117. package/src/__tests__/pages/project-list.test.ts +0 -108
  118. package/src/__tests__/pages/project-upload.test.ts +0 -481
  119. package/src/__tests__/pages/publish.test.ts +0 -2745
  120. package/src/__tests__/pages-deployment-tail.test.ts +0 -955
  121. package/src/__tests__/parse.test.ts +0 -436
  122. package/src/__tests__/paths.test.ts +0 -39
  123. package/src/__tests__/publish.test.ts +0 -8167
  124. package/src/__tests__/pubsub.test.ts +0 -493
  125. package/src/__tests__/queues.test.ts +0 -529
  126. package/src/__tests__/r2.test.ts +0 -374
  127. package/src/__tests__/route.test.ts +0 -45
  128. package/src/__tests__/secret.test.ts +0 -693
  129. package/src/__tests__/tail.test.ts +0 -958
  130. package/src/__tests__/test-old-node-version.js +0 -31
  131. package/src/__tests__/tsconfig-sanity.ts +0 -12
  132. package/src/__tests__/tsconfig.json +0 -8
  133. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  134. package/src/__tests__/type-generation.test.ts +0 -233
  135. package/src/__tests__/user.test.ts +0 -118
  136. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  137. package/src/__tests__/validate-dev-props.test.ts +0 -56
  138. package/src/__tests__/version.test.ts +0 -35
  139. package/src/__tests__/whoami.test.tsx +0 -172
  140. package/src/__tests__/worker-namespace.test.ts +0 -339
  141. package/src/abort.d.ts +0 -3
  142. package/src/api/dev.ts +0 -328
  143. package/src/api/index.ts +0 -11
  144. package/src/api/mtls-certificate.ts +0 -148
  145. package/src/api/pages/create-worker-bundle-contents.ts +0 -75
  146. package/src/api/pages/index.ts +0 -5
  147. package/src/api/pages/publish.tsx +0 -368
  148. package/src/bundle-reporter.ts +0 -68
  149. package/src/bundle.ts +0 -877
  150. package/src/cfetch/index.ts +0 -158
  151. package/src/cfetch/internal.ts +0 -258
  152. package/src/cli.ts +0 -28
  153. package/src/config/README.md +0 -107
  154. package/src/config/config.ts +0 -282
  155. package/src/config/diagnostics.ts +0 -80
  156. package/src/config/environment.ts +0 -586
  157. package/src/config/index.ts +0 -375
  158. package/src/config/validation-helpers.ts +0 -597
  159. package/src/config/validation.ts +0 -2198
  160. package/src/config-cache.ts +0 -85
  161. package/src/create-worker-preview.ts +0 -293
  162. package/src/create-worker-upload-form.ts +0 -334
  163. package/src/d1/backups.tsx +0 -215
  164. package/src/d1/constants.ts +0 -2
  165. package/src/d1/create.tsx +0 -64
  166. package/src/d1/delete.ts +0 -53
  167. package/src/d1/execute.tsx +0 -354
  168. package/src/d1/formatTimeAgo.ts +0 -14
  169. package/src/d1/index.ts +0 -100
  170. package/src/d1/list.tsx +0 -60
  171. package/src/d1/migrations/apply.tsx +0 -206
  172. package/src/d1/migrations/create.tsx +0 -76
  173. package/src/d1/migrations/helpers.ts +0 -172
  174. package/src/d1/migrations/index.ts +0 -3
  175. package/src/d1/migrations/list.tsx +0 -92
  176. package/src/d1/migrations/options.ts +0 -23
  177. package/src/d1/options.ts +0 -22
  178. package/src/d1/splitter.ts +0 -161
  179. package/src/d1/types.ts +0 -25
  180. package/src/d1/utils.ts +0 -49
  181. package/src/delete.ts +0 -100
  182. package/src/deployments.ts +0 -116
  183. package/src/deprecated/index.ts +0 -144
  184. package/src/dev/dev-vars.ts +0 -39
  185. package/src/dev/dev.tsx +0 -600
  186. package/src/dev/get-local-persistence-path.ts +0 -31
  187. package/src/dev/local.tsx +0 -922
  188. package/src/dev/remote.tsx +0 -632
  189. package/src/dev/start-server.ts +0 -538
  190. package/src/dev/use-esbuild.ts +0 -205
  191. package/src/dev/validate-dev-props.ts +0 -31
  192. package/src/dev-registry.ts +0 -201
  193. package/src/dev.tsx +0 -914
  194. package/src/dialogs.ts +0 -136
  195. package/src/dispatch-namespace.ts +0 -211
  196. package/src/docs/index.ts +0 -97
  197. package/src/durable.ts +0 -102
  198. package/src/entry.ts +0 -327
  199. package/src/environment-variables/factory.ts +0 -88
  200. package/src/environment-variables/misc-variables.ts +0 -30
  201. package/src/errors.ts +0 -11
  202. package/src/generate/index.ts +0 -298
  203. package/src/git-client.ts +0 -135
  204. package/src/global-wrangler-config-path.ts +0 -26
  205. package/src/https-options.ts +0 -127
  206. package/src/index.ts +0 -705
  207. package/src/init.ts +0 -1022
  208. package/src/inspect.ts +0 -782
  209. package/src/intl-polyfill.d.ts +0 -139
  210. package/src/is-ci.ts +0 -14
  211. package/src/is-interactive.ts +0 -16
  212. package/src/jest.d.ts +0 -4
  213. package/src/kv/helpers.ts +0 -430
  214. package/src/kv/index.ts +0 -594
  215. package/src/logger.ts +0 -104
  216. package/src/metrics/index.ts +0 -5
  217. package/src/metrics/metrics-config.ts +0 -239
  218. package/src/metrics/metrics-dispatcher.ts +0 -96
  219. package/src/metrics/metrics-usage-headers.ts +0 -24
  220. package/src/metrics/send-event.ts +0 -98
  221. package/src/miniflare-cli/README.md +0 -30
  222. package/src/miniflare-cli/assets.ts +0 -251
  223. package/src/miniflare-cli/index.ts +0 -210
  224. package/src/miniflare-cli/request-context.ts +0 -40
  225. package/src/miniflare-cli/tsconfig.json +0 -9
  226. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  227. package/src/miniflare-cli/types.ts +0 -11
  228. package/src/module-collection.ts +0 -267
  229. package/src/mtls-certificate/cli.ts +0 -155
  230. package/src/open-in-browser.ts +0 -17
  231. package/src/package-manager.ts +0 -219
  232. package/src/pages/build.ts +0 -232
  233. package/src/pages/buildFunctions.ts +0 -130
  234. package/src/pages/constants.ts +0 -18
  235. package/src/pages/deployment-tails.ts +0 -281
  236. package/src/pages/deployments.tsx +0 -86
  237. package/src/pages/dev.ts +0 -716
  238. package/src/pages/errors.ts +0 -66
  239. package/src/pages/functions/buildPlugin.ts +0 -90
  240. package/src/pages/functions/buildWorker.ts +0 -288
  241. package/src/pages/functions/filepath-routing.test.ts +0 -234
  242. package/src/pages/functions/filepath-routing.ts +0 -189
  243. package/src/pages/functions/identifiers.ts +0 -78
  244. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  245. package/src/pages/functions/routes-consolidation.ts +0 -73
  246. package/src/pages/functions/routes-transformation.test.ts +0 -282
  247. package/src/pages/functions/routes-transformation.ts +0 -115
  248. package/src/pages/functions/routes-validation.test.ts +0 -403
  249. package/src/pages/functions/routes-validation.ts +0 -202
  250. package/src/pages/functions/routes.ts +0 -151
  251. package/src/pages/functions/tsconfig.json +0 -8
  252. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  253. package/src/pages/functions.ts +0 -86
  254. package/src/pages/hash.ts +0 -13
  255. package/src/pages/index.ts +0 -102
  256. package/src/pages/projects.tsx +0 -162
  257. package/src/pages/prompt-select-project.tsx +0 -31
  258. package/src/pages/publish.tsx +0 -276
  259. package/src/pages/types.ts +0 -46
  260. package/src/pages/upload.tsx +0 -449
  261. package/src/pages/utils.ts +0 -23
  262. package/src/parse.ts +0 -308
  263. package/src/paths.ts +0 -71
  264. package/src/proxy.ts +0 -694
  265. package/src/publish/index.ts +0 -274
  266. package/src/publish/publish.ts +0 -1065
  267. package/src/pubsub/index.ts +0 -286
  268. package/src/pubsub/pubsub-commands.ts +0 -623
  269. package/src/queues/cli/commands/consumer/add.ts +0 -65
  270. package/src/queues/cli/commands/consumer/index.ts +0 -19
  271. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  272. package/src/queues/cli/commands/create.ts +0 -25
  273. package/src/queues/cli/commands/delete.ts +0 -26
  274. package/src/queues/cli/commands/index.ts +0 -35
  275. package/src/queues/cli/commands/list.ts +0 -25
  276. package/src/queues/client.ts +0 -135
  277. package/src/queues/utils.ts +0 -18
  278. package/src/r2/constants.ts +0 -4
  279. package/src/r2/helpers.ts +0 -132
  280. package/src/r2/index.ts +0 -289
  281. package/src/routes.ts +0 -140
  282. package/src/secret/index.ts +0 -375
  283. package/src/selfsigned.d.ts +0 -29
  284. package/src/sites.ts +0 -372
  285. package/src/tail/createTail.ts +0 -406
  286. package/src/tail/filters.ts +0 -277
  287. package/src/tail/index.ts +0 -211
  288. package/src/tail/printing.ts +0 -122
  289. package/src/tsconfig-sanity.ts +0 -16
  290. package/src/type-generation.ts +0 -181
  291. package/src/update-check.ts +0 -19
  292. package/src/user/access.ts +0 -68
  293. package/src/user/auth-variables.ts +0 -113
  294. package/src/user/choose-account.tsx +0 -39
  295. package/src/user/generate-auth-url.ts +0 -33
  296. package/src/user/generate-random-state.ts +0 -16
  297. package/src/user/index.ts +0 -2
  298. package/src/user/user.ts +0 -1233
  299. package/src/utils/collectKeyValues.ts +0 -14
  300. package/src/whoami.ts +0 -135
  301. package/src/worker.ts +0 -257
  302. package/src/yargs-types.ts +0 -37
  303. package/src/zones.ts +0 -191
  304. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  305. package/templates/d1-beta-facade.js +0 -241
  306. package/templates/first-party-worker-module-facade.ts +0 -19
  307. package/templates/format-dev-errors.ts +0 -34
  308. package/templates/serve-static-assets.ts +0 -66
  309. package/templates/service-bindings-module-facade.js +0 -55
  310. package/templates/service-bindings-sw-facade.js +0 -42
  311. package/templates/tsconfig.tsbuildinfo +0 -1
@@ -1,2198 +0,0 @@
1
- import path from "node:path";
2
- import TOML from "@iarna/toml";
3
- import { Diagnostics } from "./diagnostics";
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,
28
- } from "./validation-helpers";
29
- import type { Config, DevConfig, RawConfig, RawDevConfig } from "./config";
30
- import type {
31
- RawEnvironment,
32
- DeprecatedUpload,
33
- Environment,
34
- Rule,
35
- } from "./environment";
36
- import type { ValidatorFn } from "./validation-helpers";
37
-
38
- const ENGLISH = new Intl.ListFormat("en");
39
-
40
- /**
41
- * Validate the given `rawConfig` object that was loaded from `configPath`.
42
- *
43
- * The configuration is normalized, which includes using default values for missing field,
44
- * and copying over inheritable fields into named environments.
45
- *
46
- * Any errors or warnings from the validation are available in the returned `diagnostics` object.
47
- */
48
- export function normalizeAndValidateConfig(
49
- rawConfig: RawConfig,
50
- configPath: string | undefined,
51
- args: unknown
52
- ): {
53
- config: Config;
54
- diagnostics: Diagnostics;
55
- } {
56
- const diagnostics = new Diagnostics(
57
- `Processing ${
58
- configPath ? path.relative(process.cwd(), configPath) : "wrangler"
59
- } configuration:`
60
- );
61
-
62
- deprecated(
63
- diagnostics,
64
- rawConfig,
65
- "miniflare",
66
- "Wrangler does not use configuration in the `miniflare` section. Unless you are using Miniflare directly you can remove this section.",
67
- true,
68
- "😶 Ignored"
69
- );
70
-
71
- deprecated(
72
- diagnostics,
73
- rawConfig,
74
- "type",
75
- "Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
76
- true,
77
- "😶 Ignored"
78
- );
79
-
80
- deprecated(
81
- diagnostics,
82
- rawConfig,
83
- "webpack_config",
84
- "Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
85
- true,
86
- "😶 Ignored"
87
- );
88
-
89
- validateOptionalProperty(
90
- diagnostics,
91
- "",
92
- "legacy_env",
93
- rawConfig.legacy_env,
94
- "boolean"
95
- );
96
-
97
- validateOptionalProperty(
98
- diagnostics,
99
- "",
100
- "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 };
240
- }
241
-
242
- /**
243
- * Validate the `build` configuration and return the normalized values.
244
- */
245
- function normalizeAndValidateBuild(
246
- diagnostics: Diagnostics,
247
- rawEnv: RawEnvironment,
248
- rawBuild: Config["build"],
249
- configPath: string | undefined
250
- ): Config["build"] & { deprecatedUpload: DeprecatedUpload } {
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
- };
332
- }
333
-
334
- /**
335
- * Validate the `main` field and return the normalized values.
336
- */
337
- function normalizeAndValidateMainField(
338
- configPath: string | undefined,
339
- rawMain: string | undefined,
340
- deprecatedUpload: DeprecatedUpload | undefined
341
- ): string | undefined {
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
- }
359
- }
360
-
361
- /**
362
- * Validate the `dev` configuration and return the normalized values.
363
- */
364
- function normalizeAndValidateDev(
365
- diagnostics: Diagnostics,
366
- rawDev: RawDevConfig
367
- ): DevConfig {
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 };
406
- }
407
-
408
- /**
409
- * Validate the `migrations` configuration and return the normalized values.
410
- */
411
- function normalizeAndValidateMigrations(
412
- diagnostics: Diagnostics,
413
- rawMigrations: Config["migrations"],
414
- durableObjects: Config["durable_objects"]
415
- ): Config["migrations"] {
416
- if (!Array.isArray(rawMigrations)) {
417
- diagnostics.errors.push(
418
- `The optional "migrations" field should be an array, but got ${JSON.stringify(
419
- rawMigrations
420
- )}`
421
- );
422
- return [];
423
- } else {
424
- for (let i = 0; i < rawMigrations.length; i++) {
425
- const { tag, new_classes, renamed_classes, deleted_classes, ...rest } =
426
- rawMigrations[i];
427
-
428
- validateAdditionalProperties(
429
- diagnostics,
430
- "migrations",
431
- Object.keys(rest),
432
- []
433
- );
434
-
435
- validateRequiredProperty(
436
- diagnostics,
437
- `migrations[${i}]`,
438
- `tag`,
439
- tag,
440
- "string"
441
- );
442
- validateOptionalTypedArray(
443
- diagnostics,
444
- `migrations[${i}].new_classes`,
445
- new_classes,
446
- "string"
447
- );
448
- if (renamed_classes !== undefined) {
449
- if (!Array.isArray(renamed_classes)) {
450
- diagnostics.errors.push(
451
- `Expected "migrations[${i}].renamed_classes" to be an array of "{from: string, to: string}" objects but got ${JSON.stringify(
452
- renamed_classes
453
- )}.`
454
- );
455
- } else if (
456
- renamed_classes.some(
457
- (c) =>
458
- typeof c !== "object" ||
459
- !isRequiredProperty(c, "from", "string") ||
460
- !isRequiredProperty(c, "to", "string")
461
- )
462
- ) {
463
- diagnostics.errors.push(
464
- `Expected "migrations[${i}].renamed_classes" to be an array of "{from: string, to: string}" objects but got ${JSON.stringify(
465
- renamed_classes
466
- )}.`
467
- );
468
- }
469
- }
470
- validateOptionalTypedArray(
471
- diagnostics,
472
- `migrations[${i}].deleted_classes`,
473
- deleted_classes,
474
- "string"
475
- );
476
- }
477
-
478
- if (
479
- Array.isArray(durableObjects?.bindings) &&
480
- durableObjects.bindings.length > 0
481
- ) {
482
- // intrinsic [durable_objects] implies [migrations]
483
- const exportedDurableObjects = (durableObjects.bindings || []).filter(
484
- (binding) => !binding.script_name
485
- );
486
- if (exportedDurableObjects.length > 0 && rawMigrations.length === 0) {
487
- if (
488
- !exportedDurableObjects.some(
489
- (exportedDurableObject) =>
490
- typeof exportedDurableObject.class_name !== "string"
491
- )
492
- ) {
493
- const durableObjectClassnames = exportedDurableObjects.map(
494
- (durable) => durable.class_name
495
- );
496
-
497
- diagnostics.warnings.push(
498
- `In wrangler.toml, you have configured [durable_objects] exported by this Worker (${durableObjectClassnames.join(
499
- ", "
500
- )}), but no [migrations] for them. This may not work as expected until you add a [migrations] section to your wrangler.toml. Add this configuration to your wrangler.toml:
501
-
502
- \`\`\`
503
- [[migrations]]
504
- tag = "v1" # Should be unique for each entry
505
- new_classes = [${durableObjectClassnames
506
- .map((name) => `"${name}"`)
507
- .join(", ")}]
508
- \`\`\`
509
-
510
- Refer to https://developers.cloudflare.com/workers/learning/using-durable-objects/#durable-object-migrations-in-wranglertoml for more details.`
511
- );
512
- }
513
- }
514
- }
515
-
516
- return rawMigrations;
517
- }
518
- }
519
-
520
- /**
521
- * Validate the `site` configuration and return the normalized values.
522
- */
523
- function normalizeAndValidateSite(
524
- diagnostics: Diagnostics,
525
- configPath: string | undefined,
526
- rawConfig: RawConfig,
527
- mainEntryPoint: string | undefined
528
- ): Config["site"] {
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
- };
673
- }
674
-
675
- /**
676
- * Map the paths of the `wasm_modules`, `text_blobs` or `data_blobs` configuration to be relative to the current working directory.
677
- */
678
- function normalizeAndValidateModulePaths(
679
- diagnostics: Diagnostics,
680
- configPath: string | undefined,
681
- field: "wasm_modules" | "text_blobs" | "data_blobs",
682
- rawMapping: Record<string, string> | undefined
683
- ): Record<string, string> | undefined {
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;
702
- }
703
-
704
- /**
705
- * Check whether a value has the shape of a route, which can be a string
706
- * or an object that looks like {pattern: string, zone_id: string }
707
- */
708
- function isValidRouteValue(item: unknown): boolean {
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 Wrangler v1-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 Wrangler v1 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;
778
- }
779
-
780
- /**
781
- * Validate that the field is a route.
782
- */
783
- const isRoute: ValidatorFn = (diagnostics, field, value) => {
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;
793
- };
794
-
795
- /**
796
- * Validate that the field is an array of routes.
797
- */
798
- const isRouteArray: ValidatorFn = (diagnostics, field, value) => {
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;
824
- };
825
-
826
- function normalizeAndValidateRoute(
827
- diagnostics: Diagnostics,
828
- topLevelEnv: Environment | undefined,
829
- rawEnv: RawEnvironment
830
- ): Config["route"] {
831
- return inheritable(
832
- diagnostics,
833
- topLevelEnv,
834
- mutateEmptyStringRouteValue(diagnostics, rawEnv),
835
- "route",
836
- isRoute,
837
- undefined
838
- );
839
- }
840
-
841
- function validateRoutes(
842
- diagnostics: Diagnostics,
843
- topLevelEnv: Environment | undefined,
844
- rawEnv: RawEnvironment
845
- ): Config["routes"] {
846
- return inheritable(
847
- diagnostics,
848
- topLevelEnv,
849
- rawEnv,
850
- "routes",
851
- all(isRouteArray, isMutuallyExclusiveWith(rawEnv, "route")),
852
- undefined
853
- );
854
- }
855
-
856
- /**
857
- * Validate top-level environment configuration and return the normalized values.
858
- */
859
- function normalizeAndValidateEnvironment(
860
- diagnostics: Diagnostics,
861
- configPath: string | undefined,
862
- topLevelEnv: RawEnvironment
863
- ): Environment;
864
- /**
865
- * Validate the named environment configuration and return the normalized values.
866
- */
867
- function normalizeAndValidateEnvironment(
868
- diagnostics: Diagnostics,
869
- configPath: string | undefined,
870
- rawEnv: RawEnvironment,
871
- envName: string,
872
- topLevelEnv: Environment,
873
- isLegacyEnv: boolean,
874
- rawConfig: RawConfig
875
- ): Environment;
876
- function normalizeAndValidateEnvironment(
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
884
- ): 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
- mtls_certificates: notInheritable(
1138
- diagnostics,
1139
- topLevelEnv,
1140
- rawConfig,
1141
- rawEnv,
1142
- envName,
1143
- "mtls_certificates",
1144
- validateBindingArray(envName, validateMTlsCertificateBinding),
1145
- []
1146
- ),
1147
- logfwdr: inheritable(
1148
- diagnostics,
1149
- topLevelEnv,
1150
- rawEnv,
1151
- "logfwdr",
1152
- validateBindingsProperty(envName, validateCflogfwdrBinding),
1153
- {
1154
- schema: undefined,
1155
- bindings: [],
1156
- }
1157
- ),
1158
- unsafe: notInheritable(
1159
- diagnostics,
1160
- topLevelEnv,
1161
- rawConfig,
1162
- rawEnv,
1163
- envName,
1164
- "unsafe",
1165
- validateBindingsProperty(envName, validateUnsafeBinding),
1166
- {
1167
- bindings: [],
1168
- }
1169
- ),
1170
- zone_id: rawEnv.zone_id,
1171
- no_bundle: inheritable(
1172
- diagnostics,
1173
- topLevelEnv,
1174
- rawEnv,
1175
- "no_bundle",
1176
- isBoolean,
1177
- undefined
1178
- ),
1179
- minify: inheritable(
1180
- diagnostics,
1181
- topLevelEnv,
1182
- rawEnv,
1183
- "minify",
1184
- isBoolean,
1185
- undefined
1186
- ),
1187
- node_compat: inheritable(
1188
- diagnostics,
1189
- topLevelEnv,
1190
- rawEnv,
1191
- "node_compat",
1192
- isBoolean,
1193
- undefined
1194
- ),
1195
- first_party_worker: inheritable(
1196
- diagnostics,
1197
- topLevelEnv,
1198
- rawEnv,
1199
- "first_party_worker",
1200
- isBoolean,
1201
- undefined
1202
- ),
1203
- logpush: inheritable(
1204
- diagnostics,
1205
- topLevelEnv,
1206
- rawEnv,
1207
- "logpush",
1208
- isBoolean,
1209
- undefined
1210
- ),
1211
- };
1212
-
1213
- return environment;
1214
- }
1215
-
1216
- function validateAndNormalizeTsconfig(
1217
- diagnostics: Diagnostics,
1218
- topLevelEnv: Environment | undefined,
1219
- rawEnv: RawEnvironment,
1220
- configPath: string | undefined
1221
- ) {
1222
- const tsconfig = inheritable(
1223
- diagnostics,
1224
- topLevelEnv,
1225
- rawEnv,
1226
- "tsconfig",
1227
- isString,
1228
- undefined
1229
- );
1230
-
1231
- return configPath && tsconfig
1232
- ? path.relative(
1233
- process.cwd(),
1234
- path.join(path.dirname(configPath), tsconfig)
1235
- )
1236
- : tsconfig;
1237
- }
1238
-
1239
- const validateAndNormalizeRules = (
1240
- diagnostics: Diagnostics,
1241
- topLevelEnv: Environment | undefined,
1242
- rawEnv: RawEnvironment,
1243
- deprecatedRules: Rule[] | undefined,
1244
- envName: string
1245
- ): Rule[] => {
1246
- if (topLevelEnv === undefined) {
1247
- // Only create errors/warnings for the top-level environment
1248
- if (rawEnv.rules && deprecatedRules) {
1249
- diagnostics.errors.push(
1250
- `You cannot configure both [rules] and [build.upload.rules] in your wrangler.toml. Delete the \`build.upload\` section.`
1251
- );
1252
- } else if (deprecatedRules) {
1253
- diagnostics.warnings.push(
1254
- `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` +
1255
- "```\n" +
1256
- TOML.stringify({ rules: deprecatedRules }) +
1257
- "```"
1258
- );
1259
- }
1260
- }
1261
-
1262
- return inheritable(
1263
- diagnostics,
1264
- topLevelEnv,
1265
- rawEnv,
1266
- "rules",
1267
- validateRules(envName),
1268
- deprecatedRules ?? []
1269
- );
1270
- };
1271
-
1272
- const validateRules =
1273
- (envName: string): ValidatorFn =>
1274
- (diagnostics, field, envValue, config) => {
1275
- if (!envValue) {
1276
- return true;
1277
- }
1278
- const fieldPath =
1279
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1280
- if (!Array.isArray(envValue)) {
1281
- diagnostics.errors.push(
1282
- `The field "${fieldPath}" should be an array but got ${JSON.stringify(
1283
- envValue
1284
- )}.`
1285
- );
1286
- return false;
1287
- }
1288
-
1289
- let isValid = true;
1290
- for (let i = 0; i < envValue.length; i++) {
1291
- isValid =
1292
- validateRule(diagnostics, `${fieldPath}[${i}]`, envValue[i], config) &&
1293
- isValid;
1294
- }
1295
- return isValid;
1296
- };
1297
-
1298
- const validateRule: ValidatorFn = (diagnostics, field, value) => {
1299
- if (typeof value !== "object" || value === null) {
1300
- diagnostics.errors.push(
1301
- `"${field}" should be an object but got ${JSON.stringify(value)}.`
1302
- );
1303
- return false;
1304
- }
1305
- // Rules must have a type string and glob string array, and optionally a fallthrough boolean.
1306
- let isValid = true;
1307
- const rule = value as Rule;
1308
-
1309
- if (
1310
- !isRequiredProperty(rule, "type", "string", [
1311
- "ESModule",
1312
- "CommonJS",
1313
- "CompiledWasm",
1314
- "Text",
1315
- "Data",
1316
- ])
1317
- ) {
1318
- diagnostics.errors.push(
1319
- `bindings should have a string "type" field, which contains one of "ESModule", "CommonJS", "CompiledWasm", "Text", or "Data".`
1320
- );
1321
- isValid = false;
1322
- }
1323
-
1324
- isValid =
1325
- validateTypedArray(diagnostics, `${field}.globs`, rule.globs, "string") &&
1326
- isValid;
1327
-
1328
- if (!isOptionalProperty(rule, "fallthrough", "boolean")) {
1329
- diagnostics.errors.push(
1330
- `the field "fallthrough", when present, should be a boolean.`
1331
- );
1332
- isValid = false;
1333
- }
1334
-
1335
- return isValid;
1336
- };
1337
-
1338
- const validateDefines =
1339
- (envName: string): ValidatorFn =>
1340
- (diagnostics, field, value, config) => {
1341
- let isValid = true;
1342
- const fieldPath =
1343
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1344
-
1345
- if (typeof value === "object" && value !== null) {
1346
- for (const varName in value) {
1347
- // some casting here to appease typescript
1348
- // even though the value might not match the type
1349
- if (typeof (value as Record<string, string>)[varName] !== "string") {
1350
- diagnostics.errors.push(
1351
- `The field "${fieldPath}.${varName}" should be a string but got ${JSON.stringify(
1352
- (value as Record<string, string>)[varName]
1353
- )}.`
1354
- );
1355
- isValid = false;
1356
- }
1357
- }
1358
- } else {
1359
- if (value !== undefined) {
1360
- diagnostics.errors.push(
1361
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1362
- value
1363
- )}.\n`
1364
- );
1365
- isValid = false;
1366
- }
1367
- }
1368
-
1369
- const configDefines = Object.keys(config?.define ?? {});
1370
-
1371
- // If there are no top level vars then there is nothing to do here.
1372
- if (configDefines.length > 0) {
1373
- if (typeof value === "object" && value !== null) {
1374
- const configEnvDefines = config === undefined ? [] : Object.keys(value);
1375
-
1376
- for (const varName of configDefines) {
1377
- if (!(varName in value)) {
1378
- diagnostics.warnings.push(
1379
- `"define.${varName}" exists at the top level, but not on "${fieldPath}".\n` +
1380
- `This is not what you probably want, since "define" configuration is not inherited by environments.\n` +
1381
- `Please add "define.${varName}" to "env.${envName}".`
1382
- );
1383
- }
1384
- }
1385
- for (const varName of configEnvDefines) {
1386
- if (!configDefines.includes(varName)) {
1387
- diagnostics.warnings.push(
1388
- `"${varName}" exists on "env.${envName}", but not on the top level.\n` +
1389
- `This is not what you probably want, since "define" configuration within environments can only override existing top level "define" configuration\n` +
1390
- `Please remove "${fieldPath}.${varName}", or add "define.${varName}".`
1391
- );
1392
- }
1393
- }
1394
- }
1395
- }
1396
-
1397
- return isValid;
1398
- };
1399
-
1400
- const validateVars =
1401
- (envName: string): ValidatorFn =>
1402
- (diagnostics, field, value, config) => {
1403
- let isValid = true;
1404
- const fieldPath =
1405
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1406
- const configVars = Object.keys(config?.vars ?? {});
1407
- // If there are no top level vars then there is nothing to do here.
1408
- if (configVars.length > 0) {
1409
- if (typeof value !== "object" || value === null) {
1410
- diagnostics.errors.push(
1411
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1412
- value
1413
- )}.\n`
1414
- );
1415
- isValid = false;
1416
- } else {
1417
- for (const varName of configVars) {
1418
- if (!(varName in value)) {
1419
- diagnostics.warnings.push(
1420
- `"vars.${varName}" exists at the top level, but not on "${fieldPath}".\n` +
1421
- `This is not what you probably want, since "vars" configuration is not inherited by environments.\n` +
1422
- `Please add "vars.${varName}" to "env.${envName}".`
1423
- );
1424
- }
1425
- }
1426
- }
1427
- }
1428
- return isValid;
1429
- };
1430
-
1431
- const validateBindingsProperty =
1432
- (envName: string, validateBinding: ValidatorFn): ValidatorFn =>
1433
- (diagnostics, field, value, config) => {
1434
- let isValid = true;
1435
- const fieldPath =
1436
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1437
-
1438
- if (value !== undefined) {
1439
- // Check the validity of the `value` as a bindings container.
1440
- if (typeof value !== "object" || value === null || Array.isArray(value)) {
1441
- diagnostics.errors.push(
1442
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
1443
- value
1444
- )}.`
1445
- );
1446
- isValid = false;
1447
- } else if (!hasProperty(value, "bindings")) {
1448
- diagnostics.errors.push(
1449
- `The field "${fieldPath}" is missing the required "bindings" property.`
1450
- );
1451
- isValid = false;
1452
- } else if (!Array.isArray(value.bindings)) {
1453
- diagnostics.errors.push(
1454
- `The field "${fieldPath}.bindings" should be an array but got ${JSON.stringify(
1455
- value.bindings
1456
- )}.`
1457
- );
1458
- isValid = false;
1459
- } else {
1460
- for (let i = 0; i < value.bindings.length; i++) {
1461
- const binding = value.bindings[i];
1462
- const bindingDiagnostics = new Diagnostics(
1463
- `"${fieldPath}.bindings[${i}]": ${JSON.stringify(binding)}`
1464
- );
1465
- isValid =
1466
- validateBinding(
1467
- bindingDiagnostics,
1468
- `${fieldPath}.bindings[${i}]`,
1469
- binding,
1470
- config
1471
- ) && isValid;
1472
- diagnostics.addChild(bindingDiagnostics);
1473
- }
1474
- }
1475
-
1476
- const configBindingNames = getBindingNames(
1477
- config?.[field as keyof Environment]
1478
- );
1479
- if (isValid && configBindingNames.length > 0) {
1480
- // If there are top level bindings then check that they all appear in the environment.
1481
- const envBindingNames = new Set(getBindingNames(value));
1482
- const missingBindings = configBindingNames.filter(
1483
- (name) => !envBindingNames.has(name)
1484
- );
1485
- if (missingBindings.length > 0) {
1486
- diagnostics.warnings.push(
1487
- `The following bindings are at the top level, but not on "env.${envName}".\n` +
1488
- `This is not what you probably want, since "${field}" configuration is not inherited by environments.\n` +
1489
- `Please add a binding for each to "${fieldPath}.bindings":\n` +
1490
- missingBindings.map((name) => `- ${name}`).join("\n")
1491
- );
1492
- }
1493
- }
1494
- }
1495
- return isValid;
1496
- };
1497
-
1498
- /**
1499
- * Check that the given field is a valid "durable_object" binding object.
1500
- */
1501
- const validateDurableObjectBinding: ValidatorFn = (
1502
- diagnostics,
1503
- field,
1504
- value
1505
- ) => {
1506
- if (typeof value !== "object" || value === null) {
1507
- diagnostics.errors.push(
1508
- `Expected "${field}" to be an object but got ${JSON.stringify(value)}`
1509
- );
1510
- return false;
1511
- }
1512
-
1513
- // Durable Object bindings must have a name and class_name, and optionally a script_name and an environment.
1514
- let isValid = true;
1515
- if (!isRequiredProperty(value, "name", "string")) {
1516
- diagnostics.errors.push(`binding should have a string "name" field.`);
1517
- isValid = false;
1518
- }
1519
- if (!isRequiredProperty(value, "class_name", "string")) {
1520
- diagnostics.errors.push(`binding should have a string "class_name" field.`);
1521
- isValid = false;
1522
- }
1523
- if (!isOptionalProperty(value, "script_name", "string")) {
1524
- diagnostics.errors.push(
1525
- `the field "script_name", when present, should be a string.`
1526
- );
1527
- isValid = false;
1528
- }
1529
- // environment requires a script_name
1530
- if (!isOptionalProperty(value, "environment", "string")) {
1531
- diagnostics.errors.push(
1532
- `the field "environment", when present, should be a string.`
1533
- );
1534
- isValid = false;
1535
- }
1536
-
1537
- if ("environment" in value && !("script_name" in value)) {
1538
- diagnostics.errors.push(
1539
- `binding should have a "script_name" field if "environment" is present.`
1540
- );
1541
- isValid = false;
1542
- }
1543
-
1544
- return isValid;
1545
- };
1546
-
1547
- const validateCflogfwdrBinding: ValidatorFn = (diagnostics, field, value) => {
1548
- if (typeof value !== "object" || value === null) {
1549
- diagnostics.errors.push(
1550
- `Expected "${field}" to be an object but got ${JSON.stringify(value)}`
1551
- );
1552
- return false;
1553
- }
1554
-
1555
- let isValid = true;
1556
- if (!isRequiredProperty(value, "name", "string")) {
1557
- diagnostics.errors.push(`binding should have a string "name" field.`);
1558
- isValid = false;
1559
- }
1560
-
1561
- if (!isRequiredProperty(value, "destination", "string")) {
1562
- diagnostics.errors.push(
1563
- `binding should have a string "destination" field.`
1564
- );
1565
- isValid = false;
1566
- }
1567
-
1568
- return isValid;
1569
- };
1570
-
1571
- /**
1572
- * Check that the given field is a valid "unsafe" binding object.
1573
- *
1574
- * TODO: further validation of known unsafe bindings.
1575
- */
1576
- const validateUnsafeBinding: ValidatorFn = (diagnostics, field, value) => {
1577
- if (typeof value !== "object" || value === null) {
1578
- diagnostics.errors.push(
1579
- `Expected ${field} to be an object but got ${JSON.stringify(value)}.`
1580
- );
1581
- return false;
1582
- }
1583
-
1584
- let isValid = true;
1585
- // Unsafe bindings must have a name and type.
1586
- if (!isRequiredProperty(value, "name", "string")) {
1587
- diagnostics.errors.push(`binding should have a string "name" field.`);
1588
- isValid = false;
1589
- }
1590
- if (isRequiredProperty(value, "type", "string")) {
1591
- const safeBindings = [
1592
- "plain_text",
1593
- "json",
1594
- "wasm_module",
1595
- "data_blob",
1596
- "text_blob",
1597
- "kv_namespace",
1598
- "durable_object_namespace",
1599
- "d1_database",
1600
- "r2_bucket",
1601
- "service",
1602
- "logfwdr",
1603
- "mtls_certificate",
1604
- ];
1605
-
1606
- if (safeBindings.includes(value.type)) {
1607
- diagnostics.warnings.push(
1608
- `The binding type "${value.type}" is directly supported by wrangler.\n` +
1609
- `Consider migrating this unsafe binding to a format for '${value.type}' bindings that is supported by wrangler for optimal support.\n` +
1610
- "For more details, see https://developers.cloudflare.com/workers/cli-wrangler/configuration"
1611
- );
1612
- }
1613
- } else {
1614
- diagnostics.errors.push(`binding should have a string "type" field.`);
1615
- isValid = false;
1616
- }
1617
- return isValid;
1618
- };
1619
-
1620
- /**
1621
- * Check that the given environment field is a valid array of bindings.
1622
- */
1623
- const validateBindingArray =
1624
- (envName: string, validateBinding: ValidatorFn): ValidatorFn =>
1625
- (diagnostics, field, envValue, config) => {
1626
- if (envValue === undefined) {
1627
- return true;
1628
- }
1629
-
1630
- const fieldPath =
1631
- config === undefined ? `${field}` : `env.${envName}.${field}`;
1632
- if (!Array.isArray(envValue)) {
1633
- diagnostics.errors.push(
1634
- `The field "${fieldPath}" should be an array but got ${JSON.stringify(
1635
- envValue
1636
- )}.`
1637
- );
1638
- return false;
1639
- }
1640
-
1641
- let isValid = true;
1642
- for (let i = 0; i < envValue.length; i++) {
1643
- isValid =
1644
- validateBinding(
1645
- diagnostics,
1646
- `${fieldPath}[${i}]`,
1647
- envValue[i],
1648
- config
1649
- ) && isValid;
1650
- }
1651
- const configValue = config?.[field as keyof Environment] as {
1652
- binding: unknown;
1653
- }[];
1654
- if (Array.isArray(configValue)) {
1655
- const configBindingNames = configValue.map((value) => value.binding);
1656
- // If there are no top level bindings then there is nothing to do here.
1657
- if (configBindingNames.length > 0) {
1658
- const envBindingNames = new Set(envValue.map((value) => value.binding));
1659
- for (const configBindingName of configBindingNames) {
1660
- if (!envBindingNames.has(configBindingName)) {
1661
- diagnostics.warnings.push(
1662
- `There is a ${field} binding with name "${configBindingName}" at the top level, but not on "env.${envName}".\n` +
1663
- `This is not what you probably want, since "${field}" configuration is not inherited by environments.\n` +
1664
- `Please add a binding for "${configBindingName}" to "env.${envName}.${field}.bindings".`
1665
- );
1666
- }
1667
- }
1668
- }
1669
- }
1670
- return isValid;
1671
- };
1672
-
1673
- const validateKVBinding: ValidatorFn = (diagnostics, field, value) => {
1674
- if (typeof value !== "object" || value === null) {
1675
- diagnostics.errors.push(
1676
- `"kv_namespaces" bindings should be objects, but got ${JSON.stringify(
1677
- value
1678
- )}`
1679
- );
1680
- return false;
1681
- }
1682
- let isValid = true;
1683
- // KV bindings must have a binding and id.
1684
- if (!isRequiredProperty(value, "binding", "string")) {
1685
- diagnostics.errors.push(
1686
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1687
- value
1688
- )}.`
1689
- );
1690
- isValid = false;
1691
- }
1692
- if (
1693
- !isRequiredProperty(value, "id", "string") ||
1694
- (value as { id: string }).id.length === 0
1695
- ) {
1696
- diagnostics.errors.push(
1697
- `"${field}" bindings should have a string "id" field but got ${JSON.stringify(
1698
- value
1699
- )}.`
1700
- );
1701
- isValid = false;
1702
- }
1703
- if (!isOptionalProperty(value, "preview_id", "string")) {
1704
- diagnostics.errors.push(
1705
- `"${field}" bindings should, optionally, have a string "preview_id" field but got ${JSON.stringify(
1706
- value
1707
- )}.`
1708
- );
1709
- isValid = false;
1710
- }
1711
- return isValid;
1712
- };
1713
-
1714
- const validateQueueBinding: ValidatorFn = (diagnostics, field, value) => {
1715
- if (typeof value !== "object" || value === null) {
1716
- diagnostics.errors.push(
1717
- `"queue" bindings should be objects, but got ${JSON.stringify(value)}`
1718
- );
1719
- return false;
1720
- }
1721
-
1722
- if (
1723
- !validateAdditionalProperties(diagnostics, field, Object.keys(value), [
1724
- "binding",
1725
- "queue",
1726
- ])
1727
- ) {
1728
- return false;
1729
- }
1730
-
1731
- // Queue bindings must have a binding and queue.
1732
- let isValid = true;
1733
- if (!isRequiredProperty(value, "binding", "string")) {
1734
- diagnostics.errors.push(
1735
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1736
- value
1737
- )}.`
1738
- );
1739
- isValid = false;
1740
- }
1741
- if (
1742
- !isRequiredProperty(value, "queue", "string") ||
1743
- (value as { queue: string }).queue.length === 0
1744
- ) {
1745
- diagnostics.errors.push(
1746
- `"${field}" bindings should have a string "queue" field but got ${JSON.stringify(
1747
- value
1748
- )}.`
1749
- );
1750
- isValid = false;
1751
- }
1752
- return isValid;
1753
- };
1754
-
1755
- const validateR2Binding: ValidatorFn = (diagnostics, field, value) => {
1756
- if (typeof value !== "object" || value === null) {
1757
- diagnostics.errors.push(
1758
- `"r2_buckets" bindings should be objects, but got ${JSON.stringify(
1759
- value
1760
- )}`
1761
- );
1762
- return false;
1763
- }
1764
- let isValid = true;
1765
- // R2 bindings must have a binding and bucket_name.
1766
- if (!isRequiredProperty(value, "binding", "string")) {
1767
- diagnostics.errors.push(
1768
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1769
- value
1770
- )}.`
1771
- );
1772
- isValid = false;
1773
- }
1774
- if (
1775
- !isRequiredProperty(value, "bucket_name", "string") ||
1776
- (value as { bucket_name: string }).bucket_name.length === 0
1777
- ) {
1778
- diagnostics.errors.push(
1779
- `"${field}" bindings should have a string "bucket_name" field but got ${JSON.stringify(
1780
- value
1781
- )}.`
1782
- );
1783
- isValid = false;
1784
- }
1785
- if (!isOptionalProperty(value, "preview_bucket_name", "string")) {
1786
- diagnostics.errors.push(
1787
- `"${field}" bindings should, optionally, have a string "preview_bucket_name" field but got ${JSON.stringify(
1788
- value
1789
- )}.`
1790
- );
1791
- isValid = false;
1792
- }
1793
- return isValid;
1794
- };
1795
-
1796
- const validateD1Binding: ValidatorFn = (diagnostics, field, value) => {
1797
- if (typeof value !== "object" || value === null) {
1798
- diagnostics.errors.push(
1799
- `"d1_databases" bindings should be objects, but got ${JSON.stringify(
1800
- value
1801
- )}`
1802
- );
1803
- return false;
1804
- }
1805
- let isValid = true;
1806
- // D1 databases must have a binding and either a database_name or database_id.
1807
- if (!isRequiredProperty(value, "binding", "string")) {
1808
- diagnostics.errors.push(
1809
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1810
- value
1811
- )}.`
1812
- );
1813
- isValid = false;
1814
- }
1815
- if (
1816
- // TODO: allow name only, where we look up the ID dynamically
1817
- // !isOptionalProperty(value, "database_name", "string") &&
1818
- !isRequiredProperty(value, "database_id", "string")
1819
- ) {
1820
- diagnostics.errors.push(
1821
- `"${field}" bindings must have a "database_id" field but got ${JSON.stringify(
1822
- value
1823
- )}.`
1824
- );
1825
- isValid = false;
1826
- }
1827
- if (!isOptionalProperty(value, "preview_database_id", "string")) {
1828
- diagnostics.errors.push(
1829
- `"${field}" bindings should, optionally, have a string "preview_database_id" field but got ${JSON.stringify(
1830
- value
1831
- )}.`
1832
- );
1833
- isValid = false;
1834
- }
1835
- if (isValid && !process.env.NO_D1_WARNING) {
1836
- diagnostics.warnings.push(
1837
- "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>`"
1838
- );
1839
- }
1840
- return isValid;
1841
- };
1842
-
1843
- /**
1844
- * Check that bindings whose names might conflict, don't.
1845
- *
1846
- * We don't want to have, for example, a KV namespace named "DATA"
1847
- * and a Durable Object also named "DATA". Then it would be ambiguous
1848
- * what exactly would live at `env.DATA` (or in the case of service-workers,
1849
- * the `DATA` global).
1850
- */
1851
- const validateBindingsHaveUniqueNames = (
1852
- diagnostics: Diagnostics,
1853
- {
1854
- durable_objects,
1855
- kv_namespaces,
1856
- r2_buckets,
1857
- analytics_engine_datasets,
1858
- text_blobs,
1859
- unsafe,
1860
- vars,
1861
- define,
1862
- wasm_modules,
1863
- data_blobs,
1864
- }: Partial<Config>
1865
- ): boolean => {
1866
- let hasDuplicates = false;
1867
-
1868
- const bindingsGroupedByType = {
1869
- "Durable Object": getBindingNames(durable_objects),
1870
- "KV Namespace": getBindingNames(kv_namespaces),
1871
- "R2 Bucket": getBindingNames(r2_buckets),
1872
- "Analytics Engine Dataset": getBindingNames(analytics_engine_datasets),
1873
- "Text Blob": getBindingNames(text_blobs),
1874
- Unsafe: getBindingNames(unsafe),
1875
- "Environment Variable": getBindingNames(vars),
1876
- Definition: getBindingNames(define),
1877
- "WASM Module": getBindingNames(wasm_modules),
1878
- "Data Blob": getBindingNames(data_blobs),
1879
- } as Record<string, string[]>;
1880
-
1881
- const bindingsGroupedByName: Record<string, string[]> = {};
1882
-
1883
- for (const bindingType in bindingsGroupedByType) {
1884
- const bindingNames = bindingsGroupedByType[bindingType];
1885
-
1886
- for (const bindingName of bindingNames) {
1887
- if (!(bindingName in bindingsGroupedByName)) {
1888
- bindingsGroupedByName[bindingName] = [];
1889
- }
1890
-
1891
- bindingsGroupedByName[bindingName].push(bindingType);
1892
- }
1893
- }
1894
-
1895
- for (const bindingName in bindingsGroupedByName) {
1896
- const bindingTypes = bindingsGroupedByName[bindingName];
1897
- if (bindingTypes.length < 2) {
1898
- // there's only one (or zero) binding(s) with this name, which is fine, actually
1899
- continue;
1900
- }
1901
-
1902
- hasDuplicates = true;
1903
-
1904
- // there's two types of duplicates we want to look for:
1905
- // - bindings with the same name of the same type (e.g. two Durable Objects both named "OBJ")
1906
- // - bindings with the same name of different types (a KV namespace and DO both named "DATA")
1907
-
1908
- const sameType = bindingTypes
1909
- // filter once to find duplicate binding types
1910
- .filter((type, i) => bindingTypes.indexOf(type) !== i)
1911
- // filter twice to only get _unique_ duplicate binding types
1912
- .filter(
1913
- (type, i, duplicateBindingTypes) =>
1914
- duplicateBindingTypes.indexOf(type) === i
1915
- );
1916
-
1917
- const differentTypes = bindingTypes.filter(
1918
- (type, i) => bindingTypes.indexOf(type) === i
1919
- );
1920
-
1921
- if (differentTypes.length > 1) {
1922
- // we have multiple different types using the same name
1923
- diagnostics.errors.push(
1924
- `${bindingName} assigned to ${ENGLISH.format(differentTypes)} bindings.`
1925
- );
1926
- }
1927
-
1928
- sameType.forEach((bindingType) => {
1929
- diagnostics.errors.push(
1930
- `${bindingName} assigned to multiple ${bindingType} bindings.`
1931
- );
1932
- });
1933
- }
1934
-
1935
- if (hasDuplicates) {
1936
- const problem =
1937
- "Bindings must have unique names, so that they can all be referenced in the worker.";
1938
- const resolution = "Please change your bindings to have unique names.";
1939
- diagnostics.errors.push(`${problem}\n${resolution}`);
1940
- }
1941
-
1942
- return !hasDuplicates;
1943
- };
1944
-
1945
- const validateServiceBinding: ValidatorFn = (diagnostics, field, value) => {
1946
- if (typeof value !== "object" || value === null) {
1947
- diagnostics.errors.push(
1948
- `"services" bindings should be objects, but got ${JSON.stringify(value)}`
1949
- );
1950
- return false;
1951
- }
1952
- let isValid = true;
1953
- // Service bindings must have a binding, service, and environment.
1954
- if (!isRequiredProperty(value, "binding", "string")) {
1955
- diagnostics.errors.push(
1956
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1957
- value
1958
- )}.`
1959
- );
1960
- isValid = false;
1961
- }
1962
- if (!isRequiredProperty(value, "service", "string")) {
1963
- diagnostics.errors.push(
1964
- `"${field}" bindings should have a string "service" field but got ${JSON.stringify(
1965
- value
1966
- )}.`
1967
- );
1968
- isValid = false;
1969
- }
1970
- if (!isOptionalProperty(value, "environment", "string")) {
1971
- diagnostics.errors.push(
1972
- `"${field}" bindings should have a string "environment" field but got ${JSON.stringify(
1973
- value
1974
- )}.`
1975
- );
1976
- isValid = false;
1977
- }
1978
- return isValid;
1979
- };
1980
-
1981
- const validateAnalyticsEngineBinding: ValidatorFn = (
1982
- diagnostics,
1983
- field,
1984
- value
1985
- ) => {
1986
- if (typeof value !== "object" || value === null) {
1987
- diagnostics.errors.push(
1988
- `"analytics_engine" bindings should be objects, but got ${JSON.stringify(
1989
- value
1990
- )}`
1991
- );
1992
- return false;
1993
- }
1994
- let isValid = true;
1995
- // Service bindings must have a binding and optional dataset.
1996
- if (!isRequiredProperty(value, "binding", "string")) {
1997
- diagnostics.errors.push(
1998
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
1999
- value
2000
- )}.`
2001
- );
2002
- isValid = false;
2003
- }
2004
- if (
2005
- !isOptionalProperty(value, "dataset", "string") ||
2006
- (value as { dataset: string }).dataset?.length === 0
2007
- ) {
2008
- diagnostics.errors.push(
2009
- `"${field}" bindings should, optionally, have a string "dataset" field but got ${JSON.stringify(
2010
- value
2011
- )}.`
2012
- );
2013
- isValid = false;
2014
- }
2015
- return isValid;
2016
- };
2017
-
2018
- const validateWorkerNamespaceBinding: ValidatorFn = (
2019
- diagnostics,
2020
- field,
2021
- value
2022
- ) => {
2023
- if (typeof value !== "object" || value === null) {
2024
- diagnostics.errors.push(
2025
- `"${field}" binding should be objects, but got ${JSON.stringify(value)}`
2026
- );
2027
- return false;
2028
- }
2029
- let isValid = true;
2030
- // Worker namespace bindings must have a binding, and a namespace.
2031
- if (!isRequiredProperty(value, "binding", "string")) {
2032
- diagnostics.errors.push(
2033
- `"${field}" should have a string "binding" field but got ${JSON.stringify(
2034
- value
2035
- )}.`
2036
- );
2037
- isValid = false;
2038
- }
2039
- if (!isRequiredProperty(value, "namespace", "string")) {
2040
- diagnostics.errors.push(
2041
- `"${field}" should have a string "namespace" field but got ${JSON.stringify(
2042
- value
2043
- )}.`
2044
- );
2045
- isValid = false;
2046
- }
2047
- return isValid;
2048
- };
2049
-
2050
- const validateMTlsCertificateBinding: ValidatorFn = (
2051
- diagnostics,
2052
- field,
2053
- value
2054
- ) => {
2055
- if (typeof value !== "object" || value === null) {
2056
- diagnostics.errors.push(
2057
- `"mtls_certificates" bindings should be objects, but got ${JSON.stringify(
2058
- value
2059
- )}`
2060
- );
2061
- return false;
2062
- }
2063
- let isValid = true;
2064
- if (!isRequiredProperty(value, "binding", "string")) {
2065
- diagnostics.errors.push(
2066
- `"${field}" bindings should have a string "binding" field but got ${JSON.stringify(
2067
- value
2068
- )}.`
2069
- );
2070
- isValid = false;
2071
- }
2072
- if (
2073
- !isRequiredProperty(value, "certificate_id", "string") ||
2074
- (value as { certificate_id: string }).certificate_id.length === 0
2075
- ) {
2076
- diagnostics.errors.push(
2077
- `"${field}" bindings should have a string "certificate_id" field but got ${JSON.stringify(
2078
- value
2079
- )}.`
2080
- );
2081
- isValid = false;
2082
- }
2083
- return isValid;
2084
- };
2085
-
2086
- function validateQueues(envName: string): ValidatorFn {
2087
- return (diagnostics, field, value, config) => {
2088
- const fieldPath =
2089
- config === undefined ? `${field}` : `env.${envName}.${field}`;
2090
-
2091
- if (typeof value !== "object" || Array.isArray(value) || value === null) {
2092
- diagnostics.errors.push(
2093
- `The field "${fieldPath}" should be an object but got ${JSON.stringify(
2094
- value
2095
- )}.`
2096
- );
2097
- return false;
2098
- }
2099
-
2100
- let isValid = true;
2101
- if (
2102
- !validateAdditionalProperties(
2103
- diagnostics,
2104
- fieldPath,
2105
- Object.keys(value),
2106
- ["consumers", "producers"]
2107
- )
2108
- ) {
2109
- isValid = false;
2110
- }
2111
-
2112
- if (hasProperty(value, "consumers")) {
2113
- const consumers = value.consumers;
2114
- if (!Array.isArray(consumers)) {
2115
- diagnostics.errors.push(
2116
- `The field "${fieldPath}.consumers" should be an array but got ${JSON.stringify(
2117
- consumers
2118
- )}.`
2119
- );
2120
- isValid = false;
2121
- }
2122
-
2123
- for (let i = 0; i < consumers.length; i++) {
2124
- const consumer = consumers[i];
2125
- const consumerPath = `${fieldPath}.consumers[${i}]`;
2126
- if (!validateConsumer(diagnostics, consumerPath, consumer, config)) {
2127
- isValid = false;
2128
- }
2129
- }
2130
- }
2131
-
2132
- if (hasProperty(value, "producers")) {
2133
- if (
2134
- !validateBindingArray(envName, validateQueueBinding)(
2135
- diagnostics,
2136
- `${field}.producers`,
2137
- value.producers,
2138
- config
2139
- )
2140
- ) {
2141
- isValid = false;
2142
- }
2143
- }
2144
- return isValid;
2145
- };
2146
- }
2147
-
2148
- const validateConsumer: ValidatorFn = (diagnostics, field, value, _config) => {
2149
- if (typeof value !== "object" || value === null) {
2150
- diagnostics.errors.push(
2151
- `"${field}" should be a objects, but got ${JSON.stringify(value)}`
2152
- );
2153
- return false;
2154
- }
2155
-
2156
- let isValid = true;
2157
- if (
2158
- !validateAdditionalProperties(diagnostics, field, Object.keys(value), [
2159
- "queue",
2160
- "max_batch_size",
2161
- "max_batch_timeout",
2162
- "max_retries",
2163
- "dead_letter_queue",
2164
- ])
2165
- ) {
2166
- isValid = false;
2167
- }
2168
-
2169
- if (!isRequiredProperty(value, "queue", "string")) {
2170
- diagnostics.errors.push(
2171
- `"${field}" should have a string "queue" field but got ${JSON.stringify(
2172
- value
2173
- )}.`
2174
- );
2175
- }
2176
-
2177
- const options: {
2178
- key: string;
2179
- type: "number" | "string";
2180
- }[] = [
2181
- { key: "max_batch_size", type: "number" },
2182
- { key: "max_batch_timeout", type: "number" },
2183
- { key: "max_retries", type: "number" },
2184
- { key: "dead_letter_queue", type: "string" },
2185
- ];
2186
- for (const optionalOpt of options) {
2187
- if (!isOptionalProperty(value, optionalOpt.key, optionalOpt.type)) {
2188
- diagnostics.errors.push(
2189
- `"${field}" should, optionally, have a ${optionalOpt.type} "${
2190
- optionalOpt.key
2191
- }" field but got ${JSON.stringify(value)}.`
2192
- );
2193
- isValid = false;
2194
- }
2195
- }
2196
-
2197
- return isValid;
2198
- };