Job.cs

Go to the documentation of this file.

using System;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.Linq;
 
using Tgstation.Server.Api.Models;
using Tgstation.Server.Api.Models.Response;
using Tgstation.Server.Api.Rights;
 
namespace Tgstation.Server.Host.Models
{
#pragma warning disable CA1724 // naming conflict with gitlab package
    public sealed class Job : Api.Models.Internal.Job, ILegacyApiTransformable<JobResponse>
#pragma warning restore CA1724
    {
        [Required]
        public User? StartedBy { get; set; }
 
        public User? CancelledBy { get; set; }
 
        [Required]
        public Instance? Instance { get; set; }
 
        public static Job Create<TRight>(JobCode code, User? startedBy, Api.Models.Instance instance, TRight cancelRight)
            where TRight : Enum
            => new(
                code,
                startedBy,
                instance,
                RightsHelper.TypeToRight<TRight>(),
                (ulong)(object)cancelRight);
 
        public static Job Create(JobCode code, User? startedBy, Api.Models.Instance instance)
            => new(
                code,
                startedBy,
                instance,
                null,
                null);
 
        [Obsolete("For use by EFCore only", true)]
        public Job()
        {
        }
 
        public Job(long id)
        {
            Id = id;
        }
 
        Job(JobCode code, User? startedBy, Api.Models.Instance instance, RightsType? cancelRightsType, ulong? cancelRight)
        {
            StartedBy = startedBy;
            ArgumentNullException.ThrowIfNull(instance);
            Instance = new Instance
            {
                Id = instance.Id ?? throw new InvalidOperationException("Instance associated with job does not have an Id!"),
            };
            Description = typeof(JobCode)
                .GetField(code.ToString())!
                .GetCustomAttributes(false)
                .OfType<DescriptionAttribute>()
                .First()
                .Description;
            JobCode = code;
            CancelRight = cancelRight;
            CancelRightsType = cancelRightsType;
        }
 
        public JobResponse ToApi() => new()
        {
            Id = Id,
            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,
            CancelledBy = CancelledBy?.CreateUserName(),
            CancelRight = CancelRight,
            CancelRightsType = CancelRightsType,
            Description = Description,
            ExceptionDetails = ExceptionDetails,
            ErrorCode = ErrorCode,
            StartedBy = (StartedBy ?? throw new InvalidOperationException("StartedBy needs to be set!")).CreateUserName(),
        };
    }
}