Merge pull request #5592 from flexion/10525-test-bugfix

10525: Fix minor PDF generated UI fix + back merge;
flexion · Nov 25, 2024 · 438df35 · 438df35
2 parents 0620e69 + 7b22236
commit 438df35
Show file tree

Hide file tree

Showing 29 changed files with 5,036 additions and 7,203 deletions.
diff --git a/...etail/docketRecord/docketRecordSort.cy.ts → ...ail/docketRecord/docket-record-sort.cy.ts b/...etail/docketRecord/docketRecordSort.cy.ts → ...ail/docketRecord/docket-record-sort.cy.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/shared/src/business/entities/EntityConstants.ts b/shared/src/business/entities/EntityConstants.ts
@@ -6,8 +6,9 @@ import courtIssuedEventCodesJson from '../../tools/courtIssuedEventCodes.json';
 import externalFilingEventsJson from '../../tools/externalFilingEvents.json';
 import internalFilingEventsJson from '../../tools/internalFilingEvents.json';
 
-export const KEYS = {
-  DOCKET_RECORD_TABLE_SORT: 'DOCKET_RECORD_TABLE_SORT',
+export const STATE_KEYS = {
+  DOCKET_RECORD_TABLE_SORT:
+    'DOCKET_RECORD_TABLE_SORT' as 'DOCKET_RECORD_TABLE_SORT',
 };
 
 export const DEBOUNCE_TIME_MILLISECONDS = 500;

diff --git a/shared/src/business/entities/trialSessions/SpecialTrialSessions.ts b/shared/src/business/entities/trialSessions/SpecialTrialSessions.ts
@@ -0,0 +1,14 @@
+export type SpecialTrialSession = {
+  userId: string;
+  trialSessionId: string;
+};
+
+export type SpecialTrialSessionKey = {
+  pk: string;
+  sk: string;
+};
+
+export type TrialSessionWorkingCopyNotes = {
+  sessionNotes: string;
+  trialSessionId: string;
+};
diff --git a/shared/src/proxies/trialSessions/getBulkSpecialTrialSessionCopyNotesProxy.ts b/shared/src/proxies/trialSessions/getBulkSpecialTrialSessionCopyNotesProxy.ts
@@ -1,7 +1,7 @@
 import {
   SpecialTrialSession,
   TrialSessionWorkingCopyNotes,
-} from '@shared/business/entities/trialSessions/SpeciailTrialSessions';
+} from '@shared/business/entities/trialSessions/SpecialTrialSessions';
 import { post } from '../requests';
 
 export const getBulkSpecialTrialSessionCopyNotesInteractor = (

diff --git a/tmp.md b/tmp.md
diff --git a/web-api/src/business/useCases/generateDocketRecordPdfInteractor.test.ts b/web-api/src/business/useCases/generateDocketRecordPdfInteractor.test.ts
@@ -377,5 +377,39 @@ describe('generateDocketRecordPdfInteractor', () => {
         },
       ]);
     });
+
+    it('should default numberOfPages to 0 to correctly sort the docket entries', async () => {
+      caseDetail.docketEntries = [
+        { index: 1, isOnDocketRecord: true, numberOfPages: 1 },
+        { index: 2, isOnDocketRecord: true, numberOfPages: 3 },
+        { index: 3, isOnDocketRecord: true, numberOfPages: undefined },
+      ];
+
+      await generateDocketRecordPdfInteractor(
+        applicationContext,
+        {
+          docketNumber: caseDetail.docketNumber,
+          docketRecordTableSort: {
+            sortField: 'numberOfPages',
+            sortOrder: 'asc',
+          },
+          isIndirectlyAssociated: true,
+        } as any,
+        mockPetitionerUser,
+      );
+
+      const docketRecordCalls =
+        applicationContext.getDocumentGenerators().docketRecord.mock.calls;
+      expect(docketRecordCalls.length).toEqual(1);
+
+      const {
+        data: { entries },
+      } = docketRecordCalls[0][0];
+      expect(entries).toMatchObject([
+        { index: 3, isOnDocketRecord: true, numberOfPages: 0 },
+        { index: 1, isOnDocketRecord: true, numberOfPages: 1 },
+        { index: 2, isOnDocketRecord: true, numberOfPages: 3 },
+      ]);
+    });
   });
 });
diff --git a/web-api/src/business/useCases/generateDocketRecordPdfInteractor.ts b/web-api/src/business/useCases/generateDocketRecordPdfInteractor.ts
@@ -83,6 +83,12 @@ export const generateDocketRecordPdfInteractor = async (
       docketRecordSort,
     });
 
+  formattedCaseDetail.formattedDocketEntries =
+    formattedCaseDetail.formattedDocketEntries.map(docketEntry => ({
+      ...docketEntry,
+      numberOfPages: docketEntry.numberOfPages || 0,
+    }));
+
   const sortedDocketEntries = sortDocketEntryTable(
     formattedCaseDetail.formattedDocketEntries,
     docketRecordTableSort && docketRecordTableSort.sortField,

diff --git a/web-api/src/business/useCases/trialSessions/getBulkTrialSessionCopyNotesInteractor.ts b/web-api/src/business/useCases/trialSessions/getBulkTrialSessionCopyNotesInteractor.ts
@@ -7,7 +7,7 @@ import {
   SpecialTrialSession,
   SpecialTrialSessionKey,
   TrialSessionWorkingCopyNotes,
-} from '@shared/business/entities/trialSessions/SpeciailTrialSessions';
+} from '@shared/business/entities/trialSessions/SpecialTrialSessions';
 import { UnauthorizedError } from '@web-api/errors/errors';
 import { UnknownAuthUser } from '@shared/business/entities/authUser/AuthUser';
 

diff --git a/web-api/src/persistence/dynamo/trialSessions/getBulkTrialSessionWorkingCopies.ts b/web-api/src/persistence/dynamo/trialSessions/getBulkTrialSessionWorkingCopies.ts
@@ -1,5 +1,5 @@
 import { TDynamoRecord } from '../dynamoTypes';
-import { TrialSessionWorkingCopyNotes } from '@shared/business/entities/trialSessions/SpeciailTrialSessions';
+import { TrialSessionWorkingCopyNotes } from '@shared/business/entities/trialSessions/SpecialTrialSessions';
 import { batchGet } from '../../dynamodbClientService';
 
 export const getBulkTrialSessionWorkingCopies = async ({

diff --git a/web-client/src/presenter/actions/Public/generatePublicDocketRecordPdfUrlAction.ts b/web-client/src/presenter/actions/Public/generatePublicDocketRecordPdfUrlAction.ts
@@ -1,5 +1,5 @@
 import { ClientPublicApplicationContext } from '@web-client/applicationContextPublic';
-import { KEYS } from '@shared/business/entities/EntityConstants';
+import { STATE_KEYS } from '@shared/business/entities/EntityConstants';
 import { state } from '@web-client/presenter/app-public.cerebral';
 /**
  * invokes the generate public docket record endpoint to get back the pdf url
@@ -13,10 +13,10 @@ export const generatePublicDocketRecordPdfUrlAction = async ({
 }: ActionProps<{}, ClientPublicApplicationContext>) => {
   const docketNumber = get(state.caseDetail.docketNumber);
   const docketRecordSortField = get(
-    state[KEYS.DOCKET_RECORD_TABLE_SORT].sortField,
+    state[STATE_KEYS.DOCKET_RECORD_TABLE_SORT].sortField,
   );
   const docketRecordSortOrder = get(
-    state[KEYS.DOCKET_RECORD_TABLE_SORT].sortOrder,
+    state[STATE_KEYS.DOCKET_RECORD_TABLE_SORT].sortOrder,
   );
 
   const { url } = await applicationContext

diff --git a/web-client/src/presenter/actions/TrialSession/getBulkSpecialTrialSessionCopyNotesAction.ts b/web-client/src/presenter/actions/TrialSession/getBulkSpecialTrialSessionCopyNotesAction.ts
@@ -2,7 +2,7 @@ import { SESSION_TYPES } from '@shared/business/entities/EntityConstants';
 import {
   SpecialTrialSession,
   TrialSessionWorkingCopyNotes,
-} from '@shared/business/entities/trialSessions/SpeciailTrialSessions';
+} from '@shared/business/entities/trialSessions/SpecialTrialSessions';
 const getSpecialTrialSessions = trialSessions =>
   trialSessions
     .filter(trialSession => trialSession.sessionType === SESSION_TYPES.special)

diff --git a/web-client/src/presenter/actions/generateDocketRecordPdfUrlAction.test.ts b/web-client/src/presenter/actions/generateDocketRecordPdfUrlAction.test.ts
@@ -1,4 +1,4 @@
-import { KEYS } from '@shared/business/entities/EntityConstants';
+import { STATE_KEYS } from '@shared/business/entities/EntityConstants';
 import { applicationContextForClient as applicationContext } from '@web-client/test/createClientTestApplicationContext';
 import { generateDocketRecordPdfUrlAction } from './generateDocketRecordPdfUrlAction';
 import { presenter } from '../presenter-mock';
@@ -122,7 +122,7 @@ describe('generateDocketRecordPdfUrlAction', () => {
         caseDetail: {
           docketNumber: '123-45',
         },
-        [KEYS.DOCKET_RECORD_TABLE_SORT]: {
+        [STATE_KEYS.DOCKET_RECORD_TABLE_SORT]: {
           sortField: 'sortField_test',
           sortOrder: 'sortOrder_test',
         },

diff --git a/web-client/src/presenter/actions/generateDocketRecordPdfUrlAction.ts b/web-client/src/presenter/actions/generateDocketRecordPdfUrlAction.ts
@@ -1,4 +1,4 @@
-import { KEYS } from '@shared/business/entities/EntityConstants';
+import { STATE_KEYS } from '@shared/business/entities/EntityConstants';
 import { state } from '@web-client/presenter/app.cerebral';
 /**
  * get the pdf file and pdf blob url from the passed in htmlString
@@ -18,10 +18,10 @@ export const generateDocketRecordPdfUrlAction = async ({
   );
 
   const docketRecordSortField = get(
-    state[KEYS.DOCKET_RECORD_TABLE_SORT].sortField,
+    state[STATE_KEYS.DOCKET_RECORD_TABLE_SORT].sortField,
   );
   const docketRecordSortOrder = get(
-    state[KEYS.DOCKET_RECORD_TABLE_SORT].sortOrder,
+    state[STATE_KEYS.DOCKET_RECORD_TABLE_SORT].sortOrder,
   );
 
   const { isAssociated } = props;

diff --git a/web-client/src/presenter/actions/setDefaultDocketEntriesTableSortAction.ts b/web-client/src/presenter/actions/setDefaultDocketEntriesTableSortAction.ts
@@ -1,12 +1,12 @@
-import { KEYS } from '@shared/business/entities/EntityConstants';
+import { STATE_KEYS } from '@shared/business/entities/EntityConstants';
 import { state } from '@web-client/presenter/app.cerebral';
 
 export const setDefaultDocketEntriesTableSortAction = ({
   store,
 }: ActionProps) => {
   store.set(
-    state[KEYS.DOCKET_RECORD_TABLE_SORT].sortField,
+    state[STATE_KEYS.DOCKET_RECORD_TABLE_SORT].sortField,
     'sortingFilingDate',
   );
-  store.set(state[KEYS.DOCKET_RECORD_TABLE_SORT].sortOrder, 'asc');
+  store.set(state[STATE_KEYS.DOCKET_RECORD_TABLE_SORT].sortOrder, 'asc');
 };
diff --git a/web-client/src/presenter/actions/setTableSortConfigurationAction.test.ts b/web-client/src/presenter/actions/setTableSortConfigurationAction.test.ts
@@ -11,7 +11,7 @@ describe('setTableSortConfigurationAction', () => {
       props: { sortField: 'createdAt', sortOrder: ASCENDING },
       state: {
         tableSort: {
-          sortField: 'recievedAt',
+          sortField: 'receivedAt',
           sortOrder: DESCENDING,
         },
       },
@@ -24,9 +24,13 @@ describe('setTableSortConfigurationAction', () => {
   });
 
   it('should set the field to sort and the sort order in the correct root', async () => {
-    const TEST_ROOT = 'TEST_ROOT';
+    const STATE_KEY = 'STATE_KEY';
     const { state } = await runAction(setTableSortConfigurationAction, {
-      props: { root: TEST_ROOT, sortField: 'createdAt', sortOrder: ASCENDING },
+      props: {
+        sortField: 'createdAt',
+        sortOrder: ASCENDING,
+        stateKey: STATE_KEY,
+      },
       state: {
         tableSort: {
           sortField: 'recievedAt',
@@ -35,7 +39,7 @@ describe('setTableSortConfigurationAction', () => {
       },
     });
 
-    expect(state[TEST_ROOT]).toEqual({
+    expect(state[STATE_KEY]).toEqual({
       sortField: 'createdAt',
       sortOrder: ASCENDING,
     });

diff --git a/web-client/src/presenter/actions/setTableSortConfigurationAction.ts b/web-client/src/presenter/actions/setTableSortConfigurationAction.ts
@@ -6,11 +6,11 @@ export const setTableSortConfigurationAction = ({
 }: ActionProps<{
   sortField: string;
   sortOrder: 'asc' | 'desc';
-  root?: string;
+  stateKey?: string;
 }>) => {
-  const { root, sortField, sortOrder } = props;
+  const { sortField, sortOrder, stateKey } = props;
 
-  const ROOT = root || 'tableSort';
-  store.set(state[ROOT].sortField, sortField);
-  store.set(state[ROOT].sortOrder, sortOrder);
+  const STATE_KEY = stateKey || 'tableSort';
+  store.set(state[STATE_KEY].sortField, sortField);
+  store.set(state[STATE_KEY].sortOrder, sortOrder);
 };
diff --git a/web-client/src/presenter/computeds/Public/publicCaseDetailHelper.test.ts b/web-client/src/presenter/computeds/Public/publicCaseDetailHelper.test.ts
@@ -4,11 +4,11 @@ import {
   AMICUS_BRIEF_EVENT_CODE,
   DOCKET_ENTRY_SEALED_TO_TYPES,
   DOCUMENT_PROCESSING_STATUS_OPTIONS,
-  KEYS,
   PARTIES_CODES,
   POLICY_DATE_IMPACTED_EVENTCODES,
   PUBLIC_DOCKET_RECORD_FILTER_OPTIONS,
   ROLES,
+  STATE_KEYS,
   STIPULATED_DECISION_EVENT_CODE,
   UNSERVABLE_EVENT_CODES,
 } from '@shared/business/entities/EntityConstants';
@@ -147,7 +147,7 @@ describe('publicCaseDetailHelper', () => {
       sessionMetadata: {
         docketRecordFilter: PUBLIC_DOCKET_RECORD_FILTER_OPTIONS.allDocuments,
       },
-      [KEYS.DOCKET_RECORD_TABLE_SORT]: {},
+      [STATE_KEYS.DOCKET_RECORD_TABLE_SORT]: {},
     };
   });
 
@@ -255,7 +255,7 @@ describe('publicCaseDetailHelper', () => {
     });
 
     it('should be sorted newer to older when sort order is by date desc', () => {
-      state[KEYS.DOCKET_RECORD_TABLE_SORT] = {
+      state[STATE_KEYS.DOCKET_RECORD_TABLE_SORT] = {
         sortField: 'sortingFilingDate',
         sortOrder: 'desc',
       };
@@ -390,7 +390,7 @@ describe('publicCaseDetailHelper', () => {
           const result = runCompute(publicCaseDetailHelper, {
             state: {
               caseDetail,
-              [KEYS.DOCKET_RECORD_TABLE_SORT]: {},
+              [STATE_KEYS.DOCKET_RECORD_TABLE_SORT]: {},
               sessionMetadata: {
                 docketRecordFilter: PUBLIC_DOCKET_RECORD_FILTER_OPTIONS.orders,
               },
@@ -407,7 +407,7 @@ describe('publicCaseDetailHelper', () => {
           const result = runCompute(publicCaseDetailHelper, {
             state: {
               caseDetail,
-              [KEYS.DOCKET_RECORD_TABLE_SORT]: {},
+              [STATE_KEYS.DOCKET_RECORD_TABLE_SORT]: {},
               sessionMetadata: {
                 docketRecordFilter: PUBLIC_DOCKET_RECORD_FILTER_OPTIONS.motions,
               },
@@ -424,7 +424,7 @@ describe('publicCaseDetailHelper', () => {
           const result = runCompute(publicCaseDetailHelper, {
             state: {
               caseDetail,
-              [KEYS.DOCKET_RECORD_TABLE_SORT]: {},
+              [STATE_KEYS.DOCKET_RECORD_TABLE_SORT]: {},
               sessionMetadata: {
                 docketRecordFilter:
                   PUBLIC_DOCKET_RECORD_FILTER_OPTIONS.allDocuments,
@@ -1425,7 +1425,7 @@ describe('publicCaseDetailHelper', () => {
             canAllowPrintableDocketRecord: true,
             docketEntries: [],
           },
-          [KEYS.DOCKET_RECORD_TABLE_SORT]: {},
+          [STATE_KEYS.DOCKET_RECORD_TABLE_SORT]: {},
           sessionMetadata: {
             docketRecordFilter:
               PUBLIC_DOCKET_RECORD_FILTER_OPTIONS.allDocuments,
@@ -1442,7 +1442,7 @@ describe('publicCaseDetailHelper', () => {
             canAllowPrintableDocketRecord: false,
             docketEntries: [],
           },
-          [KEYS.DOCKET_RECORD_TABLE_SORT]: {},
+          [STATE_KEYS.DOCKET_RECORD_TABLE_SORT]: {},
           sessionMetadata: {
             docketRecordFilter:
               PUBLIC_DOCKET_RECORD_FILTER_OPTIONS.allDocuments,
@@ -1484,7 +1484,7 @@ describe('formatDocketEntryOnDocketRecord', () => {
     mockCase = cloneDeep(MOCK_CASE);
     state = {
       caseDetail: mockCase,
-      [KEYS.DOCKET_RECORD_TABLE_SORT]: {},
+      [STATE_KEYS.DOCKET_RECORD_TABLE_SORT]: {},
       sessionMetadata: {
         docketRecordFilter: PUBLIC_DOCKET_RECORD_FILTER_OPTIONS.allDocuments,
       },

diff --git a/web-client/src/presenter/computeds/Public/publicCaseDetailHelper.ts b/web-client/src/presenter/computeds/Public/publicCaseDetailHelper.ts
@@ -1,10 +1,10 @@
 /* eslint-disable complexity */
 import {
   ALLOWLIST_FEATURE_FLAGS,
-  KEYS,
   PUBLIC_DOCKET_RECORD_FILTER,
   PUBLIC_DOCKET_RECORD_FILTER_OPTIONS,
   ROLES,
+  STATE_KEYS,
 } from '../../../../../shared/src/business/entities/EntityConstants';
 import { ClientApplicationContext } from '@web-client/applicationContext';
 import { DocketEntry } from '../../../../../shared/src/business/entities/DocketEntry';
@@ -180,7 +180,9 @@ export const publicCaseDetailHelper = (
   const { canAllowPrintableDocketRecord, docketEntries, isSealed } = rawCase;
 
   const isTerminalUser = get(state.isTerminalUser);
-  const { sortField, sortOrder } = get(state[KEYS.DOCKET_RECORD_TABLE_SORT]);
+  const { sortField, sortOrder } = get(
+    state[STATE_KEYS.DOCKET_RECORD_TABLE_SORT],
+  );
 
   const { docketRecordFilter } = get(state.sessionMetadata);
 

diff --git a/web-client/src/presenter/computeds/formattedDocketEntries.test.ts b/web-client/src/presenter/computeds/formattedDocketEntries.test.ts
@@ -4,8 +4,8 @@ import {
   ALLOWLIST_FEATURE_FLAGS,
   DOCKET_ENTRY_SEALED_TO_TYPES,
   DOCKET_RECORD_FILTER_OPTIONS,
-  KEYS,
   ROLES,
+  STATE_KEYS,
 } from '../../../../shared/src/business/entities/EntityConstants';
 import { MOCK_CASE } from '../../../../shared/src/test/mockCase';
 import { applicationContextForClient as applicationContext } from '@web-client/test/createClientTestApplicationContext';
@@ -1171,7 +1171,7 @@ describe('formattedDocketEntries', () => {
             ...MOCK_CASE,
             docketEntries: TEST_DOCKET_ENTRIES,
           },
-          [KEYS.DOCKET_RECORD_TABLE_SORT]: {
+          [STATE_KEYS.DOCKET_RECORD_TABLE_SORT]: {
             sortField: 'testProp',
             sortOrder: 'desc',
           },

diff --git a/web-client/src/presenter/computeds/formattedDocketEntries.ts b/web-client/src/presenter/computeds/formattedDocketEntries.ts
@@ -2,7 +2,7 @@
 import { ClientApplicationContext } from '@web-client/applicationContext';
 import { DocketEntry } from '@shared/business/entities/DocketEntry';
 import { Get } from 'cerebral';
-import { KEYS } from '@shared/business/entities/EntityConstants';
+import { STATE_KEYS } from '@shared/business/entities/EntityConstants';
 import { computeIsNotServedDocument } from '@shared/business/utilities/getFormattedCaseDetail';
 import { sortBy } from 'lodash';
 import { state } from '@web-client/presenter/app.cerebral';
@@ -215,10 +215,10 @@ export const formattedDocketEntries = (
   }
 
   const docketRecordSortField = get(
-    state[KEYS.DOCKET_RECORD_TABLE_SORT].sortField,
+    state[STATE_KEYS.DOCKET_RECORD_TABLE_SORT].sortField,
   );
   const docketRecordSortOrder = get(
-    state[KEYS.DOCKET_RECORD_TABLE_SORT].sortOrder,
+    state[STATE_KEYS.DOCKET_RECORD_TABLE_SORT].sortOrder,
   );
 
   const DOCUMENT_VISIBILITY_POLICY_CHANGE_DATE = get(
@@ -318,7 +318,7 @@ export const formattedDocketEntries = (
 
 export function sortDocketEntryTable<T>(
   docketEntries: (T & { sortingFilingDate: string | undefined })[] = [],
-  docketRecordSortField: keyof T | undefined,
+  docketRecordSortField: string | undefined,
   docketRecordSortOrder: 'asc' | 'desc' | undefined,
 ): T[] {
   if (!docketRecordSortField || !docketRecordSortOrder) {