fix: implement user preferences migration logic to ensure compatibility with versioning

Author: arunjaindev

src/Shared/Hooks/useUserPreferences/service.ts

@@ -178,6 +178,33 @@ export const updateUserPreferences = async ({
     }
 }
 
+const migrateUserPreferences = async () => {
+    try {
+        const userPreferences: UserPreferencesType = await JSON.parse(
+            localStorage.getItem(USER_PREFERENCES_ATTRIBUTE_KEY),
+        )
+        if (userPreferences && userPreferences.version !== 'v1') {
+            const migratedPreferences: UserPreferencesType = {
+                ...userPreferences,
+                resources: {
+                    ...userPreferences.resources,
+                    [ResourceKindType.devtronApplication]: {
+                        [UserPreferenceResourceActions.RECENTLY_VISITED]: (
+                            userPreferences.resources?.[ResourceKindType.devtronApplication]?.[
+                                UserPreferenceResourceActions.RECENTLY_VISITED
+                            ] || []
+                        ).map(({ id, name }) => ({ id: +id, name })),
+                    },
+                },
+                version: 'v1',
+            }
+            localStorage.setItem(USER_PREFERENCES_ATTRIBUTE_KEY, JSON.stringify(migratedPreferences))
+        }
+    } catch {
+        // do nothing
+    }
+}
+
 /**
  * Optimized function to get updated user preferences with resource filtering
  * Can work with provided userPreferences or fetch from server/localStorage
@@ -191,6 +218,8 @@ const getUpdatedUserPreferences = async ({
 }: UserPreferenceFilteredListTypes & {
     userPreferencesResponse?: UserPreferencesType
 }): Promise<UserPreferencesType> => {
+    await migrateUserPreferences()
+
     // Get base user preferences from multiple sources (priority: provided > localStorage > server)
     let baseUserPreferences: UserPreferencesType
 
@@ -231,33 +260,6 @@ const getUpdatedUserPreferences = async ({
     }
 }
 
-const migrateUserPreferences = async () => {
-    try {
-        const userPreferences: UserPreferencesType = await JSON.parse(
-            localStorage.getItem(USER_PREFERENCES_ATTRIBUTE_KEY),
-        )
-        if (userPreferences && userPreferences.version !== 'v1') {
-            const migratedPreferences: UserPreferencesType = {
-                ...userPreferences,
-                resources: {
-                    ...userPreferences.resources,
-                    [ResourceKindType.devtronApplication]: {
-                        [UserPreferenceResourceActions.RECENTLY_VISITED]: (
-                            userPreferences.resources?.[ResourceKindType.devtronApplication]?.[
-                                UserPreferenceResourceActions.RECENTLY_VISITED
-                            ] || []
-                        ).map(({ id, name }) => ({ id: +id, name })),
-                    },
-                },
-                version: userPreferences.version ?? 'v1',
-            }
-            localStorage.setItem(USER_PREFERENCES_ATTRIBUTE_KEY, JSON.stringify(migratedPreferences))
-        }
-    } catch {
-        // do nothing
-    }
-}
-
 /**
  * Centralized function to update and persist user preferences
  * Handles both local state and server updates automatically
@@ -283,8 +285,6 @@ export const updateAndPersistUserPreferences = async ({
         resourceKind,
     })
 
-    await migrateUserPreferences()
-
     // Update localStorage if requested
     if (updateLocalStorage) {
         localStorage.setItem(USER_PREFERENCES_ATTRIBUTE_KEY, JSON.stringify(updatedPreferences))