CCM-16644: Add an eventsub Module#189
Closed
gareth-allan wants to merge 2 commits intomainfrom
Closed
Conversation
Contributor
Author
|
It's been agreed that the reporting domain does not need to use the eventsub module, so I'm closing this PR. I don't think there's value in extracting the module from the supplier-api unless we know it's needed elsewhere. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add the eventsub module from nhs-notify-supplier-api so that it can also be used in the reporting domain.
Context
The reporting domain needs to use the same pattern for subscribing to events from the shared event bus as the Supplier API already uses, and given that the supplier API already includes a Terraform module to implement this pattern, it makes sense to extract that module here to allow for reuse.
Validation
I used the new eventsub module in this PR in the nhs-notify-reporting repository: NHSDigital/nhs-notify-reporting#242
I then deployed this branch of nhs-notify-reporting: https://github.com/NHSDigital/nhs-notify-internal/actions/runs/25057676077
Deployed Resources
SNS Topic:

Firehose Stream:

S3 Bucket:

Glue Crawler:

Sending a Test Message
I then published a test message to the SNS topic:

Eventually, a file appeared in the S3 bucket:

The content of the file was as follows (formatted for readability):
{ "Type": "Notification", "MessageId": "00cfc587-9975-5cf8-be5c-a7ed45c5edc7", "TopicArn": "arn:aws:sns:eu-west-2:381492132479:nhs-notify-main-reporting-eventsub", "Subject": "test", "Message": "{\n \"test\": \"This is a test\"\n}", "Timestamp": "2026-04-28T16:04:00.169Z", "UnsubscribeURL": "https://sns.eu-west-2.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:eu-west-2:381492132479:nhs-notify-main-reporting-eventsub:82b03e51-7e7b-4d17-8ee8-8ab025ba56c8" }Type of changes
Checklist
Sensitive Information Declaration
To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.