Allow apps to determine which commands should be run synchronous based on traints

This commit is contained in:
Robin Appelman 2015-02-23 15:25:59 +01:00
parent be930e338d
commit 8213f8d67d
2 changed files with 65 additions and 1 deletions

View File

@ -21,6 +21,13 @@ class AsyncBus implements IBus {
*/
private $jobList;
/**
* List of traits for command which require sync execution
*
* @var string[]
*/
private $syncTraits = [];
/**
* @param \OCP\BackgroundJob\IJobList $jobList
*/
@ -34,7 +41,31 @@ class AsyncBus implements IBus {
* @param \OCP\Command\ICommand | callable $command
*/
public function push($command) {
if ($this->canRunAsync($command)) {
$this->jobList->add($this->getJobClass($command), $this->serializeCommand($command));
} else {
$this->runCommand($command);
}
}
/**
* Require all commands using a trait to be run synchronous
*
* @param string $trait
*/
public function requireSync($trait) {
$this->syncTraits[] = trim($trait, '\\');
}
/**
* @param \OCP\Command\ICommand | callable $command
*/
private function runCommand($command) {
if ($command instanceof ICommand) {
$command->handle();
} else {
$command();
}
}
/**
@ -67,4 +98,30 @@ class AsyncBus implements IBus {
throw new \InvalidArgumentException('Invalid command');
}
}
/**
* @param \OCP\Command\ICommand | callable $command
* @return bool
*/
private function canRunAsync($command) {
$traits = $this->getTraits($command);
foreach ($traits as $trait) {
if (array_search($trait, $this->syncTraits) !== false) {
return false;
}
}
return true;
}
/**
* @param \OCP\Command\ICommand | callable $command
* @return string[]
*/
private function getTraits($command) {
if ($command instanceof ICommand) {
return class_uses($command);
} else {
return [];
}
}
}

View File

@ -15,4 +15,11 @@ interface IBus {
* @param \OCP\Command\ICommand | callable $command
*/
public function push($command);
/**
* Require all commands using a trait to be run synchronous
*
* @param string $trait
*/
public function requireSync($trait);
}