CA Task Id 37 - Validate Response from Persistence Layer

efcms-service/src/cases/createCase.test.js

@@ -26,7 +26,7 @@ describe('Create case lambda', function() {
     beforeEach(function() {
       sinon.stub(client, 'put').resolves({
         userId: 'userId',
-        docketNumber: '456789-18',
+        docketNumber: '56789-18',
         documents,
         caseId: 'a6b81f4d-1e47-423a-8caf-6d2fdc3d3859',
         createdAt: '',
@@ -73,7 +73,7 @@ describe('Create case lambda', function() {
     beforeEach(function() {
       sinon.stub(client, 'put').resolves({
         userId: 'userId',
-        docketNumber: '456789-18',
+        docketNumber: '56789-18',
         documents: documents,
         createdAt: '',
       });
@@ -121,7 +121,7 @@ describe('Create case lambda', function() {
         return lambdaTester(createCase.create)
           .event(post)
           .expectResolve(err => {
-            expect(err.body).to.startsWith('"The case was invalid');
+            expect(err.body).to.startsWith('"The entity was invalid');
           });
       });
     });

efcms-service/src/cases/getCase.test.js

@@ -10,8 +10,23 @@ describe('Get case lambda', function() {
   const MOCK_CASE = {
     userId: 'userId',
     caseId: 'c54ba5a9-b37b-479d-9201-067ec6e335bb',
-    docketNumber: '456789-18',
-    createdAt: '',
+    docketNumber: '56789-18',
+    status: 'new',
+    createdAt: new Date().toISOString(),
+    documents: [
+      {
+        documentId: 'a6b81f4d-1e47-423a-8caf-6d2fdc3d3859',
+        documentType: 'Petition',
+      },
+      {
+        documentId: 'b6b81f4d-1e47-423a-8caf-6d2fdc3d3859',
+        documentType: 'Petition',
+      },
+      {
+        documentId: 'c6b81f4d-1e47-423a-8caf-6d2fdc3d3859',
+        documentType: 'Petition',
+      },
+    ]
   };
 
   describe('success - no cases exist in database', function() {

efcms-service/src/cases/getCases.test.js

@@ -9,16 +9,16 @@ chai.use(require('chai-string'));
 describe('Get cases lambda', function() {
   const documents = [
     {
-      documentId: '123456789',
-      documentType: 'stin',
+      documentId: 'a6b81f4d-1e47-423a-8caf-6d2fdc3d3859',
+      documentType: 'Petition',
     },
     {
-      documentId: '123456780',
-      documentType: 'stin',
+      documentId: 'a6b81f4d-1e47-423a-8caf-6d2fdc3d3859',
+      documentType: 'Petition',
     },
     {
-      documentId: '123456781',
-      documentType: 'stin',
+      documentId: 'a6b81f4d-1e47-423a-8caf-6d2fdc3d3859',
+      documentType: 'Petition',
     },
   ];
 
@@ -33,8 +33,8 @@ describe('Get cases lambda', function() {
       sinon.stub(client, 'batchGet').resolves([
         {
           userId: 'userId',
-          caseId: 'a6b81f4d-1e47-423a-8caf-6d2fdc3d3859A',
-          docketNumber: '456789-18',
+          caseId: 'a6b81f4d-1e47-423a-8caf-6d2fdc3d3859',
+          docketNumber: '56789-18',
           documents,
           createdAt: '',
         },

shared/src/business/entities/Case.js

@@ -1,78 +1,11 @@
+const { joiValidationDecorator } = require('./JoiValidationDecorator');
 const joi = require('joi-browser');
 const uuidv4 = require('uuid/v4');
 
 const uuidVersions = {
   version: ['uuidv4'],
 };
 
-/**
- * schema definition
- */
-const caseSchema = joi.object().keys({
-  caseId: joi
-    .string()
-    .uuid(uuidVersions)
-    .optional(),
-  userId: joi
-    .string()
-    // .uuid(uuidVersions)
-    .optional(),
-  createdAt: joi
-    .date()
-    .iso()
-    .optional(),
-  docketNumber: joi
-    .string()
-    .regex(/^[0-9]{5}-[0-9]{2}$/)
-    .optional(),
-  respondentId: joi.string().optional(),
-  irsSendDate: joi
-    .date()
-    .iso()
-    .optional(),
-  payGovId: joi.string().optional(),
-  payGovDate: joi
-    .date()
-    .iso()
-    .optional(),
-  status: joi
-    .string()
-    .regex(/^(new)|(general)$/)
-    .optional(),
-  documents: joi
-    .array()
-    .min(3)
-    .items(
-      joi.object({
-        documentId: joi
-          .string()
-          .uuid(uuidVersions)
-          .required(),
-        userId: joi
-          .string()
-          // .uuid(uuidVersions)
-          .optional(),
-        documentType: joi.string().required(),
-        validated: joi.boolean().optional(),
-        reviewDate: joi
-          .date()
-          .iso()
-          .optional(),
-        reviewUser: joi.string().optional(),
-        status: joi.string().optional(),
-        servedDate: joi
-          .date()
-          .iso()
-          .optional(),
-        createdAt: joi
-          .date()
-          .iso()
-          .optional(),
-      }),
-    )
-    .required(),
-});
-
 /**
  * Case
  * @param rawCase
@@ -95,40 +28,73 @@ function Case(rawCase) {
   );
 }
 
-/**
- * isValid
- * @returns {boolean}
- */
-Case.prototype.isValid = function isValid() {
-  return joi.validate(this, caseSchema).error === null;
-};
-/**
- * getValidationError
- * @returns {*}
- */
-Case.prototype.getValidationError = function getValidationError() {
-  return joi.validate(this, caseSchema).error;
-};
-
-/**
- * validate
- */
-Case.prototype.validate = function validate() {
-  if (!this.isValid()) {
-    throw new Error('The case was invalid ' + this.getValidationError());
-  }
-};
-
-/**
- * validateWithError
- * will throw the error provided if the case entity is invalid
- */
-Case.prototype.validateWithError = function validate(error) {
-  if (!this.isValid()) {
-    error.message = `${error.message} ${this.getValidationError()}`;
-    throw error;
-  }
-};
+joiValidationDecorator(
+  Case,
+  joi.object().keys({
+    caseId: joi
+      .string()
+      .uuid(uuidVersions)
+      .optional(),
+    userId: joi
+      .string()
+      // .uuid(uuidVersions)
+      .optional(),
+    createdAt: joi
+      .date()
+      .iso()
+      .optional(),
+    docketNumber: joi
+      .string()
+      .regex(/^[0-9]{5}-[0-9]{2}$/)
+      .required(),
+    respondentId: joi.string().optional(),
+    irsSendDate: joi
+      .date()
+      .iso()
+      .optional(),
+    payGovId: joi.string().optional(),
+    payGovDate: joi
+      .date()
+      .iso()
+      .optional(),
+    status: joi
+      .string()
+      .regex(/^(new)|(general)$/)
+      .optional(),
+    documents: joi
+      .array()
+      .min(3)
+      .items(
+        joi.object({
+          documentId: joi
+            .string()
+            .uuid(uuidVersions)
+            .required(),
+          userId: joi
+            .string()
+            // .uuid(uuidVersions)
+            .optional(),
+          documentType: joi.string().required(),
+          validated: joi.boolean().optional(),
+          reviewDate: joi
+            .date()
+            .iso()
+            .optional(),
+          reviewUser: joi.string().optional(),
+          status: joi.string().optional(),
+          servedDate: joi
+            .date()
+            .iso()
+            .optional(),
+          createdAt: joi
+            .date()
+            .iso()
+            .optional(),
+        }),
+      )
+      .required(),
+  }),
+);
 
 /**
  * isPetitionPackageReviewed
@@ -145,10 +111,12 @@ Case.prototype.markAsSentToIRS = function(sendDate) {
   this.irsSendDate = sendDate;
   this.status = 'general';
   this.documents.every(document => (document.status = 'served'));
+  return this;
 };
 
 Case.prototype.markAsPaidByPayGov = function(payGovDate) {
   this.payGovDate = payGovDate;
+  return this;
 };
 
 /**
@@ -174,6 +142,10 @@ Case.isValidDocketNumber = docketNumber => {
   );
 };
 
+Case.prototype.preValidate = function() {
+  return Case.isValidDocketNumber(this.docketNumber);
+};
+
 /**
  * documentTypes
  * @type {{petitionFile: string, requestForPlaceOfTrial: string, statementOfTaxpayerIdentificationNumber: string}}

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

@@ -3,6 +3,7 @@ const assert = require('assert');
 const Case = require('./Case');
 
 const A_VALID_CASE = {
+  docketNumber: '00101-18',
   documents: [
     {
       documentId: 'c6b81f4d-1e47-423a-8caf-6d2fdc3d3859',
@@ -46,6 +47,7 @@ describe('Case entity', () => {
         caseId: '241edd00-1d94-40cd-9374-8d1bc7ae6d7b',
         createdAt: '2018-11-21T20:58:28.192Z',
         status: 'new',
+        docketNumber: '00101-18',
         documents: A_VALID_CASE.documents,
       };
       const myCase = new Case(previouslyCreatedCase);
@@ -59,6 +61,7 @@ describe('Case entity', () => {
         status: 'new',
         documents: A_VALID_CASE.documents,
         payGovId: '1234',
+        docketNumber: '00101-18',
       };
       const myCase = new Case(previouslyCreatedCase);
       assert.ok(myCase.isValid());

shared/src/business/entities/CaseInitiator.js

@@ -1,29 +1,22 @@
+const { joiValidationDecorator } = require('./JoiValidationDecorator');
+const joi = require('joi-browser');
+
 /**
  * constructor
  * @param rawCaseInitiator
  * @constructor
  */
 function CaseInitiator(rawCaseInitiator) {
-  this.petitionFile = rawCaseInitiator.petitionFile;
-  this.requestForPlaceOfTrial = rawCaseInitiator.requestForPlaceOfTrial;
-  this.statementOfTaxpayerIdentificationNumber =
-    rawCaseInitiator.statementOfTaxpayerIdentificationNumber;
+  Object.assign(this, rawCaseInitiator);
 }
 
-/**
- * isValid
- * @returns {boolean}
- */
-CaseInitiator.prototype.isValid = function isValid() {
-  return (
-    !!this.petitionFile &&
-    !!this.requestForPlaceOfTrial &&
-    !!this.statementOfTaxpayerIdentificationNumber
-  );
-};
-
-CaseInitiator.prototype.exportObject = function exportObject() {
-  return Object.assign({}, this);
-};
+joiValidationDecorator(
+  CaseInitiator,
+  joi.object().keys({
+    petitionFile: joi.object().required(),
+    requestForPlaceOfTrial: joi.object().required(),
+    statementOfTaxpayerIdentificationNumber: joi.object().required(),
+  }),
+);
 
 module.exports = CaseInitiator;

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

@@ -23,4 +23,11 @@ describe('Petition entity', () => {
     });
     assert.ok(!caseDetail.isValid());
   });
+  it('Creates an invalid petition', () => {
+    const caseDetail = new CaseInitiator({
+      requestForPlaceOfTrial: new Blob(['blob']),
+      statementOfTaxpayerIdentificationNumber: undefined,
+    });
+    assert.ok(!caseDetail.isValid());
+  });
 });