Skip to content

Kill orphaned listing processes on timeout (#4974) #4980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Gabriel Dufresne (GabrielDuf) merged 1 commit into from
Jun 22, 2026
+91 −66
Merged

Kill orphaned listing processes on timeout (#4974) #4980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/UniGetUI.PackageEngine.Managers.Chocolatey/Chocolatey.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ public class Chocolatey : BaseNuGet
Path.Join(CoreData.UniGetUIDataDirectory, "Chocolatey"),
];

// AttemptFastRepair is a no-op here, so retrying a timed-out choco listing just spawns another (#4974).
protected override bool RetryListingTasksOnTimeout => false;

public Chocolatey()
{
Capabilities = new ManagerCapabilities
Expand Down Expand Up @@ -276,6 +279,7 @@ protected override IReadOnlyList<Package> GetAvailableUpdates_UnSafe()

IProcessTaskLogger logger = TaskLogger.CreateNew(LoggableTaskType.ListUpdates, p);
p.Start();
RegisterListingProcess(p);

string? line;
List<string> lines = [];
Expand Down Expand Up @@ -315,6 +319,7 @@ protected override IReadOnlyList<Package> _getInstalledPackages_UnSafe()
p
);
p.Start();
RegisterListingProcess(p);

string? line;
List<string> lines = [];
Expand Down
152 changes: 86 additions & 66 deletions src/UniGetUI.PackageEngine.PackageManagerClasses/Manager/PackageManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.Diagnostics;
using System.Text;
using UniGetUI.Core.Logging;
using UniGetUI.Core.SettingsEngine;
Expand Down Expand Up @@ -263,6 +264,67 @@ public bool IsReady()
return _ready && IsEnabled() && Status.Found;
}

// Opt out (override => false) when AttemptFastRepair can't recover a timed-out query (issue #4974).
protected virtual bool RetryListingTasksOnTimeout => true;

// Processes started by the current listing task, so a timeout can kill them instead of orphaning them.
private readonly AsyncLocal<List<Process>?> _listingProcesses = new();

// Lets a listing task register a process for kill-on-timeout. No-op when outside a listing task.
protected void RegisterListingProcess(Process process)
{
List<Process>? processes = _listingProcesses.Value;
if (processes is null)
return;
lock (processes)
processes.Add(process);
}

private static void KillListingProcesses(List<Process> processes)
{
lock (processes)
foreach (Process p in processes)
{
try
{
if (!p.HasExited)
p.Kill(entireProcessTree: true);
}
catch (Exception ex)
{
Logger.Warn($"Could not kill a timed-out process tree: {ex.Message}");
}
}
}

private T RunListingTaskWithTimeout<T>(Func<T> method, string taskName)
{
List<Process> processes = [];
var task = Task.Run(() =>
{
_listingProcesses.Value = processes;
return method();
});

if (!task.Wait(TimeSpan.FromSeconds(PackageListingTaskTimeout)))
{
if (!Settings.Get(Settings.K.DisableTimeoutOnPackageListingTasks))
{
KillListingProcesses(processes);
CoreTools.FinalizeDangerousTask(task);
throw new TimeoutException(
$"Task {taskName} for manager {Name} did not finish after "
+ $"{PackageListingTaskTimeout} seconds, aborting. You may disable "
+ $"timeouts from UniGetUI Advanced Settings"
);
}

task.Wait();
}

return task.GetAwaiter().GetResult();
}

/// <summary>
/// Returns an array of Package objects that the manager lists for the given query. Depending on the manager, the list may
/// also include similar results. This method is fail-safe and will return an empty array if an error occurs.
Expand All @@ -278,36 +340,22 @@ private IReadOnlyList<IPackage> _findPackages(string query, bool SecondAttempt)
}
try
{
var task = Task.Run(() => FindPackages_UnSafe(query));
if (!task.Wait(TimeSpan.FromSeconds(PackageListingTaskTimeout)))
{
if (!Settings.Get(Settings.K.DisableTimeoutOnPackageListingTasks))
{
CoreTools.FinalizeDangerousTask(task);
throw new TimeoutException(
$"Task _getInstalledPackages for manager {Name} did not finish after "
+ $"{PackageListingTaskTimeout} seconds, aborting. You may disable "
+ $"timeouts from UniGetUI Advanced Settings"
);
}

task.Wait();
}

var packages = task.GetAwaiter().GetResult();
var packages = RunListingTaskWithTimeout(
() => FindPackages_UnSafe(query),
"_findPackages"
);
Logger.Info(
$"Found {packages.Count} available packages from {Name} with the query {query}"
);
return packages;
}
catch (Exception e)
{
if (!SecondAttempt)
while (e is AggregateException)
e = e.InnerException ?? new InvalidOperationException("How did we get here?");

if (!SecondAttempt && (RetryListingTasksOnTimeout || e is not TimeoutException))
{
while (e is AggregateException)
e =
e.InnerException
?? new InvalidOperationException("How did we get here?");
Logger.Warn(
$"Manager {DisplayName} failed to find packages with exception {e.GetType().Name}: {e.Message}"
);
Expand Down Expand Up @@ -342,34 +390,20 @@ private IReadOnlyList<IPackage> _getAvailableUpdates(bool SecondAttempt)
Task.Run(RefreshPackageIndexes)
.Wait(TimeSpan.FromSeconds(PackageListingTaskTimeout));

var task = Task.Run(GetAvailableUpdates_UnSafe);
if (!task.Wait(TimeSpan.FromSeconds(PackageListingTaskTimeout)))
{
if (!Settings.Get(Settings.K.DisableTimeoutOnPackageListingTasks))
{
CoreTools.FinalizeDangerousTask(task);
throw new TimeoutException(
$"Task _getInstalledPackages for manager {Name} did not finish after "
+ $"{PackageListingTaskTimeout} seconds, aborting. You may disable "
+ $"timeouts from UniGetUI Advanced Settings"
);
}

task.Wait();
}

var packages = task.GetAwaiter().GetResult();
var packages = RunListingTaskWithTimeout(
GetAvailableUpdates_UnSafe,
"_getAvailableUpdates"
);
Logger.Info($"Found {packages.Count} available updates from {Name}");
return packages;
}
catch (Exception e)
{
if (!SecondAttempt)
while (e is AggregateException)
e = e.InnerException ?? new InvalidOperationException("How did we get here?");

if (!SecondAttempt && (RetryListingTasksOnTimeout || e is not TimeoutException))
{
while (e is AggregateException)
e =
e.InnerException
?? new InvalidOperationException("How did we get here?");
Logger.Warn(
$"Manager {DisplayName} failed to list available updates with exception {e.GetType().Name}: {e.Message}"
);
Expand Down Expand Up @@ -401,34 +435,20 @@ private IReadOnlyList<IPackage> _getInstalledPackages(bool SecondAttempt)
}
try
{
var task = Task.Run(GetInstalledPackages_UnSafe);
if (!task.Wait(TimeSpan.FromSeconds(PackageListingTaskTimeout)))
{
if (!Settings.Get(Settings.K.DisableTimeoutOnPackageListingTasks))
{
CoreTools.FinalizeDangerousTask(task);
throw new TimeoutException(
$"Task _getInstalledPackages for manager {Name} did not finish after "
+ $"{PackageListingTaskTimeout} seconds, aborting. You may disable "
+ $"timeouts from UniGetUI Advanced Settings"
);
}

task.Wait();
}

var packages = task.GetAwaiter().GetResult();
var packages = RunListingTaskWithTimeout(
GetInstalledPackages_UnSafe,
"_getInstalledPackages"
);
Logger.Info($"Found {packages.Count} installed packages from {Name}");
return packages;
}
catch (Exception e)
{
if (!SecondAttempt)
while (e is AggregateException)
e = e.InnerException ?? new InvalidOperationException("How did we get here?");

if (!SecondAttempt && (RetryListingTasksOnTimeout || e is not TimeoutException))
{
while (e is AggregateException)
e =
e.InnerException
?? new InvalidOperationException("How did we get here?");
Logger.Warn(
$"Manager {DisplayName} failed to list installed packages with exception {e.GetType().Name}: {e.Message}"
);
Expand Down
Loading