Add BackgroundJob to clear old statuses

Signed-off-by: Georg Ehrke <[email protected]>

apps/user_status/appinfo/info.xml

@@ -15,4 +15,7 @@
     <dependencies>
         <nextcloud min-version="20" max-version="20"/>
     </dependencies>
+    <background-jobs>
+        <job>OCA\UserStatus\BackgroundJob\ClearOldStatusesBackgroundJob</job>
+    </background-jobs>
 </info>

apps/user_status/lib/BackgroundJob/ClearOldStatusesBackgroundJob.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020, Georg Ehrke
+ *
+ * @author Georg Ehrke <[email protected]>
+ *
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCA\UserStatus\BackgroundJob;
+
+use OCA\UserStatus\Db\UserStatusMapper;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\TimedJob;
+
+/**
+ * Class ClearOldStatusesBackgroundJob
+ *
+ * @package OCA\UserStatus\BackgroundJob
+ */
+class ClearOldStatusesBackgroundJob extends TimedJob {
+
+	/** @var UserStatusMapper */
+	private $mapper;
+
+	/**
+	 * ClearOldStatusesBackgroundJob constructor.
+	 *
+	 * @param ITimeFactory $time
+	 * @param UserStatusMapper $mapper
+	 */
+	public function __construct(ITimeFactory $time,
+								UserStatusMapper $mapper) {
+		parent::__construct($time);
+		$this->mapper = $mapper;
+
+		// Run every 15 minutes
+		$this->setInterval(60 * 15);
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	protected function run($argument) {
+		$this->mapper->clearOlderThan($this->time->getTime());
+	}
+}

apps/user_status/lib/Db/UserStatusMapper.php

@@ -78,4 +78,17 @@ public function findByUserId(string $userId):UserStatus {
 
 		return $this->findEntity($qb);
 	}
+
+	/**
+	 * Clear all statuses older than a given timestamp
+	 *
+	 * @param int $timestamp
+	 */
+	public function clearOlderThan(int $timestamp): void {
+		$qb = $this->db->getQueryBuilder();
+		$qb->delete($this->tableName)
+			->where($qb->expr()->lte('clear_at', $qb->createNamedParameter($timestamp, IQueryBuilder::PARAM_INT)));
+
+		$qb->execute();
+	}
 }

apps/user_status/tests/Unit/BackgroundJob/ClearOldStatusesBackgroundJobTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020, Georg Ehrke
+ *
+ * @author Georg Ehrke <[email protected]>
+ *
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCA\UserStatus\Tests\BackgroundJob;
+
+use OCA\UserStatus\BackgroundJob\ClearOldStatusesBackgroundJob;
+use OCA\UserStatus\Db\UserStatusMapper;
+use OCP\AppFramework\Utility\ITimeFactory;
+use Test\TestCase;
+
+class ClearOldStatusesBackgroundJobTest extends TestCase {
+
+	/** @var ITimeFactory|\PHPUnit\Framework\MockObject\MockObject */
+	private $time;
+
+	/** @var UserStatusMapper|\PHPUnit\Framework\MockObject\MockObject */
+	private $mapper;
+
+	/** @var ClearOldStatusesBackgroundJob */
+	private $job;
+
+	protected function setUp(): void {
+		parent::setUp();
+
+		$this->time = $this->createMock(ITimeFactory::class);
+		$this->mapper = $this->createMock(UserStatusMapper::class);
+
+		$this->job = new ClearOldStatusesBackgroundJob($this->time, $this->mapper);
+	}
+
+	public function testRun() {
+		$this->mapper->expects($this->once())
+			->method('clearOlderThan')
+			->with(1337);
+
+		$this->time->method('getTime')
+			->willReturn(1337);
+
+		self::invokePrivate($this->job, 'run', [[]]);
+	}
+}

apps/user_status/tests/Unit/Db/UserStatusMapperTest.php

@@ -113,6 +113,17 @@ public function testUserIdUnique(): void {
 		$this->mapper->insert($userStatus2);
 	}
 
+	public function testClearOlderThan(): void {
+		$this->insertSampleStatuses();
+
+		$this->mapper->clearOlderThan(55000);
+
+		$allStatuses = $this->mapper->findAll();
+		$this->assertCount(2, $allStatuses);
+		$this->assertEquals('admin', $allStatuses[0]->getUserId());
+		$this->assertEquals('user2', $allStatuses[1]->getUserId());
+	}
+
 	private function insertSampleStatuses(): void {
 		$userStatus1 = new UserStatus();
 		$userStatus1->setUserId('admin');