Add source field back to origin as this scopes the subject

m-houston · m-houston · commit 783c385d4563 · 2025-11-04T13:43:55.000Z
diff --git a/internal/events/schemas/domain/letter.schema.json b/internal/events/schemas/domain/letter.schema.json
@@ -28,9 +28,14 @@
           "description": "The domain which requested this letter",
           "type": "string"
         },
+        "source": {
+          "title": "Event source",
+          "description": "The source of the event which created this letter",
+          "type": "string"
+        },
         "subject": {
           "title": "Event subject",
-          "description": "The subject of the event which created this letter",
+          "description": "The subject of the event which created this letter, scoped to source",
           "type": "string"
         },
         "event": {
@@ -41,6 +46,7 @@
       },
       "required": [
         "domain",
+        "source",
         "subject",
         "event"
       ]
diff --git a/internal/events/schemas/events/letter.ACCEPTED.schema.json b/internal/events/schemas/events/letter.ACCEPTED.schema.json
@@ -111,9 +111,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -124,6 +129,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/events/letter.CANCELLED.schema.json b/internal/events/schemas/events/letter.CANCELLED.schema.json
@@ -111,9 +111,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -124,6 +129,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/events/letter.DELIVERED.schema.json b/internal/events/schemas/events/letter.DELIVERED.schema.json
@@ -111,9 +111,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -124,6 +129,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/events/letter.DISPATCHED.schema.json b/internal/events/schemas/events/letter.DISPATCHED.schema.json
@@ -111,9 +111,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -124,6 +129,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/events/letter.ENCLOSED.schema.json b/internal/events/schemas/events/letter.ENCLOSED.schema.json
@@ -111,9 +111,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -124,6 +129,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/events/letter.FAILED.schema.json b/internal/events/schemas/events/letter.FAILED.schema.json
@@ -111,9 +111,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -124,6 +129,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/events/letter.FORWARDED.schema.json b/internal/events/schemas/events/letter.FORWARDED.schema.json
@@ -111,9 +111,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -124,6 +129,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/events/letter.PENDING.schema.json b/internal/events/schemas/events/letter.PENDING.schema.json
@@ -111,9 +111,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -124,6 +129,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/events/letter.PRINTED.schema.json b/internal/events/schemas/events/letter.PRINTED.schema.json
@@ -111,9 +111,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -124,6 +129,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/events/letter.REJECTED.schema.json b/internal/events/schemas/events/letter.REJECTED.schema.json
@@ -111,9 +111,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -124,6 +129,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/events/letter.RETURNED.schema.json b/internal/events/schemas/events/letter.RETURNED.schema.json
@@ -111,9 +111,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -124,6 +129,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/events/letter.any.schema.json b/internal/events/schemas/events/letter.any.schema.json
@@ -123,9 +123,14 @@
               "description": "The domain which requested this letter",
               "type": "string"
             },
+            "source": {
+              "title": "Event source",
+              "description": "The source of the event which created this letter",
+              "type": "string"
+            },
             "subject": {
               "title": "Event subject",
-              "description": "The subject of the event which created this letter",
+              "description": "The subject of the event which created this letter, scoped to source",
               "type": "string"
             },
             "event": {
@@ -136,6 +141,7 @@
           },
           "required": [
             "domain",
+            "source",
             "subject",
             "event"
           ]
diff --git a/internal/events/schemas/examples/letter.ACCEPTED.json b/internal/events/schemas/examples/letter.ACCEPTED.json
@@ -5,6 +5,7 @@
     "origin": {
       "domain": "letter-rendering",
       "event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+      "source": "/data-plane/letter-rendering/prod/render-pdf",
       "subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
     },
     "specificationId": "1y3q9v1zzzz",
diff --git a/internal/events/schemas/examples/letter.FORWARDED.json b/internal/events/schemas/examples/letter.FORWARDED.json
@@ -5,6 +5,7 @@
     "origin": {
       "domain": "letter-rendering",
       "event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+      "source": "/data-plane/letter-rendering/prod/render-pdf",
       "subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
     },
     "reasonCode": "RNIB",
diff --git a/internal/events/schemas/examples/letter.RETURNED.json b/internal/events/schemas/examples/letter.RETURNED.json
@@ -5,6 +5,7 @@
     "origin": {
       "domain": "letter-rendering",
       "event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+      "source": "/data-plane/letter-rendering/prod/render-pdf",
       "subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
     },
     "reasonCode": "R07",
diff --git a/internal/events/src/domain/letter.ts b/internal/events/src/domain/letter.ts
@@ -37,9 +37,14 @@ export const $Letter = DomainBase("Letter")
           title: "Domain ID",
           description: "The domain which requested this letter",
         }),
+        source: z.string().meta({
+          title: "Event source",
+          description: "The source of the event which created this letter",
+        }),
         subject: z.string().meta({
           title: "Event subject",
-          description: "The subject of the event which created this letter",
+          description:
+            "The subject of the event which created this letter, scoped to source",
         }),
         event: z.string().meta({
           title: "Event ID",
diff --git a/internal/events/src/events/__tests__/testData/letter.ACCEPTED-with-invalid-major-version.json b/internal/events/src/events/__tests__/testData/letter.ACCEPTED-with-invalid-major-version.json
@@ -5,6 +5,7 @@
     "origin": {
       "domain": "letter-rendering",
       "event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+      "source": "/data-plane/letter-rendering/prod/render-pdf",
       "subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
     },
     "specificationId": "1y3q9v1zzzz",
diff --git a/internal/events/src/events/__tests__/testData/letter.ACCEPTED-with-missing-fields.json b/internal/events/src/events/__tests__/testData/letter.ACCEPTED-with-missing-fields.json
@@ -4,7 +4,8 @@
     "groupId": "client_template",
     "origin": {
       "domain": "letter-rendering",
-      "event": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
+      "event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+      "source": "/data-plane/letter-rendering/prod/render-pdf"
     },
     "specificationId": "1y3q9v1zzzz",
     "status": "ACCEPTED"
diff --git a/internal/events/src/events/__tests__/testData/letter.ACCEPTED.json b/internal/events/src/events/__tests__/testData/letter.ACCEPTED.json
@@ -5,6 +5,7 @@
     "origin": {
       "domain": "letter-rendering",
       "event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+      "source": "/data-plane/letter-rendering/prod/render-pdf",
       "subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
     },
     "specificationId": "1y3q9v1zzzz",
diff --git a/internal/events/src/events/__tests__/testData/letter.FORWARDED.json b/internal/events/src/events/__tests__/testData/letter.FORWARDED.json
@@ -5,6 +5,7 @@
     "origin": {
       "domain": "letter-rendering",
       "event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+      "source": "/data-plane/letter-rendering/prod/render-pdf",
       "subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
     },
     "reasonCode": "RNIB",
diff --git a/internal/events/src/events/__tests__/testData/letter.RETURNED.json b/internal/events/src/events/__tests__/testData/letter.RETURNED.json
@@ -5,6 +5,7 @@
     "origin": {
       "domain": "letter-rendering",
       "event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+      "source": "/data-plane/letter-rendering/prod/render-pdf",
       "subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
     },
     "reasonCode": "R07",
