Merge pull request #55716 from nextcloud/feat/taskprocessing-successrate-setupcheck

feat(settings): Introduce TaskProcessingSuccessRate setup check

apps/settings/composer/composer/autoload_classmap.php

@@ -135,6 +135,7 @@ return array(
     'OCA\\Settings\\SetupChecks\\SupportedDatabase' => $baseDir . '/../lib/SetupChecks/SupportedDatabase.php',
     'OCA\\Settings\\SetupChecks\\SystemIs64bit' => $baseDir . '/../lib/SetupChecks/SystemIs64bit.php',
     'OCA\\Settings\\SetupChecks\\TaskProcessingPickupSpeed' => $baseDir . '/../lib/SetupChecks/TaskProcessingPickupSpeed.php',
+    'OCA\\Settings\\SetupChecks\\TaskProcessingSuccessRate' => $baseDir . '/../lib/SetupChecks/TaskProcessingSuccessRate.php',
     'OCA\\Settings\\SetupChecks\\TempSpaceAvailable' => $baseDir . '/../lib/SetupChecks/TempSpaceAvailable.php',
     'OCA\\Settings\\SetupChecks\\TransactionIsolation' => $baseDir . '/../lib/SetupChecks/TransactionIsolation.php',
     'OCA\\Settings\\SetupChecks\\WellKnownUrls' => $baseDir . '/../lib/SetupChecks/WellKnownUrls.php',

apps/settings/composer/composer/autoload_static.php

@@ -150,6 +150,7 @@ class ComposerStaticInitSettings
         'OCA\\Settings\\SetupChecks\\SupportedDatabase' => __DIR__ . '/..' . '/../lib/SetupChecks/SupportedDatabase.php',
         'OCA\\Settings\\SetupChecks\\SystemIs64bit' => __DIR__ . '/..' . '/../lib/SetupChecks/SystemIs64bit.php',
         'OCA\\Settings\\SetupChecks\\TaskProcessingPickupSpeed' => __DIR__ . '/..' . '/../lib/SetupChecks/TaskProcessingPickupSpeed.php',
+        'OCA\\Settings\\SetupChecks\\TaskProcessingSuccessRate' => __DIR__ . '/..' . '/../lib/SetupChecks/TaskProcessingSuccessRate.php',
         'OCA\\Settings\\SetupChecks\\TempSpaceAvailable' => __DIR__ . '/..' . '/../lib/SetupChecks/TempSpaceAvailable.php',
         'OCA\\Settings\\SetupChecks\\TransactionIsolation' => __DIR__ . '/..' . '/../lib/SetupChecks/TransactionIsolation.php',
         'OCA\\Settings\\SetupChecks\\WellKnownUrls' => __DIR__ . '/..' . '/../lib/SetupChecks/WellKnownUrls.php',

apps/settings/lib/SetupChecks/TaskProcessingSuccessRate.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Settings\SetupChecks;
+
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\IL10N;
+use OCP\SetupCheck\ISetupCheck;
+use OCP\SetupCheck\SetupResult;
+use OCP\TaskProcessing\IManager;
+use OCP\TaskProcessing\Task;
+
+class TaskProcessingSuccessRate implements ISetupCheck {
+	public const MAX_FAILURE_PERCENTAGE = 0.2;
+
+	public const MAX_DAYS = 14;
+
+	public function __construct(
+		private IL10N $l10n,
+		private IManager $taskProcessingManager,
+		private ITimeFactory $timeFactory,
+	) {
+	}
+
+	public function getCategory(): string {
+		return 'ai';
+	}
+
+	public function getName(): string {
+		return $this->l10n->t('Task Processing pickup speed');
+	}
+
+	public function run(): SetupResult {
+		$taskCount = 0;
+		$lastNDays = 0;
+		while ($taskCount === 0 && $lastNDays < self::MAX_DAYS) {
+			$lastNDays++;
+			// userId: '' means no filter, whereas null would mean guest
+			$tasks = $this->taskProcessingManager->getTasks(userId: '', scheduleAfter: $this->timeFactory->now()->getTimestamp() - (60 * 60 * 24 * $lastNDays));
+			$taskCount = count($tasks);
+		}
+		if ($taskCount === 0) {
+			return SetupResult::success(
+				$this->l10n->n(
+					'No scheduled tasks in the last day.',
+					'No scheduled tasks in the last %n days.',
+					$lastNDays
+				)
+			);
+		}
+		$failedCount = 0;
+		foreach ($tasks as $task) {
+			if ($task->getEndedAt() === null) {
+				continue; // task was not picked up yet
+			}
+			$status = $task->getStatus();
+			if ($status === Task::STATUS_FAILED) {
+				$failedCount++;
+			}
+		}
+
+		if (($failedCount / $taskCount) < self::MAX_FAILURE_PERCENTAGE) {
+			return SetupResult::success(
+				$this->l10n->n(
+					'Most tasks were successful in the last day.',
+					'Most tasks were successful in the last %n days.',
+					$lastNDays
+				)
+			);
+		} else {
+			return SetupResult::warning(
+				$this->l10n->n(
+					'A lot of tasks failed in the last day. Consider checking the nextcloud log for errors and investigating whether the AI provider apps have been set up correctly.',
+					'A lot of tasks failed in the last %n days. Consider checking the nextcloud log for errors and investigating whether the AI provider apps have been set up correctly.',
+					$lastNDays
+				),
+				'https://docs.nextcloud.com/server/latest/admin_manual/ai/insight_and_debugging.html'
+			);
+		}
+	}
+}

apps/settings/tests/SetupChecks/TaskProcessingSuccessRateTest.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Settings\Tests;
+
+use OCA\Settings\SetupChecks\TaskProcessingSuccessRate;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\IL10N;
+use OCP\SetupCheck\SetupResult;
+use OCP\TaskProcessing\IManager;
+use OCP\TaskProcessing\Task;
+use Test\TestCase;
+
+class TaskProcessingSuccessRateTest extends TestCase {
+	private IL10N $l10n;
+	private ITimeFactory $timeFactory;
+	private IManager $taskProcessingManager;
+
+	private TaskProcessingSuccessRate $check;
+
+	protected function setUp(): void {
+		parent::setUp();
+
+		$this->l10n = $this->getMockBuilder(IL10N::class)->getMock();
+		$this->timeFactory = $this->getMockBuilder(ITimeFactory::class)->getMock();
+		$this->taskProcessingManager = $this->getMockBuilder(IManager::class)->getMock();
+
+		$this->check = new TaskProcessingSuccessRate(
+			$this->l10n,
+			$this->taskProcessingManager,
+			$this->timeFactory,
+		);
+	}
+
+	public function testPass(): void {
+		$tasks = [];
+		for ($i = 0; $i < 100; $i++) {
+			$task = new Task('test', ['test' => 'test'], 'settings', 'user' . $i);
+			$task->setStartedAt(0);
+			$task->setEndedAt(1);
+			if ($i < 15) {
+				$task->setStatus(Task::STATUS_FAILED); // 15% get status FAILED
+			} else {
+				$task->setStatus(Task::STATUS_SUCCESSFUL);
+			}
+			$tasks[] = $task;
+		}
+		$this->taskProcessingManager->method('getTasks')->willReturn($tasks);
+
+		$this->assertEquals(SetupResult::SUCCESS, $this->check->run()->getSeverity());
+	}
+
+	public function testFail(): void {
+		$tasks = [];
+		for ($i = 0; $i < 100; $i++) {
+			$task = new Task('test', ['test' => 'test'], 'settings', 'user' . $i);
+			$task->setStartedAt(0);
+			$task->setEndedAt(1);
+			if ($i < 30) {
+				$task->setStatus(Task::STATUS_FAILED); // 30% get status FAILED
+			} else {
+				$task->setStatus(Task::STATUS_SUCCESSFUL);
+			}
+			$tasks[] = $task;
+		}
+		$this->taskProcessingManager->method('getTasks')->willReturn($tasks);
+
+		$this->assertEquals(SetupResult::WARNING, $this->check->run()->getSeverity());
+	}
+}