Add url ttl as config

Author: francisco-videira-nhs

infrastructure/terraform/components/api/locals.tf

@@ -18,7 +18,8 @@ locals {
   common_lambda_env_vars = {
     LETTERS_TABLE_NAME = aws_dynamodb_table.letters.name,
     LETTER_TTL_HOURS = 24,
-    SUPPLIER_ID_HEADER = "nhsd-supplier-id"
-    APIM_CORRELATION_HEADER = "nhsd-correlation-id"
+    SUPPLIER_ID_HEADER = "nhsd-supplier-id",
+    APIM_CORRELATION_HEADER = "nhsd-correlation-id",
+    DOWNLOAD_URL_TTL_SECONDS = 3600
   }
 }

lambdas/api-handler/src/config/__tests__/deps.test.ts

@@ -33,6 +33,7 @@ describe('getDeps()', () => {
         LETTER_TTL_HOURS: '24',
         SUPPLIER_ID_HEADER: 'nhsd-supplier-id',
         APIM_CORRELATION_HEADER: 'nhsd-correlation-id',
+        DOWNLOAD_URL_TTL_SECONDS: '3600'
       },
     }));
   });
@@ -61,6 +62,7 @@ describe('getDeps()', () => {
       LETTER_TTL_HOURS: '24',
       SUPPLIER_ID_HEADER: 'nhsd-supplier-id',
       APIM_CORRELATION_HEADER: 'nhsd-correlation-id',
+      DOWNLOAD_URL_TTL_SECONDS: '3600'
     });
   });
 

lambdas/api-handler/src/config/__tests__/env.test.ts

@@ -15,14 +15,16 @@ describe('lambdaEnv', () => {
     process.env.APIM_CORRELATION_HEADER = 'x-correlation-id';
     process.env.LETTERS_TABLE_NAME = 'letters-table';
     process.env.LETTER_TTL_HOURS = '24';
+    process.env.DOWNLOAD_URL_TTL_SECONDS = '3600';
 
     const { lambdaEnv } = require('../env');
 
     expect(lambdaEnv).toEqual({
       SUPPLIER_ID_HEADER: 'x-supplier-id',
       APIM_CORRELATION_HEADER: 'x-correlation-id',
       LETTERS_TABLE_NAME: 'letters-table',
-      LETTER_TTL_HOURS: '24'
+      LETTER_TTL_HOURS: '24',
+      DOWNLOAD_URL_TTL_SECONDS: '3600'
     });
   });
 
@@ -31,6 +33,7 @@ describe('lambdaEnv', () => {
     process.env.APIM_CORRELATION_HEADER = 'x-correlation-id';
     process.env.LETTERS_TABLE_NAME = undefined; // simulate missing var
     process.env.LETTER_TTL_HOURS = '24';
+    process.env.DOWNLOAD_URL_TTL_SECONDS = '3600';
 
     expect(() => require('../env')).toThrow(
       'Missing required env var: LETTERS_TABLE_NAME'

lambdas/api-handler/src/config/env.ts

@@ -3,13 +3,15 @@ export interface LambdaEnv {
   APIM_CORRELATION_HEADER: string;
   LETTERS_TABLE_NAME: string;
   LETTER_TTL_HOURS: string;
+  DOWNLOAD_URL_TTL_SECONDS: string;
 }
 
 export const lambdaEnv: LambdaEnv = {
   SUPPLIER_ID_HEADER: getEnv('SUPPLIER_ID_HEADER')!,
   APIM_CORRELATION_HEADER: getEnv('APIM_CORRELATION_HEADER')!,
   LETTERS_TABLE_NAME: getEnv('LETTERS_TABLE_NAME')!,
-  LETTER_TTL_HOURS: getEnv('LETTER_TTL_HOURS')!
+  LETTER_TTL_HOURS: getEnv('LETTER_TTL_HOURS')!,
+  DOWNLOAD_URL_TTL_SECONDS: getEnv('DOWNLOAD_URL_TTL_SECONDS')!
 };
 
 function getEnv(name: string, required = true): string | undefined {

lambdas/api-handler/src/handlers/__tests__/get-letter-data.test.ts

@@ -24,7 +24,8 @@ const fakeDeps: jest.Mocked<Deps> = {
     SUPPLIER_ID_HEADER: 'nhsd-supplier-id',
     APIM_CORRELATION_HEADER: 'nhsd-correlation-id',
     LETTERS_TABLE_NAME: 'LETTERS_TABLE_NAME',
-    LETTER_TTL_HOURS: 'LETTER_TTL_HOURS'
+    LETTER_TTL_HOURS: 'LETTER_TTL_HOURS',
+    DOWNLOAD_URL_TTL_SECONDS: 'DOWNLOAD_URL_TTL_SECONDS'
   } as unknown as LambdaEnv
 }
 mockedGetDeps.mockReturnValue(fakeDeps);

lambdas/api-handler/src/handlers/__tests__/get-letters.test.ts

@@ -10,7 +10,8 @@ const fakeDeps: jest.Mocked<Deps> = {
     SUPPLIER_ID_HEADER: 'nhsd-supplier-id',
     APIM_CORRELATION_HEADER: 'nhsd-correlation-id',
     LETTERS_TABLE_NAME: 'LETTERS_TABLE_NAME',
-    LETTER_TTL_HOURS: 'LETTER_TTL_HOURS'
+    LETTER_TTL_HOURS: 'LETTER_TTL_HOURS',
+    DOWNLOAD_URL_TTL_SECONDS: 'DOWNLOAD_URL_TTL_SECONDS'
   } as unknown as LambdaEnv
 }
 mockedGetDeps.mockReturnValue(fakeDeps);

lambdas/api-handler/src/handlers/__tests__/patch-letter.test.ts

@@ -10,7 +10,8 @@ const fakeDeps: jest.Mocked<Deps> = {
     SUPPLIER_ID_HEADER: 'nhsd-supplier-id',
     APIM_CORRELATION_HEADER: 'nhsd-correlation-id',
     LETTERS_TABLE_NAME: 'LETTERS_TABLE_NAME',
-    LETTER_TTL_HOURS: 'LETTER_TTL_HOURS'
+    LETTER_TTL_HOURS: 'LETTER_TTL_HOURS',
+    DOWNLOAD_URL_TTL_SECONDS: 'DOWNLOAD_URL_TTL_SECONDS'
   } as unknown as LambdaEnv
 }
 mockedGetDeps.mockReturnValue(fakeDeps);

lambdas/api-handler/src/services/__tests__/letter-operations.test.ts

@@ -3,13 +3,11 @@ import { Deps } from '../../config/deps';
 import { LetterDto } from '../../contracts/letters';
 import { getLetterDataUrl, getLettersForSupplier, patchLetterStatus } from '../letter-operations';
 import pino from 'pino';
-import { LambdaEnv } from '../../config/env';
 
 jest.mock('@aws-sdk/s3-request-presigner', () => ({
   getSignedUrl: jest.fn(),
 }));
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
-const mockedGetSignedUrl = getSignedUrl as jest.MockedFunction<typeof getSignedUrl>;
 
 jest.mock('@aws-sdk/client-s3', () => {
   const originalModule = jest.requireActual('@aws-sdk/client-s3');
@@ -18,9 +16,13 @@ jest.mock('@aws-sdk/client-s3', () => {
   };
 });
 import { S3Client, GetObjectCommand } from '@aws-sdk/client-s3';
-const MockedGetObjectCommand = GetObjectCommand as unknown as jest.Mock;
 
 describe("getLetterIdsForSupplier", () => {
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
   it("returns letter IDs from the repository", async () => {
     const mockRepo = {
       getLettersBySupplier: jest.fn().mockResolvedValue([
@@ -50,6 +52,10 @@ describe("getLetterIdsForSupplier", () => {
 
 describe('patchLetterStatus function', () => {
 
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
   const updatedLetterDto: LetterDto = {
     id: 'letter1',
     supplierId: 'supplier1',
@@ -106,14 +112,27 @@ describe('patchLetterStatus function', () => {
 
 describe('getLetterDataUrl function', () => {
 
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  const mockedGetSignedUrl = getSignedUrl as jest.MockedFunction<typeof getSignedUrl>;
+  const MockedGetObjectCommand = GetObjectCommand as unknown as jest.Mock;
+
   const updatedLetter = makeLetter("letter1", "REJECTED");
 
   const s3Client = { send: jest.fn() } as unknown as S3Client;
   const letterRepo = {
     getLetterById: jest.fn().mockResolvedValue(updatedLetter)
   } as unknown as LetterRepository;
   const logger = jest.fn() as unknown as pino.Logger;;
-  const env = jest.fn() as unknown as LambdaEnv;
+  const env = {
+        LETTERS_TABLE_NAME: 'LettersTable',
+        LETTER_TTL_HOURS: '24',
+        SUPPLIER_ID_HEADER: 'nhsd-supplier-id',
+        APIM_CORRELATION_HEADER: 'nhsd-correlation-id',
+        DOWNLOAD_URL_TTL_SECONDS: '3600'
+  };
   const deps: Deps = { s3Client, letterRepo, logger, env };
 
   it('should return pre signed url successfully', async () => {
@@ -122,12 +141,11 @@ describe('getLetterDataUrl function', () => {
 
     const result = await getLetterDataUrl('supplier1', 'letter1', deps);
 
-    expect(mockedGetSignedUrl).toHaveBeenCalled();
-    expect(MockedGetObjectCommand).toHaveBeenCalledWith({
+    const expectedCommandInput = {
         Bucket: 'letterDataBucket',
         Key: 'letter1.pdf'
-    });
-
+    };
+    expect(mockedGetSignedUrl).toHaveBeenCalledWith(s3Client, { input: expectedCommandInput}, { expiresIn: 3600});
     expect(result).toEqual('http://somePreSignedUrl.com');
   });
 

lambdas/api-handler/src/services/letter-operations.ts

@@ -39,7 +39,7 @@ export const getLetterDataUrl = async (supplierId: string, letterId: string, dep
 
   try {
     letter = await deps.letterRepo.getLetterById(supplierId, letterId);
-    return await getPresignedUrl(letter.url, deps.s3Client);
+    return await getDownloadUrl(letter.url, deps.s3Client, deps.env.DOWNLOAD_URL_TTL_SECONDS);
   } catch (error) {
     if (error instanceof Error && /^Letter with id \w+ not found for supplier \w+$/.test(error.message)) {
       throw new NotFoundError(ApiErrorDetail.NotFoundLetterId);
@@ -48,7 +48,7 @@ export const getLetterDataUrl = async (supplierId: string, letterId: string, dep
   }
 }
 
-async function getPresignedUrl(s3Uri: string, s3Client: S3Client) {
+async function getDownloadUrl(s3Uri: string, s3Client: S3Client, expiry: string) {
 
   const url = new URL(s3Uri); // works for s3:// URIs
   const bucket = url.hostname;
@@ -59,5 +59,5 @@ async function getPresignedUrl(s3Uri: string, s3Client: S3Client) {
     Key: key,
   });
 
-  return await getSignedUrl(s3Client, command, { expiresIn: 3600 });
+  return await getSignedUrl(s3Client, command, { expiresIn: Number.parseInt(expiry) });
 }