Merge pull request #29090 from nextcloud/bug/noid/disable-versions-expire-background-job

Add configuration flag to disable the background job for files_versions

apps/files_versions/lib/BackgroundJob/ExpireVersions.php

@@ -27,31 +27,41 @@ namespace OCA\Files_Versions\BackgroundJob;
 
 use OCA\Files_Versions\Expiration;
 use OCA\Files_Versions\Storage;
+use OCP\IConfig;
 use OCP\IUser;
 use OCP\IUserManager;
 
 class ExpireVersions extends \OC\BackgroundJob\TimedJob {
 	public const ITEMS_PER_SESSION = 1000;
 
+	/** @var IConfig */
+	private $config;
+
 	/**
 	 * @var Expiration
 	 */
 	private $expiration;
-	
+
 	/**
 	 * @var IUserManager
 	 */
 	private $userManager;
 
-	public function __construct(IUserManager $userManager, Expiration $expiration) {
+	public function __construct(IConfig $config, IUserManager $userManager, Expiration $expiration) {
 		// Run once per 30 minutes
 		$this->setInterval(60 * 30);
 
+		$this->config = $config;
 		$this->expiration = $expiration;
 		$this->userManager = $userManager;
 	}
 
-	protected function run($argument) {
+	public function run($argument) {
+		$backgroundJob = $this->config->getAppValue('files_versions', 'background_job_expire_versions', 'yes');
+		if ($backgroundJob === 'no') {
+			return;
+		}
+
 		$maxAge = $this->expiration->getMaxAgeAsTimestamp();
 		if (!$maxAge) {
 			return;

apps/files_versions/tests/BackgroundJob/ExpireVersionsTest.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * @copyright 2021 Daniel Kesselberg <mail@danielkesselberg.de>
+ *
+ * @author Daniel Kesselberg <mail@danielkesselberg.de>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Files_Versions\Tests\BackgroundJob;
+
+use OCA\Files_Versions\BackgroundJob\ExpireVersions;
+use OCA\Files_Versions\Expiration;
+use OCP\BackgroundJob\IJobList;
+use OCP\IConfig;
+use OCP\ILogger;
+use OCP\IUserManager;
+use PHPUnit\Framework\MockObject\MockObject;
+use Test\TestCase;
+
+class ExpireVersionsTest extends TestCase {
+
+	/** @var IConfig|MockObject */
+	private $config;
+
+	/** @var IUserManager|MockObject */
+	private $userManager;
+
+	/** @var Expiration|MockObject */
+	private $expiration;
+
+	/** @var IJobList|MockObject */
+	private $jobList;
+
+	/** @var ILogger|MockObject */
+	private $logger;
+
+	protected function setUp(): void {
+		parent::setUp();
+
+		$this->config = $this->createMock(IConfig::class);
+		$this->userManager = $this->createMock(IUserManager::class);
+		$this->expiration = $this->createMock(Expiration::class);
+		$this->jobList = $this->createMock(IJobList::class);
+		$this->logger = $this->createMock(ILogger::class);
+
+		$this->jobList->expects($this->once())
+			->method('setLastRun');
+		$this->jobList->expects($this->once())
+			->method('setExecutionTime');
+	}
+
+	public function testBackgroundJobDeactivated(): void {
+		$this->config->method('getAppValue')
+			->with('files_versions', 'background_job_expire_versions', 'yes')
+			->willReturn('no');
+		$this->expiration->expects($this->never())
+			->method('getMaxAgeAsTimestamp');
+
+		$job = new ExpireVersions($this->config, $this->userManager, $this->expiration);
+		$job->execute($this->jobList, $this->logger);
+	}
+}