C#: Extract modifiers for lambdas (async, static)

tamasvajk · tamasvajk · commit 55d47a70f491 · 2020-11-26T16:12:18.000+01:00
diff --git a/csharp/change-notes/2020-11-18-lambda-modifiers.md b/csharp/change-notes/2020-11-18-lambda-modifiers.md
@@ -0,0 +1,2 @@
+lgtm,codescanning
+* The `AnonymousFunctionExpr` class now extends `Modifiable`. This change allows storing the `async` modifier for lambdas, which was missing before, and the `static` modifier, which was added in C# 9.
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/Lambda.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/Lambda.cs
@@ -24,6 +24,18 @@ private void VisitParameter(ParameterSyntax p)
         private Lambda(ExpressionNodeInfo info, CSharpSyntaxNode body, IEnumerable<ParameterSyntax> @params)
             : base(info)
         {
+            var symbol = cx.GetModel(info.Node).GetSymbolInfo(info.Node).Symbol as IMethodSymbol;
+
+            if (symbol is object)
+            {
+                Modifier.ExtractStaticModifier(cx, info.Context.TrapWriter.Writer, this, symbol);
+                Modifier.ExtractAsyncModifier(cx, info.Context.TrapWriter.Writer, this, symbol);
+            }
+            else
+            {
+                cx.ModelError(info.Node, "Unknown declared symbol");
+            }
+
             // No need to use `Populate` as the population happens later
             cx.PopulateLater(() =>
             {
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Modifier.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Modifier.cs
@@ -86,10 +86,7 @@ public static void ExtractModifiers(Context cx, TextWriter trapFile, IEntity key
             if (symbol.IsSealed)
                 HasModifier(cx, trapFile, key, "sealed");
 
-            var fromSource = symbol.DeclaringSyntaxReferences.Length > 0;
-
-            if (symbol.IsStatic && !(symbol.Kind == SymbolKind.Field && ((IFieldSymbol)symbol).IsConst && !fromSource))
-                HasModifier(cx, trapFile, key, "static");
+            ExtractStaticModifier(cx, trapFile, key, symbol);
 
             if (symbol.IsVirtual)
                 HasModifier(cx, trapFile, key, "virtual");
@@ -104,8 +101,7 @@ public static void ExtractModifiers(Context cx, TextWriter trapFile, IEntity key
             if (symbol.IsOverride)
                 HasModifier(cx, trapFile, key, "override");
 
-            if (symbol.Kind == SymbolKind.Method && ((IMethodSymbol)symbol).IsAsync)
-                HasModifier(cx, trapFile, key, "async");
+            ExtractAsyncModifier(cx, trapFile, key, symbol);
 
             if (symbol.IsExtern)
                 HasModifier(cx, trapFile, key, "extern");
@@ -129,6 +125,20 @@ public static void ExtractModifiers(Context cx, TextWriter trapFile, IEntity key
             }
         }
 
+        public static void ExtractAsyncModifier(Context cx, TextWriter trapFile, IEntity key, ISymbol symbol)
+        {
+            if (symbol.Kind == SymbolKind.Method && ((IMethodSymbol)symbol).IsAsync)
+                HasModifier(cx, trapFile, key, "async");
+        }
+
+        public static void ExtractStaticModifier(Context cx, TextWriter trapFile, IEntity key, ISymbol symbol)
+        {
+            var fromSource = symbol.DeclaringSyntaxReferences.Length > 0;
+
+            if (symbol.IsStatic && !(symbol.Kind == SymbolKind.Field && ((IFieldSymbol)symbol).IsConst && !fromSource))
+                HasModifier(cx, trapFile, key, "static");
+        }
+
         public static Modifier Create(Context cx, string modifier)
         {
             return ModifierFactory.Instance.CreateEntity(cx, (typeof(Modifier), modifier), modifier);
diff --git a/csharp/ql/src/semmle/code/csharp/exprs/Creation.qll b/csharp/ql/src/semmle/code/csharp/exprs/Creation.qll
@@ -407,7 +407,7 @@ class Stackalloc extends ArrayCreation {
  * An anonymous function. Either a lambda expression (`LambdaExpr`) or an
  * anonymous method expression (`AnonymousMethodExpr`).
  */
-class AnonymousFunctionExpr extends Expr, Callable, @anonymous_function_expr {
+class AnonymousFunctionExpr extends Expr, Callable, Modifiable, @anonymous_function_expr {
   override string getName() { result = "<anonymous>" }
 
   override Type getReturnType() {
diff --git a/csharp/ql/src/semmlecode.csharp.dbscheme b/csharp/ql/src/semmlecode.csharp.dbscheme
@@ -541,7 +541,7 @@ specific_type_parameter_nullability(
 
 @modifiable = @modifiable_direct | @event_accessor;
 
-@modifiable_direct = @member | @accessor | @local_function;
+@modifiable_direct = @member | @accessor | @local_function | @anonymous_function_expr;
 
 modifiers(
   unique int id: @modifier,
diff --git a/csharp/ql/test/library-tests/csharp9/Discard.expected b/csharp/ql/test/library-tests/csharp9/Discard.expected
@@ -6,3 +6,6 @@
 | Discard.cs:9:13:9:32 | (...) => ... | Discard.cs:9:25:9:25 | _`1 |
 | Discard.cs:10:13:10:49 | delegate(...) { ... } | Discard.cs:10:27:10:27 | _ |
 | Discard.cs:10:13:10:49 | delegate(...) { ... } | Discard.cs:10:34:10:34 | _`1 |
+| LambdaModifier.cs:11:11:11:27 | (...) => ... | LambdaModifier.cs:11:18:11:18 | x |
+| LambdaModifier.cs:12:11:12:20 | (...) => ... | LambdaModifier.cs:12:11:12:11 | x |
+| LambdaModifier.cs:13:11:13:51 | delegate(...) { ... } | LambdaModifier.cs:13:32:13:32 | x |
diff --git a/csharp/ql/test/library-tests/csharp9/LambdaModifier.cs b/csharp/ql/test/library-tests/csharp9/LambdaModifier.cs
@@ -0,0 +1,17 @@
+using System;
+using System.Threading.Tasks;
+
+public class Class1
+{
+    public async Task M1()
+    {
+        void m(Func<int, int> f) { }
+
+        const int z = 10;
+        m(static x => x + z);
+        m(x => x + z);
+        m(static delegate (int x) { return x + z; });
+
+        await Task.Run(async () => { await Task.CompletedTask; });
+    }
+}
diff --git a/csharp/ql/test/library-tests/csharp9/LambdaModifier.expected b/csharp/ql/test/library-tests/csharp9/LambdaModifier.expected
@@ -0,0 +1,3 @@
+| LambdaModifier.cs:11:11:11:27 | (...) => ... | static |
+| LambdaModifier.cs:13:11:13:51 | delegate(...) { ... } | static |
+| LambdaModifier.cs:15:24:15:64 | (...) => ... | async |
diff --git a/csharp/ql/test/library-tests/csharp9/LambdaModifier.ql b/csharp/ql/test/library-tests/csharp9/LambdaModifier.ql
@@ -0,0 +1,5 @@
+import csharp
+
+from AnonymousFunctionExpr anon, string modifier
+where anon.hasModifier(modifier)
+select anon, modifier
diff --git a/csharp/ql/test/library-tests/csharp9/LocalFunctions.expected b/csharp/ql/test/library-tests/csharp9/LocalFunctions.expected
@@ -1,6 +1,7 @@
 noBody
 | LocalFunction.cs:16:9:16:41 | localExtern |
 localFunctionModifier
+| LambdaModifier.cs:8:9:8:36 | m | private |
 | LocalFunction.cs:9:9:12:9 | mul | async |
 | LocalFunction.cs:9:9:12:9 | mul | private |
 | LocalFunction.cs:16:9:16:41 | localExtern | extern |
diff --git a/csharp/ql/test/library-tests/csharp9/PrintAst.expected b/csharp/ql/test/library-tests/csharp9/PrintAst.expected
@@ -47,6 +47,66 @@ Discard.cs:
 #   10|             4: [BlockStmt] {...}
 #   10|               0: [ReturnStmt] return ...;
 #   10|                 0: [IntLiteral] 0
+LambdaModifier.cs:
+#    4| [Class] Class1
+#    6|   5: [Method] M1
+#    6|     -1: [TypeMention] Task
+#    7|     4: [BlockStmt] {...}
+#    8|       0: [LocalFunctionStmt] m(...)
+#    8|         0: [LocalFunction] m
+#-----|           2: (Parameters)
+#    8|             0: [Parameter] f
+#    8|               -1: [TypeMention] Func<Int32, Int32>
+#    8|                 1: [TypeMention] int
+#    8|                 2: [TypeMention] int
+#    8|           4: [BlockStmt] {...}
+#   10|       1: [LocalConstantDeclStmt] const ... ...;
+#   10|         0: [LocalVariableDeclAndInitExpr] Int32 z = ...
+#   10|           -1: [TypeMention] int
+#   10|           0: [LocalVariableAccess] access to local variable z
+#   10|           1: [IntLiteral] 10
+#   11|       2: [ExprStmt] ...;
+#   11|         0: [LocalFunctionCall] call to local function m
+#   11|           -1: [LocalFunctionAccess] access to local function m
+#   11|           0: [LambdaExpr] (...) => ...
+#-----|             2: (Parameters)
+#   11|               0: [Parameter] x
+#   11|             4: [AddExpr] ... + ...
+#   11|               0: [ParameterAccess] access to parameter x
+#   11|               1: [LocalVariableAccess] access to local variable z
+#   12|       3: [ExprStmt] ...;
+#   12|         0: [LocalFunctionCall] call to local function m
+#   12|           -1: [LocalFunctionAccess] access to local function m
+#   12|           0: [LambdaExpr] (...) => ...
+#-----|             2: (Parameters)
+#   12|               0: [Parameter] x
+#   12|             4: [AddExpr] ... + ...
+#   12|               0: [ParameterAccess] access to parameter x
+#   12|               1: [LocalVariableAccess] access to local variable z
+#   13|       4: [ExprStmt] ...;
+#   13|         0: [LocalFunctionCall] call to local function m
+#   13|           -1: [LocalFunctionAccess] access to local function m
+#   13|           0: [AnonymousMethodExpr] delegate(...) { ... }
+#-----|             2: (Parameters)
+#   13|               0: [Parameter] x
+#   13|                 -1: [TypeMention] int
+#   13|             4: [BlockStmt] {...}
+#   13|               0: [ReturnStmt] return ...;
+#   13|                 0: [AddExpr] ... + ...
+#   13|                   0: [ParameterAccess] access to parameter x
+#   13|                   1: [LocalVariableAccess] access to local variable z
+#   15|       5: [ExprStmt] ...;
+#   15|         0: [AwaitExpr] await ...
+#   15|           0: [MethodCall] call to method Run
+#   15|             -1: [TypeAccess] access to type Task
+#   15|               0: [TypeMention] Task
+#   15|             0: [LambdaExpr] (...) => ...
+#   15|               4: [BlockStmt] {...}
+#   15|                 0: [ExprStmt] ...;
+#   15|                   0: [AwaitExpr] await ...
+#   15|                     0: [PropertyCall] access to property CompletedTask
+#   15|                       -1: [TypeAccess] access to type Task
+#   15|                         0: [TypeMention] Task
 LocalFunction.cs:
 #    4| [Class] LocalFunction
 #    6|   5: [Method] M1
diff --git a/csharp/upgrades/TO_CHANGE/upgrade.properties b/csharp/upgrades/TO_CHANGE/upgrade.properties
@@ -0,0 +1,2 @@
+description: Added 'anonymous_function_expr' to 'modifiable_direct'.
+compatibility: backwards

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+lgtm,codescanning`
	`2`	+* The `AnonymousFunctionExpr` class now extends `Modifiable`. This change allows storing the `async` modifier for lambdas, which was missing before, and the `static` modifier, which was added in C# 9.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+\| LambdaModifier.cs:11:11:11:27 \| (...) => ... \| static \|`
	`2`	`+\| LambdaModifier.cs:13:11:13:51 \| delegate(...) { ... } \| static \|`
	`3`	`+\| LambdaModifier.cs:15:24:15:64 \| (...) => ... \| async \|`