relay-compiler diagnostic errors logging improvements #4574
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
1. Update diagnostic.print_without_source() to no longer include character ranges since the formatting of startchar:endchar doesnt match the standard expectation of linenumber:character (and thus editors will interpret it wrong) 2. Updated the ValidationErrors to no longer enumerate all errors, and instead show the count (since the actual errors are shown above anyway) # Test Plan Confirmed the new formatting of .print_without_source() is correct with no character ranges (tested via ValidationError since I'm not sure how to generate a DiagnosticsError, but this will no longer be triggered due to the summarization change): ``` [INFO] Querying files to compile... [INFO] [default] compiling... [ERROR] Error: ✖︎ The type `CustomMetric` has no field `test`. See https://relay.dev/docs/error-reference/unknown-field/ client/components/console/metrics_catalog/MetricDefinitionDebugDialog.tsx:20:7 19 │ configuration_json 20 │ test │ ^^^^ 21 │ } [ERROR] Compilation failed. [ERROR] Unable to run relay compiler. Error details: Failed to build: - Validation errors: - The type `CustomMetric` has no field `test`. See https://relay.dev/docs/error-reference/unknown-field/: client/components/console/metrics_catalog/MetricDefinitionDebugDialog.tsx ``` Confirmed the count shows instead of the individual errors now: ``` [INFO] Querying files to compile... [INFO] [default] compiling... [ERROR] Error: ✖︎ The type `CustomMetric` has no field `test`. See https://relay.dev/docs/error-reference/unknown-field/ client/components/console/metrics_catalog/MetricDefinitionDebugDialog.tsx:20:7 19 │ configuration_json 20 │ test │ ^^^^ 21 │ } [ERROR] Compilation failed. [ERROR] Unable to run relay compiler. Error details: Failed to build: - Validation errors: 1 error(s) encountered above. ``` Also confirmed that config errors still showed up correctly: ``` [ERROR] Config `/Users/alex/dev/statsig/console/relay.config.js` is invalid: - The `schema` configured for project `default` does not exist at `./server/lib/graphql/schedma.graphql`.
|
I could update DiagnosticsError to have the same summarization change, but I'm not familiar with how to trigger that / if it shows those messages elsewhere or not |
|
@captbaritone has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
|
This is great! Thanks for coming through with the PR and for the detailed test plan. |
|
@captbaritone merged this pull request in a2c7ed4. |
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.
Couple of improvements to relay compiler error output to address issues from #4571
Test Plan
Confirmed the new formatting of .print_without_source() is correct with no character ranges (tested via ValidationError since I'm not sure how to generate a DiagnosticsError, but this will no longer be triggered due to the summarization change):
Confirmed the count shows instead of the individual errors now:
Also confirmed that config errors still showed up correctly: