Stoppable behavior

CHANGELOG.md

@@ -3,6 +3,7 @@ Yii2 Queue Extension Change Log
 
 ## 2.0.1 under development
 
+- Enh #102: Stoppable behavior (zhuravljov)
 - Bug #118: Synchronized moving of delayed and reserved jobs to waiting list (zhuravljov)
 - Bug #112: Queue command inside module (tsingsun)
 - Enh #116: Add Chinese Guide (kids-return)

src/stoppable/Behavior.php

@@ -0,0 +1,107 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\queue\stoppable;
+
+use yii\caching\Cache;
+use yii\di\Instance;
+use yii\queue\ExecEvent;
+use yii\queue\Queue;
+
+/**
+ * Stoppable Behavior allows stopping scheduled jobs in a queue.
+ *
+ * It provides a [[stop()]] method to mark scheduled jobs as "stopped", that
+ * will prevent their execution.
+ *
+ * This behavior should be attached to the [[Queue]] component.
+ *
+ * @author Roman Zhuravlev <[email protected]>
+ * @since 2.0.1
+ */
+class Behavior extends \yii\base\Behavior
+{
+    /**
+     * @var Cache|array|string the cache instance used to store stopped status.
+     */
+    public $cache = 'cache';
+    /**
+     * @var bool option allows to turn status checking off in case a driver does not support it.
+     */
+    public $checkWaiting = true;
+    /**
+     * @var Queue
+     * @inheritdoc
+     */
+    public $owner;
+
+    /**
+     * @inheritdoc
+     */
+    public function init()
+    {
+        parent::init();
+        $this->cache = Instance::ensure($this->cache, Cache::class);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function events()
+    {
+        return [
+            Queue::EVENT_BEFORE_EXEC => 'beforeExec',
+        ];
+    }
+
+    /**
+     * @param ExecEvent $event
+     */
+    public function beforeExec(ExecEvent $event)
+    {
+        $event->handled = $this->isStopped($event->id);
+    }
+
+    /**
+     * Sets stop flag.
+     *
+     * @param string $id of a job
+     * @return bool
+     */
+    public function stop($id)
+    {
+        if (!$this->checkWaiting || $this->owner->isWaiting($id)) {
+            $this->markAsStopped($id);
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $id of a job
+     * @return bool
+     */
+    protected function markAsStopped($id)
+    {
+        $this->cache->set(__CLASS__ . $id, true);
+    }
+
+    /**
+     * @param string $id of a job
+     * @return bool
+     */
+    protected function isStopped($id)
+    {
+        if ($this->cache->exists(__CLASS__ . $id)) {
+            $this->cache->delete(__CLASS__ . $id);
+            return true;
+        }
+
+        return false;
+    }
+}

tests/stoppable/StoppableTest.php

@@ -0,0 +1,70 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace tests\stoppable;
+
+use tests\app\SimpleJob;
+use tests\TestCase;
+use Yii;
+use yii\caching\ArrayCache;
+use yii\queue\stoppable\Behavior as Stoppable;
+use yii\queue\sync\Queue as SyncQueue;
+
+/**
+ * Stoppable Test
+ *
+ * @author Roman Zhuravlev <[email protected]>
+ */
+class StoppableTest extends TestCase
+{
+    public function testStop()
+    {
+        $job = new SimpleJob(['uid' => uniqid()]);
+        $id = $this->getQueue()->push($job);
+        $this->getQueue()->stop($id);
+        $this->getQueue()->run();
+        $this->assertFileNotExists($job->getFileName());
+    }
+
+    public function testNotStop()
+    {
+        $job = new SimpleJob(['uid' => uniqid()]);
+        $this->getQueue()->push($job);
+        $this->getQueue()->run();
+        $this->assertFileExists($job->getFileName());
+    }
+
+    /**
+     * @return SyncQueue|Stoppable
+     */
+    protected function getQueue()
+    {
+        if (!$this->_queue) {
+            $this->_queue = new SyncQueue([
+                'handle' => false,
+                'as stoppable' => [
+                    'class' => Stoppable::class,
+                    'cache' => ArrayCache::class,
+                ],
+            ]);
+        }
+        return $this->_queue;
+    }
+
+    private $_queue;
+
+    /**
+     * @inheritdoc
+     */
+    protected function tearDown()
+    {
+        foreach (glob(Yii::getAlias("@runtime/job-*.lock")) as $fileName) {
+            unlink($fileName);
+        }
+        parent::tearDown();
+    }
+}