Merge pull request #48496 from nextcloud/enh/noid/taskprocessing-comm…

…ands-task-errors [taskprocessing] Add new command to get a task from a task ID
nextcloud · Oct 1, 2024 · 0e1cb72 · 0e1cb72
2 parents 1c1f488 + 14cf5b0
commit 0e1cb72
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 1 deletion.
diff --git a/core/Command/TaskProcessing/GetCommand.php b/core/Command/TaskProcessing/GetCommand.php
@@ -0,0 +1,41 @@
+<?php
+/**
+ * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OC\Core\Command\TaskProcessing;
+
+use OC\Core\Command\Base;
+use OCP\TaskProcessing\IManager;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class GetCommand extends Base {
+	public function __construct(
+		protected IManager $taskProcessingManager,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure() {
+		$this
+			->setName('taskprocessing:task:get')
+			->setDescription('Display all information for a specific task')
+			->addArgument(
+				'task-id',
+				InputArgument::REQUIRED,
+				'ID of the task to display'
+			);
+		parent::configure();
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$taskId = (int)$input->getArgument('task-id');
+		$task = $this->taskProcessingManager->getTask($taskId);
+		$jsonTask = $task->jsonSerialize();
+		$jsonTask['error_message'] = $task->getErrorMessage();
+		$this->writeArrayInOutputFormat($input, $output, $jsonTask);
+		return 0;
+	}
+}
diff --git a/core/Command/TaskProcessing/ListCommand.php b/core/Command/TaskProcessing/ListCommand.php
@@ -83,7 +83,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 		$endedBefore = $input->getOption('endedBefore');
 
 		$tasks = $this->taskProcessingManager->getTasks($userIdFilter, $type, $appId, $customId, $status, $scheduledAfter, $endedBefore);
-		$arrayTasks = array_map(fn (Task $task): array => $task->jsonSerialize(), $tasks);
+		$arrayTasks = array_map(static function (Task $task) {
+			$jsonTask = $task->jsonSerialize();
+			$jsonTask['error_message'] = $task->getErrorMessage();
+			return $jsonTask;
+		}, $tasks);
 
 		$this->writeArrayInOutputFormat($input, $output, $arrayTasks);
 		return 0;

diff --git a/core/register_command.php b/core/register_command.php
@@ -145,6 +145,7 @@
 	$application->add(Server::get(Command\SetupChecks::class));
 	$application->add(Server::get(Command\FilesMetadata\Get::class));
 
+	$application->add(Server::get(Command\TaskProcessing\GetCommand::class));
 	$application->add(Server::get(Command\TaskProcessing\ListCommand::class));
 	$application->add(Server::get(Command\TaskProcessing\Statistics::class));
 

diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
@@ -1228,6 +1228,7 @@
     'OC\\Core\\Command\\SystemTag\\Delete' => $baseDir . '/core/Command/SystemTag/Delete.php',
     'OC\\Core\\Command\\SystemTag\\Edit' => $baseDir . '/core/Command/SystemTag/Edit.php',
     'OC\\Core\\Command\\SystemTag\\ListCommand' => $baseDir . '/core/Command/SystemTag/ListCommand.php',
+    'OC\\Core\\Command\\TaskProcessing\\GetCommand' => $baseDir . '/core/Command/TaskProcessing/GetCommand.php',
     'OC\\Core\\Command\\TaskProcessing\\ListCommand' => $baseDir . '/core/Command/TaskProcessing/ListCommand.php',
     'OC\\Core\\Command\\TaskProcessing\\Statistics' => $baseDir . '/core/Command/TaskProcessing/Statistics.php',
     'OC\\Core\\Command\\TwoFactorAuth\\Base' => $baseDir . '/core/Command/TwoFactorAuth/Base.php',

diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
@@ -1261,6 +1261,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\Core\\Command\\SystemTag\\Delete' => __DIR__ . '/../../..' . '/core/Command/SystemTag/Delete.php',
         'OC\\Core\\Command\\SystemTag\\Edit' => __DIR__ . '/../../..' . '/core/Command/SystemTag/Edit.php',
         'OC\\Core\\Command\\SystemTag\\ListCommand' => __DIR__ . '/../../..' . '/core/Command/SystemTag/ListCommand.php',
+        'OC\\Core\\Command\\TaskProcessing\\GetCommand' => __DIR__ . '/../../..' . '/core/Command/TaskProcessing/GetCommand.php',
         'OC\\Core\\Command\\TaskProcessing\\ListCommand' => __DIR__ . '/../../..' . '/core/Command/TaskProcessing/ListCommand.php',
         'OC\\Core\\Command\\TaskProcessing\\Statistics' => __DIR__ . '/../../..' . '/core/Command/TaskProcessing/Statistics.php',
         'OC\\Core\\Command\\TwoFactorAuth\\Base' => __DIR__ . '/../../..' . '/core/Command/TwoFactorAuth/Base.php',