fix: input types loose out on provided graphQL documentation #1657
Conversation
WalkthroughThe changes introduced aim to enhance the handling of input types and documentation within the GraphQL schema generation process. This includes the addition of a new test to verify the parsing of SDL descriptions into the config structure, as well as modifications to improve the handling of input object types and the inclusion of documentation in the generated schema. Changes
Assessment against linked issues
Possibly related issues
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
type: docs
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
|
||
| #[test] | ||
| fn test_from_sdl_description() { | ||
| let actual = Config::from_sdl( | ||
| r#" | ||
| """ | ||
| Some Documentation | ||
| """ | ||
| input Foo { | ||
| id: Int! | ||
| } | ||
| "#, | ||
| ) | ||
| .to_result() | ||
| .unwrap(); | ||
|
|
||
| let expected = Config::default().types(vec![( | ||
| "Foo", | ||
| Type { | ||
| doc: Some("Some Documentation".to_string()), | ||
| ..Default::default() | ||
| } | ||
| .fields(vec![("id", Field::int().required(true))]), | ||
| )]); | ||
| assert_eq!(actual, expected); | ||
| } |
There was a problem hiding this comment.
Add assertions for the fields and scalar properties in the test_from_sdl_description test to ensure comprehensive coverage.
#[test]
fn test_from_sdl_description() {
// Test setup and execution...
assert_eq!(actual.types["Foo"].fields["id"].type_of, "Int");
assert!(!actual.types["Foo"].scalar);
}This enhancement will verify that the input object type Foo not only has the correct documentation but also accurately reflects its fields and scalar property, ensuring a more thorough test coverage.
There was a problem hiding this comment.
You can drop this test and add one like this https://github.com/tailcallhq/tailcall/tree/main/tests/execution
There was a problem hiding this comment.
@tusharmath, based on your request to drop the existing test and add a new one similar to those in the tests/execution directory, here's a proposed approach:
-
Remove the existing test: The existing
test_from_sdl_descriptiontest insrc/config/config.rswill be removed as per your instruction. -
Add a new test: A new test will be added following the structure and style observed in the
tests/executiondirectory. The provided output from thetests/executiondirectory suggests a pattern of testing involving server configurations, mock requests, and assertions. However, since the task is to modify a Rust test file, and the provided examples are not directly applicable to Rust code, I'll generate a Rust test that conceptually aligns with the pattern of setting up a scenario, executing a function, and asserting the outcome.
Here's a conceptual Rust test that aligns with the instructions:
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_new_sdl_description_behavior() {
// Setup the test environment
let sdl = r#"
"""
Example Documentation
"""
input ExampleInput {
id: Int!
}
"#;
// Execute the function under test
let config = Config::from_sdl(sdl).to_result().unwrap();
// Assert the expected outcome
assert_eq!(config.types["ExampleInput"].doc, Some("Example Documentation".to_string()));
assert_eq!(config.types["ExampleInput"].fields["id"].type_of, "Int");
assert!(config.types["ExampleInput"].fields["id"].required);
}
}This test checks that the SDL description is correctly parsed and associated with the ExampleInput type, and that the id field is correctly identified as an Int and marked as required. This aligns with the objective of ensuring that descriptions for input object types are correctly parsed and included in the generated schema, as well as verifying the field types and requirements.
Please review this approach and let me know if it meets your expectations or if further adjustments are needed.
Analysis chain
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# List the files in the tests/execution directory to choose a representative file.
fd . tests/execution --exec cat {}
Length of output: 180053
There was a problem hiding this comment.
@tusharmath I am having trouble with what the test will look like, can you give me a hint?
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
There was a problem hiding this comment.
Check out this test — tests/execution/test-query-documentation.md
There was a problem hiding this comment.
@tusharmath does the test look alright?
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1657 +/- ##
==========================================
+ Coverage 87.10% 87.13% +0.02%
==========================================
Files 148 148
Lines 15145 15178 +33
==========================================
+ Hits 13192 13225 +33
Misses 1953 1953 ☔ View full report in Codecov by Sentry. |
|
Action required: PR inactive for 2 days. |
github-actions
bot
added
state: inactive
|
Action required: PR inactive for 2 days. |
github-actions
bot
added
state: inactive
|
Action required: PR inactive for 2 days. |
github-actions
bot
added
state: inactive
|
Action required: PR inactive for 2 days. |
github-actions
bot
added
state: inactive
|
Action required: PR inactive for 2 days. |
github-actions
bot
added
state: inactive
|
Action required: PR inactive for 2 days. |
github-actions
bot
added
the
state: inactive
|
PR closed after 5 days of inactivity. |
Summary:
Add descriptions to input object types
Issue Reference(s):
Fixes #1625
Build & Testing:
cargo testsuccessfully../lint.sh --mode=fixto fix all linting issues raised by./lint.sh --mode=check.Checklist:
<type>(<optional scope>): <title>/claim #1625
Summary by CodeRabbit