detect nodejs side by side pulumi for inline automation programs and fail fast #7349
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
This was referenced Jul 21, 2021
joeduffy
reviewed
Jul 24, 2021
|
|
||
| // if we see a different identifier, another version of pulumi has been loaded and we should fail. | ||
| if (!!envSxS && envSxS !== sxsRandomIdentifier) { | ||
| throw new Error("Detected multiple versions of '@pulumi/pulumi' in use in an inline automation api program.\n" + |
There was a problem hiding this comment.
Would be good to think about how to possibly link to docs with an example resolution in errors like this.
justinvp
added a commit
that referenced
this pull request
Oct 10, 2023
This change removes the SxS check in the Node.js Automation API since it's blocking a customer scenario and isn't needed anymore now that #5449 has been addressed with #10568. The check was originally added in #7349 to provide a helpful error message when multiple versions of `@pulumi/pulumi` were used with inline programs, which could cause clashes with global state. Since then, we've changed how state is stored to allow parallel execution of multiple inline programs with #10568. However, the SxS checks were not removed as part of that change. A customer recently hit the error associated with the SxS check. They are creating a Next.js program that runs Pulumi operations as inline programs. Next.js ends up loading modules multiple times in a way that confuses the SxS checker, causing the error to be thrown, even though it wouldn't have been a problem.
justinvp
added a commit
that referenced
this pull request
Oct 10, 2023
This change removes the SxS check in the Node.js Automation API since it's blocking a customer scenario and isn't needed anymore now that #5449 has been addressed with #10568. The check was originally added in #7349 to provide a helpful error message when multiple versions of `@pulumi/pulumi` were used with inline programs, which could cause clashes with global state. Since then, we've changed how state is stored to allow parallel execution of multiple inline programs with #10568. However, the SxS checks were not removed as part of that change. A customer recently hit the error associated with the SxS check. They are creating a Next.js program that runs Pulumi operations as inline programs. Next.js ends up loading modules multiple times in a way that confuses the SxS checker, causing the error to be thrown, even though it wouldn't have been a problem.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 11, 2023
This change removes the SxS check in the Node.js Automation API since it's blocking a customer scenario and isn't needed anymore now that #5449 has been addressed with #10568. The check was originally added in #7349 to provide a helpful error message when multiple versions of `@pulumi/pulumi` were used with inline programs, which could cause clashes with global state. Since then, we've changed how state is stored to allow parallel execution of multiple inline programs with #10568. However, the SxS checks were not removed as part of that change. A customer recently hit the error associated with the SxS check. They are creating a Next.js program that runs Pulumi operations as inline programs. Next.js ends up loading modules multiple times in a way that confuses the SxS checker, causing the error to be thrown, even though it wouldn't have been a problem. Fixes #14128
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.
Description
This change detects when nodejs automation api inline programs load multiple instances of
@pulumi/pulumiand triggers an early failure with a helpful error message:Using multiple versions of pulumi/pulumi in inline programs can cause collisions in global state. Until we address #5449, inline node automation users need to pin to a single version of pulumi/pulumi to avoid issues like those seen in #6998
This change set adds a module level global (a random number) that each instance of pulumi/pulumi will write into the environment. We detect side by side scenarios by comparing the module level global to the value in the environment every time we observe settings, or do a resource operation (invoke, register resource, get, etc).
Fixes #7333
Checklist