CCM-10483: wip spike

Author: harrim91

package-lock.json

@@ -41,6 +41,10 @@
     "lint": "npm run lint --workspaces",
     "lint:fix": "npm run lint:fix --workspaces",
     "start": "npm run start --workspace frontend",
+    "test:contracts:clean": "npm --workspace=tests/contracts run pact:clean",
+    "test:contracts:consumers": "npm --workspace=tests/contracts run test:consumers",
+    "test:contracts:producer": "npm --workspace=tests/contracts run test:producer",
+    "test:contracts:upload": "npm --workspace=tests/contracts run upload:consumer-pacts",
     "test:unit": "npm run test:unit --workspaces",
     "typecheck": "npm run typecheck --workspaces"
   },
@@ -53,6 +57,7 @@
     "lambdas/download-authorizer",
     "lambdas/sftp-letters",
     "tests/accessibility",
+    "tests/contracts",
     "tests/test-team",
     "utils/backend-config",
     "utils/entity-update-command-builder",

package.json

@@ -0,0 +1 @@
+*/pacts/

tests/contracts/.gitignore

@@ -0,0 +1,49 @@
+import path from 'node:path';
+import {
+  MessageConsumerPact,
+  Matchers,
+  asynchronousBodyHandler,
+} from '@pact-foundation/pact';
+import { z } from 'zod';
+
+// I guess this would be defined in the handler source code in the event consumer and imported here
+// Handlers should parse the incoming event before doing anything else
+const $TemplateDeletedEvent = z.object({
+  'detail-type': z.literal('TemplateDeleted'),
+  version: z.literal('1.0'),
+  detail: z.object({
+    id: z.string().uuid(),
+    owner: z.string().uuid(),
+  }),
+});
+
+// Simulate consumer handler that processes the incoming event
+// Only check the validation - don't run actual handler logic
+async function handleTemplateDeleted(event: unknown): Promise<void> {
+  $TemplateDeletedEvent.parse(event);
+}
+
+describe('Pact Message Consumer - TemplateDeleted Event', () => {
+  const messagePact = new MessageConsumerPact({
+    consumer: 'consumer-2',
+    provider: 'templates',
+    dir: path.resolve(__dirname, 'pacts'),
+    pactfileWriteMode: 'update',
+    logLevel: 'error',
+  });
+
+  it('should validate the template deleted event structure and handler logic', async () => {
+    await messagePact
+      .given('A template has been deleted')
+      .expectsToReceive('TemplateDeleted')
+      .withContent({
+        'detail-type': 'TemplateDeleted',
+        version: '1.0',
+        detail: {
+          owner: Matchers.uuid('c0574019-4629-4b3f-8987-aa34ca8bc5b9'),
+          id: Matchers.uuid('b18a9a49-72a8-4157-8b85-76d5ac5c7804'),
+        },
+      })
+      .verify(asynchronousBodyHandler(handleTemplateDeleted));
+  });
+});

tests/contracts/consumer-2/template-deleted.pact.test.ts

@@ -0,0 +1,47 @@
+import path from 'node:path';
+import {
+  MessageConsumerPact,
+  Matchers,
+  asynchronousBodyHandler,
+} from '@pact-foundation/pact';
+import { z } from 'zod';
+
+// I guess this would be defined in the handler source code in the event consumer and imported here
+// Handlers should parse the incoming event before doing anything else
+const $TemplateDeletedEvent = z.object({
+  'detail-type': z.literal('TemplateDeleted'),
+  detail: z.object({
+    id: z.string().uuid(),
+    owner: z.string().uuid(),
+  }),
+});
+
+// Simulate consumer handler that processes the incoming event
+// Only check the validation - don't run actual handler logic
+async function handleTemplateDeleted(event: unknown): Promise<void> {
+  $TemplateDeletedEvent.parse(event);
+}
+
+describe('Pact Message Consumer - TemplateDeleted Event', () => {
+  const messagePact = new MessageConsumerPact({
+    consumer: 'core',
+    provider: 'templates',
+    dir: path.resolve(__dirname, 'pacts'),
+    pactfileWriteMode: 'update',
+    logLevel: 'error',
+  });
+
+  it('should validate the template deleted event structure and handler logic', async () => {
+    await messagePact
+      .given('A template has been deleted')
+      .expectsToReceive('TemplateDeleted')
+      .withContent({
+        'detail-type': 'TemplateDeleted',
+        detail: {
+          owner: Matchers.uuid('c0574019-4629-4b3f-8987-aa34ca8bc5b9'),
+          id: Matchers.uuid('b18a9a49-72a8-4157-8b85-76d5ac5c7804'),
+        },
+      })
+      .verify(asynchronousBodyHandler(handleTemplateDeleted));
+  });
+});

tests/contracts/consumer/template-deleted.pact.test.ts

@@ -0,0 +1,10 @@
+import type { Config } from 'jest';
+
+const config: Config = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/tests/**/*.pact.test.ts'],
+  transform: { '^.+\\.ts$': '@swc/jest' },
+};
+
+export default config;

tests/contracts/jest.config.ts

@@ -0,0 +1,19 @@
+{
+  "devDependencies": {
+    "@pact-foundation/pact": "^15.0.1",
+    "@swc/core": "^1.11.13",
+    "@swc/jest": "^0.2.37",
+    "@tsconfig/node20": "^20.1.5",
+    "jest": "^29.7.0",
+    "zod": "^3.24.2"
+  },
+  "name": "contract-tests",
+  "private": true,
+  "scripts": {
+    "pact:clean": "./scripts/clean.sh",
+    "test:consumers": "jest consumer consumer-2",
+    "test:producer": "cp -r consumer/pacts producer && cp -r consumer-2/pacts producer && jest producer/",
+    "upload:consumer-pacts": "./scripts/upload-consumer-pacts.sh"
+  },
+  "version": "1.0.0"
+}

tests/contracts/package.json

@@ -0,0 +1,37 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { MessageProviderPact } from '@pact-foundation/pact';
+
+// This would be the actual function that produces the event payload in the producer source code
+function produceTemplateDeletedEvent(): any {
+  return {
+    'detail-type': 'TemplateDeleted',
+    source: 'uk.nhs.notify.templates',
+    time: new Date().toISOString(),
+    version: '1.0',
+    detail: {
+      owner: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
+      id: 'de305d54-75b4-431b-adb2-eb6b9e546014',
+    },
+  };
+}
+
+describe('Pact Message Provider - TemplateDeleted Event', () => {
+  const pactDir = path.resolve(__dirname, 'pacts');
+
+  const messagePact = new MessageProviderPact({
+    provider: 'templates',
+    pactUrls: fs
+      .readdirSync(pactDir)
+      .filter((f) => f.endsWith('.json'))
+      .map((f) => path.join(pactDir, f)),
+    messageProviders: {
+      TemplateDeleted: () => produceTemplateDeletedEvent(),
+    },
+    logLevel: 'error',
+  });
+
+  it('should produce a message that satisfies the consumer contract for TemplateDeleted', () => {
+    return messagePact.verify();
+  });
+});

tests/contracts/producer/template-deleted.pact.test.ts

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -euo pipefail
+
+script_path="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )";
+
+dirs=("consumer" "consumer-2" "producer")
+
+for dir in "${dirs[@]}"; do
+  pact_dir="$(realpath "${script_path}/../${dir}")/pacts"
+
+  echo "Removing pact files in $pact_dir..."
+
+  rm -rf $pact_dir
+done
+
+echo "All Pact files deleted successfully."

tests/contracts/scripts/clean.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+set -euo pipefail
+
+script_path="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )";
+
+consumer_dirs=("consumer" "consumer-2")
+pact_dir="pacts"
+
+VERSION_TAG=${PACT_VERSION:-$(git rev-parse --abbrev-ref HEAD)}
+
+for consumer in "${consumer_dirs[@]}"; do
+  consumer_pact_dir=$(realpath "${script_path}/../${consumer}/${pact_dir}")
+
+  echo "Looking for pact files in $consumer_pact_dir..."
+
+  for file in "$consumer_pact_dir"/*.json; do
+    if [[ -f "$file" ]]; then
+      # Extract consumer and provider names from filename
+      filename=$(basename "$file")
+      provider=$(cat $file | jq -r ".provider.name")
+
+      # Define S3 target path
+      targetPath="pacts/$provider/$filename"
+
+      echo "Uploading to s3://$PACT_BUCKET/$targetPath"
+      # aws s3 cp "$file" "s3://$PACT_BUCKET/$targetPath" --acl bucket-owner-full-control
+    fi
+  done
+done
+
+echo "All Pact files uploaded successfully."