fix: projects archive search (#7898)

Filter projects when searching
Unleash · Aug 15, 2024 · f2e2952 · f2e2952
1 parent a3decb5
commit f2e2952
Show file tree

Hide file tree

Showing 5 changed files with 88 additions and 13 deletions.
diff --git a/frontend/src/component/common/Highlighter/Highlighter.tsx b/frontend/src/component/common/Highlighter/Highlighter.tsx
@@ -1,4 +1,4 @@
-import type { VFC } from 'react';
+import type { FC } from 'react';
 import { safeRegExp } from '@server/util/escape-regex';
 import { styled } from '@mui/material';
 
@@ -14,7 +14,7 @@ export const StyledSpan = styled('span')(({ theme }) => ({
     },
 }));
 
-export const Highlighter: VFC<IHighlighterProps> = ({
+export const Highlighter: FC<IHighlighterProps> = ({
     search,
     children,
     caseSensitive,

diff --git a/frontend/src/component/project/NewProjectCard/ProjectArchiveCard.tsx b/frontend/src/component/project/NewProjectCard/ProjectArchiveCard.tsx
@@ -28,6 +28,8 @@ import {
 import Undo from '@mui/icons-material/Undo';
 import PermissionIconButton from 'component/common/PermissionIconButton/PermissionIconButton';
 import Delete from '@mui/icons-material/Delete';
+import { Highlighter } from 'component/common/Highlighter/Highlighter';
+import { useSearchHighlightContext } from 'component/common/Table/SearchHighlightContext/SearchHighlightContext';
 
 export type ProjectArchiveCardProps = {
     id: string;
@@ -51,16 +53,21 @@ export const ProjectArchiveCard: FC<ProjectArchiveCardProps> = ({
     owners,
 }) => {
     const { locationSettings } = useLocationSettings();
+    const { searchQuery } = useSearchHighlightContext();
 
     return (
-        <StyledProjectCard disabled>
+        <StyledProjectCard disabled data-testid={id}>
             <StyledProjectCardBody>
                 <StyledDivHeader>
                     <StyledIconBox>
                         <ProjectIcon color='action' />
                     </StyledIconBox>
                     <StyledBox data-loading>
-                        <StyledCardTitle>{name}</StyledCardTitle>
+                        <StyledCardTitle>
+                            <Highlighter search={searchQuery}>
+                                {name}
+                            </Highlighter>
+                        </StyledCardTitle>
                     </StyledBox>
                     <ProjectModeBadge mode={mode} />
                 </StyledDivHeader>
@@ -89,6 +96,7 @@ export const ProjectArchiveCard: FC<ProjectArchiveCardProps> = ({
                                             date={
                                                 new Date(archivedAt as string)
                                             }
+                                            live={false}
                                         />
                                     </p>
                                 </Box>

diff --git a/frontend/src/component/project/ProjectList/ArchiveProjectList.test.tsx b/frontend/src/component/project/ProjectList/ArchiveProjectList.test.tsx
@@ -0,0 +1,52 @@
+import { screen, waitFor } from '@testing-library/react';
+import { render } from 'utils/testRenderer';
+import { testServerRoute, testServerSetup } from 'utils/testServer';
+import { ArchiveProjectList } from './ArchiveProjectList';
+import userEvent from '@testing-library/user-event';
+
+const server = testServerSetup();
+
+const setupApi = () => {
+    testServerRoute(server, '/api/admin/projects', {
+        projects: [
+            { id: 'testid-1', name: 'Project One', archived: true },
+            { id: 'testid-2', name: 'Project Two', archived: true },
+        ],
+    });
+
+    testServerRoute(server, '/api/admin/ui-config', {
+        flags: {
+            archiveFeature: true,
+        },
+        versionInfo: {
+            current: { enterprise: 'version' },
+        },
+    });
+};
+
+beforeEach(() => {
+    setupApi();
+});
+
+test('displays archived projects correctly', async () => {
+    render(<ArchiveProjectList />);
+
+    await waitFor(() => {
+        expect(screen.getByText('Project One')).toBeInTheDocument();
+        expect(screen.getByText('Project Two')).toBeInTheDocument();
+    });
+});
+
+test('search in header works', async () => {
+    render(<ArchiveProjectList />);
+
+    const searchInput = screen.getByPlaceholderText(/^Search/);
+    expect(searchInput).toBeInTheDocument();
+
+    await userEvent.type(searchInput, 'One');
+
+    await waitFor(() => {
+        expect(screen.queryByTestId('testid-1')).toBeInTheDocument();
+        expect(screen.queryByTestId('testid-2')).not.toBeInTheDocument();
+    });
+});
diff --git a/frontend/src/component/project/ProjectList/ArchiveProjectList.tsx b/frontend/src/component/project/ProjectList/ArchiveProjectList.tsx
@@ -1,4 +1,4 @@
-import { type FC, useEffect, useState } from 'react';
+import { type FC, useEffect, useMemo, useState } from 'react';
 import { useSearchParams } from 'react-router-dom';
 import { ConditionallyRender } from 'component/common/ConditionallyRender/ConditionallyRender';
 import { PageContent } from 'component/common/PageContent/PageContent';
@@ -15,6 +15,8 @@ import {
 import useProjects from 'hooks/api/getters/useProjects/useProjects';
 import { ReviveProjectDialog } from './ReviveProjectDialog/ReviveProjectDialog';
 import { DeleteProjectDialogue } from '../Project/DeleteProject/DeleteProjectDialogue';
+import { SearchHighlightProvider } from 'component/common/Table/SearchHighlightContext/SearchHighlightContext';
+import { safeRegExp } from '@server/util/escape-regex';
 
 const StyledApiError = styled(ApiError)(({ theme }) => ({
     maxWidth: '500px',
@@ -82,6 +84,16 @@ export const ArchiveProjectList: FC = () => {
         />
     );
 
+    const filteredProjects = useMemo(
+        () =>
+            searchValue
+                ? projects.filter((project) =>
+                      safeRegExp(searchValue, 'i').test(project.name),
+                  )
+                : projects,
+        [projects, searchValue],
+    );
+
     return (
         <PageContent
             isLoading={loading}
@@ -123,14 +135,16 @@ export const ArchiveProjectList: FC = () => {
                     )}
                 />
 
-                <ProjectGroup
-                    loading={loading}
-                    searchValue={searchValue}
-                    projects={projects}
-                    placeholder='No archived projects found'
-                    ProjectCardComponent={ProjectCard}
-                    link={false}
-                />
+                <SearchHighlightProvider value={searchValue}>
+                    <ProjectGroup
+                        loading={loading}
+                        searchValue={searchValue}
+                        projects={filteredProjects}
+                        placeholder='No archived projects found'
+                        ProjectCardComponent={ProjectCard}
+                        link={false}
+                    />
+                </SearchHighlightProvider>
             </StyledContainer>
             <ReviveProjectDialog
                 id={reviveProject.id || ''}

diff --git a/frontend/src/component/project/ProjectList/ProjectGroup.tsx b/frontend/src/component/project/ProjectList/ProjectGroup.tsx
@@ -112,6 +112,7 @@ export const ProjectGroup = <T extends { id: string }>({
                                             </StyledCardLink>
                                         ) : (
                                             <ProjectCardComponent
+                                                key={project.id}
                                                 onHover={() => {}}
                                                 {...project}
                                             />