refactor: replace create and update functions with upsert for build infra profiles

Author: AbhishekA1509

src/Pages/GlobalConfigurations/BuildInfra/UseBuildInfraForm.tsx

@@ -18,7 +18,6 @@ import {
     BuildInfraToleranceOperatorType,
     BuildInfraToleranceValueType,
     CREATE_MODE_REQUIRED_INPUT_FIELDS,
-    createBuildInfraProfile,
     DEFAULT_PROFILE_NAME,
     DEFAULT_TOLERANCE_EFFECT,
     DEFAULT_TOLERANCE_OPERATOR,
@@ -29,7 +28,7 @@ import {
     ProfileInputErrorType,
     TARGET_PLATFORM_ERROR_FIELDS_MAP,
     ToleranceHeaderType,
-    updateBuildInfraProfile,
+    upsertBuildInfraProfile,
     UseBuildInfraFormProps,
     UseBuildInfraFormResponseType,
     ValidateNodeSelectorParamsType,
@@ -285,6 +284,7 @@ const useBuildInfraForm = ({
     name,
     editProfile,
     handleSuccessRedirection,
+    canConfigureUseK8sDriver,
 }: UseBuildInfraFormProps): UseBuildInfraFormResponseType => {
     const fromCreateView = !name
 
@@ -293,6 +293,7 @@ const useBuildInfraForm = ({
             getBuildInfraProfileByName({
                 name: name ?? DEFAULT_PROFILE_NAME,
                 fromCreateView,
+                canConfigureUseK8sDriver,
             }),
         [name],
     )
@@ -766,11 +767,11 @@ const useBuildInfraForm = ({
 
         setLoadingActionRequest(true)
         try {
-            if (editProfile) {
-                await updateBuildInfraProfile({ name, profileInput })
-            } else {
-                await createBuildInfraProfile({ profileInput })
-            }
+            await upsertBuildInfraProfile({
+                name,
+                profileInput,
+                canConfigureUseK8sDriver,
+            })
             setLoadingActionRequest(false)
             ToastManager.showToast({
                 variant: ToastVariantType.success,

src/Pages/GlobalConfigurations/BuildInfra/constants.tsx

@@ -26,8 +26,6 @@ import {
     BuildInfraLocators,
     BuildInfraMetaConfigTypes,
     ProfileInputErrorType,
-    BuildInfraProfileBase,
-    BuildInfraProfileVariants,
     HandleProfileInputChangeType,
     BuildInfraProfileAdditionalErrorKeysType,
     BuildInfraAPIVersionType,
@@ -176,13 +174,6 @@ export const PROFILE_INPUT_ERROR_FIELDS = Object.fromEntries(
 // fields required to be filled before submitting the form in create view, since we pre-populate the form with default values so no need in configs
 export const CREATE_MODE_REQUIRED_INPUT_FIELDS = [BuildInfraMetaConfigTypes.NAME]
 
-export const CREATE_PROFILE_BASE_VALUE: BuildInfraProfileBase = {
-    name: '',
-    description: '',
-    type: BuildInfraProfileVariants.NORMAL,
-    appCount: 0,
-}
-
 export const BUILD_INFRA_TEST_IDS = {
     SUBMIT_BUTTON: 'build-infra-submit-button',
     CANCEL_BUTTON: 'build-infra-cancel-button',

src/Pages/GlobalConfigurations/BuildInfra/services.tsx

@@ -24,14 +24,14 @@ import {
     BuildInfraProfileDTO,
     BuildInfraProfileInfoDTO,
     BuildInfraProfileResponseType,
-    CreateBuildInfraProfileType,
     GetBuildInfraProfileType,
-    UpdateBuildInfraProfileType,
+    UpsertBuildInfraProfileServiceParamsType,
 } from './types'
 
 export const getBuildInfraProfileByName = async ({
     name,
     fromCreateView,
+    canConfigureUseK8sDriver,
 }: GetBuildInfraProfileType): Promise<BuildInfraProfileResponseType> => {
     try {
         const profilePayload: Pick<BuildInfraProfileDTO['profile'], 'name'> = { name }
@@ -45,25 +45,33 @@ export const getBuildInfraProfileByName = async ({
             defaultConfigurations,
             profile,
             fromCreateView,
+            canConfigureUseK8sDriver,
         })
     } catch (error) {
         showError(error)
         throw error
     }
 }
 
-export const updateBuildInfraProfile = async ({ name, profileInput }: UpdateBuildInfraProfileType) => {
-    const updateProfilePayload: Pick<BuildInfraProfileDTO['profile'], 'name'> = { name }
-    const response = await put<ReturnType<typeof put>, BuildInfraProfileInfoDTO>(
-        getUrlWithSearchParams(getBuildInfraProfileEndpoint(), updateProfilePayload),
-        getBuildInfraProfilePayload(profileInput),
-    )
+export const upsertBuildInfraProfile = async ({
+    name,
+    profileInput,
+    canConfigureUseK8sDriver,
+}: UpsertBuildInfraProfileServiceParamsType) => {
+    const isEditView = !!name
+    const baseEndpoint = getBuildInfraProfileEndpoint()
+    const payload = getBuildInfraProfilePayload(profileInput, canConfigureUseK8sDriver)
+
+    if (isEditView) {
+        const updateProfileQueryPayload: Pick<BuildInfraProfileDTO['profile'], 'name'> = { name }
+        const response = await put<ReturnType<typeof put>, BuildInfraProfileInfoDTO>(
+            getUrlWithSearchParams(baseEndpoint, updateProfileQueryPayload),
+            payload,
+        )
 
+        return response
+    }
+
+    const response = await post<ReturnType<typeof post>, BuildInfraProfileInfoDTO>(baseEndpoint, payload)
     return response
 }
-
-export const createBuildInfraProfile = async ({ profileInput }: CreateBuildInfraProfileType) =>
-    post<ReturnType<typeof post>, BuildInfraProfileInfoDTO>(
-        getBuildInfraProfileEndpoint(),
-        getBuildInfraProfilePayload(profileInput),
-    )

src/Pages/GlobalConfigurations/BuildInfra/types.tsx

@@ -232,6 +232,7 @@ interface BuildInfraProfileBaseDTO {
     type: BuildInfraProfileVariants
     appCount?: number
     active?: boolean
+    useK8sDriver?: boolean
 }
 
 export interface BuildInfraProfileBase extends BuildInfraProfileBaseDTO {}
@@ -247,20 +248,6 @@ export interface BuildInfraProfileData extends BuildInfraProfileBase {
     configurations: Record<string, BuildInfraConfigurationMapType>
 }
 
-export interface GetBuildInfraProfileType {
-    name: string
-    fromCreateView?: boolean
-}
-
-export interface BuildInfraProfileResponseType {
-    configurationUnits: BuildInfraUnitsMapType | null
-    profile: BuildInfraProfileData | null
-    /**
-     * To be used in case user is creating configuration for new platform
-     */
-    fallbackPlatformConfigurationMap: BuildInfraProfileData['configurations']
-}
-
 export interface UseBuildInfraFormProps {
     /**
      * Name of the profile, if not provided assumption would be for create view
@@ -274,6 +261,24 @@ export interface UseBuildInfraFormProps {
      * If true, call this on form submission success
      */
     handleSuccessRedirection?: () => void
+    /**
+     * @default - false
+     */
+    canConfigureUseK8sDriver: boolean
+}
+
+export interface GetBuildInfraProfileType extends Pick<UseBuildInfraFormProps, 'canConfigureUseK8sDriver'> {
+    name: string
+    fromCreateView?: boolean
+}
+
+export interface BuildInfraProfileResponseType {
+    configurationUnits: BuildInfraUnitsMapType | null
+    profile: BuildInfraProfileData | null
+    /**
+     * To be used in case user is creating configuration for new platform
+     */
+    fallbackPlatformConfigurationMap: BuildInfraProfileData['configurations']
 }
 
 export enum BuildInfraProfileAdditionalErrorKeysType {
@@ -476,8 +481,13 @@ export interface FooterProps {
     loading?: boolean
 }
 
-export interface UpdateBuildInfraProfileType extends Pick<UseBuildInfraFormResponseType, 'profileInput'> {
-    name: string
+export interface UpsertBuildInfraProfileServiceParamsType
+    extends Pick<UseBuildInfraFormResponseType, 'profileInput'>,
+        Pick<UseBuildInfraFormProps, 'canConfigureUseK8sDriver'> {
+    /**
+     * If not given would consider as create view
+     */
+    name?: string
 }
 
 export interface CreateBuildInfraProfileType extends Pick<UseBuildInfraFormResponseType, 'profileInput'> {}
@@ -519,7 +529,8 @@ export interface BuildInfraProfileDTO extends BaseBuildInfraProfileDTO {
 
 export interface BuildInfraProfileTransformerParamsType
     extends BuildInfraProfileDTO,
-        Pick<GetBuildInfraProfileType, 'fromCreateView'> {}
+        Pick<GetBuildInfraProfileType, 'fromCreateView'>,
+        Pick<GetBuildInfraProfileType, 'canConfigureUseK8sDriver'> {}
 
 export interface GetPlatformConfigurationsWithDefaultValuesParamsType {
     profileConfigurationsMap: BuildInfraConfigurationMapTypeWithoutDefaultFallback
@@ -544,3 +555,6 @@ export interface ValidateNodeSelectorParamsType
     selector: BuildInfraNodeSelectorValueType
     existingKeys: string[]
 }
+
+export interface GetBaseProfileObjectParamsType
+    extends Pick<BuildInfraProfileTransformerParamsType, 'canConfigureUseK8sDriver' | 'fromCreateView' | 'profile'> {}

src/Pages/GlobalConfigurations/BuildInfra/utils.tsx

@@ -31,13 +31,14 @@ import {
     BuildInfraProfileInfoDTO,
     BuildInfraProfileResponseType,
     BuildInfraProfileTransformerParamsType,
+    BuildInfraProfileVariants,
     BuildInfraToleranceOperatorType,
     BuildInfraToleranceValueType,
     CreateBuildInfraProfileType,
+    GetBaseProfileObjectParamsType,
     GetPlatformConfigurationsWithDefaultValuesParamsType,
 } from './types'
 import {
-    CREATE_PROFILE_BASE_VALUE,
     BUILD_INFRA_DEFAULT_PLATFORM_NAME,
     BUILD_INFRA_LATEST_API_VERSION,
     INFRA_CONFIG_NOT_SUPPORTED_BY_BUILD_X,
@@ -106,9 +107,22 @@ export const parsePlatformConfigIntoValue = (
     }
 }
 
-const getBaseProfileObject = (fromCreateView: boolean, profile: BuildInfraProfileInfoDTO): BuildInfraProfileBase => {
+const getBaseProfileObject = ({
+    fromCreateView,
+    profile,
+    canConfigureUseK8sDriver,
+}: GetBaseProfileObjectParamsType): BuildInfraProfileBase => {
+    const parsedUseK8sDriverValue = profile?.useK8sDriver || true
+    const useK8sDriver = canConfigureUseK8sDriver ? parsedUseK8sDriverValue : null
+
     if (fromCreateView) {
-        return structuredClone(CREATE_PROFILE_BASE_VALUE)
+        return {
+            name: '',
+            description: '',
+            type: BuildInfraProfileVariants.NORMAL,
+            appCount: 0,
+            useK8sDriver,
+        }
     }
 
     return {
@@ -117,6 +131,7 @@ const getBaseProfileObject = (fromCreateView: boolean, profile: BuildInfraProfil
         description: profile.description,
         type: profile.type,
         appCount: profile.appCount,
+        useK8sDriver,
     }
 }
 
@@ -190,6 +205,7 @@ export const getTransformedBuildInfraProfileResponse = ({
     defaultConfigurations,
     profile,
     fromCreateView,
+    canConfigureUseK8sDriver,
 }: BuildInfraProfileTransformerParamsType): BuildInfraProfileResponseType => {
     // Ideal assumption is defaultConfigurations would contain all the required keys
     const globalProfilePlatformConfigMap = getConfigurationMapWithoutDefaultFallback(defaultConfigurations)
@@ -254,14 +270,20 @@ export const getTransformedBuildInfraProfileResponse = ({
         configurationUnits,
         fallbackPlatformConfigurationMap,
         profile: {
-            ...(profile && getBaseProfileObject(fromCreateView, profile)),
+            ...(profile &&
+                getBaseProfileObject({
+                    fromCreateView,
+                    profile,
+                    canConfigureUseK8sDriver,
+                })),
             configurations,
         },
     }
 }
 
 export const getBuildInfraProfilePayload = (
     profileInput: CreateBuildInfraProfileType['profileInput'],
+    canConfigureUseK8sDriver: boolean,
 ): BuildInfraProfileInfoDTO => {
     const platformConfigurationMap = profileInput.configurations || {}
     const configurations: BuildInfraProfileInfoDTO['configurations'] = Object.entries(platformConfigurationMap).reduce<
@@ -312,6 +334,9 @@ export const getBuildInfraProfilePayload = (
         description: profileInput.description,
         type: profileInput.type,
         configurations,
+        ...(canConfigureUseK8sDriver && {
+            useK8sDriver: profileInput.useK8sDriver,
+        }),
     }
     return payload
 }