fix: ensure that non-inherited fields are not removed when using an inferred named environment #7478
+90
−63
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 50f5b2e The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
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 |
|
I can confirm that the updated tests fail without this fix. |
petebacondarwin
commented
Dec 6, 2024
| env: { | ||
| DEV: { | ||
| account_id: "some_account_id", | ||
| it("should error if named environment contains a `account_id` field, even if there is no top-level name", () => { |
There was a problem hiding this comment.
This whole section has just been moved inside the "non-legacy" describe block as that is what they are related to. There is no code change here.
|
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/12282151899/npm-package-wrangler-7478You can reference the automatically updated head of this PR with: npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/7478/npm-package-wrangler-7478Or you can use npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12282151899/npm-package-wrangler-7478 dev path/to/script.jsAdditional artifacts:npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12282151899/npm-package-create-cloudflare-7478 --no-auto-updatenpm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12282151899/npm-package-cloudflare-kv-asset-handler-7478npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12282151899/npm-package-miniflare-7478npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12282151899/npm-package-cloudflare-pages-shared-7478npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12282151899/npm-package-cloudflare-vitest-pool-workers-7478npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12282151899/npm-package-cloudflare-workers-editor-shared-7478npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12282151899/npm-package-cloudflare-workers-shared-7478npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12282151899/npm-package-cloudflare-workflows-shared-7478Note that these links will no longer work once the GitHub Actions artifact expires.
Please ensure constraints are pinned, and |
jamesopstad
reviewed
Dec 6, 2024
Comment on lines
+72
to
+76
| // `rawEnv === topLevelEnv` is a special case where the user has provided an environment name | ||
| // but that named environment is not actually defined in the configuration. | ||
| // In that case we have reused the topLevelEnv as the rawEnv, | ||
| // and so we need to process the `transformFn()` anyway rather than just using the field in the `rawEnv`. | ||
| (rawEnv !== topLevelEnv ? (rawEnv[field] as Environment[K]) : undefined) ?? |
There was a problem hiding this comment.
Trying to understand the need for the extra logic here. What would happen if it was left as it was?
There was a problem hiding this comment.
Without this the inherited field transform does not run. For example the name field gets transformed when it is inherited from 'my-worker' to 'my-worker-env'.
jamesopstad
approved these changes
Dec 9, 2024
80c4fc2 to
0d6a2f5
Compare
…nferred named environment It is an error for the the user to provide an environment name that doesn't match any of the named environments in the Wrangler configuration. But if there are no named environments defined at all in the Wrangler configuration, we special case the top-level environment as though it was a named environment. Previously, when this happens, we would remove all the nonInheritable fields from the configuration (essentially all the bindings) leaving an incorrect configuration. Now we correctly generate a flattened named environment that has the nonInheritable fields, plus correctly applies any transformFn on inheritable fields.
0d6a2f5 to
50f5b2e
Compare
penalosa
approved these changes
Dec 12, 2024
Merged
penalosa
pushed a commit
that referenced
this pull request
Jan 10, 2025
…nferred named environment (#7478) It is an error for the the user to provide an environment name that doesn't match any of the named environments in the Wrangler configuration. But if there are no named environments defined at all in the Wrangler configuration, we special case the top-level environment as though it was a named environment. Previously, when this happens, we would remove all the nonInheritable fields from the configuration (essentially all the bindings) leaving an incorrect configuration. Now we correctly generate a flattened named environment that has the nonInheritable fields, plus correctly applies any transformFn on inheritable fields.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #0000
It is an error for the the user to provide an environment name that doesn't match any of the named environments in the Wrangler configuration. But if there are no named environments defined at all in the Wrangler configuration, we special case the top-level environment as though it was a named environment. Previously, when this happens, we would remove all the nonInheritable fields from the configuration (essentially all the bindings) leaving an incorrect configuration. Now we correctly generate a flattened named environment that has the nonInheritable fields, plus correctly applies any transformFn on inheritable fields.