Skip to content

Add additional Dapr Actors Analyzers#1715

Open
moonolgerd wants to merge 12 commits intodapr:masterfrom
moonolgerd:master
Open

Add additional Dapr Actors Analyzers#1715
moonolgerd wants to merge 12 commits intodapr:masterfrom
moonolgerd:master

Conversation

@moonolgerd
Copy link

@moonolgerd moonolgerd commented Feb 20, 2026

Description

Add additional Dapr Actors Analyzers

Issue reference

Add analyzers that help prevent developer gotchas
Please reference the issue this PR will close: ##1426

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

  • Code compiles correctly
  • Created/updated tests
  • Extended the documentation

Copilot AI and others added 3 commits February 20, 2026 04:55
Initial plan
1c171fa
@moonolgerd
Add ActorSerializationAnalyzer and ActorSerializationCodeFixProvider …
5c8923c 
…(DAPR1405-DAPR1414)

Co-authored-by: moonolgerd <3743184+moonolgerd@users.noreply.github.com>
@moonolgerd
Merge pull request #1 from moonolgerd/copilot/create-pr-for-merge
06e4072 
Add ActorSerializationAnalyzer with DAPR1405-DAPR1414 diagnostic rules
Copilot AI review requested due to automatic review settings February 20, 2026 05:19
@moonolgerd moonolgerd requested review from a team as code owners February 20, 2026 05:19
Copilot AI reviewed Feb 20, 2026
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Roslyn analyzer + code fix provider intended to catch common Dapr Actors serialization “gotchas” (interfaces inheriting IActor, enum member attributes, validation of types used in actor method signatures), along with initial unit tests and analyzer release notes.

Changes:

  • Introduces ActorSerializationAnalyzer with new rule IDs DAPR1405–DAPR1414.
  • Adds ActorSerializationCodeFixProvider with fixes for a subset of the new diagnostics.
  • Adds ActorSerializationAnalyzerTests and updates AnalyzerReleases.Unshipped.md to document the rules.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 10 comments.

File Description
test/Dapr.Actors.Analyzers.Test/ActorSerializationAnalyzerTests.cs Adds analyzer tests for several new serialization-related diagnostics.
src/Dapr.Actors.Analyzers/Dapr.Actors.Analyzers/AnalyzerReleases.Unshipped.md Documents newly introduced analyzer rules (unshipped).
src/Dapr.Actors.Analyzers/Dapr.Actors.Analyzers/ActorSerializationCodeFixProvider.cs Adds code fixes for several new serialization diagnostics.
src/Dapr.Actors.Analyzers/Dapr.Actors.Analyzers/ActorSerializationAnalyzer.cs Implements new actor serialization analyzer rules and diagnostic descriptors.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

test/Dapr.Actors.Analyzers.Test/ActorSerializationAnalyzerTests.cs
Comment on lines +283 to +287
[Fact]
public async Task ActorClassWithoutIActorInterface_ShouldReportDAPR1413()
{
var context = CreateTest();
context.TestCode = """
Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are no tests covering DAPR1411 (collection element validation) or DAPR1414 (parameterless ctor / [DataContract]) even though ActorSerializationAnalyzer introduces both rules. Adding targeted analyzer tests (and code-fix tests for ActorSerializationCodeFixProvider) would help prevent regressions and validate diagnostic locations.

Copilot uses AI. Check for mistakes.
Copy link
Author

@moonolgerd moonolgerd Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot open a new pull request to apply changes based on this feedback

src/Dapr.Actors.Analyzers/Dapr.Actors.Analyzers/ActorSerializationAnalyzer.cs
Comment on lines +196 to +200
private static void AnalyzeEnumDeclaration(SyntaxNodeAnalysisContext context)
{
var enumDeclaration = (EnumDeclarationSyntax)context.Node;
var semanticModel = context.SemanticModel;
var enumSymbol = semanticModel.GetDeclaredSymbol(enumDeclaration);
Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AnalyzeEnumDeclaration currently enforces DAPR1406 for every enum in the compilation regardless of whether the enum is related to Dapr actors. If the intent is "Actor types" only (per title/notes), the analyzer should scope this rule to enums reachable from Actor method signatures or Actor-related types, or adjust the wording to indicate a global rule.

Copilot uses AI. Check for mistakes.
Copy link
Author

@moonolgerd moonolgerd Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot open a new pull request to apply changes based on this feedback

src/Dapr.Actors.Analyzers/Dapr.Actors.Analyzers/ActorSerializationCodeFixProvider.cs
Comment on lines +151 to +155
private static void RegisterAddRecordDataContractFix(CodeFixContext context, SyntaxNode root, SyntaxNode node, Diagnostic diagnostic)
{
if (node is RecordDeclarationSyntax recordDeclaration)
{
var action = CodeAction.Create(
Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DAPR1412 is reported at the record usage location (e.g., a method signature), but this code fix only registers when the diagnostic node is a RecordDeclarationSyntax. In most cases FindNode(span) will return an IdentifierName/TypeSyntax, so the fix won't appear; resolve the record symbol via SemanticModel and apply the fix at its declaring syntax reference(s).

Copilot uses AI. Check for mistakes.
Copy link
Author

@moonolgerd moonolgerd Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot open a new pull request to apply changes based on this feedback

Copy link
Author

@moonolgerd moonolgerd Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot open a new pull request to apply changes based on this feedback

src/Dapr.Actors.Analyzers/Dapr.Actors.Analyzers/AnalyzerReleases.Unshipped.md
Comment on lines +7 to +11
DAPR1405 | Usage | Error | Actor interface should inherit from IActor.
DAPR1406 | Usage | Warning | Enum members in Actor types should use EnumMember attribute.
DAPR1407 | Usage | Info | Consider using JsonPropertyName for property name consistency.
DAPR1408 | Usage | Warning | Complex types used in Actor methods need serialization attributes.
DAPR1409 | Usage | Warning | Actor method parameter needs proper serialization attributes.
Copy link

Copilot AI Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This release note lists DAPR1407 and DAPR1408 as new rules, but ActorSerializationAnalyzer currently never reports either diagnostic. Either implement them or remove them from the release list so the documented rule set matches actual behavior.

Copilot uses AI. Check for mistakes.
Copy link
Author

@moonolgerd moonolgerd Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot open a new pull request to apply changes based on this feedback

Copy link
Author

@moonolgerd moonolgerd Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot open a new pull request to apply changes based on this feedback

@moonolgerd
Copy link
Author

moonolgerd commented Feb 20, 2026

@copilot open a new pull request to apply changes based on the comments in this thread

WhitWaldo
WhitWaldo requested changes Feb 20, 2026
View reviewed changes
Copy link
Contributor

@WhitWaldo WhitWaldo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for submitting this PR. I've added a few review notes and if you could also address what Copilot has raised, I think that'll put this PR in a good place to merge it.

moonolgerd and others added 3 commits February 21, 2026 21:51
@moonolgerd
Update src/Dapr.Actors.Analyzers/Dapr.Actors.Analyzers/ActorSerializa…
6b1d851 
…tionAnalyzer.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Oleg Merkulov <moonolgerd@gmail.com>
@moonolgerd
Update src/Dapr.Actors.Analyzers/Dapr.Actors.Analyzers/ActorSerializa…
8e5ac90 
…tionCodeFixProvider.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Oleg Merkulov <moonolgerd@gmail.com>
@WhitWaldo
Merge branch 'master' into master
da94efa
@WhitWaldo
Copy link
Contributor

WhitWaldo commented Feb 23, 2026

Something about your analyzer is blocking the build altogether - could you please take a look at that?

moonolgerd and others added 6 commits February 23, 2026 10:24
@moonolgerd
Fixed missing descriptors
4a58de3
@moonolgerd
PR changes
140c8a4
@WhitWaldo
Merge branch 'master' into master
1f7c822
@moonolgerd
Update src/Dapr.Actors.Analyzers/Dapr.Actors.Analyzers/ActorSerializa…
355e274 
…tionAnalyzer.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Oleg Merkulov <moonolgerd@gmail.com>
@moonolgerd
Update src/Dapr.Actors.Analyzers/Dapr.Actors.Analyzers/ActorSerializa…
a92619f 
…tionAnalyzer.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Oleg Merkulov <moonolgerd@gmail.com>
@moonolgerd
Update src/Dapr.Actors.Analyzers/Dapr.Actors.Analyzers/ActorSerializa…
36ee2cf 
…tionCodeFixProvider.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Oleg Merkulov <moonolgerd@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@WhitWaldo WhitWaldo WhitWaldo requested changes

Requested changes must be addressed to merge this pull request.

Assignees

@moonolgerd moonolgerd

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@moonolgerd @WhitWaldo