Prepare 3.1 release

Author: Oliver Stark

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file.
 
+## [3.1.0] - 2022-09-22
+
+> {note} Upgrading is highly recommended. The previous version did not limit concurrency of queue runners. `ASYNC_QUEUE_CONCURRENCY` defaults to `1` now. 
+
+- Fixed RateLimiter
+- Added tests for RateLimiter / concurrency
+- Concurrency of queue runners defaults to `1` now 
+
+
 ## [3.0.0] - 2022-05-12
 - Craft 4 support
 - PHP 8 syntax

README.md

@@ -55,7 +55,7 @@ PHP_BINARY="/usr/local/Cellar/php71/7.1.0_11/bin/php"
 ```
 
 
-By default `2` background processes handle the queue. With the `ASYNC_QUEUE_CONCURRENCY` ENV var you can modify this behaviour.
+By default `1` background process handles the queue. With the `ASYNC_QUEUE_CONCURRENCY` ENV var you can modify this behaviour.
 ```
 # No concurrency
 ASYNC_QUEUE_CONCURRENCY=1

composer.json

@@ -23,16 +23,14 @@
   "require": {
     "php": "^8.0",
     "craftcms/cms": "^4.0.0",
-    "symfony/process": "^5.0",
-    "treeware/plant": "^0.1.0"
+    "symfony/process": "^5.0"
   },
   "autoload": {
     "psr-4": {
       "ostark\\AsyncQueue\\": "src/"
     }
   },
   "extra": {
-    "treeware": {},
     "name": "AsyncQueue",
     "handle": "async-queue",
     "hasCpSettings": false,
@@ -51,8 +49,7 @@
   "config": {
     "allow-plugins": {
       "yiisoft/yii2-composer": true,
-      "craftcms/plugin-installer": true,
-      "treeware/plant": true
+      "craftcms/plugin-installer": true
     }
   },
   "prefer-stable": true,

src/Handlers/BackgroundQueueHandler.php

@@ -26,24 +26,28 @@ public function __construct(Plugin $plugin)
 
     public function __invoke(PushEvent $event): void
     {
+
         $context = ($event->job instanceof JobInterface)
             ? $event->job->getDescription()
             : 'Not instanceof craft\queue\JobInterface';
 
         // Run queue in the background
         if ($this->plugin->getRateLimiter()->canIUse($context)) {
+
             try {
-                $this->plugin->getProcess()->start();
+                $process = $this->plugin->getProcess()->start();
                 $this->plugin->getRateLimiter()->increment();
                 $handled = true;
 
+                $process->wait();
+
             } catch (PhpExecutableNotFound) {
-                Craft::debug(
+                Craft::error(
                     'QueueHandler::startBackgroundProcess() (PhpExecutableNotFound)',
                     'async-queue'
                 );
             } catch (RuntimeException | LogicException $e) {
-                Craft::debug(
+                Craft::error(
                     Craft::t(
                         'async-queue',
                         'QueueHandler::startBackgroundProcess() (Job status: {status}. Exit code: {code})', [
@@ -68,7 +72,7 @@ protected function logPushEvent(PushEvent $event, bool $handled = false): void
         }
 
         if ($event->job instanceof BaseJob) {
-            Craft::debug(
+            Craft::info(
                 Craft::t(
                     'async-queue',
                     'New PushEvent for {job} job - ({handled})', [

src/QueueCommand.php

@@ -9,7 +9,7 @@ class QueueCommand extends Component
 {
     public const DEFAULT_SCRIPT = "craft";
 
-    public const DEFAULT_ARGS = "queue/run";
+    public const DEFAULT_ARGS = "queue/run -v";
 
     public const EVENT_PREPARE_COMMAND = 'prepareCommand';
 
@@ -68,7 +68,8 @@ protected function decorate(string $commandLine): string
         }
 
         // default decoration
-        return "nice -n 15 {$commandLine}"; //  > /tmp/null.txt 2>&1 &
+        return "nice -n 15 {$commandLine} > /dev/null 2>&1 &";
+
     }
 
 }

src/Settings.php

@@ -4,23 +4,9 @@
 
 class Settings extends Model
 {
-    // Public Properties
-    // =========================================================================
+    public int $concurrency;
 
-    /**
-     * @var integer
-     */
-    public $concurrency;
-
-    /**
-     * @var integer
-     */
-    public $poolLifetime;
-
-    /**
-     * @var bool
-     */
-    public $enabled = true;
+    public bool $enabled = true;
 
 
     /**
@@ -29,8 +15,7 @@ class Settings extends Model
     public function __construct(array $config = [])
     {
         $config = array_merge([
-            'concurrency'  => (int)$this->env('ASYNC_QUEUE_CONCURRENCY', 2),
-            'poolLifetime' => (int)$this->env('ASYNC_QUEUE_POOL_LIFETIME', 3600),
+            'concurrency'  => (int) $this->env('ASYNC_QUEUE_CONCURRENCY', 1),
             'enabled'      => ($this->env('DISABLE_ASYNC_QUEUE', '0') == '1') ? false : true
         ], $config);
 

src/TestUtility/TestJob.php

@@ -13,7 +13,7 @@ class TestJob extends BaseJob
      */
     public function execute($queue): void
     {
-        sleep(10);
+        sleep(3);
     }
 
 

tests/BackgroundProcessRunTest.php

@@ -32,6 +32,9 @@ public function test_start_default_dummy_script_success(): void
 
         $process->wait();
 
+        // give it some time to write the test file
+        usleep(150000);
+
         $this->assertEquals(0, $process->getExitCode());
         $this->assertTrue($process->isSuccessful());
         $this->assertEquals(\Symfony\Component\Process\Process::STATUS_TERMINATED, $process->getStatus());
@@ -53,6 +56,8 @@ public function test_process_does_not_block(): void
         $command   = new \ostark\AsyncQueue\QueueCommand('craft.php', '--sleep');
         $bgProcess = new BackgroundProcess($command);
         $process   = $bgProcess->start();
+
+        // give it some time to write the test file
         usleep(150000);
 
         $this->assertFileExists(TEST_FILE);
@@ -61,5 +66,4 @@ public function test_process_does_not_block(): void
         $this->assertGreaterThanOrEqual($content['timestamp'], time());
 
     }
-
 }