Merge pull request #12 from freyo/plain

Add Plain Support

Author: freyo

.scrutinizer.yml

@@ -0,0 +1,25 @@
+tools:
+  # external_code_coverage: true
+  php_mess_detector: true
+  php_code_sniffer: true
+  sensiolabs_security_checker: true
+  # php_code_coverage: true
+  php_pdepend: true
+  php_loc:
+    enabled: true
+    excluded_dirs: [vendor, tests]
+checks:
+  php:
+    code_rating: true
+    duplication: true
+filter:
+  excluded_paths:
+  - 'tests/*'
+build:
+  tests:
+    override:
+    -
+      command: vendor/bin/phpunit --coverage-clover=my-coverage-file
+      coverage:
+        file: my-coverage-file
+        format: php-clover

.travis.yml

@@ -0,0 +1,13 @@
+language: php
+
+php:
+- 5.6
+- 7.0
+- 7.1
+- 7.2
+
+sudo: false
+
+install: travis_retry composer install --no-interaction --prefer-source
+
+script: vendor/bin/phpunit --verbose

README.md

@@ -56,7 +56,7 @@
   
   CMQ_QUEUE_HOST=https://cmq-queue-region.api.qcloud.com
   CMQ_QUEUE=queue_name #default queue name
-  CMQ_QUEUE_POLLING_WAIT_SECONDS=30
+  CMQ_QUEUE_POLLING_WAIT_SECONDS=0
   
   CMQ_TOPIC_ENABLE=false # set to true to use topic
   CMQ_TOPIC_FILTER=routing # or msgtag
@@ -118,6 +118,10 @@ Configure `config/queue.php`
                 'name'   => '',
             ],
         ],
+        'plain' => [
+            'enable' => false,
+            'job' => 'App\Jobs\CMQPlainJob@handle',
+        ],
     ];
     //...
 ];
@@ -129,6 +133,65 @@ Configure `config/queue.php`
 php artisan queue:work {connection-name} --queue={queue-name}
 ```
 
+#### Plain Mode (Experimental)
+
+```
+CMQ_PLAIN_ENABLE=true
+CMQ_PLAIN_JOB=App\Jobs\CMQPlainJob@handle
+```
+
+```php
+<?php
+
+namespace App\Jobs;
+ 
+use Illuminate\Bus\Queueable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Queue\Jobs\Job;
+
+class CMQPlainJob implements ShouldQueue
+{
+    use InteractsWithQueue, Queueable;
+    
+    protected $payload;
+
+    /**
+     * Create a new job instance.
+     *
+     * @return void
+     */
+    public function __construct($payload)
+    {
+        $this->payload = $payload;
+    }
+    
+    /**
+     * Get the plain payload of the job.
+     *
+     * @return string
+     */
+    public function getPayload()
+    {
+        return $this->payload;
+    }
+    
+    /**
+     * Execute the job.
+     *
+     * @return void
+     */
+    public function handle(Job $job, $payload)
+    {
+        if (! $job->isDeletedOrReleased()) {
+            $job->delete();
+        }
+        
+        var_dump($payload);
+    }
+}
+```
+
 ## References
 
 - [Product Documentation](https://cloud.tencent.com/document/product/406?lang=en)

composer.json

@@ -3,12 +3,12 @@
     "description": "Queue Adapter for Tencent Qcloud CMQ SDK",
     "keywords": ["laravel-queue", "cmq", "qcloud"],
     "require": {
-        "php": "^7.1.3",
-        "illuminate/queue": "5.6.*|5.7.*"
+        "php": ">=5.6.4",
+        "illuminate/queue": "5.2.*|5.3.*|5.4.*|5.5.*|5.6.*|5.7.*"
     },
     "require-dev": {
-        "php": "^7.1.3",
-        "phpunit/phpunit": "^7.0"
+        "php": ">=5.6.4",
+        "phpunit/phpunit": "~4.8"
     },
     "autoload": {
         "psr-4": {

config/cmq.php

@@ -28,4 +28,9 @@
         ],
     ],
 
+    'plain' => [
+        'enable' => env('CMQ_PLAIN_ENABLE', false),
+        'job'    => env('CMQ_PLAIN_JOB', 'App\Jobs\CMQPlainJob@handle'),
+    ],
+
 ];

phpunit.xml.dist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         syntaxCheck="false">
+    <testsuites>
+        <testsuite name="Application Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/LaravelQueueCMQServiceProvider.php

@@ -31,7 +31,7 @@ public function boot()
         $queue = $this->app['queue'];
 
         $queue->addConnector('cmq', function () {
-            return new CMQConnector($this->app['events']);
+            return new CMQConnector();
         });
     }
 }

src/Queue/CMQQueue.php

@@ -9,6 +9,7 @@
 use Freyo\LaravelQueueCMQ\Queue\Jobs\CMQJob;
 use Illuminate\Contracts\Queue\Queue as QueueContract;
 use Illuminate\Queue\Queue;
+use Illuminate\Support\Arr;
 
 class CMQQueue extends Queue implements QueueContract
 {
@@ -29,13 +30,36 @@ class CMQQueue extends Queue implements QueueContract
     private $queueAccount;
     private $topicAccount;
 
+    /**
+     * @var array
+     */
+    protected $plainOptions;
+
     public function __construct(Account $queueAccount, Account $topicAccount, array $config)
     {
         $this->queueAccount = $queueAccount;
         $this->topicAccount = $topicAccount;
 
         $this->queueOptions = $config['options']['queue'];
         $this->topicOptions = $config['options']['topic'];
+
+        $this->plainOptions = Arr::get($config, 'plain', []);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isPlain()
+    {
+        return Arr::get($this->plainOptions, 'enable', false);
+    }
+
+    /**
+     * @return string
+     */
+    public function getPlainJob()
+    {
+        return Arr::get($this->plainOptions, 'job');
     }
 
     /**
@@ -63,7 +87,9 @@ public function size($queue = null)
      */
     public function push($job, $data = '', $queue = null)
     {
-        return $this->pushRaw($this->createPayload($job, $data), $queue);
+        $payload = $this->isPlain() ? $job->getPayload() : $this->createPayload($job, $data);
+
+        return $this->pushRaw($payload, $queue);
     }
 
     /**

src/Queue/Connectors/CMQConnector.php

@@ -4,23 +4,11 @@
 
 use Freyo\LaravelQueueCMQ\Queue\CMQQueue;
 use Freyo\LaravelQueueCMQ\Queue\Driver\Account;
-use Illuminate\Contracts\Events\Dispatcher;
-use Illuminate\Contracts\Queue\Queue;
 use Illuminate\Queue\Connectors\ConnectorInterface;
-use Illuminate\Queue\Events\WorkerStopping;
+use Illuminate\Support\Arr;
 
 class CMQConnector implements ConnectorInterface
 {
-    /**
-     * @var Dispatcher
-     */
-    private $dispatcher;
-
-    public function __construct(Dispatcher $dispatcher)
-    {
-        $this->dispatcher = $dispatcher;
-    }
-
     /**
      * Establish a queue connection.
      *
@@ -30,13 +18,17 @@ public function __construct(Dispatcher $dispatcher)
      */
     public function connect(array $config)
     {
-        $queue = new Account(array_get($config, 'options.queue.host'), $config['secret_id'], $config['secret_key']);
-
-        $topic = new Account(array_get($config, 'options.topic.host'), $config['secret_id'], $config['secret_key']);
-
-        $this->dispatcher->listen(WorkerStopping::class, function () {
-            //
-        });
+        $queue = new Account(
+            Arr::get($config, 'options.queue.host'),
+            $config['secret_id'],
+            $config['secret_key']
+        );
+
+        $topic = new Account(
+            Arr::get($config, 'options.topic.host'),
+            $config['secret_id'],
+            $config['secret_key']
+        );
 
         return new CMQQueue($queue, $topic, $config);
     }

src/Queue/Jobs/CMQJob.php

@@ -59,11 +59,33 @@ public function attempts()
      */
     public function fire()
     {
-        method_exists($this, 'resolveAndFire') 
-            ? $this->resolveAndFire(json_decode($this->getRawBody(), true)) 
+        method_exists($this, 'resolveAndFire')
+            ? $this->resolveAndFire($this->payload())
             : parent::fire();
     }
 
+    /**
+     * Get the decoded body of the job.
+     *
+     * @return array
+     */
+    public function payload()
+    {
+        if ($this->connection->isPlain()) {
+            $job = $this->connection->getPlainJob();
+
+            return [
+                'displayName' => is_string($job) ? explode('@', $job)[0] : null,
+                'job'         => $job,
+                'maxTries'    => null,
+                'timeout'     => null,
+                'data'        => $this->getRawBody(),
+            ];
+        }
+
+        return json_decode($this->getRawBody(), true);
+    }
+
     /**
      * Delete the job from the queue.
      *