feat: add Request Interceptor and request ID generation utilities (#2176) - #2179
Open
nagi1 wants to merge 1 commit into
Open
feat: add Request Interceptor and request ID generation utilities (#2176)#2179nagi1 wants to merge 1 commit into
nagi1 wants to merge 1 commit into
Conversation
Author
|
Related issue: #2176 |
Author
|
@devlikepro Kind Reminder to review and merge this! |
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.
This pull request introduces infrastructure for request ID tracing to improve request correlation and observability. It adds a configurable request ID header, generates or propagates request IDs, and ensures the request ID is included in responses. The changes also include comprehensive tests for these features.
Request ID tracing and propagation:
Added a new module
src/nestjs/requestId.tsproviding:generateRequestIdfor extracting or generating a request ID (UUID v4) from incoming requests, using a configurable header (WAHA_REQUEST_ID_HEADER, defaulting tox-request-id).RequestIdInterceptor, a NestJS interceptor that writes the request ID to the response header, matching the incoming header name.getRequestIdHeaderutility for retrieving the configured header name.Integrated request ID tracing into the core app:
RequestIdInterceptoras a global interceptor inPROVIDERS_BASEto ensure all responses include the request ID header.pino-httplogging to usegenerateRequestId, ensuring consistent request ID usage in logs and tracing.Testing and reliability:
src/nestjs/requestId.test.tscovering:RequestIdInterceptorunder various scenarios, including custom headers and edge cases.