Fix backward compatibility issues in config file migration. Closes #2042

turbot · May 11, 2022 · b226aa3 · b226aa3
1 parent b0adb24
commit b226aa3
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/ociinstaller/versionfile/db_version_file.go b/ociinstaller/versionfile/db_version_file.go
@@ -85,6 +85,11 @@ func readDatabaseVersionFile(path string) (*DatabaseVersionFile, error) {
 func (f *DatabaseVersionFile) Save() error {
 	// set the struct version
 	f.StructVersion = DatabaseStructVersion
+	// maintain the legacy properties for backward compatibility
+	f.LegacyFdwExtension = f.FdwExtension
+	f.LegacyFdwExtension.MaintainLegacy()
+	f.LegacyEmbeddedDB = f.EmbeddedDB
+	f.LegacyEmbeddedDB.MaintainLegacy()
 
 	versionFilePath := filepaths.DatabaseVersionFilePath()
 	return f.write(versionFilePath)

diff --git a/ociinstaller/versionfile/installed_version.go b/ociinstaller/versionfile/installed_version.go
@@ -24,3 +24,12 @@ func (f *InstalledVersion) MigrateLegacy() {
 	f.InstallDate = f.LegacyInstallDate
 	f.LastCheckedDate = f.LegacyLastCheckedDate
 }
+
+// MaintainLegacy keeps the values of the legacy properties for backward
+// compatibility
+func (f *InstalledVersion) MaintainLegacy() {
+	f.LegacyImageDigest = f.ImageDigest
+	f.LegacyInstalledFrom = f.InstalledFrom
+	f.LegacyInstallDate = f.InstallDate
+	f.LegacyLastCheckedDate = f.LastCheckedDate
+}
diff --git a/ociinstaller/versionfile/plugin_version_file.go b/ociinstaller/versionfile/plugin_version_file.go
@@ -58,6 +58,10 @@ func (f *PluginVersionFile) Save() error {
 	// set struct version
 	f.StructVersion = PluginStructVersion
 	versionFilePath := filepaths.PluginVersionFilePath()
+	// maintain the legacy properties for backward compatibility
+	for _, v := range f.Plugins {
+		v.MaintainLegacy()
+	}
 	return f.write(versionFilePath)
 }
 

diff --git a/statefile/state.go b/statefile/state.go
@@ -65,6 +65,9 @@ func (s *State) Save() error {
 	s.StructVersion = StateStructVersion
 
 	s.LastCheck = nowTimeString()
+	s.LegacyLastCheck = nowTimeString()
+	// maintain the legacy properties for backward compatibility
+	s.MaintainLegacy()
 	// ensure internal dirs exists
 	_ = os.MkdirAll(filepaths.EnsureInternalDir(), os.ModePerm)
 	stateFilePath := filepath.Join(filepaths.EnsureInternalDir(), filepaths.StateFileName())
@@ -90,6 +93,13 @@ func (s *State) MigrateFrom() migrate.Migrateable {
 	return s
 }
 
+// MaintainLegacy keeps the values of the legacy properties for backward
+// compatibility
+func (s *State) MaintainLegacy() {
+	s.LegacyLastCheck = s.LastCheck
+	s.LegacyInstallationID = s.InstallationID
+}
+
 func newInstallationID() string {
 	return uuid.New().String()
 }