CCM-11228: Add TTL fields to ddb repository

Author: m-houston

internal/datastore/src/__test__/db.ts

@@ -1,5 +1,10 @@
 import { GenericContainer } from 'testcontainers';
-import { CreateTableCommand, DeleteTableCommand, DynamoDBClient } from '@aws-sdk/client-dynamodb';
+import {
+  CreateTableCommand,
+  DeleteTableCommand,
+  DynamoDBClient,
+  UpdateTimeToLiveCommand
+} from '@aws-sdk/client-dynamodb';
 import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
 import { DatastoreConfig } from '../config';
 
@@ -24,7 +29,8 @@ export async function setupDynamoDBContainer() {
   const config : DatastoreConfig = {
     region: 'us-west-2',
     endpoint,
-    lettersTableName: 'letters'
+    lettersTableName: 'letters',
+    ttlHours: 1
   };
 
   return {
@@ -66,8 +72,17 @@ export async function createTables(context: DBContext) {
       { AttributeName: 'supplierStatus', AttributeType: 'S' }
     ]
   }));
+
+  await ddbClient.send(new UpdateTimeToLiveCommand({
+    TableName: 'letters',
+    TimeToLiveSpecification: {
+      AttributeName: 'ttl',
+      Enabled: true
+    }
+  }));
 }
 
+
 export async function deleteTables(context: DBContext) {
   const { ddbClient } = context;
 

internal/datastore/src/config.ts

@@ -2,4 +2,5 @@ export type DatastoreConfig = {
   region: string,
   endpoint?: string,
   lettersTableName: string,
+  ttlHours: number
 }

internal/datastore/src/letter-repository.ts

@@ -18,16 +18,22 @@ const defaultPagingOptions = {
   pageSize: 50
 };
 
+export type LetterRepositoryConfig = {
+  lettersTableName: string,
+  ttlHours: number
+}
+
 export class LetterRepository {
   constructor(readonly ddbClient: DynamoDBDocumentClient,
               readonly log: Logger,
-              readonly config: { lettersTableName: string }) {
+              readonly config: LetterRepositoryConfig) {
   }
 
-  async putLetter(letter: Letter): Promise<LetterDB> {
+  async putLetter(letter: Letter): Promise<Letter> {
     const letterDb: LetterDB = {
       ...letter,
-      supplierStatus: `${letter.supplierId}#${letter.status}`
+      supplierStatus: `${letter.supplierId}#${letter.status}`,
+      ttl: Math.floor(Date.now() / 1000 + 60 * 60 * this.config.ttlHours)
     };
     try {
       await this.ddbClient.send(new PutCommand({
@@ -41,7 +47,7 @@ export class LetterRepository {
       }
       throw error;
     }
-    return letterDb;
+    return LetterSchema.parse(letterDb);
   }
 
   async getLetterById(supplierId: string, letterId: string): Promise<Letter> {
@@ -103,15 +109,17 @@ export class LetterRepository {
           supplierId: supplierId,
           id: letterId
         },
-        UpdateExpression: 'set #status = :status, updatedAt = :updatedAt, supplierStatus = :supplierStatus',
+        UpdateExpression: 'set #status = :status, updatedAt = :updatedAt, supplierStatus = :supplierStatus, #ttl = :ttl',
         ConditionExpression: 'attribute_exists(id)', // Ensure letter exists
         ExpressionAttributeNames: {
           '#status': 'status',
+          '#ttl': 'ttl'
         },
         ExpressionAttributeValues: {
           ':status': status,
           ':updatedAt': new Date().toISOString(),
-          ':supplierStatus': `${supplierId}#${status}`
+          ':supplierStatus': `${supplierId}#${status}`,
+          ':ttl': Math.floor(Date.now() / 1000 + 60 * 60 * this.config.ttlHours)
         },
         ReturnValues: 'ALL_NEW'
       }));

internal/datastore/src/types.ts

@@ -24,13 +24,14 @@ export const LetterSchema = z.object({
   url: z.url(),
   status: LetterStatus,
   createdAt: z.string(),
-  updatedAt: z.string(),
+  updatedAt: z.string()
 }).describe('Letter');
 
 export type Letter = z.infer<typeof LetterSchema>;
 
 export const LetterDBSchema = LetterSchema.extend({
   supplierStatus: z.string().describe('Secondary index PK'),
+  ttl: z.int()
 });
 
 /**