Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: [AEA-4168] - 200 response for duplicate item #384

Merged
merged 13 commits into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions packages/specification/examples/request-duplicate-items.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"resourceType": "Bundle",
"type": "transaction",
"entry": [
{
"fullUrl": "urn:uuid:d70678c-81e4-6665-8c67-17596fd0aa87",
"resource": {
"resourceType": "Task",
"id": "d70678c-81e4-6665-8c67-17596fd0aa87",
"basedOn": [
{
"identifier": {
"system": "https://fhir.nhs.uk/Id/prescription-order-number",
"value": "07A66F-A83008-1EEEA0"
}
}
],
"status": "completed",
"businessStatus": {
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/task-businessStatus-nppt",
"code": "Dispatched"
}
]
},
"intent": "order",
"focus": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/prescription-order-item-number",
"value": "6989b7bd-8db6-428c-a593-4022e3044c00"
}
},
"for": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9449304130"
}
},
"lastModified": "2023-09-11T10:11:12Z",
"owner": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "C9Z1O"
}
}
},
"request": {
"method": "POST",
"url": "Task"
}
}
]
}
26 changes: 22 additions & 4 deletions packages/updatePrescriptionStatus/src/updatePrescriptionStatus.ts
Original file line number Diff line number Diff line change
Expand Up @@ -154,14 +154,32 @@ export function handleTransactionCancelledException(
e: TransactionCanceledException,
responseEntries: Array<BundleEntry>
): void {
responseEntries.length = 0
const taskIdSet = new Set<string>()

e.CancellationReasons?.forEach((reason) => {
if (reason.Item?.TaskID?.S) {
const taskId = reason.Item.TaskID.S
responseEntries.push(conflictDuplicate(taskId))
const taskId = reason.Item?.TaskID?.S
if (taskId) {
const conflictedEntry = conflictDuplicate(taskId)

const index = responseEntries.findIndex((entry) => {
const entryTaskId = entry.response?.location?.split("/").pop() || entry.fullUrl?.split(":").pop()
return entryTaskId === taskId
})

if (index !== -1) {
responseEntries[index] = conflictedEntry
} else {
responseEntries.push(conflictedEntry)
}

taskIdSet.add(taskId)
}
})

responseEntries = responseEntries.filter((entry) => {
const taskId = entry.fullUrl?.split(":").pop()
return !taskId || !taskIdSet.has(taskId) || entry.response?.status !== "200 OK"
})
}

export function buildDataItems(
Expand Down
64 changes: 60 additions & 4 deletions packages/updatePrescriptionStatus/tests/testHandler.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import requestMultipleItems from "../../specification/examples/request-multiple-
import requestMissingFields from "../../specification/examples/request-missing-fields.json"
import requestMultipleMissingFields from "../../specification/examples/request-multiple-missing-fields.json"
import requestNoItems from "../../specification/examples/request-no-items.json"
import requestDuplicateItems from "../../specification/examples/request-duplicate-items.json"
import responseSingleItem from "../../specification/examples/response-single-item.json"
import responseMultipleItems from "../../specification/examples/response-multiple-items.json"
import {
Expand Down Expand Up @@ -199,20 +200,75 @@ describe("Integration tests for updatePrescriptionStatus handler", () => {
expect(response.statusCode).toEqual(201)
})

it("when duplicates are introduced, expect 409 status code and message indicating duplicate fields", async () => {
it("when duplicates are introduced, expect only 409 status with a message, while the other response gives a 200 with message", async () => {
const body = generateBody()
const mockEvent: APIGatewayProxyEvent = generateMockEvent(body)

mockSend.mockRejectedValue(
new TransactionCanceledException({
message: "DynamoDB transaction cancelled due to conditional check failure.",
$metadata: {},
CancellationReasons: [
{
Code: "ConditionalCheckFailed",
Item: {
TaskID: {S: "d70678c-81e4-6665-8c67-17596fd0aa87"}
},
Message: "The conditional request failed"
}
]
}) as never
)

const response: APIGatewayProxyResult = await handler(mockEvent, {})
const responseBody = JSON.parse(response.body)

expect(response.statusCode).toBe(409)
expect(responseBody.entry).toHaveLength(2)

expect(responseBody.entry[0].fullUrl).toEqual("urn:uuid:4d70678c-81e4-4ff4-8c67-17596fd0aa46")
expect(responseBody.entry[0].response.status).toEqual("200 OK")
expect(responseBody.entry[0].response.outcome.issue[0].diagnostics).toEqual(
"Data not committed due to issues in other entries."
)
expect(responseBody.entry[1].response.location).toEqual("Task/d70678c-81e4-6665-8c67-17596fd0aa87")
expect(responseBody.entry[1].response.status).toEqual("409 Conflict")
expect(responseBody.entry[1].response.outcome.issue[0].diagnostics).toEqual(
"Request contains a task id and prescription id identical to a record already in the data store."
)
expect(responseBody.entry[1].response.status).not.toEqual("200 OK")
})

it("when duplicates are introduced without any other entry, expect only 409 status with a message", async () => {
const mockEvent: APIGatewayProxyEvent = generateMockEvent(requestDuplicateItems)

mockSend.mockRejectedValue(
new TransactionCanceledException({
message: "DynamoDB transaction cancelled due to conditional check failure.",
CancellationReasons: [{Code: "ConditionalCheckFailedException"}]
$metadata: {},
CancellationReasons: [
{
Code: "ConditionalCheckFailed",
Item: {
TaskID: {S: "d70678c-81e4-6665-8c67-17596fd0aa87"}
},
Message: "The conditional request failed"
}
]
}) as never
)

const result: APIGatewayProxyResult = await handler(mockEvent, {})
const response: APIGatewayProxyResult = await handler(mockEvent, {})
const responseBody = JSON.parse(response.body)

expect(response.statusCode).toBe(409)
expect(responseBody.entry).toHaveLength(1)

expect(result.statusCode).toBe(409)
expect(responseBody.entry[0].response.location).toEqual("Task/d70678c-81e4-6665-8c67-17596fd0aa87")
expect(responseBody.entry[0].response.status).toEqual("409 Conflict")
expect(responseBody.entry[0].response.outcome.issue[0].diagnostics).toEqual(
"Request contains a task id and prescription id identical to a record already in the data store."
)
expect(responseBody.entry[0].response.status).not.toEqual("200 OK")
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ describe("Unit test validateEntries", () => {
})

describe("handleTransactionCancelledException", () => {
it("should add conflictDuplicate entries to responseEntries", () => {
it("should add a conflictDuplicate entry to responseEntries", () => {
const responseEntries: Array<any> = []
const mockException: TransactionCanceledException = {
name: "TransactionCanceledException",
Expand All @@ -141,7 +141,7 @@ describe("handleTransactionCancelledException", () => {
{
Code: "ConditionalCheckFailed",
Item: {
TaskID: {S: "d70678c-81e4-6665-8c67-17596fd0aa46"}
TaskID: {S: "d70678c-81e4-6665-8c67-17596fd0aa87"}
},
Message: "The conditional request failed"
}
Expand All @@ -152,7 +152,52 @@ describe("handleTransactionCancelledException", () => {
const validResponseEntry = responseEntries[0]

expect(responseEntries).toHaveLength(1)
expect(validResponseEntry).toEqual(conflictDuplicate("d70678c-81e4-6665-8c67-17596fd0aa46"))
expect(validResponseEntry).toEqual(conflictDuplicate("d70678c-81e4-6665-8c67-17596fd0aa87"))
expect(validResponseEntry.response?.status).toEqual("409 Conflict")
})

it("should replaces a 200 for a duplicate item with a conflictDuplicate entry to responseEntries", () => {
const responseEntries: Array<any> = [
{
fullUrl: "urn:uuid:d70678c-81e4-6665-8c67-17596fd0aa87",
response: {
outcome: {
issue: [
{
code: "informational",
diagnostics: "Data not committed due to issues in other entries.",
severity: "information"
}
],
meta: {lastUpdated: "2023-09-11T10:11:12.000Z"},
resourceType: "OperationOutcome"
},
status: "200 OK"
}
}
]
const mockException: TransactionCanceledException = {
name: "TransactionCanceledException",
message: "DynamoDB transaction cancelled due to conditional check failure.",
$fault: "client",
$metadata: {},
CancellationReasons: [
{
Code: "ConditionalCheckFailed",
Item: {
TaskID: {S: "d70678c-81e4-6665-8c67-17596fd0aa87"}
},
Message: "The conditional request failed"
}
]
}

handleTransactionCancelledException(mockException, responseEntries)
const validResponseEntry = responseEntries[0]

expect(responseEntries).toHaveLength(1)
expect(validResponseEntry).toEqual(conflictDuplicate("d70678c-81e4-6665-8c67-17596fd0aa87"))
expect(validResponseEntry.response?.status).toEqual("409 Conflict")
expect(validResponseEntry.response?.status).not.toEqual("200 OK")
})
})