Merge pull request #125 from ConductionNL/development

Fixes on log retention and job interval

appinfo/info.xml

@@ -33,6 +33,10 @@ The OpenConnector Nextcloud app provides a ESB-framework to work together in an
         <owncloud max-version="0" min-version="0"/>
 	</dependencies>
 
+	<background-jobs>
+		<job>OCA\OpenConnector\Cron\LogCleanUpTask</job>
+	</background-jobs>
+
 	<navigations>
 		<navigation>
 			<id>openconnector</id>

lib/Cron/ActionTask.php

@@ -109,7 +109,9 @@ public function run($argument)
 
         // Update the job
         $job->setLastRun(new DateTime());
-        $job->setNextRun(new DateTime());
+		$nextRun = new DateTime('now + '.$job->getInterval().' seconds');
+		$nextRun->setTime(hour: $nextRun->format('H'), minute: $nextRun->format('i'));
+        $job->setNextRun($nextRun);
         $this->jobMapper->update($job);
 
         // Log the job

lib/Cron/LogCleanUpTask.php

@@ -3,13 +3,35 @@
 namespace OCA\OpenConnector\Cron;
 
 use OCA\OpenConnector\Db\CallLogMapper;
+use OCA\OpenConnector\Db\JobLogMapper;
+use OCA\OpenConnector\Db\JobMapper;
+use OCP\BackgroundJob\IJobList;
 use OCP\BackgroundJob\TimedJob;
 use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\IUserManager;
+use OCP\IUserSession;
 
-class LogCleanUpTask
+class LogCleanUpTask extends TimedJob
 {
-    public function doCron(array $arguments, CallLogMapper $callLogMapper){
-        $callLogMapper = new ClearLogs();
+	public function __construct(
+		ITimeFactory $time,
+		private readonly CallLogMapper $callLogMapper,
+	) {
+		parent::__construct($time);
+
+		// Run every 5 minutes
+		$this->setInterval(300);
+
+		// Delay until low-load time
+		//$this->setTimeSensitivity(\OCP\BackgroundJob\IJob::TIME_SENSITIVE);
+		// Or $this->setTimeSensitivity(\OCP\BackgroundJob\IJob::TIME_INSENSITIVE);
+
+		// Only run one instance of this job at a time
+		$this->setAllowParallelRuns(false);
+	}
+
+    public function run(mixed $argument){
+        $this->callLogMapper->clearLogs();
     }
 
 }

lib/Db/CallLogMapper.php

@@ -93,7 +93,7 @@ public function clearLogs(): bool
 
         // Build the delete query
         $qb->delete('openconnector_call_logs')
-           ->where($qb->expr()->lt('expired', $qb->createFunction('NOW()')));
+           ->where($qb->expr()->lt('expires', $qb->createFunction('NOW()')));
 
         // Execute the query and get the number of affected rows
         $result = $qb->execute();

lib/Migration/Version1Date20241206095007.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\OpenConnector\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+/**
+ * FIXME Auto-generated migration step: Please modify to your needs!
+ */
+class Version1Date20241206095007 extends SimpleMigrationStep {
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure(): ISchemaWrapper $schemaClosure
+	 * @param array $options
+	 */
+	public function preSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
+	}
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure(): ISchemaWrapper $schemaClosure
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/**
+		 * @var ISchemaWrapper $schema
+		 */
+		$schema = $schemaClosure();
+
+		if ($schema->hasTable('openconnector_sources') === true) {
+			$table = $schema->getTable('openconnector_sources');
+
+			if ($table->hasColumn('logRetention') === true) {
+				$table->dropColumn('logRetention');
+				$table->addColumn('log_retention', Types::INTEGER)->setNotnull(false)->setDefault(3600);
+			}
+			if ($table->hasColumn('errorRetention') === true) {
+				$table->dropColumn('errorRetention');
+				$table->addColumn('error_retention', Types::INTEGER)->setNotnull(false)->setDefault(86400);
+			}
+		}
+
+		return $schema;
+	}
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure(): ISchemaWrapper $schemaClosure
+	 * @param array $options
+	 */
+	public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
+	}
+}

lib/Service/CallService.php

@@ -138,6 +138,7 @@ public function call(
 			$callLog->setStatusCode(409);
 			$callLog->setStatusMessage("This source is not enabled");
 			$callLog->setCreated(new \DateTime());
+			$callLog->setExpires(new \DateTime('now + '.$source->getErrorRetention().' seconds'));
 
 			$this->callLogMapper->insert($callLog);
 
@@ -152,6 +153,7 @@ public function call(
 			$callLog->setStatusCode(409);
 			$callLog->setStatusMessage("This source has no location");
 			$callLog->setCreated(new \DateTime());
+			$callLog->setExpires(new \DateTime('now + '.$source->getErrorRetention().' seconds'));
 
 			$this->callLogMapper->insert($callLog);
 
@@ -178,6 +180,7 @@ public function call(
 			$callLog->setStatusCode(429); //
 			$callLog->setStatusMessage("The rate limit for this source has been exceeded. Try again later.");
 			$callLog->setCreated(new \DateTime());
+			$callLog->setExpires(new \DateTime('now + '.$source->getErrorRetention().' seconds'));
 
 			$this->callLogMapper->insert($callLog);
 
@@ -282,6 +285,7 @@ public function call(
 		$callLog->setRequest($data['request']);
 		$callLog->setResponse($data['response']);
 		$callLog->setCreated(new \DateTime());
+		$callLog->setExpires(new \DateTime('now + '.($data['response']['statusCode'] < 400 ? $source->getLogRetention() : $source->getErrorRetention()).' seconds'));
 
 		$this->callLogMapper->insert($callLog);