forked from nextcloud/server
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge #245 Multiple cron background jobs based on class
- Loading branch information
Showing
7 changed files
with
317 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2022 Julius Härtl <jus@bitgrid.net> | ||
| * | ||
| * @author Julius Härtl <jus@bitgrid.net> | ||
| * | ||
| * @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 OC\Core\Command\Background; | ||
|
|
||
| use OCP\BackgroundJob\IJob; | ||
| use OCP\BackgroundJob\IJobList; | ||
| use Psr\Log\LoggerInterface; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
|
|
||
| abstract class JobBase extends \OC\Core\Command\Base { | ||
| protected IJobList $jobList; | ||
| protected LoggerInterface $logger; | ||
|
|
||
| public function __construct(IJobList $jobList, | ||
| LoggerInterface $logger) { | ||
| parent::__construct(); | ||
| $this->jobList = $jobList; | ||
| $this->logger = $logger; | ||
| } | ||
|
|
||
| protected function printJobInfo(int $jobId, IJob $job, OutputInterface $output): void { | ||
| $row = $this->jobList->getDetailsById($jobId); | ||
|
|
||
| $lastRun = new \DateTime(); | ||
| $lastRun->setTimestamp((int) $row['last_run']); | ||
| $lastChecked = new \DateTime(); | ||
| $lastChecked->setTimestamp((int) $row['last_checked']); | ||
| $reservedAt = new \DateTime(); | ||
| $reservedAt->setTimestamp((int) $row['reserved_at']); | ||
|
|
||
| $output->writeln('Job class: ' . get_class($job)); | ||
| $output->writeln('Arguments: ' . json_encode($job->getArgument())); | ||
|
|
||
| $isTimedJob = $job instanceof \OC\BackgroundJob\TimedJob || $job instanceof \OCP\BackgroundJob\TimedJob; | ||
| if ($isTimedJob) { | ||
| $output->writeln('Type: timed'); | ||
| } elseif ($job instanceof \OC\BackgroundJob\QueuedJob || $job instanceof \OCP\BackgroundJob\QueuedJob) { | ||
| $output->writeln('Type: queued'); | ||
| } else { | ||
| $output->writeln('Type: job'); | ||
| } | ||
|
|
||
| $output->writeln(''); | ||
| $output->writeln('Last checked: ' . $lastChecked->format(\DateTimeInterface::ATOM)); | ||
| if ((int) $row['reserved_at'] === 0) { | ||
| $output->writeln('Reserved at: -'); | ||
| } else { | ||
| $output->writeln('Reserved at: <comment>' . $reservedAt->format(\DateTimeInterface::ATOM) . '</comment>'); | ||
| } | ||
| $output->writeln('Last executed: ' . $lastRun->format(\DateTimeInterface::ATOM)); | ||
| $output->writeln('Last duration: ' . $row['execution_duration']); | ||
|
|
||
| if ($isTimedJob) { | ||
| $reflection = new \ReflectionClass($job); | ||
| $intervalProperty = $reflection->getProperty('interval'); | ||
| $intervalProperty->setAccessible(true); | ||
| $interval = $intervalProperty->getValue($job); | ||
|
|
||
| $nextRun = new \DateTime(); | ||
| $nextRun->setTimestamp($row['last_run'] + $interval); | ||
|
|
||
| if ($nextRun > new \DateTime()) { | ||
| $output->writeln('Next execution: <comment>' . $nextRun->format(\DateTimeInterface::ATOM) . '</comment>'); | ||
| } else { | ||
| $output->writeln('Next execution: <info>' . $nextRun->format(\DateTimeInterface::ATOM) . '</info>'); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| /** | ||
| * @copyright Copyright (c) 2021, Joas Schilling <coding@schilljs.com> | ||
| * | ||
| * @author Joas Schilling <coding@schilljs.com> | ||
| * | ||
| * @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 OC\Core\Command\Background; | ||
|
|
||
| use OC\Core\Command\InterruptedException; | ||
| use OCP\BackgroundJob\IJobList; | ||
| use Psr\Log\LoggerInterface; | ||
| use Symfony\Component\Console\Input\InputArgument; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
|
|
||
| class JobWorker extends JobBase { | ||
| private array $executedJobs = []; | ||
|
|
||
| public function __construct(IJobList $jobList, | ||
| LoggerInterface $logger) { | ||
| parent::__construct($jobList, $logger); | ||
| } | ||
|
|
||
| protected function configure(): void { | ||
| parent::configure(); | ||
|
|
||
| $this | ||
| ->setName('background-job:worker') | ||
| ->setDescription('Run a background job worker') | ||
| ->addArgument( | ||
| 'job-class', | ||
| InputArgument::OPTIONAL, | ||
| 'The class of the job in the database' | ||
| ) | ||
| ->addOption( | ||
| 'once', | ||
| null, | ||
| InputOption::VALUE_NONE, | ||
| 'Only execute the worker once (as a regular cron execution would do it)' | ||
| ) | ||
| ->addOption( | ||
| 'interval', | ||
| 'i', | ||
| InputOption::VALUE_OPTIONAL, | ||
| 'Interval in seconds in which the worker should repeat already processed jobs (set to 0 for no repeat)', | ||
| 5 | ||
| ) | ||
| ; | ||
| } | ||
|
|
||
| protected function execute(InputInterface $input, OutputInterface $output): int { | ||
| $jobClass = $input->getArgument('job-class'); | ||
|
|
||
| if ($jobClass && !class_exists($jobClass)) { | ||
| $output->writeln('<error>Invalid job class</error>'); | ||
| return 1; | ||
| } | ||
|
|
||
| while (true) { | ||
| // Handle canceling of the process | ||
| try { | ||
| $this->abortIfInterrupted(); | ||
| } catch (InterruptedException $e) { | ||
| $output->writeln('<comment>Cleaning up before quitting. Press Ctrl-C again to kill, but this may have unexpected side effects.</comment>'); | ||
| $this->unlockExecuted(); | ||
| $output->writeln('<info>Background job worker stopped</info>'); | ||
| break; | ||
| } | ||
|
|
||
| $this->printSummary($input, $output); | ||
|
|
||
| $interval = (int)($input->getOption('interval') ?? 5); | ||
|
|
||
| // Unlock jobs that should be executed again after the interval | ||
| // Alternative could be to set last_checked to interval in the future to avoid the extra locks | ||
| foreach ($this->executedJobs as $id => $time) { | ||
| if ($time <= time() - $interval) { | ||
| unset($this->executedJobs[$id]); | ||
| $job = $this->jobList->getById($id); | ||
| if ($job !== null) { | ||
| $this->jobList->unlockJob($job); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| usleep(50000); | ||
| $job = $this->jobList->getNext(false, $jobClass); | ||
| if (!$job) { | ||
| if ($input->getOption('once') === true || $interval === 0) { | ||
| break; | ||
| } | ||
|
|
||
| $output->writeln("Waiting for new jobs to be queued", OutputInterface::VERBOSITY_VERBOSE); | ||
| // Re-check interval for new jobs | ||
| sleep(1); | ||
| continue; | ||
| } | ||
|
|
||
|
|
||
| if (isset($this->executedJobs[$job->getId()]) && ($this->executedJobs[$job->getId()] + $interval > time())) { | ||
| $output->writeln("<comment>Job already executed within timeframe " . get_class($job) . " " . $job->getId() . '</comment>', OutputInterface::VERBOSITY_VERBOSE); | ||
| continue; | ||
| } | ||
|
|
||
| $output->writeln("Running job " . get_class($job) . " with ID " . $job->getId()); | ||
|
|
||
| if ($output->isVerbose()) { | ||
| $this->printJobInfo($job->getId(), $job, $output); | ||
| } | ||
|
|
||
| $job->execute($this->jobList, \OC::$server->getLogger()); | ||
|
|
||
| // clean up after unclean jobs | ||
| \OC_Util::tearDownFS(); | ||
| \OC::$server->getTempManager()->clean(); | ||
|
|
||
| $this->jobList->setLastJob($job); | ||
| $this->jobList->unlockJob($job); | ||
| $this->executedJobs[$job->getId()] = time(); | ||
|
|
||
| if ($input->getOption('once') === true) { | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| $this->unlockExecuted(); | ||
|
|
||
| return 0; | ||
| } | ||
|
|
||
| private function printSummary(InputInterface $input, OutputInterface $output): void { | ||
| if (!$output->isVeryVerbose()) { | ||
| return; | ||
| } | ||
| $output->writeln("<comment>Summary</comment>"); | ||
|
|
||
| $counts = []; | ||
| foreach ($this->jobList->countByClass() as $row) { | ||
| $counts[] = $row; | ||
| } | ||
| $this->writeTableInOutputFormat($input, $output, $counts); | ||
| } | ||
|
|
||
| private function unlockExecuted() { | ||
| foreach ($this->executedJobs as $id => $time) { | ||
| unset($this->executedJobs[$id]); | ||
| $job = $this->jobList->getById($id); | ||
| if ($job !== null) { | ||
| $this->jobList->unlockJob($job); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.