feat: support experimental headers #1425
Merged
Conversation
This file contains 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
WalkthroughThe recent changes introduce support for experimental headers in HTTP responses, enabling the use of custom Changes
Assessment against linked issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
github-actions
bot
added
the
type: feature
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1425 +/- ##
==========================================
+ Coverage 88.55% 88.58% +0.02%
==========================================
Files 127 127
Lines 13604 13634 +30
==========================================
+ Hits 12047 12077 +30
Misses 1557 1557 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files ignored due to path filters (3)
tests/snapshots/execution_spec__experimental-headers.md_assert_0.snapis excluded by:!**/*.snaptests/snapshots/execution_spec__experimental-headers.md_client.snapis excluded by:!**/*.snaptests/snapshots/execution_spec__experimental-headers.md_merged.snapis excluded by:!**/*.snap
Files selected for processing (8)
- generated/.tailcallrc.graphql (1 hunks)
- generated/.tailcallrc.schema.json (1 hunks)
- src/blueprint/server.rs (4 hunks)
- src/config/headers.rs (1 hunks)
- src/config/server.rs (1 hunks)
- src/http/request_context.rs (3 hunks)
- src/http/request_handler.rs (4 hunks)
- tests/execution/experimental-headers.md (1 hunks)
Check Runs (1)
codecov/patch completed (2)
- src/http/request_handler.rs: 169-169: Added line #L169 was not covered by tests
- src/http/request_handler.rs: 172-172: Added line #L172 was not covered by tests
Additional comments: 11
tests/execution/experimental-headers.md (1)
- 1-44: The documentation provides a clear example of how to define and test experimental headers using GraphQL schema and mock requests. It's well-structured and aligns with the PR's objectives of supporting
x-*headers.src/config/headers.rs (1)
- 21-24: The addition of the
experimentalfield to theHeadersstruct is well-implemented. It allows for the inclusion of experimental headers in server responses, aligning with the PR's objectives. The use ofOption<Vec<String>>is appropriate for optional and multiple values.src/http/request_context.rs (3)
- 22-22: The introduction of the
experimental_headersfield to theRequestContextstruct is correctly implemented. This field is essential for handling experimental headers throughout the request lifecycle.- 101-101: Initialization of the
experimental_headersfield withHeaderMap::new()in theFrom<&AppContext>implementation is correct, ensuring that each request context starts with an empty set of experimental headers.- 132-132: Similarly, initializing the
experimental_headersfield in the test module's defaultRequestContextis appropriate, ensuring consistency in test environments.src/blueprint/server.rs (2)
- 33-33: Adding the
experimental_headersfield to theServerstruct is a crucial step in supporting experimental headers. This field allows specifying which headers are considered experimental at the server level.- 75-77: The
get_experimental_headersmethod correctly converts theexperimental_headersvector into aBTreeSet<String>for efficient access and deduplication. This method facilitates the retrieval of experimental headers in a structured manner.src/config/server.rs (1)
- 175-180: The
get_experimental_headersmethod is implemented correctly, providing a way to retrieve experimental headers defined in the server configuration. This method ensures that experimental headers can be accessed and utilized where needed.src/http/request_handler.rs (2)
- 71-77: The creation of allowed headers, including experimental headers, is correctly implemented. This step is crucial for filtering and including only the allowed and experimental headers in the request context.
- 93-103: The
update_experimental_headersfunction correctly updates the response headers with the experimental headers from the request context. This implementation ensures that experimental headers are correctly forwarded in the server's response.generated/.tailcallrc.graphql (1)
- 580-584: The addition of the
experimentalfield to theHeadersinput type is correctly implemented and documented. It aligns with the PR's objective to support experimental headers.Please ensure the application correctly processes these headers and includes them in responses as intended.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- tests/execution/experimental-headers.md (1 hunks)
Additional comments: 3
tests/execution/experimental-headers.md (3)
- 3-15: The GraphQL schema definition correctly implements the functionality for handling experimental headers as outlined in the PR objectives. This is a well-structured approach to extending the server's capabilities.
- 18-32: The mock YAML configuration correctly demonstrates the inclusion of experimental headers in a request. However, the presence of
x-not-allowedheader raises questions about its purpose in this context. Is it intended to test the server's behavior with unsupported headers? Clarification would be helpful.- 34-42: The YAML configuration for the assertion correctly tests the server's handling of experimental headers in a GraphQL request. This aligns with the PR objectives and demonstrates the desired functionality effectively.
# Conflicts: # benches/impl_path_string_for_evaluation_context.rs # generated/.tailcallrc.graphql # generated/.tailcallrc.schema.json # src/config/headers.rs # src/http/request_context.rs # src/http/request_handler.rs
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to path filters (1)
tests/snapshots/execution_spec__experimental-headers.md_merged.snapis excluded by:!**/*.snap
Files selected for processing (8)
- benches/impl_path_string_for_evaluation_context.rs (1 hunks)
- generated/.tailcallrc.graphql (1 hunks)
- generated/.tailcallrc.schema.json (1 hunks)
- src/blueprint/server.rs (4 hunks)
- src/config/headers.rs (2 hunks)
- src/config/server.rs (2 hunks)
- src/http/request_context.rs (3 hunks)
- src/http/request_handler.rs (4 hunks)
Files skipped from review as they are similar to previous changes (7)
- generated/.tailcallrc.graphql
- generated/.tailcallrc.schema.json
- src/blueprint/server.rs
- src/config/headers.rs
- src/config/server.rs
- src/http/request_context.rs
- src/http/request_handler.rs
Additional comments: 1
benches/impl_path_string_for_evaluation_context.rs (1)
- 250-250: The addition of
experimental_headerstoRequestContextaligns with the PR's objectives. Ensure that this new field is utilized effectively in processing and includingx-*headers in API responses.Verification successful
The verification process has confirmed that the
experimental_headersfield is correctly added, initialized, and utilized across the application for handling HTTP requests and responses, aligning with the PR's objectives. The usage and configuration of this field are consistent with the intended purpose of managing experimental headers effectively.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that `experimental_headers` is used in HTTP request and response handling. rg --type rust 'experimental_headers'Length of output: 1518
tusharmath
approved these changes
Mar 14, 2024
|
Realized after merging that we need a test to make sure
|
ssddOnTop
pushed a commit
that referenced
this pull request
Mar 16, 2024
Co-authored-by: Tushar Mathur <tusharmath@gmail.com>
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.
Issue Reference(s):
Fixes #1413
/claim #1413
Doc PR: tailcallhq/tailcallhq.github.io#157
Build & Testing:
cargo testsuccessfully../lint.sh --mode=fixto fix all linting issues raised by./lint.sh --mode=check.Checklist:
<type>(<optional scope>): <title>Summary by CodeRabbit
Summary by CodeRabbit