CCM-12185: Add new endpoint to get mi information (#522)

Author: RossFaulds171

.env.template

@@ -36,7 +36,9 @@ TARGET_ENVIRONMENT=prxx
 export NON_PROD_API_KEY=xxx
 export NON_PROD_SECONDARY_API_KEY=xxx
 export INTEGRATION_API_KEY=xxx
+export INTEGRATION_SECONDARY_API_KEY=xxx
 export PRODUCTION_API_KEY=xxx
+export PRODUCTION_SECONDARY_API_KEY=xxx
 
 # Status Endpoint API Key
 # In order to find the value of the status endpoint API key, follow these steps:

.github/actions/acceptance-tests-e2e/action.yml

@@ -78,9 +78,12 @@ runs:
         if [[ -z "$PR_NUMBER" ]]; then
           export PROXY_NAME="${BASE_PROXY_NAME}"
           export NON_PROD_API_KEY="${DEV_E2E_KEYS_APIM_MAIN}"
+          export NON_PROD_SECONDARY_API_KEY="${DEV_E2E_KEYS_APIM_MAIN_SECONDARY}"
         else
           export PROXY_NAME="${BASE_PROXY_NAME}-PR-${PR_NUMBER}"
           export NON_PROD_API_KEY="${DEV_E2E_KEYS_APIM_PR}"
+          export NON_PROD_SECONDARY_API_KEY="${DEV_E2E_KEYS_APIM_PR_SECONDARY}"
+
         fi
 
         export STATUS_ENDPOINT_API_KEY="${DEV_E2E_KEYS_APIM_STATUS}"

.github/workflows/stage-4-acceptance.yaml

@@ -81,4 +81,4 @@ jobs:
             --targetEnvironment "$ENVIRONMENT" \
             --targetAccountGroup "nhs-notify-supplier-api-dev" \
             --targetComponent "api" \
-            --extraSecretNames '["/dev/e2e/keys/apim/main","/dev/e2e/keys/apim/pr","/dev/e2e/keys/apim/status","/dev/e2e/keys/private"]'
+            --extraSecretNames '["/dev/e2e/keys/apim/main","/dev/e2e/keys/apim/pr","/dev/e2e/keys/apim/pr/secondary","/dev/e2e/keys/apim/status","/dev/e2e/keys/private"]'

infrastructure/terraform/components/api/README.md

@@ -72,6 +72,7 @@ No requirements.
 | <a name="module_get_letter"></a> [get\_letter](#module\_get\_letter) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/4.0.2/terraform-lambda.zip | n/a |
 | <a name="module_get_letter_data"></a> [get\_letter\_data](#module\_get\_letter\_data) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/4.0.2/terraform-lambda.zip | n/a |
 | <a name="module_get_letters"></a> [get\_letters](#module\_get\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/4.0.2/terraform-lambda.zip | n/a |
+| <a name="module_get_mi"></a> [get\_mi](#module\_get\_mi) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
 | <a name="module_get_status"></a> [get\_status](#module\_get\_status) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/4.0.2/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.26/terraform-kms.zip | n/a |
 | <a name="module_lambda_alarms"></a> [lambda\_alarms](#module\_lambda\_alarms) | ../../modules/alarms-lambda | n/a |

infrastructure/terraform/components/api/iam_role_api_gateway_execution_role.tf

@@ -52,6 +52,7 @@ data "aws_iam_policy_document" "api_gateway_execution_policy" {
       module.get_letter.function_arn,
       module.get_letter_data.function_arn,
       module.get_letters.function_arn,
+      module.get_mi.function_arn,
       module.patch_letter.function_arn,
       module.post_letters.function_arn,
       module.get_status.function_arn,

infrastructure/terraform/components/api/locals.tf

@@ -17,6 +17,7 @@ locals {
     PATCH_LETTER_LAMBDA_ARN    = module.patch_letter.function_arn
     POST_LETTERS_LAMBDA_ARN    = module.post_letters.function_arn
     POST_MI_LAMBDA_ARN         = module.post_mi.function_arn
+    GET_MI_LAMBDA_ARN          = module.get_mi.function_arn
   })
 
   destination_arn = "arn:aws:logs:${var.region}:${var.shared_infra_account_id}:destination:nhs-main-obs-firehose-logs"

infrastructure/terraform/components/api/locals_alarms.tf

@@ -11,6 +11,7 @@ locals {
     get_letter                  = module.get_letter.function_name
     get_letters                 = module.get_letters.function_name
     get_letter_data             = module.get_letter_data.function_name
+    get_mi                      = module.get_mi.function_name
     get_status                  = module.get_status.function_name
     patch_letter                = module.patch_letter.function_name
     post_letters                = module.post_letters.function_name

infrastructure/terraform/components/api/module_lambda_get_mi.tf

@@ -0,0 +1,68 @@
+module "get_mi" {
+  source = "https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip"
+
+  function_name = "get_mi"
+  description   = "Retrieve 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.get_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   = "getMI"
+  runtime                 = "nodejs22.x"
+  memory                  = 512
+  timeout                 = 29
+  log_level               = var.log_level
+
+  force_lambda_code_deploy = var.force_lambda_code_deploy
+  enable_lambda_insights   = false
+
+  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" "get_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:GetItem",
+      "dynamodb:Query"
+    ]
+
+    resources = [
+      aws_dynamodb_table.mi.arn,
+    ]
+  }
+}

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

@@ -306,6 +306,56 @@
           "uri": "arn:aws:apigateway:${AWS_REGION}:lambda:path/2015-03-31/functions/${POST_MI_LAMBDA_ARN}/invocations"
         }
       }
+    },
+    "/mi/{id}": {
+      "get": {
+        "description": "Returns 200 OK with management information.",
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "400": {
+            "description": "Bad request, invalid input data"
+          },
+          "404": {
+            "description": "Resource not found"
+          },
+          "500": {
+            "description": "Server error"
+          }
+        },
+        "security": [
+          {
+            "LambdaAuthorizer": []
+          }
+        ],
+        "summary": "Get MI",
+        "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/${GET_MI_LAMBDA_ARN}/invocations"
+        }
+      },
+      "parameters": [
+        {
+          "description": "Unique identifier of this resource",
+          "in": "path",
+          "name": "id",
+          "required": true,
+          "schema": {
+            "type": "string"
+          }
+        }
+      ]
     }
   },
   "x-amazon-apigateway-endpoint-access-mode": "${ENDPOINT_ACCESS_MODE}",

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

@@ -64,4 +64,44 @@ describe("MiRepository", () => {
       );
     });
   });
+
+  describe("getMi", () => {
+    it("throws an error when fetching MI information that does not exist", async () => {
+      await expect(miRepository.getMI("XXX", "supplier1")).rejects.toThrow(
+        "Management information not found: supplierId=supplier1, miId=XXX",
+      );
+    });
+
+    it("creates MI with id and timestamps", async () => {
+      jest.useFakeTimers();
+      // Month is zero-indexed in JS Date
+      jest.setSystemTime(new Date(2020, 1, 1));
+      const mi = {
+        specificationId: "spec1",
+        supplierId: "supplier1",
+        groupId: "group1",
+        lineItem: "item1",
+        quantity: 12,
+        timestamp: new Date().toISOString(),
+        stockRemaining: 0,
+      };
+
+      const persistedMi = await miRepository.putMI(mi);
+
+      const fetchedMi = await miRepository.getMI(
+        persistedMi.id,
+        persistedMi.supplierId,
+      );
+
+      expect(fetchedMi).toEqual(
+        expect.objectContaining({
+          id: expect.any(String),
+          createdAt: "2020-02-01T00:00:00.000Z",
+          updatedAt: "2020-02-01T00:00:00.000Z",
+          ttl: 1_580_518_800, // 2020-02-01T00:01:00.000Z, seconds since epoch
+          ...mi,
+        }),
+      );
+    });
+  });
 });