wrangler 2.20.0 → 3.0.0

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