Merge pull request #1385 from guardian/pf/ingest-iconik-messages-1

Iconik Ingest 1: Use zod for ingestion lambda types

Author: bryophyta

pluto-message-ingestion/package.json

@@ -18,7 +18,8 @@
     "@aws-sdk/client-secrets-manager": "3.901.0",
     "@aws-sdk/credential-providers": "3.901.0",
     "@guardian/libs": "26.0.0",
-    "esbuild": "0.25.10"
+    "esbuild": "0.25.10",
+    "zod": "^4.1.12"
   },
   "devDependencies": {
     "@types/aws-lambda": "8.10.152",

pluto-message-ingestion/scripts/test-pluto-lambda-CODE.js

@@ -2,8 +2,8 @@
 // @ts-check
 
 /**
- * @typedef {import("../src/types").UpsertMessage} UpsertMessage
- * @typedef {import("../src/types").DeleteMessage} DeleteMessage
+ * @typedef {import("../src/types").PlutoUpsertMessage} UpsertMessage
+ * @typedef {import("../src/types").PlutoDeleteMessage} DeleteMessage
  */
 
 import { getProject, invokeLambda } from './aws.js';

pluto-message-ingestion/src/process-record.ts

@@ -4,8 +4,8 @@ import { createHmacClient } from './hmac-request';
 import { createLogger, Logger } from './logging';
 import {
   hasRecognisedMessageType,
-  isDeleteMessage,
-  isUpsertMessage
+  isPlutoDeleteMessage,
+  isPlutoUpsertMessage
 } from './types';
 
 export async function processRecord(
@@ -24,7 +24,7 @@ export async function processRecord(
     return 'failure'; // if the message is not valid there isn't any point in retrying
   }
 
-  if (isDeleteMessage(data)) {
+  if (isPlutoDeleteMessage(data)) {
     const result = await hmacDelete({
       url: `${baseUrl}/api/pluto/commissions/${data.commissionId}`
     });
@@ -36,7 +36,7 @@ export async function processRecord(
         `Error deleting commission ${data.commissionId}: ${result.status} ${result.statusText}`
       );
     }
-  } else if (isUpsertMessage(data)) {
+  } else if (isPlutoUpsertMessage(data)) {
     const result = await hmacPut({
       url: `${baseUrl}/api/pluto/projects`,
       data

pluto-message-ingestion/src/types.ts

@@ -1,19 +1,13 @@
-const recognisedMessageTypes = ['project-created', 'project-updated'];
-type MessageType = (typeof recognisedMessageTypes)[number];
+import { z } from 'zod/v4';
 
-export type UpsertMessage = {
-  type: MessageType;
-  id: string;
-  title: string;
-  status: string;
-  commissionId: string;
-  commissionTitle: string;
-  productionOffice: string;
-  created: string;
-};
+const plutoMessageTypes = ['project-created', 'project-updated'];
+
+const plutoMessageTypeSchema = z.enum(plutoMessageTypes);
+
+export type MessageType = z.infer<typeof plutoMessageTypeSchema>;
 
 export function isRecognisedMessageType(type: unknown): type is MessageType {
-  return recognisedMessageTypes.includes(type as MessageType);
+  return plutoMessageTypes.includes(type as MessageType);
 }
 
 export function hasRecognisedMessageType(data: unknown): boolean {
@@ -24,50 +18,37 @@ export function hasRecognisedMessageType(data: unknown): boolean {
   return isRecognisedMessageType(type);
 }
 
-export function isUpsertMessage(data: unknown): data is UpsertMessage {
-  if (!data || typeof data !== 'object' || data === null) {
-    return false;
-  }
-  const {
-    type,
-    id,
-    title,
-    status,
-    commissionId,
-    commissionTitle,
-    productionOffice,
-    created
-  } = data as {
-    [key: string]: unknown;
-  };
-  return (
-    isRecognisedMessageType(type) &&
-    typeof id === 'string' &&
-    typeof title === 'string' &&
-    typeof status === 'string' &&
-    typeof commissionId === 'string' &&
-    typeof commissionTitle === 'string' &&
-    typeof productionOffice === 'string' &&
-    typeof created === 'string'
-  );
+const plutoUpsertMessageSchema = z.looseObject({
+  type: plutoMessageTypeSchema,
+  id: z.string(),
+  title: z.string(),
+  status: z.string(),
+  commissionId: z.string(),
+  commissionTitle: z.string(),
+  productionOffice: z.string(),
+  created: z.string()
+});
+
+export type PlutoUpsertMessage = z.infer<typeof plutoUpsertMessageSchema>;
+
+export function isPlutoUpsertMessage(
+  data: unknown
+): data is PlutoUpsertMessage {
+  const parsed = plutoUpsertMessageSchema.safeParse(data);
+  return parsed.success;
 }
 
-export type DeleteMessage = {
-  type: MessageType;
-  commissionId: string;
-  commissionTitle: '(DELETE)';
-};
+const PlutoDeleteMessageSchema = z.looseObject({
+  type: plutoMessageTypeSchema,
+  commissionId: z.string(),
+  commissionTitle: z.literal('(DELETE)')
+});
 
-export function isDeleteMessage(data: unknown): data is DeleteMessage {
-  if (!data || typeof data !== 'object' || data === null) {
-    return false;
-  }
-  const { commissionId, commissionTitle, type } = data as {
-    [key: string]: unknown;
-  };
-  return (
-    isRecognisedMessageType(type) &&
-    typeof commissionId === 'string' &&
-    commissionTitle === '(DELETE)'
-  );
+export type PlutoDeleteMessage = z.infer<typeof PlutoDeleteMessageSchema>;
+
+export function isPlutoDeleteMessage(
+  data: unknown
+): data is PlutoDeleteMessage {
+  const parsed = PlutoDeleteMessageSchema.safeParse(data);
+  return parsed.success;
 }

pluto-message-ingestion/yarn.lock

@@ -2296,3 +2296,8 @@ yocto-queue@^0.1.0:
   version "0.1.0"
   resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b"
   integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==
+
+zod@^4.1.12:
+  version "4.1.12"
+  resolved "https://registry.yarnpkg.com/zod/-/zod-4.1.12.tgz#64f1ea53d00eab91853195653b5af9eee68970f0"
+  integrity sha512-JInaHOamG8pt5+Ey8kGmdcAcg3OL9reK8ltczgHTAwNhMys/6ThXHityHxVV2p3fkw/c+MAvBHFVYHFZDmjMCQ==