cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-07-13 09:03:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Nullify Job

Browse Source
This commit is contained in:
Jordan Dominion
2023-12-18 19:48:09 -05:00
parent 3a6047702f
commit 8fc4c36fd3
5 changed files with 27 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Tgstation.Server.Host/Components/Chat/Providers/Provider.cs
+4 -1
View File
@@ -96,6 +96,9 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
Logger = logger ?? throw new ArgumentNullException(nameof(logger));
ChatBot = chatBot ?? throw new ArgumentNullException(nameof(chatBot));
if (chatBot.Instance == null)
throw new ArgumentException("chatBot must have Instance!", nameof(chatBot));
messageQueue = new Queue<Message?>();
nextMessage = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
initialConnectionTcs = new TaskCompletionSource();
@@ -286,7 +289,7 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
connectNow = false;
if (!Connected)
{
var job = Job.Create(Api.Models.JobCode.ReconnectChatBot, null, ChatBot.Instance, ChatBotRights.WriteEnabled);
var job = Job.Create(Api.Models.JobCode.ReconnectChatBot, null, ChatBot.Instance!, ChatBotRights.WriteEnabled);
job.Description += $": {ChatBot.Name}";
await jobManager.RegisterOperation(
src/Tgstation.Server.Host/Jobs/JobService.cs
+4 -1
View File
@@ -123,6 +123,9 @@ namespace Tgstation.Server.Host.Jobs
if (job.StartedBy != null && job.StartedBy.Name == null)
throw new InvalidOperationException("StartedBy User associated with job does not have a Name!");
if (job.Instance == null)
throw new InvalidOperationException("No Instance associated with job!");
job.StartedAt = DateTimeOffset.UtcNow;
job.Cancelled = false;
@@ -458,7 +461,7 @@ namespace Tgstation.Server.Host.Jobs
logger.LogTrace("Starting job...");
await operation(
instanceCoreProvider.GetInstance(job.Instance),
instanceCoreProvider.GetInstance(job.Instance!),
databaseContextFactory,
job,
new JobProgressReporter(
src/Tgstation.Server.Host/Models/Job.cs
+10 -12
View File
@@ -7,8 +7,6 @@ using Tgstation.Server.Api.Models;
using Tgstation.Server.Api.Models.Response;
using Tgstation.Server.Api.Rights;
#nullable disable
namespace Tgstation.Server.Host.Models
{
/// <inheritdoc cref="Api.Models.Internal.Job" />
@@ -20,18 +18,18 @@ namespace Tgstation.Server.Host.Models
/// See <see cref="JobResponse.StartedBy"/>.
/// </summary>
[Required]
public User StartedBy { get; set; }
public User? StartedBy { get; set; }
/// <summary>
/// See <see cref="JobResponse.CancelledBy"/>.
/// </summary>
public User CancelledBy { get; set; }
public User? CancelledBy { get; set; }
/// <summary>
/// The <see cref="Models.Instance"/> the job belongs to if any.
/// </summary>
[Required]
public Instance Instance { get; set; }
public Instance? Instance { get; set; }
/// <summary>
/// Creates a new job for registering in the <see cref="Jobs.IJobService"/>.
@@ -42,7 +40,7 @@ namespace Tgstation.Server.Host.Models
/// <param name="instance">The <see cref="Api.Models.Instance"/> used to generate the value of <see cref="Instance"/>.</param>
/// <param name="cancelRight">The value of <see cref="Api.Models.Internal.Job.CancelRight"/>. <see cref="Api.Models.Internal.Job.CancelRightsType"/> will be derived from this.</param>
/// <returns>A new <see cref="Job"/> ready to be registered with the <see cref="Jobs.IJobService"/>.</returns>
public static Job Create<TRight>(JobCode code, User startedBy, Api.Models.Instance instance, TRight cancelRight)
public static Job Create<TRight>(JobCode code, User? startedBy, Api.Models.Instance instance, TRight cancelRight)
where TRight : Enum
=> new(
code,
@@ -58,7 +56,7 @@ namespace Tgstation.Server.Host.Models
/// <param name="startedBy">The value of <see cref="StartedBy"/>. If <see langword="null"/>, the <see cref="User.TgsSystemUserName"/> user will be used.</param>
/// <param name="instance">The <see cref="Api.Models.Instance"/> used to generate the value of <see cref="Instance"/>.</param>
/// <returns>A new <see cref="Job"/> ready to be registered with the <see cref="Jobs.IJobService"/>.</returns>
public static Job Create(JobCode code, User startedBy, Api.Models.Instance instance)
public static Job Create(JobCode code, User? startedBy, Api.Models.Instance instance)
=> new(
code,
startedBy,
@@ -91,7 +89,7 @@ namespace Tgstation.Server.Host.Models
/// <param name="instance">The value of <see cref="Instance"/>.</param>
/// <param name="cancelRightsType">The value of <see cref="Api.Models.Internal.Job.CancelRightsType"/>.</param>
/// <param name="cancelRight">The value of <see cref="Api.Models.Internal.Job.CancelRight"/>.</param>
Job(JobCode code, User startedBy, Api.Models.Instance instance, RightsType? cancelRightsType, ulong? cancelRight)
Job(JobCode code, User? startedBy, Api.Models.Instance instance, RightsType? cancelRightsType, ulong? cancelRight)
{
StartedBy = startedBy;
ArgumentNullException.ThrowIfNull(instance);
@@ -100,7 +98,7 @@ namespace Tgstation.Server.Host.Models
Id = instance.Id ?? throw new InvalidOperationException("Instance associated with job does not have an Id!"),
};
Description = typeof(JobCode)
.GetField(code.ToString())
.GetField(code.ToString())!
.GetCustomAttributes(false)
.OfType<DescriptionAttribute>()
.First()
@@ -114,8 +112,8 @@ namespace Tgstation.Server.Host.Models
public JobResponse ToApi() => new()
{
Id = Id,
JobCode = JobCode.Value,
InstanceId = Instance.Id.Value,
JobCode = this.Require(x => x.JobCode),
InstanceId = (Instance ?? throw new InvalidOperationException("Instance needs to be set!")).Require(x => x.Id),
StartedAt = StartedAt,
StoppedAt = StoppedAt,
Cancelled = Cancelled,
@@ -125,7 +123,7 @@ namespace Tgstation.Server.Host.Models
Description = Description,
ExceptionDetails = ExceptionDetails,
ErrorCode = ErrorCode,
StartedBy = StartedBy.CreateUserName(),
StartedBy = (StartedBy ?? throw new InvalidOperationException("StartedBy needs to be set!")).CreateUserName(),
};
}
}
tests/Tgstation.Server.Host.Tests/Components/Chat/Providers/TestDiscordProvider.cs
+6 -3
View File
@@ -1,11 +1,11 @@
using System;
using System.Collections.Generic;
using System.Reflection;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using Tgstation.Server.Api.Models;
@@ -31,7 +31,8 @@ namespace Tgstation.Server.Host.Components.Chat.Providers.Tests
testToken1 = new ChatBot
{
ConnectionString = actualToken,
ReconnectionInterval = 1
ReconnectionInterval = 1,
Instance = new Models.Instance()
};
var mockSetup = new Mock<IJobManager>();
@@ -52,6 +53,7 @@ namespace Tgstation.Server.Host.Components.Chat.Providers.Tests
{
ConnectionString = "fake_token",
ReconnectionInterval = 1,
Instance = new Models.Instance(),
};
Assert.ThrowsException<ArgumentNullException>(() => new DiscordProvider(null, null, null, null, null, null));
@@ -76,7 +78,8 @@ namespace Tgstation.Server.Host.Components.Chat.Providers.Tests
await using var provider = new DiscordProvider(mockJobManager, Mock.Of<IAsyncDelayer>(), mockLogger.Object, Mock.Of<IAssemblyInformationProvider>(), new ChatBot
{
ReconnectionInterval = 1,
ConnectionString = "asdf"
ConnectionString = "asdf",
Instance = new Models.Instance(),
}, new GeneralConfiguration());
await Assert.ThrowsExceptionAsync<JobException>(async () => await InvokeConnect(provider));
Assert.IsFalse(provider.Connected);
tests/Tgstation.Server.Host.Tests/Components/Chat/Providers/TestIrcProvider.cs
+3 -3
View File
@@ -1,14 +1,12 @@
using System;
using System.Collections.Generic;
using System.Reflection;
using System.Threading;
using System.Threading.Tasks;
using System.Xml.Linq;
using Microsoft.Extensions.Logging;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;
using Serilog.Parsing;
using Tgstation.Server.Api.Models;
using Tgstation.Server.Host.Jobs;
@@ -37,6 +35,7 @@ namespace Tgstation.Server.Host.Components.Chat.Providers.Tests
var mockBot = new ChatBot
{
Name = "test",
Instance = new Models.Instance(),
Provider = ChatProvider.Irc
};
@@ -83,6 +82,7 @@ namespace Tgstation.Server.Host.Components.Chat.Providers.Tests
{
ConnectionString = actualToken,
Provider = ChatProvider.Irc,
Instance = new Models.Instance(),
});
Assert.IsFalse(provider.Connected);
await InvokeConnect(provider);