CCM-12222: list routing configs api endpoint (#710)

Author: harrim91

infrastructure/terraform/modules/backend-api/README.md

@@ -51,6 +51,7 @@ No requirements.
 | <a name="module_lambda_sftp_poll"></a> [lambda\_sftp\_poll](#module\_lambda\_sftp\_poll) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip | n/a |
 | <a name="module_lambda_sftp_request_proof"></a> [lambda\_sftp\_request\_proof](#module\_lambda\_sftp\_request\_proof) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip | n/a |
 | <a name="module_lambda_validate_letter_template_files"></a> [lambda\_validate\_letter\_template\_files](#module\_lambda\_validate\_letter\_template\_files) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip | n/a |
+| <a name="module_list_routing_configs_lambda"></a> [list\_routing\_configs\_lambda](#module\_list\_routing\_configs\_lambda) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip | n/a |
 | <a name="module_list_template_lambda"></a> [list\_template\_lambda](#module\_list\_template\_lambda) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip | n/a |
 | <a name="module_request_proof_lambda"></a> [request\_proof\_lambda](#module\_request\_proof\_lambda) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip | n/a |
 | <a name="module_s3bucket_download"></a> [s3bucket\_download](#module\_s3bucket\_download) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-s3bucket.zip | n/a |

infrastructure/terraform/modules/backend-api/iam_role_api_gateway_execution_role.tf

@@ -53,8 +53,9 @@ data "aws_iam_policy_document" "api_gateway_execution_policy" {
       module.create_template_lambda.function_arn,
       module.delete_template_lambda.function_arn,
       module.get_client_lambda.function_arn,
-      module.get_template_lambda.function_arn,
       module.get_routing_config_lambda.function_arn,
+      module.get_template_lambda.function_arn,
+      module.list_routing_configs_lambda.function_arn,
       module.list_template_lambda.function_arn,
       module.request_proof_lambda.function_arn,
       module.submit_template_lambda.function_arn,

infrastructure/terraform/modules/backend-api/locals.tf

@@ -11,19 +11,20 @@ locals {
   client_ssm_path_pattern = "arn:aws:ssm:${var.region}:${var.aws_account_id}:parameter${local.client_ssm_path_prefix}/*"
 
   openapi_spec = templatefile("${path.module}/spec.tmpl.json", {
-    APIG_EXECUTION_ROLE_ARN       = aws_iam_role.api_gateway_execution_role.arn
-    AUTHORIZER_LAMBDA_ARN         = module.authorizer_lambda.function_arn
-    AWS_REGION                    = var.region
-    CREATE_LAMBDA_ARN             = module.create_template_lambda.function_arn
-    DELETE_LAMBDA_ARN             = module.delete_template_lambda.function_arn
-    GET_CLIENT_LAMBDA_ARN         = module.get_client_lambda.function_arn
-    GET_LAMBDA_ARN                = module.get_template_lambda.function_arn
-    GET_ROUTING_CONFIG_LAMBDA_ARN = module.get_routing_config_lambda.function_arn
-    LIST_LAMBDA_ARN               = module.list_template_lambda.function_arn
-    REQUEST_PROOF_LAMBDA_ARN      = module.request_proof_lambda.function_arn
-    SUBMIT_LAMBDA_ARN             = module.submit_template_lambda.function_arn
-    UPDATE_LAMBDA_ARN             = module.update_template_lambda.function_arn
-    UPLOAD_LETTER_LAMBDA_ARN      = module.upload_letter_template_lambda.function_arn
+    APIG_EXECUTION_ROLE_ARN         = aws_iam_role.api_gateway_execution_role.arn
+    AUTHORIZER_LAMBDA_ARN           = module.authorizer_lambda.function_arn
+    AWS_REGION                      = var.region
+    CREATE_LAMBDA_ARN               = module.create_template_lambda.function_arn
+    DELETE_LAMBDA_ARN               = module.delete_template_lambda.function_arn
+    GET_CLIENT_LAMBDA_ARN           = module.get_client_lambda.function_arn
+    GET_LAMBDA_ARN                  = module.get_template_lambda.function_arn
+    GET_ROUTING_CONFIG_LAMBDA_ARN   = module.get_routing_config_lambda.function_arn
+    LIST_LAMBDA_ARN                 = module.list_template_lambda.function_arn
+    LIST_ROUTING_CONFIGS_LAMBDA_ARN = module.list_routing_configs_lambda.function_arn
+    REQUEST_PROOF_LAMBDA_ARN        = module.request_proof_lambda.function_arn
+    SUBMIT_LAMBDA_ARN               = module.submit_template_lambda.function_arn
+    UPDATE_LAMBDA_ARN               = module.update_template_lambda.function_arn
+    UPLOAD_LETTER_LAMBDA_ARN        = module.upload_letter_template_lambda.function_arn
   })
 
   backend_lambda_environment_variables = {

infrastructure/terraform/modules/backend-api/module_list_routing_configs_lambda.tf

@@ -0,0 +1,68 @@
+module "list_routing_configs_lambda" {
+  source = "https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip"
+
+  project        = var.project
+  environment    = var.environment
+  component      = var.component
+  aws_account_id = var.aws_account_id
+  region         = var.region
+
+  kms_key_arn = var.kms_key_arn
+
+  function_name = "list-routing-configs"
+
+  function_module_name  = "list-routing-configs"
+  handler_function_name = "handler"
+  description           = "List Routing Configs API endpoint"
+
+  memory  = 512
+  timeout = 3
+  runtime = "nodejs20.x"
+
+  log_retention_in_days = var.log_retention_in_days
+
+  iam_policy_document = {
+    body = data.aws_iam_policy_document.list_routing_configs_lambda_policy.json
+  }
+
+  lambda_env_vars         = local.backend_lambda_environment_variables
+  function_s3_bucket      = var.function_s3_bucket
+  function_code_base_path = local.lambdas_dir
+  function_code_dir       = "backend-api/dist/list-routing-configs"
+
+  send_to_firehose          = var.send_to_firehose
+  log_destination_arn       = var.log_destination_arn
+  log_subscription_role_arn = var.log_subscription_role_arn
+}
+
+data "aws_iam_policy_document" "list_routing_configs_lambda_policy" {
+  statement {
+    sid    = "AllowDynamoAccess"
+    effect = "Allow"
+
+    actions = [
+      "dynamodb:Query",
+    ]
+
+    resources = [
+      aws_dynamodb_table.routing_configuration.arn,
+    ]
+  }
+
+  statement {
+    sid    = "AllowKMSAccess"
+    effect = "Allow"
+
+    actions = [
+      "kms:Decrypt",
+      "kms:DescribeKey",
+      "kms:Encrypt",
+      "kms:GenerateDataKey*",
+      "kms:ReEncrypt*",
+    ]
+
+    resources = [
+      var.kms_key_arn
+    ]
+  }
+}

infrastructure/terraform/modules/backend-api/spec.tmpl.json

@@ -636,9 +636,21 @@
         "type": "object"
       },
       "RoutingConfigStatus": {
+        "anyOf": [
+          {
+            "$ref": "#/components/schemas/RoutingConfigStatusActive"
+          },
+          {
+            "enum": [
+              "DELETED"
+            ],
+            "type": "string"
+          }
+        ]
+      },
+      "RoutingConfigStatusActive": {
         "enum": [
           "COMPLETED",
-          "DELETED",
           "DRAFT"
         ],
         "type": "string"
@@ -658,6 +670,24 @@
         ],
         "type": "object"
       },
+      "RoutingConfigSuccessList": {
+        "properties": {
+          "data": {
+            "items": {
+              "$ref": "#/components/schemas/RoutingConfig"
+            },
+            "type": "array"
+          },
+          "statusCode": {
+            "type": "integer"
+          }
+        },
+        "required": [
+          "data",
+          "statusCode"
+        ],
+        "type": "object"
+      },
       "SmsProperties": {
         "properties": {
           "message": {
@@ -1023,6 +1053,70 @@
         }
       }
     },
+    "/v1/routing-configurations": {
+      "get": {
+        "description": "List all routing configs",
+        "parameters": [
+          {
+            "description": "Filter by a single active status",
+            "in": "query",
+            "name": "status",
+            "schema": {
+              "$ref": "#/components/schemas/RoutingConfigStatusActive"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RoutingConfigSuccessList"
+                }
+              }
+            },
+            "description": "200 response",
+            "headers": {
+              "Content-Type": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "default": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Failure"
+                }
+              }
+            },
+            "description": "Error"
+          }
+        },
+        "security": [
+          {
+            "authorizer": []
+          }
+        ],
+        "summary": "List all routing configs",
+        "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/${LIST_ROUTING_CONFIGS_LAMBDA_ARN}/invocations"
+        }
+      }
+    },
     "/v1/template": {
       "post": {
         "description": "Create a template",

lambdas/backend-api/README.md

@@ -149,3 +149,11 @@ curl --location "${APIG_STAGE}/v1/routing-configuration/${ROUTING_CONFIG_ID}" \
 --header 'Accept: application/json' \
 --header "Authorization: $SANDBOX_TOKEN"
 ```
+
+### GET - /v1/routing-configurations - List routing configurations
+
+```bash
+curl --location "${APIG_STAGE}/v1/routing-configurations \
+--header 'Accept: application/json' \
+--header "Authorization: $SANDBOX_TOKEN"
+```

lambdas/backend-api/build.sh

@@ -23,6 +23,7 @@ npx esbuild \
     src/templates/get.ts \
     src/templates/get-routing-config.ts \
     src/templates/list.ts \
+    src/templates/list-routing-configs.ts \
     src/templates/process-proof.ts \
     src/templates/proof.ts \
     src/templates/set-letter-upload-virus-scan-status.ts \

lambdas/backend-api/src/__tests__/templates/api/list-routing-configs.test.ts

@@ -0,0 +1,131 @@
+import type { APIGatewayProxyEvent, Context } from 'aws-lambda';
+import { mock } from 'jest-mock-extended';
+import type { Logger } from 'nhs-notify-web-template-management-utils/logger';
+import { createHandler } from '@backend-api/templates/api/list-routing-configs';
+import { RoutingConfigClient } from '@backend-api/templates/app/routing-config-client';
+import { makeRoutingConfig } from '../fixtures/routing-config';
+
+jest.mock('nhs-notify-web-template-management-utils/logger', () => ({
+  logger: mock<Logger>({
+    child: jest.fn().mockReturnThis(),
+  }),
+}));
+
+const setup = () => {
+  const routingConfigClient = mock<RoutingConfigClient>();
+
+  const handler = createHandler({ routingConfigClient });
+
+  return { handler, mocks: { routingConfigClient } };
+};
+
+describe('ListRoutingConfig handler', () => {
+  test.each([
+    ['undefined', undefined],
+    ['missing user', { clientId: 'client-id', user: undefined }],
+    ['missing client', { clientId: undefined, user: 'user-id' }],
+  ])(
+    'should return 400 - Invalid request when requestContext is %s',
+    async (_, ctx) => {
+      const { handler, mocks } = setup();
+
+      const event = mock<APIGatewayProxyEvent>({
+        requestContext: { authorizer: ctx },
+      });
+
+      const result = await handler(event, mock<Context>(), jest.fn());
+
+      expect(result).toEqual({
+        statusCode: 400,
+        body: JSON.stringify({
+          statusCode: 400,
+          technicalMessage: 'Invalid request',
+        }),
+      });
+
+      expect(
+        mocks.routingConfigClient.listRoutingConfigs
+      ).not.toHaveBeenCalled();
+    }
+  );
+
+  test('should return error when listing routing configs fails', async () => {
+    const { handler, mocks } = setup();
+
+    mocks.routingConfigClient.listRoutingConfigs.mockResolvedValueOnce({
+      error: {
+        errorMeta: {
+          code: 500,
+          description: 'Internal server error',
+        },
+      },
+    });
+
+    const event = mock<APIGatewayProxyEvent>();
+    event.requestContext.authorizer = {
+      user: 'sub',
+      clientId: 'nhs-notify-client-id',
+    };
+
+    event.queryStringParameters = {
+      status: 'DRAFT',
+    };
+
+    const result = await handler(event, mock<Context>(), jest.fn());
+
+    expect(result).toEqual({
+      statusCode: 500,
+      body: JSON.stringify({
+        statusCode: 500,
+        technicalMessage: 'Internal server error',
+      }),
+    });
+
+    expect(mocks.routingConfigClient.listRoutingConfigs).toHaveBeenCalledWith(
+      'nhs-notify-client-id',
+      { status: 'DRAFT' }
+    );
+  });
+
+  test('should return list of routing configs', async () => {
+    const { handler, mocks } = setup();
+
+    const list = [
+      makeRoutingConfig({
+        owner: 'nhs-notify-client-id',
+        clientId: 'nhs-notify-client-id',
+        status: 'COMPLETED',
+      }),
+      makeRoutingConfig({
+        owner: 'nhs-notify-client-id',
+        clientId: 'nhs-notify-client-id',
+        status: 'COMPLETED',
+      }),
+    ];
+
+    mocks.routingConfigClient.listRoutingConfigs.mockResolvedValueOnce({
+      data: list,
+    });
+
+    const event = mock<APIGatewayProxyEvent>();
+    event.requestContext.authorizer = {
+      user: 'sub',
+      clientId: 'nhs-notify-client-id',
+    };
+    event.queryStringParameters = {
+      status: 'COMPLETED',
+    };
+
+    const result = await handler(event, mock<Context>(), jest.fn());
+
+    expect(result).toEqual({
+      statusCode: 200,
+      body: JSON.stringify({ statusCode: 200, data: list }),
+    });
+
+    expect(mocks.routingConfigClient.listRoutingConfigs).toHaveBeenCalledWith(
+      'nhs-notify-client-id',
+      { status: 'COMPLETED' }
+    );
+  });
+});