Add support for timeout in process termination handling

Author: JanKrivanek

src/System.CommandLine.ApiCompatibility.Tests/ApiCompatibilityApprovalTests.System_CommandLine_api_is_not_changed.approved.txt

@@ -240,7 +240,7 @@ System.CommandLine.Builder
   public static class CommandLineBuilderExtensions
     public static CommandLineBuilder AddMiddleware(this CommandLineBuilder builder, System.CommandLine.Invocation.InvocationMiddleware middleware, System.CommandLine.Invocation.MiddlewareOrder order = Default)
     public static CommandLineBuilder AddMiddleware(this CommandLineBuilder builder, System.Action<System.CommandLine.Invocation.InvocationContext> onInvoke, System.CommandLine.Invocation.MiddlewareOrder order = Default)
-    public static CommandLineBuilder CancelOnProcessTermination(this CommandLineBuilder builder)
+    public static CommandLineBuilder CancelOnProcessTermination(this CommandLineBuilder builder, System.Nullable<System.TimeSpan> cancelationProcessingTimeout = null)
     public static CommandLineBuilder EnableDirectives(this CommandLineBuilder builder, System.Boolean value = True)
     public static CommandLineBuilder EnableLegacyDoubleDashBehavior(this CommandLineBuilder builder, System.Boolean value = True)
     public static CommandLineBuilder EnablePosixBundling(this CommandLineBuilder builder, System.Boolean value = True)

src/System.CommandLine.Tests/Invocation/CancelOnProcessTerminationTests.cs

@@ -20,7 +20,7 @@ public class CancelOnProcessTerminationTests
         private const int SIGTERM = 15;
 
         [LinuxOnlyTheory]
-        [InlineData(SIGINT, Skip = "https://github.com/dotnet/command-line-api/issues/1206")]  // Console.CancelKeyPress
+        [InlineData(SIGINT/*, Skip = "https://github.com/dotnet/command-line-api/issues/1206"*/)]  // Console.CancelKeyPress
         [InlineData(SIGTERM)] // AppDomain.CurrentDomain.ProcessExit
         public async Task CancelOnProcessTermination_cancels_on_process_termination(int signo)
         {
@@ -91,6 +91,83 @@ public async Task CancelOnProcessTermination_cancels_on_process_termination(int
             process.ExitCode.Should().Be(CancelledExitCode);
         }
 
+        [LinuxOnlyTheory]
+        [InlineData(null, SIGINT)]
+        [InlineData(100, SIGINT)]
+        [InlineData(null, SIGTERM)]
+        [InlineData(100, SIGTERM)]
+        public async Task CancelOnProcessTermination_timeout_on_cancel_processing(int? timeOutMs, int signo)
+        {
+            TimeSpan? timeOut = timeOutMs.HasValue ? TimeSpan.FromMilliseconds(timeOutMs.Value) : null; 
+
+            const string ChildProcessWaiting = "Waiting for the command to be cancelled";
+            const int CancelledExitCode = 42;
+            const int ForceTerminationCode = 130;
+
+            Func<string[], Task<int>> childProgram = (string[] args) =>
+            {
+                var command = new Command("the-command");
+
+                command.SetHandler(async context =>
+                {
+                    var cancellationToken = context.GetCancellationToken();
+
+                    try
+                    {
+                        context.Console.WriteLine(ChildProcessWaiting);
+                        await Task.Delay(int.MaxValue, cancellationToken);
+                        context.ExitCode = 1;
+                    }
+                    catch (OperationCanceledException)
+                    {
+                        // For Process.Exit handling the event must remain blocked as long as the
+                        // command is executed.
+                        // We are currently blocking that event because CancellationTokenSource.Cancel
+                        // is called from the event handler.
+                        // We'll do an async Task.Delay now. This means the Cancel call will return
+                        // and we're no longer actively blocking the event.
+                        // The event handler is responsible to continue blocking until the command
+                        // has finished executing. If it doesn't we won't get the CancelledExitCode.
+                        await Task.Delay(TimeSpan.FromMilliseconds(2000));
+
+                        context.ExitCode = CancelledExitCode;
+                    }
+
+                });
+
+                return new CommandLineBuilder(new RootCommand
+                       {
+                           command
+                       })
+                       .CancelOnProcessTermination(timeOut)
+                       .Build()
+                       .InvokeAsync("the-command");
+            };
+
+            using RemoteExecution program = RemoteExecutor.Execute(childProgram, psi: new ProcessStartInfo { RedirectStandardOutput = true });
+
+            Process process = program.Process;
+
+            // Wait for the child to be in the command handler.
+            string childState = await process.StandardOutput.ReadLineAsync();
+            childState.Should().Be(ChildProcessWaiting);
+
+            // Request termination
+            kill(process.Id, signo).Should().Be(0);
+
+            // Verify the process terminates timely
+            bool processExited = process.WaitForExit(10000);
+            if (!processExited)
+            {
+                process.Kill();
+                process.WaitForExit();
+            }
+            processExited.Should().Be(true);
+
+            // Verify the process exit code
+            process.ExitCode.Should().Be(timeOutMs.HasValue ? ForceTerminationCode : CancelledExitCode);
+        }
+
         [DllImport("libc", SetLastError = true)]
         private static extern int kill(int pid, int sig);
     }

src/System.CommandLine/Builder/CommandLineBuilderExtensions.cs

@@ -10,6 +10,7 @@
 using System.Linq;
 using System.Reflection;
 using System.Threading;
+using System.Threading.Tasks;
 using static System.Environment;
 using Process = System.CommandLine.Invocation.Process;
 
@@ -42,9 +43,21 @@ public static class CommandLineBuilderExtensions
         /// Enables signaling and handling of process termination via a <see cref="CancellationToken"/> that can be passed to a <see cref="ICommandHandler"/> during invocation.
         /// </summary>
         /// <param name="builder">A command line builder.</param>
+        /// <param name="cancelationProcessingTimeout">
+        /// Optional timeout for the command to process the exit cancellation.
+        /// If not passed, or passed null or non-positive timeout (including <see cref="Timeout.InfiniteTimeSpan"/>), no timeout is enforced.
+        /// If positive value is passed - command is forcefully terminated after the timeout with exit code 130 (as if <see cref="CancelOnProcessTermination"/> was not called).
+        /// Host enforced timeout for ProcessExit event cannot be extended - default is 2 seconds: https://docs.microsoft.com/en-us/dotnet/api/system.appdomain.processexit?view=net-6.0.
+        /// </param>
         /// <returns>The same instance of <see cref="CommandLineBuilder"/>.</returns>
-        public static CommandLineBuilder CancelOnProcessTermination(this CommandLineBuilder builder)
+        public static CommandLineBuilder CancelOnProcessTermination(
+            this CommandLineBuilder builder, 
+            TimeSpan? cancelationProcessingTimeout = null)
         {
+            cancelationProcessingTimeout ??= Timeout.InfiniteTimeSpan;
+            // https://tldp.org/LDP/abs/html/exitcodes.html - 130 - script terminated by ctrl-c
+            const int SIGINT_EXIT_CODE = 130;
+
             builder.AddMiddleware(async (context, next) =>
             {
                 bool cancellationHandlingAdded = false;
@@ -56,24 +69,42 @@ public static CommandLineBuilder CancelOnProcessTermination(this CommandLineBuil
                 {
                     blockProcessExit = new ManualResetEventSlim(initialState: false);
                     cancellationHandlingAdded = true;
-                    consoleHandler = (_, args) =>
-                    {
-                        cts.Cancel();
-                        // Stop the process from terminating.
-                        // Since the context was cancelled, the invocation should
-                        // finish and Main will return.
-                        args.Cancel = true;
-                    };
+                    // Default limit for ProcesExit handler is 2 seconds
+                    //  https://docs.microsoft.com/en-us/dotnet/api/system.appdomain.processexit?view=net-6.0
                     processExitHandler = (_, _) =>
                     {
                         cts.Cancel();
                         // The process exits as soon as the event handler returns.
                         // We provide a return value using Environment.ExitCode
                         // because Main will not finish executing.
                         // Wait for the invocation to finish.
-                        blockProcessExit.Wait();
+                        if (!blockProcessExit.Wait(cancelationProcessingTimeout > TimeSpan.Zero
+                                ? cancelationProcessingTimeout.Value
+                                : Timeout.InfiniteTimeSpan))
+                        {
+                            context.ExitCode = SIGINT_EXIT_CODE;
+                        }
                         ExitCode = context.ExitCode;
                     };
+                    consoleHandler = (_, args) =>
+                    {
+                        cts.Cancel();
+                        // Stop the process from terminating.
+                        // Since the context was cancelled, the invocation should
+                        // finish and Main will return.
+                        args.Cancel = true;
+                        if (cancelationProcessingTimeout! > TimeSpan.Zero)
+                        {
+                            Task
+                                .Delay(cancelationProcessingTimeout.Value, default)
+                                .ContinueWith(t =>
+                                {
+                                    // Prevent our ProcessExit from intervene and block the exit
+                                    AppDomain.CurrentDomain.ProcessExit -= processExitHandler;
+                                    Environment.Exit(SIGINT_EXIT_CODE);
+                                }, (CancellationToken)default);
+                        }
+                    };
                     Console.CancelKeyPress += consoleHandler;
                     AppDomain.CurrentDomain.ProcessExit += processExitHandler;
                 };