AliceMajere / wonderland-thread

src/AbstractThread.php

Indentation +83 added lines, -83 removed lines

@@ -6,88 +6,88 @@
 
 abstract class AbstractThread extends AbstractThreadMediator
 {
-	const EXIT_STATUS_SUCCESS = 0;
-	const EXIT_STATUS_ERROR = 1;
-
-	/** @var int $pid */
-	private $pid;
-
-	/** @var string $processName */
-	private $processName;
-
-	/**
-	 * AbstractThread constructor.
-	 *
-	 * @param string $processName
-	 */
-	public function __construct(string $processName)
-	{
-		$this->processName = $processName;
-	}
-
-	/**
-	 * Return the name of the method to process during the thread
-	 *
-	 * @return string
-	 */
-	abstract protected function getMethodName(): string;
-
-	/**
-	 * Return the list of dependencies that will be passed as parameters of the method referenced by getMethodName
-	 *
-	 * @return array
-	 */
-	abstract protected function getDependencies(): array;
-
-	/**
-	 * @return int|null
-	 */
-	public function getPid(): ?int
-	{
-		return $this->pid;
-	}
-
-	/**
-	 * @param int $pid
-	 * @return AbstractThread
-	 */
-	public function setPid(int $pid): self
-	{
-		$this->pid = $pid;
-
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getProcessName(): ?string
-	{
-		return $this->processName;
-	}
-
-	/**
-	 * @return int
-	 * @throws ThreadException
-	 */
-	public function run(): int
-	{
-		if (false === method_exists($this, $this->getMethodName())) {
-			throw new ThreadException('No proper method defined for the thread');
-		}
-
-		$status = call_user_func_array(
-			[$this, $this->getMethodName()],
-			array_merge([$this->getProcessName()], $this->getDependencies())
-		);
-
-		if (null === $status) {
-			throw new ThreadException(
-				'Error. You must return a process status in '.get_class($this).':'.$this->getMethodName()
-			);
-		}
-
-		return $status;
-	}
+    const EXIT_STATUS_SUCCESS = 0;
+    const EXIT_STATUS_ERROR = 1;
+
+    /** @var int $pid */
+    private $pid;
+
+    /** @var string $processName */
+    private $processName;
+
+    /**
+     * AbstractThread constructor.
+     *
+     * @param string $processName
+     */
+    public function __construct(string $processName)
+    {
+        $this->processName = $processName;
+    }
+
+    /**
+     * Return the name of the method to process during the thread
+     *
+     * @return string
+     */
+    abstract protected function getMethodName(): string;
+
+    /**
+     * Return the list of dependencies that will be passed as parameters of the method referenced by getMethodName
+     *
+     * @return array
+     */
+    abstract protected function getDependencies(): array;
+
+    /**
+     * @return int|null
+     */
+    public function getPid(): ?int
+    {
+        return $this->pid;
+    }
+
+    /**
+     * @param int $pid
+     * @return AbstractThread
+     */
+    public function setPid(int $pid): self
+    {
+        $this->pid = $pid;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getProcessName(): ?string
+    {
+        return $this->processName;
+    }
+
+    /**
+     * @return int
+     * @throws ThreadException
+     */
+    public function run(): int
+    {
+        if (false === method_exists($this, $this->getMethodName())) {
+            throw new ThreadException('No proper method defined for the thread');
+        }
+
+        $status = call_user_func_array(
+            [$this, $this->getMethodName()],
+            array_merge([$this->getProcessName()], $this->getDependencies())
+        );
+
+        if (null === $status) {
+            throw new ThreadException(
+                'Error. You must return a process status in '.get_class($this).':'.$this->getMethodName()
+            );
+        }
+
+        return $status;
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -83,7 +83,7 @@
 
 		if (null === $status) {
 			throw new ThreadException(
-				'Error. You must return a process status in '.get_class($this).':'.$this->getMethodName()
+				'Error. You must return a process status in ' . get_class($this) . ':' . $this->getMethodName()
 			);
 		}
 

src/AbstractThreadMediator.php

Indentation +20 added lines, -20 removed lines

@@ -7,28 +7,28 @@
 
 class AbstractThreadMediator
 {
-	/** @var Mediator */
-	private $mediator;
+    /** @var Mediator */
+    private $mediator;
 
-	/**
-	 * @return Mediator
-	 */
-	protected function getMediator()
-	{
-		return $this->mediator;
-	}
+    /**
+     * @return Mediator
+     */
+    protected function getMediator()
+    {
+        return $this->mediator;
+    }
 
-	public function setMediator(Mediator $mediator)
-	{
-		$this->mediator = $mediator;
-	}
+    public function setMediator(Mediator $mediator)
+    {
+        $this->mediator = $mediator;
+    }
 
-	/**
-	 * @param EventInterface $event
-	 */
-	protected function notify(EventInterface $event)
-	{
-		$this->getMediator()->notify($event);
-	}
+    /**
+     * @param EventInterface $event
+     */
+    protected function notify(EventInterface $event)
+    {
+        $this->getMediator()->notify($event);
+    }
 
 }

src/ThreadPool.php

Indentation +267 added lines, -267 removed lines

@@ -7,272 +7,272 @@
 
 class ThreadPool extends AbstractThreadPoolMediator
 {
-	// 0.2s
-	private const SLEEP_TIME_MS = 50000;
-
-	/** @var AbstractThread[] $childs */
-	private $threads;
-
-	/** @var AbstractThread[] $toRunThreads */
-	private $toRunThreads;
-
-	/** @var AbstractThread[] $runningChilds */
-	private $runningThreads;
-
-	/** @var bool $isRunning */
-	private $isRunning;
-
-	/** @var int $maxRunningThreadNb */
-	private $maxRunningThreadNb;
-
-	/**
-	 * ThreadPool constructor.
-	 */
-	public function __construct()
-	{
-		parent::__construct();
-		$this->threads = [];
-		$this->runningThreads = [];
-		$this->toRunThreads = [];
-		$this->isRunning = false;
-		$this->maxRunningThreadNb = 0;
-	}
-
-	/**
-	 *
-	 */
-	public function __destruct()
-	{
-		pcntl_waitpid(-1, $status, WNOHANG);
-	}
-
-	/**
-	 * @return AbstractThread[]
-	 */
-	public function getThreads(): array
-	{
-		return $this->threads;
-	}
-
-	/**
-	 * @param AbstractThread[] $threads
-	 * @return ThreadPool
-	 */
-	public function setThreads(array $threads): self
-	{
-		$this->threads = $threads;
-
-		return $this;
-	}
-
-	/**
-	 * @param AbstractThread $thread
-	 * @return ThreadPool
-	 */
-	public function addThread(AbstractThread $thread): self
-	{
-		$this->threads[] = $thread;
-
-		return $this;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getMaxRunningThreadNb(): int
-	{
-		return $this->maxRunningThreadNb;
-	}
-
-	/**
-	 * @param int $maxRunningThreadNb
-	 * @return ThreadPool
-	 */
-	public function setMaxRunningThreadNb(int $maxRunningThreadNb): self
-	{
-		$this->maxRunningThreadNb = $maxRunningThreadNb;
-
-		return $this;
-	}
-
-	/**
-	 * @return AbstractThread[]
-	 */
-	public function getToRunThreads(): array
-	{
-		return $this->toRunThreads;
-	}
-
-	/**
-	 * @return AbstractThread[]
-	 */
-	public function getRunningThreads(): array
-	{
-		return $this->runningThreads;
-	}
-
-	/**
-	 * @throws ThreadException
-	 */
-	public function run()
-	{
-		$this->checkEnv();
-		$this->initRun();
-
-		while ($this->isRunningThreads()) {
-			$this->waitOnThreads();
-		}
-
-		$this->resetRun();
-	}
-
-	/**
-	 * @return bool
-	 * @throws ThreadException
-	 */
-	private function isRunningThreads(): bool
-	{
-		if (count($this->toRunThreads) > 0) {
-			while (count($this->runningThreads) < $this->maxRunningThreadNb && count($this->toRunThreads) > 0) {
-				$this->createThreadProcess(array_shift($this->toRunThreads));
-			}
-		}
-
-		return count($this->runningThreads) > 0;
-	}
-
-	/**
-	 * can't test some part of it this since we can't unit-test in web and we're never in a child
-	 * process when pid 0 when unit-testing since the coverage is done by the parent thread
-	 *
-	 * @param AbstractThread $thread
-	 * @throws ThreadException
-	 */
-	private function createThreadProcess(AbstractThread $thread)
-	{
-		$pid = pcntl_fork();
-
-		switch ($pid) {
-			case -1: //error forking
-				// @codeCoverageIgnoreStart
-				throw new ThreadException('Error while trying to fork. Check your server installation');
-				// @codeCoverageIgnoreEnd
-			case 0: // child
-				// @codeCoverageIgnoreStart
-				$thread->setMediator($this->getMediator());
-				$this->processThread($thread);
-				break;
-				// @codeCoverageIgnoreEnd
-			default: //parent
-				$thread->setPid($pid);
-				$this->runningThreads[] = $thread;
-				$this->notify(PoolEvent::POOL_NEW_THREAD, $thread);
-				$this->startRunStatus();
-		}
-	}
-
-	/**
-	 *
-	 */
-	private function waitOnThreads()
-	{
-		$this->notify(PoolEvent::POOL_PRE_WAIT_TICK);
-		foreach ($this->runningThreads as $k => $thread) {
-
-			$res = pcntl_waitpid($thread->getPid(), $status, WNOHANG);
-			$this->notify(PoolEvent::POOL_WAIT_TICK_PID);
-
-			if ($res === -1 || $res > 0) {
-				$this->notify(PoolEvent::POOL_WAIT_TICK_PID_REMOVED, $thread);
-				unset($this->runningThreads[$k]);
-			}
-
-		}
-		$this->notify(PoolEvent::POOL_POST_WAIT_TICK);
-
-		usleep(self::SLEEP_TIME_MS);
-	}
-
-	/**
-	 * @codeCoverageIgnore Can't test since this is only run in a child thread.. which doesnt' go throug the
-	 * unit-test coverage which is only done in the main process
-	 * @param AbstractThread $thread
-	 * @throws ThreadException
-	 */
-	private function processThread(AbstractThread $thread)
-	{
-		$this->notify(PoolEvent::THREAD_PRE_PROCESS, $thread);
-		$response = $thread->run();
-		$this->notify(PoolEvent::THREAD_POST_PROCESS, $thread);
-
-		switch ($response) {
-			case AbstractThread::EXIT_STATUS_SUCCESS:
-				$this->notify(PoolEvent::THREAD_EXIT_SUCCESS, $thread);
-				break;
-			case AbstractThread::EXIT_STATUS_ERROR:
-				$this->notify(PoolEvent::THREAD_EXIT_ERROR, $thread);
-				break;
-			default:
-				$this->notify(PoolEvent::THREAD_EXIT_UNKNOWN, $thread);
-		}
-
-		exit($response);
-	}
-
-	/**
-	 * Can't test the exception is not in cli since php-unit is only run in cli environment
-	 * @throws ThreadException
-	 */
-	private function checkEnv()
-	{
-		if (false === $this->isCli()) {
-			// @codeCoverageIgnoreStart
-			throw new ThreadException('Error. It is not safe to use process forking in other way than php-cli');
-			// @codeCoverageIgnoreEnd
-		}
-		if (0 === count($this->threads)) {
-			throw new ThreadException('Error. Can\'t run child threads processes without any added in the Pool');
-		}
-	}
-
-	/**
-	 *
-	 */
-	private function initRun()
-	{
-		$this->resetRun();
-	}
-
-	/**
-	 * @return bool
-	 */
-	private function isCli(): bool
-	{
-		return PHP_SAPI === 'cli';
-	}
-
-	/**
-	 *
-	 */
-	private function startRunStatus()
-	{
-		if (false === $this->isRunning) {
-			$this->notify(PoolEvent::POOL_RUN_START);
-			$this->isRunning = true;
-		}
-	}
-
-	/**
-	 *
-	 */
-	private function resetRun()
-	{
-		if (true === $this->isRunning) {
-			$this->notify(PoolEvent::POOL_RUN_STOP);
-		}
-		$this->isRunning = false;
-		$this->toRunThreads = $this->threads;
-		$this->runningThreads = [];
-	}
+    // 0.2s
+    private const SLEEP_TIME_MS = 50000;
+
+    /** @var AbstractThread[] $childs */
+    private $threads;
+
+    /** @var AbstractThread[] $toRunThreads */
+    private $toRunThreads;
+
+    /** @var AbstractThread[] $runningChilds */
+    private $runningThreads;
+
+    /** @var bool $isRunning */
+    private $isRunning;
+
+    /** @var int $maxRunningThreadNb */
+    private $maxRunningThreadNb;
+
+    /**
+     * ThreadPool constructor.
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->threads = [];
+        $this->runningThreads = [];
+        $this->toRunThreads = [];
+        $this->isRunning = false;
+        $this->maxRunningThreadNb = 0;
+    }
+
+    /**
+     *
+     */
+    public function __destruct()
+    {
+        pcntl_waitpid(-1, $status, WNOHANG);
+    }
+
+    /**
+     * @return AbstractThread[]
+     */
+    public function getThreads(): array
+    {
+        return $this->threads;
+    }
+
+    /**
+     * @param AbstractThread[] $threads
+     * @return ThreadPool
+     */
+    public function setThreads(array $threads): self
+    {
+        $this->threads = $threads;
+
+        return $this;
+    }
+
+    /**
+     * @param AbstractThread $thread
+     * @return ThreadPool
+     */
+    public function addThread(AbstractThread $thread): self
+    {
+        $this->threads[] = $thread;
+
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function getMaxRunningThreadNb(): int
+    {
+        return $this->maxRunningThreadNb;
+    }
+
+    /**
+     * @param int $maxRunningThreadNb
+     * @return ThreadPool
+     */
+    public function setMaxRunningThreadNb(int $maxRunningThreadNb): self
+    {
+        $this->maxRunningThreadNb = $maxRunningThreadNb;
+
+        return $this;
+    }
+
+    /**
+     * @return AbstractThread[]
+     */
+    public function getToRunThreads(): array
+    {
+        return $this->toRunThreads;
+    }
+
+    /**
+     * @return AbstractThread[]
+     */
+    public function getRunningThreads(): array
+    {
+        return $this->runningThreads;
+    }
+
+    /**
+     * @throws ThreadException
+     */
+    public function run()
+    {
+        $this->checkEnv();
+        $this->initRun();
+
+        while ($this->isRunningThreads()) {
+            $this->waitOnThreads();
+        }
+
+        $this->resetRun();
+    }
+
+    /**
+     * @return bool
+     * @throws ThreadException
+     */
+    private function isRunningThreads(): bool
+    {
+        if (count($this->toRunThreads) > 0) {
+            while (count($this->runningThreads) < $this->maxRunningThreadNb && count($this->toRunThreads) > 0) {
+                $this->createThreadProcess(array_shift($this->toRunThreads));
+            }
+        }
+
+        return count($this->runningThreads) > 0;
+    }
+
+    /**
+     * can't test some part of it this since we can't unit-test in web and we're never in a child
+     * process when pid 0 when unit-testing since the coverage is done by the parent thread
+     *
+     * @param AbstractThread $thread
+     * @throws ThreadException
+     */
+    private function createThreadProcess(AbstractThread $thread)
+    {
+        $pid = pcntl_fork();
+
+        switch ($pid) {
+            case -1: //error forking
+                // @codeCoverageIgnoreStart
+                throw new ThreadException('Error while trying to fork. Check your server installation');
+                // @codeCoverageIgnoreEnd
+            case 0: // child
+                // @codeCoverageIgnoreStart
+                $thread->setMediator($this->getMediator());
+                $this->processThread($thread);
+                break;
+                // @codeCoverageIgnoreEnd
+            default: //parent
+                $thread->setPid($pid);
+                $this->runningThreads[] = $thread;
+                $this->notify(PoolEvent::POOL_NEW_THREAD, $thread);
+                $this->startRunStatus();
+        }
+    }
+
+    /**
+     *
+     */
+    private function waitOnThreads()
+    {
+        $this->notify(PoolEvent::POOL_PRE_WAIT_TICK);
+        foreach ($this->runningThreads as $k => $thread) {
+
+            $res = pcntl_waitpid($thread->getPid(), $status, WNOHANG);
+            $this->notify(PoolEvent::POOL_WAIT_TICK_PID);
+
+            if ($res === -1 || $res > 0) {
+                $this->notify(PoolEvent::POOL_WAIT_TICK_PID_REMOVED, $thread);
+                unset($this->runningThreads[$k]);
+            }
+
+        }
+        $this->notify(PoolEvent::POOL_POST_WAIT_TICK);
+
+        usleep(self::SLEEP_TIME_MS);
+    }
+
+    /**
+     * @codeCoverageIgnore Can't test since this is only run in a child thread.. which doesnt' go throug the
+     * unit-test coverage which is only done in the main process
+     * @param AbstractThread $thread
+     * @throws ThreadException
+     */
+    private function processThread(AbstractThread $thread)
+    {
+        $this->notify(PoolEvent::THREAD_PRE_PROCESS, $thread);
+        $response = $thread->run();
+        $this->notify(PoolEvent::THREAD_POST_PROCESS, $thread);
+
+        switch ($response) {
+            case AbstractThread::EXIT_STATUS_SUCCESS:
+                $this->notify(PoolEvent::THREAD_EXIT_SUCCESS, $thread);
+                break;
+            case AbstractThread::EXIT_STATUS_ERROR:
+                $this->notify(PoolEvent::THREAD_EXIT_ERROR, $thread);
+                break;
+            default:
+                $this->notify(PoolEvent::THREAD_EXIT_UNKNOWN, $thread);
+        }
+
+        exit($response);
+    }
+
+    /**
+     * Can't test the exception is not in cli since php-unit is only run in cli environment
+     * @throws ThreadException
+     */
+    private function checkEnv()
+    {
+        if (false === $this->isCli()) {
+            // @codeCoverageIgnoreStart
+            throw new ThreadException('Error. It is not safe to use process forking in other way than php-cli');
+            // @codeCoverageIgnoreEnd
+        }
+        if (0 === count($this->threads)) {
+            throw new ThreadException('Error. Can\'t run child threads processes without any added in the Pool');
+        }
+    }
+
+    /**
+     *
+     */
+    private function initRun()
+    {
+        $this->resetRun();
+    }
+
+    /**
+     * @return bool
+     */
+    private function isCli(): bool
+    {
+        return PHP_SAPI === 'cli';
+    }
+
+    /**
+     *
+     */
+    private function startRunStatus()
+    {
+        if (false === $this->isRunning) {
+            $this->notify(PoolEvent::POOL_RUN_START);
+            $this->isRunning = true;
+        }
+    }
+
+    /**
+     *
+     */
+    private function resetRun()
+    {
+        if (true === $this->isRunning) {
+            $this->notify(PoolEvent::POOL_RUN_STOP);
+        }
+        $this->isRunning = false;
+        $this->toRunThreads = $this->threads;
+        $this->runningThreads = [];
+    }
 
 }