Add timeout parameter (#1006)

Author: joshua-siw

dev-proxy-abstractions/IProxyConfiguration.cs

@@ -21,4 +21,5 @@ public interface IProxyConfiguration
     IEnumerable<int> WatchPids { get; }
     IEnumerable<string> WatchProcessNames { get; }
     bool ShowTimestamps { get; }
+    long? TimeoutSeconds { get; }
 }

dev-proxy/CommandHandlers/ProxyCommandHandler.cs

@@ -135,6 +135,11 @@ private void ParseOptions(InvocationContext context)
         {
             Configuration.InstallCert = installCert.Value;
         }
+        var timeout = context.ParseResult.GetValueForOption<long?>(ProxyHost.TimeoutOptionName, _options);
+        if (timeout is not null)
+        {
+            Configuration.TimeoutSeconds = timeout.Value;
+        }
     }
 
     private async Task CheckForNewVersionAsync()

dev-proxy/InactivityTimer.cs

@@ -0,0 +1,13 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+namespace DevProxy;
+
+internal class InactivityTimer(long timeoutSeconds, Action timeoutAction)
+{
+    private readonly TimeSpan _timeout = TimeSpan.FromSeconds(timeoutSeconds);
+    private readonly Timer _timer = new(_ => timeoutAction.Invoke(), null, TimeSpan.FromSeconds(timeoutSeconds), Timeout.InfiniteTimeSpan);
+    public void Reset() => _timer.Change(_timeout, Timeout.InfiniteTimeSpan);
+    public void Stop() => _timer.Dispose();
+}

dev-proxy/Properties/launchSettings.json

@@ -45,6 +45,10 @@
     "Jwt create": {
       "commandName": "Project",
       "commandLineArgs": "jwt create"
+    },
+    "Timeout": {
+      "commandName": "Project",
+      "commandLineArgs": "--timeout 30"
     }
   }
 }

dev-proxy/ProxyConfiguration.cs

@@ -39,4 +39,5 @@ public class ProxyConfiguration : IProxyConfiguration
     public int ApiPort { get; set; } = 8897;
     public bool ShowSkipMessages { get; set; } = true;
     public bool ShowTimestamps { get; set; } = true;
+    public long? TimeoutSeconds { get; set; }
 }

dev-proxy/ProxyEngine.cs

@@ -38,6 +38,7 @@ public class ProxyEngine(IProxyConfiguration config, ISet<UrlToWatch> urlsToWatc
     // Dictionary for plugins to store data between requests
     // the key is HashObject of the SessionEventArgs object
     private readonly Dictionary<int, Dictionary<string, object>> _pluginData = [];
+    private InactivityTimer? _inactivityTimer;
 
     public static X509Certificate2? Certificate => _proxyServer?.CertificateManager.RootCertificate;
 
@@ -160,7 +161,12 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
             StartRecording();
         }
         _pluginEvents.AfterRequestLog += AfterRequestLogAsync;
-
+        
+        if (config.TimeoutSeconds.HasValue)
+        {
+            _inactivityTimer = new InactivityTimer(config.TimeoutSeconds.Value, _proxyState.StopProxy);
+        }
+        
         if (!isInteractive)
         {
             return;
@@ -343,6 +349,8 @@ private void StopProxy()
                 }
             }
 
+            _inactivityTimer?.Stop();
+
             if (RunTime.IsMac && _config.AsSystemProxy)
             {
                 ToggleSystemProxy(ToggleSystemProxyAction.Off);
@@ -453,6 +461,7 @@ private bool IsProxiedProcess(TunnelConnectSessionEventArgs e)
 
     async Task OnRequestAsync(object sender, SessionEventArgs e)
     {
+        _inactivityTimer?.Reset();
         if (IsProxiedHost(e.HttpClient.Request.RequestUri.Host) &&
             IsIncludedByHeaders(e.HttpClient.Request.Headers))
         {

dev-proxy/ProxyHost.cs

@@ -35,6 +35,8 @@ internal class ProxyHost
     private readonly Option<bool?> _installCertOption;
     internal static readonly string UrlsToWatchOptionName = "--urls-to-watch";
     private static Option<IEnumerable<string>?>? _urlsToWatchOption;
+    internal static readonly string TimeoutOptionName = "--timeout";
+    private readonly Option<long?> _timeoutOption;
 
     private static bool _configFileResolved = false;
     private static string _configFile = "devproxyrc.json";
@@ -268,6 +270,26 @@ public ProxyHost()
             Arity = ArgumentArity.ZeroOrMore
         };
         _urlsToWatchOption.AddAlias("-u");
+        
+        _timeoutOption = new Option<long?>(TimeoutOptionName, "Time in seconds after which Dev Proxy exits. Resets when Dev Proxy intercepts a request.")
+        {
+            ArgumentHelpName = "timeout",
+        };
+        _timeoutOption.AddValidator(input =>
+        {
+            try
+            {
+                if (!long.TryParse(input.Tokens[0].Value, out long timeoutInput) || timeoutInput < 1)
+                {
+                    input.ErrorMessage = $"{input.Tokens[0].Value} is not valid as a timeout value";
+                }
+            }
+            catch (InvalidOperationException ex)
+            {
+                input.ErrorMessage = ex.Message;
+            }
+        });
+        _timeoutOption.AddAlias("-t");
 
         ProxyCommandHandler.Configuration.ConfigFile = ConfigFile;
     }
@@ -291,7 +313,8 @@ public RootCommand GetRootCommand(ILogger logger)
             _installCertOption,
             // _urlsToWatchOption is set while initialize the Program
             // As such, it's always set here
-            _urlsToWatchOption!
+            _urlsToWatchOption!,
+            _timeoutOption
         };
         command.Description = "Dev Proxy is a command line tool for testing Microsoft Graph, SharePoint Online and any other HTTP APIs.";
 
@@ -457,6 +480,7 @@ public RootCommand GetRootCommand(ILogger logger)
             _noFirstRunOption,
             _asSystemProxyOption,
             _installCertOption,
+            _timeoutOption,
             .. optionsFromPlugins,
         ],
         urlsToWatch,

schemas/v0.25.0/rc.schema.json

@@ -134,6 +134,10 @@
     },
     "showTimestamps": {
       "type": "boolean"
+    },
+    "timeout": {
+      "type": "number",
+      "minimum": 1
     }
   },
   "required": [