Merge pull request #259 from devtron-labs/feat/approval-config

feat: add support for any & specific approval type in cd pipeline

Author: eshankvaish

package-lock.json

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

package.json

@@ -19,6 +19,7 @@ import { Placement } from 'tippy.js'
 import { ImageComment, ReleaseTag } from './ImageTags.Types'
 import { ACTION_STATE, DEPLOYMENT_WINDOW_TYPE, DockerConfigOverrideType, SortingOrder, TaskErrorObj } from '.'
 import { RegistryType } from '../Shared'
+import { UserGroupDTO } from '@Pages/GlobalConfigurations'
 
 /**
  * Generic response type object with support for overriding the result type
@@ -319,9 +320,34 @@ export enum DeploymentNodeType {
     APPROVAL = 'APPROVAL',
 }
 
+export enum ManualApprovalType {
+    specific = 'SPECIFIC',
+    any = 'ANY',
+    notConfigured = 'NOT_CONFIGURED',
+}
+
+// TODO: Need to verify this change for all impacting areas
 export interface UserApprovalConfigType {
+    type: ManualApprovalType
     requiredCount: number
-}
+    specificUsers: {
+        identifiers: string[]
+    }
+    userGroups: (Pick<UserGroupDTO, 'identifier'> & {
+        requiredCount: number
+    })[]
+}
+
+export type UserApprovalConfigPayloadType =
+    | ({
+          type: ManualApprovalType.any
+      } & Pick<UserApprovalConfigType, 'requiredCount'>)
+    | ({
+          type: ManualApprovalType.specific
+      } & Pick<UserApprovalConfigType, 'userGroups' | 'specificUsers'>)
+    | {
+          type: ManualApprovalType.notConfigured
+      }
 
 interface ApprovalUserDataType {
     dataId: number

src/Common/Types.ts

@@ -17,3 +17,4 @@
 export * from './constants'
 export type { UserListFilterParams, UserRoleGroup, UserGroupDTO, UserGroupType } from './types'
 export * from './shared'
+export * from './service'

src/Pages/GlobalConfigurations/Authorization/index.ts

@@ -0,0 +1,37 @@
+import { get } from '@Common/index'
+import { SelectPickerCustomOptionType } from '@Shared/Components'
+import { API_TOKEN_PREFIX } from '@Shared/constants'
+import { stringComparatorBySortOrder } from '@Shared/Helpers'
+import { DefaultUserKey } from '@Shared/types'
+import { GroupBase } from 'react-select'
+
+// FIXME: Common out the typing and url from dashboard
+export const getUserAndApiTokenOptions = async (): Promise<GroupBase<SelectPickerCustomOptionType<string>>[]> => {
+    const [{ result: userResponse }, { result: apiTokenResponse }] = await Promise.all([
+        get('user/v2'),
+        get('api-token'),
+    ])
+
+    return [
+        {
+            label: 'Users',
+            options: (userResponse?.users ?? [])
+                .sort((a, b) => stringComparatorBySortOrder(a.email_id, b.email_id))
+                .filter(({ email_id: emailId }) => emailId !== DefaultUserKey.system)
+                .map(({ email_id: emailId }) => ({
+                    label: emailId,
+                    value: emailId,
+                })),
+        },
+        {
+            label: 'API Tokens',
+            options: (apiTokenResponse ?? [])
+                .sort((a, b) => stringComparatorBySortOrder(a.userIdentifier, b.userIdentifier))
+                .map(({ userIdentifier }) => ({
+                    // Remove the API Token Prefix
+                    label: userIdentifier.startsWith(API_TOKEN_PREFIX) ? userIdentifier.split(':')[1] : userIdentifier,
+                    value: userIdentifier,
+                })),
+        },
+    ]
+}

src/Pages/GlobalConfigurations/Authorization/service.ts

@@ -62,11 +62,19 @@ export interface UserGroupDTO {
     identifier: string
     /**
      * Associated description
+     *
+     * @default ''
      */
     description?: string
+    /**
+     * Number of users assigned to the group
+     *
+     * @default 0
+     */
+    usersCount?: number
 }
 
-export interface UserGroupType extends Required<Pick<UserGroupDTO, 'description' | 'name'>> {
+export interface UserGroupType extends Required<Pick<UserGroupDTO, 'description' | 'name' | 'usersCount'>> {
     /**
      * Unique id of the user group
      *

src/Pages/GlobalConfigurations/Authorization/types.ts

@@ -18,7 +18,7 @@ export { default as SelectPickerCustom } from './SelectPicker.component'
 export { default as FilterSelectPickerCustom } from './FilterSelectPicker'
 export type {
     SelectPickerOptionType as SelectPickerCustomOptionType,
-    SelectPickerVariantType as SelectPickerCustomVariantType,
     SelectPickerProps as SelectPickerCustomProps,
     FilterSelectPickerProps as FilterSelectPickerCustomProps,
 } from './type'
+export { SelectPickerVariantType as SelectPickerCustomVariantType } from './type'