INTEGRATION - BP-18060 - Wire up AOA packet link customer/office (PART 2 - FIX CUSTOMER ISSUE)

.github/workflows/main-to-integration-sync.yml

@@ -0,0 +1,25 @@
+name: Integration Testing Syncing
+
+on:
+  pull_request:
+    branches: main
+    types: closed
+jobs:
+  merge-main-to-int-testing:
+    if: github.event.pull_request.merged == true
+    timeout-minutes: 2
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set Git config
+      run: |
+          git config --local user.email "actions@github.com"
+          git config --local user.name "Github Actions"
+    - name: Merge main to integrationTesting-Dummy
+      run: |
+          git fetch --unshallow
+          git checkout integrationTesting-Dummy
+          git pull
+          git merge --no-ff master -m "Auto-merge main to integrationTesting-Dummy"
+          git push

migrations/app/schema/20240206173201_update_shipment_address_update_table_sit_and_distance_columns.up.sql

@@ -1,15 +1,20 @@
 -- Adds new columns to shipment address update table
 ALTER TABLE shipment_address_updates
-ADD COLUMN sit_original_address_id uuid DEFAULT NULL,
-ADD COLUMN old_sit_distance_between INTEGER DEFAULT NULL,
-ADD COLUMN new_sit_distance_between INTEGER DEFAULT NULL;
+ADD COLUMN IF NOT EXISTS sit_original_address_id uuid DEFAULT NULL,
+ADD COLUMN IF NOT EXISTS old_sit_distance_between INTEGER DEFAULT NULL,
+ADD COLUMN IF NOT EXISTS new_sit_distance_between INTEGER DEFAULT NULL;
+-- ADD COLUMN sit_original_address_id uuid DEFAULT NULL,
+-- ADD COLUMN old_sit_distance_between INTEGER DEFAULT NULL,
+-- ADD COLUMN new_sit_distance_between INTEGER DEFAULT NULL;
 
 -- Add foreign key constraint
-ALTER TABLE shipment_address_updates
-ADD CONSTRAINT fk_sit_original_address
-FOREIGN KEY (sit_original_address_id) REFERENCES addresses(id);
+-- ALTER TABLE shipment_address_updates
+-- ADD CONSTRAINT fk_sit_original_address
+-- FOREIGN KEY (sit_original_address_id) REFERENCES addresses(id);
 
 -- Comments on new columns
-COMMENT on COLUMN shipment_address_updates.sit_original_address_id IS 'SIT address at the original time of SIT approval';
-COMMENT on COLUMN shipment_address_updates.old_sit_distance_between IS 'Distance between original SIT address and previous shipment destination address';
-COMMENT on COLUMN shipment_address_updates.new_sit_distance_between IS 'Distance between original SIT address and new shipment destination address';
+-- COMMENT on COLUMN shipment_address_updates.sit_original_address_id IS 'SIT address at the original time of SIT approval';
+-- COMMENT on COLUMN shipment_address_updates.old_sit_distance_between IS 'Distance between original SIT address and previous shipment destination address';
+-- COMMENT on COLUMN shipment_address_updates.new_sit_distance_between IS 'Distance between original SIT address and new shipment destination address';
+
+--SOME COMMENT

src/components/Office/DefinitionLists/PPMShipmentInfoList.jsx

@@ -1,12 +1,12 @@
 import React from 'react';
 import * as PropTypes from 'prop-types';
 import classNames from 'classnames';
-import { Link } from 'react-router-dom';
 
 import shipmentDefinitionListsStyles from './ShipmentDefinitionLists.module.scss';
 
 import styles from 'styles/descriptionList.module.scss';
 import { formatDate } from 'shared/dates';
+import AsyncPacketDownloadLink from 'shared/AsyncPacketDownloadLink/AsyncPacketDownloadLink';
 import { ShipmentShape } from 'types/shipment';
 import { formatCentsTruncateWhole, formatWeight } from 'utils/formatters';
 import { setFlagStyles, setDisplayFlags, getDisplayFlags, fieldValidationShape } from 'utils/displayFlags';
@@ -15,7 +15,6 @@ import affiliation from 'content/serviceMemberAgencies';
 import { permissionTypes } from 'constants/permissions';
 import Restricted from 'components/Restricted/Restricted';
 import { downloadPPMAOAPacket } from 'services/ghcApi';
-import { downloadPPMAOAPacketOnSuccessHandler } from 'utils/download';
 
 const PPMShipmentInfoList = ({
   className,
@@ -72,16 +71,6 @@ const PPMShipmentInfoList = ({
     return (isExpanded || elementFlags.alwaysShow) && !elementFlags.hideRow;
   };
 
-  const handlePPMAOAPacketDownloadClick = (shipmentId) => {
-    downloadPPMAOAPacket(shipmentId)
-      .then((response) => {
-        downloadPPMAOAPacketOnSuccessHandler(response);
-      })
-      .catch(() => {
-        onErrorModalToggle();
-      });
-  };
-
   const expectedDepartureDateElementFlags = getDisplayFlags('expectedDepartureDate');
   const expectedDepartureDateElement = (
     <div className={expectedDepartureDateElementFlags.classes}>
@@ -201,9 +190,12 @@ const PPMShipmentInfoList = ({
       <dt>AOA Packet</dt>
       <dd data-testid="aoaPacketDownload">
         <p className={styles.downloadLink}>
-          <Link onClick={() => handlePPMAOAPacketDownloadClick(shipment?.ppmShipment.id)}>
-            Download AOA Paperwork (PDF)
-          </Link>
+          <AsyncPacketDownloadLink
+            id={shipment?.ppmShipment?.id}
+            label="Download AOA Paperwork (PDF)"
+            asyncRetrieval={downloadPPMAOAPacket}
+            onFailure={onErrorModalToggle}
+          />
         </p>
       </dd>
     </div>

src/components/Office/DefinitionLists/PPMShipmentInfoList.test.jsx

@@ -9,18 +9,12 @@ import { MockProviders } from 'testUtils';
 import { permissionTypes } from 'constants/permissions';
 import { ADVANCE_STATUSES } from 'constants/ppms';
 import { downloadPPMAOAPacket } from 'services/ghcApi';
-import { downloadPPMAOAPacketOnSuccessHandler } from 'utils/download';
 
 jest.mock('services/ghcApi', () => ({
   ...jest.requireActual('services/ghcApi'),
   downloadPPMAOAPacket: jest.fn(),
 }));
 
-jest.mock('utils/download', () => ({
-  ...jest.requireActual('utils/download'),
-  downloadPPMAOAPacketOnSuccessHandler: jest.fn(),
-}));
-
 afterEach(() => {
   jest.resetAllMocks();
 });
@@ -91,7 +85,6 @@ describe('PPMShipmentInfoList', () => {
 
     await waitFor(() => {
       expect(downloadPPMAOAPacket).toHaveBeenCalledTimes(1);
-      expect(downloadPPMAOAPacketOnSuccessHandler).toHaveBeenCalledTimes(1);
     });
   });
 
@@ -117,7 +110,6 @@ describe('PPMShipmentInfoList', () => {
 
     await waitFor(() => {
       expect(downloadPPMAOAPacket).toHaveBeenCalledTimes(1);
-      expect(downloadPPMAOAPacketOnSuccessHandler).toHaveBeenCalledTimes(0);
       expect(onErrorHandler).toHaveBeenCalledTimes(1);
     });
   });

src/pages/MyMove/Home/MoveHome.jsx

@@ -16,6 +16,8 @@ import {
   HelperPPMCloseoutSubmitted,
 } from './HomeHelpers';
 
+import AsyncPacketDownloadLink from 'shared/AsyncPacketDownloadLink/AsyncPacketDownloadLink';
+import DownloadAOAErrorModal from 'shared/DownloadAOAErrorModal/DownloadAOAErrorModal';
 import ConnectedDestructiveShipmentConfirmationModal from 'components/ConfirmationModals/DestructiveShipmentConfirmationModal';
 import Contact from 'components/Customer/Home/Contact';
 import DocsUploaded from 'components/Customer/Home/DocsUploaded';
@@ -30,7 +32,7 @@ import MOVE_STATUSES from 'constants/moves';
 import { customerRoutes } from 'constants/routes';
 import { ppmShipmentStatuses, shipmentTypes } from 'constants/shipments';
 import ConnectedFlashMessage from 'containers/FlashMessage/FlashMessage';
-import { deleteMTOShipment, getAllMoves, getMTOShipmentsForMove } from 'services/internalApi';
+import { deleteMTOShipment, getAllMoves, getMTOShipmentsForMove, downloadPPMAOAPacket } from 'services/internalApi';
 import { withContext } from 'shared/AppContext';
 import { SHIPMENT_OPTIONS } from 'shared/constants';
 import {
@@ -79,6 +81,7 @@ const MoveHome = ({ serviceMemberMoves, isProfileComplete, serviceMember, signed
   const [targetShipmentId, setTargetShipmentId] = useState(null);
   const [showDeleteSuccessAlert, setShowDeleteSuccessAlert] = useState(false);
   const [showDeleteErrorAlert, setShowDeleteErrorAlert] = useState(false);
+  const [showDownloadPPMAOAPaperworkErrorAlert, setShowDownloadPPMAOAPaperworkErrorAlert] = useState(false);
 
   // fetching all move data on load since this component is dependent on that data
   // this will run each time the component is loaded/accessed
@@ -371,6 +374,10 @@ const MoveHome = ({ serviceMemberMoves, isProfileComplete, serviceMember, signed
     );
   };
 
+  const toggleDownloadAOAErrorModal = () => {
+    setShowDownloadPPMAOAPaperworkErrorAlert(!showDownloadPPMAOAPaperworkErrorAlert);
+  };
+
   // early return if loading user/service member
   if (!serviceMember) {
     return (
@@ -414,6 +421,7 @@ const MoveHome = ({ serviceMemberMoves, isProfileComplete, serviceMember, signed
         submitText="Yes, Delete"
         closeText="No, Keep It"
       />
+      <DownloadAOAErrorModal isOpen={showDownloadPPMAOAPaperworkErrorAlert} closeModal={toggleDownloadAOAErrorModal} />
       <div className={styles.homeContainer}>
         <header data-testid="customer-header" className={styles['customer-header']}>
           <div className={`usa-prose grid-container ${styles['grid-container']}`}>
@@ -587,11 +595,13 @@ const MoveHome = ({ serviceMemberMoves, isProfileComplete, serviceMember, signed
                                   {` ${shipmentNumber} `}
                                 </strong>
                                 {shipment?.ppmShipment?.advanceStatus === ADVANCE_STATUSES.APPROVED.apiValue && (
-                                  // TODO: B-18060 will add link to method that will create the AOA packet and return for download
                                   <p className={styles.downloadLink}>
-                                    <a href="">
-                                      <span>Download AOA Paperwork (PDF)</span>
-                                    </a>
+                                    <AsyncPacketDownloadLink
+                                      id={shipment?.ppmShipment?.id}
+                                      label="Download AOA Paperwork (PDF)"
+                                      asyncRetrieval={downloadPPMAOAPacket}
+                                      onFailure={toggleDownloadAOAErrorModal}
+                                    />
                                   </p>
                                 )}
                                 {shipment?.ppmShipment?.advanceStatus === ADVANCE_STATUSES.REJECTED.apiValue && (

src/pages/MyMove/Home/MoveHome.test.jsx

@@ -2,11 +2,13 @@
 import React from 'react';
 import { v4 } from 'uuid';
 import { mount } from 'enzyme';
+import { waitFor } from '@testing-library/react';
 
 import MoveHome from './MoveHome';
 
 import { customerRoutes } from 'constants/routes';
 import { MockProviders } from 'testUtils';
+import { downloadPPMAOAPacket } from 'services/internalApi';
 
 jest.mock('containers/FlashMessage/FlashMessage', () => {
   const MockFlash = () => <div>Flash message</div>;
@@ -29,6 +31,7 @@ jest.mock('services/internalApi', () => ({
   deleteMTOShipment: jest.fn(),
   getMTOShipmentsForMove: jest.fn(),
   getAllMoves: jest.fn().mockImplementation(() => Promise.resolve()),
+  downloadPPMAOAPacket: jest.fn().mockImplementation(() => Promise.resolve()),
 }));
 
 const props = {
@@ -794,6 +797,8 @@ const defaultPropsAmendedOrdersWithAdvanceRequested = {
   uploadedAmendedOrderDocuments: [],
 };
 
+const expectedPpmShipmentID = 'd18b865f-fd12-495d-91fa-65b53d72705a';
+
 const defaultPropsWithAdvanceAndPPMApproved = {
   ...props,
   serviceMemberMoves: {
@@ -829,7 +834,7 @@ const defaultPropsWithAdvanceAndPPMApproved = {
               hasProGear: false,
               hasReceivedAdvance: null,
               hasRequestedAdvance: true,
-              id: 'd18b865f-fd12-495d-91fa-65b53d72705a',
+              id: expectedPpmShipmentID,
               movingExpenses: [],
               pickupPostalCode: '74133',
               proGearWeight: null,
@@ -1248,5 +1253,37 @@ describe('Home component', () => {
       expect(confirmMoveRequest.prop('actionBtnDisabled')).toBeFalsy();
       expect(confirmMoveRequest.prop('actionBtnLabel')).toBe('Review your request');
     });
+
+    it('Download AOA Paperwork - success', async () => {
+      const buttonId = `button[data-testid="asyncPacketDownloadLink${expectedPpmShipmentID}"]`;
+      expect(wrapper.find(buttonId).length).toBe(1);
+      const mockResponse = {
+        ok: true,
+        headers: {
+          'content-disposition': 'filename="test.pdf"',
+        },
+        status: 200,
+        data: null,
+      };
+      downloadPPMAOAPacket.mockImplementation(() => Promise.resolve(mockResponse));
+      await wrapper.find(buttonId).simulate('click');
+      await waitFor(() => {
+        expect(downloadPPMAOAPacket).toHaveBeenCalledTimes(1);
+      });
+    });
+
+    it('Download AOA Paperwork - failure', async () => {
+      const buttonId = `button[data-testid="asyncPacketDownloadLink${expectedPpmShipmentID}"]`;
+      expect(wrapper.find(buttonId).length).toBe(1);
+      downloadPPMAOAPacket.mockRejectedValue({
+        response: { body: { title: 'Error title', detail: 'Error detail' } },
+      });
+      await wrapper.find(buttonId).simulate('click');
+      await waitFor(() => {
+        // scrape text from error modal
+        expect(wrapper.text()).toContain('Something went wrong downloading PPM AOA paperwork');
+        expect(downloadPPMAOAPacket).toHaveBeenCalledTimes(1);
+      });
+    });
   });
 });

src/pages/MyMove/Home/index.jsx

@@ -3,7 +3,7 @@ import { arrayOf, bool, func, node, shape, string } from 'prop-types';
 import moment from 'moment';
 import { connect } from 'react-redux';
 import { Alert, Button } from '@trussworks/react-uswds';
-import { generatePath, Link } from 'react-router-dom';
+import { generatePath } from 'react-router-dom';
 
 import styles from './Home.module.scss';
 import {
@@ -16,6 +16,7 @@ import {
   HelperPPMCloseoutSubmitted,
 } from './HomeHelpers';
 
+import AsyncPacketDownloadLink from 'shared/AsyncPacketDownloadLink/AsyncPacketDownloadLink';
 import ConnectedDestructiveShipmentConfirmationModal from 'components/ConfirmationModals/DestructiveShipmentConfirmationModal';
 import Contact from 'components/Customer/Home/Contact';
 import DocsUploaded from 'components/Customer/Home/DocsUploaded';
@@ -52,7 +53,6 @@ import { MoveShape, OrdersShape, UploadShape } from 'types/customerShapes';
 import { ShipmentShape } from 'types/shipment';
 import { formatCustomerDate, formatWeight } from 'utils/formatters';
 import { isPPMAboutInfoComplete, isPPMShipmentComplete, isWeightTicketComplete } from 'utils/shipments';
-import { downloadPPMAOAPacketOnSuccessHandler } from 'utils/download';
 import withRouter from 'utils/routing';
 import { RouterShape } from 'types/router';
 import { ADVANCE_STATUSES } from 'constants/ppms';
@@ -369,17 +369,6 @@ export class Home extends Component {
     }));
   };
 
-  // eslint-disable-next-line class-methods-use-this
-  handlePPMAOAPacketDownloadClick = (shipmentId) => {
-    downloadPPMAOAPacket(shipmentId)
-      .then((response) => {
-        downloadPPMAOAPacketOnSuccessHandler(response);
-      })
-      .catch(() => {
-        this.toggleDownloadAOAErrorModal();
-      });
-  };
-
   // eslint-disable-next-line class-methods-use-this
   sortAllShipments = (mtoShipments) => {
     const allShipments = JSON.parse(JSON.stringify(mtoShipments));
@@ -637,11 +626,12 @@ export class Home extends Component {
                                   </strong>
                                   {shipment?.ppmShipment?.advanceStatus === ADVANCE_STATUSES.APPROVED.apiValue && (
                                     <p className={styles.downloadLink}>
-                                      <Link
-                                        onClick={() => this.handlePPMAOAPacketDownloadClick(shipment?.ppmShipment.id)}
-                                      >
-                                        Download AOA Paperwork (PDF)
-                                      </Link>
+                                      <AsyncPacketDownloadLink
+                                        id={shipment?.ppmShipment?.id}
+                                        label="Download AOA Paperwork (PDF)"
+                                        asyncRetrieval={downloadPPMAOAPacket}
+                                        onFailure={this.toggleDownloadAOAErrorModal}
+                                      />
                                     </p>
                                   )}
                                   {shipment?.ppmShipment?.advanceStatus === ADVANCE_STATUSES.REJECTED.apiValue && (

src/pages/MyMove/Home/index.test.jsx

@@ -24,7 +24,6 @@ import {
   createSubmittedPPMShipment,
 } from 'utils/test/factories/ppmShipment';
 import { downloadPPMAOAPacket } from 'services/internalApi';
-import { downloadPPMAOAPacketOnSuccessHandler } from 'utils/download';
 
 jest.mock('containers/FlashMessage/FlashMessage', () => {
   const MockFlash = () => <div>Flash message</div>;
@@ -43,11 +42,6 @@ jest.mock('services/internalApi', () => ({
   downloadPPMAOAPacket: jest.fn(),
 }));
 
-jest.mock('utils/download', () => ({
-  ...jest.requireActual('utils/download'),
-  downloadPPMAOAPacketOnSuccessHandler: jest.fn(),
-}));
-
 const defaultProps = {
   serviceMember: {
     id: v4(),
@@ -661,7 +655,6 @@ describe('Home component', () => {
             screen.getByText(/Something went wrong downloading PPM AOA paperwork./, { exact: false }),
           ).toBeInTheDocument();
           expect(downloadPPMAOAPacket).toHaveBeenCalledTimes(1);
-          expect(downloadPPMAOAPacketOnSuccessHandler).toHaveBeenCalledTimes(0);
         });
       });
 
@@ -694,7 +687,6 @@ describe('Home component', () => {
 
         await waitFor(() => {
           expect(downloadPPMAOAPacket).toHaveBeenCalledTimes(1);
-          expect(downloadPPMAOAPacketOnSuccessHandler).toHaveBeenCalledTimes(1);
         });
       });
     });