New: [AEA-6061] - Support Optum post dated prescription updates (#2559)

## Summary

- ✨ New Feature

### Details

- Support batch processors' post dated prescription updates

Author: tstephen-nhs

packages/common/commonTypes/src/index.ts

@@ -11,6 +11,9 @@ export interface PSUDataItem {
   TerminalStatus: string
   ApplicationName: string
   ExpiryTime: number
+  // (Optional, legacy batch-processors only) Indicates that {@link LastModified} is postdated;
+  // contains the ISO 8601 timestamp when the postdated update was set.
+  PostDatedLastModifiedSetAt?: string
 }
 
 export interface NotifyDataItem {

packages/updatePrescriptionStatus/src/updatePrescriptionStatus.ts

@@ -384,6 +384,10 @@ export function buildDataItems(
       ExpiryTime: (Math.floor(+new Date() / 1000) + TTL_DELTA)
     }
 
+    if (task.meta?.lastUpdated) {
+      (dataItem as any).PostDatedLastModifiedSetAt = task.meta.lastUpdated
+    }
+
     dataItems.push(dataItem)
   }
   return dataItems

packages/updatePrescriptionStatus/src/validation/content.ts

@@ -63,18 +63,30 @@ export function entryContent(entry: BundleEntry): Array<string> {
 }
 
 export function lastModified(task: Task): string | undefined {
-  const today = new Date()
   const lastModified = new Date(task.lastModified!)
+  return isPastDate(lastModified, "lastModified")
+}
 
-  if (isNaN(lastModified.getTime())) {
-    return "Date format provided for lastModified is invalid."
+function isPastDate(date: Date, fieldName: string): string | undefined {
+  if (isNaN(date.getTime())) {
+    return `Date format provided for ${fieldName} is invalid.`
   }
 
-  if (lastModified.valueOf() - today.valueOf() > ONE_DAY_IN_MS) {
-    return "Invalid last modified value provided."
+  const today = new Date()
+  if (date.valueOf() - today.valueOf() > ONE_DAY_IN_MS) {
+    return `Invalid ${fieldName} value provided.`
   }
 }
 
+export function metaLastUpdated(task: Task): string | undefined {
+  if (!task.meta?.lastUpdated) {
+    return undefined
+  }
+
+  const parsed = new Date(task.meta.lastUpdated)
+  return isPastDate(parsed, "meta.lastUpdated")
+}
+
 export function prescriptionID(task: Task): string | undefined {
   const message = "Prescription ID is invalid."
   const prescriptionID = task.basedOn?.[0].identifier?.value
@@ -183,6 +195,7 @@ export function taskContent(task: Task): Array<string> {
     status,
     businessStatus,
     lastModified,
+    metaLastUpdated,
     nhsNumber,
     prescriptionID,
     resourceType,

packages/updatePrescriptionStatus/tests/testUpdatePrescriptionStatus.test.ts

@@ -287,4 +287,21 @@ describe("buildDataItems", () => {
 
     expect(dataItems[0].ExpiryTime).toBeGreaterThan(expectedExpiryTime)
   })
+
+  it("should include PostDatedLastModifiedSetAt in data item when meta.lastUpdated is defined", () => {
+    const task = validTask()
+    const lastUpdated = new Date(DEFAULT_DATE.valueOf() - (24 * 60 * 60 * 1000)).toISOString()
+    task.meta = {
+      lastUpdated: lastUpdated
+    }
+
+    const requestEntry: BundleEntry = {
+      resource: task,
+      fullUrl: ""
+    }
+
+    const dataItems = buildDataItems([requestEntry], "", "")
+    const first: any = dataItems[0]
+    expect(first.PostDatedLastModifiedSetAt).toEqual(lastUpdated)
+  })
 })

packages/updatePrescriptionStatus/tests/validation/testRequestContentValidation.test.ts

@@ -11,6 +11,7 @@ import {
   businessStatus,
   codeSystems,
   lastModified,
+  metaLastUpdated,
   nhsNumber,
   ONE_DAY_IN_MS,
   prescriptionID,
@@ -150,7 +151,7 @@ describe("Unit tests for validation of lastModified", () => {
     )
     const task = {lastModified: futureDate.toISOString()}
 
-    const expected = "Invalid last modified value provided."
+    const expected = "Invalid lastModified value provided."
 
     const actual = lastModified(task as Task)
 
@@ -176,6 +177,51 @@ describe("Unit tests for validation of lastModified", () => {
   })
 })
 
+describe("Unit tests for validation of metaLastUpdated", () => {
+  beforeEach(() => {
+    jest.useFakeTimers().setSystemTime(DEFAULT_DATE)
+  })
+
+  it("When meta.lastUpdated is over a day in the future, should return expected issue.", async () => {
+    const futureDate = new Date(
+      DEFAULT_DATE.valueOf() + (ONE_DAY_IN_MS + 1000)
+    )
+    const task = {meta: {lastUpdated: futureDate.toISOString()}}
+
+    const expected = "Invalid meta.lastUpdated value provided."
+
+    const actual = metaLastUpdated(task as Task)
+
+    expect(actual).toEqual(expected)
+  })
+
+  it("When meta.lastUpdated date format is invalid, should return expected issue.", async () => {
+    const task = {meta: {lastUpdated: "invalid date"}}
+
+    const expected = "Date format provided for meta.lastUpdated is invalid."
+
+    const actual = metaLastUpdated(task as Task)
+
+    expect(actual).toEqual(expected)
+  })
+
+  it("When meta.lastUpdated is valid and not in the future, should return undefined.", async () => {
+    const task = {meta: {lastUpdated: DEFAULT_DATE.toISOString()}}
+
+    const actual = metaLastUpdated(task as Task)
+
+    expect(actual).toEqual(undefined)
+  })
+
+  it("When meta.lastUpdated is not present, should return undefined.", async () => {
+    const task = {}
+
+    const actual = metaLastUpdated(task as Task)
+
+    expect(actual).toEqual(undefined)
+  })
+})
+
 describe("Unit tests for validation of prescription ID", () => {
   it.each([
     {

packages/updatePrescriptionStatus/tests/validation/testRequestValidationViaHandler.test.ts

@@ -55,7 +55,7 @@ describe("Integration tests for validation via updatePrescriptionStatus handler"
     const event: APIGatewayProxyEvent = generateMockEvent(body)
 
     const expected = bundleWrap([
-      badRequest("Invalid last modified value provided.", FULL_URL_0),
+      badRequest("Invalid lastModified value provided.", FULL_URL_0),
       accepted(FULL_URL_1)
     ])
 
@@ -77,7 +77,7 @@ describe("Integration tests for validation via updatePrescriptionStatus handler"
     const event: APIGatewayProxyEvent = generateMockEvent(body)
 
     const expected = bundleWrap([
-      badRequest("Invalid last modified value provided.", FULL_URL_0),
+      badRequest("Invalid lastModified value provided.", FULL_URL_0),
       badRequest("Missing required field(s) - FullUrl, PrescriptionID.")
     ])