Make the scan timeout configurable via argument (#40)

Author: z4kn4fein

docs/configcat-scan.md

@@ -13,6 +13,7 @@ configcat scan ./dir -c <config-id> -l 5 --print
 | ------ | ----------- |
 | `--config-id`, `-c` | ID of the Config to scan against |
 | `--line-count`, `-l` | Context line count before and after the reference line (min: 1, max: 10) |
+| `--timeout`, `-to` | Scan timeout in seconds (default: 1800, min: 60) |
 | `--print`, `-p` | Print found references to output |
 | `--upload`, `-u` | Upload references to ConfigCat |
 | `--repo`, `-r` | Repository name. Mandatory for code reference upload |

src/ConfigCat.Cli.Services/Scan/FileScanner.cs

@@ -19,6 +19,7 @@ Task<IEnumerable<FlagReferenceResult>> ScanAsync(FlagModel[] flags,
         string[] matchPatterns,
         string[] usagePatterns,
         int contextLines,
+        TimeSpan timeout,
         List<string> warningTracker,
         CancellationToken token);
 }
@@ -40,17 +41,18 @@ public FileScanner(IReferenceCollector referenceCollector,
         this.aliasCollector = aliasCollector;
         this.botPolicy = botPolicy;
         this.output = output;
-        this.botPolicy.Configure(p => p.Timeout(t => t.After(TimeSpan.FromMinutes(30))));
     }
 
     public async Task<IEnumerable<FlagReferenceResult>> ScanAsync(FlagModel[] flags,
         FileInfo[] filesToScan,
         string[] matchPatterns,
         string[] usagePatterns,
         int contextLines,
+        TimeSpan timeout,
         List<string> warningTracker,
         CancellationToken token)
     {
+        this.botPolicy.Configure(p => p.Timeout(t => t.After(timeout)));
         using var spinner = this.output.CreateSpinner(token);
         return await this.botPolicy.ExecuteAsync(async (_, cancellation) =>
         {

src/ConfigCat.Cli/CommandBuilder.cs

@@ -1293,6 +1293,7 @@ private static CommandDescriptor BuildScanCommand() =>
             {
                 new Option<string>(["--config-id", "-c"], "ID of the Config to scan against"),
                 new Option<int>(["--line-count", "-l"], () => 4, "Context line count before and after the reference line (min: 1, max: 10)"),
+                new Option<int>(["--timeout", "-to"], () => 1800, "Scan timeout in seconds (default: 1800, min: 60)"),
                 new Option<bool>(["--print", "-p"], "Print found references to output"),
                 new Option<bool>(["--upload", "-u"], "Upload references to ConfigCat"),
                 new Option<string>(["--repo", "-r"], "Repository name. Mandatory for code reference upload"),

src/ConfigCat.Cli/CommandDescriptor.cs

@@ -16,13 +16,13 @@ public class CommandDescriptor(string name, string description, string example =
 
     public bool IsHidden { get; init; }
 
-    public IEnumerable<Option> Options { get; init; } = Enumerable.Empty<Option>();
+    public IEnumerable<Option> Options { get; init; } = [];
 
-    public IEnumerable<Argument> Arguments { get; init; } = Enumerable.Empty<Argument>();
+    public IEnumerable<Argument> Arguments { get; init; } = [];
 
-    public IEnumerable<string> Aliases { get; init; } = Enumerable.Empty<string>();
+    public IEnumerable<string> Aliases { get; init; } = [];
 
-    public IEnumerable<CommandDescriptor> SubCommands { get; init; } = Enumerable.Empty<CommandDescriptor>();
+    public IEnumerable<CommandDescriptor> SubCommands { get; init; } = [];
 
     public HandlerDescriptor Handler { get; init; }
 }

src/ConfigCat.Cli/Commands/Scan.cs

@@ -47,6 +47,7 @@ public async Task<int> InvokeAsync(DirectoryInfo directory,
         string[] aliasPatterns,
         string[] usagePatterns,
         string[] excludeFlagKeys,
+        int timeout,
         CancellationToken token)
     {
         if (upload && repo.IsEmpty())
@@ -67,6 +68,10 @@ public async Task<int> InvokeAsync(DirectoryInfo directory,
         lineCount = lineCount is < 0 or > 10
             ? 4
             : lineCount;
+        
+        timeout = timeout < 60
+            ? 60
+            : timeout;
 
         var flags = await flagClient.GetFlagsAsync(configId, token);
         if (excludeFlagKeys is {Length: > 0})
@@ -78,6 +83,8 @@ public async Task<int> InvokeAsync(DirectoryInfo directory,
         if (excludeFlagKeys is {Length: > 0})
             deletedFlags = deletedFlags.Where(f => !excludeFlagKeys.Contains(f.Key));
 
+        output.Verbose($"Scanning {directory} with {timeout}s timeout");
+        
         var gitRepoDir = await gitClient.GetRepoRootDirectoryOrNull(directory);
 
         var files = await fileCollector.CollectAsync(directory, gitRepoDir, token);
@@ -92,6 +99,7 @@ public async Task<int> InvokeAsync(DirectoryInfo directory,
             patternsFromEnv.Concat(aliasPatterns).ToArray(), 
             usagePatternsFromEnv.Concat(usagePatterns).ToArray(), 
             lineCount, 
+            TimeSpan.FromSeconds(timeout),
             warningTracker, 
             token);