feat(taskprocessing): add start, stop and schedule time to tasks

Signed-off-by: Julien Veyssier <julien-nc@posteo.net>

2 files changed, 37 insertions, 0 deletions

diff --git a/lib/private/TaskProcessing/Db/Task.php b/lib/private/TaskProcessing/Db/Task.php
index 9fc999faf1a..ea95f32b252 100644
--- a/lib/private/TaskProcessing/Db/Task.php
+++ b/lib/private/TaskProcessing/Db/Task.php
@@ -39,6 +39,12 @@ use OCP\TaskProcessing\Task as OCPTask;
  * @method string getWebhookUri()
  * @method setWebhookMethod(string $webhookMethod)
  * @method string getWebhookMethod()
+ * @method setScheduledAt(int $scheduledAt)
+ * @method int getScheduledAt()
+ * @method setStartedAt(int $startedAt)
+ * @method int getStartedAt()
+ * @method setEndedAt(int $endedAt)
+ * @method int getEndedAt()
  */
 class Task extends Entity {
 	protected $lastUpdated;
@@ -54,6 +60,9 @@ class Task extends Entity {
 	protected $progress;
 	protected $webhookUri;
 	protected $webhookMethod;
+	protected $scheduledAt;
+	protected $startedAt;
+	protected $endedAt;
 
 	/**
 	 * @var string[]
@@ -82,6 +91,9 @@ class Task extends Entity {
 		$this->addType('progress', 'float');
 		$this->addType('webhookUri', 'string');
 		$this->addType('webhookMethod', 'string');
+		$this->addType('scheduleAt', 'integer');
+		$this->addType('startedAt', 'integer');
+		$this->addType('endedAt', 'integer');
 	}
 
 	public function toRow(): array {
@@ -107,6 +119,9 @@ class Task extends Entity {
 			'progress' => $task->getProgress(),
 			'webhookUri' => $task->getWebhookUri(),
 			'webhookMethod' => $task->getWebhookMethod(),
+			'scheduledAt' => $task->getScheduledAt(),
+			'startedAt' => $task->getStartedAt(),
+			'endedAt' => $task->getEndedAt(),
 		]);
 		return $taskEntity;
 	}
@@ -126,6 +141,9 @@ class Task extends Entity {
 		$task->setProgress($this->getProgress());
 		$task->setWebhookUri($this->getWebhookUri());
 		$task->setWebhookMethod($this->getWebhookMethod());
+		$task->setScheduledAt($this->getScheduledAt());
+		$task->setStartedAt($this->getStartedAt());
+		$task->setEndedAt($this->getEndedAt());
 		return $task;
 	}
 }
diff --git a/lib/private/TaskProcessing/Manager.php b/lib/private/TaskProcessing/Manager.php
index 714a23ce5e2..2ddfc3d6e51 100644
--- a/lib/private/TaskProcessing/Manager.php
+++ b/lib/private/TaskProcessing/Manager.php
@@ -616,6 +616,7 @@ class Manager implements IManager {
 		// remove superfluous keys and set input
 		$task->setInput($this->removeSuperfluousArrayKeys($task->getInput(), $inputShape, $optionalInputShape));
 		$task->setStatus(Task::STATUS_SCHEDULED);
+		$task->setScheduledAt(time());
 		$provider = $this->getPreferredProvider($task->getTaskTypeId());
 		// calculate expected completion time
 		$completionExpectedAt = new \DateTime('now');
@@ -656,6 +657,7 @@ class Manager implements IManager {
 			return;
 		}
 		$task->setStatus(Task::STATUS_CANCELLED);
+		$task->setEndedAt(time());
 		$taskEntity = \OC\TaskProcessing\Db\Task::fromPublicTask($task);
 		try {
 			$this->taskMapper->update($taskEntity);
@@ -671,6 +673,10 @@ class Manager implements IManager {
 		if ($task->getStatus() === Task::STATUS_CANCELLED) {
 			return false;
 		}
+		// only set the start time if the task is going from scheduled to running
+		if ($task->getstatus() === Task::STATUS_SCHEDULED) {
+			$task->setStartedAt(time());
+		}
 		$task->setStatus(Task::STATUS_RUNNING);
 		$task->setProgress($progress);
 		$taskEntity = \OC\TaskProcessing\Db\Task::fromPublicTask($task);
@@ -691,6 +697,7 @@ class Manager implements IManager {
 		}
 		if ($error !== null) {
 			$task->setStatus(Task::STATUS_FAILED);
+			$task->setEndedAt(time());
 			$task->setErrorMessage($error);
 			$this->logger->warning('A TaskProcessing ' . $task->getTaskTypeId() . ' task with id ' . $id . ' failed with the following message: ' . $error);
 		} elseif ($result !== null) {
@@ -725,21 +732,25 @@ class Manager implements IManager {
 				$task->setOutput($output);
 				$task->setProgress(1);
 				$task->setStatus(Task::STATUS_SUCCESSFUL);
+				$task->setEndedAt(time());
 			} catch (ValidationException $e) {
 				$task->setProgress(1);
 				$task->setStatus(Task::STATUS_FAILED);
+				$task->setEndedAt(time());
 				$error = 'The task was processed successfully but the provider\'s output doesn\'t pass validation against the task type\'s outputShape spec and/or the provider\'s own optionalOutputShape spec';
 				$task->setErrorMessage($error);
 				$this->logger->error($error, ['exception' => $e]);
 			} catch (NotPermittedException $e) {
 				$task->setProgress(1);
 				$task->setStatus(Task::STATUS_FAILED);
+				$task->setEndedAt(time());
 				$error = 'The task was processed successfully but storing the output in a file failed';
 				$task->setErrorMessage($error);
 				$this->logger->error($error, ['exception' => $e]);
 			} catch (InvalidPathException|\OCP\Files\NotFoundException $e) {
 				$task->setProgress(1);
 				$task->setStatus(Task::STATUS_FAILED);
+				$task->setEndedAt(time());
 				$error = 'The task was processed successfully but the result file could not be found';
 				$task->setErrorMessage($error);
 				$this->logger->error($error, ['exception' => $e]);
@@ -926,6 +937,14 @@ class Manager implements IManager {
 	 * @throws Exception
 	 */
 	public function setTaskStatus(Task $task, int $status): void {
+		$currentTaskStatus = $task->getStatus();
+		if ($currentTaskStatus === Task::STATUS_SCHEDULED && $status === Task::STATUS_RUNNING) {
+			$task->setStartedAt(time());
+		} elseif ($currentTaskStatus === Task::STATUS_RUNNING && ($status === Task::STATUS_FAILED || $status === Task::STATUS_CANCELLED)) {
+			$task->setEndedAt(time());
+		} elseif ($currentTaskStatus === Task::STATUS_UNKNOWN && $status === Task::STATUS_SCHEDULED) {
+			$task->setScheduledAt(time());
+		}
 		$task->setStatus($status);
 		$taskEntity = \OC\TaskProcessing\Db\Task::fromPublicTask($task);
 		$this->taskMapper->update($taskEntity);