feat(api): add request id middleware with client header validation and tracing (#686) - #729
Open
ravendevhub wants to merge 1 commit into
Open
Conversation
…d tracing (Core-Foundry#686) - Validate client-supplied X-Request-ID and X-Correlation-ID headers (alphanumeric/hyphens <= 64 chars) - Fallback to cryptographically random UUID generation on invalid/missing headers - Expose X-Request-ID and X-Correlation-ID in HTTP response headers - Attach validated IDs to request context for structured logging - Add unit test coverage and specification in docs/REQUEST_ID_MIDDLEWARE.md
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.
Summary
Resolves #686 by introducing Request ID and Correlation ID tracing middleware for the NotifyChain API, validating client-supplied headers, attaching tracing identifiers to logs, and exposing
X-Request-IDin HTTP response headers.Changes
listener/src/middleware/request-id.ts,listener/src/utils/request-id.ts):X-Request-IDandX-Correlation-IDheaders against safe alphanumeric/hyphen patterns (^[a-zA-Z0-9_-]{1,64}$).X-Request-IDandX-Correlation-IDresponse headers before flushing.req.headersfor downstream structured log context.request-id.test.tsverifying validation, sanitization, and response binding.docs/REQUEST_ID_MIDDLEWARE.md.Acceptance Criteria