Merge pull request github#7759 from hvitved/csharp/more-debug-context

hvitved · web-flow · commit ece952ae2de2 · 2022-01-27T09:40:21.000+01:00
C#: Add more debug context to various error messages
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Accessor.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Accessor.cs
@@ -42,7 +42,8 @@ public override void Populate(TextWriter trapFile)
             var prop = PropertySymbol;
             if (prop is null)
             {
-                Context.ModelError(Symbol, "Unhandled accessor associated symbol");
+                var type = Symbol.AssociatedSymbol?.GetType().ToString() ?? "null";
+                Context.ModelError(Symbol, $"Unhandled accessor associated symbol of type {type}");
                 return;
             }
 
@@ -61,7 +62,7 @@ public override void Populate(TextWriter trapFile)
             }
             else
             {
-                Context.ModelError(Symbol, "Unhandled accessor kind");
+                Context.ModelError(Symbol, $"Unhandled accessor method {Symbol.ToDisplayString()}");
                 return;
             }
 
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/EventAccessor.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/EventAccessor.cs
@@ -21,7 +21,8 @@ public override void Populate(TextWriter trapFile)
             var @event = EventSymbol;
             if (@event is null)
             {
-                Context.ModelError(Symbol, "Unhandled event accessor associated symbol");
+                var type = Symbol.AssociatedSymbol?.GetType().ToString() ?? "null";
+                Context.ModelError(Symbol, $"Unhandled event accessor associated symbol of type {type}");
                 return;
             }
 
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/Lambda.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/Lambda.cs
@@ -45,7 +45,7 @@ private Lambda(ExpressionNodeInfo info, CSharpSyntaxNode body, IEnumerable<Param
                 else if (body is BlockSyntax blockBody)
                     Statements.Block.Create(Context, blockBody, this, 0);
                 else
-                    Context.ModelError(body, "Unhandled lambda body");
+                    Context.ModelError(body, $"Unhandled lambda body of type {body.GetType()}");
             });
         }
 
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/MemberAccess.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/MemberAccess.cs
@@ -96,7 +96,7 @@ private static Expression Create(ExpressionNodeInfo info, ExpressionSyntax expre
                     kind = ExprKind.NAMESPACE_ACCESS;
                     break;
                 default:
-                    info.Context.ModelError(info.Node, "Unhandled symbol for member access");
+                    info.Context.ModelError(info.Node, $"Unhandled symbol for member access of kind {symbol.Kind}");
                     kind = ExprKind.UNKNOWN;
                     break;
             }
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/ObjectCreation/BaseObjectCreation.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/ObjectCreation/BaseObjectCreation.cs
@@ -43,7 +43,8 @@ protected override void PopulateExpression(TextWriter trapFile)
 
             if (Syntax.Initializer is not null)
             {
-                switch (Syntax.Initializer.Kind())
+                var kind = Syntax.Initializer.Kind();
+                switch (kind)
                 {
                     case SyntaxKind.CollectionInitializerExpression:
                         CollectionInitializer.Create(new ExpressionNodeInfo(Context, Syntax.Initializer, this, -1).SetType(Type));
@@ -52,7 +53,7 @@ protected override void PopulateExpression(TextWriter trapFile)
                         ObjectInitializer.Create(new ExpressionNodeInfo(Context, Syntax.Initializer, this, -1).SetType(Type));
                         break;
                     default:
-                        Context.ModelError(Syntax.Initializer, "Unhandled initializer in object creation");
+                        Context.ModelError(Syntax.Initializer, $"Unhandled initializer in object creation of kind {kind}");
                         break;
                 }
             }
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/Patterns/Pattern.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/Patterns/Pattern.cs
@@ -68,7 +68,7 @@ internal static Expression Create(Context cx, PatternSyntax syntax, IExpressionP
                         case DiscardDesignationSyntax discard:
                             return new Expressions.Discard(cx, discard, parent, child);
                         default:
-                            throw new InternalError("var pattern designation is unhandled");
+                            throw new InternalError($"var pattern designation of type {varPattern.Designation.GetType()} is unhandled");
                     }
 
                 case DiscardPatternSyntax dp:
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/VariableDeclaration.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Expressions/VariableDeclaration.cs
@@ -105,7 +105,8 @@ public static Expression CreateParenthesized(Context cx, VarPatternSyntax varPat
                             }
                             break;
                         default:
-                            throw new InternalError(variable, "Unhandled designation type");
+                            var type = variable.GetType().ToString() ?? "null";
+                            throw new InternalError(variable, $"Unhandled designation type {type}");
                     }
 
                     elementTypes.Add(sub.Type.HasValue && sub.Type.Value.Symbol?.Kind != SymbolKind.ErrorType
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/LineDirective.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/LineDirective.cs
@@ -13,7 +13,7 @@ private LineDirective(Context cx, LineDirectiveTriviaSyntax trivia)
                 SyntaxKind.DefaultKeyword => LineDirectiveKind.Default,
                 SyntaxKind.HiddenKeyword => LineDirectiveKind.Hidden,
                 SyntaxKind.NumericLiteralToken => LineDirectiveKind.Numeric,
-                _ => throw new InternalError(trivia, "Unhandled line token kind")
+                _ => throw new InternalError(trivia, $"Unhandled line token kind {trivia.Line.Kind()}")
             })
         {
         }
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/NullableDirective.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/PreprocessorDirectives/NullableDirective.cs
@@ -18,15 +18,15 @@ protected override void PopulatePreprocessor(TextWriter trapFile)
                 SyntaxKind.DisableKeyword => 0,
                 SyntaxKind.EnableKeyword => 1,
                 SyntaxKind.RestoreKeyword => 2,
-                _ => throw new InternalError(Symbol, "Unhandled setting token kind")
+                _ => throw new InternalError(Symbol, $"Unhandled setting token kind {Symbol.SettingToken.Kind()}")
             };
 
             var target = Symbol.TargetToken.Kind() switch
             {
                 SyntaxKind.None => 0,
                 SyntaxKind.AnnotationsKeyword => 1,
                 SyntaxKind.WarningsKeyword => 2,
-                _ => throw new InternalError(Symbol, "Unhandled target token kind")
+                _ => throw new InternalError(Symbol, $"Unhandled target token kind {Symbol.TargetToken.Kind()}")
             };
 
             trapFile.directive_nullables(this, setting, target);
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Statements/Case.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Statements/Case.cs
@@ -23,7 +23,7 @@ public static Statement Create(Context cx, SwitchLabelSyntax node, Switch parent
                 case SyntaxKind.CasePatternSwitchLabel:
                     return CasePattern.Create(cx, (CasePatternSwitchLabelSyntax)node, parent, child);
                 default:
-                    throw new InternalError(node, "Unhandled case label");
+                    throw new InternalError(node, $"Unhandled case label of kind {node.Kind()}");
             }
         }
     }
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Populators/TypeContainerVisitor.cs b/csharp/extractor/Semmle.Extraction.CSharp/Populators/TypeContainerVisitor.cs
@@ -36,7 +36,7 @@ public TypeContainerVisitor(Context cx, TextWriter trapFile, IEntity parent)
 
         public override void DefaultVisit(SyntaxNode node)
         {
-            throw new InternalError(node, "Unhandled top-level syntax node");
+            throw new InternalError(node, $"Unhandled top-level syntax node of type  {node.GetType()}");
         }
 
         public override void VisitGlobalStatement(GlobalStatementSyntax node)

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,8 @@ public override void Populate(TextWriter trapFile)`
`42`	`42`	`var prop = PropertySymbol;`
`43`	`43`	`if (prop is null)`
`44`	`44`	`{`
`45`		`- Context.ModelError(Symbol, "Unhandled accessor associated symbol");`
	`45`	`+ var type = Symbol.AssociatedSymbol?.GetType().ToString() ?? "null";`
	`46`	`+ Context.ModelError(Symbol, $"Unhandled accessor associated symbol of type {type}");`
`46`	`47`	`return;`
`47`	`48`	`}`
`48`	`49`
`@@ -61,7 +62,7 @@ public override void Populate(TextWriter trapFile)`
`61`	`62`	`}`
`62`	`63`	`else`
`63`	`64`	`{`
`64`		`- Context.ModelError(Symbol, "Unhandled accessor kind");`
	`65`	`+ Context.ModelError(Symbol, $"Unhandled accessor method {Symbol.ToDisplayString()}");`
`65`	`66`	`return;`
`66`	`67`	`}`
`67`	`68`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,8 @@ public override void Populate(TextWriter trapFile)`
`21`	`21`	`var @event = EventSymbol;`
`22`	`22`	`if (@event is null)`
`23`	`23`	`{`
`24`		`- Context.ModelError(Symbol, "Unhandled event accessor associated symbol");`
	`24`	`+ var type = Symbol.AssociatedSymbol?.GetType().ToString() ?? "null";`
	`25`	`+ Context.ModelError(Symbol, $"Unhandled event accessor associated symbol of type {type}");`
`25`	`26`	`return;`
`26`	`27`	`}`
`27`	`28`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ private Lambda(ExpressionNodeInfo info, CSharpSyntaxNode body, IEnumerable<Param`
`45`	`45`	`else if (body is BlockSyntax blockBody)`
`46`	`46`	`Statements.Block.Create(Context, blockBody, this, 0);`
`47`	`47`	`else`
`48`		`- Context.ModelError(body, "Unhandled lambda body");`
	`48`	`+ Context.ModelError(body, $"Unhandled lambda body of type {body.GetType()}");`
`49`	`49`	`});`
`50`	`50`	`}`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ private static Expression Create(ExpressionNodeInfo info, ExpressionSyntax expre`
`96`	`96`	`kind = ExprKind.NAMESPACE_ACCESS;`
`97`	`97`	`break;`
`98`	`98`	`default:`
`99`		`- info.Context.ModelError(info.Node, "Unhandled symbol for member access");`
	`99`	`+ info.Context.ModelError(info.Node, $"Unhandled symbol for member access of kind {symbol.Kind}");`
`100`	`100`	`kind = ExprKind.UNKNOWN;`
`101`	`101`	`break;`
`102`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,8 @@ protected override void PopulateExpression(TextWriter trapFile)`
`43`	`43`
`44`	`44`	`if (Syntax.Initializer is not null)`
`45`	`45`	`{`
`46`		`- switch (Syntax.Initializer.Kind())`
	`46`	`+ var kind = Syntax.Initializer.Kind();`
	`47`	`+ switch (kind)`
`47`	`48`	`{`
`48`	`49`	`case SyntaxKind.CollectionInitializerExpression:`
`49`	`50`	`CollectionInitializer.Create(new ExpressionNodeInfo(Context, Syntax.Initializer, this, -1).SetType(Type));`
`@@ -52,7 +53,7 @@ protected override void PopulateExpression(TextWriter trapFile)`
`52`	`53`	`ObjectInitializer.Create(new ExpressionNodeInfo(Context, Syntax.Initializer, this, -1).SetType(Type));`
`53`	`54`	`break;`
`54`	`55`	`default:`
`55`		`- Context.ModelError(Syntax.Initializer, "Unhandled initializer in object creation");`
	`56`	`+ Context.ModelError(Syntax.Initializer, $"Unhandled initializer in object creation of kind {kind}");`
`56`	`57`	`break;`
`57`	`58`	`}`
`58`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ internal static Expression Create(Context cx, PatternSyntax syntax, IExpressionP`
`68`	`68`	`case DiscardDesignationSyntax discard:`
`69`	`69`	`return new Expressions.Discard(cx, discard, parent, child);`
`70`	`70`	`default:`
`71`		`- throw new InternalError("var pattern designation is unhandled");`
	`71`	`+ throw new InternalError($"var pattern designation of type {varPattern.Designation.GetType()} is unhandled");`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`case DiscardPatternSyntax dp:`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,8 @@ public static Expression CreateParenthesized(Context cx, VarPatternSyntax varPat`
`105`	`105`	`}`
`106`	`106`	`break;`
`107`	`107`	`default:`
`108`		`- throw new InternalError(variable, "Unhandled designation type");`
	`108`	`+ var type = variable.GetType().ToString() ?? "null";`
	`109`	`+ throw new InternalError(variable, $"Unhandled designation type {type}");`
`109`	`110`	`}`
`110`	`111`
`111`	`112`	`elementTypes.Add(sub.Type.HasValue && sub.Type.Value.Symbol?.Kind != SymbolKind.ErrorType`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ private LineDirective(Context cx, LineDirectiveTriviaSyntax trivia)`
`13`	`13`	`SyntaxKind.DefaultKeyword => LineDirectiveKind.Default,`
`14`	`14`	`SyntaxKind.HiddenKeyword => LineDirectiveKind.Hidden,`
`15`	`15`	`SyntaxKind.NumericLiteralToken => LineDirectiveKind.Numeric,`
`16`		`- _ => throw new InternalError(trivia, "Unhandled line token kind")`
	`16`	`+ _ => throw new InternalError(trivia, $"Unhandled line token kind {trivia.Line.Kind()}")`
`17`	`17`	`})`
`18`	`18`	`{`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public static Statement Create(Context cx, SwitchLabelSyntax node, Switch parent`
`23`	`23`	`case SyntaxKind.CasePatternSwitchLabel:`
`24`	`24`	`return CasePattern.Create(cx, (CasePatternSwitchLabelSyntax)node, parent, child);`
`25`	`25`	`default:`
`26`		`- throw new InternalError(node, "Unhandled case label");`
	`26`	`+ throw new InternalError(node, $"Unhandled case label of kind {node.Kind()}");`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`	`}`