CCM-11188 Implement patch /letter/id API

.vscode/launch.json

@@ -0,0 +1,50 @@
+{
+  "configurations": [
+    {
+      "args": [
+        "${relativeFile}",
+        "--runInBand"
+      ],
+      "console": "integratedTerminal",
+      "cwd": "${workspaceFolder}/${input:workspace}",
+      "internalConsoleOptions": "neverOpen",
+      "name": "Debug current test file (pick workspace)",
+      "program": "${workspaceFolder}/node_modules/.bin/jest",
+      "request": "launch",
+      "type": "node"
+    },
+    {
+      "args": [
+        "${relativeFile}",
+        "--runInBand",
+        "--testNamePattern",
+        "${input:testName}"
+      ],
+      "console": "integratedTerminal",
+      "cwd": "${workspaceFolder}/${input:workspace}",
+      "internalConsoleOptions": "neverOpen",
+      "name": "Debug single test by name (pick workspace)",
+      "program": "${workspaceFolder}/node_modules/.bin/jest",
+      "request": "launch",
+      "type": "node"
+    }
+  ],
+  "inputs": [
+    {
+      "description": "Select package workspace to run tests in",
+      "id": "workspace",
+      "options": [
+        "lambdas/api-handler",
+        "lambdas/authorizer",
+        "internal/datastore"
+      ],
+      "type": "pickString"
+    },
+    {
+      "description": "Enter test name regex for --testNamePattern",
+      "id": "testName",
+      "type": "promptString"
+    }
+  ],
+  "version": "0.0.1"
+}

infrastructure/terraform/components/api/README.md

@@ -32,12 +32,12 @@ No requirements.
 | Name | Source | Version |
 |------|--------|---------|
 | <a name="module_authorizer_lambda"></a> [authorizer\_lambda](#module\_authorizer\_lambda) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-lambda.zip | n/a |
-| <a name="module_domain_truststore"></a> [domain\_truststore](#module\_domain\_truststore) | git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/s3bucket | v2.0.17 |
+| <a name="module_domain_truststore"></a> [domain\_truststore](#module\_domain\_truststore) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-s3bucket.zip | n/a |
 | <a name="module_get_letters"></a> [get\_letters](#module\_get\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-lambda.zip | n/a |
 | <a name="module_kms"></a> [kms](#module\_kms) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-kms.zip | n/a |
-| <a name="module_logging_bucket"></a> [logging\_bucket](#module\_logging\_bucket) | git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/s3bucket | v2.0.17 |
+| <a name="module_logging_bucket"></a> [logging\_bucket](#module\_logging\_bucket) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-s3bucket.zip | n/a |
 | <a name="module_patch_letters"></a> [patch\_letters](#module\_patch\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-lambda.zip | n/a |
-| <a name="module_supplier_ssl"></a> [supplier\_ssl](#module\_supplier\_ssl) | git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/ssl | v2.0.17 |
+| <a name="module_supplier_ssl"></a> [supplier\_ssl](#module\_supplier\_ssl) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-ssl.zip | n/a |
 ## Outputs
 
 | Name | Description |

infrastructure/terraform/components/api/locals.tf

@@ -13,4 +13,11 @@ locals {
   })
 
   destination_arn = "arn:aws:logs:${var.region}:${var.shared_infra_account_id}:destination:nhs-main-obs-firehose-logs"
+
+  common_db_access_lambda_env_vars = {
+    LETTERS_TABLE_NAME = aws_dynamodb_table.letters.name,
+    LETTER_TTL_HOURS = 24,
+    SUPPLIER_ID_HEADER = "nhsd-supplier-id"
+    SUPPLIER_ID_HEADER = "nhsd-correlation-id"
+  }
 }

infrastructure/terraform/components/api/module_domain_truststore.tf

@@ -1,5 +1,5 @@
 module "domain_truststore" {
-  source = "git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/s3bucket?ref=v2.0.17"
+  source = "https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-s3bucket.zip"
 
   name           = "truststore"
   aws_account_id = var.aws_account_id

infrastructure/terraform/components/api/module_lambda_get_letters.tf

@@ -35,11 +35,9 @@ module "get_letters" {
   log_destination_arn       = local.destination_arn
   log_subscription_role_arn = local.acct.log_subscription_role_arn
 
-  lambda_env_vars = {
-    LETTERS_TABLE_NAME = aws_dynamodb_table.letters.name,
-    LETTER_TTL_HOURS   = var.letter_table_ttl_hours,
-    MAX_LIMIT          = var.max_get_limit,
-  }
+  lambda_env_vars = merge(local.common_db_access_lambda_env_vars, {
+    MAX_LIMIT = var.max_get_limit
+  })
 }
 
 data "aws_iam_policy_document" "get_letters_lambda" {

infrastructure/terraform/components/api/module_lambda_patch_letters.tf

@@ -35,10 +35,7 @@ module "patch_letters" {
   log_destination_arn       = local.destination_arn
   log_subscription_role_arn = local.acct.log_subscription_role_arn
 
-  lambda_env_vars = {
-    LETTERS_TABLE_NAME = aws_dynamodb_table.letters.name,
-    LETTER_TTL_HOURS   = 24
-  }
+  lambda_env_vars = merge(local.common_db_access_lambda_env_vars, {})
 }
 
 data "aws_iam_policy_document" "patch_letters_lambda" {

infrastructure/terraform/components/api/module_logging_bucket.tf

@@ -1,5 +1,5 @@
 module "logging_bucket" {
-  source = "git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/s3bucket?ref=v2.0.17"
+  source = "https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-s3bucket.zip"
 
   name           = "bucket-logs"
   aws_account_id = var.aws_account_id

infrastructure/terraform/components/api/module_supplier_ssl.tf

@@ -1,7 +1,7 @@
 module "supplier_ssl" {
   count = var.manually_configure_mtls_truststore ? 0 : 1
 
-  source = "git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/ssl?ref=v2.0.17"
+  source = "https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-ssl.zip"
 
   name                = "sapi_trust"
   aws_account_id      = var.aws_account_id

infrastructure/terraform/components/api/resources/spec.tmpl.json

@@ -67,154 +67,29 @@
       ],
       "patch": {
         "description": "Update the status of a letter by providing the new status in the request body.",
+        "operationId": "patchLetters",
         "requestBody": {
-          "content": {
-            "application/vnd.api+json": {
-              "schema": {
-                "properties": {
-                  "data": {
-                    "properties": {
-                      "attributes": {
-                        "properties": {
-                          "reasonCode": {
-                            "description": "Reason code for the given status",
-                            "type": "number"
-                          },
-                          "reasonText": {
-                            "description": "Reason text for the given status",
-                            "type": "string"
-                          },
-                          "requestedProductionStatus": {
-                            "description": "The requested production status for this letter.\nMay only be set by NHS Notify.",
-                            "enum": [
-                              "ACTIVE",
-                              "HOLD",
-                              "CANCEL"
-                            ],
-                            "title": "ProductionStatus",
-                            "type": "string"
-                          },
-                          "status": {
-                            "default": "PENDING",
-                            "description": "The supplier status of an individual letter",
-                            "enum": [
-                              "PENDING",
-                              "ACCEPTED",
-                              "REJECTED",
-                              "PRINTED",
-                              "ENCLOSED",
-                              "CANCELLED",
-                              "DISPATCHED",
-                              "FAILED",
-                              "RETURNED",
-                              "DESTROYED",
-                              "FORWARDED"
-                            ],
-                            "type": "string"
-                          }
-                        },
-                        "type": "object"
-                      },
-                      "id": {
-                        "type": "string"
-                      },
-                      "type": {
-                        "const": "Letter",
-                        "type": "string"
-                      }
-                    },
-                    "type": "object"
-                  }
-                },
-                "type": "object"
-              }
-            }
-          },
           "required": true
         },
         "responses": {
           "200": {
-            "content": {
-              "application/vnd.api+json": {
-                "schema": {
-                  "properties": {
-                    "data": {
-                      "properties": {
-                        "attributes": {
-                          "properties": {
-                            "reasonCode": {
-                              "description": "Reason code for the given status",
-                              "type": "number"
-                            },
-                            "reasonText": {
-                              "description": "Reason text for the given status",
-                              "type": "string"
-                            },
-                            "requestedProductionStatus": {
-                              "description": "A requested status for the production of a letter",
-                              "enum": [
-                                "ACTIVE",
-                                "HOLD",
-                                "CANCEL"
-                              ],
-                              "title": "ProductionStatus",
-                              "type": "string"
-                            },
-                            "status": {
-                              "default": "PENDING",
-                              "description": "The supplier status of an individual letter",
-                              "enum": [
-                                "PENDING",
-                                "ACCEPTED",
-                                "REJECTED",
-                                "PRINTED",
-                                "ENCLOSED",
-                                "CANCELLED",
-                                "DISPATCHED",
-                                "FAILED",
-                                "RETURNED",
-                                "DESTROYED",
-                                "FORWARDED"
-                              ],
-                              "type": "string"
-                            }
-                          },
-                          "required": [
-                            "status",
-                            "requestedProductionStatus"
-                          ],
-                          "type": "object"
-                        },
-                        "id": {
-                          "type": "string"
-                        },
-                        "type": {
-                          "const": "Letter",
-                          "type": "string"
-                        }
-                      },
-                      "type": "object"
-                    }
-                  },
-                  "type": "object"
-                }
-              }
-            },
-            "description": "Letter resource updated successfully"
+            "description": "List of letters to process"
           },
           "400": {
-            "description": "Bad request"
+            "description": "Bad request, invalid input data"
           },
           "404": {
             "description": "Resource not found"
+          },
+          "500": {
+            "description": "Server error"
           }
         },
         "security": [
           {
             "LambdaAuthorizer": []
           }
         ],
-        "summary": "Update the status of a letter",
         "x-amazon-apigateway-integration": {
           "contentHandling": "CONVERT_TO_TEXT",
           "credentials": "${APIG_EXECUTION_ROLE_ARN}",

internal/datastore/src/__test__/letter-repository.test.ts

@@ -50,21 +50,23 @@ describe('LetterRepository', () => {
     await db.container.stop();
   });
 
-  async function checkLetterExists(supplierId: string, letterId: string) {
-    const letter = await letterRepository.getLetterById(supplierId, letterId);
-    expect(letter).toBeDefined();
-    expect(letter.id).toBe(letterId);
-    expect(letter.supplierId).toBe(supplierId);
-  }
-
   async function checkLetterStatus(supplierId: string, letterId: string, status: Letter['status']) {
     const letter = await letterRepository.getLetterById(supplierId, letterId);
     expect(letter.status).toBe(status);
   }
 
   test('adds a letter to the database', async () => {
-    await letterRepository.putLetter(createLetter('supplier1', 'letter1'));
-    await checkLetterExists('supplier1', 'letter1');
+    const supplierId = 'supplier1';
+    const letterId = 'letter1';
+
+    await letterRepository.putLetter(createLetter(supplierId, letterId));
+
+    const letter = await letterRepository.getLetterById(supplierId, letterId);
+    expect(letter).toBeDefined();
+    expect(letter.id).toBe(letterId);
+    expect(letter.supplierId).toBe(supplierId);
+    expect(letter.reasonCode).toBeUndefined();
+    expect(letter.reasonText).toBeUndefined();
   });
 
   test('fetches a letter by id', async () => {
@@ -100,11 +102,16 @@ describe('LetterRepository', () => {
   });
 
   test('updates a letter\'s status in the database', async () => {
-    await letterRepository.putLetter(createLetter('supplier1', 'letter1', 'PENDING'));
+    const letter = createLetter('supplier1', 'letter1', 'PENDING');
+    await letterRepository.putLetter(letter);
     await checkLetterStatus('supplier1', 'letter1', 'PENDING');
 
-    await letterRepository.updateLetterStatus('supplier1', 'letter1', 'DELIVERED');
-    await checkLetterStatus('supplier1', 'letter1', 'DELIVERED');
+    await letterRepository.updateLetterStatus('supplier1', 'letter1', 'REJECTED', 1, "Reason text");
+
+    const updatedLetter = await letterRepository.getLetterById('supplier1', 'letter1');
+    expect(updatedLetter.status).toBe('REJECTED');
+    expect(updatedLetter.reasonCode).toBe(1);
+    expect(updatedLetter.reasonText).toBe('Reason text');
   });
 
   test('updates a letter\'s updatedAt date', async () => {
@@ -117,13 +124,13 @@ describe('LetterRepository', () => {
     // Month is zero-indexed in JavaScript Date
     // Day is one-indexed
     jest.setSystemTime(new Date(2020, 1, 2));
-    await letterRepository.updateLetterStatus('supplier1', 'letter1', 'DELIVERED');
+    await letterRepository.updateLetterStatus('supplier1', 'letter1', 'DELIVERED', undefined, undefined);
     const updatedLetter = await letterRepository.getLetterById('supplier1', 'letter1');
     expect(updatedLetter.updatedAt).toBe('2020-02-02T00:00:00.000Z');
   });
 
   test('can\'t update a letter that does not exist', async () => {
-    await expect(letterRepository.updateLetterStatus('supplier1', 'letter1', 'DELIVERED'))
+    await expect(letterRepository.updateLetterStatus('supplier1', 'letter1', 'DELIVERED', undefined, undefined))
       .rejects.toThrow('Letter with id letter1 not found for supplier supplier1');
   });
 
@@ -132,7 +139,7 @@ describe('LetterRepository', () => {
       ...db.config,
       lettersTableName: 'nonexistent-table'
     });
-    await expect(misconfiguredRepository.updateLetterStatus('supplier1', 'letter1', 'DELIVERED'))
+    await expect(misconfiguredRepository.updateLetterStatus('supplier1', 'letter1', 'DELIVERED', undefined, undefined))
       .rejects.toThrow('Cannot do operations on a non-existent table');
   });
 
@@ -157,7 +164,7 @@ describe('LetterRepository', () => {
     const pendingLetters = await letterRepository.getLettersByStatus('supplier1', 'PENDING');
     expect(pendingLetters.letters).toHaveLength(2);
 
-    await letterRepository.updateLetterStatus('supplier1', 'letter1', 'DELIVERED');
+    await letterRepository.updateLetterStatus('supplier1', 'letter1', 'DELIVERED', undefined, undefined);
     const remainingLetters = await letterRepository.getLettersByStatus('supplier1', 'PENDING');
     expect(remainingLetters.letters).toHaveLength(1);
     expect(remainingLetters.letters[0].id).toBe('letter2');