Add performance hints #501
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
ptpaterson
approved these changes
Dec 10, 2024
ptpaterson
reviewed
Dec 10, 2024
jrodewig
approved these changes
Dec 10, 2024
fauna-chase
reviewed
Dec 10, 2024
fauna-chase
approved these changes
Dec 11, 2024
Closed
Merged
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.
Problem
The query API can enable performance hints in the payload summary. This feature is not available in the CLI.
Solution
This PR adds performance hints to query and shell. Within shell, you can toggle them on and off. When using query, they are printed to stderr so they do not interfere with things reading outputs.
Because performance hints come through summary, some parsing logic needs to be in place to protect against that. Additionally, we apply fql formatting to the actual diagnostic text itself. If for whatever reason this fails, we just print the summary as is.
Result
Query
Query w/ summary
Shell
Shell with multiple hints
Testing
Tests were added to prove its wired up to the driver and displays appropriately in shell and query.