From 9731350acef75931ccbeafa054b40afe8189653f Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Thu, 24 Aug 2017 16:06:37 +0200 Subject: split async test bus for easier subclassing --- lib/private/Command/AsyncBus.php | 55 +++++------------------------ lib/private/Command/CronBus.php | 75 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+), 46 deletions(-) create mode 100644 lib/private/Command/CronBus.php (limited to 'lib/private/Command') diff --git a/lib/private/Command/AsyncBus.php b/lib/private/Command/AsyncBus.php index fb3cbee7240..2dffc9c784d 100644 --- a/lib/private/Command/AsyncBus.php +++ b/lib/private/Command/AsyncBus.php @@ -24,17 +24,11 @@ namespace OC\Command; use OCP\Command\IBus; use OCP\Command\ICommand; -use SuperClosure\Serializer; /** * Asynchronous command bus that uses the background job system as backend */ -class AsyncBus implements IBus { - /** - * @var \OCP\BackgroundJob\IJobList - */ - private $jobList; - +abstract class AsyncBus implements IBus { /** * List of traits for command which require sync execution * @@ -42,13 +36,6 @@ class AsyncBus implements IBus { */ private $syncTraits = []; - /** - * @param \OCP\BackgroundJob\IJobList $jobList - */ - public function __construct($jobList) { - $this->jobList = $jobList; - } - /** * Schedule a command to be fired * @@ -56,12 +43,19 @@ class AsyncBus implements IBus { */ public function push($command) { if ($this->canRunAsync($command)) { - $this->jobList->add($this->getJobClass($command), $this->serializeCommand($command)); + $this->queueCommand($command); } else { $this->runCommand($command); } } + /** + * Queue a command in the bus + * + * @param \OCP\Command\ICommand | callable $command + */ + abstract protected function queueCommand($command); + /** * Require all commands using a trait to be run synchronous * @@ -82,37 +76,6 @@ class AsyncBus implements IBus { } } - /** - * @param \OCP\Command\ICommand | callable $command - * @return string - */ - private function getJobClass($command) { - if ($command instanceof \Closure) { - return 'OC\Command\ClosureJob'; - } else if (is_callable($command)) { - return 'OC\Command\CallableJob'; - } else if ($command instanceof ICommand) { - return 'OC\Command\CommandJob'; - } else { - throw new \InvalidArgumentException('Invalid command'); - } - } - - /** - * @param \OCP\Command\ICommand | callable $command - * @return string - */ - private function serializeCommand($command) { - if ($command instanceof \Closure) { - $serializer = new Serializer(); - return $serializer->serialize($command); - } else if (is_callable($command) or $command instanceof ICommand) { - return serialize($command); - } else { - throw new \InvalidArgumentException('Invalid command'); - } - } - /** * @param \OCP\Command\ICommand | callable $command * @return bool diff --git a/lib/private/Command/CronBus.php b/lib/private/Command/CronBus.php new file mode 100644 index 00000000000..a0ad9b3c860 --- /dev/null +++ b/lib/private/Command/CronBus.php @@ -0,0 +1,75 @@ + + * + * @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 . + * + */ + +namespace OC\Command; + +use OCP\Command\ICommand; +use SuperClosure\Serializer; + +class CronBus extends AsyncBus { + /** + * @var \OCP\BackgroundJob\IJobList + */ + private $jobList; + + + /** + * @param \OCP\BackgroundJob\IJobList $jobList + */ + public function __construct($jobList) { + $this->jobList = $jobList; + } + + protected function queueCommand($command) { + $this->jobList->add($this->getJobClass($command), $this->serializeCommand($command)); + } + + /** + * @param \OCP\Command\ICommand | callable $command + * @return string + */ + private function getJobClass($command) { + if ($command instanceof \Closure) { + return 'OC\Command\ClosureJob'; + } else if (is_callable($command)) { + return 'OC\Command\CallableJob'; + } else if ($command instanceof ICommand) { + return 'OC\Command\CommandJob'; + } else { + throw new \InvalidArgumentException('Invalid command'); + } + } + + /** + * @param \OCP\Command\ICommand | callable $command + * @return string + */ + private function serializeCommand($command) { + if ($command instanceof \Closure) { + $serializer = new Serializer(); + return $serializer->serialize($command); + } else if (is_callable($command) or $command instanceof ICommand) { + return serialize($command); + } else { + throw new \InvalidArgumentException('Invalid command'); + } + } +} \ No newline at end of file -- cgit v1.2.3