upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-04-20 22:00:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 15

feat(backgroundjob): Schedule job after <timestamp>

Browse source 
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
This commit is contained in:
Christoph Wurst 2023-09-27 14:53:04 +02:00
parent f8f437072a
commit 04ecc2a6a9
No known key found for this signature in database
GPG key ID: CC42AC2A7F0E56D8
3 changed files with 32 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
lib/private/BackgroundJob/JobList.php
View file

@ -41,6 +41,10 @@ use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\IConfig;
use OCP\IDBConnection;
use Psr\Log\LoggerInterface;
use function get_class;
use function json_encode;
use function md5;
use function strlen;
class JobList implements IJobList {
protected IDBConnection $connection;
@ -55,11 +59,10 @@ class JobList implements IJobList {
$this->logger = $logger;
}
/**
* @param IJob|class-string<IJob> $job
* @param mixed $argument
*/
public function add($job, $argument = null): void {
public function add($job, $argument = null, int $firstCheck = null): void {
if ($firstCheck === null) {
$firstCheck = $this->timeFactory->getTime();
}
if ($job instanceof IJob) {
$class = get_class($job);
} else {
@ -79,18 +82,22 @@ class JobList implements IJobList {
'argument' => $query->createNamedParameter($argumentJson),
'argument_hash' => $query->createNamedParameter(md5($argumentJson)),
'last_run' => $query->createNamedParameter(0, IQueryBuilder::PARAM_INT),
'last_checked' => $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT),
'last_checked' => $query->createNamedParameter($firstCheck, IQueryBuilder::PARAM_INT),
]);
} else {
$query->update('jobs')
->set('reserved_at', $query->expr()->literal(0, IQueryBuilder::PARAM_INT))
->set('last_checked', $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT))
->set('last_checked', $query->createNamedParameter($firstCheck, IQueryBuilder::PARAM_INT))
->where($query->expr()->eq('class', $query->createNamedParameter($class)))
->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(md5($argumentJson))));
}
$query->executeStatement();
}
public function scheduleAfter(string $job, int $runAfter, $argument = null): void {
$this->add($job, $argument, $runAfter);
}
/**
* @param IJob|string $job
* @param mixed $argument

13
lib/public/BackgroundJob/IJobList.php
View file

@ -57,6 +57,19 @@ interface IJobList {
*/
public function add($job, $argument = null): void;
/**
* Add a job to the list but only run it after the given timestamp
*
* For cron background jobs this means the job will likely run shortly after the timestamp
* has been reached. For ajax background jobs the job might only run when users are active
* on the instance again.
*
* @param class-string<IJob> $job
* @param mixed $argument The serializable argument to be passed to $job->run() when the job is executed
* @since 28.0.0
*/
public function scheduleAfter(string $job, int $runAfter, $argument = null): void;
/**
* Remove a job from the list
*

6
tests/lib/BackgroundJob/DummyJobList.php
View file

@ -35,7 +35,7 @@ class DummyJobList extends \OC\BackgroundJob\JobList {
* @param IJob|class-string<IJob> $job
* @param mixed $argument
*/
public function add($job, $argument = null): void {
public function add($job, $argument = null, int $firstCheck = null): void {
if (is_string($job)) {
/** @var IJob $job */
$job = \OCP\Server::get($job);
@ -46,6 +46,10 @@ class DummyJobList extends \OC\BackgroundJob\JobList {
}
}
public function scheduleAfter(string $job, int $runAfter, $argument = null): void {
$this->add($job, $argument, $runAfter);
}
/**
* @param IJob|string $job
* @param mixed $argument