10409 story rebased

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.

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/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/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/proxies/trialSessions/getTrialSessionsProxy.ts

@@ -1,3 +1,4 @@
+import { TrialSessionInfoDTO } from '@shared/business/dto/trialSessions/TrialSessionInfoDTO';
 import { get } from '../requests';
 
 /**
@@ -6,7 +7,9 @@ import { get } from '../requests';
  * @param {object} applicationContext the application context
  * @returns {Promise<*>} the promise of the api call
  */
-export const getTrialSessionsInteractor = applicationContext => {
+export const getTrialSessionsInteractor = (
+  applicationContext,
+): Promise<TrialSessionInfoDTO[]> => {
   return get({
     applicationContext,
     endpoint: '/trial-sessions',

web-api/src/business/useCases/trialSessions/getTrialSessionsInteractor.test.ts

@@ -10,7 +10,6 @@ import {
   mockPetitionerUser,
   mockPetitionsClerkUser,
 } from '@shared/test/mockAuthUsers';
-import { omit } from 'lodash';
 
 describe('getTrialSessionsInteractor', () => {
   it('should throw an unauthorized error when the user does not have permission to view trial sessions', async () => {
@@ -19,19 +18,7 @@ describe('getTrialSessionsInteractor', () => {
     ).rejects.toThrow(new UnauthorizedError('Unauthorized'));
   });
 
-  it('should throw an error when the entity returned from persistence is invalid', async () => {
-    applicationContext
-      .getPersistenceGateway()
-      .getTrialSessions.mockResolvedValue([
-        omit(MOCK_TRIAL_INPERSON, 'maxCases'),
-      ]);
-
-    await expect(
-      getTrialSessionsInteractor(applicationContext, mockPetitionsClerkUser),
-    ).rejects.toThrow('The TrialSession entity was invalid.');
-  });
-
-  it('should return a list of validated trial sessions', async () => {
+  it('should return a list of trial sessions', async () => {
     applicationContext
       .getPersistenceGateway()
       .getTrialSessions.mockResolvedValue([

web-api/src/business/useCases/trialSessions/getTrialSessionsInteractor.ts

@@ -3,7 +3,7 @@ import {
   isAuthorized,
 } from '../../../../../shared/src/authorization/authorizationClientService';
 import { ServerApplicationContext } from '@web-api/applicationContext';
-import { TrialSession } from '../../../../../shared/src/business/entities/trialSessions/TrialSession';
+import { TrialSession } from '@shared/business/entities/trialSessions/TrialSession';
 import { TrialSessionInfoDTO } from '../../../../../shared/src/business/dto/trialSessions/TrialSessionInfoDTO';
 import { UnauthorizedError } from '@web-api/errors/errors';
 import { UnknownAuthUser } from '@shared/business/entities/authUser/AuthUser';
@@ -22,9 +22,7 @@ export const getTrialSessionsInteractor = async (
       applicationContext,
     });
 
-  const validatedSessions = TrialSession.validateRawCollection(trialSessions);
-
-  return validatedSessions.map(
-    trialSession => new TrialSessionInfoDTO(trialSession),
-  );
+  return trialSessions
+    .map(t => new TrialSession(t).toRawObject())
+    .map(trialSession => new TrialSessionInfoDTO(trialSession));
 };

web-api/storage/fixtures/seed/efcms-local.json

@@ -50345,7 +50345,7 @@
   {
     "caseOrder": [],
     "gsi1pk": "trial-session-catalog",
-    "sessionStatus": "New",
+    "sessionStatus": "Open",
     "trialLocation": "Denver, Colorado",
     "proceedingType": "In Person",
     "createdAt": "2019-11-02T05:00:00.000Z",
@@ -50362,7 +50362,7 @@
     "startDate": "2019-12-02T05:00:00.000Z",
     "maxCases": 30,
     "trialSessionId": "0d943468-bc2e-4631-84e3-b084cf5b1fbb",
-    "isCalendared": false,
+    "isCalendared": true,
     "status": "Closed"
   },
   {