-
Notifications
You must be signed in to change notification settings - Fork 53
Add Roslyn analyzer for non-contextual logger usage in orchestrations (DURABLE0009) #553
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
Draft
Copilot
wants to merge
4
commits into
main
Choose a base branch
from
copilot/alert-non-contextual-logger
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+420
−0
Conversation
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
Co-authored-by: YunchuWang <[email protected]>
…ate diagnostics Co-authored-by: YunchuWang <[email protected]>
Comment on lines
+69
to
+81
| foreach (IParameterSymbol parameter in methodSymbol.Parameters) | ||
| { | ||
| if (this.IsILoggerType(parameter.Type)) | ||
| { | ||
| // Found an ILogger parameter - report diagnostic at the parameter location | ||
| if (parameter.DeclaringSyntaxReferences.Length > 0) | ||
| { | ||
| SyntaxNode parameterSyntax = parameter.DeclaringSyntaxReferences[0].GetSyntax(); | ||
| reportDiagnostic(RoslynExtensions.BuildDiagnostic(Rule, parameterSyntax, methodSymbol.Name, orchestrationName)); | ||
| reportedParameters.Add(parameter); | ||
| } | ||
| } | ||
| } |
Comment on lines
+71
to
+80
| if (this.IsILoggerType(parameter.Type)) | ||
| { | ||
| // Found an ILogger parameter - report diagnostic at the parameter location | ||
| if (parameter.DeclaringSyntaxReferences.Length > 0) | ||
| { | ||
| SyntaxNode parameterSyntax = parameter.DeclaringSyntaxReferences[0].GetSyntax(); | ||
| reportDiagnostic(RoslynExtensions.BuildDiagnostic(Rule, parameterSyntax, methodSymbol.Name, orchestrationName)); | ||
| reportedParameters.Add(parameter); | ||
| } | ||
| } |
Co-authored-by: YunchuWang <[email protected]>
Copilot
AI
changed the title
[WIP] Add Roslyn Analyzer alert for non-contextual logger usage
Add Roslyn analyzer for non-contextual logger usage in orchestrations (DURABLE0009)
Dec 10, 2025
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.
Orchestrations must use
context.CreateReplaySafeLogger()instead of injectingILoggerdirectly, otherwise logs will be emitted during replay operations. This was listed as a common gotcha in #253 but lacked compile-time detection.Changes
New analyzer
LoggerOrchestrationAnalyzer(DURABLE0009) warns when:ILoggerorILogger<T>parameters appear in orchestration signaturesILoggerfields/properties are referenced within orchestration code pathsTaskOrchestrator, andAddOrchestratorFuncpatternsDetection logic traverses method call chains to catch indirect usage, skips parameter references already flagged at declaration to avoid duplicate diagnostics
Ignores legitimate cases: Activity functions, loggers created via
CreateReplaySafeLogger(), non-orchestration codeExample
Test coverage includes all orchestration types, generic logger variants, field/property references, and method chains.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.