feat(bulk-import): Use enums for importFlow and TaskStatus (#1718)

Author: lokanandaprabhu

workspaces/bulk-import/.changeset/add-importflow-and-taskstatus-enums.md

@@ -0,0 +1,8 @@
+---
+'@red-hat-developer-hub/backstage-plugin-bulk-import': minor
+---
+
+Use enums for importFlow and TaskStatus
+
+- Convert TaskStatus from union type to enum for better status handling and type safety
+- Add ImportFlow enum to standardize import flow configuration values

workspaces/bulk-import/plugins/bulk-import/src/api/BulkImportBackendClient.test.ts

@@ -28,6 +28,7 @@ import {
 import {
   AddedRepositoryColumnNameEnum,
   ApprovalTool,
+  ImportFlow,
   RepositoryStatus,
   SortingOrderEnum,
 } from '../types';
@@ -180,7 +181,7 @@ beforeAll(() => server.listen());
 afterEach(() => server.restoreHandlers());
 afterAll(() => server.close());
 
-const getConfigApi = (importAPI: 'open-pull-requests' | 'scaffolder') => ({
+const getConfigApi = (importAPI: ImportFlow) => ({
   has: jest.fn(),
   keys: jest.fn(),
   get: jest.fn(),
@@ -222,7 +223,7 @@ describe('BulkImportBackendClient with open-pull-requests', () => {
 
   beforeEach(() => {
     bulkImportApi = new BulkImportBackendClient({
-      configApi: getConfigApi('open-pull-requests'),
+      configApi: getConfigApi(ImportFlow.OpenPullRequests),
       identityApi: identityApi,
     });
   });
@@ -446,7 +447,7 @@ describe('BulkImportBackendClient with scaffolder', () => {
 
   beforeEach(() => {
     bulkImportApi = new BulkImportBackendClient({
-      configApi: getConfigApi('scaffolder'),
+      configApi: getConfigApi(ImportFlow.Scaffolder),
       identityApi: identityApi,
     });
   });

workspaces/bulk-import/plugins/bulk-import/src/api/BulkImportBackendClient.ts

@@ -25,6 +25,7 @@ import {
   APITypes,
   ApprovalTool,
   CreateImportJobRepository,
+  ImportFlow,
   ImportJobResponse,
   ImportJobs,
   ImportJobStatus,
@@ -108,13 +109,13 @@ export class BulkImportBackendClient implements BulkImportAPI {
     this.identityApi = options.identityApi;
     const importAPI =
       this.configApi.getOptionalString('bulkImport.importAPI') ??
-      'open-pull-requests';
+      ImportFlow.OpenPullRequests;
 
     switch (importAPI) {
-      case 'scaffolder':
+      case ImportFlow.Scaffolder:
         this.pathProvider = new ScaffolderBulkImportBackendClientPathProvider();
         break;
-      case 'open-pull-requests':
+      case ImportFlow.OpenPullRequests:
         this.pathProvider = new PRBulkImportBackendClientPathProvider();
         break;
       default:

workspaces/bulk-import/plugins/bulk-import/src/components/AddRepositories/AddRepositoriesFormFooter.tsx

@@ -26,7 +26,11 @@ import { useFormikContext } from 'formik';
 import { useGitlabConfigured } from '../../hooks';
 import { useImportFlow } from '../../hooks/useImportFlow';
 import { useTranslation } from '../../hooks/useTranslation';
-import { AddRepositoriesFormValues, ApprovalTool } from '../../types';
+import {
+  AddRepositoriesFormValues,
+  ApprovalTool,
+  ImportFlow,
+} from '../../types';
 
 export const AddRepositoriesFormFooter = () => {
   const { t } = useTranslation();
@@ -40,7 +44,7 @@ export const AddRepositoriesFormFooter = () => {
     Object.keys(values.repositories || []).length > 1;
 
   const getGitSubmitTitle = (isGitlabConfigured: boolean) => {
-    if (isGitlabConfigured || importFlow === 'scaffolder') {
+    if (isGitlabConfigured || importFlow === ImportFlow.Scaffolder) {
       return t('common.import');
     }
     return isPluralRepositories
@@ -62,7 +66,7 @@ export const AddRepositoriesFormFooter = () => {
     [ApprovalTool.Git]: {
       submitTitle: getGitSubmitTitle(gitlabConfigured),
       toolTipTitle:
-        gitlabConfigured || importFlow === 'scaffolder'
+        gitlabConfigured || importFlow === ImportFlow.Scaffolder
           ? t('forms.footer.importTooltip')
           : t('forms.footer.pullRequestTooltip'),
     },

workspaces/bulk-import/plugins/bulk-import/src/components/AddRepositories/CatalogInfoStatus.tsx

@@ -27,6 +27,7 @@ import { useTranslation } from '../../hooks/useTranslation';
 import {
   AddRepositoriesFormValues,
   AddRepositoryData,
+  ImportFlow,
   RepositoryStatus,
 } from '../../types';
 import {
@@ -79,7 +80,7 @@ export const CatalogInfoStatus = ({
 
   const importFlow = useImportFlow();
   if (
-    importFlow !== 'scaffolder' &&
+    importFlow !== ImportFlow.Scaffolder &&
     !isDrawer &&
     (isSelected ||
       (data?.totalReposInOrg && data.totalReposInOrg > 0 && allSelected))

workspaces/bulk-import/plugins/bulk-import/src/components/Repositories/AddedRepositoryTableRow.tsx

@@ -28,6 +28,7 @@ import {
   AddRepositoriesFormValues,
   AddRepositoryData,
   ApprovalTool,
+  ImportFlow,
 } from '../../types';
 import {
   calculateLastUpdated,
@@ -82,7 +83,7 @@ export const AddedRepositoryTableRow = ({
   return (
     <TableRow hover>
       <TableCell component="th" scope="row" className={classes.tableCellStyle}>
-        {importFlow === 'scaffolder' ? (
+        {importFlow === ImportFlow.Scaffolder ? (
           <Link
             to={`/bulk-import/repositories/tasks/${encodeURIComponent(
               data.repoUrl || '',

workspaces/bulk-import/plugins/bulk-import/src/components/Repositories/DeleteRepository.tsx

@@ -21,7 +21,7 @@ import Typography from '@mui/material/Typography';
 
 import { useImportFlow } from '../../hooks/useImportFlow';
 import { useTranslation } from '../../hooks/useTranslation';
-import { AddRepositoryData } from '../../types';
+import { AddRepositoryData, ImportFlow } from '../../types';
 import { useDeleteDialog } from '../DeleteDialogContext';
 
 const DeleteRepository = ({ data }: { data: AddRepositoryData }) => {
@@ -36,7 +36,7 @@ const DeleteRepository = ({ data }: { data: AddRepositoryData }) => {
   const importFlow = useImportFlow();
   let tooltipMessage;
   let delDisabled;
-  if (importFlow === 'scaffolder') {
+  if (importFlow === ImportFlow.Scaffolder) {
     tooltipMessage = t('repositories.removeTooltipRepositoryScaffolder');
     delDisabled = false;
   } else {

workspaces/bulk-import/plugins/bulk-import/src/components/Repositories/DeleteRepositoryDialog.tsx

@@ -36,7 +36,7 @@ import { bulkImportApiRef } from '../../api/BulkImportBackendClient';
 import { useGitlabConfigured } from '../../hooks';
 import { useImportFlow } from '../../hooks/useImportFlow';
 import { useTranslation } from '../../hooks/useTranslation';
-import { AddRepositoryData } from '../../types';
+import { AddRepositoryData, ImportFlow } from '../../types';
 
 const useStyles = makeStyles(() =>
   createStyles({
@@ -88,7 +88,7 @@ const DeleteRepositoryDialog = ({
 
   const importFlow = useImportFlow();
   let deleteMsg;
-  if (importFlow === 'scaffolder') {
+  if (importFlow === ImportFlow.Scaffolder) {
     deleteMsg = t('repositories.removeRepositoryWarningScaffolder');
   } else {
     deleteMsg = gitlabConfigured

workspaces/bulk-import/plugins/bulk-import/src/components/Repositories/RepositoriesList.test.tsx

@@ -60,7 +60,7 @@ const mockAsyncData = {
       id: item.id,
       task: {
         id: item.task?.taskId || '',
-        status: 'TASK_COMPLETED' as TaskStatus,
+        status: TaskStatus.Completed,
       },
     })),
     totalJobs: mockGetImportJobs.imports.length,

workspaces/bulk-import/plugins/bulk-import/src/hooks/useImportFlow.ts

@@ -15,9 +15,12 @@
  */
 import { configApiRef, useApi } from '@backstage/core-plugin-api';
 
-export const useImportFlow = () => {
+import { ImportFlow } from '../types/types';
+
+export const useImportFlow = (): ImportFlow => {
   const configApi = useApi(configApiRef);
-  return (
-    configApi.getOptionalString('bulkImport.importAPI') ?? 'open-pull-requests'
-  );
+  const flowValue =
+    configApi.getOptionalString('bulkImport.importAPI') ??
+    ImportFlow.OpenPullRequests;
+  return flowValue as ImportFlow;
 };