feat(jobs): clean old job runs

feat(jobs): clean old job runs

Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>

[skip ci]

Author: Altahrim

config/config.sample.php

@@ -3020,4 +3020,12 @@
 	 * Defaults to ``0``.
 	 */
 	'preview_expiration_days' => 0,
+
+	/**
+	 * Delete job runs older than a certain number of days.
+	 * Less than one day is not allowed.
+	 *
+	 * Defaults to ``60``.
+	 */
+	'background_jobs_expiration_days' => 60,
 ];

core/BackgroundJobs/CleanupBackgroundJobsJob.php

@@ -19,12 +19,14 @@
 use OCP\IServerInfo;
 use Override;
 use Psr\Log\LoggerInterface;
+use RuntimeException;
 
 class CleanupBackgroundJobsJob extends TimedJob {
 	public function __construct(
 		ITimeFactory $time,
 		private readonly JobRuns $jobRuns,
 		private readonly IServerInfo $serverInfo,
+		private readonly IConfig $config,
 		private readonly LoggerInterface $logger,
 	) {
 		parent::__construct($time);
@@ -35,8 +37,7 @@ public function __construct(
 	#[Override]
 	protected function run($argument): void {
 		$this->reapCrashedJobs();
-
-		// TODO Clean oldest jobs
+		$this->cleanOldestRuns();
 	}
 
 	private function reapCrashedJobs(): void {
@@ -67,4 +68,19 @@ private function reapCrashedJobs(): void {
 			}
 		}
 	}
+
+	private function cleanOldestRuns(): void {
+		$daysToKeep = $this->config->getSystemValueInt('background_jobs_expiration_days', 60);
+		if ($daysToKeep < 1) {
+			throw new RuntimeException('Invalid number of days');
+		}
+		$cleanBeforeTimestamp = time() - ($daysToKeep * 24 * 3600);
+
+		$cleanedJobs = $this->jobRuns->deleteBefore($cleanBeforeTimestamp);
+		if ($cleanedJobs > 0) {
+			$this->logger->info(
+				'Cleanup of old background jobs. Number of jobs removed: ' . $cleanedJobs . 'Reason: older than ' . $daysToKeep . ' days.',
+			);
+		}
+	}
 }

lib/private/BackgroundJob/JobRuns.php

@@ -61,6 +61,18 @@ public function finished(int|string $runId, int $duration, int $memoryPeakUsage,
 		return $result === 1;
 	}
 
+	public function deleteBefore(int $timestamp): int {
+		$beforeSnowflake = $this->snowflakeGenerator->minForTimeId($timestamp);
+		$beforeSnowflake = '91480652934574081';
+		$qb = $this->connection->getQueryBuilder();
+		$result = $qb
+			->delete(self::TABLE)
+			->where($qb->expr()->lt('run_id', $qb->createNamedParameter($beforeSnowflake)))
+			->executeStatement();
+
+		return $result;
+	}
+
 	#[Override]
 	public function runningJobs(int $limit = 200): \Generator {
 		$qb = $this->connection->getQueryBuilder();