Validate published envelope topics

[neekolas]

tl;dr

• Uses new envelopes structs to help validate publish requests
• Validates that the topic matches the payload (Topic validation (validate payloads are published to the correct topic) #231)

AI Generated Summary

Refactored envelope handling and improved validation in the API service.

What changed?

• Moved envelope-related test utilities to a dedicated package pkg/testutils/envelopes.
• Enhanced ClientEnvelope struct with additional methods for topic handling and payload validation.
• Updated Service.PublishEnvelopes to use the new envelope validation logic.
• Improved error handling and messages in various API functions.
• Introduced TopicMatchesPayload method to ensure consistency between envelope topic and payload.

How to test?

1. Run the existing test suite to ensure all tests pass after the refactoring.
2. Add new tests to cover the TopicMatchesPayload functionality in pkg/envelopes/client.go.
3. Verify that publishing envelopes with mismatched topics and payloads now results in appropriate error messages.

Why make this change?

This refactoring improves code organization, enhances envelope validation, and increases the robustness of the API service. By centralizing envelope-related logic and adding stricter validation, we reduce the likelihood of processing invalid envelopes and improve overall system reliability.

[graphite-app]

Your org has enabled the Graphite merge queue for merging into main

Add the label “Queue” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “Hotfix” to add to the merge queue as a hot fix.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

[neekolas]

• Add auth token to GRPC requests #236
• Add domain separation for originator signatures #235
• Recover signer from payer envelopes #234
• Validate published envelope topics #233 👈
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @neekolas and the rest of your teammates on Graphite

[neekolas]

Merge activity

• Oct 17, 5:18 PM PDT: A user started a stack merge that includes this pull request via Graphite.
• Oct 17, 5:18 PM PDT: A user merged this pull request with Graphite.