Merge pull request #49463 from nextcloud/backport/48600/stable28

sorbaugh · web-flow · commit 4260dd1517a2 · 2024-11-25T09:48:57.000+01:00
[stable28] fix(BackgroundJobs): Adjust intervals and time sensitivities
diff --git a/apps/contactsinteraction/lib/BackgroundJob/CleanupJob.php b/apps/contactsinteraction/lib/BackgroundJob/CleanupJob.php
@@ -27,7 +27,6 @@
 
 use OCA\ContactsInteraction\Db\RecentContactMapper;
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\BackgroundJob\IJob;
 use OCP\BackgroundJob\TimedJob;
 
 class CleanupJob extends TimedJob {
@@ -39,7 +38,7 @@ public function __construct(
 		parent::__construct($time);
 
 		$this->setInterval(24 * 60 * 60);
-		$this->setTimeSensitivity(IJob::TIME_INSENSITIVE);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 
 	}
 
diff --git a/apps/dav/lib/BackgroundJob/UploadCleanup.php b/apps/dav/lib/BackgroundJob/UploadCleanup.php
@@ -29,7 +29,6 @@
 
 use OC\User\NoUserException;
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\BackgroundJob\IJob;
 use OCP\BackgroundJob\IJobList;
 use OCP\BackgroundJob\TimedJob;
 use OCP\Files\File;
@@ -51,7 +50,7 @@ public function __construct(ITimeFactory $time, IRootFolder $rootFolder, IJobLis
 
 		// Run once a day
 		$this->setInterval(60 * 60 * 24);
-		$this->setTimeSensitivity(IJob::TIME_INSENSITIVE);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 	protected function run($argument) {
diff --git a/apps/federation/lib/SyncJob.php b/apps/federation/lib/SyncJob.php
@@ -37,6 +37,7 @@ public function __construct(SyncFederationAddressBooks $syncService, LoggerInter
 		parent::__construct($timeFactory);
 		// Run once a day
 		$this->setInterval(24 * 60 * 60);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 		$this->syncService = $syncService;
 		$this->logger = $logger;
 	}
diff --git a/apps/files/lib/BackgroundJob/CleanupDirectEditingTokens.php b/apps/files/lib/BackgroundJob/CleanupDirectEditingTokens.php
@@ -31,14 +31,12 @@
 use OCP\DirectEditing\IManager;
 
 class CleanupDirectEditingTokens extends TimedJob {
-	private const INTERVAL_MINUTES = 15 * 60;
-
 	private IManager $manager;
 
 	public function __construct(ITimeFactory $time,
 		IManager $manager) {
 		parent::__construct($time);
-		$this->interval = self::INTERVAL_MINUTES;
+		$this->setInterval(15 * 60);
 		$this->manager = $manager;
 	}
 
diff --git a/apps/files/lib/BackgroundJob/CleanupFileLocks.php b/apps/files/lib/BackgroundJob/CleanupFileLocks.php
@@ -31,20 +31,12 @@
  * Clean up all file locks that are expired for the DB file locking provider
  */
 class CleanupFileLocks extends TimedJob {
-	/**
-	 * Default interval in minutes
-	 *
-	 * @var int $defaultIntervalMin
-	 **/
-	protected $defaultIntervalMin = 5;
-
 	/**
 	 * sets the correct interval for this timed job
 	 */
 	public function __construct(ITimeFactory $time) {
 		parent::__construct($time);
-
-		$this->interval = $this->defaultIntervalMin * 60;
+		$this->setInterval(5 * 60);
 	}
 
 	/**
diff --git a/apps/files/lib/BackgroundJob/DeleteExpiredOpenLocalEditor.php b/apps/files/lib/BackgroundJob/DeleteExpiredOpenLocalEditor.php
@@ -28,7 +28,6 @@
 
 use OCA\Files\Db\OpenLocalEditorMapper;
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\BackgroundJob\IJob;
 use OCP\BackgroundJob\TimedJob;
 
 /**
@@ -46,7 +45,7 @@ public function __construct(
 
 		// Run every 12h
 		$this->interval = 12 * 3600;
-		$this->setTimeSensitivity(IJob::TIME_INSENSITIVE);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 	/**
diff --git a/apps/files/lib/BackgroundJob/DeleteOrphanedItems.php b/apps/files/lib/BackgroundJob/DeleteOrphanedItems.php
@@ -35,7 +35,6 @@
  */
 class DeleteOrphanedItems extends TimedJob {
 	public const CHUNK_SIZE = 200;
-	protected $defaultIntervalMin = 60;
 
 	/**
 	 * sets the correct interval for this timed job
@@ -46,7 +45,7 @@ public function __construct(
 		protected LoggerInterface $logger,
 	) {
 		parent::__construct($time);
-		$this->interval = $this->defaultIntervalMin * 60;
+		$this->setInterval(60 * 60);
 	}
 
 	/**
diff --git a/apps/files_external/lib/BackgroundJob/CredentialsCleanup.php b/apps/files_external/lib/BackgroundJob/CredentialsCleanup.php
@@ -29,7 +29,6 @@
 use OCA\Files_External\Lib\StorageConfig;
 use OCA\Files_External\Service\UserGlobalStoragesService;
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\BackgroundJob\IJob;
 use OCP\BackgroundJob\TimedJob;
 use OCP\IUser;
 use OCP\IUserManager;
@@ -54,7 +53,7 @@ public function __construct(
 
 		// run every day
 		$this->setInterval(24 * 60 * 60);
-		$this->setTimeSensitivity(IJob::TIME_INSENSITIVE);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 	protected function run($argument) {
diff --git a/apps/files_reminders/lib/BackgroundJob/CleanUpReminders.php b/apps/files_reminders/lib/BackgroundJob/CleanUpReminders.php
@@ -28,7 +28,6 @@
 
 use OCA\FilesReminders\Service\ReminderService;
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\BackgroundJob\IJob;
 use OCP\BackgroundJob\TimedJob;
 
 class CleanUpReminders extends TimedJob {
@@ -39,7 +38,7 @@ public function __construct(
 		parent::__construct($time);
 
 		$this->setInterval(24 * 60 * 60); // 1 day
-		$this->setTimeSensitivity(IJob::TIME_INSENSITIVE);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 	/**
diff --git a/apps/files_sharing/lib/BackgroundJob/FederatedSharesDiscoverJob.php b/apps/files_sharing/lib/BackgroundJob/FederatedSharesDiscoverJob.php
@@ -45,7 +45,8 @@ public function __construct(
 		private LoggerInterface $logger,
 	) {
 		parent::__construct($time);
-		$this->setInterval(86400);
+		$this->setInterval(24 * 60 * 60);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 	public function run($argument) {
diff --git a/apps/files_sharing/lib/ExpireSharesJob.php b/apps/files_sharing/lib/ExpireSharesJob.php
@@ -25,7 +25,6 @@
 namespace OCA\Files_Sharing;
 
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\BackgroundJob\IJob;
 use OCP\BackgroundJob\TimedJob;
 use OCP\IDBConnection;
 use OCP\Share\Exceptions\ShareNotFound;
@@ -51,7 +50,7 @@ public function __construct(ITimeFactory $time, IManager $shareManager, IDBConne
 
 		// Run once a day
 		$this->setInterval(24 * 60 * 60);
-		$this->setTimeSensitivity(IJob::TIME_INSENSITIVE);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 
diff --git a/apps/oauth2/lib/BackgroundJob/CleanupExpiredAuthorizationCode.php b/apps/oauth2/lib/BackgroundJob/CleanupExpiredAuthorizationCode.php
@@ -28,7 +28,6 @@
 
 use OCA\OAuth2\Db\AccessTokenMapper;
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\BackgroundJob\IJob;
 use OCP\BackgroundJob\TimedJob;
 use OCP\DB\Exception;
 use Psr\Log\LoggerInterface;
@@ -44,7 +43,7 @@ public function __construct(
 		parent::__construct($timeFactory);
 		// 30 days
 		$this->setInterval(60 * 60 * 24 * 30);
-		$this->setTimeSensitivity(IJob::TIME_INSENSITIVE);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 	/**
diff --git a/apps/twofactor_backupcodes/lib/BackgroundJob/RememberBackupCodesJob.php b/apps/twofactor_backupcodes/lib/BackgroundJob/RememberBackupCodesJob.php
@@ -28,7 +28,6 @@
 
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\Authentication\TwoFactorAuth\IRegistry;
-use OCP\BackgroundJob\IJob;
 use OCP\BackgroundJob\IJobList;
 use OCP\BackgroundJob\TimedJob;
 use OCP\IUserManager;
@@ -61,7 +60,7 @@ public function __construct(IRegistry $registry,
 		$this->jobList = $jobList;
 
 		$this->setInterval(60 * 60 * 24 * 14);
-		$this->setTimeSensitivity(IJob::TIME_INSENSITIVE);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 	protected function run($argument) {
diff --git a/apps/updatenotification/lib/Notification/BackgroundJob.php b/apps/updatenotification/lib/Notification/BackgroundJob.php
@@ -54,6 +54,7 @@ public function __construct(
 		parent::__construct($timeFactory);
 		// Run once a day
 		$this->setInterval(60 * 60 * 24);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 	protected function run($argument) {
diff --git a/apps/user_ldap/lib/Jobs/CleanUp.php b/apps/user_ldap/lib/Jobs/CleanUp.php
@@ -45,7 +45,7 @@ class CleanUp extends TimedJob {
 	protected $limit;
 
 	/** @var int $defaultIntervalMin default interval in minutes */
-	protected $defaultIntervalMin = 51;
+	protected $defaultIntervalMin = 60;
 
 	/** @var User_LDAP|User_Proxy $userBackend */
 	protected $userBackend;
diff --git a/apps/user_status/lib/BackgroundJob/ClearOldStatusesBackgroundJob.php b/apps/user_status/lib/BackgroundJob/ClearOldStatusesBackgroundJob.php
@@ -52,7 +52,7 @@ public function __construct(ITimeFactory $time,
 		$this->mapper = $mapper;
 
 		// Run every time the cron is run
-		$this->setInterval(60);
+		$this->setInterval(0);
 	}
 
 	/**
diff --git a/core/BackgroundJobs/CleanupLoginFlowV2.php b/core/BackgroundJobs/CleanupLoginFlowV2.php
@@ -37,7 +37,7 @@ public function __construct(
 	) {
 		parent::__construct($time);
 
-		$this->setInterval(3600);
+		$this->setInterval(60 * 60);
 	}
 
 	protected function run($argument): void {
diff --git a/core/BackgroundJobs/GenerateMetadataJob.php b/core/BackgroundJobs/GenerateMetadataJob.php
@@ -48,8 +48,8 @@ public function __construct(
 	) {
 		parent::__construct($time);
 
-		$this->setTimeSensitivity(\OCP\BackgroundJob\IJob::TIME_INSENSITIVE);
-		$this->setInterval(24 * 3600);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
+		$this->setInterval(24 * 60 * 60);
 	}
 
 	protected function run(mixed $argument): void {
diff --git a/lib/private/Preview/BackgroundCleanupJob.php b/lib/private/Preview/BackgroundCleanupJob.php
@@ -54,7 +54,8 @@ public function __construct(ITimeFactory $timeFactory,
 		bool $isCLI) {
 		parent::__construct($timeFactory);
 		// Run at most once an hour
-		$this->setInterval(3600);
+		$this->setInterval(60 * 60);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 
 		$this->connection = $connection;
 		$this->previewFolder = $previewFolder;
diff --git a/lib/private/Security/Bruteforce/CleanupJob.php b/lib/private/Security/Bruteforce/CleanupJob.php
@@ -26,7 +26,6 @@
 namespace OC\Security\Bruteforce;
 
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\BackgroundJob\IJob;
 use OCP\BackgroundJob\TimedJob;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IDBConnection;
@@ -39,8 +38,8 @@ public function __construct(
 		parent::__construct($time);
 
 		// Run once a day
-		$this->setInterval(3600 * 24);
-		$this->setTimeSensitivity(IJob::TIME_INSENSITIVE);
+		$this->setInterval(60 * 60 * 24);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 	protected function run($argument): void {
diff --git a/lib/private/TextProcessing/RemoveOldTasksBackgroundJob.php b/lib/private/TextProcessing/RemoveOldTasksBackgroundJob.php
@@ -33,7 +33,7 @@
 use Psr\Log\LoggerInterface;
 
 class RemoveOldTasksBackgroundJob extends TimedJob {
-	public const MAX_TASK_AGE_SECONDS = 60 * 50 * 24 * 7; // 1 week
+	public const MAX_TASK_AGE_SECONDS = 60 * 60 * 24 * 7; // 1 week
 
 	public function __construct(
 		ITimeFactory $timeFactory,
@@ -43,6 +43,7 @@ public function __construct(
 	) {
 		parent::__construct($timeFactory);
 		$this->setInterval(60 * 60 * 24);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 	/**
diff --git a/lib/private/TextToImage/RemoveOldTasksBackgroundJob.php b/lib/private/TextToImage/RemoveOldTasksBackgroundJob.php
@@ -37,7 +37,7 @@
 use Psr\Log\LoggerInterface;
 
 class RemoveOldTasksBackgroundJob extends TimedJob {
-	public const MAX_TASK_AGE_SECONDS = 60 * 50 * 24 * 7; // 1 week
+	public const MAX_TASK_AGE_SECONDS = 60 * 60 * 24 * 7; // 1 week
 
 	private IAppData $appData;
 
@@ -50,6 +50,7 @@ public function __construct(
 		parent::__construct($timeFactory);
 		$this->appData = $appDataFactory->get('core');
 		$this->setInterval(60 * 60 * 24);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
 	}
 
 	/**
diff --git a/lib/private/User/BackgroundJobs/CleanupDeletedUsers.php b/lib/private/User/BackgroundJobs/CleanupDeletedUsers.php
@@ -12,7 +12,6 @@
 use OC\User\PartiallyDeletedUsersBackend;
 use OC\User\User;
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\BackgroundJob\IJob;
 use OCP\BackgroundJob\TimedJob;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\IConfig;
@@ -26,8 +25,8 @@ public function __construct(
 		private LoggerInterface $logger,
 	) {
 		parent::__construct($time);
-		$this->setTimeSensitivity(IJob::TIME_INSENSITIVE);
-		$this->setInterval(24 * 3600);
+		$this->setTimeSensitivity(self::TIME_INSENSITIVE);
+		$this->setInterval(24 * 60 * 60);
 	}
 
 	protected function run($argument): void {
diff --git a/lib/public/BackgroundJob/TimedJob.php b/lib/public/BackgroundJob/TimedJob.php
@@ -27,6 +27,8 @@
 namespace OCP\BackgroundJob;
 
 use OCP\ILogger;
+use OCP\Server;
+use Psr\Log\LoggerInterface;
 
 /**
  * Simple base class to extend to run periodic background jobs.
@@ -71,8 +73,8 @@ public function isTimeSensitive(): bool {
 	 * @since 24.0.0
 	 */
 	public function setTimeSensitivity(int $sensitivity): void {
-		if ($sensitivity !== IJob::TIME_SENSITIVE &&
-			$sensitivity !== IJob::TIME_INSENSITIVE) {
+		if ($sensitivity !== self::TIME_SENSITIVE &&
+			$sensitivity !== self::TIME_INSENSITIVE) {
 			throw new \InvalidArgumentException('Invalid sensitivity');
 		}
 
@@ -99,6 +101,9 @@ final public function execute(IJobList $jobList, ILogger $logger = null) {
 	 */
 	final public function start(IJobList $jobList): void {
 		if (($this->time->getTime() - $this->lastRun) > $this->interval) {
+			if ($this->interval >= 12 * 60 * 60 && $this->isTimeSensitive()) {
+				Server::get(LoggerInterface::class)->debug('TimedJob ' . get_class($this) . ' has a configured interval of ' . $this->interval . ' seconds, but is also marked as time sensitive. Please consider marking it as time insensitive to allow more sensitive jobs to run when needed.');
+			}
 			parent::start($jobList);
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ public function __construct(SyncFederationAddressBooks $syncService, LoggerInter`
`37`	`37`	`parent::__construct($timeFactory);`
`38`	`38`	`// Run once a day`
`39`	`39`	`$this->setInterval(24 * 60 * 60);`
	`40`	`+ $this->setTimeSensitivity(self::TIME_INSENSITIVE);`
`40`	`41`	`$this->syncService = $syncService;`
`41`	`42`	`$this->logger = $logger;`
`42`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,8 @@ public function __construct(`
`45`	`45`	`private LoggerInterface $logger,`
`46`	`46`	`) {`
`47`	`47`	`parent::__construct($time);`
`48`		`- $this->setInterval(86400);`
	`48`	`+ $this->setInterval(24 * 60 * 60);`
	`49`	`+ $this->setTimeSensitivity(self::TIME_INSENSITIVE);`
`49`	`50`	`}`
`50`	`51`
`51`	`52`	`public function run($argument) {`