[AK1005] Must close sender in async lambda expression argument #87
Conversation
…-in-ReceiveAsync # Conflicts: # src/Akka.Analyzers/Context/Core/Actor/BaseActorContext.cs # src/Akka.Analyzers/Utility/RuleDescriptors.cs
| id: "AK1005", | ||
| title: "Must close over `Sender` or `Self`", | ||
| category: AnalysisCategory.ActorDesign, | ||
| defaultSeverity: DiagnosticSeverity.Error, |
There was a problem hiding this comment.
I'd reduce this to a warning for now, in case this rule doesn't work as expected in the wild. We can always raise the severity later.
There was a problem hiding this comment.
Sounds good, I'll fix it now.
| ReceiveAsync<string>(async str => { | ||
| var sender = Sender; | ||
| await api.AsyncLambda(async () => { | ||
| sender.Tell(new Message(str)); |
There was a problem hiding this comment.
Just so I'm clear, it's the async lambda running inside this local function that makes accessing Context.Sender an issue, not the await-ing inside the ReceiveAsync itself, right?
There was a problem hiding this comment.
And I know this is a passing case with a closure et al, but I just wanted to be clear since I'm working from the top down of the diff.
| ReceiveAsync<string>(async str => | ||
| { | ||
| await api.AsyncLambda(async () => { | ||
| Context.Sender.Tell(new Message(str)); |
There was a problem hiding this comment.
Got it, yep I can see why this would be a problem.
There was a problem hiding this comment.
Analyzer test cases look good and make sense.
| var akkaActor = akkaContext.AkkaCore.Actor; | ||
|
|
||
| // The class declaration must implements or inherits `Akka.Actor.ActorBase` | ||
| if (!classDeclaration.IsDerivedOrImplements(semanticModel, akkaActor.ActorBaseType!)) |
| } | ||
| } | ||
|
|
||
| private sealed class BlockVisitor: CSharpSyntaxVisitor<List<Diagnostic>> |
There was a problem hiding this comment.
There are 2 visitors:
- one is for collecting all lambda expression that are being passed in as an argument to a method invocation,
- the other is a visitor that enumerates the body of said lambda to look for the use of
Sender,Self,Context.Sender, andContext.Self.
The two needs to be separated because they need to be executed in step
| public INamedTypeSymbol? TaskType { get; } | ||
| } | ||
|
|
||
| public sealed class SystemThreadingTasksContext: ISystemThreadingTasksContext |
| return false; | ||
|
|
||
| // Property is equal to `ActorBase.Sender` or `IActorContext.Sender` | ||
| return ReferenceEquals(akkaContext.Actor.ActorBase.Sender, propertySymbol) || |
Fixes #71
Changes