10409 Trial Sessions Page: Calendared View

10409_validation_delete_me.md

@@ -0,0 +1,26 @@
+Problem statement: How can we detect when making a validation changes to entities, we do not create invalid data in the database?
+
+- Pull all validation rules into a single file, if they change in any way, a validation sweep must be run on the database
+- Continue validating before we return inside all of our interactors but instead of exploding just silently log which entities are now invalid.
+- On each deployment validate all data in the database.
+
+
+Assumptions
+- Not all business rules can or should live inside of the persistence layer.
+  - For example when a trialSession is calendared it should have a sessionType
+- What is and what is not a valid entity can only be expressed inside of functions. 
+  - Is it possible to tell if a function has been modified between different git commits?
+  - If it is a pure function that does not modify any external state
+
+
+shared/src/business/entities/contacts/Contact.ts getValidationRules depends on instance.countryType
+
+
+Thoughts
+- If validation rules are expressed inside of functions it is impossible to tell if a function has changed its behavior from one release to another. If it is impossible to tell if validation rules have changed then maybe defensively checking if they have changed, and running a validation sweep on the DB is not the correct approach
+- Another option is better warnings to devs about making validation changes. 
+- Another option is continue validating, but only log invalid values instead of throwing errors to reduce application impact.
+
+
+Resources
+- Validate at input time. Validate again before you put it in the database. And have database constraints to prevent bad input. And you can bet in spite of all that, bad data will still get into your database, so validate it again when you use it.

cypress/local-only/tests/accessibility/fileDocument/petitioner.cy.ts

@@ -17,18 +17,16 @@ describe('File Document Page - Petitioner Accessibility', () => {
   it('should be free of a11y issues on step 2', () => {
     loginAsPetitioner();
     cy.visit('/case-detail/101-19/file-a-document');
-    cy.get('#document-type').click({ force: true });
-    cy.get('#document-type input')
-      .first()
-      .type('Motion for Leave to File Out of Time');
-    cy.get('#document-type #react-select-2-option-0').click({ force: true });
-    cy.get('#secondary-doc-secondary-document-type').click({ force: true });
-    cy.get('#secondary-doc-secondary-document-type input')
-      .first()
-      .type('Motion for Continuance');
-    cy.get(
-      '#secondary-doc-secondary-document-type #react-select-3-option-0',
-    ).click({ force: true });
+    cy.get('[data-testid="document-type"]').click();
+    cy.get('[data-testid="document-type"]')
+      .contains('Motion for Leave to File Out of Time')
+      .click();
+
+    cy.get('[data-testid="secondary-doc-secondary-document-type"]').click();
+    cy.get('[data-testid="secondary-doc-secondary-document-type"]')
+      .contains('Motion for Continuance')
+      .click();
+
     cy.get('#submit-document').click();
     cy.get('#primaryDocument-certificateOfService-label').click();
     cy.get('#primaryDocument-service-date-picker').should('exist');

shared/src/business/dto/trialSessions/TrialSessionInfoDTO.ts

@@ -21,17 +21,11 @@ export class TrialSessionInfoDTO {
   public sessionStatus: string;
   public swingSession?: boolean;
   public dismissedAlertForNOTT?: boolean;
-  public isStartDateWithinNOTTReminderRange?: boolean;
-  public thirtyDaysBeforeTrialFormatted?: string;
 
   constructor(rawTrialSession: RawTrialSession) {
     this.estimatedEndDate = rawTrialSession.estimatedEndDate;
     this.isCalendared = rawTrialSession.isCalendared;
     this.judge = rawTrialSession.judge;
-    this.isStartDateWithinNOTTReminderRange =
-      rawTrialSession.isStartDateWithinNOTTReminderRange;
-    this.thirtyDaysBeforeTrialFormatted =
-      rawTrialSession.thirtyDaysBeforeTrialFormatted;
     this.proceedingType = rawTrialSession.proceedingType;
     this.sessionType = rawTrialSession.sessionType;
     this.startDate = rawTrialSession.startDate;

shared/src/business/entities/cases/CalendaredCase.ts

@@ -7,7 +7,7 @@ import { IrsPractitioner } from '../IrsPractitioner';
 import { JoiValidationConstants } from '../JoiValidationConstants';
 import { JoiValidationEntity } from '../JoiValidationEntity';
 import { PrivatePractitioner } from '../PrivatePractitioner';
-import { setPretrialMemorandumFiler } from '../../utilities/getFormattedTrialSessionDetails';
+import { setPretrialMemorandumFiler } from '../../utilities/trialSession/getFormattedTrialSessionDetails';
 import joi from 'joi';
 
 export class CalendaredCase extends JoiValidationEntity {

shared/src/business/entities/trialSessions/TrialSession.noticeOfTrialReminder.test.ts

@@ -20,17 +20,22 @@ describe('TrialSession entity', () => {
       { daysFromToday: 34, expectedOutput: true },
       { daysFromToday: 35, expectedOutput: false },
     ];
-    it('should set isStartDateWithinNOTTReminderRange to false when the trial session is not calendared', () => {
+    it('should return false when the trial session is not calendared', () => {
       const trialSession = new TrialSession({
         ...MOCK_TRIAL_REGULAR,
         isCalendared: false,
       });
 
-      expect(trialSession.isStartDateWithinNOTTReminderRange).toBe(false);
+      expect(
+        TrialSession.isStartDateWithinNOTTReminderRange({
+          isCalendared: trialSession.isCalendared,
+          startDate: trialSession.startDate,
+        }),
+      ).toBe(false);
     });
 
     tests.forEach(({ daysFromToday, expectedOutput }) => {
-      it(`should set isStartDateWithinNOTTReminderRange to ${expectedOutput} when the trial session is calendared and the start date is ${daysFromToday} days from today`, () => {
+      it(`should return ${expectedOutput} when the trial session is calendared and the start date is ${daysFromToday} days from today`, () => {
         const thirtyDaysFromToday = today.plus({ ['days']: daysFromToday });
 
         const trialSession = new TrialSession({
@@ -39,9 +44,12 @@ describe('TrialSession entity', () => {
           startDate: thirtyDaysFromToday,
         });
 
-        expect(trialSession.isStartDateWithinNOTTReminderRange).toBe(
-          expectedOutput,
-        );
+        expect(
+          TrialSession.isStartDateWithinNOTTReminderRange({
+            isCalendared: trialSession.isCalendared,
+            startDate: trialSession.startDate,
+          }),
+        ).toBe(expectedOutput);
       });
     });
   });

shared/src/business/entities/trialSessions/TrialSession.ts

@@ -87,7 +87,6 @@ export class TrialSession extends JoiValidationEntity {
   public irsCalendarAdministratorInfo?: RawIrsCalendarAdministratorInfo;
   public isCalendared: boolean;
   public isClosed?: boolean;
-  public isStartDateWithinNOTTReminderRange?: boolean;
   public joinPhoneNumber?: string;
   public judge?: TJudge;
   public maxCases?: number;
@@ -107,7 +106,6 @@ export class TrialSession extends JoiValidationEntity {
   public swingSessionId?: string;
   public term: string;
   public termYear: string;
-  public thirtyDaysBeforeTrialFormatted?: string;
   public trialClerk?: TTrialClerk;
   public trialLocation?: string;
   public trialSessionId?: string;
@@ -198,12 +196,6 @@ export class TrialSession extends JoiValidationEntity {
       };
     }
 
-    if (rawSession.isCalendared && rawSession.startDate) {
-      this.setNoticeOfTrialReminderAlert();
-    } else {
-      this.isStartDateWithinNOTTReminderRange = false;
-    }
-
     if (rawSession.trialClerk && rawSession.trialClerk.name) {
       this.trialClerk = {
         name: rawSession.trialClerk.name,
@@ -216,6 +208,33 @@ export class TrialSession extends JoiValidationEntity {
     return sessionScope === TRIAL_SESSION_SCOPE_TYPES.standaloneRemote;
   }
 
+  static isStartDateWithinNOTTReminderRange({
+    isCalendared,
+    startDate,
+  }: {
+    isCalendared?: boolean;
+    startDate?: string;
+  }): boolean {
+    if (!isCalendared || !startDate) {
+      return false;
+    }
+
+    const formattedStartDate = formatDateString(startDate, FORMATS.MMDDYY);
+    const trialStartDateString = prepareDateFromString(
+      formattedStartDate,
+      FORMATS.MMDDYY,
+    );
+
+    return isTodayWithinGivenInterval({
+      intervalEndDate: trialStartDateString.minus({
+        ['days']: 24, // luxon's interval end date is not inclusive
+      }),
+      intervalStartDate: trialStartDateString.minus({
+        ['days']: 34,
+      }),
+    });
+  }
+
   static validationRules = {
     COMMON: {
       address1: JoiValidationConstants.STRING.max(100).allow('').optional(),
@@ -406,32 +425,6 @@ export class TrialSession extends JoiValidationEntity {
     return skPrefix;
   }
 
-  setNoticeOfTrialReminderAlert() {
-    const formattedStartDate = formatDateString(this.startDate, FORMATS.MMDDYY);
-    const trialStartDateString: any = prepareDateFromString(
-      formattedStartDate,
-      FORMATS.MMDDYY,
-    );
-
-    this.isStartDateWithinNOTTReminderRange = isTodayWithinGivenInterval({
-      intervalEndDate: trialStartDateString.minus({
-        ['days']: 24, // luxon's interval end date is not inclusive
-      }),
-      intervalStartDate: trialStartDateString.minus({
-        ['days']: 34,
-      }),
-    });
-
-    const thirtyDaysBeforeTrialInclusive: any = trialStartDateString.minus({
-      ['days']: 29,
-    });
-
-    this.thirtyDaysBeforeTrialFormatted = formatDateString(
-      thirtyDaysBeforeTrialInclusive,
-      FORMATS.MMDDYY,
-    );
-  }
-
   setAsCalendared() {
     this.isCalendared = true;
     this.sessionStatus = SESSION_STATUS_TYPES.open;

shared/src/business/entities/trialSessions/TrialSessionsPageValidation.ts

@@ -0,0 +1,39 @@
+import { JoiValidationConstants } from '@shared/business/entities/JoiValidationConstants';
+import { JoiValidationEntity } from '../JoiValidationEntity';
+import joi from 'joi';
+
+export class TrialSessionsPageValidation extends JoiValidationEntity {
+  public endDate: string;
+  public startDate: string;
+
+  constructor(rawProps) {
+    super('TrialSessionsPageValidation');
+    this.endDate = rawProps.endDate;
+    this.startDate = rawProps.startDate;
+  }
+
+  getValidationRules() {
+    return {
+      endDate: joi
+        .alternatives()
+        .conditional('startDate', {
+          is: JoiValidationConstants.ISO_DATE.exist().not(null),
+          otherwise: JoiValidationConstants.ISO_DATE,
+          then: JoiValidationConstants.ISO_DATE.min(
+            joi.ref('startDate'),
+          ).description(
+            'The end date search filter must be of valid date format and greater than or equal to the start date',
+          ),
+        })
+        .messages({
+          '*': 'Enter date in format MM/DD/YYYY.',
+          'date.min': 'End date cannot be prior to start date.',
+        }),
+      startDate: JoiValidationConstants.ISO_DATE.description(
+        'The start date to search by, which cannot be greater than the current date, and is required when there is an end date provided',
+      ).messages({
+        '*': 'Enter date in format MM/DD/YYYY.',
+      }),
+    };
+  }
+}

shared/src/business/test/createTestApplicationContext.ts

@@ -40,7 +40,7 @@ import {
   compareCasesByDocketNumber,
   formatCaseForTrialSession,
   getFormattedTrialSessionDetails,
-} from '@shared/business/utilities/getFormattedTrialSessionDetails';
+} from '@shared/business/utilities/trialSession/getFormattedTrialSessionDetails';
 import {
   compareISODateStrings,
   compareStrings,

shared/src/business/utilities/DateHandler.ts

@@ -233,7 +233,7 @@
  * @returns {string} a formatted date string
  */
 export const formatDateString = (
-  dateString: string,
+  dateString: string | undefined,
   formatArg: TimeFormatNames | TimeFormats = FORMATS.ISO,
 ): string => {
   if (!dateString) return '';
@@ -608,7 +608,7 @@
   const todayDate = formatNow(FORMATS.YYYYMMDD);
   const dateLessthanOrEqualToToday = dateString <= todayDate;
   // console.log(`dateInputValid: ${dateInputValid}`);
   // console.log(`dateLessthanOrEqualToToday: ${dateLessthanOrEqualToToday}`);
   return dateInputValid && dateLessthanOrEqualToToday;
 };
 

shared/src/business/utilities/getFormattedTrialSessionDetails.compareCasesByDocketNumber.test.ts → shared/src/business/utilities/trialSession/getFormattedTrialSessionDetails.compareCasesByDocketNumber.test.ts

@@ -1,4 +1,3 @@
-import { applicationContext } from '../test/createTestApplicationContext';
 import {
   compareCasesByDocketNumber,
   compareCasesByDocketNumberFactory,
@@ -58,7 +57,6 @@ describe('getFormattedTrialSessionDetails.compareCasesByDocketNumberFactory', ()
   it('101-19 should come before 102-19', () => {
     const result = compareCasesByDocketNumberFactory({
       allCases: [],
-      applicationContext,
     })(
       {
         docketNumber: '101-19',
@@ -79,7 +77,6 @@ describe('getFormattedTrialSessionDetails.compareCasesByDocketNumberFactory', ()
   it('190-07 should come before 102-19', () => {
     const result = compareCasesByDocketNumberFactory({
       allCases: [],
-      applicationContext,
     })(
       {
         docketNumber: '190-07',
@@ -94,7 +91,6 @@ describe('getFormattedTrialSessionDetails.compareCasesByDocketNumberFactory', ()
   it('102-19 should equal 102-19', () => {
     const result = compareCasesByDocketNumberFactory({
       allCases: [],
-      applicationContext,
     })(
       {
         docketNumber: '102-19',
@@ -115,7 +111,6 @@ describe('getFormattedTrialSessionDetails.compareCasesByDocketNumberFactory', ()
   it('103-19 should come after 102-19', () => {
     const result = compareCasesByDocketNumberFactory({
       allCases: [],
-      applicationContext,
     })(
       {
         docketNumber: '103-19',
@@ -163,7 +158,6 @@ describe('getFormattedTrialSessionDetails.compareCasesByDocketNumberFactory', ()
             leadDocketNumber: '101-20',
           },
         ],
-        applicationContext,
       }),
     );
 
@@ -207,7 +201,6 @@ describe('getFormattedTrialSessionDetails.compareCasesByDocketNumberFactory', ()
     cases.sort(
       compareCasesByDocketNumberFactory({
         allCases: [],
-        applicationContext,
       }),
     );