feat(bulk-import) : resolving comments

redhat-developer · Dec 23, 2024 · ea7ffa3 · ea7ffa3
1 parent 636dc6e
commit ea7ffa3
Show file tree

Hide file tree

Showing 10 changed files with 80 additions and 43 deletions.
diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ImportApi.md b/workspaces/bulk-import/plugins/bulk-import-backend/api-docs/Apis/ImportApi.md
diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapi.d.ts b/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapi.d.ts
@@ -31,7 +31,12 @@ declare namespace Components {
     export type SizePerIntegrationQueryParam = number;
     export type SizePerIntegrationQueryParamDeprecated = number;
     export type SizeQueryParam = number;
-    export type SortColumnQueryParam = string;
+    export type SortColumnQueryParam =
+      | 'repository.name'
+      | 'repository.organization'
+      | 'repository.url'
+      | 'lastUpdate'
+      | 'status';
     export type SortOrderQueryParam = 'asc' | 'desc';
   }
   export interface QueryParameters {
@@ -332,7 +337,12 @@ declare namespace Paths {
       export type Search = string;
       export type Size = number;
       export type SizePerIntegration = number;
-      export type SortColumn = string;
+      export type SortColumn =
+        | 'repository.name'
+        | 'repository.organization'
+        | 'repository.url'
+        | 'lastUpdate'
+        | 'status';
       export type SortOrder = 'asc' | 'desc';
     }
     export interface QueryParameters {

diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapidocument.ts b/workspaces/bulk-import/plugins/bulk-import-backend/src/generated/openapidocument.ts
@@ -571,10 +571,17 @@ const OPENAPI = `
       "sortColumnQueryParam": {
         "in": "query",
         "name": "sortColumn",
-        "description": "The name of the column to sort by",
+        "description": "The allowed values for sorting columns:\\n- repository.name: Sort by repository name.\\n- repository.organization: Sort by organization URL.\\n- repository.url: Sort by repository URL.\\n- lastUpdate: Sort by the last time the catalog-info.yaml was updated.\\n- status: Sort by the status of the catalog-info.yaml.\\n",
         "required": false,
         "schema": {
-          "type": "string"
+          "enum": [
+            "repository.name",
+            "repository.organization",
+            "repository.url",
+            "lastUpdate",
+            "status"
+          ],
+          "default": "repository.name"
         }
       },
       "sortOrderQueryParam": {

diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/src/helpers/utils.ts b/workspaces/bulk-import/plugins/bulk-import-backend/src/helpers/utils.ts
@@ -24,7 +24,3 @@ export function getNestedValue<T>(obj: T, path: string): any {
       obj,
     );
 }
-export enum SortingOrderEnum {
-  ASC = 'asc',
-  DESC = 'desc',
-}
diff --git a/workspaces/bulk-import/plugins/bulk-import-backend/src/schema/openapi.yaml b/workspaces/bulk-import/plugins/bulk-import-backend/src/schema/openapi.yaml
@@ -364,10 +364,23 @@ components:
     sortColumnQueryParam:
       in: query
       name: sortColumn
-      description: The name of the column to sort by
+      description: |
+        The allowed values for sorting columns:
+        - `repository.name`: Sort by repository name.
+        - `repository.organization`: Sort by organization URL.
+        - `repository.url`: Sort by repository URL.
+        - `lastUpdate`: Sort by the last time the catalog-info.yaml was updated.
+        - `status`: Sort by the status of the catalog-info.yaml.
       required: false
       schema:
-        type: string
+        enum:
+          - repository.name
+          - repository.organization
+          - repository.url
+          - lastUpdate
+          - status
+        default: repository.name
+
     sortOrderQueryParam:
       in: query
       name: sortOrder

diff --git a/...spaces/bulk-import/plugins/bulk-import-backend/src/service/handlers/import/bulkImports.ts b/...spaces/bulk-import/plugins/bulk-import-backend/src/service/handlers/import/bulkImports.ts
@@ -32,7 +32,6 @@ import {
   getNestedValue,
   logErrorIfNeeded,
   paginateArray,
-  SortingOrderEnum,
 } from '../../../helpers';
 import {
   DefaultPageNumber,
@@ -52,18 +51,27 @@ type FindAllImportsResponse =
 
 function sortImports(
   imports: Components.Schemas.Import[],
-  sortColumn: string = 'repository.name',
-  sortOrder: string = SortingOrderEnum.ASC,
+  sortColumn: Components.Parameters.SortColumnQueryParam = 'repository.name',
+  sortOrder: Components.Parameters.SortOrderQueryParam = 'asc',
 ) {
   imports.sort((a, b) => {
     const value1 = getNestedValue(a, sortColumn);
     const value2 = getNestedValue(b, sortColumn);
     // Handle cases where values are undefined
     if (value1 === undefined && value2 === undefined) return 0;
-    if (value1 === undefined) return SortingOrderEnum.ASC ? -1 : 1;
-    if (value2 === undefined) return SortingOrderEnum.ASC ? 1 : -1;
+    if (value1 === undefined) return sortOrder === 'asc' ? -1 : 1;
+    if (value2 === undefined) return sortOrder === 'asc' ? 1 : -1;
+
+    if (sortColumn === 'lastUpdate') {
+      const date1 = new Date(value1); // Convert string to Date object
+      const date2 = new Date(value2); // Convert string to Date object
+      // Compare dates
+      return sortOrder === 'asc'
+        ? date2.getTime() - date1.getTime()
+        : date1.getTime() - date2.getTime();
+    }
     // Compare values based on sort order
-    return SortingOrderEnum.ASC === sortOrder
+    return sortOrder === 'asc'
       ? value1.localeCompare(value2)
       : value2.localeCompare(value1);
   });
@@ -83,8 +91,8 @@ export async function findAllImports(
     search?: string;
     pageNumber?: number;
     pageSize?: number;
-    sortColumn?: string;
-    sortOrder?: string;
+    sortColumn?: Components.Parameters.SortColumnQueryParam;
+    sortOrder?: Components.Parameters.SortOrderQueryParam;
   },
 ): Promise<HandlerResponse<FindAllImportsResponse>> {
   const apiVersion = requestHeaders?.apiVersion ?? 'v1';

diff --git a/workspaces/bulk-import/plugins/bulk-import/src/api/BulkImportBackendClient.test.ts b/workspaces/bulk-import/plugins/bulk-import/src/api/BulkImportBackendClient.test.ts
@@ -313,8 +313,8 @@ describe('BulkImportBackendClient', () => {
         1,
         2,
         '',
-        AddedRepositoryColumnNameEnum.repoName,
-        SortingOrderEnum.ASC,
+        AddedRepositoryColumnNameEnum.repositoryName,
+        SortingOrderEnum.Asc,
       );
       expect(jobs).toEqual(mockGetImportJobs);
     });
@@ -324,8 +324,8 @@ describe('BulkImportBackendClient', () => {
         1,
         2,
         'cup',
-        AddedRepositoryColumnNameEnum.repoName,
-        SortingOrderEnum.ASC,
+        AddedRepositoryColumnNameEnum.repositoryName,
+        SortingOrderEnum.Asc,
       );
       expect(jobs).toEqual(
         mockGetImportJobs.imports.filter(r =>
@@ -340,8 +340,8 @@ describe('BulkImportBackendClient', () => {
           1,
           2,
           '',
-          AddedRepositoryColumnNameEnum.repoName,
-          SortingOrderEnum.ASC,
+          AddedRepositoryColumnNameEnum.repositoryName,
+          SortingOrderEnum.Asc,
         ),
       ).resolves.toEqual(expect.objectContaining([]));
     });

diff --git a/workspaces/bulk-import/plugins/bulk-import/src/components/Repositories/RepositoriesList.tsx b/workspaces/bulk-import/plugins/bulk-import/src/components/Repositories/RepositoriesList.tsx
@@ -40,10 +40,10 @@ export const RepositoriesList = () => {
   const location = useLocation();
   const queryParams = new URLSearchParams(location.search);
   const [order, setOrder] = React.useState<SortingOrderEnum>(
-    SortingOrderEnum.ASC,
+    SortingOrderEnum.Asc,
   );
   const [orderBy, setOrderBy] = React.useState<string>(
-    AddedRepositoryColumnNameEnum.repoName,
+    AddedRepositoryColumnNameEnum.repositoryName,
   );
   const { openDialog, setOpenDialog, deleteComponent } = useDeleteDialog();
   const { openDrawer, setOpenDrawer, drawerData } = useDrawer();
@@ -65,7 +65,7 @@ export const RepositoriesList = () => {
     pageNumber + 1,
     rowsPerPage,
     debouncedSearch,
-    AddedRepositoryColumnNameEnum[orderByColumn] || '',
+    AddedRepositoryColumnNameEnum[orderByColumn],
     order,
   );
 
@@ -89,7 +89,7 @@ export const RepositoriesList = () => {
     property: string,
   ) => {
     const isAsc = orderBy === property && order === 'asc';
-    setOrder(isAsc ? SortingOrderEnum.DESC : SortingOrderEnum.ASC);
+    setOrder(isAsc ? SortingOrderEnum.Desc : SortingOrderEnum.Asc);
     setOrderBy(property);
   };
 

diff --git a/workspaces/bulk-import/plugins/bulk-import/src/hooks/useAddedRepositories.test.ts b/workspaces/bulk-import/plugins/bulk-import/src/hooks/useAddedRepositories.test.ts
@@ -54,8 +54,8 @@ describe('useAddedRepositories', () => {
         1,
         5,
         '',
-        AddedRepositoryColumnNameEnum.repoName,
-        SortingOrderEnum.ASC,
+        AddedRepositoryColumnNameEnum.repositoryName,
+        SortingOrderEnum.Asc,
       ),
     );
     await waitFor(() => {

diff --git a/workspaces/bulk-import/plugins/bulk-import/src/types/types.ts b/workspaces/bulk-import/plugins/bulk-import/src/types/types.ts
@@ -97,16 +97,19 @@ export enum RepositoryStatus {
   'REPO_EMPTY' = 'REPO_EMPTY',
   'CODEOWNERS_FILE_NOT_FOUND_IN_REPO' = 'CODEOWNERS_FILE_NOT_FOUND_IN_REPO',
 }
+
 export enum AddedRepositoryColumnNameEnum {
-  repoName = 'repository.name',
+  repoName = 'repository.name', // because of property name
+  repositoryName = 'repository.name',
   organizationUrl = 'repository.organization',
   repoUrl = 'repository.url',
   catalogInfoYamlLastUpdated = 'lastUpdate',
   catalogInfoYamlStatus = 'status',
 }
+
 export enum SortingOrderEnum {
-  ASC = 'asc',
-  DESC = 'desc',
+  Asc = 'asc',
+  Desc = 'desc',
 }
 export enum RepositorySelection {
   Repository = 'repository',