Add duplicate validation

Author: francisco-videira-nhs

internal/datastore/src/types.md

@@ -31,14 +31,16 @@ erDiagram
 erDiagram
     MI {
         string id
-        string supplierId
-        string specificationId
-        string groupId
         string lineItem
+        string timestamp
         number quantity
+        string specificationId
+        string groupId
         number stockRemaining
+        string supplierId
         string createdAt
         string updatedAt
+        number ttl "min: -9007199254740991, max: 9007199254740991"
     }
 ```
 

lambdas/api-handler/src/contracts/errors.ts

@@ -36,7 +36,8 @@ export enum ApiErrorDetail {
   InvalidRequestLimitOnly = "Only 'limit' query parameter is supported",
   InvalidRequestNoRequestId = 'The request does not contain a request id',
   InvalidRequestTimestamp = 'Timestamps should be UTC date/times in ISO8601 format, with a Z suffix',
-  InvalidRequestLettersToUpdate = 'The request exceeds the maximum of %s items allowed for update'
+  InvalidRequestLettersToUpdate = 'The request exceeds the maximum of %s items allowed for update',
+  InvalidRequestDuplicateLetterId = 'The request cannot include multiple letter objects with the same id'
 }
 
 export function buildApiError(params: {

lambdas/api-handler/src/handlers/__tests__/post-letters.test.ts

@@ -209,6 +209,44 @@ describe('postLetters API Handler', () => {
     expect(result).toEqual(expectedErrorResponse);
   });
 
+    it('returns error when the request has duplicate letter ids', async () => {
+
+    const event = makeApiGwEvent({
+      path: '/letters',
+      body: JSON.stringify({
+        data: [
+          {
+            id: 'id1',
+            type: 'Letter',
+            attributes: {
+              status: 'ACCEPTED'
+            }
+          },
+          {
+            id: 'id1',
+            type: 'Letter',
+            attributes: {
+              status: 'ACCEPTED'
+            }
+          }
+        ]
+      }),
+      headers: {
+        'nhsd-supplier-id': 'supplier1',
+        'nhsd-correlation-id': 'correlationId',
+        'x-request-id': 'requestId'
+      }
+    });
+    const context = mockDeep<Context>();
+    const callback = jest.fn();
+
+    const postLettersHandler = createPostLettersHandler(mockedDeps);
+    const result = await postLettersHandler(event, context, callback);
+
+    expect(mockedProcessError).toHaveBeenCalledWith(new ValidationError(errors.ApiErrorDetail.InvalidRequestDuplicateLetterId), 'correlationId', mockedDeps.logger);
+    expect(result).toEqual(expectedErrorResponse);
+  });
+
   it('returns error when request body is not json', async () => {
     const event = makeApiGwEvent({
       path: '/letters',

lambdas/api-handler/src/handlers/post-letters.ts

@@ -38,6 +38,10 @@ export function createPostLettersHandler(deps: Deps): APIGatewayProxyHandler {
         throw new ValidationError(ApiErrorDetail.InvalidRequestLettersToUpdate, { args: [maxUpdateItems]});
       }
 
+      if( duplicateIdsExist(postLettersRequest) ) {
+        throw new ValidationError(ApiErrorDetail.InvalidRequestDuplicateLetterId);
+      }
+
       await enqueueLetterUpdateRequests(postLettersRequest, commonHeadersResult.value.supplierId, commonHeadersResult.value.correlationId, deps);
 
       return {
@@ -50,3 +54,8 @@ export function createPostLettersHandler(deps: Deps): APIGatewayProxyHandler {
     }
   };
 };
+
+function duplicateIdsExist(postLettersRequest: PostLettersRequest) {
+  const ids = postLettersRequest.data.map(item => item.id);
+  return new Set(ids).size !== ids.length;
+}

sandbox/api/openapi.yaml

@@ -459,6 +459,8 @@ paths:
 
         It is not possible to update a letter to status of `PENDING`.
 
+        The request should not contain multiple letter objects with the same ID.
+
         Optionally a `reasonCode` and `reasonText` explaining the status (for example, validation failures) can be included in the request body for each update.
       operationId: postLetters
       parameters:
@@ -561,23 +563,23 @@ paths:
                 example: 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA
                 type: string
               style: simple
-        "404":
+        "400":
           content:
             application/vnd.api+json:
               examples:
-                error-not-found:
+                error-bad-request-invalid-request-body:
                   value:
                     errors:
-                    - code: NOTIFY_RESOURCE_NOT_FOUND
-                      detail: No resource found with that ID
+                    - code: NOTIFY_INVALID_REQUEST
+                      detail: The request body is invalid
                       id: rrt-1931948104716186917-c-geu2-10664-3111479-3.0
                       links:
                         about: https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier
-                      status: "404"
-                      title: Resource not found
+                      status: "400"
+                      title: Invalid request
               schema:
                 $ref: "#/components/schemas/listLetters_400_response"
-          description: Resource not found
+          description: "Bad request, invalid input data"
         "429":
           content:
             application/vnd.api+json:

sandbox/services/LetterService.js

@@ -111,7 +111,7 @@ const patchLetter = ({ xRequestId, id, body, xCorrelationId }) => new Promise(
 * xRequestId String Unique request identifier, in the format of a GUID
 * postLettersRequest PostLettersRequest
 * xCorrelationId String An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place. The ID will be returned in a response header. (optional)
-* returns listLetters_200_response
+* returns 202
 * */
 const postLetters = ({ xRequestId, body, xCorrelationId }) => new Promise(
   async (resolve, reject) => {

sandbox/utils/ResponseProvider.js

@@ -93,10 +93,10 @@ async function patchLetterResponse(request) {
 }
 
 async function postLettersResponse(request) {
-  const patchLetterFileMap = {
+  const postLettersFileMap = {
     'data/examples/postLetter/requests/postLetters.json': {responsePath: 'data/examples/postLetter/responses/postLetters.json', responseCode: 202},
   };
-  return await mapExampleResponse(request, patchLetterFileMap);
+  return await mapExampleResponse(request, postLettersFileMap);
 }
 
 async function postMIResponse(request) {

specification/api/components/documentation/postLetters.md

@@ -25,4 +25,6 @@ Allowed `status` values that can be used to are:
 
 It is not possible to update a letter to status of `PENDING`.
 
+The request should not contain multiple letter objects with the same ID.
+
 Optionally a `reasonCode` and `reasonText` explaining the status (for example, validation failures) can be included in the request body for each update.