Make dotnet restore timeout configurable (#31)

Author: sagi1623

ScipDotnet/IndexCommandHandler.cs

@@ -12,7 +12,7 @@ namespace ScipDotnet;
 public static class IndexCommandHandler
 {
     public static async Task<int> Process(IHost host, List<FileInfo> projects, string output, FileInfo workingDirectory,
-        List<string> include, List<string> exclude, bool allowGlobalSymbolDefinitions)
+        List<string> include, List<string> exclude, bool allowGlobalSymbolDefinitions, int dotnetRestoreTimeout)
     {
         var logger = host.Services.GetRequiredService<ILogger<IndexCommandOptions>>();
         var matcher = new Matcher();
@@ -33,7 +33,8 @@ public static async Task<int> Process(IHost host, List<FileInfo> projects, strin
             projectFiles,
             logger,
             matcher,
-            allowGlobalSymbolDefinitions
+            allowGlobalSymbolDefinitions,
+            dotnetRestoreTimeout
         );
         await ScipIndex(host, options);
         return 0;

ScipDotnet/IndexCommandOptions.cs

@@ -9,5 +9,6 @@ public record IndexCommandOptions(
     List<FileInfo> ProjectsFile,
     ILogger<IndexCommandOptions> Logger,
     Matcher Matcher,
-    bool AllowGlobalSymbolDefinitions
+    bool AllowGlobalSymbolDefinitions,
+    int DotnetRestoreTimeout
 );

ScipDotnet/Program.cs

@@ -15,6 +15,8 @@ namespace ScipDotnet;
 
 public static class Program
 {
+    private const int DotnetRestoreTimeout = 300000;
+
     public static async Task<int> Main(string[] args)
     {
         var indexCommand = new Command("index", "Index a solution file")
@@ -38,7 +40,9 @@ public static async Task<int> Main(string[] args)
             },
             new Option<bool>("--allow-global-symbol-definitions", () => false,
                 "If enabled, allow public symbol definitions to be accessible from other SCIP indexes. " +
-                "If disabled, then public symbols will only be visible within the index.")
+                "If disabled, then public symbols will only be visible within the index."),
+            new Option<int>("--dotnet-restore-timeout", () => DotnetRestoreTimeout,
+                @"The timeout (in ms) for the ""dotnet restore"" command")
         };
         indexCommand.Handler = CommandHandler.Create(IndexCommandHandler.Process);
         var rootCommand =

ScipDotnet/ScipCSharpSyntaxWalker.cs

@@ -94,14 +94,12 @@ public override void VisitStructDeclaration(StructDeclarationSyntax node)
         base.VisitStructDeclaration(node);
     }
 
-
     public override void VisitVariableDeclarator(VariableDeclaratorSyntax node)
     {
         _scipDocumentIndexer.VisitOccurrence(_semanticModel.GetDeclaredSymbol(node), node.Identifier.GetLocation(), true);
         base.VisitVariableDeclarator(node);
     }
 
-
     public override void VisitEnumMemberDeclaration(EnumMemberDeclarationSyntax node)
     {
         _scipDocumentIndexer.VisitOccurrence(_semanticModel.GetDeclaredSymbol(node), node.Identifier.GetLocation(), true);

ScipDotnet/ScipDocumentIndexer.cs

@@ -104,7 +104,6 @@ private ScipSymbol CreateScipSymbol(ISymbol? sym)
         return result;
     }
 
-
     private ScipSymbol CreateLocalScipSymbol(ISymbol sym)
     {
         var local = _locals.GetValueOrDefault(sym, ScipSymbol.Empty);
@@ -202,19 +201,17 @@ private static string MethodDisambiguator(ISymbol sym)
 
     private readonly string[] _isIgnoredRelationshipSymbol =
     {
-    " System/Object#",
-    " System/Enum#",
-    " System/ValueType#",
-};
+        " System/Object#",
+        " System/Enum#",
+        " System/ValueType#",
+    };
 
     // Returns true if this symbol should not be emitted as a SymbolInformation relationship symbol.
     // The reason we ignore these symbols is because they appear automatically for a large number of
     // symbols putting pressure on our backend to index the inverted index. It's not particularly useful anyways
     // to query all the implementations of something like System/Object#.
-    private bool IsIgnoredRelationshipSymbol(string symbol)
-    {
-        return _isIgnoredRelationshipSymbol.Any(symbol.EndsWith);
-    }
+    private bool IsIgnoredRelationshipSymbol(string symbol) =>
+        _isIgnoredRelationshipSymbol.Any(symbol.EndsWith);
 
     public void VisitOccurrence(ISymbol? symbol, Location location, bool isDefinition)
     {
@@ -326,7 +323,6 @@ public void VisitOccurrence(ISymbol? symbol, Location location, bool isDefinitio
         }
     }
 
-
     // Returns explicitly and implicitly implemented interface methods by the given symbol method.
     // The Roslyn API has a `ExplicitInterfaceImplementations` that does not return implicitly implemented
     // methods.
@@ -345,22 +341,27 @@ private static IEnumerable<ISymbol> InterfaceImplementations(IMethodSymbol symbo
         }
     }
 
-
     // Converts a Roslyn location into a SCIP range.
     private static IEnumerable<int> LocationToRange(Location location)
     {
         var span = location.GetMappedLineSpan();
         if (span.StartLinePosition.Line == span.EndLinePosition.Line)
         {
             return new[]
-                { span.StartLinePosition.Line, span.StartLinePosition.Character, span.EndLinePosition.Character };
+                {
+                    span.StartLinePosition.Line,
+                    span.StartLinePosition.Character,
+                    span.EndLinePosition.Character
+                };
         }
 
         return new[]
-        {
-        span.StartLinePosition.Line, span.StartLinePosition.Character, span.EndLinePosition.Line,
-        span.EndLinePosition.Character
-    };
+            {
+                span.StartLinePosition.Line,
+                span.StartLinePosition.Character,
+                span.EndLinePosition.Line,
+                span.EndLinePosition.Character
+            };
     }
 
     private static bool IsLocalSymbol(ISymbol sym)

ScipDotnet/ScipProjectIndexer.cs

@@ -13,14 +13,12 @@ namespace ScipDotnet;
 /// </summary>
 public class ScipProjectIndexer
 {
-    private const int DotnetRestoreTimeout = 3000;
-
     public ScipProjectIndexer(ILogger<ScipProjectIndexer> logger) =>
         Logger = logger;
 
     private ILogger<ScipProjectIndexer> Logger { get; }
 
-    private static void Restore(IndexCommandOptions options, FileInfo project)
+    private void Restore(IndexCommandOptions options, FileInfo project)
     {
         var arguments = project.Extension.Equals(".sln") ? $"restore {project.FullName}" : "restore";
         var process = new Process()
@@ -34,7 +32,10 @@ private static void Restore(IndexCommandOptions options, FileInfo project)
         };
         options.Logger.LogInformation("$ dotnet {Arguments}", arguments);
         process.Start();
-        process.WaitForExit(DotnetRestoreTimeout);
+        if (!process.WaitForExit(options.DotnetRestoreTimeout))
+        {
+            Logger.LogWarning("Dotnet restore did not finish in {Time} milliseconds, the results of the indexing might be incorrect.", options.DotnetRestoreTimeout);
+        }
     }
 
     public async IAsyncEnumerable<Scip.Document> IndexDocuments(IHost host, IndexCommandOptions options)