New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: input types loose out on provided graphQL documentation #1657
Closed
+55
−4
Closed
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add assertions for the
fields
andscalar
properties in thetest_from_sdl_description
test to ensure comprehensive coverage.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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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_description
test insrc/config/config.rs
will 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/execution
directory. The provided output from thetests/execution
directory 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:
This test checks that the SDL description is correctly parsed and associated with the
ExampleInput
type, and that theid
field is correctly identified as anInt
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:
Length of output: 180053
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check out this test —
tests/execution/test-query-documentation.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tusharmath does the test look alright?