CCM-11189 Lambda to POST management information

Author: stevebux

.tool-versions

@@ -3,7 +3,7 @@ gitleaks 8.24.0
 jq 1.6
 nodejs 22.15.0
 pre-commit 3.6.0
-python 3.12.11
+python 3.13.2
 terraform 1.10.1
 terraform-docs 0.19.0
 trivy 0.61.0

infrastructure/terraform/components/api/README.md

@@ -39,6 +39,7 @@ No requirements.
 | <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) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-s3bucket.zip | n/a |
 | <a name="module_patch_letter"></a> [patch\_letter](#module\_patch\_letter) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-lambda.zip | n/a |
+| <a name="module_post_mi"></a> [post\_mi](#module\_post\_mi) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-lambda.zip | n/a |
 | <a name="module_s3bucket_test_letters"></a> [s3bucket\_test\_letters](#module\_s3bucket\_test\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-s3bucket.zip | n/a |
 | <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

infrastructure/terraform/components/api/iam_role_api_gateway_execution_role.tf

@@ -51,7 +51,8 @@ data "aws_iam_policy_document" "api_gateway_execution_policy" {
       module.authorizer_lambda.function_arn,
       module.get_letters.function_arn,
       module.patch_letter.function_arn,
-      module.get_letter_data.function_arn
+      module.get_letter_data.function_arn,
+      module.post_mi.function_arn
     ]
   }
 }

infrastructure/terraform/components/api/locals.tf

@@ -11,12 +11,14 @@ locals {
     GET_LETTERS_LAMBDA_ARN  = module.get_letters.function_arn
     GET_LETTER_DATA_LAMBDA_ARN  = module.get_letter_data.function_arn
     PATCH_LETTER_LAMBDA_ARN  = module.patch_letter.function_arn
+    POST_MI_LAMBDA_ARN       = module.post_mi.function_arn
   })
 
   destination_arn = "arn:aws:logs:${var.region}:${var.shared_infra_account_id}:destination:nhs-main-obs-firehose-logs"
 
   common_lambda_env_vars = {
     LETTERS_TABLE_NAME = aws_dynamodb_table.letters.name,
+    MI_TABLE_NAME = aws_dynamodb_table.mi.name,
     LETTER_TTL_HOURS = 24,
     SUPPLIER_ID_HEADER = "nhsd-supplier-id",
     APIM_CORRELATION_HEADER = "nhsd-correlation-id",

infrastructure/terraform/components/api/module_lambda_post_mi.tf

@@ -0,0 +1,68 @@
+module "post_mi" {
+  source = "https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-lambda.zip"
+
+  function_name = "post_mi"
+  description   = "Add management information"
+
+  aws_account_id = var.aws_account_id
+  component      = var.component
+  environment    = var.environment
+  project        = var.project
+  region         = var.region
+  group          = var.group
+
+  log_retention_in_days = var.log_retention_in_days
+  kms_key_arn           = module.kms.key_arn
+
+  iam_policy_document = {
+    body = data.aws_iam_policy_document.post_mi_lambda.json
+  }
+
+  function_s3_bucket      = local.acct.s3_buckets["lambda_function_artefacts"]["id"]
+  function_code_base_path = local.aws_lambda_functions_dir_path
+  function_code_dir       = "api-handler/dist"
+  function_include_common = true
+  handler_function_name   = "postMi"
+  runtime                 = "nodejs22.x"
+  memory                  = 128
+  timeout                 = 5
+  log_level               = var.log_level
+
+  force_lambda_code_deploy = var.force_lambda_code_deploy
+  enable_lambda_insights   = false
+
+  send_to_firehose          = true
+  log_destination_arn       = local.destination_arn
+  log_subscription_role_arn = local.acct.log_subscription_role_arn
+
+  lambda_env_vars = merge(local.common_lambda_env_vars, {})
+}
+
+data "aws_iam_policy_document" "post_mi_lambda" {
+  statement {
+    sid    = "KMSPermissions"
+    effect = "Allow"
+
+    actions = [
+      "kms:Decrypt",
+      "kms:GenerateDataKey",
+    ]
+
+    resources = [
+      module.kms.key_arn, ## Requires shared kms module
+    ]
+  }
+
+  statement {
+    sid    = "AllowDynamoDBAccess"
+    effect = "Allow"
+
+    actions = [
+      "dynamodb:PutItem",
+    ]
+
+    resources = [
+      aws_dynamodb_table.mi.arn,
+    ]
+  }
+}

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

@@ -165,6 +165,45 @@
           }
         }
       ]
+    },
+    "/mi": {
+      "post": {
+        "description": "Provide management information.",
+        "operationId": "postMi",
+        "requestBody": {
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Resource created"
+          },
+          "400": {
+            "description": "Bad request, invalid input data"
+          },
+          "500": {
+            "description": "Server error"
+          }
+        },
+        "security": [
+          {
+            "LambdaAuthorizer": []
+          }
+        ],
+        "x-amazon-apigateway-integration": {
+          "contentHandling": "CONVERT_TO_TEXT",
+          "credentials": "${APIG_EXECUTION_ROLE_ARN}",
+          "httpMethod": "POST",
+          "passthroughBehavior": "WHEN_NO_TEMPLATES",
+          "responses": {
+            ".*": {
+              "statusCode": "200"
+            }
+          },
+          "timeoutInMillis": 29000,
+          "type": "AWS_PROXY",
+          "uri": "arn:aws:apigateway:${AWS_REGION}:lambda:path/2015-03-31/functions/${POST_MI_LAMBDA_ARN}/invocations"
+        }
+      }
     }
   }
 }

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

@@ -1,9 +1,12 @@
 import { Logger } from "pino";
-import { LetterRepository } from "../letter-repository";
 import { setupDynamoDBContainer, createTables, DBContext, deleteTables } from "./db";
 import { createTestLogger, LogStream } from "./logs";
 import { MIRepository } from "../mi-repository";
 
+// Database tests can take longer, especially with setup and teardown
+jest.setTimeout(30000);
+
+
 describe('MiRepository', () => {
   let db: DBContext;
   let miRepository: MIRepository;
@@ -46,6 +49,7 @@ describe('MiRepository', () => {
         groupId:'group1',
         lineItem: 'item1',
         quantity: 12,
+        timestamp: new Date().toISOString(),
         stockRemaining: 0
       };
 

internal/datastore/src/index.ts

@@ -1,3 +1,4 @@
 export * from './types';
+export * from './mi-repository';
 export * from './letter-repository';
 export * from './types';

internal/datastore/src/mi-repository.ts

@@ -17,6 +17,7 @@ export class MIRepository {
   }
 
   async putMI(mi: Omit<MI, 'id' | 'createdAt' | 'updatedAt'>): Promise<MI> {
+
     const now = new Date().toISOString();
     const miDb = {
       ...mi,

internal/datastore/src/types.ts

@@ -48,11 +48,12 @@ export type LetterBase = z.infer<typeof LetterSchemaBase>;
 
 export const MISchemaBase = z.object({
   id: z.string(),
-  specificationId: z.string(),
-  groupId: z.string(),
   lineItem: z.string(),
+  timestamp: z.string(),
   quantity: z.number(),
-  stockRemaining: z.number()
+  specificationId: z.string().optional(),
+  groupId: z.string().optional(),
+  stockRemaining: z.number().optional()
 });
 
 export const MISchema = MISchemaBase.extend({