Update pending versions metadata on check for updates (#5475)

* Update pending versions metadata on check for updates

Author: sgalsaleh

pkg/store/kotsstore/version_store.go

@@ -957,6 +957,24 @@ func (s *KOTSStore) GetCurrentUpdateCursor(appID string, channelID string) (stri
 	return updateCursor.String, nil
 }
 
+func (s *KOTSStore) UpdateAppVersionMetadata(appID string, update upstreamtypes.Update) error {
+	db := persistence.MustGetDBSession()
+
+	query := `UPDATE app_version 
+			 SET is_required = ?, version_label = ?, release_notes = ? 
+			 WHERE app_id = ? AND channel_id = ? AND update_cursor = ?`
+
+	_, err := db.WriteOneParameterized(gorqlite.ParameterizedStatement{
+		Query:     query,
+		Arguments: []interface{}{update.IsRequired, update.VersionLabel, update.ReleaseNotes, appID, update.ChannelID, update.Cursor},
+	})
+	if err != nil {
+		return fmt.Errorf("update app version metadata: %v", err)
+	}
+
+	return nil
+}
+
 func (s *KOTSStore) HasStrictPreflights(appID string, sequence int64) (bool, error) {
 	var preflightSpecStr gorqlite.NullString
 	db := persistence.MustGetDBSession()

pkg/store/mock/mock.go

@@ -190,6 +190,7 @@ type VersionStore interface {
 	UpdateNextAppVersionDiffSummary(appID string, baseSequence int64) error
 	GetNextAppSequence(appID string) (int64, error)
 	GetCurrentUpdateCursor(appID string, channelID string) (string, error)
+	UpdateAppVersionMetadata(appID string, update upstreamtypes.Update) error
 	HasStrictPreflights(appID string, sequence int64) (bool, error)
 	GetEmbeddedClusterConfigForVersion(appID string, sequence int64) (*embeddedclusterv1beta1.Config, error)
 }

pkg/store/store_interface.go

@@ -274,6 +274,10 @@ func checkForKotsAppUpdates(opts types.CheckForUpdatesOpts, finishedChan chan<-
 		return nil, errors.Errorf("no app versions found for app %s in downstream %s", opts.AppID, d.ClusterID)
 	}
 
+	if err := maybeUpdatePendingVersionsMetadata(a.ID, getUpdatesOptions, appVersions.CurrentVersion); err != nil {
+		logger.Error(errors.Wrap(err, "failed to update app version metadata"))
+	}
+
 	filteredUpdates := removeOldUpdates(updates.Updates, appVersions, licenseChan.IsSemverRequired)
 
 	var availableReleases []types.UpdateCheckRelease
@@ -333,6 +337,40 @@ func checkForKotsAppUpdates(opts types.CheckForUpdatesOpts, finishedChan chan<-
 	return &ucr, nil
 }
 
+// maybeUpdatePendingVersionsMetadata updates metadata for pending versions since the currently deployed version.
+//
+// Limitations:
+// - Only gets pending releases for the channel of the currently deployed version, even if channel changed in later versions
+// - Does not rerender the application archive, so the Installation object in the archive can become out of sync
+// - This is not in the critical path - errors are logged but don't fail the overall update check
+func maybeUpdatePendingVersionsMetadata(appID string, getUpdatesOptions kotspull.GetUpdatesOptions, currentVersion *downstreamtypes.DownstreamVersion) error {
+	if currentVersion == nil {
+		return nil
+	}
+
+	// update options to use info from the currently deployed version
+	getUpdatesOptions.CurrentCursor = currentVersion.UpdateCursor
+	getUpdatesOptions.CurrentChannelID = currentVersion.ChannelID
+	getUpdatesOptions.ChannelChanged = false // we want the api to return pending updates after the currently deployed version even if channel changed in later versions
+	if currentVersion.KOTSKinds != nil {
+		getUpdatesOptions.CurrentChannelName = currentVersion.KOTSKinds.Installation.Spec.ChannelName
+	} else {
+		getUpdatesOptions.CurrentChannelName = ""
+	}
+
+	updates, err := kotspull.GetUpdates(fmt.Sprintf("replicated://%s", getUpdatesOptions.License.Spec.AppSlug), getUpdatesOptions)
+	if err != nil {
+		return errors.Wrap(err, "get updates for metadata refresh")
+	}
+
+	for _, update := range updates.Updates {
+		if err := store.UpdateAppVersionMetadata(appID, update); err != nil {
+			logger.Error(errors.Wrapf(err, "failed to update app version metadata for %s", update.VersionLabel))
+		}
+	}
+	return nil
+}
+
 func downloadAppUpdates(opts types.CheckForUpdatesOpts, appID string, clusterID string, updates []upstreamtypes.Update, updateCheckTime time.Time) error {
 	for index, update := range updates {
 		appSequence, err := upstream.DownloadUpdate(appID, update, opts.SkipPreflights, opts.SkipCompatibilityCheck)

pkg/updatechecker/updatechecker.go

@@ -122,7 +122,6 @@ type State = {
   loadingVersionHistory: boolean;
   logs: Object | null;
   logsLoading: boolean;
-  noUpdateAvailiableText: string;
   numOfRemainingVersions: number;
   numOfSkippedVersions: number;
   pageSize: Number;
@@ -206,7 +205,6 @@ class AppVersionHistory extends Component<Props, State> {
       loadingVersionHistory: true,
       logs: null,
       logsLoading: false,
-      noUpdateAvailiableText: "",
       numOfRemainingVersions: 0,
       numOfSkippedVersions: 0,
       pageSize: 20,
@@ -992,25 +990,11 @@ class AppVersionHistory extends Component<Props, State> {
         const response = await res.json();
 
         if (response.availableUpdates === 0) {
-          if (
-            !find(this.state.versionHistory, {
-              parentSequence: response.currentAppSequence,
-            })
-          ) {
-            // version history list is out of sync - most probably because of automatic updates happening in the background - refetch list
-            this.fetchKotsDownstreamHistory();
-            this.setState({ checkingForUpdates: false });
-          } else {
-            this.setState({
-              checkingForUpdates: false,
-              noUpdateAvailiableText: "There are no updates available",
-            });
-            setTimeout(() => {
-              this.setState({
-                noUpdateAvailiableText: "",
-              });
-            }, 3000);
-          }
+          // refresh version history list as it can be out of sync because of:
+          // 1. automatic updates happening in the background
+          // 2. there can be metadata updates to pending versions already in the version history list
+          this.fetchKotsDownstreamHistory();
+          this.setState({ checkingForUpdates: false });
         } else {
           this.state.appUpdateChecker.start(this.getAppUpdateStatus, 1000);
         }