9684 Message Display: Display Place and Date of Trial Session When Case is Calendared

shared/src/business/entities/Message.js

@@ -17,37 +17,49 @@ function Message() {
 }
 
 Message.prototype.init = function init(rawMessage, { applicationContext }) {
+  messageDecorator(this, rawMessage, { applicationContext });
+};
+
+const messageDecorator = (
+  messageEntity,
+  rawMessage,
+  { applicationContext },
+) => {
   if (!applicationContext) {
     throw new TypeError('applicationContext must be defined');
   }
 
-  this.attachments = (rawMessage.attachments || []).map(attachment => ({
-    documentId: attachment.documentId,
-  }));
-  this.caseStatus = rawMessage.caseStatus;
-  this.caseTitle = rawMessage.caseTitle;
-  this.completedAt = rawMessage.completedAt;
-  this.completedBy = rawMessage.completedBy;
-  this.completedBySection = rawMessage.completedBySection;
-  this.completedByUserId = rawMessage.completedByUserId;
-  this.completedMessage = rawMessage.completedMessage;
-  this.createdAt = rawMessage.createdAt || createISODateString();
-  this.leadDocketNumber = rawMessage.leadDocketNumber;
-  this.docketNumber = rawMessage.docketNumber;
-  this.docketNumberWithSuffix = rawMessage.docketNumberWithSuffix;
-  this.from = rawMessage.from;
-  this.fromSection = rawMessage.fromSection;
-  this.fromUserId = rawMessage.fromUserId;
-  this.isCompleted = rawMessage.isCompleted || false;
-  this.isRead = rawMessage.isRead || false;
-  this.isRepliedTo = rawMessage.isRepliedTo || false;
-  this.message = rawMessage.message;
-  this.messageId = rawMessage.messageId || applicationContext.getUniqueId();
-  this.parentMessageId = rawMessage.parentMessageId || this.messageId;
-  this.subject = rawMessage.subject;
-  this.to = rawMessage.to;
-  this.toSection = rawMessage.toSection;
-  this.toUserId = rawMessage.toUserId;
+  messageEntity.attachments = (rawMessage.attachments || []).map(
+    attachment => ({
+      documentId: attachment.documentId,
+    }),
+  );
+  messageEntity.caseStatus = rawMessage.caseStatus;
+  messageEntity.caseTitle = rawMessage.caseTitle;
+  messageEntity.completedAt = rawMessage.completedAt;
+  messageEntity.completedBy = rawMessage.completedBy;
+  messageEntity.completedBySection = rawMessage.completedBySection;
+  messageEntity.completedByUserId = rawMessage.completedByUserId;
+  messageEntity.completedMessage = rawMessage.completedMessage;
+  messageEntity.createdAt = rawMessage.createdAt || createISODateString();
+  messageEntity.leadDocketNumber = rawMessage.leadDocketNumber;
+  messageEntity.docketNumber = rawMessage.docketNumber;
+  messageEntity.docketNumberWithSuffix = rawMessage.docketNumberWithSuffix;
+  messageEntity.from = rawMessage.from;
+  messageEntity.fromSection = rawMessage.fromSection;
+  messageEntity.fromUserId = rawMessage.fromUserId;
+  messageEntity.isCompleted = rawMessage.isCompleted || false;
+  messageEntity.isRead = rawMessage.isRead || false;
+  messageEntity.isRepliedTo = rawMessage.isRepliedTo || false;
+  messageEntity.message = rawMessage.message;
+  messageEntity.messageId =
+    rawMessage.messageId || applicationContext.getUniqueId();
+  messageEntity.parentMessageId =
+    rawMessage.parentMessageId || messageEntity.messageId;
+  messageEntity.subject = rawMessage.subject;
+  messageEntity.to = rawMessage.to;
+  messageEntity.toSection = rawMessage.toSection;
+  messageEntity.toUserId = rawMessage.toUserId;
 };
 
 Message.VALIDATION_ERROR_MESSAGES = {
@@ -205,4 +217,7 @@ Message.prototype.addAttachment = function (attachmentToAdd) {
   return this;
 };
 
-exports.Message = validEntityDecorator(Message);
+module.exports = {
+  Message: validEntityDecorator(Message),
+  messageDecorator,
+};

shared/src/business/entities/MessageResult.js

@@ -0,0 +1,56 @@
+const joi = require('joi');
+const {
+  joiValidationDecorator,
+  validEntityDecorator,
+} = require('./JoiValidationDecorator');
+const {
+  TRIAL_CITY_STRINGS,
+  TRIAL_LOCATION_MATCHER,
+} = require('./EntityConstants');
+const { JoiValidationConstants } = require('./JoiValidationConstants');
+const { messageDecorator } = require('./Message');
+
+/**
+ * constructor
+ *
+ * @param {object} rawMessage the raw message data
+ * @constructor
+ */
+function MessageResult() {
+  this.entityName = 'MessageResult';
+}
+
+MessageResult.prototype.init = function init(
+  rawMessage,
+  { applicationContext },
+) {
+  messageDecorator(this, rawMessage, { applicationContext });
+  this.trialDate = rawMessage.trialDate;
+  this.trialLocation = rawMessage.trialLocation;
+};
+
+MessageResult.VALIDATION_RULES = {
+  trialDate: joi
+    .alternatives()
+    .optional()
+    .description('When this case goes to trial.'),
+  trialLocation: joi
+    .alternatives()
+    .try(
+      JoiValidationConstants.STRING.valid(...TRIAL_CITY_STRINGS, null),
+      JoiValidationConstants.STRING.pattern(TRIAL_LOCATION_MATCHER),
+      JoiValidationConstants.STRING.valid('Standalone Remote'),
+    )
+    .optional()
+    .description(
+      'Where this case goes to trial. This may be different that the preferred trial location.',
+    ),
+};
+
+joiValidationDecorator(
+  MessageResult,
+  joi.object().keys(MessageResult.VALIDATION_RULES),
+  MessageResult.VALIDATION_ERROR_MESSAGES,
+);
+
+exports.MessageResult = validEntityDecorator(MessageResult);

shared/src/business/entities/MessageResult.test.js

@@ -0,0 +1,47 @@
+const { applicationContext } = require('../test/createTestApplicationContext');
+const { CASE_STATUS_TYPES, PETITIONS_SECTION } = require('./EntityConstants');
+const { MessageResult } = require('./MessageResult');
+
+describe('MessageResult', () => {
+  const mockRawMessageResult = {
+    caseStatus: CASE_STATUS_TYPES.generalDocket,
+    caseTitle: 'The Land Before Time',
+    createdAt: '2019-03-01T21:40:46.415Z',
+    docketNumber: '123-20',
+    docketNumberWithSuffix: '123-45S',
+    from: 'Test Petitionsclerk',
+    fromSection: PETITIONS_SECTION,
+    fromUserId: '4791e892-14ee-4ab1-8468-0c942ec379d2',
+    isCompleted: false,
+    isRead: false,
+    isRepliedTo: false,
+    message: 'hey there',
+    messageId: 'a10d6855-f3ee-4c11-861c-c7f11cba4dff',
+    parentMessageId: '31687a1e-3640-42cd-8e7e-a8e6df39ce9a',
+    subject: 'hello',
+    to: 'Test Petitionsclerk2',
+    toSection: PETITIONS_SECTION,
+    toUserId: '449b916e-3362-4a5d-bf56-b2b94ba29c12',
+    trialDate: '2029-03-01T21:40:46.415Z',
+    trialLocation: 'Denver, Colorado',
+  };
+
+  it('should create a valid MessageResult', () => {
+    const messageResult = new MessageResult(mockRawMessageResult, {
+      applicationContext,
+    });
+
+    expect(messageResult.isValid()).toBeTruthy();
+  });
+
+  it('should fail validation when trialLocation is not one of TRIAL_CITY_STRINGS or StandaloneRemote', () => {
+    const messageResult = new MessageResult(
+      { ...mockRawMessageResult, trialLocation: 'New Delhi, India' },
+      {
+        applicationContext,
+      },
+    );
+
+    expect(messageResult.isValid()).toBeFalsy();
+  });
+});

shared/src/business/useCases/messages/getInboxMessagesForSectionInteractor.test.ts

@@ -30,7 +30,7 @@ describe('getInboxMessagesForSectionInteractor', () => {
       createdAt: '2019-03-01T21:40:46.415Z',
       docketNumber: '123-45',
       docketNumberWithSuffix: '123-45S',
-      entityName: 'Message',
+      entityName: 'MessageResult',
       from: 'Test Petitionsclerk2',
       fromSection: PETITIONS_SECTION,
       fromUserId: 'fe6eeadd-e4e8-4e56-9ddf-0ebe9516df6b',
@@ -44,6 +44,8 @@ describe('getInboxMessagesForSectionInteractor', () => {
       to: 'Test Petitionsclerk',
       toSection: PETITIONS_SECTION,
       toUserId: 'b427ca37-0df1-48ac-94bb-47aed073d6f7',
+      trialDate: '2028-03-01T21:40:46.415Z',
+      trialLocation: 'El Paso, Texas',
     };
     applicationContext.getCurrentUser.mockReturnValue({
       role: ROLES.petitionsClerk,

shared/src/business/useCases/messages/getInboxMessagesForSectionInteractor.ts

@@ -1,4 +1,4 @@
-import { Message } from '../../entities/Message';
+import { MessageResult } from '../../entities/MessageResult';
 import {
   ROLE_PERMISSIONS,
   isAuthorized,
@@ -30,7 +30,7 @@ export const getInboxMessagesForSectionInteractor = async (
       section,
     });
 
-  return Message.validateRawCollection(messages, {
+  return MessageResult.validateRawCollection(messages, {
     applicationContext,
   });
 };

shared/src/business/useCases/messages/getInboxMessagesForUserInteractor.test.ts

@@ -30,7 +30,7 @@ describe('getInboxMessagesForUserInteractor', () => {
       createdAt: '2019-03-01T21:40:46.415Z',
       docketNumber: '123-45',
       docketNumberWithSuffix: '123-45S',
-      entityName: 'Message',
+      entityName: 'MessageResult',
       from: 'Test Petitionsclerk2',
       fromSection: PETITIONS_SECTION,
       fromUserId: 'fe6eeadd-e4e8-4e56-9ddf-0ebe9516df6b',
@@ -44,6 +44,8 @@ describe('getInboxMessagesForUserInteractor', () => {
       to: 'Test Petitionsclerk',
       toSection: PETITIONS_SECTION,
       toUserId: 'b427ca37-0df1-48ac-94bb-47aed073d6f7',
+      trialDate: '2028-03-01T21:40:46.415Z',
+      trialLocation: 'El Paso, Texas',
     };
     applicationContext.getCurrentUser.mockReturnValue({
       role: ROLES.petitionsClerk,

shared/src/business/useCases/messages/getInboxMessagesForUserInteractor.ts

@@ -1,4 +1,4 @@
-import { Message } from '../../entities/Message';
+import { MessageResult } from '../../entities/MessageResult';
 import {
   ROLE_PERMISSIONS,
   isAuthorized,
@@ -30,7 +30,7 @@ export const getInboxMessagesForUserInteractor = async (
       userId,
     });
 
-  return Message.validateRawCollection(messages, {
+  return MessageResult.validateRawCollection(messages, {
     applicationContext,
   });
 };

shared/src/business/useCases/messages/getOutboxMessagesForSectionInteractor.test.ts

@@ -30,7 +30,7 @@ describe('getOutboxMessagesForSectionInteractor', () => {
       createdAt: '2019-03-01T21:40:46.415Z',
       docketNumber: '123-45',
       docketNumberWithSuffix: '123-45S',
-      entityName: 'Message',
+      entityName: 'MessageResult',
       from: 'Test Petitionsclerk2',
       fromSection: PETITIONS_SECTION,
       fromUserId: 'fe6eeadd-e4e8-4e56-9ddf-0ebe9516df6b',
@@ -44,6 +44,8 @@ describe('getOutboxMessagesForSectionInteractor', () => {
       to: 'Test Petitionsclerk',
       toSection: PETITIONS_SECTION,
       toUserId: 'b427ca37-0df1-48ac-94bb-47aed073d6f7',
+      trialDate: '2028-03-01T21:40:46.415Z',
+      trialLocation: 'El Paso, Texas',
     };
     applicationContext.getCurrentUser.mockReturnValue({
       role: ROLES.petitionsClerk,

shared/src/business/useCases/messages/getOutboxMessagesForSectionInteractor.ts

@@ -1,4 +1,4 @@
-import { Message } from '../../entities/Message';
+import { MessageResult } from '../../entities/MessageResult';
 import {
   ROLE_PERMISSIONS,
   isAuthorized,
@@ -30,7 +30,7 @@ export const getOutboxMessagesForSectionInteractor = async (
       section,
     });
 
-  return Message.validateRawCollection(messages, {
+  return MessageResult.validateRawCollection(messages, {
     applicationContext,
   });
 };

shared/src/business/useCases/messages/getOutboxMessagesForUserInteractor.test.ts

@@ -30,7 +30,7 @@ describe('getOutboxMessagesForUserInteractor', () => {
       createdAt: '2019-03-01T21:40:46.415Z',
       docketNumber: '123-45',
       docketNumberWithSuffix: '123-45S',
-      entityName: 'Message',
+      entityName: 'MessageResult',
       from: 'Test Petitionsclerk2',
       fromSection: PETITIONS_SECTION,
       fromUserId: 'fe6eeadd-e4e8-4e56-9ddf-0ebe9516df6b',
@@ -44,6 +44,8 @@ describe('getOutboxMessagesForUserInteractor', () => {
       to: 'Test Petitionsclerk',
       toSection: PETITIONS_SECTION,
       toUserId: 'b427ca37-0df1-48ac-94bb-47aed073d6f7',
+      trialDate: '2028-03-01T21:40:46.415Z',
+      trialLocation: 'El Paso, Texas',
     };
     applicationContext.getCurrentUser.mockReturnValue({
       role: ROLES.petitionsClerk,

shared/src/business/useCases/messages/getOutboxMessagesForUserInteractor.ts

@@ -1,4 +1,4 @@
-import { Message } from '../../entities/Message';
+import { MessageResult } from '../../entities/MessageResult';
 import {
   ROLE_PERMISSIONS,
   isAuthorized,
@@ -30,7 +30,7 @@ export const getOutboxMessagesForUserInteractor = async (
       userId,
     });
 
-  return Message.validateRawCollection(messages, {
+  return MessageResult.validateRawCollection(messages, {
     applicationContext,
   });
 };

shared/src/business/utilities/abbreviateState.js

@@ -0,0 +1,20 @@
+import { US_STATES } from '../entities/EntityConstants';
+import { invert } from 'lodash';
+
+/**
+ * abbreviates the state given a string with a comma separated city and state
+ *
+ * @param {string} locationString the location string to format
+ * @returns {string} a formatted string with the abbreviated state
+ */
+const abbreviateState = locationString => {
+  const cityAndState = locationString.split(', ');
+  const stateAbbreviation = invert(US_STATES)[cityAndState[1]];
+  const formattedCityAndState = `${cityAndState[0]}, ${stateAbbreviation}`;
+
+  return formattedCityAndState;
+};
+
+module.exports = {
+  abbreviateState,
+};

shared/src/business/utilities/abbreviateState.test.js

@@ -0,0 +1,12 @@
+const { abbreviateState } = require('./abbreviateState');
+
+describe('abbreviateState', () => {
+  it('should return a string with an abbreviated state when passed a comma separated city and unabbreviated state', () => {
+    const locationString = 'Denver, Colorado';
+    const expectedResult = 'Denver, CO';
+
+    const result = abbreviateState(locationString);
+
+    expect(result).toEqual(expectedResult);
+  });
+});

shared/src/persistence/elasticsearch/helpers/searchClauses.js

@@ -31,7 +31,12 @@ const GET_PARENT_CASE = {
   has_parent: {
     inner_hits: {
       _source: {
-        includes: ['leadDocketNumber', 'docketNumber'],
+        includes: [
+          'leadDocketNumber',
+          'docketNumber',
+          'trialDate',
+          'trialLocation',
+        ],
       },
       name: 'case-mappings',
     },

web-api/elasticsearch/efcms-case-mappings.js

@@ -99,6 +99,12 @@ module.exports = {
     'status.S': {
       type: 'keyword',
     },
+    'trialDate.S': {
+      type: 'date',
+    },
+    'trialLocation.S': {
+      type: 'keyword',
+    },
     'userId.S': {
       type: 'keyword',
     },

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

@@ -4552,7 +4552,14 @@
     "partySecondary": false,
     "pk": "case|103-20",
     "documentTitle": "Petition",
-    "docketNumber": "103-20"
+    "docketNumber": "103-20",
+    "servedParties": [
+      {
+        "name": "Reuben Blair",
+        "email": "petitioner@example.com"
+      }
+    ],
+    "servedAt": "2020-09-25T19:27:16.630Z"
   },
   {
     "isStricken": false,