Warn if unexpected key is in the toml

[Ankcorn]

What this PR solves / how to test

Fixes #5681

Author has addressed the following

• Tests
  • TODO (before merge)
  • Included
  • Not necessary because:
• Changeset (Changeset guidelines)
  • TODO (before merge)
  • Included
  • Not necessary because:
• Public documentation
  • TODO (before merge)
  • Cloudflare docs PR(s): https://github.com/cloudflare/cloudflare-docs/pull/...
  • Not necessary because:

[changeset-bot]

🦋 Changeset detected

Latest commit: da82270

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
wrangler	Minor
@cloudflare/vitest-pool-workers	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[petebacondarwin]

Thanks for improving the experience for Wrangler users. This looks like a great improvement. A couple of suggestions if you have time...

[petebacondarwin]

Thanks for creating this fixture. As it stands I don't think this is running any tests in the CI. We could do with a vitest.config.js and then an actual vitest test that runs Wrangler to trigger the config warnings.

[Ankcorn]

I'm not sure a full e2e test is warranted for this change. I realise I may have misunderstood the intent behind the fixtures when creating this. I treated it as more of an examples folder where I could put some code.

If you think it's best I'm happy to add one but looking through the existing tests in the repo a unit test here checking that the output contains the warnings would give me reasonable confidence in this change.

Thoughts?

[github-actions]

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8940208957/npm-package-wrangler-5689

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/5689/npm-package-wrangler-5689

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8940208957/npm-package-wrangler-5689 dev path/to/script.js

Additional artifacts:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8940208957/npm-package-create-cloudflare-5689 --no-auto-update

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8940208957/npm-package-cloudflare-kv-asset-handler-5689

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8940208957/npm-package-miniflare-5689

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8940208957/npm-package-cloudflare-pages-shared-5689

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8940208957/npm-package-cloudflare-vitest-pool-workers-5689

Note that these links will no longer work once the GitHub Actions artifact expires.

---

wrangler@3.53.1 includes the following runtime dependencies:

Package	Constraint	Resolved
miniflare	workspace:*	3.20240419.0
workerd	1.20240419.0	1.20240419.0
workerd --version	1.20240419.0	2024-04-19

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

[petebacondarwin]

Cool. Thanks for updating. Try running:

pnpm run fix

to sort out the formatting issues

The other failures are most likely flakes

[Ankcorn]

Thanks @petebacondarwin

I have ran those formatting checks.

Hopefully the CI flakes in my favour this time 😃

[Ankcorn]

The other thing that is worth flagging is I used the json schema and a script to generate the lists of optional fields so I didn't have to write them by hand.

There is a chance that a missing field in my configuration could lead to unexpected warnings in customers wrangler tomls.

I could think of a good way to verify this but here is the script I used.

const schema = require('./config-schema.json')

const environment = schema.definitions.Environment.properties

function generateCode(properties) {
	return `validateAdditionalProperties(diagnostics, field, Object.keys(value), [${
		properties.reduce((sum, el) => `${sum}\n\t"${el}",`, '')
	}
]);

	`
}
for(const service of schema.definitions.Environment.required) {
	console.log(service, '\n')
	const serviceConfig = environment[service].properties || environment[service].items

	if(serviceConfig && !serviceConfig.additionalProperties && serviceConfig.properties) {

		// Generate code
		console.log(generateCode(Object.keys(serviceConfig.properties)))
	} else if(serviceConfig) {
		for(const configuration of Object.values(serviceConfig)) {
			if(configuration.items?.additionalProperties === false) {
		                 // Generate code
				console.log(generateCode(Object.keys(configuration.items.properties)))
			}
		}
	}
}