cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-27 07:04:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

Catch and log exceptions thrown by byondTopicSender

Browse Source
This commit is contained in:
Cyberboss
2018-07-13 11:27:28 -04:00
parent ff63c512f7
commit e5d8d461de
2 changed files with 43 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Tgstation.Server.Host/Components/Watchdog/SessionController.cs
+32 -13
View File
@@ -1,5 +1,6 @@
using Byond.TopicSender;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Primitives;
using System;
using System.Collections.Generic;
@@ -110,6 +111,11 @@ namespace Tgstation.Server.Host.Components.Watchdog
/// </summary>
readonly IChat chat;
/// <summary>
/// The <see cref="ILogger"/> for the <see cref="SessionController"/>
/// </summary>
readonly ILogger<SessionController> logger;
/// <summary>
/// The <see cref="TaskCompletionSource{TResult}"/> <see cref="SetPortImpl(ushort, CancellationToken)"/> waits on when DreamDaemon currently has it's ports closed
/// </summary>
@@ -147,15 +153,17 @@ namespace Tgstation.Server.Host.Components.Watchdog
/// <param name="interopRegistrar">The <see cref="IInteropRegistrar"/> used to construct <see cref="interopContext"/></param>
/// <param name="chat">The value of <see cref="chat"/></param>
/// <param name="chatJsonTrackingContext">The value of <see cref="chatJsonTrackingContext"/></param>
public SessionController(ReattachInformation reattachInformation, ISession session, IByondTopicSender byondTopicSender, IInteropRegistrar interopRegistrar, IChatJsonTrackingContext chatJsonTrackingContext, IChat chat)
/// <param name="logger">The value of <see cref="logger"/></param>
public SessionController(ReattachInformation reattachInformation, ISession session, IByondTopicSender byondTopicSender, IInteropRegistrar interopRegistrar, IChatJsonTrackingContext chatJsonTrackingContext, IChat chat, ILogger<SessionController> logger)
{
this.chatJsonTrackingContext = chatJsonTrackingContext; //null valid
this.reattachInformation = reattachInformation ?? throw new ArgumentNullException(nameof(reattachInformation));
this.byondTopicSender = byondTopicSender ?? throw new ArgumentNullException(nameof(byondTopicSender));
this.session = session ?? throw new ArgumentNullException(nameof(session));
this.chat = chat ?? throw new ArgumentNullException(nameof(chat));
if (interopRegistrar == null)
throw new ArgumentNullException(nameof(interopRegistrar));
this.session = session ?? throw new ArgumentNullException(nameof(session));
this.chat = chat ?? throw new ArgumentNullException(nameof(chat));
this.logger = logger ?? throw new ArgumentNullException(nameof(logger));
interopContext = interopRegistrar.Register(reattachInformation.AccessIdentifier, this);
@@ -254,16 +262,27 @@ namespace Tgstation.Server.Host.Components.Watchdog
}
/// <inheritdoc />
public Task<string> SendCommand(string command, CancellationToken cancellationToken) => byondTopicSender.SendTopic(
new IPEndPoint(IPAddress.Loopback, reattachInformation.Port),
String.Format(CultureInfo.InvariantCulture,
"?{0}={1}&{2}={3}",
byondTopicSender.SanitizeString(InteropConstants.DMInteropAccessIdentifier),
byondTopicSender.SanitizeString(reattachInformation.AccessIdentifier),
byondTopicSender.SanitizeString(InteropConstants.DMParameterCommand),
//intentionally don't sanitize command, that's up to the caller
command),
cancellationToken);
public async Task<string> SendCommand(string command, CancellationToken cancellationToken)
{
try
{
return await byondTopicSender.SendTopic(
new IPEndPoint(IPAddress.Loopback, reattachInformation.Port),
String.Format(CultureInfo.InvariantCulture,
"?{0}={1}&{2}={3}",
byondTopicSender.SanitizeString(InteropConstants.DMInteropAccessIdentifier),
byondTopicSender.SanitizeString(reattachInformation.AccessIdentifier),
byondTopicSender.SanitizeString(InteropConstants.DMParameterCommand),
//intentionally don't sanitize command, that's up to the caller
command),
cancellationToken).ConfigureAwait(false);
}
catch (Exception e)
{
logger.LogInformation("Send command exception:{0}{1}", Environment.NewLine, e.Message);
return null;
}
}
async Task<bool> SetPortImpl(ushort port, CancellationToken cancellationToken) => await SendCommand(String.Format(CultureInfo.InvariantCulture, "{0}&{1}={2}", byondTopicSender.SanitizeString(InteropConstants.DMTopicChangePort), byondTopicSender.SanitizeString(InteropConstants.DMParameterNewPort), byondTopicSender.SanitizeString(port.ToString(CultureInfo.InvariantCulture))), cancellationToken).ConfigureAwait(false) == InteropConstants.DMResponseSuccess;
src/Tgstation.Server.Host/Components/Watchdog/SessionControllerFactory.cs
+11 -3
View File
@@ -1,4 +1,5 @@
using Byond.TopicSender;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using System;
using System.Globalization;
@@ -61,6 +62,11 @@ namespace Tgstation.Server.Host.Components.Watchdog
/// </summary>
readonly IChat chat;
/// <summary>
/// The <see cref="ILoggerFactory"/> for the <see cref="SessionControllerFactory"/>
/// </summary>
readonly ILoggerFactory loggerFactory;
/// <summary>
/// Construct a <see cref="SessionControllerFactory"/>
/// </summary>
@@ -73,7 +79,8 @@ namespace Tgstation.Server.Host.Components.Watchdog
/// <param name="instance">The value of <see cref="instance"/></param>
/// <param name="ioManager">The value of <see cref="ioManager"/></param>
/// <param name="chat">The value of <see cref="chat"/></param>
public SessionControllerFactory(IExecutor executor, IByond byond, IByondTopicSender byondTopicSender, IInteropRegistrar interopRegistrar, ICryptographySuite cryptographySuite, IApplication application, IInstance instance, IIOManager ioManager, IChat chat)
/// <param name="loggerFactory">The value of <see cref="loggerFactory"/></param>
public SessionControllerFactory(IExecutor executor, IByond byond, IByondTopicSender byondTopicSender, IInteropRegistrar interopRegistrar, ICryptographySuite cryptographySuite, IApplication application, IInstance instance, IIOManager ioManager, IChat chat, ILoggerFactory loggerFactory)
{
this.executor = executor ?? throw new ArgumentNullException(nameof(executor));
this.byond = byond ?? throw new ArgumentNullException(nameof(byond));
@@ -84,6 +91,7 @@ namespace Tgstation.Server.Host.Components.Watchdog
this.instance = instance ?? throw new ArgumentNullException(nameof(instance));
this.ioManager = ioManager ?? throw new ArgumentNullException(nameof(ioManager));
this.chat = chat ?? throw new ArgumentNullException(nameof(chat));
this.loggerFactory = loggerFactory ?? throw new ArgumentNullException(nameof(loggerFactory));
}
/// <inheritdoc />
@@ -149,7 +157,7 @@ namespace Tgstation.Server.Host.Components.Watchdog
IsPrimary = primaryDirectory,
Port = portToUse.Value,
ProcessId = session.ProcessId
}, session, byondTopicSender, interopRegistrar, chatJsonTrackingContext, chat);
}, session, byondTopicSender, interopRegistrar, chatJsonTrackingContext, chat, loggerFactory.CreateLogger<SessionController>());
}
catch
{
@@ -186,7 +194,7 @@ namespace Tgstation.Server.Host.Components.Watchdog
var session = executor.AttachToDreamDaemon(reattachInformation.ProcessId, byondLock);
try
{
return new SessionController(reattachInformation, session, byondTopicSender, interopRegistrar, chatJsonTrackingContext, chat);
return new SessionController(reattachInformation, session, byondTopicSender, interopRegistrar, chatJsonTrackingContext, chat, loggerFactory.CreateLogger<SessionController>());
}
catch
{