diff --git a/.github/workflows/ci-pipeline.yml b/.github/workflows/ci-pipeline.yml index 6ce724ea5d3..8e75c03afb2 100644 --- a/.github/workflows/ci-pipeline.yml +++ b/.github/workflows/ci-pipeline.yml @@ -365,7 +365,7 @@ jobs: fail-fast: false matrix: database-type: [ 'SqlServer', 'Sqlite', 'PostgresSql', 'MariaDB', 'MySql' ] - watchdog-type: [ 'Basic', 'System' ] + watchdog-type: [ 'Basic', 'Advanced' ] configuration: [ 'Debug', 'Release' ] runs-on: windows-latest steps: @@ -382,7 +382,7 @@ jobs: dotnet-version: ${{ env.TGS_DOTNET_VERSION }} - name: Set TGS_TEST_DUMP_API_SPEC - if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'System' && matrix.database-type == 'SqlServer' }} + if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'Advanced' && matrix.database-type == 'SqlServer' }} run: echo "TGS_TEST_DUMP_API_SPEC=yes" >> $Env:GITHUB_ENV - name: Set General__UseBasicWatchdog @@ -473,7 +473,7 @@ jobs: path: ./TestResults/ - name: Store OpenAPI Spec - if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'System' && matrix.database-type == 'SqlServer' }} + if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'Advanced' && matrix.database-type == 'SqlServer' }} uses: actions/upload-artifact@v3 with: name: openapi-spec @@ -562,7 +562,7 @@ jobs: fail-fast: false matrix: database-type: [ 'Sqlite', 'PostgresSql', 'MariaDB', 'MySql' ] - watchdog-type: [ 'Basic', 'System' ] + watchdog-type: [ 'Basic', 'Advanced' ] configuration: [ 'Debug', 'Release' ] runs-on: ubuntu-latest steps: @@ -645,7 +645,7 @@ jobs: path: ./TestResults/ - name: Package Server Console - if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'System' && matrix.database-type == 'MariaDB' }} + if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'Advanced' && matrix.database-type == 'MariaDB' }} run: | cd src/Tgstation.Server.Host.Console dotnet publish -c ${{ matrix.configuration }} -o ../../artifacts/Console @@ -657,7 +657,7 @@ jobs: build/RemoveUnsupportedRuntimes.sh artifacts/Console - name: Package Server Update Package - if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'System' && matrix.database-type == 'PostgresSql' }} + if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'Advanced' && matrix.database-type == 'PostgresSql' }} run: | cd src/Tgstation.Server.Host dotnet publish -c ${{ matrix.configuration }}NoWindows --no-build -o ../../artifacts/ServerUpdate @@ -666,14 +666,14 @@ jobs: build/RemoveUnsupportedRuntimes.sh artifacts/ServerUpdate - name: Store Server Console - if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'System' && matrix.database-type == 'MariaDB' }} + if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'Advanced' && matrix.database-type == 'MariaDB' }} uses: actions/upload-artifact@v3 with: name: ServerConsole path: artifacts/Console/ - name: Store Server Update Package - if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'System' && matrix.database-type == 'PostgresSql' }} + if: ${{ matrix.configuration == 'Release' && matrix.watchdog-type == 'Advanced' && matrix.database-type == 'PostgresSql' }} uses: actions/upload-artifact@v3 with: name: ServerUpdatePackage @@ -735,100 +735,100 @@ jobs: name: linux-unit-test-coverage-Release path: ./code_coverage/unit_tests/linux_unit_tests_release - - name: Retrieve Linux Integration Test Coverage (Release, System, Sqlite) + - name: Retrieve Linux Integration Test Coverage (Release, Advanced, Sqlite) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Release-System-Sqlite + name: linux-integration-test-coverage-Release-Advanced-Sqlite path: ./code_coverage/integration_tests/linux_integration_tests_release_system_sqlite - - name: Retrieve Linux Integration Test Coverage (Release, System, PostgresSql) + - name: Retrieve Linux Integration Test Coverage (Release, Advanced, PostgresSql) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Release-System-PostgresSql + name: linux-integration-test-coverage-Release-Advanced-PostgresSql path: ./code_coverage/integration_tests/linux_integration_tests_release_system_mariadb - - name: Retrieve Linux Integration Test Coverage (Release, System, MariaDB) + - name: Retrieve Linux Integration Test Coverage (Release, Advanced, MariaDB) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Release-System-MariaDB + name: linux-integration-test-coverage-Release-Advanced-MariaDB path: ./code_coverage/integration_tests/linux_integration_tests_release_system_mysql - - name: Retrieve Linux Integration Test Coverage (Release, System, MySql) + - name: Retrieve Linux Integration Test Coverage (Release, Advanced, MySql) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Release-System-MySql + name: linux-integration-test-coverage-Release-Advanced-MySql path: ./code_coverage/integration_tests/linux_integration_tests_release_system_mysql - name: Retrieve Linux Integration Test Coverage (Release, Basic, Sqlite) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Release-System-Sqlite + name: linux-integration-test-coverage-Release-Advanced-Sqlite path: ./code_coverage/integration_tests/linux_integration_tests_release_basic_sqlite - name: Retrieve Linux Integration Test Coverage (Release, Basic, PostgresSql) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Release-System-PostgresSql + name: linux-integration-test-coverage-Release-Advanced-PostgresSql path: ./code_coverage/integration_tests/linux_integration_tests_release_basic_mariadb - name: Retrieve Linux Integration Test Coverage (Release, Basic, MariaDB) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Release-System-MariaDB + name: linux-integration-test-coverage-Release-Advanced-MariaDB path: ./code_coverage/integration_tests/linux_integration_tests_release_basic_mysql - name: Retrieve Linux Integration Test Coverage (Release, Basic, MySql) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Release-System-MySql + name: linux-integration-test-coverage-Release-Advanced-MySql path: ./code_coverage/integration_tests/linux_integration_tests_release_basic_mysql - - name: Retrieve Linux Integration Test Coverage (Debug, System, Sqlite) + - name: Retrieve Linux Integration Test Coverage (Debug, Advanced, Sqlite) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Debug-System-Sqlite + name: linux-integration-test-coverage-Debug-Advanced-Sqlite path: ./code_coverage/integration_tests/linux_integration_tests_debug_system_sqlite - - name: Retrieve Linux Integration Test Coverage (Debug, System, PostgresSql) + - name: Retrieve Linux Integration Test Coverage (Debug, Advanced, PostgresSql) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Debug-System-PostgresSql + name: linux-integration-test-coverage-Debug-Advanced-PostgresSql path: ./code_coverage/integration_tests/linux_integration_tests_debug_system_mariadb - - name: Retrieve Linux Integration Test Coverage (Debug, System, MariaDB) + - name: Retrieve Linux Integration Test Coverage (Debug, Advanced, MariaDB) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Debug-System-MariaDB + name: linux-integration-test-coverage-Debug-Advanced-MariaDB path: ./code_coverage/integration_tests/linux_integration_tests_debug_system_mysql - - name: Retrieve Linux Integration Test Coverage (Debug, System, MySql) + - name: Retrieve Linux Integration Test Coverage (Debug, Advanced, MySql) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Debug-System-MySql + name: linux-integration-test-coverage-Debug-Advanced-MySql path: ./code_coverage/integration_tests/linux_integration_tests_debug_system_mysql - name: Retrieve Linux Integration Test Coverage (Debug, Basic, Sqlite) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Debug-System-Sqlite + name: linux-integration-test-coverage-Debug-Advanced-Sqlite path: ./code_coverage/integration_tests/linux_integration_tests_debug_basic_sqlite - name: Retrieve Linux Integration Test Coverage (Debug, Basic, PostgresSql) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Debug-System-PostgresSql + name: linux-integration-test-coverage-Debug-Advanced-PostgresSql path: ./code_coverage/integration_tests/linux_integration_tests_debug_basic_mariadb - name: Retrieve Linux Integration Test Coverage (Debug, Basic, MariaDB) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Debug-System-MariaDB + name: linux-integration-test-coverage-Debug-Advanced-MariaDB path: ./code_coverage/integration_tests/linux_integration_tests_debug_basic_mysql - name: Retrieve Linux Integration Test Coverage (Debug, Basic, MySql) uses: actions/download-artifact@v3 with: - name: linux-integration-test-coverage-Debug-System-MySql + name: linux-integration-test-coverage-Debug-Advanced-MySql path: ./code_coverage/integration_tests/linux_integration_tests_debug_basic_mysql - name: Retrieve Windows Unit Test Coverage (Release) @@ -849,16 +849,16 @@ jobs: name: windows-integration-test-coverage-Release-Basic-SqlServer path: ./code_coverage/integration_tests/windows_integration_tests_release_basic_sqlserver - - name: Retrieve Windows Integration Test Coverage (Debug, System, SqlServer) + - name: Retrieve Windows Integration Test Coverage (Debug, Advanced, SqlServer) uses: actions/download-artifact@v3 with: - name: windows-integration-test-coverage-Debug-System-SqlServer + name: windows-integration-test-coverage-Debug-Advanced-SqlServer path: ./code_coverage/integration_tests/windows_integration_tests_debug_system_sqlserver - - name: Retrieve Windows Integration Test Coverage (Release, System, SqlServer) + - name: Retrieve Windows Integration Test Coverage (Release, Advanced, SqlServer) uses: actions/download-artifact@v3 with: - name: windows-integration-test-coverage-Release-System-SqlServer + name: windows-integration-test-coverage-Release-Advanced-SqlServer path: ./code_coverage/integration_tests/windows_integration_tests_release_system_sqlserver - name: Retrieve Windows Integration Test Coverage (Debug, Basic, MariaDB) @@ -873,16 +873,16 @@ jobs: name: windows-integration-test-coverage-Release-Basic-MariaDB path: ./code_coverage/integration_tests/windows_integration_tests_release_basic_mariadb - - name: Retrieve Windows Integration Test Coverage (Debug, System, MariaDB) + - name: Retrieve Windows Integration Test Coverage (Debug, Advanced, MariaDB) uses: actions/download-artifact@v3 with: - name: windows-integration-test-coverage-Debug-System-MariaDB + name: windows-integration-test-coverage-Debug-Advanced-MariaDB path: ./code_coverage/integration_tests/windows_integration_tests_debug_system_mariadb - - name: Retrieve Windows Integration Test Coverage (Release, System, MariaDB) + - name: Retrieve Windows Integration Test Coverage (Release, Advanced, MariaDB) uses: actions/download-artifact@v3 with: - name: windows-integration-test-coverage-Release-System-MariaDB + name: windows-integration-test-coverage-Release-Advanced-MariaDB path: ./code_coverage/integration_tests/windows_integration_tests_release_system_mariadb - name: Retrieve Windows Integration Test Coverage (Debug, Basic, MySql) @@ -897,16 +897,16 @@ jobs: name: windows-integration-test-coverage-Release-Basic-MySql path: ./code_coverage/integration_tests/windows_integration_tests_release_basic_mysql - - name: Retrieve Windows Integration Test Coverage (Debug, System, MySql) + - name: Retrieve Windows Integration Test Coverage (Debug, Advanced, MySql) uses: actions/download-artifact@v3 with: - name: windows-integration-test-coverage-Debug-System-MySql + name: windows-integration-test-coverage-Debug-Advanced-MySql path: ./code_coverage/integration_tests/windows_integration_tests_debug_system_mysql - - name: Retrieve Windows Integration Test Coverage (Release, System, MySql) + - name: Retrieve Windows Integration Test Coverage (Release, Advanced, MySql) uses: actions/download-artifact@v3 with: - name: windows-integration-test-coverage-Release-System-MySql + name: windows-integration-test-coverage-Release-Advanced-MySql path: ./code_coverage/integration_tests/windows_integration_tests_release_system_mysql - name: Retrieve Windows Integration Test Coverage (Debug, Basic, PostgresSql) @@ -921,16 +921,16 @@ jobs: name: windows-integration-test-coverage-Release-Basic-PostgresSql path: ./code_coverage/integration_tests/windows_integration_tests_release_basic_postgressql - - name: Retrieve Windows Integration Test Coverage (Debug, System, PostgresSql) + - name: Retrieve Windows Integration Test Coverage (Debug, Advanced, PostgresSql) uses: actions/download-artifact@v3 with: - name: windows-integration-test-coverage-Debug-System-PostgresSql + name: windows-integration-test-coverage-Debug-Advanced-PostgresSql path: ./code_coverage/integration_tests/windows_integration_tests_debug_system_postgressql - - name: Retrieve Windows Integration Test Coverage (Release, System, PostgresSql) + - name: Retrieve Windows Integration Test Coverage (Release, Advanced, PostgresSql) uses: actions/download-artifact@v3 with: - name: windows-integration-test-coverage-Release-System-PostgresSql + name: windows-integration-test-coverage-Release-Advanced-PostgresSql path: ./code_coverage/integration_tests/windows_integration_tests_release_system_postgressql - name: Retrieve Windows Integration Test Coverage (Debug, Basic, Sqlite) @@ -945,16 +945,16 @@ jobs: name: windows-integration-test-coverage-Release-Basic-Sqlite path: ./code_coverage/integration_tests/windows_integration_tests_release_basic_sqlite - - name: Retrieve Windows Integration Test Coverage (Debug, System, Sqlite) + - name: Retrieve Windows Integration Test Coverage (Debug, Advanced, Sqlite) uses: actions/download-artifact@v3 with: - name: windows-integration-test-coverage-Debug-System-Sqlite + name: windows-integration-test-coverage-Debug-Advanced-Sqlite path: ./code_coverage/integration_tests/windows_integration_tests_debug_system_sqlite - - name: Retrieve Windows Integration Test Coverage (Release, System, Sqlite) + - name: Retrieve Windows Integration Test Coverage (Release, Advanced, Sqlite) uses: actions/download-artifact@v3 with: - name: windows-integration-test-coverage-Release-System-Sqlite + name: windows-integration-test-coverage-Release-Advanced-Sqlite path: ./code_coverage/integration_tests/windows_integration_tests_release_system_sqlite - name: Upload Coverage to CodeCov diff --git a/build/Version.props b/build/Version.props index 4a4c556f247..c9c9e39ca0a 100644 --- a/build/Version.props +++ b/build/Version.props @@ -3,7 +3,7 @@ - 5.16.2 + 5.16.3 4.7.1 9.12.0 6.0.1 diff --git a/src/Tgstation.Server.Host/Components/Deployment/DmbFactory.cs b/src/Tgstation.Server.Host/Components/Deployment/DmbFactory.cs index 09567ba79cd..df587cab111 100644 --- a/src/Tgstation.Server.Host/Components/Deployment/DmbFactory.cs +++ b/src/Tgstation.Server.Host/Components/Deployment/DmbFactory.cs @@ -148,15 +148,18 @@ await remoteDeploymentManager.StageDeployment( cancellationToken); } + ValueTask dmbDisposeTask; lock (jobLockCounts) { - nextDmbProvider?.Dispose(); + dmbDisposeTask = nextDmbProvider?.DisposeAsync() ?? ValueTask.CompletedTask; nextDmbProvider = newProvider; // Oh god dammit var temp = Interlocked.Exchange(ref newerDmbTcs, new TaskCompletionSource()); temp.SetResult(); } + + await dmbDisposeTask; } /// @@ -320,7 +323,7 @@ void CleanupAction() finally { if (!providerSubmitted) - newProvider.Dispose(); + await newProvider.DisposeAsync(); } } #pragma warning restore CA1506 diff --git a/src/Tgstation.Server.Host/Components/Deployment/DmbProvider.cs b/src/Tgstation.Server.Host/Components/Deployment/DmbProvider.cs index f3711ede4f8..770409f7902 100644 --- a/src/Tgstation.Server.Host/Components/Deployment/DmbProvider.cs +++ b/src/Tgstation.Server.Host/Components/Deployment/DmbProvider.cs @@ -1,4 +1,5 @@ using System; +using System.Threading.Tasks; using Tgstation.Server.Host.IO; using Tgstation.Server.Host.Models; @@ -30,7 +31,7 @@ sealed class DmbProvider : IDmbProvider readonly string directoryAppend; /// - /// The to run when is called. + /// The to run when is called. /// Action onDispose; @@ -50,7 +51,11 @@ public DmbProvider(CompileJob compileJob, IIOManager ioManager, Action onDispose } /// - public void Dispose() => onDispose?.Invoke(); + public ValueTask DisposeAsync() + { + onDispose?.Invoke(); + return ValueTask.CompletedTask; + } /// public void KeepAlive() => onDispose = null; diff --git a/src/Tgstation.Server.Host/Components/Deployment/DreamMaker.cs b/src/Tgstation.Server.Host/Components/Deployment/DreamMaker.cs index 665efba795e..307a1bb1070 100644 --- a/src/Tgstation.Server.Host/Components/Deployment/DreamMaker.cs +++ b/src/Tgstation.Server.Host/Components/Deployment/DreamMaker.cs @@ -802,7 +802,7 @@ async Task VerifyApi( job.MinimumSecurityLevel = securityLevel; // needed for the TempDmbProvider ApiValidationStatus validationStatus; - using (var provider = new TemporaryDmbProvider(ioManager.ResolvePath(job.DirectoryName.ToString()), String.Concat(job.DmeName, DmbExtension), job)) + await using (var provider = new TemporaryDmbProvider(ioManager.ResolvePath(job.DirectoryName.ToString()), String.Concat(job.DmeName, DmbExtension), job)) await using (var controller = await sessionControllerFactory.LaunchNew(provider, byondLock, launchParameters, true, cancellationToken)) { var launchResult = await controller.LaunchResult.WaitAsync(cancellationToken); diff --git a/src/Tgstation.Server.Host/Components/Deployment/HardLinkDmbProvider.cs b/src/Tgstation.Server.Host/Components/Deployment/HardLinkDmbProvider.cs new file mode 100644 index 00000000000..cd9a3f1185a --- /dev/null +++ b/src/Tgstation.Server.Host/Components/Deployment/HardLinkDmbProvider.cs @@ -0,0 +1,224 @@ +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Globalization; +using System.IO; +using System.Threading; +using System.Threading.Tasks; + +using Microsoft.Extensions.Logging; + +using Tgstation.Server.Host.Configuration; +using Tgstation.Server.Host.Extensions; +using Tgstation.Server.Host.IO; +using Tgstation.Server.Host.Utils; + +namespace Tgstation.Server.Host.Components.Deployment +{ + /// + /// A that uses hard links. + /// + sealed class HardLinkDmbProvider : SwappableDmbProvider + { + /// + /// The for . + /// + readonly CancellationTokenSource cancellationTokenSource; + + /// + /// The representing the base provider mirroring operation. + /// + readonly Task mirroringTask; + + /// + /// The for the . + /// + readonly ILogger logger; + + /// + /// Initializes a new instance of the class. + /// + /// The for the . + /// The for the . + /// The for the . + /// The value of . + /// The for the . + public HardLinkDmbProvider( + IDmbProvider baseProvider, + IIOManager ioManager, + IFilesystemLinkFactory linkFactory, + ILogger logger, + GeneralConfiguration generalConfiguration) + : base( + baseProvider, + ioManager, + linkFactory) + { + this.logger = logger ?? throw new ArgumentNullException(nameof(logger)); + cancellationTokenSource = new CancellationTokenSource(); + try + { + mirroringTask = MirrorSourceDirectory(generalConfiguration.GetCopyDirectoryTaskThrottle(), cancellationTokenSource.Token); + } + catch + { + cancellationTokenSource.Dispose(); + throw; + } + } + + /// + public override async ValueTask DisposeAsync() + { + cancellationTokenSource.Cancel(); + cancellationTokenSource.Dispose(); + try + { + await mirroringTask; + } + catch (OperationCanceledException ex) + { + logger.LogDebug(ex, "Mirroring task cancelled!"); + } + + await base.DisposeAsync(); + } + + /// + public override Task FinishActivationPreparation(CancellationToken cancellationToken) + { + if (!mirroringTask.IsCompleted) + logger.LogTrace("Waiting for mirroring to complete..."); + + return mirroringTask.WaitAsync(cancellationToken); + } + + /// + protected override async Task DoSwap(CancellationToken cancellationToken) + { + var mirroredDir = await mirroringTask.WaitAsync(cancellationToken); + var goAheadTcs = new TaskCompletionSource(); + + // I feel dirty... + async void DisposeOfOldDirectory() + { + var directoryMoved = false; + var disposePath = Guid.NewGuid().ToString(); + try + { + await IOManager.MoveDirectory(LiveGameDirectory, disposePath, cancellationToken); + directoryMoved = true; + goAheadTcs.SetResult(); + await IOManager.DeleteDirectory(disposePath, CancellationToken.None); // DCT: We're detached at this point + } + catch (DirectoryNotFoundException ex) + { + logger.LogDebug(ex, "Live directory appears to not exist"); + if (!directoryMoved) + goAheadTcs.SetResult(); + } + catch (Exception ex) + { + logger.LogWarning(ex, "Failed to delete hard linked directory: {disposePath}", disposePath); + if (!directoryMoved) + goAheadTcs.SetException(ex); + } + } + + DisposeOfOldDirectory(); + await goAheadTcs.Task; + await IOManager.MoveDirectory(mirroredDir, LiveGameDirectory, cancellationToken); + } + + /// + /// Mirror the . + /// + /// The optional maximum number of simultaneous tasks allowed to execute. + /// The for the operation. + /// A resulting in the full path to the mirrored directory. + async Task MirrorSourceDirectory(int? taskThrottle, CancellationToken cancellationToken) + { + var stopwatch = Stopwatch.StartNew(); + var mirrorGuid = Guid.NewGuid(); + logger.LogDebug("Starting to mirror {sourceDir} as hard links to {mirrorGuid}...", CompileJob.DirectoryName, mirrorGuid); + if (taskThrottle.HasValue && taskThrottle < 1) + throw new ArgumentOutOfRangeException(nameof(taskThrottle), taskThrottle, "taskThrottle must be at least 1!"); + + var src = IOManager.ResolvePath(CompileJob.DirectoryName.ToString()); + var dest = IOManager.ResolvePath(mirrorGuid.ToString()); + + using var semaphore = taskThrottle.HasValue ? new SemaphoreSlim(taskThrottle.Value) : null; + await Task.WhenAll(MirrorDirectoryImpl(src, dest, semaphore, cancellationToken)); + stopwatch.Stop(); + + logger.LogDebug( + "Finished mirror of {sourceDir} to {mirrorGuid} in {seconds}s...", + CompileJob.DirectoryName, + mirrorGuid, + stopwatch.Elapsed.TotalSeconds.ToString("0.##", CultureInfo.InvariantCulture)); + + return dest; + } + + /// + /// Recursively create tasks to create a hard link directory mirror of to . + /// + /// The source directory path. + /// The destination directory path. + /// Optional used to limit degree of parallelism. + /// The for the operation. + /// A of s representing the running operations. The first returned is always the necessary call to . + /// I genuinely don't know how this will work with symlinked files. Waiting for the issue report I guess. + IEnumerable MirrorDirectoryImpl(string src, string dest, SemaphoreSlim semaphore, CancellationToken cancellationToken) + { + var dir = new DirectoryInfo(src); + Task subdirCreationTask = null; + foreach (var subDirectory in dir.EnumerateDirectories()) + { + // check if we are a symbolic link + if (!subDirectory.Attributes.HasFlag(FileAttributes.Directory) || subDirectory.Attributes.HasFlag(FileAttributes.ReparsePoint)) + { + logger.LogTrace("Skipping symlink to {subdir}", subDirectory.Name); + continue; + } + + var checkingSubdirCreationTask = true; + foreach (var copyTask in MirrorDirectoryImpl(subDirectory.FullName, Path.Combine(dest, subDirectory.Name), semaphore, cancellationToken)) + { + if (subdirCreationTask == null) + { + subdirCreationTask = copyTask; + yield return subdirCreationTask; + } + else if (!checkingSubdirCreationTask) + yield return copyTask; + + checkingSubdirCreationTask = false; + } + } + + foreach (var fileInfo in dir.EnumerateFiles()) + { + if (subdirCreationTask == null) + { + subdirCreationTask = IOManager.CreateDirectory(dest, cancellationToken); + yield return subdirCreationTask; + } + + var sourceFile = fileInfo.FullName; + var destFile = IOManager.ConcatPath(dest, fileInfo.Name); + + async Task LinkThisFile() + { + await subdirCreationTask.WaitAsync(cancellationToken); + using var lockContext = semaphore != null + ? await SemaphoreSlimContext.Lock(semaphore, cancellationToken) + : null; + await LinkFactory.CreateHardLink(sourceFile, destFile, cancellationToken); + } + + yield return LinkThisFile(); + } + } + } +} diff --git a/src/Tgstation.Server.Host/Components/Deployment/IDmbProvider.cs b/src/Tgstation.Server.Host/Components/Deployment/IDmbProvider.cs index efc773a9193..c1c477ffff7 100644 --- a/src/Tgstation.Server.Host/Components/Deployment/IDmbProvider.cs +++ b/src/Tgstation.Server.Host/Components/Deployment/IDmbProvider.cs @@ -7,7 +7,7 @@ namespace Tgstation.Server.Host.Components.Deployment /// /// Provides absolute paths to the latest compiled .dmbs. /// - public interface IDmbProvider : IDisposable + public interface IDmbProvider : IAsyncDisposable { /// /// The file name of the .dmb. diff --git a/src/Tgstation.Server.Host/Components/Deployment/SwappableDmbProvider.cs b/src/Tgstation.Server.Host/Components/Deployment/SwappableDmbProvider.cs index e4964532229..b00ba3d518e 100644 --- a/src/Tgstation.Server.Host/Components/Deployment/SwappableDmbProvider.cs +++ b/src/Tgstation.Server.Host/Components/Deployment/SwappableDmbProvider.cs @@ -8,23 +8,23 @@ namespace Tgstation.Server.Host.Components.Deployment { /// - /// A that uses symlinks. + /// A that uses filesystem links to change directory structure underneath the server process. /// - sealed class SwappableDmbProvider : IDmbProvider + abstract class SwappableDmbProvider : IDmbProvider { /// - /// The directory where the is symlinked to. + /// The directory where the is symlinked to. /// public const string LiveGameDirectory = "Live"; /// - public string DmbName => baseProvider.DmbName; + public string DmbName => BaseProvider.DmbName; /// - public string Directory => ioManager.ResolvePath(LiveGameDirectory); + public string Directory => IOManager.ResolvePath(LiveGameDirectory); /// - public CompileJob CompileJob => baseProvider.CompileJob; + public CompileJob CompileJob => BaseProvider.CompileJob; /// /// If has been run. @@ -34,17 +34,17 @@ sealed class SwappableDmbProvider : IDmbProvider /// /// The we are swapping for. /// - readonly IDmbProvider baseProvider; + protected IDmbProvider BaseProvider { get; } /// /// The to use. /// - readonly IIOManager ioManager; + protected IIOManager IOManager { get; } /// - /// The to use. + /// The to use. /// - readonly ISymlinkFactory symlinkFactory; + protected IFilesystemLinkFactory LinkFactory { get; } /// /// Backing field for . @@ -54,41 +54,47 @@ sealed class SwappableDmbProvider : IDmbProvider /// /// Initializes a new instance of the class. /// - /// The value of . - /// The value of . - /// The value of . - public SwappableDmbProvider(IDmbProvider baseProvider, IIOManager ioManager, ISymlinkFactory symlinkFactory) + /// The value of . + /// The value of . + /// The value of . + public SwappableDmbProvider(IDmbProvider baseProvider, IIOManager ioManager, IFilesystemLinkFactory symlinkFactory) { - this.baseProvider = baseProvider ?? throw new ArgumentNullException(nameof(baseProvider)); - this.ioManager = ioManager ?? throw new ArgumentNullException(nameof(ioManager)); - this.symlinkFactory = symlinkFactory ?? throw new ArgumentNullException(nameof(symlinkFactory)); + BaseProvider = baseProvider ?? throw new ArgumentNullException(nameof(baseProvider)); + IOManager = ioManager ?? throw new ArgumentNullException(nameof(ioManager)); + LinkFactory = symlinkFactory ?? throw new ArgumentNullException(nameof(symlinkFactory)); } /// - public void Dispose() => baseProvider.Dispose(); + public virtual ValueTask DisposeAsync() => BaseProvider.DisposeAsync(); /// - public void KeepAlive() => baseProvider.KeepAlive(); + public void KeepAlive() => BaseProvider.KeepAlive(); /// /// Make the active by replacing the live link with our . /// /// The for the operation. /// A representing the running operation. - public async Task MakeActive(CancellationToken cancellationToken) + public Task MakeActive(CancellationToken cancellationToken) { if (Interlocked.Exchange(ref swapped, 1) != 0) throw new InvalidOperationException("Already swapped!"); - if (symlinkFactory.SymlinkedDirectoriesAreDeletedAsFiles) - await ioManager.DeleteFile(LiveGameDirectory, cancellationToken); - else - await ioManager.DeleteDirectory(LiveGameDirectory, cancellationToken); - - await symlinkFactory.CreateSymbolicLink( - ioManager.ResolvePath(baseProvider.Directory), - ioManager.ResolvePath(LiveGameDirectory), - cancellationToken); + return DoSwap(cancellationToken); } + + /// + /// Should be . before calling to ensure the is ready to instantly swap. Can be called multiple times. + /// + /// The for the operation. + /// A representing the preparation process. + public abstract Task FinishActivationPreparation(CancellationToken cancellationToken); + + /// + /// Perform the swapping action. + /// + /// The for the operation. + /// A representing the running operation. + protected abstract Task DoSwap(CancellationToken cancellationToken); } } diff --git a/src/Tgstation.Server.Host/Components/Deployment/SymlinkDmbProvider.cs b/src/Tgstation.Server.Host/Components/Deployment/SymlinkDmbProvider.cs new file mode 100644 index 00000000000..2edc58d37eb --- /dev/null +++ b/src/Tgstation.Server.Host/Components/Deployment/SymlinkDmbProvider.cs @@ -0,0 +1,44 @@ +using System.Threading; +using System.Threading.Tasks; + +using Tgstation.Server.Host.IO; + +namespace Tgstation.Server.Host.Components.Deployment +{ + /// + /// A that uses symlinks. + /// + sealed class SymlinkDmbProvider : SwappableDmbProvider + { + /// + /// Initializes a new instance of the class. + /// + /// The for the . + /// The for the . + /// The for the . + public SymlinkDmbProvider( + IDmbProvider baseProvider, + IIOManager ioManager, + IFilesystemLinkFactory linkFactory) + : base(baseProvider, ioManager, linkFactory) + { + } + + /// + public override Task FinishActivationPreparation(CancellationToken cancellationToken) => Task.CompletedTask; + + /// + protected override async Task DoSwap(CancellationToken cancellationToken) + { + if (LinkFactory.SymlinkedDirectoriesAreDeletedAsFiles) + await IOManager.DeleteFile(LiveGameDirectory, cancellationToken); + else + await IOManager.DeleteDirectory(LiveGameDirectory, cancellationToken); + + await LinkFactory.CreateSymbolicLink( + IOManager.ResolvePath(BaseProvider.Directory), + IOManager.ResolvePath(LiveGameDirectory), + cancellationToken); + } + } +} diff --git a/src/Tgstation.Server.Host/Components/Deployment/TemporaryDmbProvider.cs b/src/Tgstation.Server.Host/Components/Deployment/TemporaryDmbProvider.cs index 0bf982cfa38..4476d9d2c3d 100644 --- a/src/Tgstation.Server.Host/Components/Deployment/TemporaryDmbProvider.cs +++ b/src/Tgstation.Server.Host/Components/Deployment/TemporaryDmbProvider.cs @@ -1,4 +1,5 @@ using System; +using System.Threading.Tasks; using Tgstation.Server.Host.Models; @@ -32,9 +33,7 @@ public TemporaryDmbProvider(string directory, string dmb, CompileJob compileJob) } /// - public void Dispose() - { - } + public ValueTask DisposeAsync() => ValueTask.CompletedTask; /// public void KeepAlive() => throw new NotSupportedException(); diff --git a/src/Tgstation.Server.Host/Components/InstanceFactory.cs b/src/Tgstation.Server.Host/Components/InstanceFactory.cs index 8c7a8df85e6..a3c7ba21925 100644 --- a/src/Tgstation.Server.Host/Components/InstanceFactory.cs +++ b/src/Tgstation.Server.Host/Components/InstanceFactory.cs @@ -66,9 +66,9 @@ sealed class InstanceFactory : IInstanceFactory readonly ISynchronousIOManager synchronousIOManager; /// - /// The for the . + /// The for the . /// - readonly ISymlinkFactory symlinkFactory; + readonly IFilesystemLinkFactory linkFactory; /// /// The for the . @@ -173,7 +173,7 @@ sealed class InstanceFactory : IInstanceFactory /// The value of . /// The value of . /// The value of . - /// The value of . + /// The value of . /// The value of . /// The value of . /// The value of . @@ -199,7 +199,7 @@ public InstanceFactory( ITopicClientFactory topicClientFactory, ICryptographySuite cryptographySuite, ISynchronousIOManager synchronousIOManager, - ISymlinkFactory symlinkFactory, + IFilesystemLinkFactory linkFactory, IByondInstaller byondInstaller, IChatManagerFactory chatFactory, IProcessExecutor processExecutor, @@ -225,7 +225,7 @@ public InstanceFactory( this.topicClientFactory = topicClientFactory ?? throw new ArgumentNullException(nameof(topicClientFactory)); this.cryptographySuite = cryptographySuite ?? throw new ArgumentNullException(nameof(cryptographySuite)); this.synchronousIOManager = synchronousIOManager ?? throw new ArgumentNullException(nameof(synchronousIOManager)); - this.symlinkFactory = symlinkFactory ?? throw new ArgumentNullException(nameof(symlinkFactory)); + this.linkFactory = linkFactory ?? throw new ArgumentNullException(nameof(linkFactory)); this.byondInstaller = byondInstaller ?? throw new ArgumentNullException(nameof(byondInstaller)); this.chatFactory = chatFactory ?? throw new ArgumentNullException(nameof(chatFactory)); this.processExecutor = processExecutor ?? throw new ArgumentNullException(nameof(processExecutor)); @@ -275,7 +275,7 @@ public async Task CreateInstance(IBridgeRegistrar bridgeRegistrar, Mo var configuration = new StaticFiles.Configuration( configurationIoManager, synchronousIOManager, - symlinkFactory, + linkFactory, processExecutor, postWriteHandler, platformIdentifier, diff --git a/src/Tgstation.Server.Host/Components/Session/ISessionController.cs b/src/Tgstation.Server.Host/Components/Session/ISessionController.cs index 3ded84429ac..93f10eb17cc 100644 --- a/src/Tgstation.Server.Host/Components/Session/ISessionController.cs +++ b/src/Tgstation.Server.Host/Components/Session/ISessionController.cs @@ -128,7 +128,7 @@ interface ISessionController : IProcessBase, IRenameNotifyee, IAsyncDisposable /// Replace the in use with a given , disposing the old one. /// /// The new . - /// An to be disposed once certain that the original is no longer in use. - IDisposable ReplaceDmbProvider(IDmbProvider newProvider); + /// An to be disposed once certain that the original is no longer in use. + IAsyncDisposable ReplaceDmbProvider(IDmbProvider newProvider); } } diff --git a/src/Tgstation.Server.Host/Components/Session/SessionController.cs b/src/Tgstation.Server.Host/Components/Session/SessionController.cs index 2da8c03b58f..eab32bdce18 100644 --- a/src/Tgstation.Server.Host/Components/Session/SessionController.cs +++ b/src/Tgstation.Server.Host/Components/Session/SessionController.cs @@ -350,8 +350,13 @@ public async ValueTask DisposeAsync() await process.DisposeAsync(); byondLock.Dispose(); bridgeRegistration?.Dispose(); - ReattachInformation.Dmb.Dispose(); - ReattachInformation.InitialDmb?.Dispose(); + var regularDmbDisposeTask = ReattachInformation.Dmb.DisposeAsync(); + var initialDmb = ReattachInformation.InitialDmb; + if (initialDmb != null) + await initialDmb.DisposeAsync(); + + await regularDmbDisposeTask; + chatTrackingContext.Dispose(); reattachTopicCts.Dispose(); @@ -552,7 +557,7 @@ public void ResetRebootState() public void Resume() => process.Resume(); /// - public IDisposable ReplaceDmbProvider(IDmbProvider dmbProvider) + public IAsyncDisposable ReplaceDmbProvider(IDmbProvider dmbProvider) { var oldDmb = ReattachInformation.Dmb; ReattachInformation.Dmb = dmbProvider ?? throw new ArgumentNullException(nameof(dmbProvider)); diff --git a/src/Tgstation.Server.Host/Components/StaticFiles/Configuration.cs b/src/Tgstation.Server.Host/Components/StaticFiles/Configuration.cs index 087503d68c4..eeb5cd71c65 100644 --- a/src/Tgstation.Server.Host/Components/StaticFiles/Configuration.cs +++ b/src/Tgstation.Server.Host/Components/StaticFiles/Configuration.cs @@ -94,9 +94,9 @@ sealed class Configuration : IConfiguration readonly ISynchronousIOManager synchronousIOManager; /// - /// The for . + /// The for . /// - readonly ISymlinkFactory symlinkFactory; + readonly IFilesystemLinkFactory linkFactory; /// /// The for . @@ -153,7 +153,7 @@ sealed class Configuration : IConfiguration /// /// The value of . /// The value of . - /// The value of . + /// The value of . /// The value of . /// The value of . /// The value of . @@ -164,7 +164,7 @@ sealed class Configuration : IConfiguration public Configuration( IIOManager ioManager, ISynchronousIOManager synchronousIOManager, - ISymlinkFactory symlinkFactory, + IFilesystemLinkFactory linkFactory, IProcessExecutor processExecutor, IPostWriteHandler postWriteHandler, IPlatformIdentifier platformIdentifier, @@ -175,7 +175,7 @@ public Configuration( { this.ioManager = ioManager ?? throw new ArgumentNullException(nameof(ioManager)); this.synchronousIOManager = synchronousIOManager ?? throw new ArgumentNullException(nameof(synchronousIOManager)); - this.symlinkFactory = symlinkFactory ?? throw new ArgumentNullException(nameof(symlinkFactory)); + this.linkFactory = linkFactory ?? throw new ArgumentNullException(nameof(linkFactory)); this.processExecutor = processExecutor ?? throw new ArgumentNullException(nameof(processExecutor)); this.postWriteHandler = postWriteHandler ?? throw new ArgumentNullException(nameof(postWriteHandler)); this.platformIdentifier = platformIdentifier ?? throw new ArgumentNullException(nameof(platformIdentifier)); @@ -450,7 +450,7 @@ await Task.WhenAll(entries.Select(async file => var fileExists = await fileExistsTask; if (fileExists) await ioManager.DeleteFile(destPath, cancellationToken); - await symlinkFactory.CreateSymbolicLink(ioManager.ResolvePath(file), ioManager.ResolvePath(destPath), cancellationToken); + await linkFactory.CreateSymbolicLink(ioManager.ResolvePath(file), ioManager.ResolvePath(destPath), cancellationToken); })); } diff --git a/src/Tgstation.Server.Host/Components/Watchdog/AdvancedWatchdog.cs b/src/Tgstation.Server.Host/Components/Watchdog/AdvancedWatchdog.cs new file mode 100644 index 00000000000..48d2b3e2546 --- /dev/null +++ b/src/Tgstation.Server.Host/Components/Watchdog/AdvancedWatchdog.cs @@ -0,0 +1,424 @@ +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Threading; +using System.Threading.Tasks; + +using Microsoft.Extensions.Logging; + +using Tgstation.Server.Api.Models.Internal; +using Tgstation.Server.Host.Components.Chat; +using Tgstation.Server.Host.Components.Deployment; +using Tgstation.Server.Host.Components.Deployment.Remote; +using Tgstation.Server.Host.Components.Events; +using Tgstation.Server.Host.Components.Session; +using Tgstation.Server.Host.Core; +using Tgstation.Server.Host.IO; +using Tgstation.Server.Host.Jobs; +using Tgstation.Server.Host.Utils; + +namespace Tgstation.Server.Host.Components.Watchdog +{ + /// + /// A that, instead of killing servers for updates, uses the wonders of filesystem links to swap out changes without killing the server process. + /// + abstract class AdvancedWatchdog : BasicWatchdog + { + /// + /// The for . + /// + protected SwappableDmbProvider ActiveSwappable { get; private set; } + + /// + /// The for the pointing to the Game directory. + /// + protected IIOManager GameIOManager { get; } + + /// + /// The for the . + /// + protected IFilesystemLinkFactory LinkFactory { get; } + + /// + /// of s that are waiting to clean up old deployments. + /// + readonly List deploymentCleanupTasks; + + /// + /// The active for . + /// + SwappableDmbProvider pendingSwappable; + + /// + /// The representing the cleanup of an unused . + /// + volatile TaskCompletionSource deploymentCleanupGate; + + /// + /// Initializes a new instance of the class. + /// + /// The for the . + /// The for the . + /// The for the . + /// The for the . + /// The for the . + /// The for the . + /// The for the . + /// The for the . + /// The for the . + /// The for the . + /// The value of . + /// The value of . + /// The for the . + /// The for the . + /// The for the . + /// The autostart value for the . + public AdvancedWatchdog( + IChatManager chat, + ISessionControllerFactory sessionControllerFactory, + IDmbFactory dmbFactory, + ISessionPersistor sessionPersistor, + IJobManager jobManager, + IServerControl serverControl, + IAsyncDelayer asyncDelayer, + IIOManager diagnosticsIOManager, + IEventConsumer eventConsumer, + IRemoteDeploymentManagerFactory remoteDeploymentManagerFactory, + IIOManager gameIOManager, + IFilesystemLinkFactory linkFactory, + ILogger logger, + DreamDaemonLaunchParameters initialLaunchParameters, + Api.Models.Instance instance, + bool autoStart) + : base( + chat, + sessionControllerFactory, + dmbFactory, + sessionPersistor, + jobManager, + serverControl, + asyncDelayer, + diagnosticsIOManager, + eventConsumer, + remoteDeploymentManagerFactory, + logger, + initialLaunchParameters, + instance, + autoStart) + { + try + { + GameIOManager = gameIOManager ?? throw new ArgumentNullException(nameof(gameIOManager)); + LinkFactory = linkFactory ?? throw new ArgumentNullException(nameof(linkFactory)); + + deploymentCleanupTasks = new List(); + } + catch + { + // Async dispose is for if we have controllers running, not the case here + var disposeTask = DisposeAsync(); + Debug.Assert(disposeTask.IsCompleted, "This should always be true during construction!"); + disposeTask.GetAwaiter().GetResult(); + + throw; + } + } + + /// + protected sealed override async Task DisposeAndNullControllersImpl() + { + await base.DisposeAndNullControllersImpl(); + + // If we reach this point, we can guarantee PrepServerForLaunch will be called before starting again. + ActiveSwappable = null; + await (pendingSwappable?.DisposeAsync() ?? ValueTask.CompletedTask); + pendingSwappable = null; + + await DrainDeploymentCleanupTasks(true); + } + + /// + protected sealed override async Task HandleNormalReboot(CancellationToken cancellationToken) + { + if (pendingSwappable != null) + { + Task RunPrequel() => BeforeApplyDmb(pendingSwappable.CompileJob, cancellationToken); + + var needToSwap = !pendingSwappable.Swapped; + if (needToSwap) + { + // IMPORTANT: THE SESSIONCONTROLLER SHOULD STILL BE PROCESSING THE BRIDGE REQUEST SO WE KNOW DD IS SLEEPING + // OTHERWISE, IT COULD RETURN TO /world/Reboot() TOO EARLY AND LOAD THE WRONG .DMB + if (!Server.ProcessingRebootBridgeRequest) + { + // integration test logging will catch this + Logger.LogError( + "The reboot bridge request completed before the watchdog could suspend the server! This can lead to buggy DreamDaemon behaviour and should be reported! To ensure stability, we will need to hard reboot the server"); + await RunPrequel(); + return MonitorAction.Restart; + } + + // DCT: Not necessary + if (!pendingSwappable.FinishActivationPreparation(CancellationToken.None).IsCompleted) + { + // rare pokemon + Logger.LogInformation("Deployed .dme is not ready to swap, delaying until next reboot!"); + Chat.QueueWatchdogMessage("The pending deployment was not ready to be activated this reboot. It will be applied at the next one."); + return MonitorAction.Continue; + } + } + + var updateTask = RunPrequel(); + if (needToSwap) + await PerformDmbSwap(pendingSwappable, cancellationToken); + + var currentCompileJobId = Server.ReattachInformation.Dmb.CompileJob.Id; + + await DrainDeploymentCleanupTasks(false); + + IAsyncDisposable lingeringDeployment; + var localDeploymentCleanupGate = new TaskCompletionSource(); + async Task CleanupLingeringDeployment() + { + var lingeringDeploymentExpirySeconds = ActiveLaunchParameters.StartupTimeout.Value; + Logger.LogDebug( + "Holding old deployment {compileJobId} for up to {expiry} seconds...", + currentCompileJobId, + lingeringDeploymentExpirySeconds); + + var timeout = AsyncDelayer.Delay(TimeSpan.FromSeconds(lingeringDeploymentExpirySeconds), cancellationToken); + + var completedTask = await Task.WhenAny( + localDeploymentCleanupGate.Task, + timeout); + + var timedOut = completedTask == timeout; + Logger.Log( + timedOut + ? LogLevel.Warning + : LogLevel.Trace, + "Releasing old deployment {compileJobId}{afterTimeout}", + currentCompileJobId, + timedOut + ? " due to timeout!" + : "..."); + + await lingeringDeployment.DisposeAsync(); + } + + var oldDeploymentCleanupGate = Interlocked.Exchange(ref deploymentCleanupGate, localDeploymentCleanupGate); + oldDeploymentCleanupGate?.TrySetResult(); + + Logger.LogTrace("Replacing activeSwappable with pendingSwappable..."); + + lock (deploymentCleanupTasks) + { + lingeringDeployment = Server.ReplaceDmbProvider(pendingSwappable); + deploymentCleanupTasks.Add( + CleanupLingeringDeployment()); + } + + ActiveSwappable = pendingSwappable; + pendingSwappable = null; + + await SessionPersistor.Save(Server.ReattachInformation, cancellationToken); + await updateTask; + } + else + Logger.LogTrace("Nothing to do as pendingSwappable is null."); + + return MonitorAction.Continue; + } + + /// + protected sealed override async Task HandleNewDmbAvailable(CancellationToken cancellationToken) + { + IDmbProvider compileJobProvider = DmbFactory.LockNextDmb(1); + bool canSeamlesslySwap = true; + + if (compileJobProvider.CompileJob.ByondVersion != ActiveCompileJob.ByondVersion) + { + // have to do a graceful restart + Logger.LogDebug( + "Not swapping to new compile job {0} as it uses a different BYOND version ({1}) than what is currently active {2}. Queueing graceful restart instead...", + compileJobProvider.CompileJob.Id, + compileJobProvider.CompileJob.ByondVersion, + ActiveCompileJob.ByondVersion); + canSeamlesslySwap = false; + } + + if (compileJobProvider.CompileJob.DmeName != ActiveCompileJob.DmeName) + { + Logger.LogDebug( + "Not swapping to new compile job {0} as it uses a different .dmb name ({1}) than what is currently active {2}. Queueing graceful restart instead...", + compileJobProvider.CompileJob.Id, + compileJobProvider.CompileJob.DmeName, + ActiveCompileJob.DmeName); + canSeamlesslySwap = false; + } + + if (!canSeamlesslySwap) + { + await compileJobProvider.DisposeAsync(); + await base.HandleNewDmbAvailable(cancellationToken); + return; + } + + SwappableDmbProvider swappableProvider = null; + try + { + swappableProvider = CreateSwappableDmbProvider(compileJobProvider); + if (ActiveCompileJob.DMApiVersion == null) + { + Logger.LogWarning("Active compile job has no DMAPI! Commencing immediate .dmb swap. Note this behavior is known to be buggy in some DM code contexts. See https://github.com/tgstation/tgstation-server/issues/1550"); + await PerformDmbSwap(swappableProvider, cancellationToken); + } + } + catch (Exception ex) + { + Logger.LogError(ex, "Exception while swapping"); + IDmbProvider providerToDispose = swappableProvider ?? compileJobProvider; + await providerToDispose.DisposeAsync(); + throw; + } + + await (pendingSwappable?.DisposeAsync() ?? ValueTask.CompletedTask); + pendingSwappable = swappableProvider; + } + + /// + protected sealed override async Task PrepServerForLaunch(IDmbProvider dmbToUse, CancellationToken cancellationToken) + { + if (ActiveSwappable != null) + throw new InvalidOperationException("Expected activeSwappable to be null!"); + if (pendingSwappable != null) + throw new InvalidOperationException("Expected pendingSwappable to be null!"); + + Logger.LogTrace("Prep for server launch"); + + ActiveSwappable = CreateSwappableDmbProvider(dmbToUse); + try + { + await InitialLink(cancellationToken); + } + catch (Exception ex) + { + // We won't worry about disposing activeSwappable here as we can't dispose dmbToUse here. + Logger.LogTrace(ex, "Initial link error, nulling ActiveSwappable"); + ActiveSwappable = null; + throw; + } + + return ActiveSwappable; + } + + /// + /// Set the for the . + /// + /// The for the operation. + /// A representing the running operation. + protected abstract Task ApplyInitialDmb(CancellationToken cancellationToken); + + /// + /// Create a for a given . + /// + /// The to create a for. + /// A new . + protected abstract SwappableDmbProvider CreateSwappableDmbProvider(IDmbProvider dmbProvider); + + /// + protected override async Task SessionStartupPersist(CancellationToken cancellationToken) + { + await ApplyInitialDmb(cancellationToken); + await base.SessionStartupPersist(cancellationToken); + } + + /// + protected override async Task HandleMonitorWakeup(MonitorActivationReason reason, CancellationToken cancellationToken) + { + var result = await base.HandleMonitorWakeup(reason, cancellationToken); + if (reason == MonitorActivationReason.ActiveServerStartup) + await DrainDeploymentCleanupTasks(false); + + return result; + } + + /// + /// Create the initial link to the live game directory using . + /// + /// The for the operation. + /// A representing the running operation. + async ValueTask InitialLink(CancellationToken cancellationToken) + { + await ActiveSwappable.FinishActivationPreparation(cancellationToken); + Logger.LogTrace("Linking compile job..."); + await ActiveSwappable.MakeActive(cancellationToken); + } + + /// + /// Suspends the and calls on a . + /// + /// The to activate. + /// The for the operation. + /// A representing the running operation. + async ValueTask PerformDmbSwap(SwappableDmbProvider newProvider, CancellationToken cancellationToken) + { + Logger.LogDebug("Swapping to compile job {id}...", newProvider.CompileJob.Id); + + await newProvider.FinishActivationPreparation(cancellationToken); + + var suspended = false; + var server = Server; + try + { + server.Suspend(); + suspended = true; + } + catch (Exception ex) + { + Logger.LogWarning(ex, "Exception while suspending server!"); + } + + try + { + await newProvider.MakeActive(cancellationToken); + } + finally + { + // Let this throw hard if it fails + if (suspended) + server.Resume(); + } + } + + /// + /// Asynchronously drain . + /// + /// If , all s will be ed. Otherwise, only s with set will be ed. + /// A representing the running operation. + Task DrainDeploymentCleanupTasks(bool blocking) + { + Logger.LogTrace("DrainDeploymentCleanupTasks..."); + var localDeploymentCleanupGate = Interlocked.Exchange(ref deploymentCleanupGate, null); + localDeploymentCleanupGate?.TrySetResult(); + + List localDeploymentCleanupTasks; + lock (deploymentCleanupTasks) + { + var totalActiveTasks = deploymentCleanupTasks.Count; + localDeploymentCleanupTasks = new List(totalActiveTasks); + for (var i = totalActiveTasks - 1; i >= 0; --i) + { + var currentTask = deploymentCleanupTasks[i]; + if (!blocking && !currentTask.IsCompleted) + continue; + + localDeploymentCleanupTasks.Add(currentTask); + deploymentCleanupTasks.RemoveAt(i); + } + } + + return Task.WhenAll(localDeploymentCleanupTasks); + } + } +} diff --git a/src/Tgstation.Server.Host/Components/Watchdog/BasicWatchdog.cs b/src/Tgstation.Server.Host/Components/Watchdog/BasicWatchdog.cs index 8396ce7c992..fc5c3461b0c 100644 --- a/src/Tgstation.Server.Host/Components/Watchdog/BasicWatchdog.cs +++ b/src/Tgstation.Server.Host/Components/Watchdog/BasicWatchdog.cs @@ -268,7 +268,7 @@ await ReattachFailure( // server didn't get control of this dmb if (dmbToUse != null && !serverWasActive) - dmbToUse.Dispose(); + await dmbToUse.DisposeAsync(); throw; } diff --git a/src/Tgstation.Server.Host/Components/Watchdog/PosixWatchdog.cs b/src/Tgstation.Server.Host/Components/Watchdog/PosixWatchdog.cs index 044ef3f1ef8..eb563bd1fa0 100644 --- a/src/Tgstation.Server.Host/Components/Watchdog/PosixWatchdog.cs +++ b/src/Tgstation.Server.Host/Components/Watchdog/PosixWatchdog.cs @@ -1,4 +1,5 @@ -using System.Threading; +using System; +using System.Threading; using System.Threading.Tasks; using Microsoft.Extensions.Logging; @@ -9,6 +10,7 @@ using Tgstation.Server.Host.Components.Deployment.Remote; using Tgstation.Server.Host.Components.Events; using Tgstation.Server.Host.Components.Session; +using Tgstation.Server.Host.Configuration; using Tgstation.Server.Host.Core; using Tgstation.Server.Host.IO; using Tgstation.Server.Host.Jobs; @@ -17,10 +19,15 @@ namespace Tgstation.Server.Host.Components.Watchdog { /// - /// A variant of the that works on POSIX systems. + /// A variant of the that works on POSIX systems. /// - sealed class PosixWatchdog : WindowsWatchdog + sealed class PosixWatchdog : AdvancedWatchdog { + /// + /// The for the . + /// + readonly GeneralConfiguration generalConfiguration; + /// /// Initializes a new instance of the class. /// @@ -34,11 +41,12 @@ sealed class PosixWatchdog : WindowsWatchdog /// The for the . /// The for the . /// The for the . - /// The pointing to the game directory for the .. - /// The for the . + /// The pointing to the game directory for the .. + /// The for the . /// The for the . /// The for the . /// The for the . + /// The value of . /// The autostart value for the . public PosixWatchdog( IChatManager chat, @@ -52,10 +60,11 @@ public PosixWatchdog( IEventConsumer eventConsumer, IRemoteDeploymentManagerFactory remoteDeploymentManagerFactory, IIOManager gameIOManager, - ISymlinkFactory symlinkFactory, + IFilesystemLinkFactory linkFactory, ILogger logger, DreamDaemonLaunchParameters initialLaunchParameters, Api.Models.Instance instance, + GeneralConfiguration generalConfiguration, bool autoStart) : base( chat, @@ -69,19 +78,21 @@ public PosixWatchdog( eventConsumer, remoteDeploymentManagerFactory, gameIOManager, - symlinkFactory, + linkFactory, logger, initialLaunchParameters, instance, autoStart) { + this.generalConfiguration = generalConfiguration ?? throw new ArgumentNullException(nameof(generalConfiguration)); } /// protected override Task ApplyInitialDmb(CancellationToken cancellationToken) - { - // not necessary to hold initial .dmb on Linux because of based inode deletes - return Task.CompletedTask; - } + => Task.CompletedTask; // not necessary to hold initial .dmb on Linux because of based inode deletes + + /// + protected override SwappableDmbProvider CreateSwappableDmbProvider(IDmbProvider dmbProvider) + => new HardLinkDmbProvider(dmbProvider, GameIOManager, LinkFactory, Logger, generalConfiguration); } } diff --git a/src/Tgstation.Server.Host/Components/Watchdog/PosixWatchdogFactory.cs b/src/Tgstation.Server.Host/Components/Watchdog/PosixWatchdogFactory.cs index 6774c73cb55..64c86722625 100644 --- a/src/Tgstation.Server.Host/Components/Watchdog/PosixWatchdogFactory.cs +++ b/src/Tgstation.Server.Host/Components/Watchdog/PosixWatchdogFactory.cs @@ -29,21 +29,21 @@ sealed class PosixWatchdogFactory : WindowsWatchdogFactory /// The for the . /// The for the . /// The for the . - /// The for the . + /// The for the . /// The for for the . public PosixWatchdogFactory( IServerControl serverControl, ILoggerFactory loggerFactory, IJobManager jobManager, IAsyncDelayer asyncDelayer, - ISymlinkFactory symlinkFactory, + IFilesystemLinkFactory linkFactory, IOptions generalConfigurationOptions) : base( serverControl, loggerFactory, jobManager, asyncDelayer, - symlinkFactory, + linkFactory, generalConfigurationOptions) { } @@ -72,10 +72,11 @@ public override IWatchdog CreateWatchdog( eventConsumer, remoteDeploymentManagerFactory, gameIOManager, - SymlinkFactory, + LinkFactory, LoggerFactory.CreateLogger(), settings, instance, + GeneralConfiguration, settings.AutoStart ?? throw new ArgumentNullException(nameof(settings))); } } diff --git a/src/Tgstation.Server.Host/Components/Watchdog/WindowsWatchdog.cs b/src/Tgstation.Server.Host/Components/Watchdog/WindowsWatchdog.cs index c8d6c7eb442..05c1f100888 100644 --- a/src/Tgstation.Server.Host/Components/Watchdog/WindowsWatchdog.cs +++ b/src/Tgstation.Server.Host/Components/Watchdog/WindowsWatchdog.cs @@ -1,7 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Diagnostics; -using System.Threading; +using System.Threading; using System.Threading.Tasks; using Microsoft.Extensions.Logging; @@ -20,40 +17,10 @@ namespace Tgstation.Server.Host.Components.Watchdog { /// - /// A that, instead of killing servers for updates, uses the wonders of symlinks to swap out changes without killing DreamDaemon. + /// A variant of the that works on Windows systems. /// - class WindowsWatchdog : BasicWatchdog + sealed class WindowsWatchdog : AdvancedWatchdog { - /// - /// The for . - /// - protected SwappableDmbProvider ActiveSwappable { get; private set; } - - /// - /// The for the pointing to the Game directory. - /// - protected IIOManager GameIOManager { get; } - - /// - /// The for the . - /// - readonly ISymlinkFactory symlinkFactory; - - /// - /// of s that are waiting to clean up old deployments. - /// - readonly List deploymentCleanupTasks; - - /// - /// The active for . - /// - SwappableDmbProvider pendingSwappable; - - /// - /// The representing the cleanup of an unused . - /// - volatile TaskCompletionSource deploymentCleanupGate; - /// /// Initializes a new instance of the class. /// @@ -67,8 +34,8 @@ class WindowsWatchdog : BasicWatchdog /// The for the . /// The for the . /// The for the . - /// The value of . - /// The value of . + /// The pointing to the game directory for the .. + /// The for the . /// The for the . /// The for the . /// The for the . @@ -85,321 +52,39 @@ public WindowsWatchdog( IEventConsumer eventConsumer, IRemoteDeploymentManagerFactory remoteDeploymentManagerFactory, IIOManager gameIOManager, - ISymlinkFactory symlinkFactory, + IFilesystemLinkFactory linkFactory, ILogger logger, DreamDaemonLaunchParameters initialLaunchParameters, Api.Models.Instance instance, bool autoStart) : base( - chat, - sessionControllerFactory, - dmbFactory, - sessionPersistor, - jobManager, - serverControl, - asyncDelayer, - diagnosticsIOManager, - eventConsumer, - remoteDeploymentManagerFactory, - logger, - initialLaunchParameters, - instance, - autoStart) + chat, + sessionControllerFactory, + dmbFactory, + sessionPersistor, + jobManager, + serverControl, + asyncDelayer, + diagnosticsIOManager, + eventConsumer, + remoteDeploymentManagerFactory, + gameIOManager, + linkFactory, + logger, + initialLaunchParameters, + instance, + autoStart) { - try - { - GameIOManager = gameIOManager ?? throw new ArgumentNullException(nameof(gameIOManager)); - this.symlinkFactory = symlinkFactory ?? throw new ArgumentNullException(nameof(symlinkFactory)); - - deploymentCleanupTasks = new List(); - } - catch - { - // Async dispose is for if we have controllers running, not the case here - var disposeTask = DisposeAsync(); - Debug.Assert(disposeTask.IsCompleted, "This should always be true during construction!"); - disposeTask.GetAwaiter().GetResult(); - - throw; - } - } - - /// - protected override async Task DisposeAndNullControllersImpl() - { - await base.DisposeAndNullControllersImpl(); - - // If we reach this point, we can guarantee PrepServerForLaunch will be called before starting again. - ActiveSwappable = null; - pendingSwappable?.Dispose(); - pendingSwappable = null; - - await DrainDeploymentCleanupTasks(true); - } - - /// - protected override async Task HandleNormalReboot(CancellationToken cancellationToken) - { - if (pendingSwappable != null) - { - var updateTask = BeforeApplyDmb(pendingSwappable.CompileJob, cancellationToken); - - if (!pendingSwappable.Swapped) - { - // IMPORTANT: THE SESSIONCONTROLLER SHOULD STILL BE PROCESSING THE BRIDGE REQUEST SO WE KNOW DD IS SLEEPING - // OTHERWISE, IT COULD RETURN TO /world/Reboot() TOO EARLY AND LOAD THE WRONG .DMB - if (!Server.ProcessingRebootBridgeRequest) - { - // integration test logging will catch this - Logger.LogError( - "The reboot bridge request completed before the watchdog could suspend the server! This can lead to buggy DreamDaemon behaviour and should be reported! To ensure stability, we will need to hard reboot the server"); - await updateTask; - return MonitorAction.Restart; - } - - await PerformDmbSwap(pendingSwappable, cancellationToken); - } - - var currentCompileJobId = Server.ReattachInformation.Dmb.CompileJob.Id; - - await DrainDeploymentCleanupTasks(false); - - IDisposable lingeringDeployment; - var localDeploymentCleanupGate = new TaskCompletionSource(); - async Task CleanupLingeringDeployment() - { - var lingeringDeploymentExpirySeconds = ActiveLaunchParameters.StartupTimeout.Value; - Logger.LogDebug( - "Holding old deployment {compileJobId} for up to {expiry} seconds...", - currentCompileJobId, - lingeringDeploymentExpirySeconds); - - var timeout = AsyncDelayer.Delay(TimeSpan.FromSeconds(lingeringDeploymentExpirySeconds), cancellationToken); - - var completedTask = await Task.WhenAny( - localDeploymentCleanupGate.Task, - timeout); - - var timedOut = completedTask == timeout; - Logger.Log( - timedOut - ? LogLevel.Warning - : LogLevel.Trace, - "Releasing old deployment {compileJobId}{afterTimeout}", - currentCompileJobId, - timedOut - ? " due to timeout!" - : "..."); - - lingeringDeployment.Dispose(); - } - - var oldDeploymentCleanupGate = Interlocked.Exchange(ref deploymentCleanupGate, localDeploymentCleanupGate); - oldDeploymentCleanupGate?.TrySetResult(); - - Logger.LogTrace("Replacing activeSwappable with pendingSwappable..."); - - lock (deploymentCleanupTasks) - { - lingeringDeployment = Server.ReplaceDmbProvider(pendingSwappable); - deploymentCleanupTasks.Add( - CleanupLingeringDeployment()); - } - - ActiveSwappable = pendingSwappable; - pendingSwappable = null; - - await SessionPersistor.Save(Server.ReattachInformation, cancellationToken); - await updateTask; - } - else - Logger.LogTrace("Nothing to do as pendingSwappable is null."); - - return MonitorAction.Continue; } /// - protected override async Task HandleNewDmbAvailable(CancellationToken cancellationToken) - { - IDmbProvider compileJobProvider = DmbFactory.LockNextDmb(1); - bool canSeamlesslySwap = true; - - if (compileJobProvider.CompileJob.ByondVersion != ActiveCompileJob.ByondVersion) - { - // have to do a graceful restart - Logger.LogDebug( - "Not swapping to new compile job {0} as it uses a different BYOND version ({1}) than what is currently active {2}. Queueing graceful restart instead...", - compileJobProvider.CompileJob.Id, - compileJobProvider.CompileJob.ByondVersion, - ActiveCompileJob.ByondVersion); - canSeamlesslySwap = false; - } - - if (compileJobProvider.CompileJob.DmeName != ActiveCompileJob.DmeName) - { - Logger.LogDebug( - "Not swapping to new compile job {0} as it uses a different .dmb name ({1}) than what is currently active {2}. Queueing graceful restart instead...", - compileJobProvider.CompileJob.Id, - compileJobProvider.CompileJob.DmeName, - ActiveCompileJob.DmeName); - canSeamlesslySwap = false; - } - - if (!canSeamlesslySwap) - { - compileJobProvider.Dispose(); - await base.HandleNewDmbAvailable(cancellationToken); - return; - } - - SwappableDmbProvider windowsProvider = null; - try - { - windowsProvider = new SwappableDmbProvider(compileJobProvider, GameIOManager, symlinkFactory); - if (ActiveCompileJob.DMApiVersion == null) - { - Logger.LogWarning("Active compile job has no DMAPI! Commencing immediate .dmb swap. Note this behavior is known to be buggy in some DM code contexts. See https://github.com/tgstation/tgstation-server/issues/1550"); - await PerformDmbSwap(windowsProvider, cancellationToken); - } - } - catch (Exception ex) - { - Logger.LogError(ex, "Exception while swapping"); - IDmbProvider providerToDispose = windowsProvider ?? compileJobProvider; - providerToDispose.Dispose(); - throw; - } - - pendingSwappable?.Dispose(); - pendingSwappable = windowsProvider; - } - - /// - protected sealed override async Task PrepServerForLaunch(IDmbProvider dmbToUse, CancellationToken cancellationToken) - { - if (ActiveSwappable != null) - throw new InvalidOperationException("Expected activeSwappable to be null!"); - if (pendingSwappable != null) - throw new InvalidOperationException("Expected pendingSwappable to be null!"); - - Logger.LogTrace("Prep for server launch"); - - ActiveSwappable = new SwappableDmbProvider(dmbToUse, GameIOManager, symlinkFactory); - try - { - await InitialLink(cancellationToken); - } - catch (Exception ex) - { - // We won't worry about disposing activeSwappable here as we can't dispose dmbToUse here. - Logger.LogTrace(ex, "Initial link error, nulling ActiveSwappable"); - ActiveSwappable = null; - throw; - } - - return ActiveSwappable; - } - - /// - /// Set the for the . - /// - /// The for the operation. - /// A representing the running operation. - protected virtual async Task ApplyInitialDmb(CancellationToken cancellationToken) + protected override async Task ApplyInitialDmb(CancellationToken cancellationToken) { Server.ReattachInformation.InitialDmb = await DmbFactory.FromCompileJob(Server.CompileJob, cancellationToken); } /// - protected override async Task SessionStartupPersist(CancellationToken cancellationToken) - { - await ApplyInitialDmb(cancellationToken); - await base.SessionStartupPersist(cancellationToken); - } - - /// - protected override async Task HandleMonitorWakeup(MonitorActivationReason reason, CancellationToken cancellationToken) - { - var result = await base.HandleMonitorWakeup(reason, cancellationToken); - if (reason == MonitorActivationReason.ActiveServerStartup) - await DrainDeploymentCleanupTasks(false); - - return result; - } - - /// - /// Create the initial link to the live game directory using . - /// - /// The for the operation. - /// A representing the running operation. - Task InitialLink(CancellationToken cancellationToken) - { - Logger.LogTrace("Symlinking compile job..."); - return ActiveSwappable.MakeActive(cancellationToken); - } - - /// - /// Suspends the and calls on a . - /// - /// The to activate. - /// The for the operation. - /// A representing the running operation. - async ValueTask PerformDmbSwap(SwappableDmbProvider newProvider, CancellationToken cancellationToken) - { - Logger.LogDebug("Swapping to compile job {id}...", newProvider.CompileJob.Id); - - var suspended = false; - var server = Server; - try - { - server.Suspend(); - suspended = true; - } - catch (Exception ex) - { - Logger.LogWarning(ex, "Exception while suspending server!"); - } - - try - { - await newProvider.MakeActive(cancellationToken); - } - finally - { - // Let this throw hard if it fails - if (suspended) - server.Resume(); - } - } - - /// - /// Asynchronously drain . - /// - /// If , all s will be ed. Otherwise, only s with set will be ed. - /// A representing the running operation. - Task DrainDeploymentCleanupTasks(bool blocking) - { - Logger.LogTrace("DrainDeploymentCleanupTasks..."); - var localDeploymentCleanupGate = Interlocked.Exchange(ref deploymentCleanupGate, null); - localDeploymentCleanupGate?.TrySetResult(); - - List localDeploymentCleanupTasks; - lock (deploymentCleanupTasks) - { - var totalActiveTasks = deploymentCleanupTasks.Count; - localDeploymentCleanupTasks = new List(totalActiveTasks); - for (var i = totalActiveTasks - 1; i >= 0; --i) - { - var currentTask = deploymentCleanupTasks[i]; - if (!blocking && !currentTask.IsCompleted) - continue; - - localDeploymentCleanupTasks.Add(currentTask); - deploymentCleanupTasks.RemoveAt(i); - } - } - - return Task.WhenAll(localDeploymentCleanupTasks); - } + protected override SwappableDmbProvider CreateSwappableDmbProvider(IDmbProvider dmbProvider) + => new SymlinkDmbProvider(dmbProvider, GameIOManager, LinkFactory); } } diff --git a/src/Tgstation.Server.Host/Components/Watchdog/WindowsWatchdogFactory.cs b/src/Tgstation.Server.Host/Components/Watchdog/WindowsWatchdogFactory.cs index 7909be59aff..89ed6b145d7 100644 --- a/src/Tgstation.Server.Host/Components/Watchdog/WindowsWatchdogFactory.cs +++ b/src/Tgstation.Server.Host/Components/Watchdog/WindowsWatchdogFactory.cs @@ -18,14 +18,14 @@ namespace Tgstation.Server.Host.Components.Watchdog { /// - /// for creating s. + /// for creating s. /// class WindowsWatchdogFactory : WatchdogFactory { /// - /// The for the . + /// The for the . /// - protected ISymlinkFactory SymlinkFactory { get; } + protected IFilesystemLinkFactory LinkFactory { get; } /// /// Initializes a new instance of the class. @@ -34,14 +34,14 @@ class WindowsWatchdogFactory : WatchdogFactory /// The for the . /// The for the . /// The for the . - /// The value of . + /// The value of . /// The for for the . public WindowsWatchdogFactory( IServerControl serverControl, ILoggerFactory loggerFactory, IJobManager jobManager, IAsyncDelayer asyncDelayer, - ISymlinkFactory symlinkFactory, + IFilesystemLinkFactory symlinkFactory, IOptions generalConfigurationOptions) : base( serverControl, @@ -50,7 +50,7 @@ public WindowsWatchdogFactory( asyncDelayer, generalConfigurationOptions) { - SymlinkFactory = symlinkFactory ?? throw new ArgumentNullException(nameof(symlinkFactory)); + LinkFactory = symlinkFactory ?? throw new ArgumentNullException(nameof(symlinkFactory)); } /// @@ -77,7 +77,7 @@ public override IWatchdog CreateWatchdog( eventConsumer, remoteDeploymentManagerFactory, gameIOManager, - SymlinkFactory, + LinkFactory, LoggerFactory.CreateLogger(), settings, instance, diff --git a/src/Tgstation.Server.Host/Core/Application.cs b/src/Tgstation.Server.Host/Core/Application.cs index ed1cb97cad0..18abdcacf30 100644 --- a/src/Tgstation.Server.Host/Core/Application.cs +++ b/src/Tgstation.Server.Host/Core/Application.cs @@ -336,7 +336,7 @@ void AddTypedContext() { AddWatchdog(services, postSetupServices); services.AddSingleton(); - services.AddSingleton(); + services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); @@ -349,7 +349,7 @@ void AddTypedContext() { AddWatchdog(services, postSetupServices); services.AddSingleton(); - services.AddSingleton(); + services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); diff --git a/src/Tgstation.Server.Host/IO/ISymlinkFactory.cs b/src/Tgstation.Server.Host/IO/IFilesystemLinkFactory.cs similarity index 65% rename from src/Tgstation.Server.Host/IO/ISymlinkFactory.cs rename to src/Tgstation.Server.Host/IO/IFilesystemLinkFactory.cs index 1adbd99d975..3cf0622801a 100644 --- a/src/Tgstation.Server.Host/IO/ISymlinkFactory.cs +++ b/src/Tgstation.Server.Host/IO/IFilesystemLinkFactory.cs @@ -6,7 +6,7 @@ namespace Tgstation.Server.Host.IO /// /// For creating filesystem symbolic links. /// - interface ISymlinkFactory + interface IFilesystemLinkFactory { /// /// If directory symlinks must be deleted as files would in the current environment. @@ -22,5 +22,14 @@ interface ISymlinkFactory /// The for the operation. /// A representing the running operation. Task CreateSymbolicLink(string targetPath, string linkPath, CancellationToken cancellationToken); + + /// + /// Creates a hard link. + /// + /// The path to the hard target. + /// The path to the link. + /// The for the operation. + /// A representing the running operation. + Task CreateHardLink(string targetPath, string linkPath, CancellationToken cancellationToken); } } diff --git a/src/Tgstation.Server.Host/IO/PosixSymlinkFactory.cs b/src/Tgstation.Server.Host/IO/PosixFilesystemLinkFactory.cs similarity index 58% rename from src/Tgstation.Server.Host/IO/PosixSymlinkFactory.cs rename to src/Tgstation.Server.Host/IO/PosixFilesystemLinkFactory.cs index ddbcbb86fb7..b80af9e122a 100644 --- a/src/Tgstation.Server.Host/IO/PosixSymlinkFactory.cs +++ b/src/Tgstation.Server.Host/IO/PosixFilesystemLinkFactory.cs @@ -8,13 +8,29 @@ namespace Tgstation.Server.Host.IO { /// - /// for posix systems. + /// for POSIX systems. /// - sealed class PosixSymlinkFactory : ISymlinkFactory + sealed class PosixFilesystemLinkFactory : IFilesystemLinkFactory { /// public bool SymlinkedDirectoriesAreDeletedAsFiles => true; + /// + public Task CreateHardLink(string targetPath, string linkPath, CancellationToken cancellationToken) => Task.Factory.StartNew( + () => + { + ArgumentNullException.ThrowIfNull(targetPath); + ArgumentNullException.ThrowIfNull(linkPath); + + cancellationToken.ThrowIfCancellationRequested(); + var fsInfo = new UnixFileInfo(targetPath); + cancellationToken.ThrowIfCancellationRequested(); + fsInfo.CreateLink(linkPath); + }, + cancellationToken, + DefaultIOManager.BlockingTaskCreationOptions, + TaskScheduler.Current); + /// public Task CreateSymbolicLink(string targetPath, string linkPath, CancellationToken cancellationToken) => Task.Factory.StartNew( () => diff --git a/src/Tgstation.Server.Host/IO/WindowsSymlinkFactory.cs b/src/Tgstation.Server.Host/IO/WindowsFilesystemLinkFactory.cs similarity index 83% rename from src/Tgstation.Server.Host/IO/WindowsSymlinkFactory.cs rename to src/Tgstation.Server.Host/IO/WindowsFilesystemLinkFactory.cs index 18abde6b8f9..1513f4e1666 100644 --- a/src/Tgstation.Server.Host/IO/WindowsSymlinkFactory.cs +++ b/src/Tgstation.Server.Host/IO/WindowsFilesystemLinkFactory.cs @@ -9,13 +9,17 @@ namespace Tgstation.Server.Host.IO { /// - /// for windows systems. + /// for windows systems. /// - sealed class WindowsSymlinkFactory : ISymlinkFactory + sealed class WindowsFilesystemLinkFactory : IFilesystemLinkFactory { /// public bool SymlinkedDirectoriesAreDeletedAsFiles => false; + /// + public Task CreateHardLink(string targetPath, string linkPath, CancellationToken cancellationToken) + => throw new NotSupportedException(); + /// public Task CreateSymbolicLink(string targetPath, string linkPath, CancellationToken cancellationToken) => Task.Factory.StartNew( () => diff --git a/tests/DMAPI/LongRunning/Test.dm b/tests/DMAPI/LongRunning/Test.dm index a77c3377b5d..657fadbfd07 100644 --- a/tests/DMAPI/LongRunning/Test.dm +++ b/tests/DMAPI/LongRunning/Test.dm @@ -22,6 +22,15 @@ if(!length(channels)) FailTest("Expected some chat channels!") + var/test_str = "aljsdhfjahsfkjnsalkjdfhskljdackmcnvxkljhvkjsdanv,jdshlkufhklasjeFDhfjkalhdkjlfhalksfdjh" + var/res_contents = file2text('resource.txt') // we need a .rsc to be generated + + if(!findtext(res_contents, test_str)) + FailTest("Failed to resource? Did not find magic: [res_contents]") + + if(!fexists("[DME_NAME].rsc")) + FailTest("Failed to create .rsc!") + StartAsync() /proc/dab() diff --git a/tests/DMAPI/LongRunning/long_running_test.dme b/tests/DMAPI/LongRunning/long_running_test.dme index b9270144556..322587647dc 100644 --- a/tests/DMAPI/LongRunning/long_running_test.dme +++ b/tests/DMAPI/LongRunning/long_running_test.dme @@ -13,5 +13,8 @@ // BEGIN_INCLUDE #include "Config.dm" #include "../test_prelude.dm" +#ifndef DME_NAME +#define DME_NAME "long_running_test" +#endif #include "Test.dm" // END_INCLUDE diff --git a/tests/DMAPI/LongRunning/long_running_test_copy.dme b/tests/DMAPI/LongRunning/long_running_test_copy.dme index b4da8e0d964..e443c4b3312 100644 --- a/tests/DMAPI/LongRunning/long_running_test_copy.dme +++ b/tests/DMAPI/LongRunning/long_running_test_copy.dme @@ -11,5 +11,6 @@ // END_PREFERENCES // BEGIN_INCLUDE +#define DME_NAME "long_running_test_copy" #include "long_running_test.dme" // END_INCLUDE diff --git a/tests/DMAPI/LongRunning/resource.txt b/tests/DMAPI/LongRunning/resource.txt new file mode 100644 index 00000000000..94b848fe2ac --- /dev/null +++ b/tests/DMAPI/LongRunning/resource.txt @@ -0,0 +1,8 @@ + + if(!length(channels)) + FailTest("Expected some chat channels!") + + var/test_str = "aljsdhfjahsfkjnsalkjdfhskljdackmcnvxkljhvkjsdanv,jdshlkufhklasjeFDhfjkalhdkjlfhalksfdjh" + var/self_contents = file2text(file('Test.dm')) // we need a .rsc to be generated + + if(!(test_str in self_contents)) diff --git a/tests/Tgstation.Server.Host.Tests/Components/StaticFiles/TestConfiguration.cs b/tests/Tgstation.Server.Host.Tests/Components/StaticFiles/TestConfiguration.cs index 68241988d11..ff3bd0b5b83 100644 --- a/tests/Tgstation.Server.Host.Tests/Components/StaticFiles/TestConfiguration.cs +++ b/tests/Tgstation.Server.Host.Tests/Components/StaticFiles/TestConfiguration.cs @@ -47,7 +47,7 @@ public async Task TestListOrdering() var configuration = new Configuration( ioManager, new SynchronousIOManager(), - Mock.Of(), + Mock.Of(), Mock.Of(), Mock.Of(), Mock.Of(), diff --git a/tests/Tgstation.Server.Host.Tests/IO/TestSymlinkFactory.cs b/tests/Tgstation.Server.Host.Tests/IO/TestFilesystemLinkFactory.cs similarity index 52% rename from tests/Tgstation.Server.Host.Tests/IO/TestSymlinkFactory.cs rename to tests/Tgstation.Server.Host.Tests/IO/TestFilesystemLinkFactory.cs index 27646a9dc76..dbf2aaf2a82 100644 --- a/tests/Tgstation.Server.Host.Tests/IO/TestSymlinkFactory.cs +++ b/tests/Tgstation.Server.Host.Tests/IO/TestFilesystemLinkFactory.cs @@ -1,24 +1,26 @@ -using Microsoft.VisualStudio.TestTools.UnitTesting; -using System; +using System; using System.IO; using System.Runtime.InteropServices; using System.Security.Principal; +using System.Threading; using System.Threading.Tasks; +using Microsoft.VisualStudio.TestTools.UnitTesting; + namespace Tgstation.Server.Host.IO.Tests { [TestClass] - public sealed class TestSymlinkFactory + public sealed class TestFilesystemLinkFactory { - static ISymlinkFactory symlinkFactory; + static IFilesystemLinkFactory linkFactory; [ClassInitialize] public static void SelectFactory(TestContext _) { if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) - symlinkFactory = new WindowsSymlinkFactory(); + linkFactory = new WindowsFilesystemLinkFactory(); else - symlinkFactory = new PosixSymlinkFactory(); + linkFactory = new PosixFilesystemLinkFactory(); } public static bool HasPermissionToMakeSymlinks() @@ -30,6 +32,57 @@ public static bool HasPermissionToMakeSymlinks() return principal.IsInRole(WindowsBuiltInRole.Administrator); } + [TestMethod] + public async Task TestHardLinkWorks() + { + string f2 = null; + var f1 = Path.GetTempFileName(); + try + { + f2 = f1 + ".linked"; + const string Text = "Hello world"; + File.WriteAllText(f1, Text); + + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + await Assert.ThrowsExceptionAsync(() => linkFactory.CreateHardLink(f1, f2, CancellationToken.None)); + Assert.Inconclusive("Windows does not support hardlinks"); + } + + await Assert.ThrowsExceptionAsync(() => linkFactory.CreateHardLink(null, null, CancellationToken.None)); + await Assert.ThrowsExceptionAsync(() => linkFactory.CreateHardLink(f1, null, CancellationToken.None)); + + await linkFactory.CreateHardLink(f1, f2, default); + Assert.IsTrue(File.Exists(f2)); + + var f2Contents = File.ReadAllText(f2); + Assert.AreEqual(Text, f2Contents); + + const string NewText = "asdf"; + File.WriteAllText(f1, NewText); + + f2Contents = File.ReadAllText(f2); + Assert.AreEqual(NewText, f2Contents); + + const string NewText2 = "fdsa"; + File.WriteAllText(f2, NewText2); + + var f1Contents = File.ReadAllText(f1); + Assert.AreEqual(NewText2, f1Contents); + + File.Delete(f1); + Assert.IsFalse(File.Exists(f1)); + Assert.IsTrue(File.Exists(f2)); + f2Contents = File.ReadAllText(f2); + Assert.AreEqual(NewText2, f2Contents); + } + finally + { + File.Delete(f2); + File.Delete(f1); + } + } + [TestMethod] public async Task TestFileWorks() { @@ -43,10 +96,10 @@ public async Task TestFileWorks() f2 = f1 + ".linked"; File.WriteAllText(f1, Text); - await Assert.ThrowsExceptionAsync(() => symlinkFactory.CreateSymbolicLink(null, null, default)); - await Assert.ThrowsExceptionAsync(() => symlinkFactory.CreateSymbolicLink(f1, null, default)); + await Assert.ThrowsExceptionAsync(() => linkFactory.CreateSymbolicLink(null, null, default)); + await Assert.ThrowsExceptionAsync(() => linkFactory.CreateSymbolicLink(f1, null, default)); - await symlinkFactory.CreateSymbolicLink(f1, f2, default); + await linkFactory.CreateSymbolicLink(f1, f2, default); Assert.IsTrue(File.Exists(f2)); var f2Contents = File.ReadAllText(f2); @@ -76,10 +129,10 @@ public async Task TestDirectoryWorks() var p1 = Path.Combine(f1, FileName); File.WriteAllText(p1, Text); - await Assert.ThrowsExceptionAsync(() => symlinkFactory.CreateSymbolicLink(null, null, default)); - await Assert.ThrowsExceptionAsync(() => symlinkFactory.CreateSymbolicLink(f1, null, default)); + await Assert.ThrowsExceptionAsync(() => linkFactory.CreateSymbolicLink(null, null, default)); + await Assert.ThrowsExceptionAsync(() => linkFactory.CreateSymbolicLink(f1, null, default)); - await symlinkFactory.CreateSymbolicLink(f1, f2, default); + await linkFactory.CreateSymbolicLink(f1, f2, default); var p2 = Path.Combine(f2, FileName); Assert.IsTrue(File.Exists(p2)); @@ -104,7 +157,7 @@ public async Task TestFailsProperly() try { - await symlinkFactory.CreateSymbolicLink(BadPath, BadPath, default); + await linkFactory.CreateSymbolicLink(BadPath, BadPath, default); Assert.Fail("No exception thrown!"); } catch { } diff --git a/tests/Tgstation.Server.Host.Tests/IO/TestIOManager.cs b/tests/Tgstation.Server.Host.Tests/IO/TestIOManager.cs index f92ffaa04db..00319f4f30e 100644 --- a/tests/Tgstation.Server.Host.Tests/IO/TestIOManager.cs +++ b/tests/Tgstation.Server.Host.Tests/IO/TestIOManager.cs @@ -1,11 +1,12 @@ -using Microsoft.VisualStudio.TestTools.UnitTesting; - -using Remora.Discord.API.Objects; - -using System; +using System; using System.IO; +using System.Linq; +using System.Text; +using System.Threading; using System.Threading.Tasks; +using Microsoft.VisualStudio.TestTools.UnitTesting; + using Tgstation.Server.Host.System; namespace Tgstation.Server.Host.IO.Tests @@ -38,6 +39,53 @@ public async Task TestDeleteDirectory() } } + [TestMethod] + public async Task TestDeleteDirectoryWithSymlinkInsideDoesntRecurse() + { + var linkFactory = (IFilesystemLinkFactory)(new PlatformIdentifier().IsWindows + ? new WindowsFilesystemLinkFactory() + : new PosixFilesystemLinkFactory()); + + var tempPath = Path.GetTempFileName(); + File.Delete(tempPath); + Directory.CreateDirectory(tempPath); + try + { + var targetDir = ioManager.ConcatPath(tempPath, "targetdir"); + await ioManager.CreateDirectory(targetDir, CancellationToken.None); + var fileInTargetDir = ioManager.ConcatPath(targetDir, "test1.txt"); + + var expectedBytes = Encoding.UTF8.GetBytes("I want to live"); + await ioManager.WriteAllBytes(fileInTargetDir, expectedBytes, CancellationToken.None); + + var testDir = ioManager.ConcatPath(tempPath, "testdir"); + await ioManager.CreateDirectory(testDir, CancellationToken.None); + var symlinkedFile = ioManager.ConcatPath(testDir, "test1.txt"); + var symlinkedDir = ioManager.ConcatPath(testDir, "linkedDir"); + + await linkFactory.CreateSymbolicLink(targetDir, symlinkedDir, CancellationToken.None); + await linkFactory.CreateSymbolicLink(fileInTargetDir, symlinkedFile, CancellationToken.None); + + Assert.IsTrue(await ioManager.DirectoryExists(symlinkedDir, CancellationToken.None)); + Assert.IsTrue(await ioManager.FileExists(symlinkedFile, CancellationToken.None)); + Assert.IsTrue(await ioManager.FileExists(ioManager.ConcatPath(symlinkedDir, "test1.txt"), CancellationToken.None)); + Assert.IsTrue(await ioManager.FileExists(fileInTargetDir, CancellationToken.None)); + + await ioManager.DeleteDirectory(testDir, CancellationToken.None); + + Assert.IsFalse(await ioManager.DirectoryExists(symlinkedDir, CancellationToken.None)); + Assert.IsFalse(await ioManager.FileExists(symlinkedFile, CancellationToken.None)); + Assert.IsFalse(await ioManager.FileExists(ioManager.ConcatPath(symlinkedDir, "test1.txt"), CancellationToken.None)); + Assert.IsTrue(await ioManager.FileExists(fileInTargetDir, CancellationToken.None)); + Assert.IsTrue(expectedBytes.SequenceEqual(await ioManager.ReadAllBytes(fileInTargetDir, CancellationToken.None))); + } + catch + { + Directory.Delete(tempPath, true); + throw; + } + } + [TestMethod] public async Task TestFileExists() { diff --git a/tests/Tgstation.Server.Host.Tests/System/TestSymlinkFactory.cs b/tests/Tgstation.Server.Host.Tests/System/TestSymlinkFactory.cs index 8e488f11b0d..4d3c5be7492 100644 --- a/tests/Tgstation.Server.Host.Tests/System/TestSymlinkFactory.cs +++ b/tests/Tgstation.Server.Host.Tests/System/TestSymlinkFactory.cs @@ -12,9 +12,9 @@ namespace Tgstation.Server.Host.System.Tests [TestClass] public sealed class TestSymlinkFactory { - readonly ISymlinkFactory factory = new PlatformIdentifier().IsWindows - ? new WindowsSymlinkFactory() - : new PosixSymlinkFactory(); + readonly IFilesystemLinkFactory factory = new PlatformIdentifier().IsWindows + ? new WindowsFilesystemLinkFactory() + : new PosixFilesystemLinkFactory(); [TestMethod] public async Task TestSymlinks() diff --git a/tests/Tgstation.Server.Tests/Live/Instance/InstanceTest.cs b/tests/Tgstation.Server.Tests/Live/Instance/InstanceTest.cs index 4457994d792..2940500e206 100644 --- a/tests/Tgstation.Server.Tests/Live/Instance/InstanceTest.cs +++ b/tests/Tgstation.Server.Tests/Live/Instance/InstanceTest.cs @@ -43,6 +43,7 @@ public async Task RunTests( ushort ddPort, bool highPrioDD, bool lowPrioDeployment, + bool usingBasicWatchdog, CancellationToken cancellationToken) { var byondTest = new ByondTest(instanceClient.Byond, instanceClient.Jobs, fileDownloader, instanceClient.Metadata); @@ -67,7 +68,7 @@ public async Task RunTests( await byondTask; await new WatchdogTest( - await ByondTest.GetEdgeVersion(fileDownloader, cancellationToken), instanceClient, instanceManager, serverPort, highPrioDD, ddPort).Run(cancellationToken); + await ByondTest.GetEdgeVersion(fileDownloader, cancellationToken), instanceClient, instanceManager, serverPort, highPrioDD, ddPort, usingBasicWatchdog).Run(cancellationToken); } public async Task RunCompatTests( @@ -76,6 +77,7 @@ public async Task RunCompatTests( ushort dmPort, ushort ddPort, bool highPrioDD, + bool usingBasicWatchdog, CancellationToken cancellationToken) { System.Console.WriteLine($"COMPAT TEST START: {compatVersion}"); @@ -189,7 +191,7 @@ await instanceClient.Repository.Update(new RepositoryUpdateRequest await configSetupTask; - await new WatchdogTest(compatVersion, instanceClient, instanceManager, serverPort, highPrioDD, ddPort).Run(cancellationToken); + await new WatchdogTest(compatVersion, instanceClient, instanceManager, serverPort, highPrioDD, ddPort, usingBasicWatchdog).Run(cancellationToken); await instanceManagerClient.Update(new InstanceUpdateRequest { diff --git a/tests/Tgstation.Server.Tests/Live/Instance/WatchdogTest.cs b/tests/Tgstation.Server.Tests/Live/Instance/WatchdogTest.cs index 329fab6aa19..784fce5f67c 100644 --- a/tests/Tgstation.Server.Tests/Live/Instance/WatchdogTest.cs +++ b/tests/Tgstation.Server.Tests/Live/Instance/WatchdogTest.cs @@ -3,17 +3,22 @@ using Microsoft.Extensions.Logging; using Microsoft.VisualStudio.TestTools.UnitTesting; +using Mono.Unix; +using Mono.Unix.Native; + using Moq; using Newtonsoft.Json; using System; +using System.Collections.Generic; using System.Globalization; using System.IO; using System.Linq; using System.Net; using System.Net.Sockets; using System.Runtime.InteropServices; +using System.Text; using System.Threading; using System.Threading.Tasks; @@ -58,10 +63,11 @@ sealed class WatchdogTest : JobsRequiredTest readonly bool highPrioDD; readonly TopicClient topicClient; readonly Version testVersion; + readonly bool usingBasicWatchdog; bool ranTimeoutTest = false; - public WatchdogTest(Version testVersion, IInstanceClient instanceClient, InstanceManager instanceManager, ushort serverPort, bool highPrioDD, ushort ddPort) + public WatchdogTest(Version testVersion, IInstanceClient instanceClient, InstanceManager instanceManager, ushort serverPort, bool highPrioDD, ushort ddPort, bool usingBasicWatchdog) : base(instanceClient.Jobs) { this.instanceClient = instanceClient ?? throw new ArgumentNullException(nameof(instanceClient)); @@ -70,8 +76,9 @@ public WatchdogTest(Version testVersion, IInstanceClient instanceClient, Instanc this.highPrioDD = highPrioDD; this.ddPort = ddPort; this.testVersion = testVersion ?? throw new ArgumentNullException(nameof(testVersion)); + this.usingBasicWatchdog = usingBasicWatchdog; - this.topicClient = new(new SocketParameters + topicClient = new(new SocketParameters { SendTimeout = TimeSpan.FromSeconds(30), ReceiveTimeout = TimeSpan.FromSeconds(30), @@ -471,6 +478,47 @@ async Task RunBasicTest(CancellationToken cancellationToken) Assert.AreEqual(string.Empty, daemonStatus.AdditionalParameters); } + void TestLinuxIsntBeingFuckingCheekyAboutFilePaths(DreamDaemonResponse currentStatus, CompileJobResponse previousStatus) + { + if (new PlatformIdentifier().IsWindows || usingBasicWatchdog) + return; + + Assert.IsNotNull(currentStatus.ActiveCompileJob); + Assert.IsTrue(currentStatus.ActiveCompileJob.DmeName.Contains("long_running_test")); + Assert.AreEqual(WatchdogStatus.Online, currentStatus.Status); + + var procs = TestLiveServer.GetDDProcessesOnPort(currentStatus.Port.Value); + Assert.AreEqual(1, procs.Count); + var failingLinks = new List(); + using var proc = procs[0]; + var pid = proc.Id; + var foundLivePath = false; + var allPaths = new List(); + foreach (var fd in Directory.EnumerateFiles($"/proc/{pid}/fd")) + { + var sb = new StringBuilder(UInt16.MaxValue); + if (Syscall.readlink(fd, sb) == -1) + throw new UnixIOException(Stdlib.GetLastError()); + + var path = sb.ToString(); + + allPaths.Add($"Path: {path}"); + if (path.Contains($"Game/{previousStatus.DirectoryName}")) + failingLinks.Add($"Found fd {fd} resolving to previous absolute path game dir path: {path}"); + + if (path.Contains($"Game/{currentStatus.ActiveCompileJob.DirectoryName}")) + failingLinks.Add($"Found fd {fd} resolving to current absolute path game dir path: {path}"); + + if (path.Contains($"Game/Live")) + foundLivePath = true; + } + + if (!foundLivePath) + failingLinks.Add($"Failed to find a path containing the 'Live' directory!"); + + Assert.IsTrue(failingLinks.Count == 0, String.Join(Environment.NewLine, failingLinks.Concat(allPaths))); + } + async Task RunHealthCheckTest(bool checkDump, CancellationToken cancellationToken) { System.Console.WriteLine("TEST: WATCHDOG HEALTH CHECK TEST"); @@ -901,6 +949,8 @@ async Task RunLongRunningTestThenUpdate(CancellationToken cancellationToken) Assert.AreNotEqual(initialCompileJob.Id, daemonStatus.ActiveCompileJob.Id); Assert.IsNull(daemonStatus.StagedCompileJob); + TestLinuxIsntBeingFuckingCheekyAboutFilePaths(daemonStatus, initialCompileJob); + await instanceClient.DreamDaemon.Shutdown(cancellationToken); daemonStatus = await instanceClient.DreamDaemon.Read(cancellationToken); diff --git a/tests/Tgstation.Server.Tests/Live/LiveTestingServer.cs b/tests/Tgstation.Server.Tests/Live/LiveTestingServer.cs index 56263c17171..33213f6f7c5 100644 --- a/tests/Tgstation.Server.Tests/Live/LiveTestingServer.cs +++ b/tests/Tgstation.Server.Tests/Live/LiveTestingServer.cs @@ -63,6 +63,8 @@ static async Task Cleanup(string directory) public bool HighPriorityDreamDaemon { get; } public bool LowPriorityDeployments { get; } + public bool UsingBasicWatchdog { get; } + public bool RestartRequested => RealServer.RestartRequested; readonly List args; @@ -89,6 +91,8 @@ public LiveTestingServer(SwarmConfiguration swarmConfiguration, bool enableOAuth var gitHubAccessToken = Environment.GetEnvironmentVariable("TGS_TEST_GITHUB_TOKEN"); var dumpOpenAPISpecPathEnvVar = Environment.GetEnvironmentVariable("TGS_TEST_DUMP_API_SPEC"); + UsingBasicWatchdog = Boolean.TryParse(Environment.GetEnvironmentVariable("General__UseBasicWatchdog"), out var result) && result; + if (String.IsNullOrEmpty(DatabaseType)) Assert.Inconclusive("No database type configured in env var TGS_TEST_DATABASE_TYPE!"); diff --git a/tests/Tgstation.Server.Tests/Live/TestLiveServer.cs b/tests/Tgstation.Server.Tests/Live/TestLiveServer.cs index f058d9795fe..21ab8be8442 100644 --- a/tests/Tgstation.Server.Tests/Live/TestLiveServer.cs +++ b/tests/Tgstation.Server.Tests/Live/TestLiveServer.cs @@ -1326,8 +1326,6 @@ async Task FailFast(Task task) async Task RunInstanceTests() { - // Some earlier linux BYOND versions have a critical bug where replacing the directory in non-basic watchdogs causes the DreamDaemon cwd to change - var canRunCompatTests = new PlatformIdentifier().IsWindows; var compatTests = FailFast( instanceTest .RunCompatTests( @@ -1338,6 +1336,7 @@ async Task RunInstanceTests() compatDMPort, compatDDPort, server.HighPriorityDreamDaemon, + server.UsingBasicWatchdog, cancellationToken)); if (TestingUtils.RunningInGitHubActions) // they only have 2 cores, can't handle intense parallelization @@ -1351,6 +1350,7 @@ await FailFast( mainDDPort, server.HighPriorityDreamDaemon, server.LowPriorityDeployments, + server.UsingBasicWatchdog, cancellationToken)); await compatTests; @@ -1531,7 +1531,7 @@ async Task WaitForInitialJobs(IInstanceClient instanceClient) Assert.AreEqual(WatchdogStatus.Online, dd.Status.Value); var compileJob = await instanceClient.DreamMaker.Compile(cancellationToken); - var wdt = new WatchdogTest(edgeByond, instanceClient, GetInstanceManager(), (ushort)server.Url.Port, server.HighPriorityDreamDaemon, mainDDPort); + var wdt = new WatchdogTest(edgeByond, instanceClient, GetInstanceManager(), (ushort)server.Url.Port, server.HighPriorityDreamDaemon, mainDDPort, server.UsingBasicWatchdog); await wdt.WaitForJob(compileJob, 30, false, null, cancellationToken); dd = await instanceClient.DreamDaemon.Read(cancellationToken); @@ -1578,7 +1578,7 @@ await instanceClient.DreamDaemon.Update(new DreamDaemonRequest Assert.AreEqual(WatchdogStatus.Online, currentDD.Status); Assert.AreEqual(expectedStaged, currentDD.StagedCompileJob.Job.Id.Value); - var wdt = new WatchdogTest(edgeByond, instanceClient, GetInstanceManager(), (ushort)server.Url.Port, server.HighPriorityDreamDaemon, mainDDPort); + var wdt = new WatchdogTest(edgeByond, instanceClient, GetInstanceManager(), (ushort)server.Url.Port, server.HighPriorityDreamDaemon, mainDDPort, server.UsingBasicWatchdog); currentDD = await wdt.TellWorldToReboot(cancellationToken); Assert.AreEqual(expectedStaged, currentDD.ActiveCompileJob.Job.Id.Value); Assert.IsNull(currentDD.StagedCompileJob); diff --git a/tgstation-server.sln b/tgstation-server.sln index 20eef245e10..c1cde46821b 100644 --- a/tgstation-server.sln +++ b/tgstation-server.sln @@ -158,6 +158,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "LongRunning", "LongRunning" tests\DMAPI\LongRunning\long_running_test.dme = tests\DMAPI\LongRunning\long_running_test.dme tests\DMAPI\LongRunning\long_running_test_copy.dme = tests\DMAPI\LongRunning\long_running_test_copy.dme tests\DMAPI\LongRunning\long_running_test_rooted.dme = tests\DMAPI\LongRunning\long_running_test_rooted.dme + tests\DMAPI\LongRunning\resource.txt = tests\DMAPI\LongRunning\resource.txt tests\DMAPI\LongRunning\Test.dm = tests\DMAPI\LongRunning\Test.dm EndProjectSection EndProject