Change the isTerminalState field to boolean

NHSDigital · Jul 4, 2024 · 8e038d7 · 8e038d7
1 parent 2854640
commit 8e038d7
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 53 deletions.
diff --git a/packages/gsul/src/dynamoDBclient.ts b/packages/gsul/src/dynamoDBclient.ts
@@ -39,7 +39,7 @@ export async function getItemsUpdatesForPrescription(
   return items.map((singleUpdate) => ({
     itemId: String(singleUpdate.LineItemID),
     latestStatus: String(singleUpdate.Status),
-    isTerminalState: String(singleUpdate.TerminalStatus),
+    isTerminalState: Boolean(singleUpdate.TerminalStatus),
     lastUpdateDateTime: String(singleUpdate.LastModified)
   }))
 }

diff --git a/packages/gsul/src/schema/response.ts b/packages/gsul/src/schema/response.ts
@@ -1,6 +1,5 @@
 import {FromSchema} from "json-schema-to-ts"
 
-// Set the isTerminalState field to bool
 const itemSchema = {
   type: "object",
   required: ["itemId", "latestStatus", "isTerminalState", "lastUpdateDateTime"],
@@ -12,7 +11,7 @@ const itemSchema = {
       type: "string"
     },
     isTerminalState: {
-      type: "string"
+      type: "boolean"
     },
     lastUpdateDateTime: {
       type: "string"

diff --git a/packages/gsul/tests/testBuildResult.test.ts b/packages/gsul/tests/testBuildResult.test.ts
@@ -19,7 +19,7 @@ const scenarios: Array<scenariosType> = [
       {
         itemId: "item_1",
         latestStatus: "latest_status",
-        isTerminalState: "is_terminal_status",
+        isTerminalState: true,
         lastUpdateDateTime: "1970-01-01T00:00:00Z"
       }
     ],
@@ -30,7 +30,7 @@ const scenarios: Array<scenariosType> = [
         {
           itemId: "item_1",
           latestStatus: "latest_status",
-          isTerminalState: "is_terminal_status",
+          isTerminalState: true,
           lastUpdateDateTime: "1970-01-01T00:00:00Z"
         }
       ]
@@ -59,13 +59,13 @@ const scenarios: Array<scenariosType> = [
       {
         itemId: "item_1",
         latestStatus: "early_status",
-        isTerminalState: "is_terminal_status",
+        isTerminalState: true,
         lastUpdateDateTime: "1970-01-01T00:00:00Z"
       },
       {
         itemId: "item_1",
         latestStatus: "latest_status",
-        isTerminalState: "is_terminal_status",
+        isTerminalState: true,
         lastUpdateDateTime: "1971-01-01T00:00:00Z"
       }
     ],
@@ -76,7 +76,7 @@ const scenarios: Array<scenariosType> = [
         {
           itemId: "item_1",
           latestStatus: "latest_status",
-          isTerminalState: "is_terminal_status",
+          isTerminalState: true,
           lastUpdateDateTime: "1971-01-01T00:00:00Z"
         }
       ]
@@ -92,25 +92,25 @@ const scenarios: Array<scenariosType> = [
       {
         itemId: "item_1",
         latestStatus: "item_1_status",
-        isTerminalState: "is_terminal_status",
+        isTerminalState: true,
         lastUpdateDateTime: "1970-01-01T00:00:00Z"
       },
       {
         itemId: "item_1",
         latestStatus: "latest_item_1_status",
-        isTerminalState: "is_terminal_status",
+        isTerminalState: true,
         lastUpdateDateTime: "1972-01-01T00:00:00Z"
       },
       {
         itemId: "item_2",
         latestStatus: "item_2_status",
-        isTerminalState: "is_terminal_status",
+        isTerminalState: true,
         lastUpdateDateTime: "1971-01-01T00:00:00Z"
       },
       {
         itemId: "item_2",
         latestStatus: "early_item_2_status",
-        isTerminalState: "is_terminal_status",
+        isTerminalState: true,
         lastUpdateDateTime: "1970-01-01T00:00:00Z"
       }
     ],
@@ -121,13 +121,13 @@ const scenarios: Array<scenariosType> = [
         {
           itemId: "item_1",
           latestStatus: "latest_item_1_status",
-          isTerminalState: "is_terminal_status",
+          isTerminalState: true,
           lastUpdateDateTime: "1972-01-01T00:00:00Z"
         },
         {
           itemId: "item_2",
           latestStatus: "item_2_status",
-          isTerminalState: "is_terminal_status",
+          isTerminalState: true,
           lastUpdateDateTime: "1971-01-01T00:00:00Z"
         }
       ]

diff --git a/packages/gsul/tests/testHander.test.ts b/packages/gsul/tests/testHander.test.ts
@@ -30,13 +30,18 @@ describe("test handler", () => {
   })
 
   it("respond with error when schema version is 2", async () => {
-    const response = await handler({
-      "schemaVersion": 2,
-      "prescriptions": [{
-        prescriptionID: "abc",
-        odsCode: "123"
-      }]
-    }, dummyContext)
+    const response = await handler(
+      {
+        schemaVersion: 2,
+        prescriptions: [
+          {
+            prescriptionID: "abc",
+            odsCode: "123"
+          }
+        ]
+      },
+      dummyContext
+    )
     expect(response).toMatchObject({
       schemaVersion: 1,
       isSuccess: false,
@@ -53,9 +58,11 @@ describe("test handler", () => {
 
     const response = await handler(
       {
-        "schemaVersion": 1,
-        "prescriptions": []
-      }, dummyContext)
+        schemaVersion: 1,
+        prescriptions: []
+      },
+      dummyContext
+    )
     expect(response).toMatchObject({
       schemaVersion: 1,
       isSuccess: true,
@@ -66,37 +73,47 @@ describe("test handler", () => {
   it("respond with success when data passed in", async () => {
     const mockReply = {
       Count: 1,
-      Items: [{
-        PrescriptionID: "abc",
-        LineItemID: "item_1",
-        Status: "latest_status",
-        TerminalStatus: "terminal",
-        LastModified: "1970-01-01T00:00:00Z"
-      }]
+      Items: [
+        {
+          PrescriptionID: "abc",
+          LineItemID: "item_1",
+          Status: "latest_status",
+          TerminalStatus: true,
+          LastModified: "1970-01-01T00:00:00Z"
+        }
+      ]
     }
     jest.spyOn(DynamoDBDocumentClient.prototype, "send").mockResolvedValue(mockReply as never)
 
     const response = await handler(
       {
-        "schemaVersion": 1,
-        "prescriptions": [{
-          prescriptionID: "abc",
-          odsCode: "123"
-        }]
-      }, dummyContext)
+        schemaVersion: 1,
+        prescriptions: [
+          {
+            prescriptionID: "abc",
+            odsCode: "123"
+          }
+        ]
+      },
+      dummyContext
+    )
     expect(response).toMatchObject({
       schemaVersion: 1,
       isSuccess: true,
-      prescriptions: [{
-        prescriptionID: "abc",
-        onboarded: true,
-        items: [{
-          itemId: "item_1",
-          latestStatus: "latest_status",
-          isTerminalState: "terminal",
-          lastUpdateDateTime: "1970-01-01T00:00:00Z"
-        }]
-      }]
+      prescriptions: [
+        {
+          prescriptionID: "abc",
+          onboarded: true,
+          items: [
+            {
+              itemId: "item_1",
+              latestStatus: "latest_status",
+              isTerminalState: true,
+              lastUpdateDateTime: "1970-01-01T00:00:00Z"
+            }
+          ]
+        }
+      ]
     })
   })
 })
diff --git a/packages/gsul/tests/testRunDynamoDBQueries.test.ts b/packages/gsul/tests/testRunDynamoDBQueries.test.ts
@@ -21,7 +21,7 @@ describe("testing dynamoDBClient", () => {
           PrescriptionID: "abc",
           LineItemID: "item_1",
           Status: "latest_status",
-          TerminalStatus: "is_terminal_status",
+          TerminalStatus: true,
           LastModified: "1970-01-01T00:00:00Z"
         }
       ]
@@ -37,7 +37,7 @@ describe("testing dynamoDBClient", () => {
       {
         itemId: "item_1",
         latestStatus: "latest_status",
-        isTerminalState: "is_terminal_status",
+        isTerminalState: true,
         lastUpdateDateTime: "1970-01-01T00:00:00Z"
       }
     ])
@@ -71,7 +71,7 @@ describe("testing pagination in dynamoDBClient", () => {
           PrescriptionID: "abc",
           LineItemID: "item_1",
           Status: "first_status",
-          TerminalStatus: "is_terminal_status",
+          TerminalStatus: true,
           LastModified: "1970-01-01T00:00:00Z"
         }
       ],
@@ -88,7 +88,7 @@ describe("testing pagination in dynamoDBClient", () => {
           PrescriptionID: "abc",
           LineItemID: "item_1",
           Status: "second_status",
-          TerminalStatus: "is_terminal_status",
+          TerminalStatus: true,
           LastModified: "1970-01-01T00:00:00Z"
         }
       ]
@@ -106,13 +106,13 @@ describe("testing pagination in dynamoDBClient", () => {
       {
         itemId: "item_1",
         latestStatus: "first_status",
-        isTerminalState: "is_terminal_status",
+        isTerminalState: true,
         lastUpdateDateTime: "1970-01-01T00:00:00Z"
       },
       {
         itemId: "item_1",
         latestStatus: "second_status",
-        isTerminalState: "is_terminal_status",
+        isTerminalState: true,
         lastUpdateDateTime: "1970-01-01T00:00:00Z"
       }
     ])