feat: Generalize user preferences as per resource kind

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@devtron-labs/devtron-fe-common-lib",
-    "version": "1.15.3-pre-4",
+    "version": "1.15.3-beta-3",
     "description": "Supporting common component library",
     "type": "module",
     "main": "dist/index.js",

src/Shared/Hooks/useUserPreferences/service.ts

@@ -18,7 +18,6 @@ import { ROUTES } from '@Common/Constants'
 import { get, getUrlWithSearchParams, patch, showError } from '@Common/index'
 import { THEME_PREFERENCE_MAP } from '@Shared/Providers/ThemeProvider/types'
 import { BaseAppMetaData } from '@Shared/Services'
-import { ResourceKindType } from '@Shared/types'
 
 import { USER_PREFERENCES_ATTRIBUTE_KEY } from './constants'
 import {
@@ -64,17 +63,9 @@ export const getUserPreferences = async (): Promise<UserPreferencesType> => {
             parsedResult.computedAppTheme === 'system-dark' || parsedResult.computedAppTheme === 'system-light'
                 ? THEME_PREFERENCE_MAP.auto
                 : parsedResult.computedAppTheme,
-        resources: {
-            [ResourceKindType.devtronApplication]: {
-                [UserPreferenceResourceActions.RECENTLY_VISITED]:
-                    parsedResult.resources?.[ResourceKindType.devtronApplication]?.[
-                        UserPreferenceResourceActions.RECENTLY_VISITED
-                    ] || ([] as BaseAppMetaData[]),
-            },
-        },
+        resources: parsedResult.resources,
     }
 }
-
 /**
  * @description This function updates the user preferences in the server. It constructs a payload with the updated user preferences and sends a PATCH request to the server. If the request is successful, it returns true. If an error occurs, it shows an error message and returns false.
  * @param updatedUserPreferences - The updated user preferences to be sent to the server.
@@ -87,6 +78,8 @@ export const getUserPreferences = async (): Promise<UserPreferencesType> => {
 const getUserPreferencePayload = async ({
     path,
     value,
+    resourceKind,
+    userPreferencesResponse,
 }: UserPathValueMapType): Promise<Partial<UserPreferencesPayloadValueType>> => {
     switch (path) {
         case 'themePreference':
@@ -100,10 +93,24 @@ const getUserPreferencePayload = async ({
                     value.pipelineRBACViewSelectedTab === ViewIsPipelineRBACConfiguredRadioTabs.ACCESS_ONLY,
             }
 
-        case 'resources':
+        case 'resources': {
+            const existingResources = userPreferencesResponse?.resources || {}
+
+            const updatedResources = {
+                ...existingResources,
+                [resourceKind]: {
+                    ...existingResources[resourceKind],
+                    [UserPreferenceResourceActions.RECENTLY_VISITED]:
+                        getUserPreferenceResourcesMetadata(value as BaseAppMetaData[], resourceKind)[resourceKind]?.[
+                            UserPreferenceResourceActions.RECENTLY_VISITED
+                        ] || [],
+                },
+            }
+
             return {
-                resources: getUserPreferenceResourcesMetadata(value as BaseAppMetaData[]),
+                resources: updatedResources,
             }
+        }
         default:
             return {}
     }
@@ -112,12 +119,21 @@ const getUserPreferencePayload = async ({
 export const updateUserPreferences = async ({
     path,
     value,
+    resourceKind,
     shouldThrowError = false,
+    userPreferencesResponse,
 }: UserPreferenceResourceProps): Promise<boolean> => {
     try {
         const payload: UpdateUserPreferencesPayloadType = {
             key: USER_PREFERENCES_ATTRIBUTE_KEY,
-            value: JSON.stringify(await getUserPreferencePayload({ path, value } as UserPathValueMapType)),
+            value: JSON.stringify(
+                await getUserPreferencePayload({
+                    path,
+                    value,
+                    resourceKind,
+                    userPreferencesResponse,
+                } as UserPathValueMapType),
+            ),
         }
 
         await patch(`${ROUTES.ATTRIBUTES_USER}/${ROUTES.PATCH}`, payload)

src/Shared/Hooks/useUserPreferences/types.ts

@@ -31,11 +31,23 @@ export enum ViewIsPipelineRBACConfiguredRadioTabs {
 export enum UserPreferenceResourceActions {
     RECENTLY_VISITED = 'recently-visited',
 }
+export type PreferredResourceKindType =
+    | ResourceKindType.devtronApplication
+    | ResourceKindType.job
+    | ResourceKindType.appGroup
+    | ResourceKindType.cluster
+
+export interface UserPreferenceRecentlyVisitedAppsTypes {
+    appId: number
+    appName: string
+    resourceKind: PreferredResourceKindType
+}
+
 export interface UserResourceKindActionType {
     [UserPreferenceResourceActions.RECENTLY_VISITED]: BaseAppMetaData[]
 }
-export interface UserPreferenceResourceType {
-    [ResourceKindType.devtronApplication]: UserResourceKindActionType
+export type UserPreferenceResourceType = {
+    [key in ResourceKindType]?: UserResourceKindActionType
 }
 export interface GetUserPreferencesParsedDTO {
     viewPermittedEnvOnly?: boolean
@@ -76,30 +88,33 @@ export interface UserPreferencesType {
 export interface UpdatedUserPreferencesType extends UserPreferencesType, Pick<ThemeConfigType, 'appTheme'> {}
 
 export interface UseUserPreferencesProps {
+    userPreferenceResourceKind?: ResourceKindType
     migrateUserPreferences?: (userPreferencesResponse: UserPreferencesType) => Promise<UserPreferencesType>
 }
 
 export type UserPathValueMapType =
     | {
           path: 'themePreference'
           value: Required<Pick<UpdatedUserPreferencesType, 'themePreference' | 'appTheme'>>
+          resourceKind?: never
+          userPreferencesResponse?: never
       }
     | {
           path: 'pipelineRBACViewSelectedTab'
           value: Required<Pick<UserPreferencesType, 'pipelineRBACViewSelectedTab'>>
+          resourceKind?: never
+          userPreferencesResponse?: never
       }
     | {
           path: 'resources'
           value: Required<BaseAppMetaData[]>
+          resourceKind: PreferredResourceKindType
+          userPreferencesResponse?
       }
 
 export type UserPreferenceResourceProps = UserPathValueMapType & {
     shouldThrowError?: boolean
-}
-
-export interface UserPreferenceRecentlyVisitedAppsTypes {
-    appId: number
-    appName: string
+    userPreferencesResponse?
 }
 
 export interface UserPreferenceFilteredListTypes extends UserPreferenceRecentlyVisitedAppsTypes {

src/Shared/Hooks/useUserPreferences/useUserPrefrences.tsx

@@ -18,7 +18,6 @@ import { useState } from 'react'
 
 import { ServerErrors } from '@Common/ServerError'
 import { useTheme } from '@Shared/Providers'
-import { ResourceKindType } from '@Shared/types'
 
 import { getUserPreferences, updateUserPreferences } from './service'
 import {
@@ -36,26 +35,36 @@ export const useUserPreferences = ({ migrateUserPreferences }: UseUserPreference
 
     const { handleThemeSwitcherDialogVisibilityChange, handleThemePreferenceChange } = useTheme()
 
-    const fetchRecentlyVisitedParsedApps = async ({ appId, appName }: UserPreferenceRecentlyVisitedAppsTypes) => {
+    const fetchRecentlyVisitedParsedApps = async ({
+        appId,
+        appName,
+        resourceKind,
+    }: UserPreferenceRecentlyVisitedAppsTypes) => {
         const userPreferencesResponse = await getUserPreferences()
 
         const uniqueFilteredApps = getFilteredUniqueAppList({
             userPreferencesResponse,
             appId,
             appName,
+            resourceKind,
         })
 
         setUserPreferences((prev) => ({
             ...prev,
             resources: {
                 ...prev?.resources,
-                [ResourceKindType.devtronApplication]: {
-                    ...prev?.resources?.[ResourceKindType.devtronApplication],
+                [resourceKind]: {
+                    ...prev?.resources?.[resourceKind],
                     [UserPreferenceResourceActions.RECENTLY_VISITED]: uniqueFilteredApps,
                 },
             },
         }))
-        await updateUserPreferences({ path: 'resources', value: uniqueFilteredApps })
+        await updateUserPreferences({
+            path: 'resources',
+            value: uniqueFilteredApps,
+            resourceKind,
+            userPreferencesResponse,
+        })
     }
 
     const handleInitializeUserPreferencesFromResponse = (userPreferencesResponse: UserPreferencesType) => {

src/Shared/Hooks/useUserPreferences/utils.tsx

@@ -3,8 +3,11 @@ import { ResourceKindType } from '@Shared/types'
 
 import { UserPreferenceFilteredListTypes, UserPreferenceResourceActions, UserPreferenceResourceType } from './types'
 
-export const getUserPreferenceResourcesMetadata = (recentlyVisited: BaseAppMetaData[]): UserPreferenceResourceType => ({
-    [ResourceKindType.devtronApplication]: {
+export const getUserPreferenceResourcesMetadata = (
+    recentlyVisited: BaseAppMetaData[],
+    resourceKind: ResourceKindType,
+): UserPreferenceResourceType => ({
+    [resourceKind]: {
         [UserPreferenceResourceActions.RECENTLY_VISITED]: recentlyVisited.map(({ appId, appName }) => ({
             appId,
             appName,
@@ -16,11 +19,10 @@ export const getFilteredUniqueAppList = ({
     userPreferencesResponse,
     appId,
     appName,
+    resourceKind,
 }: UserPreferenceFilteredListTypes) => {
     const _recentApps =
-        userPreferencesResponse?.resources?.[ResourceKindType.devtronApplication]?.[
-            UserPreferenceResourceActions.RECENTLY_VISITED
-        ] || []
+        userPreferencesResponse?.resources?.[resourceKind]?.[UserPreferenceResourceActions.RECENTLY_VISITED] || []
 
     const isInvalidApp = appId && !appName
 

src/Shared/types.ts

@@ -499,6 +499,7 @@ export enum ResourceKindType {
     cdPipeline = 'cd-pipeline',
     ciPipeline = 'ci-pipeline',
     project = 'project',
+    appGroup = 'app-group',
 }
 
 /**