Noi/BirthdayBot
1
0
Fork 0
mirror of https://github.com/NoiTheCat/BirthdayBot.git synced 2024-11-24 01:14:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Skip user download in guilds where the method hangs

Browse source 
A workaround for an apparent bug in Discord.Net's
`SocketGuild.DownloadUsersAsync()` method.

Conclusions made while writing and testing this workaround:
* The guilds it hangs on are seemingly random.
* Guild size does not matter.
* If a download hangs, it never recovers within 2 hours, probably more.
* Trying a guild again never works. It just hangs again.
This commit is contained in:
Noi 2023-03-05 22:57:09 -08:00
parent 1fba7ff708
commit 29f2eeb31e
2 changed files with 24 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
BackgroundServices/AutoUserDownload.cs
View file

@ -9,10 +9,14 @@ class AutoUserDownload : BackgroundService {
public AutoUserDownload(ShardInstance instance) : base(instance) { } public AutoUserDownload(ShardInstance instance) : base(instance) { }
private static readonly HashSet<ulong> _failedDownloads = new(); private static readonly HashSet<ulong> _failedDownloads = new();
private static readonly TimeSpan _singleDlTimeout = ShardManager.DeadShardThreshold / 3;
public override async Task OnTick(int tickCount, CancellationToken token) { public override async Task OnTick(int tickCount, CancellationToken token) {
// Take action if a guild's cache is incomplete... // Take action if a guild's cache is incomplete...
var incompleteCaches = ShardInstance.DiscordClient.Guilds.Where(g => !g.HasAllMembers).Select(g => g.Id).ToHashSet(); var incompleteCaches = ShardInstance.DiscordClient.Guilds
.Where(g => !g.HasAllMembers)
.Select(g => g.Id)
.ToHashSet();
// ...and if the guild contains any user data // ...and if the guild contains any user data
IEnumerable<ulong> mustFetch; IEnumerable<ulong> mustFetch;
try { try {
@ -34,28 +38,29 @@ class AutoUserDownload : BackgroundService {
var processed = 0; var processed = 0;
var processStartTime = DateTimeOffset.UtcNow; var processStartTime = DateTimeOffset.UtcNow;
foreach (var item in mustFetch) { foreach (var item in mustFetch) {
// May cause a disconnect in certain situations. Cancel all further attempts until the next pass if it happens. // May cause a disconnect in certain situations. Make no further attempts until the next pass if it happens.
if (ShardInstance.DiscordClient.ConnectionState != ConnectionState.Connected) break; if (ShardInstance.DiscordClient.ConnectionState != ConnectionState.Connected) break;
var guild = ShardInstance.DiscordClient.GetGuild(item); var guild = ShardInstance.DiscordClient.GetGuild(item);
if (guild == null) continue; // A guild disappeared...? if (guild == null) continue; // A guild disappeared...?
const int singleTimeout = 500; await Task.Delay(200, CancellationToken.None); // Delay a bit (reduces the possibility of hanging, somehow).
var dl = guild.DownloadUsersAsync(); // We're already on a seperate thread, no need to use Task.Run (?)
dl.Wait(singleTimeout * 1000, token);
if (!dl.IsCompletedSuccessfully) {
Log($"Giving up on {guild.Id} after {singleTimeout} seconds. (Total members: {guild.MemberCount})");
lock (_failedDownloads) _failedDownloads.Add(guild.Id);
}
processed++; processed++;
var dl = guild.DownloadUsersAsync();
if (Math.Abs((DateTimeOffset.UtcNow - processStartTime).TotalMinutes) > 2) { dl.Wait((int)_singleDlTimeout.TotalMilliseconds / 2, token);
Log("Break time!"); if (dl.IsFaulted) {
// take a break (don't get killed by ShardManager for taking too long due to quantity) Log("Exception thrown by download task: " + dl.Exception);
break; break;
} else if (!dl.IsCompletedSuccessfully) {
Log($"Hang on processing {guild.Id}. Skipping.");
lock (_failedDownloads) _failedDownloads.Add(guild.Id);
continue;
} }
// Prevent unnecessary disconnections by ShardManager if we're taking too long
if (DateTimeOffset.UtcNow - processStartTime > _singleDlTimeout) break;
} }
if (processed > 20) Log($"Explicit user list request processed for {processed} guild(s)."); if (processed > 10) Log($"Member list downloads handled for {processed} guilds.");
} }
} }

10
ShardManager.cs
View file

@ -25,7 +25,7 @@ class ShardManager : IDisposable {
/// Amount of time without a completed background service run before a shard instance /// Amount of time without a completed background service run before a shard instance
/// is considered "dead" and tasked to be removed. /// is considered "dead" and tasked to be removed.
/// </summary> /// </summary>
private static readonly TimeSpan DeadShardThreshold = new(0, 20, 0); public static readonly TimeSpan DeadShardThreshold = new(0, 20, 0);
/// <summary> /// <summary>
/// A dictionary with shard IDs as its keys and shard instances as its values. /// A dictionary with shard IDs as its keys and shard instances as its values.
@ -144,10 +144,10 @@ class ShardManager : IDisposable {
shardStatuses.AppendLine(); shardStatuses.AppendLine();
//if (lastRun > DeadShardThreshold) { if (lastRun > DeadShardThreshold) {
// shardStatuses.AppendLine($"Shard {i:00} marked for disposal."); shardStatuses.AppendLine($"Shard {i:00} marked for disposal.");
// deadShards.Add(i); deadShards.Add(i);
//} }
} }
Log(shardStatuses.ToString().TrimEnd()); Log(shardStatuses.ToString().TrimEnd());