From 27ee8a76322f3b1ddae331eb96775b1faa7298c0 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Mon, 31 May 2021 17:15:26 +0200 Subject: [PATCH] Move queries to the joblist Signed-off-by: Joas Schilling --- core/Command/Background/Job.php | 25 ++---------------- lib/private/BackgroundJob/JobList.php | 33 +++++++++++++++++++++--- lib/public/BackgroundJob/IJobList.php | 15 +++++++++++ tests/lib/BackgroundJob/DummyJobList.php | 7 +++++ 4 files changed, 53 insertions(+), 27 deletions(-) diff --git a/core/Command/Background/Job.php b/core/Command/Background/Job.php index 2a96744310..62f2ea823d 100644 --- a/core/Command/Background/Job.php +++ b/core/Command/Background/Job.php @@ -27,8 +27,6 @@ namespace OC\Core\Command\Background; use OCP\BackgroundJob\IJob; use OCP\BackgroundJob\IJobList; -use OCP\DB\QueryBuilder\IQueryBuilder; -use OCP\IDBConnection; use OCP\ILogger; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputArgument; @@ -39,17 +37,13 @@ use Symfony\Component\Console\Output\OutputInterface; class Job extends Command { /** @var IJobList */ protected $jobList; - /** @var IDBConnection */ - protected $connection; /** @var ILogger */ protected $logger; public function __construct(IJobList $jobList, - IDBConnection $connection, ILogger $logger) { parent::__construct(); $this->jobList = $jobList; - $this->connection = $connection; $this->logger = $logger; } @@ -86,14 +80,7 @@ class Job extends Command { $output->writeln(''); $output->writeln('Forcing execution of the job'); - $query = $this->connection->getQueryBuilder(); - $query->update('jobs') - ->set('last_run', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT)) - ->set('reserved_at', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT)) - ->where($query->expr()->eq('id', $query->createNamedParameter($jobId), IQueryBuilder::PARAM_INT)); - - $query->executeUpdate(); - + $this->jobList->resetBackgroundJob($job); $job = $this->jobList->getById($jobId); $job->execute($this->jobList, $this->logger); $this->jobList->setLastJob($job); @@ -110,15 +97,7 @@ class Job extends Command { } protected function printJobInfo(int $jobId, IJob $job, OutputInterface$output): void { - - $query = $this->connection->getQueryBuilder(); - $query->select('*') - ->from('jobs') - ->where($query->expr()->eq('id', $query->createNamedParameter($jobId), IQueryBuilder::PARAM_INT)); - - $result = $query->executeQuery(); - $row = $result->fetch(); - $result->closeCursor(); + $row = $this->jobList->getDetailsById($jobId); $lastRun = new \DateTime(); $lastRun->setTimestamp((int) $row['last_run']); diff --git a/lib/private/BackgroundJob/JobList.php b/lib/private/BackgroundJob/JobList.php index 5a89dcdeba..101bfa1d9b 100644 --- a/lib/private/BackgroundJob/JobList.php +++ b/lib/private/BackgroundJob/JobList.php @@ -237,19 +237,29 @@ class JobList implements IJobList { * @return IJob|null */ public function getById($id) { + $row = $this->getDetailsById($id); + + if ($row) { + return $this->buildJob($row); + } + + return null; + } + + public function getDetailsById(int $id): ?array { $query = $this->connection->getQueryBuilder(); $query->select('*') ->from('jobs') ->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT))); - $result = $query->execute(); + $result = $query->executeQuery(); $row = $result->fetch(); $result->closeCursor(); if ($row) { - return $this->buildJob($row); - } else { - return null; + return $row; } + + return null; } /** @@ -331,4 +341,19 @@ class JobList implements IJobList { ->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT))); $query->execute(); } + + /** + * Reset the $job so it executes on the next trigger + * + * @param IJob $job + * @since 22.0.0 + */ + public function resetBackgroundJob(IJob $job): void { + $query = $this->connection->getQueryBuilder(); + $query->update('jobs') + ->set('last_run', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT)) + ->set('reserved_at', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT)) + ->where($query->expr()->eq('id', $query->createNamedParameter($job->getId()), IQueryBuilder::PARAM_INT)); + $query->executeStatement(); + } } diff --git a/lib/public/BackgroundJob/IJobList.php b/lib/public/BackgroundJob/IJobList.php index 36f8cd68fe..0ff8eaea1b 100644 --- a/lib/public/BackgroundJob/IJobList.php +++ b/lib/public/BackgroundJob/IJobList.php @@ -98,6 +98,13 @@ interface IJobList { */ public function getById($id); + /** + * @param int $id + * @return array|null + * @since 22.0.0 + */ + public function getDetailsById(int $id): ?array; + /** * set the job that was last ran to the current time * @@ -130,4 +137,12 @@ interface IJobList { * @since 12.0.0 */ public function setExecutionTime(IJob $job, $timeTaken); + + /** + * Reset the $job so it executes on the next trigger + * + * @param IJob $job + * @since 22.0.0 + */ + public function resetBackgroundJob(IJob $job): void; } diff --git a/tests/lib/BackgroundJob/DummyJobList.php b/tests/lib/BackgroundJob/DummyJobList.php index 452b9bb98e..97fc551d8f 100644 --- a/tests/lib/BackgroundJob/DummyJobList.php +++ b/tests/lib/BackgroundJob/DummyJobList.php @@ -117,6 +117,10 @@ class DummyJobList extends \OC\BackgroundJob\JobList { return null; } + public function getDetailsById(int $id): ?array { + return null; + } + /** * set the lastRun of $job to now * @@ -128,4 +132,7 @@ class DummyJobList extends \OC\BackgroundJob\JobList { public function setExecutionTime(IJob $job, $timeTaken) { } + + public function resetBackgroundJob(IJob $job): void { + } }