Skip to content

Add 'plane' field to event envelope and update version to 1.1.4 #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
m-houston merged 1 commit into from
Dec 2, 2025
Merged

Add 'plane' field to event envelope and update version to 1.1.4 #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/events/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@
"test:unit": "jest",
"prepare": "npm run build"
},
"version": "1.1.3"
"version": "1.1.4"
}
126 changes: 71 additions & 55 deletions packages/events/src/events/__tests__/event-envelope.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ describe("EventEnvelope schema validation", () => {
recordedtime: "2025-10-01T10:15:30.250Z",
severitynumber: 2,
severitytext: "INFO",
plane: "data",
};

describe("basic validation", () => {
Expand All @@ -44,6 +45,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "TRACE",
severitynumber: 0,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -55,6 +57,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "DEBUG",
severitynumber: 1,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -66,6 +69,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "INFO",
severitynumber: 2,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -77,6 +81,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "WARN",
severitynumber: 3,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -88,6 +93,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "ERROR",
severitynumber: 4,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -99,6 +105,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "FATAL",
severitynumber: 5,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -110,6 +117,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "TRACE",
severitynumber: 1,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -121,6 +129,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "DEBUG",
severitynumber: 2,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -132,6 +141,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "INFO",
severitynumber: 1,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -143,6 +153,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "WARN",
severitynumber: 2,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -154,6 +165,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "ERROR",
severitynumber: 3,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -165,6 +177,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "FATAL",
severitynumber: 4,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -176,6 +189,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: undefined,
severitynumber: 2,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -187,6 +201,7 @@ describe("EventEnvelope schema validation", () => {
...baseValidEnvelope,
severitytext: "INFO",
severitynumber: 2,
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -208,6 +223,7 @@ describe("EventEnvelope schema validation", () => {
dataclassification: "restricted",
dataregulation: "GDPR",
datacategory: "sensitive",
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand All @@ -216,65 +232,12 @@ describe("EventEnvelope schema validation", () => {
});
});

describe("source validation", () => {
it("should accept source with letter-rendering plane", () => {
const envelope = {
...baseValidEnvelope,
source: "/data-plane/letter-rendering/ordering",
};

const result = $Envelope.safeParse(envelope);
expect(result.error).toBeUndefined();
expect(result.success).toBe(true);
});

it("should accept source with digital-letters domain", () => {
const envelope = {
...baseValidEnvelope,
source: "/data-plane/digital-letters/ordering",
};

const result = $Envelope.safeParse(envelope);
expect(result.error).toBeUndefined();
expect(result.success).toBe(true);
});

it("should accept source with digital-letters domain and additional path", () => {
const envelope = {
...baseValidEnvelope,
source: "/data-plane/digital-letters/ordering/sub-path",
};

const result = $Envelope.safeParse(envelope);
expect(result.error).toBeUndefined();
expect(result.success).toBe(true);
});

it("should accept source with letter-rendering plane and additional path", () => {
const envelope = {
...baseValidEnvelope,
source: "/data-plane/letter-rendering/ordering/sub-path/more",
};

const result = $Envelope.safeParse(envelope);
expect(result.error).toBeUndefined();
expect(result.success).toBe(true);
});

describe("edge cases", () => {
it("should reject invalid source pattern", () => {
const envelope = {
...baseValidEnvelope,
source: "/invalid-plane/test",
};

const result = $Envelope.safeParse(envelope);
expect(result.success).toBe(false);
});

it("should reject source without data-plane prefix", () => {
const envelope = {
...baseValidEnvelope,
source: "/digital-letters/ordering",
plane: "data",
};

const result = $Envelope.safeParse(envelope);
Expand Down Expand Up @@ -304,13 +267,15 @@ describe("EventEnvelope schema validation", () => {
recordedtime: "2025-10-01T10:15:30.250Z",
severitynumber: 2,
severitytext: "INFO" as const,
plane: "data",
};

it("should accept subject with valid prefix when prefix is required", () => {
const envelope = {
...baseLetterEnvelope,
subject:
"letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479",
plane: "data",
};

const result = $EnvelopeWithPrefix.safeParse(envelope);
Expand All @@ -322,6 +287,7 @@ describe("EventEnvelope schema validation", () => {
const envelope = {
...baseLetterEnvelope,
subject: "letter/f47ac10b-58cc-4372-a567-0e02b2c3d479",
plane: "data",
};

const result = $EnvelopeWithPrefix.safeParse(envelope);
Expand All @@ -334,6 +300,7 @@ describe("EventEnvelope schema validation", () => {
const envelope = {
...baseLetterEnvelope,
subject: "letter-origin/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479",
plane: "data",
};

const result = $EnvelopeWithPrefix.safeParse(envelope);
Expand All @@ -359,6 +326,7 @@ describe("EventEnvelope schema validation", () => {
recordedtime: "2025-10-01T10:15:30.250Z",
severitynumber: 2,
severitytext: "INFO" as const,
plane: "data",
};

const result = $EnvelopeNoPrefix.safeParse(envelope);
Expand All @@ -378,6 +346,7 @@ describe("EventEnvelope schema validation", () => {
const envelope = {
...baseLetterEnvelope,
subject: "a/b/c/letter/test-id-123",
plane: "data",
};

const result = $EnvelopeMultiSegmentPrefix.safeParse(envelope);
Expand All @@ -404,10 +373,57 @@ describe("EventEnvelope schema validation", () => {
recordedtime: "2025-10-01T10:15:30.250Z",
severitynumber: 2,
severitytext: "INFO" as const,
plane: "data",
};

const result = $EnvelopeNoPrefix.safeParse(envelope);
expect(result.success).toBe(false);
});
});

// Additional tests for digital-letters source and optional request ID fields
describe("source validation", () => {
it("should accept source with digital-letters domain", () => {
const envelope = {
...baseValidEnvelope,
source: "/data-plane/digital-letters/ordering",
plane: "data",
};
const result = $Envelope.safeParse(envelope);
expect(result.error).toBeUndefined();
expect(result.success).toBe(true);
});
it("should accept source with digital-letters domain and additional path", () => {
const envelope = {
...baseValidEnvelope,
source: "/data-plane/digital-letters/ordering/sub-path",
plane: "data",
};
const result = $Envelope.safeParse(envelope);
expect(result.error).toBeUndefined();
expect(result.success).toBe(true);
});
it("should accept source with letter-rendering plane and additional path", () => {
const envelope = {
...baseValidEnvelope,
source: "/data-plane/letter-rendering/ordering/sub-path/more",
plane: "data",
};
const result = $Envelope.safeParse(envelope);
expect(result.error).toBeUndefined();
expect(result.success).toBe(true);
});
});
describe("optional request ID fields", () => {
it("should accept envelope with optional requestId fields", () => {
const envelope = {
...baseValidEnvelope,
requestId: "req-12345",
correlationId: "corr-67890",
plane: "data",
};
const result = $Envelope.safeParse(envelope);
expect(result.success).toBe(true);
});
});
});
1 change: 1 addition & 0 deletions packages/events/src/events/__tests__/testData/letter-request-prepared-valid.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"datacontenttype": "application/json",
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.prepared.1.0.0.schema.json",
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
"plane": "data",
"recordedtime": "2025-08-28T08:45:00.000Z",
"severitynumber": 2,
"severitytext": "INFO",
Expand Down
1 change: 1 addition & 0 deletions ...nts/src/events/__tests__/testData/letter-request-prepared-with-invalid-major-version.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"datacontenttype": "application/json",
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.prepared.0.1.0.schema.json",
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
"plane": "data",
"recordedtime": "2025-08-28T08:45:00.000Z",
"severitynumber": 2,
"severitytext": "INFO",
Expand Down
1 change: 1 addition & 0 deletions ...ges/events/src/events/__tests__/testData/letter-request-prepared-with-missing-fields.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"datacontenttype": "application/json",
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.prepared.1.0.0.schema.json",
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
"plane": "data",
"recordedtime": "2025-08-28T08:45:00.000Z",
"severitynumber": 2,
"severitytext": "INFO",
Expand Down
1 change: 1 addition & 0 deletions ...s/src/events/__tests__/testData/letter-request-prepared-with-partial-optional-fields.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"datacontenttype": "application/json",
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.prepared.1.0.0.schema.json",
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
"plane": "data",
"recordedtime": "2025-08-28T08:45:00.000Z",
"severitynumber": 2,
"severitytext": "INFO",
Expand Down
1 change: 1 addition & 0 deletions ...events/src/events/__tests__/testData/letter-request-prepared-without-optional-fields.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"datacontenttype": "application/json",
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.prepared.1.0.0.schema.json",
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
"plane": "data",
"recordedtime": "2025-08-28T08:45:00.000Z",
"severitynumber": 2,
"severitytext": "INFO",
Expand Down
6 changes: 6 additions & 0 deletions packages/events/src/events/event-envelope.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,12 @@ export function EventEnvelope<TData extends z.ZodTypeAny>(
}),
),

plane: z.literal("data").meta({
title: "Event Plane",
description: "The event bus in which the event was generated.",
examples: ["data"],
}),

recordedtime: z.iso.datetime().meta({
title: "Recorded Time",
description:
Expand Down