make constant for x-request-id#53667
Merged
zcin merged 1 commit intoray-project:masterfrom Jun 9, 2025
Merged
Conversation
Signed-off-by: Cindy Zhang <cindyzyx9@gmail.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR centralizes the "x-request-id" header key by introducing SERVE_HTTP_REQUEST_ID_HEADER and replaces all hardcoded instances across the codebase and tests.
- Add
SERVE_HTTP_REQUEST_ID_HEADERconstant in_private/constants.py - Update proxy and HTTP middleware to use the new constant
- Refactor tests to reference the constant instead of string literals
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| python/ray/serve/_private/constants.py | Introduce SERVE_HTTP_REQUEST_ID_HEADER constant |
| python/ray/serve/_private/proxy.py | Replace literal header key with the new constant |
| python/ray/serve/_private/http_util.py | Use constant instead of literal in request ID handling |
| python/ray/serve/tests/test_http_headers.py | Update tests to use the new constant for header checks |
Comments suppressed due to low confidence (1)
python/ray/serve/_private/constants.py:263
- [nitpick] Add a descriptive comment above this constant matching the style of other headers, e.g.
# Serve HTTP request ID header key.
SERVE_HTTP_REQUEST_ID_HEADER = "x-request-id"
| handle = handle.options(multiplexed_model_id=multiplexed_model_id) | ||
| request_context_info["multiplexed_model_id"] = multiplexed_model_id | ||
| if key.decode() == "x-request-id": | ||
| if key.decode() == SERVE_HTTP_REQUEST_ID_HEADER: |
There was a problem hiding this comment.
HTTP header names are case-insensitive; consider normalizing with key.decode().lower() before comparing to SERVE_HTTP_REQUEST_ID_HEADER to avoid mismatches.
Comment on lines
+24
to
25
| from ray.serve._private.constants import SERVE_HTTP_REQUEST_ID_HEADER, SERVE_LOGGER_NAME | ||
| from ray.serve._private.utils import generate_request_id, serve_encoders |
There was a problem hiding this comment.
[nitpick] Split this import into separate lines and reorder to follow PEP8 import grouping and alphabetical order for clarity.
Suggested change
| from ray.serve._private.constants import SERVE_HTTP_REQUEST_ID_HEADER, SERVE_LOGGER_NAME | |
| from ray.serve._private.utils import generate_request_id, serve_encoders | |
| from ray.serve._private.constants import SERVE_HTTP_REQUEST_ID_HEADER | |
| from ray.serve._private.constants import SERVE_LOGGER_NAME | |
| from ray.serve._private.utils import generate_request_id | |
| from ray.serve._private.utils import serve_encoders |
abrarsheikh
approved these changes
Jun 9, 2025
elliot-barn
pushed a commit
that referenced
this pull request
Jun 18, 2025
## Why are these changes needed? Make `x-request-id` a constant. Signed-off-by: Cindy Zhang <cindyzyx9@gmail.com> Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
elliot-barn
pushed a commit
that referenced
this pull request
Jul 2, 2025
## Why are these changes needed? Make `x-request-id` a constant. Signed-off-by: Cindy Zhang <cindyzyx9@gmail.com> Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
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.
Why are these changes needed?
Make
x-request-ida constant.