feat(file-actions): address review comments

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

Author: julien-nc

lib/Listener/FileActionTaskFailedListener.php

@@ -9,7 +9,6 @@
 
 namespace OCA\Assistant\Listener;
 
-use OCA\Assistant\AppInfo\Application;
 use OCA\Assistant\Service\NotificationService;
 use OCA\Assistant\Service\TaskProcessingService;
 use OCP\EventDispatcher\Event;
@@ -44,7 +43,7 @@ public function handle(Event $event): void {
 			return;
 		}
 
-		if (!$this->taskProcessingService->isFileActionTaskTypeAuthorized($taskTypeId)) {
+		if (!$this->taskProcessingService->isFileActionTaskTypeSupported($taskTypeId)) {
 			return;
 		}
 

lib/Listener/FileActionTaskSuccessfulListener.php

@@ -9,7 +9,6 @@
 
 namespace OCA\Assistant\Listener;
 
-use OCA\Assistant\AppInfo\Application;
 use OCA\Assistant\Service\NotificationService;
 use OCA\Assistant\Service\TaskProcessingService;
 use OCP\EventDispatcher\Event;
@@ -45,7 +44,7 @@ public function handle(Event $event): void {
 			return;
 		}
 
-		if (!$this->taskProcessingService->isFileActionTaskTypeAuthorized($taskTypeId)) {
+		if (!$this->taskProcessingService->isFileActionTaskTypeSupported($taskTypeId)) {
 			return;
 		}
 

lib/Service/NotificationService.php

@@ -95,7 +95,7 @@ public function sendFileActionNotification(
 		$notification->setApp(Application::APP_ID)
 			->setUser($userId)
 			->setDateTime(new DateTime())
-			->setObject('task', $taskId)
+			->setObject('task', (string)$taskId)
 			->setSubject($subject, $params);
 
 		$manager->notify($notification);

lib/Service/TaskProcessingService.php

@@ -23,13 +23,15 @@
 use OCP\TaskProcessing\Task;
 use OCP\TaskProcessing\TaskTypes\AudioToText;
 use OCP\TaskProcessing\TaskTypes\TextToTextSummary;
+use Psr\Log\LoggerInterface;
 use RuntimeException;
 
 class TaskProcessingService {
 
 	public function __construct(
 		private IManager $taskProcessingManager,
 		private IRootFolder $rootFolder,
+		private LoggerInterface $logger,
 	) {
 	}
 
@@ -68,12 +70,20 @@ public function getOutputFile(int $fileId): File {
 		return $node;
 	}
 
+	/**
+	 * @param int $fileId
+	 * @return string
+	 * @throws GenericFileException
+	 * @throws LockedException
+	 * @throws NotFoundException
+	 * @throws NotPermittedException
+	 */
 	public function getOutputFileContent(int $fileId): string {
 		$file = $this->getOutputFile($fileId);
 		return $file->getContent();
 	}
 
-	public function isFileActionTaskTypeAuthorized(string $taskTypeId): bool {
+	public function isFileActionTaskTypeSupported(string $taskTypeId): bool {
 		$authorizedTaskTypes = [AudioToText::ID, TextToTextSummary::ID];
 		if (class_exists('OCP\\TaskProcessing\\TaskTypes\\TextToSpeech')) {
 			$authorizedTaskTypes[] = \OCP\TaskProcessing\TaskTypes\TextToSpeech::ID;
@@ -89,35 +99,44 @@ public function isFileActionTaskTypeAuthorized(string $taskTypeId): bool {
 	 * @param string $taskTypeId
 	 * @return int The scheduled task ID
 	 * @throws Exception
-	 * @throws GenericFileException
-	 * @throws LockedException
 	 * @throws NotFoundException
-	 * @throws NotPermittedException
-	 * @throws PreConditionNotMetException
-	 * @throws UnauthorizedException
-	 * @throws ValidationException
-	 * @throws NoUserException
 	 */
 	public function runFileAction(string $userId, int $fileId, string $taskTypeId): int {
-		if (!$this->isFileActionTaskTypeAuthorized($taskTypeId)) {
-			throw new PreConditionNotMetException();
+		if (!$this->isFileActionTaskTypeSupported($taskTypeId)) {
+			throw new Exception('Invalid task type for file action');
+		}
+		try {
+			$userFolder = $this->rootFolder->getUserFolder($userId);
+		} catch (NoUserException|NotPermittedException $e) {
+			$this->logger->warning('Assistant runFileAction, the user folder could not be obtained', ['exception' => $e]);
+			throw new Exception('The user folder could not be obtained');
 		}
-		$userFolder = $this->rootFolder->getUserFolder($userId);
 		$file = $userFolder->getFirstNodeById($fileId);
 		if (!$file instanceof File) {
+			$this->logger->warning('Assistant runFileAction, the input file is not a file', ['file_id' => $fileId]);
 			throw new NotFoundException('File is not a file');
 		}
-		$input = $taskTypeId === AudioToText::ID
-			? ['input' => $fileId]
-			: ['input' => $file->getContent()];
+		try {
+			$input = $taskTypeId === AudioToText::ID
+				? ['input' => $fileId]
+				: ['input' => $file->getContent()];
+		} catch (NotPermittedException|GenericFileException|LockedException $e) {
+			$this->logger->warning('Assistant runFileAction, impossible to read the file action input file', ['exception' => $e]);
+			throw new Exception('Impossible to read the file action input file');
+		}
 		$task = new Task(
 			$taskTypeId,
 			$input,
 			Application::APP_ID,
 			$userId,
 			'file-action:' . $fileId,
 		);
-		$this->taskProcessingManager->scheduleTask($task);
+		try {
+			$this->taskProcessingManager->scheduleTask($task);
+		} catch (PreConditionNotMetException|ValidationException|Exception|UnauthorizedException $e) {
+			$this->logger->warning('Assistant runFileAction, impossible to schedule the task', ['exception' => $e]);
+			throw new Exception('Impossible to schedule the task');
+		}
 		$taskId = $task->getId();
 		if ($taskId === null) {
 			throw new Exception('The task could not be scheduled');

psalm.xml

@@ -53,7 +53,7 @@
 	</issueHandlers>
 	<stubs>
 		<file name="tests/stubs/oc_core_command_base.php" />
-		<file name="tests/stubs/oc_hooks_emitter.php" />
+		<file name="tests/stubs/oc_hooks_oca_files.php" />
 		<file name="tests/stubs/oc_transcription.php" />
 	</stubs>
 </psalm>

src/files/fileActions.js

@@ -62,7 +62,11 @@ function registerSummarizeAction() {
 			try {
 				const response = await axios.post(url)
 				console.debug('taskId', response.data.ocs.data.taskId)
-				showSuccess(t('assistant', 'The result file will be created soon'))
+				showSuccess(
+					t('assistant', 'Summarization task submitted successfully.') + ' '
+						+ t('assistant', 'You will be notified when it is ready.') + ' '
+						+ t('assistant', 'It can also be checked in the Assistant in the "Work with text -> Summarize" menu.'),
+				)
 			} catch (error) {
 				console.error(error)
 				showError(t('assistant', 'Failed to launch the AI file action'))
@@ -97,7 +101,11 @@ function registerTtsAction() {
 			try {
 				const response = await axios.post(url)
 				console.debug('taskId', response.data.ocs.data.taskId)
-				showSuccess(t('assistant', 'The result file will be created soon'))
+				showSuccess(
+					t('assistant', 'Text-to-speech task submitted successfully.') + ' '
+						+ t('assistant', 'You will be notified when it is ready.') + ' '
+						+ t('assistant', 'It can also be checked in the Assistant in the "Work with audio -> Generate speech" menu.'),
+				)
 			} catch (error) {
 				console.error(error)
 				showError(t('assistant', 'Failed to launch the AI file action'))
@@ -132,7 +140,11 @@ function registerSttAction() {
 			try {
 				const response = await axios.post(url)
 				console.debug('taskId', response.data.ocs.data.taskId)
-				showSuccess(t('assistant', 'The result file will be created soon'))
+				showSuccess(
+					t('assistant', 'Transcription task submitted successfully.') + ' '
+						+ t('assistant', 'You will be notified when it is ready.') + ' '
+						+ t('assistant', 'It can also be checked in the Assistant in the "Work with audio -> Transcribe audio" menu.'),
+				)
 			} catch (error) {
 				console.error(error)
 				showError(t('assistant', 'Failed to launch the AI file action'))