Acquisition File Header | psp-6936 (#3507)

* Addded last updated by acquisition * minor fix * Fixed issues with some pages
bcgov · Oct 7, 2023 · 977165a · 977165a
1 parent f6d6e3f
commit 977165a
Show file tree

Hide file tree

Showing 27 changed files with 661 additions and 50 deletions.
diff --git a/source/backend/api/Areas/Acquisition/Controllers/AcquisitionFileController.cs b/source/backend/api/Areas/Acquisition/Controllers/AcquisitionFileController.cs
@@ -83,6 +83,21 @@ public IActionResult GetAcquisitionFile(long id)
             return new JsonResult(_mapper.Map<AcquisitionFileModel>(acqFile));
         }
 
+        /// <summary>
+        /// Gets the specified acquisition file last updated-by information.
+        /// </summary>
+        /// <returns></returns>
+        [HttpGet("{id:long}/updateInfo")]
+        [HasPermission(Permissions.AcquisitionFileView)]
+        [Produces("application/json")]
+        [ProducesResponseType(typeof(Dal.Entities.Models.LastUpdatedByModel), 200)]
+        [SwaggerOperation(Tags = new[] { "acquisitionfile" })]
+        public IActionResult GetLastUpdatedBy(long id)
+        {
+            var lastUpdated = _acquisitionService.GetLastUpdateInformation(id);
+            return new JsonResult(lastUpdated);
+        }
+
         /// <summary>
         /// Adds the specified acquisition file.
         /// </summary>

diff --git a/source/backend/api/Services/AcquisitionFileService.cs b/source/backend/api/Services/AcquisitionFileService.cs
@@ -134,6 +134,14 @@ public PimsAcquisitionFile GetById(long id)
             return acqFile;
         }
 
+        public LastUpdatedByModel GetLastUpdateInformation(long acquisitionFileId)
+        {
+            _logger.LogInformation("Retrieving last updated-by information...");
+            _user.ThrowIfNotAuthorized(Permissions.AcquisitionFileView);
+
+            return _acqFileRepository.GetLastUpdateBy(acquisitionFileId);
+        }
+
         public IEnumerable<PimsPropertyAcquisitionFile> GetProperties(long id)
         {
             _logger.LogInformation("Getting acquisition file with id {id}", id);

diff --git a/source/backend/api/Services/IAcquisitionFileService.cs b/source/backend/api/Services/IAcquisitionFileService.cs
@@ -11,6 +11,8 @@ public interface IAcquisitionFileService
 
         PimsAcquisitionFile GetById(long id);
 
+        LastUpdatedByModel GetLastUpdateInformation(long acquisitionFileId);
+
         PimsAcquisitionFile Add(PimsAcquisitionFile acquisitionFile, IEnumerable<UserOverrideCode> userOverrides);
 
         PimsAcquisitionFile Update(PimsAcquisitionFile acquisitionFile, IEnumerable<UserOverrideCode> userOverrides);

diff --git a/source/backend/dal/Repositories/AcquisitionFileRepository.cs b/source/backend/dal/Repositories/AcquisitionFileRepository.cs
diff --git a/source/backend/dal/Repositories/Interfaces/IAcquisitionFileRepository.cs b/source/backend/dal/Repositories/Interfaces/IAcquisitionFileRepository.cs
@@ -10,6 +10,8 @@ public interface IAcquisitionFileRepository : IRepository
 
         PimsAcquisitionFile GetById(long id);
 
+        LastUpdatedByModel GetLastUpdateBy(long id);
+
         List<PimsAcquisitionOwner> GetOwnersByAcquisitionFileId(long acquisitionFileId);
 
         List<PimsAcquisitionFilePerson> GetTeamMembers(HashSet<short> regions, long? contractorPersonId = null);

diff --git a/source/frontend/src/features/mapSideBar/acquisition/AcquisitionContainer.test.tsx b/source/frontend/src/features/mapSideBar/acquisition/AcquisitionContainer.test.tsx
@@ -10,6 +10,7 @@ import {
   mockAcquisitionFileOwnersResponse,
   mockAcquisitionFileResponse,
 } from '@/mocks/acquisitionFiles.mock';
+import { mockLastUpdatedBy } from '@/mocks/lastUpdatedBy.mock';
 import { mockLookups } from '@/mocks/lookups.mock';
 import { mapMachineBaseMock } from '@/mocks/mapFSM.mock';
 import { mockNotesResponse } from '@/mocks/noteResponses.mock';
@@ -39,7 +40,6 @@ jest.mock('@/features/documents/hooks/useDocumentGenerationRepository');
 }));
 
 jest.mock('@/components/common/mapFSM/MapStateMachineContext');
-(useMapStateMachine as jest.Mock).mockImplementation(() => mapMachineBaseMock);
 
 const onClose = jest.fn();
 
@@ -96,10 +96,13 @@ describe('AcquisitionContainer component', () => {
   };
 
   beforeEach(() => {
+    (useMapStateMachine as jest.Mock).mockImplementation(() => mapMachineBaseMock);
+
     mockAxios.onGet(new RegExp('users/info/*')).reply(200, {});
     mockAxios
       .onGet(new RegExp('acquisitionfiles/1/properties'))
       .reply(200, mockAcquisitionFileResponse().fileProperties);
+    mockAxios.onGet(new RegExp('acquisitionfiles/1/updateInfo')).reply(200, mockLastUpdatedBy(1));
     mockAxios
       .onGet(new RegExp('acquisitionfiles/1/owners'))
       .reply(200, mockAcquisitionFileOwnersResponse());

diff --git a/source/frontend/src/features/mapSideBar/acquisition/AcquisitionContainer.tsx b/source/frontend/src/features/mapSideBar/acquisition/AcquisitionContainer.tsx
@@ -51,11 +51,21 @@ const initialState: AcquisitionContainerState = {
 export const AcquisitionContainer: React.FunctionComponent<IAcquisitionContainerProps> = props => {
   // Load state from props and side-bar context
   const { acquisitionFileId, onClose, View } = props;
-  const { setFile, setFileLoading, staleFile, setStaleFile, file } = useContext(SideBarContext);
+  const {
+    setFile,
+    setFileLoading,
+    staleFile,
+    setStaleFile,
+    file,
+    setLastUpdatedBy,
+    lastUpdatedBy,
+    staleLastUpdatedBy,
+  } = useContext(SideBarContext);
   const [isValid, setIsValid] = useState<boolean>(true);
   const withUserOverride = useApiUserOverride<
     (userOverrideCodes: UserOverrideCode[]) => Promise<any | void>
   >('Failed to update Acquisition File');
+
   const {
     getAcquisitionFile: { execute: retrieveAcquisitionFile, loading: loadingAcquisitionFile },
     updateAcquisitionProperties,
@@ -64,6 +74,7 @@ export const AcquisitionContainer: React.FunctionComponent<IAcquisitionContainer
       loading: loadingAcquisitionFileProperties,
     },
     getAcquisitionFileChecklist: { execute: retrieveAcquisitionFileChecklist },
+    getLastUpdatedBy: { execute: getLastUpdatedBy, loading: loadingGetLastUpdatedBy },
   } = useAcquisitionProvider();
 
   const mapMachine = useMapStateMachine();
@@ -131,15 +142,42 @@ export const AcquisitionContainer: React.FunctionComponent<IAcquisitionContainer
     setStaleFile,
   ]);
 
+  const fetchLastUpdatedBy = React.useCallback(async () => {
+    var retrieved = await getLastUpdatedBy(acquisitionFileId);
+    if (retrieved !== undefined) {
+      setLastUpdatedBy(retrieved);
+    } else {
+      setLastUpdatedBy(null);
+    }
+  }, [acquisitionFileId, getLastUpdatedBy, setLastUpdatedBy]);
+
+  React.useEffect(() => {
+    if (
+      lastUpdatedBy === undefined ||
+      acquisitionFileId !== lastUpdatedBy?.parentId ||
+      staleLastUpdatedBy
+    ) {
+      fetchLastUpdatedBy();
+    }
+  }, [fetchLastUpdatedBy, lastUpdatedBy, acquisitionFileId, staleLastUpdatedBy]);
+
   useEffect(() => {
     if (acquisitionFile === undefined || acquisitionFileId !== acquisitionFile.id || staleFile) {
       fetchAcquisitionFile();
     }
   }, [acquisitionFile, fetchAcquisitionFile, acquisitionFileId, staleFile]);
 
   useEffect(
-    () => setFileLoading(loadingAcquisitionFile || loadingAcquisitionFileProperties),
-    [loadingAcquisitionFile, setFileLoading, loadingAcquisitionFileProperties],
+    () =>
+      setFileLoading(
+        loadingAcquisitionFile || loadingAcquisitionFileProperties || loadingGetLastUpdatedBy,
+      ),
+    [
+      loadingAcquisitionFile,
+      setFileLoading,
+      loadingAcquisitionFileProperties,
+      loadingGetLastUpdatedBy,
+    ],
   );
 
   const close = useCallback(() => onClose && onClose(), [onClose]);
@@ -207,6 +245,7 @@ export const AcquisitionContainer: React.FunctionComponent<IAcquisitionContainer
 
   const onSuccess = () => {
     fetchAcquisitionFile();
+    fetchLastUpdatedBy();
     mapMachine.refreshMapProperties();
     setIsEditing(false);
   };

diff --git a/source/frontend/src/features/mapSideBar/acquisition/AcquisitionView.test.tsx b/source/frontend/src/features/mapSideBar/acquisition/AcquisitionView.test.tsx
@@ -11,6 +11,7 @@ import {
   mockAcquisitionFileResponse,
 } from '@/mocks/acquisitionFiles.mock';
 import { getMockApiInterestHolders } from '@/mocks/interestHolders.mock';
+import { mockLastUpdatedBy } from '@/mocks/lastUpdatedBy.mock';
 import { mockLookups } from '@/mocks/lookups.mock';
 import { mapMachineBaseMock } from '@/mocks/mapFSM.mock';
 import { rest, server } from '@/mocks/msw/server';
@@ -89,6 +90,9 @@ describe('AcquisitionView component', () => {
           ...mockAcquisitionFileResponse(),
           fileType: FileTypes.Acquisition,
         }}
+        lastUpdatedBy={{
+          ...mockLastUpdatedBy(1),
+        }}
       >
         <Route path="/mapview/sidebar/acquisition/:id">
           <AcquisitionView {...props} />
@@ -149,7 +153,7 @@ describe('AcquisitionView component', () => {
     expect(getByText('1-12345-01 - Test ACQ File')).toBeVisible();
     expect(getByText(prettyFormatUTCDate(testAcquisitionFile.appCreateTimestamp))).toBeVisible();
     expect(
-      getByText(prettyFormatUTCDate(testAcquisitionFile.appLastUpdateTimestamp)),
+      getByText(prettyFormatUTCDate(mockLastUpdatedBy(1).appLastUpdateTimestamp)),
     ).toBeVisible();
   });
 

diff --git a/source/frontend/src/features/mapSideBar/acquisition/AcquisitionView.tsx b/source/frontend/src/features/mapSideBar/acquisition/AcquisitionView.tsx
@@ -71,7 +71,7 @@ export const AcquisitionView: React.FunctionComponent<IAcquisitionViewProps> = (
   const location = useLocation();
   const history = useHistory();
   const match = useRouteMatch();
-  const { file } = useContext(SideBarContext);
+  const { file, lastUpdatedBy } = useContext(SideBarContext);
   if (!!file && file?.fileType !== FileTypes.Acquisition) {
     throw Error('Context file is not an acquisition file');
   }
@@ -130,7 +130,9 @@ export const AcquisitionView: React.FunctionComponent<IAcquisitionViewProps> = (
               className="mr-2"
             />
           }
-          header={<AcquisitionHeader acquisitionFile={acquisitionFile} />}
+          header={
+            <AcquisitionHeader acquisitionFile={acquisitionFile} lastUpdatedBy={lastUpdatedBy} />
+          }
           footer={
             isEditing && (
               <SidebarFooter

diff --git a/.../frontend/src/features/mapSideBar/acquisition/__snapshots__/AcquisitionView.test.tsx.snap b/.../frontend/src/features/mapSideBar/acquisition/__snapshots__/AcquisitionView.test.tsx.snap
@@ -221,7 +221,7 @@ exports[`AcquisitionView component renders as expected 1`] = `
             >
               Last updated: 
               <strong>
-                Jul 27, 2022
+                Oct 6, 2023
               </strong>
                by 
               <span
@@ -230,7 +230,7 @@ exports[`AcquisitionView component renders as expected 1`] = `
                 id="userNameTooltip"
               >
                 <strong>
-                  admin
+                  MARODRIG
                 </strong>
               </span>
             </span>

diff --git a/source/frontend/src/features/mapSideBar/acquisition/common/AcquisitionHeader.test.tsx b/source/frontend/src/features/mapSideBar/acquisition/common/AcquisitionHeader.test.tsx
@@ -12,9 +12,15 @@ const mockAxios = new MockAdapter(axios);
 describe('AcquisitionHeader component', () => {
   // render component under test
   const setup = (props: IAcquisitionHeaderProps, renderOptions: RenderOptions = {}) => {
-    const utils = render(<AcquisitionHeader acquisitionFile={props.acquisitionFile} />, {
-      ...renderOptions,
-    });
+    const utils = render(
+      <AcquisitionHeader
+        acquisitionFile={props.acquisitionFile}
+        lastUpdatedBy={props.lastUpdatedBy}
+      />,
+      {
+        ...renderOptions,
+      },
+    );
 
     return { ...utils };
   };
@@ -29,13 +35,21 @@ describe('AcquisitionHeader component', () => {
   });
 
   it('renders as expected when no data is provided', () => {
-    const { asFragment } = setup({});
+    const { asFragment } = setup({ lastUpdatedBy: null });
     expect(asFragment()).toMatchSnapshot();
   });
 
   it('renders as expected when an acquisition file is provided', async () => {
     const testAcquisitionFile = mockAcquisitionFileResponse();
-    const { getByText } = setup({ acquisitionFile: testAcquisitionFile });
+    const { getByText } = setup({
+      acquisitionFile: testAcquisitionFile,
+      lastUpdatedBy: {
+        parentId: testAcquisitionFile.id || 0,
+        appLastUpdateUserid: testAcquisitionFile.appLastUpdateUserid || '',
+        appLastUpdateUserGuid: testAcquisitionFile.appLastUpdateUserGuid || '',
+        appLastUpdateTimestamp: testAcquisitionFile.appLastUpdateTimestamp || '',
+      },
+    });
 
     expect(getByText('1-12345-01 - Test ACQ File')).toBeVisible();
     expect(getByText(prettyFormatUTCDate(testAcquisitionFile.appCreateTimestamp))).toBeVisible();
@@ -46,15 +60,15 @@ describe('AcquisitionHeader component', () => {
 
   it('renders the file number and name concatenated', async () => {
     const testAcquisitionFile = mockAcquisitionFileResponse();
-    const { getByText } = setup({ acquisitionFile: testAcquisitionFile });
+    const { getByText } = setup({ acquisitionFile: testAcquisitionFile, lastUpdatedBy: null });
 
     expect(getByText('File:')).toBeVisible();
     expect(getByText('1-12345-01 - Test ACQ File')).toBeVisible();
   });
 
   it('renders the file Project Number and name concatenated', async () => {
     const testAcquisitionFile = mockAcquisitionFileResponse();
-    const { getByText } = setup({ acquisitionFile: testAcquisitionFile });
+    const { getByText } = setup({ acquisitionFile: testAcquisitionFile, lastUpdatedBy: null });
 
     expect(getByText('Ministry project:')).toBeVisible();
     expect(
@@ -66,7 +80,7 @@ describe('AcquisitionHeader component', () => {
 
   it('renders the file Product code and description concatenated', async () => {
     const testAcquisitionFile = mockAcquisitionFileResponse();
-    const { getByText } = setup({ acquisitionFile: testAcquisitionFile });
+    const { getByText } = setup({ acquisitionFile: testAcquisitionFile, lastUpdatedBy: null });
 
     expect(getByText('Ministry product:')).toBeVisible();
     expect(getByText('00048 - MISCELLANEOUS CLAIMS')).toBeVisible();
@@ -81,9 +95,28 @@ describe('AcquisitionHeader component', () => {
         productId: null,
         projectId: null,
       },
+      lastUpdatedBy: null,
     });
 
     expect(getByText('Ministry product:')).toBeVisible();
     expect(getByTestId('acq-header-product-val')).toHaveTextContent('');
   });
+
+  it('renders the last-update-time when provided', async () => {
+    const testDate = new Date().toISOString();
+    const testAcquisitionFile = mockAcquisitionFileResponse();
+    const { getByText } = setup({
+      acquisitionFile: testAcquisitionFile,
+      lastUpdatedBy: {
+        parentId: testAcquisitionFile.id || 0,
+        appLastUpdateUserid: 'Test User Id',
+        appLastUpdateUserGuid: 'TEST GUID',
+        appLastUpdateTimestamp: testDate,
+      },
+    });
+
+    expect(getByText('1-12345-01 - Test ACQ File')).toBeVisible();
+    expect(getByText(prettyFormatUTCDate(testAcquisitionFile.appCreateTimestamp))).toBeVisible();
+    expect(getByText(prettyFormatUTCDate(testDate))).toBeVisible();
+  });
 });
diff --git a/source/frontend/src/features/mapSideBar/acquisition/common/AcquisitionHeader.tsx b/source/frontend/src/features/mapSideBar/acquisition/common/AcquisitionHeader.tsx
@@ -5,15 +5,17 @@ import styled from 'styled-components';
 import { HeaderField } from '@/components/common/HeaderField/HeaderField';
 import { UserNameTooltip } from '@/components/common/UserNameTooltip';
 import { Api_AcquisitionFile } from '@/models/api/AcquisitionFile';
+import { Api_LastUpdatedBy } from '@/models/api/File';
 import { prettyFormatUTCDate } from '@/utils';
 
 export interface IAcquisitionHeaderProps {
   acquisitionFile?: Api_AcquisitionFile;
+  lastUpdatedBy: Api_LastUpdatedBy | null;
 }
 
 export const AcquisitionHeader: React.FunctionComponent<
   React.PropsWithChildren<IAcquisitionHeaderProps>
-> = ({ acquisitionFile }) => {
+> = ({ acquisitionFile, lastUpdatedBy }) => {
   const leftColumnWidth = '7';
   const leftColumnLabel = '3';
 
@@ -71,10 +73,10 @@ export const AcquisitionHeader: React.FunctionComponent<
           <Col className="text-right">
             <StyleSmallText>
               Last updated:{' '}
-              <strong>{prettyFormatUTCDate(acquisitionFile?.appLastUpdateTimestamp)}</strong> by{' '}
+              <strong>{prettyFormatUTCDate(lastUpdatedBy?.appLastUpdateTimestamp)}</strong> by{' '}
               <UserNameTooltip
-                userName={acquisitionFile?.appLastUpdateUserid}
-                userGuid={acquisitionFile?.appLastUpdateUserGuid}
+                userName={lastUpdatedBy?.appLastUpdateUserid}
+                userGuid={lastUpdatedBy?.appLastUpdateUserGuid}
               />
             </StyleSmallText>
           </Col>