CCM-11343: create a schema which is a subset of db template

Author: bhansell1

lambdas/backend-client/src/index.ts

@@ -4,4 +4,5 @@ export * from './types/result';
 export * from './schemas/template-schema';
 export * from './schemas/client';
 export * from './schemas/union-lists';
+export * from './schemas/schema-for';
 export * from './client-configuration-api-client';

lambdas/event-publisher/src/domain/event-builder.ts

@@ -1,13 +1,12 @@
 import { Logger } from 'nhs-notify-web-template-management-utils/logger';
-import { PublishableEventRecord } from './input-schemas';
+import { $DynamoDBTemplate, PublishableEventRecord } from './input-schemas';
 import { Event, $Event } from './output-schemas';
 import { unmarshall } from '@aws-sdk/util-dynamodb';
 import {
   EventMetadata,
   EventMetadataVersionInformation,
 } from './base-metadata-schemas';
 import { shouldPublish } from './should-publish';
-import { $TemplateDtoSchema } from 'nhs-notify-backend-client';
 
 export class EventBuilder {
   constructor(
@@ -75,12 +74,7 @@ export class EventBuilder {
 
     const dynamoRecord = unmarshall(publishableEventRecord.dynamodb.NewImage);
 
-    // This isn't strictly correct. the DTO schema is slightly different from the DB schema.
-    // I guess this should be a Zod schema of the database schema
-    // Also doing this may cause this lambda to stop being backwards compatible? I.E. we add a new field
-    // then older templates being updated without the field will cause errors.
-    // Or I just rely on the any typing...
-    const databaseTemplate = $TemplateDtoSchema.parse(dynamoRecord);
+    const databaseTemplate = $DynamoDBTemplate.parse(dynamoRecord);
 
     if (!shouldPublish(databaseTemplate)) {
       this.logger.debug({
@@ -94,8 +88,8 @@ export class EventBuilder {
     return $Event.parse({
       ...this.buildTemplateSavedEventMetadata(
         publishableEventRecord.eventID,
-        dynamoRecord.templateStatus,
-        dynamoRecord.id
+        databaseTemplate.templateStatus,
+        databaseTemplate.id
       ),
       data: dynamoRecord,
     });

lambdas/event-publisher/src/domain/input-schemas.ts

@@ -1,5 +1,11 @@
 import { z } from 'zod';
-import { AttributeValue } from '@aws-sdk/client-dynamodb';
+import type { AttributeValue } from '@aws-sdk/client-dynamodb';
+import {
+  schemaFor,
+  TEMPLATE_STATUS_LIST,
+  TEMPLATE_TYPE_LIST,
+} from 'nhs-notify-backend-client';
+import type { DatabaseTemplate } from 'nhs-notify-web-template-management-utils';
 
 const $AttributeValue: z.ZodType<AttributeValue> = z.lazy(() =>
   z.union([
@@ -25,6 +31,18 @@ export const $DynamoDBStreamRecord = z.object({
   tableName: z.string(),
 });
 
+// We need a subset of the database fields so we can apply filtering rules
+export const $DynamoDBTemplate = schemaFor<Partial<DatabaseTemplate>>()(
+  z.object({
+    id: z.string(),
+    templateType: z.enum(TEMPLATE_TYPE_LIST),
+    templateStatus: z.enum(TEMPLATE_STATUS_LIST),
+    proofingEnabled: z.boolean().optional(),
+  })
+);
+
+export type DynamoDBTemplate = z.infer<typeof $DynamoDBTemplate>;
+
 // the lambda doesn't necessarily have to only accept inputs from a dynamodb stream via an
 // eventbridge pipe, but that's all it is doing at the moment
 export const $PublishableEventRecord = $DynamoDBStreamRecord;

lambdas/event-publisher/src/domain/should-publish.ts

@@ -1,26 +1,20 @@
-import {
-  TemplateStatus,
-  TemplateDto,
-  LetterProperties,
-} from 'nhs-notify-backend-client';
+import type { DynamoDBTemplate } from './input-schemas';
 
-type LetterTemplateDto = TemplateDto & LetterProperties;
-
-const publishableLetterStatuses = new Set<TemplateStatus>([
+const publishableLetterStatuses = new Set<DynamoDBTemplate['templateStatus']>([
   'DELETED',
   'PENDING_PROOF_REQUEST',
   'PROOF_AVAILABLE',
   'SUBMITTED',
   'WAITING_FOR_PROOF',
 ]);
 
-function shouldPublishLetter(data: LetterTemplateDto): boolean {
+function shouldPublishLetter(data: DynamoDBTemplate): boolean {
   return (
     publishableLetterStatuses.has(data.templateStatus) && !!data.proofingEnabled
   );
 }
 
-export function shouldPublish(data: TemplateDto) {
+export function shouldPublish(data: DynamoDBTemplate) {
   if (data.templateType === 'LETTER') {
     return shouldPublishLetter(data);
   }