using System.Globalization; using Chronos.Core.Localization; using Chronos.Core.Model; using Chronos.Data.Archiving; using Chronos.Data.Repositories; using Chronos.Testing; namespace Chronos.Data.Tests.Archiving; /// Maintenance vacuums the SQLite index (BRIEF ยง12.5 "SQLite vacuum"); a dry run only reports the reclaimable space. [Category("archive")] public sealed class IndexMaintenanceTests(TestContext context) { [Test] public async Task ADryRunReportsTheFreePagesAndARunGivesThemBack() { await using var fx = await ArchiveFixture.CreateAsync(context); await FreeSpaceAsync(fx.Db, fx.Ct); var before = (await fx.Db.SpaceAsync(fx.Ct))!; Assert.True(before.ReclaimableBytes >= before.FileBytes * 0.3, $"free pages made ({before.ReclaimableBytes} of {before.FileBytes})"); var dry = await fx.Service.Maintenance.RunAsync(fx.Archive, dryRun: true, 0, _ => ValueTask.CompletedTask, fx.Ct); Assert.Equal((before.ReclaimableBytes, 0L), (dry.IndexReclaimable, dry.IndexReclaimed)); Assert.Equal(before.ReclaimableBytes, (await fx.Db.SpaceAsync(fx.Ct))!.ReclaimableBytes); var run = await fx.Service.Maintenance.RunAsync(fx.Archive, dryRun: false, 0, _ => ValueTask.CompletedTask, fx.Ct); Assert.Greater(run.IndexReclaimed, 0L); var after = (await fx.Db.SpaceAsync(fx.Ct))!; Assert.Equal(0L, after.ReclaimableBytes); Assert.Less(after.FileBytes, before.FileBytes); // The index still answers after the rewrite. Assert.NotNull(await fx.Db.Archives.GetAsync(fx.Archive.Id, fx.Ct)); } [Test] public async Task AFewFreePagesAreNotWorthARewrite() { await using var fx = await ArchiveFixture.CreateAsync(context); var space = (await fx.Db.SpaceAsync(fx.Ct))!; Assert.True(space.ReclaimableBytes < space.FileBytes * ArchiveMaintenance.IndexVacuumRatio, "a fresh index has almost no free pages"); var run = await fx.Service.Maintenance.RunAsync(fx.Archive, dryRun: false, 0, _ => ValueTask.CompletedTask, fx.Ct); Assert.Equal((space.ReclaimableBytes, 0L), (run.IndexReclaimable, run.IndexReclaimed)); } [Test] public async Task TheMaintenanceJobLogsTheVacuum() { await using var fx = await ArchiveFixture.CreateAsync(context); await FreeSpaceAsync(fx.Db, fx.Ct); var engine = await fx.StartEngineAsync(); var dry = await engine.EnqueueAsync(ArchiveJobs.Maintenance(fx.Archive, dryRun: true), cancellationToken: fx.Ct); var dryDone = await fx.WaitForAsync(dry.Id, JobState.Done); Assert.True(HasLine(dryDone.LogTail, "Archive.Log.IndexReclaimable"), dryDone.LogTail ?? "no log"); Assert.False(HasLine(dryDone.LogTail, "Archive.Log.IndexVacuumed"), "a dry run rewrites nothing"); var run = await engine.EnqueueAsync(ArchiveJobs.Maintenance(fx.Archive), cancellationToken: fx.Ct); var runDone = await fx.WaitForAsync(run.Id, JobState.Done); Assert.Equal(5L, runDone.ProgressTotal); Assert.True(HasLine(runDone.LogTail, "Archive.Log.IndexVacuumed"), runDone.LogTail ?? "no log"); Assert.Equal(0L, (await fx.Db.SpaceAsync(fx.Ct))!.ReclaimableBytes); } /// A log line made from the one-argument sentence , whatever its size argument. private static bool HasLine(string? log, string key) { var parts = Loc.L(key, "\0").Split('\0'); return (log ?? string.Empty).Split('\n').Any(l => l.Contains(parts[0], StringComparison.Ordinal) && l.TrimEnd().EndsWith(parts[1].TrimEnd(), StringComparison.Ordinal)); } /// Writes about 2 MB of rows and deletes them: SQLite keeps the pages as free pages until a vacuum. internal static async Task FreeSpaceAsync(ChronosDatabase db, CancellationToken cancellationToken) { var filler = new string('x', 4000); for (var i = 0; i < 500; i++) await db.Settings.SetJsonAsync(SettingScope.App, null, "filler." + i.ToString(CultureInfo.InvariantCulture), "\"" + filler + "\"", cancellationToken); for (var i = 0; i < 500; i++) await db.Settings.DeleteAsync(SettingScope.App, null, "filler." + i.ToString(CultureInfo.InvariantCulture), cancellationToken); } }