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/Components/ContextSwitcher/ContextSwitcher.tsx

@@ -0,0 +1,47 @@
+import { getNoMatchingResultText, SelectPicker, SelectPickerVariantType } from '@Shared/Components'
+import { ComponentSizeType } from '@Shared/constants'
+
+import { ContextSwitcherTypes } from './types'
+import { customSelectFilterOption, getDisabledOptions } from './utils'
+
+export const ContextSwitcher = ({
+    inputId,
+    options = [],
+    inputValue,
+    onInputChange,
+    isLoading,
+    value,
+    onChange,
+    placeholder,
+    filterOption,
+    formatOptionLabel,
+    optionListError,
+    reloadOptionList,
+    classNamePrefix,
+}: ContextSwitcherTypes) => {
+    const selectedOptions = options?.map((section) => ({
+        ...section,
+        options: section?.label === 'Recently Visited' ? section.options?.slice(1) : section.options,
+    }))
+    return (
+        <SelectPicker
+            inputId={inputId}
+            options={selectedOptions || []}
+            inputValue={inputValue}
+            onInputChange={onInputChange}
+            isLoading={isLoading}
+            noOptionsMessage={getNoMatchingResultText}
+            onChange={onChange}
+            value={value}
+            variant={SelectPickerVariantType.BORDER_LESS}
+            placeholder={placeholder}
+            isOptionDisabled={getDisabledOptions}
+            size={ComponentSizeType.xl}
+            filterOption={filterOption || customSelectFilterOption}
+            formatOptionLabel={formatOptionLabel}
+            optionListError={optionListError}
+            reloadOptionList={reloadOptionList}
+            classNamePrefix={classNamePrefix}
+        />
+    )
+}

src/Shared/Components/ContextSwitcher/index.ts

@@ -0,0 +1,3 @@
+export { ContextSwitcher } from './ContextSwitcher'
+export type { ContextSwitcherTypes, RecentlyVisitedGroupedOptionsType, RecentlyVisitedOptions } from './types'
+export { getMinCharSearchPlaceholderGroup } from './utils'

src/Shared/Components/ContextSwitcher/types.ts

@@ -0,0 +1,33 @@
+import { GroupBase } from 'react-select'
+
+import { SelectPickerOptionType, SelectPickerProps } from '../SelectPicker'
+
+export interface ContextSwitcherTypes
+    extends Pick<
+        SelectPickerProps,
+        | 'placeholder'
+        | 'onChange'
+        | 'value'
+        | 'isLoading'
+        | 'onInputChange'
+        | 'inputValue'
+        | 'inputId'
+        | 'formatOptionLabel'
+        | 'filterOption'
+        | 'optionListError'
+        | 'reloadOptionList'
+        | 'classNamePrefix'
+    > {
+    options: GroupBase<SelectPickerOptionType<string | number>>[]
+    isAppDataAvailable?: boolean
+}
+
+export interface RecentlyVisitedOptions extends SelectPickerOptionType<number> {
+    isDisabled?: boolean
+    isRecentlyVisited?: boolean
+}
+
+export interface RecentlyVisitedGroupedOptionsType extends GroupBase<SelectPickerOptionType<number>> {
+    label: string
+    options: RecentlyVisitedOptions[]
+}

src/Shared/Components/ContextSwitcher/utils.ts

@@ -0,0 +1,14 @@
+import { SelectPickerProps } from '../SelectPicker'
+import { RecentlyVisitedGroupedOptionsType, RecentlyVisitedOptions } from './types'
+
+export const getDisabledOptions = (option: RecentlyVisitedOptions): SelectPickerProps['isDisabled'] => option.isDisabled
+
+export const customSelectFilterOption: SelectPickerProps['filterOption'] = (option, searchText: string) => {
+    const label = option.data.label as string
+    return option.data.value === 0 || label.toLowerCase().includes(searchText.toLowerCase())
+}
+
+export const getMinCharSearchPlaceholderGroup = (resourceKind: string): RecentlyVisitedGroupedOptionsType => ({
+    label: `All ${resourceKind}`,
+    options: [{ value: 0, label: 'Type 3 characters to search', isDisabled: true }],
+})

src/Shared/Components/index.ts

@@ -37,6 +37,7 @@ export * from './CollapsibleList'
 export * from './CommitChipCell'
 export * from './Confetti'
 export * from './ConfirmationModal'
+export * from './ContextSwitcher'
 export * from './CountrySelect'
 export * from './CustomInput'
 export * from './DatePicker'

src/Shared/Hooks/useUserPreferences/constants.ts

@@ -14,4 +14,15 @@
  * limitations under the License.
  */
 
+import { ResourceKindType } from '@Shared/types'
+
+import { PreferredResourceKindType } from './types'
+
 export const USER_PREFERENCES_ATTRIBUTE_KEY = 'userPreferences'
+
+export const DEFAULT_RESOURCES_MAP: Record<PreferredResourceKindType, null> = {
+    [ResourceKindType.devtronApplication]: null,
+    [ResourceKindType.job]: null,
+    'app-group': null,
+    [ResourceKindType.cluster]: null,
+}

src/Shared/Hooks/useUserPreferences/service.ts

@@ -17,22 +17,20 @@
 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 {
+    BaseRecentlyVisitedEntitiesTypes,
     GetUserPreferencesParsedDTO,
     GetUserPreferencesQueryParamsType,
     UpdateUserPreferencesPayloadType,
     UserPathValueMapType,
-    UserPreferenceResourceActions,
     UserPreferenceResourceProps,
     UserPreferencesPayloadValueType,
     UserPreferencesType,
     ViewIsPipelineRBACConfiguredRadioTabs,
 } from './types'
-import { getUserPreferenceResourcesMetadata } from './utils'
+import { getParsedResourcesMap, getUserPreferenceResourcesMetadata } from './utils'
 
 /**
  * @returns UserPreferencesType
@@ -64,17 +62,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: getParsedResourcesMap(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 +77,7 @@ export const getUserPreferences = async (): Promise<UserPreferencesType> => {
 const getUserPreferencePayload = async ({
     path,
     value,
+    resourceKind,
 }: UserPathValueMapType): Promise<Partial<UserPreferencesPayloadValueType>> => {
     switch (path) {
         case 'themePreference':
@@ -100,10 +91,19 @@ const getUserPreferencePayload = async ({
                     value.pipelineRBACViewSelectedTab === ViewIsPipelineRBACConfiguredRadioTabs.ACCESS_ONLY,
             }
 
-        case 'resources':
+        case 'resources': {
+            const updatedResources = {
+                [resourceKind]: {
+                    ...getUserPreferenceResourcesMetadata(value as BaseRecentlyVisitedEntitiesTypes[], resourceKind)[
+                        resourceKind
+                    ],
+                },
+            }
+
             return {
-                resources: getUserPreferenceResourcesMetadata(value as BaseAppMetaData[]),
+                resources: updatedResources,
             }
+        }
         default:
             return {}
     }
@@ -112,12 +112,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

@@ -16,7 +16,6 @@
 
 import { USER_PREFERENCES_ATTRIBUTE_KEY } from '@Shared/Hooks/useUserPreferences/constants'
 import { AppThemeType, ThemeConfigType, ThemePreferenceType } from '@Shared/Providers/ThemeProvider/types'
-import { BaseAppMetaData } from '@Shared/Services'
 import { ResourceKindType } from '@Shared/types'
 
 export interface GetUserPreferencesQueryParamsType {
@@ -31,12 +30,24 @@ export enum ViewIsPipelineRBACConfiguredRadioTabs {
 export enum UserPreferenceResourceActions {
     RECENTLY_VISITED = 'recently-visited',
 }
-export interface UserResourceKindActionType {
-    [UserPreferenceResourceActions.RECENTLY_VISITED]: BaseAppMetaData[]
+export type PreferredResourceKindType =
+    | ResourceKindType.devtronApplication
+    | ResourceKindType.job
+    | 'app-group'
+    | ResourceKindType.cluster
+
+export interface BaseRecentlyVisitedEntitiesTypes {
+    id: number
+    name: string
+}
+export interface UserPreferenceRecentlyVisitedAppsTypes extends BaseRecentlyVisitedEntitiesTypes {
+    resourceKind: PreferredResourceKindType
 }
-export interface UserPreferenceResourceType {
-    [ResourceKindType.devtronApplication]: UserResourceKindActionType
+
+export interface UserResourceKindActionType {
+    [UserPreferenceResourceActions.RECENTLY_VISITED]: BaseRecentlyVisitedEntitiesTypes[]
 }
+export type UserPreferenceResourceType = Partial<Record<PreferredResourceKindType, UserResourceKindActionType>>
 export interface GetUserPreferencesParsedDTO {
     viewPermittedEnvOnly?: boolean
     /**
@@ -75,31 +86,39 @@ export interface UserPreferencesType {
 
 export interface UpdatedUserPreferencesType extends UserPreferencesType, Pick<ThemeConfigType, 'appTheme'> {}
 
+export interface RecentlyVisitedFetchConfigType extends UserPreferenceRecentlyVisitedAppsTypes {
+    isDataAvailable?: boolean
+}
+
 export interface UseUserPreferencesProps {
+    userPreferenceResourceKind?: PreferredResourceKindType
     migrateUserPreferences?: (userPreferencesResponse: UserPreferencesType) => Promise<UserPreferencesType>
+    recentlyVisitedFetchConfig?: RecentlyVisitedFetchConfigType
 }
 
 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[]>
+          value: Required<BaseRecentlyVisitedEntitiesTypes[]>
+          resourceKind: PreferredResourceKindType
+          userPreferencesResponse?: UserPreferencesType
       }
 
 export type UserPreferenceResourceProps = UserPathValueMapType & {
     shouldThrowError?: boolean
-}
-
-export interface UserPreferenceRecentlyVisitedAppsTypes {
-    appId: number
-    appName: string
+    userPreferencesResponse?: UserPreferencesType
 }
 
 export interface UserPreferenceFilteredListTypes extends UserPreferenceRecentlyVisitedAppsTypes {