Skip to content

Implemented resume_gateway_url. #2423

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
quinchs merged 4 commits into from
Sep 14, 2022
Merged

Implemented resume_gateway_url. #2423

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e2dc23
Implemented resume_gateway_url.
Quahu Aug 10, 2022
42b785d
Merge branch 'dev' into resume-gateway-url
quinchs Sep 2, 2022
162bc81
Made the requested changes.
Quahu Sep 3, 2022
2329f1d
Implemented passing the gateway URL down from DiscordShardedClient.
Quahu Sep 9, 2022
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
2 changes: 2 additions & 0 deletions src/Discord.Net.WebSocket/API/Gateway/ReadyEvent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ public class ReadState
public User User { get; set; }
[JsonProperty("session_id")]
public string SessionId { get; set; }
[JsonProperty("resume_gateway_url")]
public string ResumeGatewayUrl { get; set; }
[JsonProperty("read_state")]
public ReadState[] ReadStates { get; set; }
[JsonProperty("guilds")]
Expand Down
45 changes: 38 additions & 7 deletions src/Discord.Net.WebSocket/DiscordSocketApiClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ internal class DiscordSocketApiClient : DiscordRestApiClient
private readonly bool _isExplicitUrl;
private CancellationTokenSource _connectCancelToken;
private string _gatewayUrl;
private string _resumeGatewayUrl;

//Store our decompression streams for zlib shared state
private MemoryStream _compressed;
Expand All @@ -37,6 +38,14 @@ internal class DiscordSocketApiClient : DiscordRestApiClient

public ConnectionState ConnectionState { get; private set; }

/// <summary>
/// Sets the gateway URL used for resumes.
/// </summary>
public string ResumeGatewayUrl
{
set => _resumeGatewayUrl = FormatGatewayUrl(value);
}

public DiscordSocketApiClient(RestClientProvider restClientProvider, WebSocketProvider webSocketProvider, string userAgent,
string url = null, RetryMode defaultRetryMode = RetryMode.AlwaysRetry, JsonSerializer serializer = null,
bool useSystemClock = true, Func<IRateLimitInfo, Task> defaultRatelimitCallback = null)
Expand Down Expand Up @@ -157,6 +166,17 @@ internal override ValueTask DisposeAsync(bool disposing)
#endif
}

/// <summary>
/// Appends necessary query parameters to the specified gateway URL.
/// </summary>
private static string FormatGatewayUrl(string gatewayUrl)
{
if (gatewayUrl == null)
return null;

return $"{gatewayUrl}?v={DiscordConfig.APIVersion}&encoding={DiscordSocketConfig.GatewayEncoding}&compress=zlib-stream";
}

public async Task ConnectAsync()
{
await _stateLock.WaitAsync().ConfigureAwait(false);
Expand Down Expand Up @@ -191,24 +211,35 @@ internal override async Task ConnectInternalAsync()
if (WebSocketClient != null)
WebSocketClient.SetCancelToken(_connectCancelToken.Token);

if (!_isExplicitUrl)
string gatewayUrl;
if (_resumeGatewayUrl == null)
{
if (!_isExplicitUrl)
{
// TODO: pass this down from DiscordShardedClient, so that it's not requested separately for every single shard
var gatewayResponse = await GetBotGatewayAsync().ConfigureAwait(false);
gatewayUrl = _gatewayUrl = FormatGatewayUrl(gatewayResponse.Url);
}
else
{
gatewayUrl = _gatewayUrl;
}
}
else
{
var gatewayResponse = await GetGatewayAsync().ConfigureAwait(false);
_gatewayUrl = $"{gatewayResponse.Url}?v={DiscordConfig.APIVersion}&encoding={DiscordSocketConfig.GatewayEncoding}&compress=zlib-stream";
gatewayUrl = _resumeGatewayUrl;
}

#if DEBUG_PACKETS
Console.WriteLine("Connecting to gateway: " + _gatewayUrl);
Console.WriteLine("Connecting to gateway: " + gatewayUrl);
#endif

await WebSocketClient.ConnectAsync(_gatewayUrl).ConfigureAwait(false);
await WebSocketClient.ConnectAsync(gatewayUrl).ConfigureAwait(false);

ConnectionState = ConnectionState.Connected;
}
catch
{
if (!_isExplicitUrl)
_gatewayUrl = null; //Uncache in case the gateway url changed
await DisconnectInternalAsync().ConfigureAwait(false);
throw;
}
Expand Down
7 changes: 6 additions & 1 deletion src/Discord.Net.WebSocket/DiscordSocketClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,6 @@ private async Task OnConnectingAsync()
}
private async Task OnDisconnectingAsync(Exception ex)
{

await _gatewayLogger.DebugAsync("Disconnecting ApiClient").ConfigureAwait(false);
await ApiClient.DisconnectAsync(ex).ConfigureAwait(false);

Expand Down Expand Up @@ -353,6 +352,10 @@ private async Task OnDisconnectingAsync(Exception ex)
if (guild.IsAvailable)
await GuildUnavailableAsync(guild).ConfigureAwait(false);
}

_sessionId = null;
_lastSeq = 0;
ApiClient.ResumeGatewayUrl = null;
}

/// <inheritdoc />
Expand Down Expand Up @@ -834,6 +837,7 @@ private async Task ProcessMessageAsync(GatewayOpCode opCode, int? seq, string ty

_sessionId = null;
_lastSeq = 0;
ApiClient.ResumeGatewayUrl = null;

if (_shardedClient != null)
{
Expand Down Expand Up @@ -891,6 +895,7 @@ private async Task ProcessMessageAsync(GatewayOpCode opCode, int? seq, string ty
AddPrivateChannel(data.PrivateChannels[i], state);

_sessionId = data.SessionId;
ApiClient.ResumeGatewayUrl = data.ResumeGatewayUrl;
_unavailableGuildCount = unavailableGuilds;
CurrentUser = currentUser;
_previousSessionUser = CurrentUser;
Expand Down