Skip to content
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

Jump to bottom

Refactor IrcProvider just a little #1935

Draft
wants to merge 2 commits into
base: dev
Choose a base branch
from
Draft

Refactor IrcProvider just a little #1935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c75a44
Refactor IrcProvider just a little
craftxbox Sep 20, 2024
077c3db
Changes from review
craftxbox Sep 20, 2024
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
1 change: 1 addition & 0 deletions src/Tgstation.Server.Api/Models/IrcConnectionStringBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ public IrcConnectionStringBuilder(string connectionString)
case IrcPasswordType.NickServ:
case IrcPasswordType.Sasl:
case IrcPasswordType.Server:
case IrcPasswordType.Oper:
Cyberboss marked this conversation as resolved.
Show resolved Hide resolved
PasswordType = passwordType;
break;
default:
Expand Down
5 changes: 5 additions & 0 deletions src/Tgstation.Server.Api/Models/IrcPasswordType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,10 @@ public enum IrcPasswordType
/// Use NickServ authentication.
/// </summary>
NickServ,

/// <summary>
/// Use OPER authentication.
/// </summary>
Oper,
}
}
209 changes: 129 additions & 80 deletions src/Tgstation.Server.Host/Components/Chat/Providers/IrcProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,6 @@ sealed class IrcProvider : Provider
/// <inheritdoc />
public override string BotMention => client.Nickname;

/// <summary>
/// The <see cref="IrcFeatures"/> client.
/// </summary>
readonly IrcFeatures client;

/// <summary>
/// Address of the server to connect to.
/// </summary>
Expand All @@ -57,6 +52,11 @@ sealed class IrcProvider : Provider
/// </summary>
readonly ushort port;

/// <summary>
/// Wether or not this IRC client is to use ssl.
/// </summary>
readonly bool ssl;

/// <summary>
/// IRC nickname.
/// </summary>
Expand All @@ -82,6 +82,16 @@ sealed class IrcProvider : Provider
/// </summary>
readonly Dictionary<ulong, string> queryChannelIdMap;

/// <summary>
/// The <see cref="IAssemblyInformationProvider"/> obtained from constructor, used for the CTCP version string.
/// </summary>
readonly IAssemblyInformationProvider assemblyInfo;

/// <summary>
/// The <see cref="IrcFeatures"/> client.
/// </summary>
IrcFeatures client;

/// <summary>
/// The <see cref="ValueTask"/> used for <see cref="IrcConnection.Listen(bool)"/>.
/// </summary>
Expand All @@ -92,11 +102,6 @@ sealed class IrcProvider : Provider
/// </summary>
ulong channelIdCounter;

/// <summary>
/// If we are disconnecting.
/// </summary>
bool disconnecting;

/// <summary>
/// Initializes a new instance of the <see cref="IrcProvider"/> class.
/// </summary>
Expand All @@ -121,33 +126,15 @@ public IrcProvider(

address = ircBuilder.Address!;
port = ircBuilder.Port!.Value;
ssl = ircBuilder.UseSsl!.Value;
nickname = ircBuilder.Nickname!;

password = ircBuilder.Password!;
passwordType = ircBuilder.PasswordType;

client = new IrcFeatures
{
SupportNonRfc = true,
CtcpUserInfo = "You are going to play. And I am going to watch. And everything will be just fine...",
AutoRejoin = true,
AutoRejoinOnKick = true,
AutoRelogin = true,
AutoRetry = false,
AutoReconnect = false,
ActiveChannelSyncing = true,
AutoNickHandling = true,
CtcpVersion = assemblyInformationProvider.VersionString,
UseSsl = ircBuilder.UseSsl!.Value,
};
if (ircBuilder.UseSsl.Value)
client.ValidateServerCertificate = true; // dunno if it defaults to that or what

client.OnChannelMessage += Client_OnChannelMessage;
client.OnQueryMessage += Client_OnQueryMessage;
assemblyInfo = assemblyInformationProvider;

/*client.OnReadLine += (sender, e) => Logger.LogTrace("READ: {line}", e.Line);
client.OnWriteLine += (sender, e) => Logger.LogTrace("WRITE: {line}", e.Line);*/
client = InstantiateClient();

channelIdMap = new Dictionary<ulong, string?>();
queryChannelIdMap = new Dictionary<ulong, string>();
Expand Down Expand Up @@ -369,83 +356,69 @@ await SendMessage(
/// <inheritdoc />
protected override async ValueTask Connect(CancellationToken cancellationToken)
{
disconnecting = false;
cancellationToken.ThrowIfCancellationRequested();
try
{
await Task.Factory.StartNew(
() => client.Connect(address, port),
() =>
{
client = InstantiateClient();
client.Connect(address, port);
},
cancellationToken,
DefaultIOManager.BlockingTaskCreationOptions,
TaskScheduler.Current)
.WaitAsync(cancellationToken);

cancellationToken.ThrowIfCancellationRequested();

listenTask = Task.Factory.StartNew(
() =>
{
Logger.LogTrace("Starting blocking listen...");
try
{
client.Listen();
}
catch (Exception ex)
{
Logger.LogWarning(ex, "IRC Main Listen Exception!");
}

Logger.LogTrace("Exiting listening task...");
},
cancellationToken,
DefaultIOManager.BlockingTaskCreationOptions,
TaskScheduler.Current);

Logger.LogTrace("Authenticating ({passwordType})...", passwordType);
switch (passwordType)
{
case IrcPasswordType.Server:
client.Login(nickname, nickname, 0, nickname, password);
client.RfcPass(password);
await Login(client, nickname, cancellationToken);
break;
case IrcPasswordType.NickServ:
client.Login(nickname, nickname, 0, nickname);
await Login(client, nickname, cancellationToken);
cancellationToken.ThrowIfCancellationRequested();
client.SendMessage(SendType.Message, "NickServ", String.Format(CultureInfo.InvariantCulture, "IDENTIFY {0}", password));
break;
case IrcPasswordType.Sasl:
await SaslAuthenticate(cancellationToken);
break;
case IrcPasswordType.Oper:
await Login(client, nickname, cancellationToken);
cancellationToken.ThrowIfCancellationRequested();
client.RfcOper(nickname, password, Priority.Critical);
break;
case null:
client.Login(nickname, nickname, 0, nickname);
await Login(client, nickname, cancellationToken);
break;
default:
throw new InvalidOperationException($"Invalid IrcPasswordType: {passwordType.Value}");
}

cancellationToken.ThrowIfCancellationRequested();
Logger.LogTrace("Processing initial messages...");
await NonBlockingListen(cancellationToken);

var nickCheckCompleteTcs = new TaskCompletionSource();
using (cancellationToken.Register(() => nickCheckCompleteTcs.TrySetCanceled(cancellationToken)))
{
listenTask = Task.Factory.StartNew(
async () =>
{
Logger.LogTrace("Entering nick check loop");
while (!disconnecting && client.IsConnected && client.Nickname != nickname)
{
client.ListenOnce(true);
if (disconnecting || !client.IsConnected)
break;
await NonBlockingListen(cancellationToken);

// ensure we have the correct nick
if (client.GetIrcUser(nickname) == null)
client.RfcNick(nickname);
}

nickCheckCompleteTcs.TrySetResult();

Logger.LogTrace("Starting blocking listen...");
try
{
client.Listen();
}
catch (Exception ex)
{
Logger.LogWarning(ex, "IRC Main Listen Exception!");
}

Logger.LogTrace("Exiting listening task...");
},
cancellationToken,
DefaultIOManager.BlockingTaskCreationOptions,
TaskScheduler.Current);

await nickCheckCompleteTcs.Task;
}

Logger.LogTrace("Connection established!");
}
Expand Down Expand Up @@ -487,6 +460,44 @@ await Task.Factory.StartNew(
}
}

/// <summary>
/// Register the client on the network.
/// </summary>
/// <param name="client">IRC client.</param>
/// <param name="nickname">Nickname.</param>
/// <param name="cancellationToken">Cancellation token.</param>
/// <returns><see cref="Task"/> that resolves when registration has been completed. </returns>
/// <exception cref="TimeoutException">If the IRC server fails to respond.</exception>
async ValueTask Login(IrcFeatures client, string nickname, CancellationToken cancellationToken)
{
var promise = new TaskCompletionSource<object>();

void Callback(object? sender, EventArgs e)
{
Logger.LogTrace("IRC Registered.");
promise.TrySetResult(e);
}

client.OnRegistered += Callback;

client.Login(nickname, nickname, 0, nickname);

using var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
cts.CancelAfter(TimeSpan.FromSeconds(30));

try
{
await promise.Task.WaitAsync(cts.Token);
client.OnRegistered -= Callback;
}
catch (OperationCanceledException)
{
if (client.IsConnected)
client.Disconnect();
throw new JobException("Timed out waiting for IRC Registration");
}
}

/// <summary>
/// Handle an IRC message.
/// </summary>
Expand Down Expand Up @@ -667,8 +678,6 @@ async ValueTask HardDisconnect(CancellationToken cancellationToken)

Logger.LogTrace("Hard disconnect");

disconnecting = true;

// This call blocks permanently randomly sometimes
// Frankly I don't give a shit
var disconnectTask = Task.Factory.StartNew(
Expand All @@ -693,5 +702,45 @@ await Task.WhenAny(
listenTask ?? Task.CompletedTask),
AsyncDelayer.Delay(TimeSpan.FromSeconds(5), cancellationToken));
}

/// <summary>
/// Creates a new instance of the IRC client.
/// Reusing the same client after a disconnection seems to cause issues.
/// </summary>
/// <returns>The <see cref="IrcFeatures"/> client to use.</returns>
IrcFeatures InstantiateClient()
{
var newClient = new IrcFeatures
{
SupportNonRfc = true,
CtcpUserInfo = "You are going to play. And I am going to watch. And everything will be just fine...",
AutoRejoin = true,
AutoRejoinOnKick = true,
AutoRelogin = false,
AutoRetry = false,
AutoReconnect = false,
ActiveChannelSyncing = true,
AutoNickHandling = true,
CtcpVersion = assemblyInfo.VersionString,
UseSsl = ssl,
EnableUTF8Recode = true,
};
if (ssl)
newClient.ValidateServerCertificate = true; // dunno if it defaults to that or what

newClient.OnChannelMessage += Client_OnChannelMessage;
newClient.OnQueryMessage += Client_OnQueryMessage;

/* newClient.OnReadLine += (sender, e) => Logger.LogTrace("READ: {line}", e.Line);
newClient.OnWriteLine += (sender, e) => Logger.LogTrace("WRITE: {line}", e.Line); */

newClient.OnError += (sender, e) =>
{
Logger.LogError("IRC ERROR: {error}", e.ErrorMessage);
newClient.Disconnect();
};

return newClient;
}
}
}
11 changes: 11 additions & 0 deletions tests/Tgstation.Server.Host.Tests/Components/Chat/Providers/TestIrcProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,17 @@ public async Task TestConnectAndDisconnect()
await InvokeConnect(provider);
Assert.IsTrue(provider.Connected);

await Task.Delay(2000); // IRC servers do not like it when you connect and disconnect in rapid succession

await provider.Disconnect(default);
Assert.IsFalse(provider.Connected);

await Task.Delay(2000); // same as above

await InvokeConnect(provider);
await Task.Delay(2000); // make sure it stays connected after a reconnect attempt
Assert.IsTrue(provider.Connected);

await provider.Disconnect(default);
Assert.IsFalse(provider.Connected);
}
Expand Down
Loading