Repository navigation
Fix diagnostic event XML docs that misstate when events are raised - #10674
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation changes are consistent, focused, and have no unresolved review issues.
No open issues 🎉
What changed in this PR
This pull request corrects XML documentation for diagnostic events so it accurately describes when execution, request-error, task, and DataLoader events are raised.
Changes:
- Clarifies exception and GraphQL-error request event semantics.
- Updates execution processing, task, and deferred-fragment descriptions.
- Documents that
BatchEvaluatedis emitted once per evaluation run without batch dispatch.
| File | Description |
|---|---|
src/HotChocolate/Core/src/Types/Execution/Instrumentation/IExecutionDiagnosticEvents.cs |
Corrects task and execution-processing event documentation. |
src/HotChocolate/Core/src/Execution.Abstractions/Execution/Instrumentation/ICoreExecutionDiagnosticEvents.cs |
Clarifies request exception and GraphQL-error event semantics. |
src/GreenDonut/src/GreenDonut/Instrumentation/IDataLoaderDiagnosticEvents.cs |
Clarifies when BatchEvaluated is raised. |
Review effort: Lite
This file contains hidden or 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
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.
Summary
Brings the XML docs of the diagnostic events in line with when the events are raised, matching the event tables that #10672 corrected on the instrumentation page:
RequestError(RequestContext, Exception)is called when an exception aborts the request, and within theParseDocumentscope when the document cannot be parsed. Resolver exceptions raiseResolverError, so they are no longer listed.RequestError(RequestContext, IError)is called when a pipeline step reports a GraphQL error that terminates the request, without promising that every such error is reported through it.StartProcessingandStopProcessingdescribe the engine starting, resuming, and pausing,RunTaskandTaskErrorname a deferred fragment as their example task, andBatchEvaluatedis raised once per run of evaluations that dispatch no batch.