fix cluster upgrade modal not showing intermittently #4488
Merged
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
cbodonnell
force-pushed
the
cbo/upgrade-modal-shows-intermittently
branch
from
6b59453
to
3d5ba20
Compare
cbodonnell
commented
Mar 1, 2024
pkg/handlers/app.go
Outdated
Comment on lines
349
to
357
| cluster.NumInstallations = len(embeddedClusterInstallations) | ||
|
|
||
| latestEmbeddedClusterInstallation, err := embeddedcluster.GetLatestInstallation(context.TODO(), embeddedClusterInstallations) | ||
| if err != nil { | ||
| return nil, errors.Wrap(err, "failed to get latest installation") | ||
| } | ||
|
|
||
| if latestEmbeddedClusterInstallation != nil { | ||
| cluster.State = string(latestEmbeddedClusterInstallation.Status.State) |
There was a problem hiding this comment.
if the installation was just recently created, .Status.State may be empty. the goal here is to provide an additional piece of data numInstallations to the UI so it can make the proper determination of whether or not to show the modal in these cases if downtime occurs before it receives an actual state.
sgalsaleh
reviewed
Mar 4, 2024
sgalsaleh
reviewed
Mar 4, 2024
pkg/embeddedcluster/util.go
Outdated
| return installationList.Items, nil | ||
| } | ||
|
|
||
| func GetLatestInstallation(ctx context.Context, installations []embeddedclusterv1beta1.Installation) (*embeddedclusterv1beta1.Installation, error) { |
There was a problem hiding this comment.
IMO this function name is confusing because there's already a GetCurrentInstallation. Listing installations from the cluster isn't an expensive process, so I would suggest basically calling both ListInstallations and GetCurrentInstallation instead of trying to save a function call.
sgalsaleh
previously approved these changes
Mar 4, 2024
sgalsaleh
approved these changes
Mar 4, 2024
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.
What this PR does / why we need it:
This PR fixes a race condition issue in embedded clusters where the cluster upgrade modal would fail to show intermittently. This issue would arise if the new installation had been applied to the cluster, but had not yet had a
statereported back to the UI before downtime occurred. In this scenario, the UI was not able to determine whether a cluster upgrade was pending.This PR changes the app details response to also include the number of installation objects in the cluster. In this case, we can infer that if the latest installation does not yet have a state, but is not the only installation, then it has just recently been applied and a cluster upgrade may be pending. If there is not actually an upgrade pending, downtime will not occur and the UI will receive another update with the actual state shortly thereafter. If there is an upgrade pending, the downtime may begin before the UI receives an actual state, but with these changes will show the upgrade modal.
Which issue(s) this PR fixes:
https://app.shortcut.com/replicated/story/99951/cluster-upgrade-modal-fails-to-show-intermittently
Special notes for your reviewer:
Steps to reproduce
Does this PR introduce a user-facing change?
Does this PR require documentation?