adding config service

Author: alexnuttall

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

@@ -39,6 +39,7 @@ locals {
   }
 
   backend_lambda_environment_variables = {
+    CSI                              = local.csi
     DEFAULT_LETTER_SUPPLIER          = local.default_letter_supplier_name
     ENVIRONMENT                      = var.environment
     NODE_OPTIONS                     = "--enable-source-maps"

lambdas/backend-api/package.json

@@ -4,6 +4,7 @@
     "@aws-sdk/client-dynamodb": "3.775.0",
     "@aws-sdk/client-s3": "3.775.0",
     "@aws-sdk/client-sqs": "3.775.0",
+    "@aws-sdk/client-ssm": "3.775.0",
     "@aws-sdk/lib-dynamodb": "3.775.0",
     "@aws-sdk/util-dynamodb": "3.775.0",
     "csv-parse": "^5.6.0",

lambdas/backend-api/src/templates/api/create-letter.ts

@@ -1,16 +1,16 @@
 import type { APIGatewayProxyHandler } from 'aws-lambda';
 import { apiFailure, apiSuccess } from './responses';
-import {
-  ClientConfiguration,
-  type CreateUpdateTemplate,
-} from 'nhs-notify-backend-client';
+import { type CreateUpdateTemplate } from 'nhs-notify-backend-client';
 import { getLetterUploadParts } from '../app/get-letter-upload-parts';
 import { TemplateClient } from '../app/template-client';
+import { ClientConfigurationService } from '../app/client-configuration-service';
 
 export function createHandler({
   templateClient,
+  clientConfigurationService,
 }: {
   templateClient: TemplateClient;
+  clientConfigurationService: ClientConfigurationService;
 }): APIGatewayProxyHandler {
   return async function (event) {
     const { user: userId, clientId } = event.requestContext.authorizer ?? {};
@@ -31,7 +31,8 @@ export function createHandler({
       return apiFailure(400, getLetterPartsError.message);
     }
 
-    const client = await ClientConfiguration.fetch(authorizationToken);
+    const clientConfiguration =
+      await clientConfigurationService.fetch(clientId);
 
     const { template, pdf, csv } = letterParts;
 
@@ -41,7 +42,7 @@ export function createHandler({
         { userId, clientId },
         pdf,
         csv,
-        client?.campaignId
+        clientConfiguration?.campaignId
       );
 
     if (createTemplateError) {

lambdas/backend-api/src/templates/app/client-configuration-service.ts

@@ -0,0 +1,14 @@
+import { ClientConfigurationRepository } from '../infra/client-configuration-repository';
+import { $ClientConfiguration } from 'nhs-notify-backend-client/src/schemas/client-configuration';
+
+export class ClientConfigurationService {
+  constructor(
+    private readonly clientConfigurationRepository: ClientConfigurationRepository
+  ) {}
+
+  async fetch(clientId: string) {
+    return $ClientConfiguration.parse(
+      this.clientConfigurationRepository.get(clientId)
+    );
+  }
+}

lambdas/backend-api/src/templates/container.ts

@@ -8,6 +8,9 @@ import { ProofingQueue } from './infra/proofing-queue';
 import { SQSClient } from '@aws-sdk/client-sqs';
 import { loadConfig } from './infra/config';
 import { logger } from 'nhs-notify-web-template-management-utils/logger';
+import { ClientConfigurationRepository } from './infra/client-configuration-repository';
+import { SSMClient } from '@aws-sdk/client-ssm';
+import { ClientConfigurationService } from './app/client-configuration-service';
 
 const sqsClient = new SQSClient({ region: 'eu-west-2' });
 
@@ -33,11 +36,20 @@ export function createContainer() {
     config.downloadBucket
   );
 
+  const clientConfigurationRepository = new ClientConfigurationRepository(
+    new SSMClient({ region: 'eu-west-2' }),
+    config.csi
+  );
+
   const proofingQueue = new ProofingQueue(
     sqsClient,
     config.requestProofQueueUrl
   );
 
+  const clientConfigurationService = new ClientConfigurationService(
+    clientConfigurationRepository
+  );
+
   const templateClient = new TemplateClient(
     templateRepository,
     letterUploadRepository,
@@ -47,9 +59,10 @@ export function createContainer() {
   );
 
   return {
+    clientConfigurationService,
+    letterUploadRepository,
     templateClient,
     templateRepository,
-    letterUploadRepository,
   };
 }
 

lambdas/backend-api/src/templates/infra/client-configuration-repository.ts

@@ -0,0 +1,14 @@
+import { GetParameterCommand, SSMClient } from '@aws-sdk/client-ssm';
+
+export class ClientConfigurationRepository {
+  constructor(
+    private readonly ssm: SSMClient,
+    private readonly csi: string
+  ) {}
+
+  async get(clientId: string) {
+    return await this.ssm.send(
+      new GetParameterCommand({ Name: `/${this.csi}/clients/${clientId}` })
+    );
+  }
+}

lambdas/backend-api/src/templates/infra/config.ts

@@ -1,6 +1,7 @@
 import z from 'zod';
 
 const $Env = z.object({
+  CSI: z.string(),
   DEFAULT_LETTER_SUPPLIER: z.string(),
   ENABLE_PROOFING: z.enum(['true', 'false']).default('false'),
   ENVIRONMENT: z.string(),
@@ -15,6 +16,7 @@ export function loadConfig() {
   const env = $Env.parse(process.env);
 
   return {
+    csi: env.CSI,
     defaultLetterSupplier: env.DEFAULT_LETTER_SUPPLIER,
     enableProofing: env.ENABLE_PROOFING === 'true',
     environment: env.ENVIRONMENT,

lambdas/backend-client/src/client-configuration-client.ts

@@ -1,39 +1,43 @@
-import type {
-  Features,
-  IClientConfiguration,
-} from './types/client-configuration';
+import type { ClientConfiguration } from './types/client-configuration';
 import { $ClientConfiguration } from './schemas/client-configuration';
+import { catchAxiosError, createAxiosClient } from './axios-client';
+import { Result } from './types/result';
 
-export class ClientConfiguration implements IClientConfiguration {
-  private constructor(
-    public readonly features: Readonly<Features>,
-    public readonly campaignId?: string
-  ) {}
-
-  featureEnabled(feature: keyof Features) {
-    return this.features[feature] === true;
-  }
+export class ClientConfigurationApiService {
+  constructor(public readonly client = createAxiosClient()) {}
 
   /**
    * Gets and validates client configuration via AWS API gateway
    * @param {string} token user's JWT to authenticate against API gateway
    * @returns {Promise<ClientConfiguration>} client configuration.
    */
-  static async fetch(token: string): Promise<ClientConfiguration | undefined> {
-    const client = await ClientConfiguration._fetch(token);
+  async fetch(token: string): Promise<Result<ClientConfiguration>> {
+    const client = await this._fetch(token);
 
-    return new ClientConfiguration(client.features, client.campaignId);
+    return client;
   }
 
-  // Note: Temporary until we have some sort of API.
-  private static async _fetch(_: string): Promise<IClientConfiguration> {
-    return $ClientConfiguration.parse({
-      clientId: 'example-clientId',
-      campaignId: 'example-campaignId',
-      name: 'example-name',
-      features: {
-        proofing: true,
-      },
-    });
+  private async _fetch(token: string): Promise<Result<ClientConfiguration>> {
+    const response = await catchAxiosError(
+      this.client.get<{
+        statusCode: number;
+        clientConfiguration: ClientConfiguration;
+      }>('/v1/client-configuration', {
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: token,
+        },
+      })
+    );
+
+    if (response.error) {
+      return {
+        error: response.error,
+      };
+    }
+
+    return {
+      data: $ClientConfiguration.parse(response.data.clientConfiguration),
+    };
   }
 }

lambdas/backend-client/src/types/client-configuration.ts

@@ -2,7 +2,7 @@ export type Features = {
   proofing: boolean;
 };
 
-export interface IClientConfiguration {
+export type ClientConfiguration = {
   campaignId?: string;
   features: Features;
-}
+};