Merge pull request #10378 from Bond-009/waitforexitasync

Use Process.WaitForExitAsync added in .NET 5
This commit is contained in:
Claus Vium 2023-10-10 20:12:07 +02:00 committed by GitHub
commit 733ee12ee4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 46 additions and 126 deletions

View File

@ -15,65 +15,13 @@ namespace MediaBrowser.Common.Extensions
/// </summary> /// </summary>
/// <param name="process">The process to wait for.</param> /// <param name="process">The process to wait for.</param>
/// <param name="timeout">The duration to wait before cancelling waiting for the task.</param> /// <param name="timeout">The duration to wait before cancelling waiting for the task.</param>
/// <returns>True if the task exited normally, false if the timeout elapsed before the process exited.</returns> /// <returns>A task that will complete when the process has exited, cancellation has been requested, or an error occurs.</returns>
/// <exception cref="InvalidOperationException">If <see cref="Process.EnableRaisingEvents"/> is not set to true for the process.</exception> /// <exception cref="OperationCanceledException">The timeout ended.</exception>
public static async Task<bool> WaitForExitAsync(this Process process, TimeSpan timeout) public static async Task WaitForExitAsync(this Process process, TimeSpan timeout)
{ {
using (var cancelTokenSource = new CancellationTokenSource(timeout)) using (var cancelTokenSource = new CancellationTokenSource(timeout))
{ {
return await WaitForExitAsync(process, cancelTokenSource.Token).ConfigureAwait(false); await process.WaitForExitAsync(cancelTokenSource.Token).ConfigureAwait(false);
}
}
/// <summary>
/// Asynchronously wait for the process to exit.
/// </summary>
/// <param name="process">The process to wait for.</param>
/// <param name="cancelToken">A <see cref="CancellationToken"/> to observe while waiting for the process to exit.</param>
/// <returns>True if the task exited normally, false if cancelled before the process exited.</returns>
public static async Task<bool> WaitForExitAsync(this Process process, CancellationToken cancelToken)
{
if (!process.EnableRaisingEvents)
{
throw new InvalidOperationException("EnableRisingEvents must be enabled to async wait for a task to exit.");
}
// Add an event handler for the process exit event
var tcs = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
process.Exited += (_, _) => tcs.TrySetResult(true);
// Return immediately if the process has already exited
if (process.HasExitedSafe())
{
return true;
}
// Register with the cancellation token then await
using (var cancelRegistration = cancelToken.Register(() => tcs.TrySetResult(process.HasExitedSafe())))
{
return await tcs.Task.ConfigureAwait(false);
}
}
/// <summary>
/// Gets a value indicating whether the associated process has been terminated using
/// <see cref="Process.HasExited"/>. This is safe to call even if there is no operating system process
/// associated with the <see cref="Process"/>.
/// </summary>
/// <param name="process">The process to check the exit status for.</param>
/// <returns>
/// True if the operating system process referenced by the <see cref="Process"/> component has
/// terminated, or if there is no associated operating system process; otherwise, false.
/// </returns>
private static bool HasExitedSafe(this Process process)
{
try
{
return process.HasExited;
}
catch (InvalidOperationException)
{
return true;
} }
} }
} }

View File

@ -174,22 +174,16 @@ namespace MediaBrowser.MediaEncoding.Attachments
process.Start(); process.Start();
var ranToCompletion = await ProcessExtensions.WaitForExitAsync(process, cancellationToken).ConfigureAwait(false); try
if (!ranToCompletion)
{ {
try await process.WaitForExitAsync(cancellationToken).ConfigureAwait(false);
{ exitCode = process.ExitCode;
_logger.LogWarning("Killing ffmpeg attachment extraction process"); }
process.Kill(); catch (OperationCanceledException)
} {
catch (Exception ex) process.Kill(true);
{ exitCode = -1;
_logger.LogError(ex, "Error killing attachment extraction process");
}
} }
exitCode = ranToCompletion ? process.ExitCode : -1;
} }
var failed = false; var failed = false;
@ -322,22 +316,16 @@ namespace MediaBrowser.MediaEncoding.Attachments
process.Start(); process.Start();
var ranToCompletion = await ProcessExtensions.WaitForExitAsync(process, cancellationToken).ConfigureAwait(false); try
if (!ranToCompletion)
{ {
try await process.WaitForExitAsync(cancellationToken).ConfigureAwait(false);
{ exitCode = process.ExitCode;
_logger.LogWarning("Killing ffmpeg attachment extraction process"); }
process.Kill(); catch (OperationCanceledException)
} {
catch (Exception ex) process.Kill(true);
{ exitCode = -1;
_logger.LogError(ex, "Error killing attachment extraction process");
}
} }
exitCode = ranToCompletion ? process.ExitCode : -1;
} }
var failed = false; var failed = false;

View File

@ -752,11 +752,15 @@ namespace MediaBrowser.MediaEncoding.Encoder
timeoutMs = enableHdrExtraction ? DefaultHdrImageExtractionTimeout : DefaultSdrImageExtractionTimeout; timeoutMs = enableHdrExtraction ? DefaultHdrImageExtractionTimeout : DefaultSdrImageExtractionTimeout;
} }
ranToCompletion = await process.WaitForExitAsync(TimeSpan.FromMilliseconds(timeoutMs)).ConfigureAwait(false); try
if (!ranToCompletion)
{ {
StopProcess(processWrapper, 1000); await process.WaitForExitAsync(TimeSpan.FromMilliseconds(timeoutMs)).ConfigureAwait(false);
ranToCompletion = true;
}
catch (OperationCanceledException)
{
process.Kill(true);
ranToCompletion = false;
} }
} }
finally finally
@ -991,7 +995,7 @@ namespace MediaBrowser.MediaEncoding.Encoder
return true; return true;
} }
private class ProcessWrapper : IDisposable private sealed class ProcessWrapper : IDisposable
{ {
private readonly MediaEncoder _mediaEncoder; private readonly MediaEncoder _mediaEncoder;
@ -1034,13 +1038,7 @@ namespace MediaBrowser.MediaEncoding.Encoder
_mediaEncoder._runningProcesses.Remove(this); _mediaEncoder._runningProcesses.Remove(this);
} }
try process.Dispose();
{
process.Dispose();
}
catch
{
}
} }
public void Dispose() public void Dispose()

View File

@ -420,23 +420,16 @@ namespace MediaBrowser.MediaEncoding.Subtitles
throw; throw;
} }
var ranToCompletion = await process.WaitForExitAsync(TimeSpan.FromMinutes(30)).ConfigureAwait(false); try
if (!ranToCompletion)
{ {
try await process.WaitForExitAsync(TimeSpan.FromMinutes(30)).ConfigureAwait(false);
{ exitCode = process.ExitCode;
_logger.LogInformation("Killing ffmpeg subtitle conversion process"); }
catch (OperationCanceledException)
process.Kill(); {
} process.Kill(true);
catch (Exception ex) exitCode = -1;
{
_logger.LogError(ex, "Error killing subtitle conversion process");
}
} }
exitCode = ranToCompletion ? process.ExitCode : -1;
} }
var failed = false; var failed = false;
@ -574,23 +567,16 @@ namespace MediaBrowser.MediaEncoding.Subtitles
throw; throw;
} }
var ranToCompletion = await process.WaitForExitAsync(TimeSpan.FromMinutes(30)).ConfigureAwait(false); try
if (!ranToCompletion)
{ {
try await process.WaitForExitAsync(TimeSpan.FromMinutes(30)).ConfigureAwait(false);
{ exitCode = process.ExitCode;
_logger.LogWarning("Killing ffmpeg subtitle extraction process"); }
catch (OperationCanceledException)
process.Kill(); {
} process.Kill(true);
catch (Exception ex) exitCode = -1;
{
_logger.LogError(ex, "Error killing subtitle extraction process");
}
} }
exitCode = ranToCompletion ? process.ExitCode : -1;
} }
var failed = false; var failed = false;