Do not show Configuration diff for PreDeployments #879
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
dotNomad
requested review from
kgartland-rstudio,
mmarchetti,
sagerb and
tdstein
as code owners
dotNomad
commented
Jan 24, 2024
Comment on lines
+7
to
+11
| export const deploymentKey = Symbol('deployment') as InjectionKey< | ||
| PreDeployment | | ||
| Deployment | | ||
| DeploymentError | ||
| >; |
There was a problem hiding this comment.
This methodology is describe in Vue's docs under Typing Provide / Inject.
| const deployment = inject(deploymentKey); | ||
|
|
||
| const showDiff = computed((): boolean => { | ||
| const isPre = deployment ? isPreDeployment(deployment) : false; |
There was a problem hiding this comment.
We aren't guaranteed to get a deployment. There is no way in Vue to tell it we are for sure provided a key value, but we can easily default to the previous behavior of comparing just the values if we aren't provided a deployment.
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.
This PR avoids showing the Configuration diff view for each attribute in the configuration when looking at a
PreDeploymentIntent
Type of Change
Approach
The approach here was to avoid passing
deploymentdown to every Configuration component and checking if it was a pre-deployment. Instead we can check that directly in theConfigSetting.vuecomponent which determines whether or not to show the plaintext value or the diff views. To do this without a lot of nested props we can use Provide / Inject.Since all attributes are new (since this PreDeployment has never been deployed) we need to check if this is a
PreDeploymentso new attributes still work for Redeployments.