feat: Limit trash expire job to 30 minutes

And pick up where it left off, leveraging getSeenUsers.

Signed-off-by: Louis Chemineau <louis@chmn.me>

[skip ci]

Author: artonge

apps/files_trashbin/lib/BackgroundJob/ExpireTrash.php

@@ -31,36 +31,24 @@
 use OCA\Files_Trashbin\Trashbin;
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\TimedJob;
-use OCP\IConfig;
-use OCP\IUser;
+use OCP\IAppConfig;
 use OCP\IUserManager;
 
 class ExpireTrash extends TimedJob {
-	private IConfig $config;
-	private Expiration $expiration;
-	private IUserManager $userManager;
 
 	public function __construct(
-		IConfig $config,
-		IUserManager $userManager,
-		Expiration $expiration,
+		private IAppConfig $appConfig,
+		private IUserManager $userManager,
+		private Expiration $expiration,
 		ITimeFactory $time
 	) {
 		parent::__construct($time);
 		// Run once per 30 minutes
 		$this->setInterval(60 * 30);
-
-		$this->config = $config;
-		$this->userManager = $userManager;
-		$this->expiration = $expiration;
 	}
 
-	/**
-	 * @param $argument
-	 * @throws \Exception
-	 */
 	protected function run($argument) {
-		$backgroundJob = $this->config->getAppValue('files_trashbin', 'background_job_expire_trash', 'yes');
+		$backgroundJob = $this->appConfig->getValueString('files_trashbin', 'background_job_expire_trash', 'yes');
 		if ($backgroundJob === 'no') {
 			return;
 		}
@@ -70,15 +58,28 @@ protected function run($argument) {
 			return;
 		}
 
-		$this->userManager->callForSeenUsers(function (IUser $user) {
+		$stopTime = time() + 60 * 30; // Stops after 30 minutes.
+		$offset = $this->appConfig->getValueInt('files_trashbin', 'background_job_expire_trash_offset', 0);
+		$users = $this->userManager->getSeenUsers($offset);
+
+		foreach ($users as $user) {
 			$uid = $user->getUID();
 			if (!$this->setupFS($uid)) {
-				return;
+				continue;
 			}
 			$dirContent = Helper::getTrashFiles('/', $uid, 'mtime');
 			Trashbin::deleteExpiredFiles($dirContent, $uid);
-		});
 
+			$offset++;
+
+			if ($stopTime < time()) {
+				$this->appConfig->setValueInt('files_trashbin', 'background_job_expire_trash_offset', $offset);
+				\OC_Util::tearDownFS();
+				return;
+			}
+		}
+
+		$this->appConfig->setValueInt('files_trashbin', 'background_job_expire_trash_offset', 0);
 		\OC_Util::tearDownFS();
 	}
 

apps/files_trashbin/tests/BackgroundJob/ExpireTrashTest.php

@@ -29,31 +29,31 @@
 use OCA\Files_Trashbin\Expiration;
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\IJobList;
-use OCP\IConfig;
+use OCP\IAppConfig;
 use OCP\IUserManager;
 use PHPUnit\Framework\MockObject\MockObject;
 use Test\TestCase;
 
 class ExpireTrashTest extends TestCase {
-	/** @var IConfig|MockObject */
-	private $config;
+	/** @var IAppConfig&MockObject */
+	private $appConfig;
 
-	/** @var IUserManager|MockObject */
+	/** @var IUserManager&MockObject */
 	private $userManager;
 
-	/** @var Expiration|MockObject */
+	/** @var Expiration&MockObject */
 	private $expiration;
 
-	/** @var IJobList|MockObject */
+	/** @var IJobList&MockObject */
 	private $jobList;
 
-	/** @var ITimeFactory|MockObject */
+	/** @var ITimeFactory&MockObject */
 	private $time;
 
 	protected function setUp(): void {
 		parent::setUp();
 
-		$this->config = $this->createMock(IConfig::class);
+		$this->appConfig = $this->createMock(IAppConfig::class);
 		$this->userManager = $this->createMock(IUserManager::class);
 		$this->expiration = $this->createMock(Expiration::class);
 		$this->jobList = $this->createMock(IJobList::class);
@@ -69,22 +69,25 @@ protected function setUp(): void {
 	}
 
 	public function testConstructAndRun(): void {
-		$this->config->method('getAppValue')
+		$this->appConfig->method('getValueString')
 			->with('files_trashbin', 'background_job_expire_trash', 'yes')
 			->willReturn('yes');
+		$this->appConfig->method('getValueInt')
+			->with('files_trashbin', 'background_job_expire_trash_offset', 0)
+			->willReturn(0);
 
-		$job = new ExpireTrash($this->config, $this->userManager, $this->expiration, $this->time);
+		$job = new ExpireTrash($this->appConfig, $this->userManager, $this->expiration, $this->time);
 		$job->start($this->jobList);
 	}
 
 	public function testBackgroundJobDeactivated(): void {
-		$this->config->method('getAppValue')
+		$this->appConfig->method('getValueString')
 			->with('files_trashbin', 'background_job_expire_trash', 'yes')
 			->willReturn('no');
 		$this->expiration->expects($this->never())
 			->method('getMaxAgeAsTimestamp');
 
-		$job = new ExpireTrash($this->config, $this->userManager, $this->expiration, $this->time);
+		$job = new ExpireTrash($this->appConfig, $this->userManager, $this->expiration, $this->time);
 		$job->start($this->jobList);
 	}
 }