Instance.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
 
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Logging;
 
using NCrontab;
 
using Serilog.Context;
 
using Tgstation.Server.Api.Rights;
using Tgstation.Server.Host.Components.Chat;
using Tgstation.Server.Host.Components.Deployment;
using Tgstation.Server.Host.Components.Deployment.Remote;
using Tgstation.Server.Host.Components.Engine;
using Tgstation.Server.Host.Components.Events;
using Tgstation.Server.Host.Components.Repository;
using Tgstation.Server.Host.Components.Watchdog;
using Tgstation.Server.Host.Database;
using Tgstation.Server.Host.Jobs;
using Tgstation.Server.Host.Models;
using Tgstation.Server.Host.Utils;
 
namespace Tgstation.Server.Host.Components
{
#pragma warning disable CA1506 // TODO: Decomplexify
    sealed class Instance : IInstance
    {
        public const string DifferentCoreExceptionMessage = "Job started on different instance core!";
 
        public IRepositoryManager RepositoryManager { get; }
 
        public IEngineManager EngineManager { get; }
 
        public IWatchdog Watchdog { get; }
 
        public IChatManager Chat { get; }
 
        public StaticFiles.IConfiguration Configuration { get; }
 
        public IDreamMaker DreamMaker { get; }
 
        readonly IDmbFactory dmbFactory;
 
        readonly IJobManager jobManager;
 
        readonly IEventConsumer eventConsumer;
 
        readonly IRemoteDeploymentManagerFactory remoteDeploymentManagerFactory;
 
        readonly IAsyncDelayer asyncDelayer;
 
        readonly ILogger<Instance> logger;
 
        readonly Api.Models.Instance metadata;
 
        readonly object timerLock;
 
        Task? autoUpdateTask;
 
        CancellationTokenSource? autoUpdateCts;
 
        Task? autoStartTask;
 
        CancellationTokenSource? autoStartCts;
 
        Task? autoStopTask;
 
        CancellationTokenSource? autoStopCts;
 
        public Instance(
            Api.Models.Instance metadata,
            IRepositoryManager repositoryManager,
            IEngineManager engineManager,
            IDreamMaker dreamMaker,
            IWatchdog watchdog,
            IChatManager chat,
            StaticFiles.IConfiguration
            configuration,
            IDmbFactory dmbFactory,
            IJobManager jobManager,
            IEventConsumer eventConsumer,
            IRemoteDeploymentManagerFactory remoteDeploymentManagerFactory,
            IAsyncDelayer asyncDelayer,
            ILogger<Instance> logger)
        {
            this.metadata = metadata ?? throw new ArgumentNullException(nameof(metadata));
            RepositoryManager = repositoryManager ?? throw new ArgumentNullException(nameof(repositoryManager));
            EngineManager = engineManager ?? throw new ArgumentNullException(nameof(engineManager));
            DreamMaker = dreamMaker ?? throw new ArgumentNullException(nameof(dreamMaker));
            Watchdog = watchdog ?? throw new ArgumentNullException(nameof(watchdog));
            Chat = chat ?? throw new ArgumentNullException(nameof(chat));
            Configuration = configuration ?? throw new ArgumentNullException(nameof(configuration));
            this.dmbFactory = dmbFactory ?? throw new ArgumentNullException(nameof(dmbFactory));
            this.jobManager = jobManager ?? throw new ArgumentNullException(nameof(jobManager));
            this.eventConsumer = eventConsumer ?? throw new ArgumentNullException(nameof(eventConsumer));
            this.remoteDeploymentManagerFactory = remoteDeploymentManagerFactory ?? throw new ArgumentNullException(nameof(remoteDeploymentManagerFactory));
            this.asyncDelayer = asyncDelayer ?? throw new ArgumentNullException(nameof(asyncDelayer));
            this.logger = logger ?? throw new ArgumentNullException(nameof(logger));
 
            timerLock = new object();
        }
 
        public async ValueTask DisposeAsync()
        {
            using (LogContext.PushProperty(SerilogContextHelper.InstanceIdContextProperty, metadata.Id))
            {
                var chatDispose = Chat.DisposeAsync();
                var watchdogDispose = Watchdog.DisposeAsync();
                autoUpdateCts?.Dispose();
                autoStartCts?.Dispose();
                autoStopCts?.Dispose();
                Configuration.Dispose();
                dmbFactory.Dispose();
                RepositoryManager.Dispose();
                EngineManager.Dispose();
                await chatDispose;
                await watchdogDispose;
            }
        }
 
        public ValueTask InstanceRenamed(string newName, CancellationToken cancellationToken)
        {
            ArgumentNullException.ThrowIfNull(newName);
            if (String.IsNullOrWhiteSpace(newName))
                throw new ArgumentException("newName cannot be whitespace!", nameof(newName));
 
            metadata.Name = newName;
            return Watchdog.InstanceRenamed(newName, cancellationToken);
        }
 
        public async Task StartAsync(CancellationToken cancellationToken)
        {
            using (LogContext.PushProperty(SerilogContextHelper.InstanceIdContextProperty, metadata.Id))
            {
                await Task.WhenAll(
                    ScheduleAutoUpdate(metadata.Require(x => x.AutoUpdateInterval), metadata.AutoUpdateCron).AsTask(),
                    ScheduleServerStart(null).AsTask(),
                    ScheduleServerStop(null).AsTask(),
                    Configuration.StartAsync(cancellationToken),
                    EngineManager.StartAsync(cancellationToken),
                    Chat.StartAsync(cancellationToken),
                    dmbFactory.StartAsync(cancellationToken));
 
                // dependent on so many things, its just safer this way
                await Watchdog.StartAsync(cancellationToken);
 
                await dmbFactory.CleanUnusedCompileJobs(cancellationToken);
            }
        }
 
        public async Task StopAsync(CancellationToken cancellationToken)
        {
            using (LogContext.PushProperty(SerilogContextHelper.InstanceIdContextProperty, metadata.Id))
            {
                logger.LogDebug("Stopping instance...");
                await ScheduleAutoUpdate(0, null);
                await Watchdog.StopAsync(cancellationToken);
                await Task.WhenAll(
                    Configuration.StopAsync(cancellationToken),
                    EngineManager.StopAsync(cancellationToken),
                    Chat.StopAsync(cancellationToken),
                    dmbFactory.StopAsync(cancellationToken));
            }
        }
 
        public async ValueTask ScheduleAutoUpdate(uint newInterval, string? newCron)
        {
            if (newInterval > 0 && !String.IsNullOrWhiteSpace(newCron))
                throw new ArgumentException("Only one of newInterval and newCron may be set!");
 
            Task toWait;
            lock (timerLock)
                if (autoUpdateTask != null)
                {
                    logger.LogTrace("Cancelling auto-update task");
                    autoUpdateCts!.Cancel();
                    autoUpdateCts.Dispose();
                    toWait = autoUpdateTask;
                    autoUpdateTask = null;
                    autoUpdateCts = null;
                }
                else
                    toWait = Task.CompletedTask;
 
            await toWait;
            if (newInterval == 0 && String.IsNullOrWhiteSpace(newCron))
            {
                logger.LogTrace("Auto-update disabled 0. Not starting task.");
                return;
            }
 
            lock (timerLock)
            {
                // race condition, just quit
                if (autoUpdateTask != null)
                {
                    logger.LogWarning("Aborting auto-update scheduling change due to race condition!");
                    return;
                }
 
                autoUpdateCts = new CancellationTokenSource();
                autoUpdateTask = TimerLoop(AutoUpdateAction, "auto-update", newInterval, newCron, autoUpdateCts.Token);
            }
        }
 
        public async ValueTask ScheduleServerStart(string? newCron)
        {
            Task toWait;
            lock (timerLock)
                if (autoStartTask != null)
                {
                    logger.LogTrace("Cancelling auto-start task");
                    autoStartCts!.Cancel();
                    autoStartCts.Dispose();
                    toWait = autoStartTask;
                    autoStartTask = null;
                    autoStartCts = null;
                }
                else
                    toWait = Task.CompletedTask;
 
            await toWait;
            if (String.IsNullOrWhiteSpace(newCron))
            {
                logger.LogTrace("Auto-start disabled. Not starting task.");
                return;
            }
 
            lock (timerLock)
            {
                // race condition, just quit
                if (autoStartTask != null)
                {
                    logger.LogWarning("Aborting auto-start scheduling change due to race condition!");
                    return;
                }
 
                autoStartCts = new CancellationTokenSource();
                autoStartTask = TimerLoop(Watchdog.Launch, "auto-start", 0, newCron, autoStartCts.Token);
            }
        }
 
        public async ValueTask ScheduleServerStop(string? newCron)
        {
            Task toWait;
            lock (timerLock)
                if (autoStopTask != null)
                {
                    logger.LogTrace("Cancelling auto-stop task");
                    autoStopCts!.Cancel();
                    autoStopCts.Dispose();
                    toWait = autoStopTask;
                    autoStopTask = null;
                    autoStopCts = null;
                }
                else
                    toWait = Task.CompletedTask;
 
            await toWait;
            if (String.IsNullOrWhiteSpace(newCron))
            {
                logger.LogTrace("Auto-stop disabled. Not stoping task.");
                return;
            }
 
            lock (timerLock)
            {
                // race condition, just quit
                if (autoStopTask != null)
                {
                    logger.LogWarning("Aborting auto-stop scheduling change due to race condition!");
                    return;
                }
 
                autoStopCts = new CancellationTokenSource();
                autoStopTask = TimerLoop(
                    async cancellationToken => await Watchdog.Terminate(true, cancellationToken),
                    "auto-stop",
                    0,
                    newCron,
                    autoStopCts.Token);
            }
        }
 
        public ValueTask<CompileJob?> LatestCompileJob() => dmbFactory.LatestCompileJob();
 
#pragma warning disable CA1502 // Cyclomatic complexity
        ValueTask RepositoryAutoUpdateJob(
            IInstanceCore? core,
            IDatabaseContextFactory databaseContextFactory,
            Job job,
            JobProgressReporter progressReporter,
            CancellationToken cancellationToken)
            => databaseContextFactory.UseContext(
                async databaseContext =>
                {
                    if (core != this)
                        throw new InvalidOperationException(DifferentCoreExceptionMessage);
 
                    // assume 5 steps with synchronize
                    var repositorySettingsTask = databaseContext
                        .RepositorySettings
                        .Where(x => x.InstanceId == metadata.Id)
                        .FirstAsync(cancellationToken);
 
                    const int ProgressSections = 7;
                    JobProgressReporter NextProgressReporter(string stage)
                    {
                        return progressReporter.CreateSection(stage, 1.0 / ProgressSections);
                    }
 
                    using var repo = await RepositoryManager.LoadRepository(cancellationToken);
                    if (repo == null)
                    {
                        logger.LogTrace("Aborting repo update, no repository!");
                        return;
                    }
 
                    var startSha = repo.Head;
                    if (!repo.Tracking)
                    {
                        logger.LogTrace("Aborting repo update, active ref not tracking any remote branch!");
                        return;
                    }
 
                    var repositorySettings = await repositorySettingsTask;
 
                    // the main point of auto update is to pull the remote
                    await repo.FetchOrigin(
                        NextProgressReporter("Fetch Origin"),
                        repositorySettings.AccessUser,
                        repositorySettings.AccessToken,
                        true,
                        cancellationToken);
 
                    var hasDbChanges = false;
                    RevisionInformation? currentRevInfo = null;
                    Models.Instance? attachedInstance = null;
                    async ValueTask UpdateRevInfo(string currentHead, bool onOrigin, IEnumerable<TestMerge>? updatedTestMerges)
                    {
                        if (currentRevInfo == null)
                        {
                            logger.LogTrace("Loading revision info for commit {sha}...", startSha[..7]);
                            currentRevInfo = await databaseContext
                                .RevisionInformations
                                .Where(x => x.CommitSha == startSha && x.InstanceId == metadata.Id)
                                .Include(x => x.ActiveTestMerges!)
                                    .ThenInclude(x => x.TestMerge)
                                .FirstOrDefaultAsync(cancellationToken);
                        }
 
                        if (currentRevInfo == default)
                        {
                            logger.LogInformation(Repository.Repository.OriginTrackingErrorTemplate, currentHead);
                            onOrigin = true;
                        }
                        else if (currentRevInfo.CommitSha == currentHead)
                        {
                            logger.LogTrace("Not updating rev-info, already in DB.");
                            return;
                        }
 
                        if (attachedInstance == null)
                        {
                            attachedInstance = new Models.Instance
                            {
                                Id = metadata.Id,
                            };
                            databaseContext.Instances.Attach(attachedInstance);
                        }
 
                        var oldRevInfo = currentRevInfo;
                        currentRevInfo = new RevisionInformation
                        {
                            CommitSha = currentHead,
                            Timestamp = await repo.TimestampCommit(currentHead, cancellationToken),
                            OriginCommitSha = onOrigin
                                ? currentHead
                                : await repo.GetOriginSha(cancellationToken),
                            Instance = attachedInstance,
                        };
 
                        if (!onOrigin)
                        {
                            var testMerges = updatedTestMerges ?? oldRevInfo!.ActiveTestMerges!.Select(x => x.TestMerge);
                            var revInfoTestMerges = testMerges.Select(
                                testMerge => new RevInfoTestMerge(testMerge, currentRevInfo))
                                .ToList();
 
                            currentRevInfo.ActiveTestMerges = revInfoTestMerges;
                        }
 
                        databaseContext.RevisionInformations.Add(currentRevInfo);
                        hasDbChanges = true;
                    }
 
                    // build current commit data if it's missing
                    await UpdateRevInfo(repo.Head, false, null);
 
                    var preserveTestMerges = repositorySettings.AutoUpdatesKeepTestMerges!.Value;
                    var remoteDeploymentManager = remoteDeploymentManagerFactory.CreateRemoteDeploymentManager(
                        metadata,
                        repo.RemoteGitProvider!.Value);
 
                    var updatedTestMerges = await remoteDeploymentManager.RemoveMergedTestMerges(
                        repo,
                        repositorySettings,
                        currentRevInfo!,
                        cancellationToken);
 
                    var result = await repo.MergeOrigin(
                        NextProgressReporter("Merge Origin"),
                        repositorySettings.CommitterName!,
                        repositorySettings.CommitterEmail!,
                        true,
                        cancellationToken);
 
                    // take appropriate auto update actions
                    var shouldSyncTracked = false;
                    if (result.HasValue)
                    {
                        if (updatedTestMerges.Count == 0)
                        {
                            logger.LogTrace("All test merges have been merged on remote");
                            preserveTestMerges = false;
                        }
                        else
                        {
                            var lastRevInfoWasOriginCommit =
                                currentRevInfo == default
                                || currentRevInfo.CommitSha == currentRevInfo.OriginCommitSha;
                            var stillOnOrigin = result.Value && lastRevInfoWasOriginCommit;
 
                            var currentHead = repo.Head;
                            if (currentHead != startSha)
                            {
                                await UpdateRevInfo(currentHead, stillOnOrigin, updatedTestMerges);
                                shouldSyncTracked = stillOnOrigin;
                            }
                        }
                    }
                    else if (preserveTestMerges)
                    {
                        Chat.QueueRawDeploymentMessage("Automatic update has failed due to a conflicting testmerge!");
                        throw new JobException(Api.Models.ErrorCode.InstanceUpdateTestMergeConflict);
                    }
 
                    if (!preserveTestMerges)
                    {
                        const string StageName = "Resetting to origin...";
                        logger.LogTrace(StageName);
                        await repo.ResetToOrigin(
                            NextProgressReporter(StageName),
                            repositorySettings.AccessUser,
                            repositorySettings.AccessToken,
                            repositorySettings.UpdateSubmodules!.Value,
                            true,
                            cancellationToken);
 
                        var currentHead = repo.Head;
 
                        currentRevInfo = await databaseContext
                            .RevisionInformations
                            .Where(x => x.CommitSha == currentHead && x.InstanceId == metadata.Id)
                            .FirstOrDefaultAsync(cancellationToken);
 
                        if (currentHead != startSha && currentRevInfo == default)
                            await UpdateRevInfo(currentHead, true, null);
 
                        shouldSyncTracked = true;
                    }
 
                    // synch if necessary
                    if (repositorySettings.AutoUpdatesSynchronize!.Value && startSha != repo.Head && (shouldSyncTracked || repositorySettings.PushTestMergeCommits!.Value))
                    {
                        var pushedOrigin = await repo.Synchronize(
                            NextProgressReporter("Synchronize"),
                            repositorySettings.AccessUser,
                            repositorySettings.AccessToken,
                            repositorySettings.CommitterName!,
                            repositorySettings.CommitterEmail!,
                            shouldSyncTracked,
                            true,
                            cancellationToken);
                        var currentHead = repo.Head;
                        if (currentHead != currentRevInfo!.CommitSha)
                            await UpdateRevInfo(currentHead, pushedOrigin, null);
                    }
 
                    if (hasDbChanges)
                        try
                        {
                            await databaseContext.Save(cancellationToken);
                        }
                        catch
                        {
                            // DCT: Cancellation token is for job, operation must run regardless
                            await repo.ResetToSha(startSha, progressReporter, CancellationToken.None);
                            throw;
                        }
                });
#pragma warning restore CA1502   // Cyclomatic complexity
 
        async Task TimerLoop(Func<CancellationToken, ValueTask> timerAction, string description, uint minutes, string? cron, CancellationToken cancellationToken)
        {
            logger.LogDebug("Entering auto-update loop");
            while (true)
                try
                {
                    TimeSpan delay;
                    if (!String.IsNullOrWhiteSpace(cron))
                    {
                        logger.LogTrace("Using cron schedule: {cron}", cron);
                        var schedule = CrontabSchedule.Parse(
                            cron,
                            new CrontabSchedule.ParseOptions
                            {
                                IncludingSeconds = true,
                            });
                        var now = DateTime.UtcNow;
                        var nextOccurrence = schedule.GetNextOccurrence(now);
                        delay = nextOccurrence - now;
                    }
                    else
                    {
                        logger.LogTrace("Using interval: {interval}m", minutes);
 
                        delay = TimeSpan.FromMinutes(minutes);
                    }
 
                    logger.LogInformation("Next {desc} will occur at {time}", description, DateTimeOffset.UtcNow + delay);
 
                    await asyncDelayer.Delay(delay, cancellationToken);
 
                    await timerAction(cancellationToken);
                }
                catch (OperationCanceledException)
                {
                    logger.LogDebug("Cancelled {desc} loop!", description);
                    break;
                }
                catch (Exception e)
                {
                    logger.LogError(e, "Error in {desc} loop!", description);
                    continue;
                }
 
            logger.LogTrace("Leaving {desc} loop...", description);
        }
 
        async ValueTask AutoUpdateAction(CancellationToken cancellationToken)
        {
            logger.LogInformation("Beginning auto update...");
            await eventConsumer.HandleEvent(EventType.InstanceAutoUpdateStart, Enumerable.Empty<string>(), true, cancellationToken);
 
            var repositoryUpdateJob = Job.Create(Api.Models.JobCode.RepositoryAutoUpdate, null, metadata, RepositoryRights.CancelPendingChanges);
            await jobManager.RegisterOperation(
                repositoryUpdateJob,
                RepositoryAutoUpdateJob,
                cancellationToken);
 
            var repoUpdateJobResult = await jobManager.WaitForJobCompletion(repositoryUpdateJob, null, cancellationToken, cancellationToken);
            if (repoUpdateJobResult == false)
            {
                logger.LogWarning("Aborting auto-update due to repository update error!");
                return;
            }
 
            Job compileProcessJob;
            using (var repo = await RepositoryManager.LoadRepository(cancellationToken))
            {
                if (repo == null)
                    throw new JobException(Api.Models.ErrorCode.RepoMissing);
 
                var deploySha = repo.Head;
                if (deploySha == null)
                {
                    logger.LogTrace("Aborting auto update, repository error!");
                    return;
                }
 
                if (deploySha == (await LatestCompileJob())?.RevisionInformation.CommitSha)
                {
                    logger.LogTrace("Aborting auto update, same revision as latest CompileJob");
                    return;
                }
 
                // finally set up the job
                compileProcessJob = Job.Create(Api.Models.JobCode.AutomaticDeployment, null, metadata, DreamMakerRights.CancelCompile);
                await jobManager.RegisterOperation(
                    compileProcessJob,
                    (core, databaseContextFactory, job, progressReporter, jobCancellationToken) =>
                    {
                        if (core != this)
                            throw new InvalidOperationException(DifferentCoreExceptionMessage);
                        return DreamMaker.DeploymentProcess(
                            job,
                            databaseContextFactory,
                            progressReporter,
                            jobCancellationToken);
                    },
                    cancellationToken);
            }
 
            await jobManager.WaitForJobCompletion(compileProcessJob, null, default, cancellationToken);
        }
    }
}