MR-3545, MR-2370: Fix change history, add cypress tests, and turn on remaining API Unit tests

services/app-api/src/postgres/contractAndRates/findContractWithHistory.test.ts

@@ -124,7 +124,9 @@ describe('findContract', () => {
         if (threeContract instanceof Error) {
             throw threeContract
         }
-        expect(threeContract.revisions).toHaveLength(4)
+
+        // Expect 3 rate revisions on contract revision
+        expect(threeContract.revisions[0].rateRevisions).toHaveLength(3)
 
         // remove the connection from rate 2
         must(
@@ -149,14 +151,14 @@ describe('findContract', () => {
             })
         )
 
-        // Now, find that contract and assert the history is what we expected
+        // Now, find that contract and assert it has 2 rate revisions
         const twoContract = must(
             await findContractWithHistory(client, contractA.id)
         )
         if (twoContract instanceof Error) {
             throw twoContract
         }
-        expect(twoContract.revisions).toHaveLength(5)
+
         expect(twoContract.revisions[0].rateRevisions).toHaveLength(2)
 
         // update rate 1 to have a new version, should make one new rev.
@@ -182,14 +184,18 @@ describe('findContract', () => {
             })
         )
 
-        // Now, find that contract and assert the history is what we expected
+        // Now, find that contract and assert rateRevision includes our updated rate
         const backAgainContract = must(
             await findContractWithHistory(client, contractA.id)
         )
         if (backAgainContract instanceof Error) {
             throw backAgainContract
         }
-        expect(backAgainContract.revisions).toHaveLength(6)
+        expect(backAgainContract.revisions[0].rateRevisions).toHaveLength(2)
+        expect(
+            backAgainContract.revisions[0].rateRevisions[1].submitInfo
+                ?.updatedReason
+        ).toContain('1.1 new name')
 
         // Make a new Contract Revision, should show up as a single new rev with all the old info
         must(
@@ -214,7 +220,12 @@ describe('findContract', () => {
         if (testingContract instanceof Error) {
             throw testingContract
         }
-        expect(testingContract.revisions).toHaveLength(7)
+        expect(testingContract.revisions).toHaveLength(2)
+        expect(testingContract.revisions[0].rateRevisions).toHaveLength(2)
+        expect(
+            testingContract.revisions[0].rateRevisions[1].submitInfo
+                ?.updatedReason
+        ).toContain('1.1 new name')
 
         // Make a new Contract Revision, changing the connections should show up as a single new rev.
         const unlockedContractA = must(
@@ -258,7 +269,12 @@ describe('findContract', () => {
         if (testingContract instanceof Error) {
             throw testingContract
         }
-        expect(testingContract.revisions).toHaveLength(8)
+        expect(testingContract.revisions).toHaveLength(3)
+        expect(testingContract.revisions[0].rateRevisions).toHaveLength(1)
+        expect(
+            testingContract.revisions[0].rateRevisions[0].formData
+                .rateCertificationName
+        ).toContain('threepointo')
 
         // Now, find that contract and assert the history is what we expected
         const resultingContract = must(
@@ -277,72 +293,39 @@ describe('findContract', () => {
 
         // Each Revision needs a Reason, one of the contracts or revisions associated with it should have changed and why.
 
-        expect(revisionsInTimeOrder).toHaveLength(8)
-        expect(revisionsInTimeOrder[0].rateRevisions).toHaveLength(0)
+        // Assert Initial submitted revision has correct data
+        expect(revisionsInTimeOrder).toHaveLength(3)
+        expect(revisionsInTimeOrder[0].rateRevisions).toHaveLength(2)
         expect(revisionsInTimeOrder[0].unlockInfo).toBeUndefined()
         expect(revisionsInTimeOrder[0].submitInfo?.updatedReason).toBe(
             'initial submit'
         )
 
-        expect(revisionsInTimeOrder[1].rateRevisions).toHaveLength(1)
-        expect(revisionsInTimeOrder[1].unlockInfo).toBeUndefined()
-        expect(revisionsInTimeOrder[1].submitInfo?.updatedReason).toBe(
-            'Rate Submit'
-        )
-
-        expect(revisionsInTimeOrder[2].rateRevisions).toHaveLength(2)
-        expect(revisionsInTimeOrder[2].unlockInfo).toBeUndefined()
-        expect(revisionsInTimeOrder[2].submitInfo?.updatedReason).toBe(
-            'RateSubmit 2'
-        )
-
-        expect(revisionsInTimeOrder[3].rateRevisions).toHaveLength(3)
-        expect(revisionsInTimeOrder[3].unlockInfo).toBeUndefined()
-        expect(revisionsInTimeOrder[3].submitInfo?.updatedReason).toBe(
-            '3.0 create'
-        )
-
-        expect(revisionsInTimeOrder[4].rateRevisions).toHaveLength(2)
-        expect(revisionsInTimeOrder[4].unlockInfo?.updatedReason).toBe(
-            'unlock for 2.1 remove'
-        )
-        expect(revisionsInTimeOrder[4].unlockInfo?.updatedBy).toBe(
-            'zuko@example.com'
+        // Assert first unlock and resubmit has correct data
+        expect(revisionsInTimeOrder[1].rateRevisions).toHaveLength(2)
+        expect(revisionsInTimeOrder[1].unlockInfo?.updatedReason).toBe(
+            'unlocking A.0'
         )
-        expect(revisionsInTimeOrder[4].submitInfo?.updatedReason).toBe(
-            '2.1 remove'
+        expect(revisionsInTimeOrder[1].submitInfo?.updatedReason).toBe(
+            'Submitting A.1'
         )
 
-        expect(revisionsInTimeOrder[5].rateRevisions).toHaveLength(2)
-        expect(
-            revisionsInTimeOrder[5].rateRevisions[1].formData
-                .rateCertificationName
-        ).toBe('onepointone')
-        expect(revisionsInTimeOrder[5].unlockInfo?.updatedReason).toBe(
-            'unlock for 1.1'
-        )
-        expect(revisionsInTimeOrder[5].submitInfo?.updatedReason).toBe(
-            '1.1 new name'
+        // Assert final unlock and resubmit has correct data
+        expect(revisionsInTimeOrder[2].unlockInfo?.updatedReason).toBe(
+            'unlocking A.1'
         )
-
-        expect(revisionsInTimeOrder[6].rateRevisions).toHaveLength(2)
-        expect(revisionsInTimeOrder[6].submitInfo?.updatedReason).toBe(
-            'Submitting A.1'
+        expect(revisionsInTimeOrder[2].submitInfo?.updatedReason).toBe(
+            'Submitting A.2'
         )
-
-        expect(revisionsInTimeOrder[7].rateRevisions).toHaveLength(1)
-        expect(revisionsInTimeOrder[7].formData).toEqual(
+        expect(revisionsInTimeOrder[2].formData).toEqual(
             expect.objectContaining({
                 submissionType: 'CONTRACT_AND_RATES',
                 submissionDescription: 'a.2 body',
             })
         )
-        expect(revisionsInTimeOrder[7].submitInfo?.updatedReason).toBe(
-            'Submitting A.2'
-        )
+        expect(revisionsInTimeOrder[2].rateRevisions).toHaveLength(1)
 
         // check for rate and see if it handles the removed bit right
-
         const rate1fetched = await findRateWithHistory(client, rate1.id)
         if (rate1fetched instanceof Error) {
             throw rate1fetched
@@ -578,36 +561,21 @@ describe('findContract', () => {
 
         // Each Revision needs a Reason, one of the contracts or revisions associated with it should have changed and why.
 
-        expect(revisions).toHaveLength(8)
-        expect(revisions[0].rateRevisions).toHaveLength(0)
+        expect(revisions).toHaveLength(3)
+        expect(revisions[0].rateRevisions).toHaveLength(2)
         expect(revisions[0].submitInfo?.updatedReason).toBe('initial submit')
 
-        expect(revisions[1].rateRevisions).toHaveLength(1)
-        expect(revisions[1].submitInfo?.updatedReason).toBe('Rate Submit')
-
-        expect(revisions[2].rateRevisions).toHaveLength(2)
-        expect(revisions[2].submitInfo?.updatedReason).toBe('RateSubmit 2')
-
-        expect(revisions[3].rateRevisions).toHaveLength(3)
-        expect(revisions[4].rateRevisions).toHaveLength(2)
-
-        expect(revisions[5].rateRevisions).toHaveLength(2)
-        expect(
-            revisions[5].rateRevisions[1].formData.rateCertificationName
-        ).toBe('onepointone')
-        expect(revisions[5].submitInfo?.updatedReason).toBe('1.1 new name')
-
-        expect(revisions[6].rateRevisions).toHaveLength(2)
-        expect(revisions[6].submitInfo?.updatedReason).toBe('Submitting A.1')
+        expect(revisions[1].rateRevisions).toHaveLength(2)
+        expect(revisions[1].submitInfo?.updatedReason).toBe('Submitting A.1')
 
-        expect(revisions[7].rateRevisions).toHaveLength(1)
-        expect(revisions[7].formData).toEqual(
+        expect(revisions[2].rateRevisions).toHaveLength(1)
+        expect(revisions[2].submitInfo?.updatedReason).toBe('Submitting A.2')
+        expect(revisions[2].formData).toEqual(
             expect.objectContaining({
                 submissionType: 'CONTRACT_AND_RATES',
                 submissionDescription: 'a.2 body',
             })
         )
-        expect(revisions[7].submitInfo?.updatedReason).toBe('Submitting A.2')
 
         // check for rate and see if it handles the removed bit right
 
@@ -818,19 +786,16 @@ describe('findContract', () => {
             JSON.stringify(revisions, null, '  ')
         )
 
-        expect(revisions).toHaveLength(3)
+        expect(revisions).toHaveLength(2)
         expect(revisions[0].rateRevisions).toHaveLength(2)
         expect(revisions[0].submitInfo?.updatedReason).toBe('initial submit')
 
         expect(revisions[1].rateRevisions).toHaveLength(2)
-        expect(revisions[1].submitInfo?.updatedReason).toBe('2.1 update')
-
-        expect(revisions[2].rateRevisions).toHaveLength(2)
-        expect(revisions[2].submitInfo?.updatedReason).toBe('third submit')
+        expect(revisions[1].submitInfo?.updatedReason).toBe('third submit')
 
         // these revisions can be in any order because they were saved at the same time
         const revisionFormDatas = new Set(
-            revisions[2].rateRevisions.map(
+            revisions[1].rateRevisions.map(
                 (rr) => rr.formData.rateCertificationName
             )
         )

services/app-api/src/postgres/contractAndRates/findRateWithHistory.test.ts

@@ -9,7 +9,11 @@ import { insertDraftRate } from './insertRate'
 import { updateDraftRate } from './updateDraftRate'
 import { unlockRate } from './unlockRate'
 import { findRateWithHistory } from './findRateWithHistory'
-import { must, createInsertContractData } from '../../testHelpers'
+import {
+    must,
+    createInsertContractData,
+    consoleLogFullData,
+} from '../../testHelpers'
 import { createInsertRateData } from '../../testHelpers/contractAndRates/rateHelpers'
 import { findContractWithHistory } from './findContractWithHistory'
 import type { DraftContractType } from '../../domain-models/contractAndRates/contractTypes'
@@ -368,10 +372,14 @@ describe('findRate', () => {
             throw contract1fetched
         }
 
-        expect(contract1fetched.revisions).toHaveLength(4)
-        expect(contract1fetched.revisions[0].submitInfo?.updatedReason).toBe(
-            'Submitting A.2'
-        )
+        consoleLogFullData(contract1fetched.revisions)
+        expect(contract1fetched.revisions).toHaveLength(2)
+
+        // Latest revision should have no rates now
+        expect(contract1fetched.revisions[0].rateRevisions).toHaveLength(0)
+
+        // Initial submit should have 1 rate
+        expect(contract1fetched.revisions[1].rateRevisions).toHaveLength(1)
     })
 
     it('finds a full rate', async () => {

services/app-api/src/postgres/contractAndRates/parseContractWithHistory.ts

@@ -146,10 +146,56 @@ function contractWithHistoryToDomainModel(
 
         allRevisionSets.push(initialEntry)
 
-        let lastEntry = initialEntry
-        // Now we construct a revision history for each change in rate revisions.
-        // go through every rate revision in the join table in time order and construct a revisionSet
-        // with (or without) the new rate revision in it.
+        // This code below was used to construct rate change history and add into our contract revision history by pushing
+        //  new contract revisions into the array. This however caused issues with the frontend apollo cache because we
+        //  used duplicate contract revision ids to create new revisions for rate changes.
+        // For now, we are commenting out the code until we are ready for this feature and leaving it intact.
+
+        // let lastEntry = initialEntry
+        // // Now we construct a revision history for each change in rate revisions.
+        // // go through every rate revision in the join table in time order and construct a revisionSet
+        // // with (or without) the new rate revision in it.
+        // for (const rateRev of contractRev.rateRevisions) {
+        //     if (!rateRev.rateRevision.submitInfo) {
+        //         return new Error(
+        //             'Programming Error: a contract is associated with an unsubmitted rate'
+        //         )
+        //     }
+        //
+        //     // if it's from before this contract was submitted, it's there at the beginning.
+        //     if (
+        //         rateRev.rateRevision.submitInfo.updatedAt <=
+        //         contractRev.submitInfo.updatedAt
+        //     ) {
+        //         if (!rateRev.isRemoval) {
+        //             initialEntry.rateRevisions.push(rateRev.rateRevision)
+        //         }
+        //     } else {
+        //         // if after, then it's always a new entry in the list
+        //         let lastRates = [...lastEntry.rateRevisions]
+        //
+        //         // take out the previous rate revision this revision supersedes
+        //         lastRates = lastRates.filter(
+        //             (r) => r.rateID !== rateRev.rateRevision.rateID
+        //         )
+        //         // an isRemoval entry indicates that this rate was removed from this contract.
+        //         if (!rateRev.isRemoval) {
+        //             lastRates.push(rateRev.rateRevision)
+        //         }
+        //
+        //         const newRev: ContractRevisionSet = {
+        //             contractRev,
+        //             submitInfo: rateRev.rateRevision.submitInfo,
+        //             unlockInfo: rateRev.rateRevision.unlockInfo || undefined,
+        //             rateRevisions: lastRates,
+        //         }
+        //
+        //         lastEntry = newRev
+        //         allRevisionSets.push(newRev)
+        //     }
+        // }
+
+        // Basically the same as above, except we do not create new contract revisions for rate changes.
         for (const rateRev of contractRev.rateRevisions) {
             if (!rateRev.rateRevision.submitInfo) {
                 return new Error(
@@ -167,7 +213,7 @@ function contractWithHistoryToDomainModel(
                 }
             } else {
                 // if after, then it's always a new entry in the list
-                let lastRates = [...lastEntry.rateRevisions]
+                let lastRates = [...initialEntry.rateRevisions]
 
                 // take out the previous rate revision this revision supersedes
                 lastRates = lastRates.filter(
@@ -178,15 +224,7 @@ function contractWithHistoryToDomainModel(
                     lastRates.push(rateRev.rateRevision)
                 }
 
-                const newRev: ContractRevisionSet = {
-                    contractRev,
-                    submitInfo: rateRev.rateRevision.submitInfo,
-                    unlockInfo: rateRev.rateRevision.unlockInfo || undefined,
-                    rateRevisions: lastRates,
-                }
-
-                lastEntry = newRev
-                allRevisionSets.push(newRev)
+                initialEntry.rateRevisions = lastRates
             }
         }
     }