Merge pull request #38 from webparking/feature/better-id-capture

Overhaul, new major release?

Author: imTigger

.travis.yml

@@ -1,20 +1,51 @@
 language: php
 
-php:
-  - 5.6
-  - 7.1
-
-sudo: false
-
-# cache vendor dirs
 cache:
   directories:
-    - vendor
     - $HOME/.composer/cache
 
-before_script:
-  - composer self-update
-  - composer install --no-interaction
+services:
+  - mysql
+
+matrix:
+  fast_finish: true
+  include:
+    - php: 7.1
+      env: LARAVEL='5.5.*' TESTBENCH='3.5.*' COMPOSER_FLAGS='--prefer-lowest'
+    - php: 7.1
+      env: LARAVEL='5.6.*' TESTBENCH='3.6.*'
+    - php: 7.1
+      env: LARAVEL='5.7.*' TESTBENCH='3.7.*'
+    - php: 7.1
+      env: LARAVEL='5.8.*' TESTBENCH='3.8.*'
+    - php: 7.2
+      env: LARAVEL='5.5.*' TESTBENCH='3.5.*'
+    - php: 7.2
+      env: LARAVEL='5.6.*' TESTBENCH='3.6.*'
+    - php: 7.2
+      env: LARAVEL='5.7.*' TESTBENCH='3.7.*'
+    - php: 7.2
+      env: LARAVEL='5.8.*' TESTBENCH='3.8.*'
+    - php: 7.3
+      env: LARAVEL='5.5.*' TESTBENCH='3.5.*'
+    - php: 7.3
+      env: LARAVEL='5.6.*' TESTBENCH='3.6.*'
+    - php: 7.3
+      env: LARAVEL='5.7.*' TESTBENCH='3.7.*'
+    - php: 7.3
+      env: LARAVEL='5.8.*' TESTBENCH='3.8.*'
+
+before_install:
+  - mysql -e 'CREATE DATABASE job_status;'
+  - travis_retry composer self-update
+  - COMPOSER_MEMORY_LIMIT=-1 travis_retry composer require --no-update --no-interaction "illuminate/support:${LARAVEL}" "illuminate/database:${LARAVEL}" "orchestra/testbench:${TESTBENCH}"
+
+install:
+  - COMPOSER_MEMORY_LIMIT=-1 travis_retry composer update --no-interaction --no-plugins --no-suggest --prefer-source ${COMPOSER_FLAGS}
 
 script:
-  - composer test
+  - vendor/bin/php-cs-fixer fix --config=.php_cs -v --dry-run --stop-on-violation
+  - vendor/bin/phpunit
+
+notifications:
+  email: false

README.md

@@ -57,6 +57,28 @@ php artisan vendor:publish --provider="Imtigger\LaravelJobStatus\LaravelJobStatu
 php artisan migrate
 ```
 
+#### 4. Improve job_id capture (optional)
+
+The first laravel event that can be captured to insert the job_id into the JobStatus model is the Queue::before event. This means that the JobStatus won't have a job_id until it is being processed for the first time.
+
+If you would like the job_id to be stored immediately you can add the `LaravelJobStatusServiceProvider` to your `config/app.php`, which tells laravel to use our `Dispatcher`.
+```php
+'providers' => [
+    ...
+    Imtigger\LaravelJobStatus\LaravelJobStatusServiceProvider::class,
+]
+```
+
+#### 5. Use a custom JobStatus model
+
+To use your own JobStatus model you can change the model in `config/job-status.php`
+
+```php
+return [
+    'model' => App\JobStatus::class,
+];
+```
+
 ### Usage
 
 In your `Job`, use `Trackable` trait and call `$this->prepareStatus()` in constructor.

composer.json

@@ -14,18 +14,20 @@
 		"queue"
     ],
     "require": {
-        "php": ">=5.6.4",
-        "illuminate/contracts": ">=5.3",
-        "illuminate/database": ">=5.3",
-        "illuminate/queue": ">=5.3",
-        "illuminate/support": ">=5.3",
+        "php": ">=7.1",
+        "illuminate/contracts": ">=5.5",
+        "illuminate/database": ">=5.5",
+        "illuminate/queue": ">=5.5",
+        "illuminate/support": ">=5.5",
         "nesbot/carbon": ">=1.21",
       "ext-json": "*"
     },
     "require-dev": {
         "phpunit/phpunit": ">=5.7",
-        "orchestra/testbench": ">=3.4",
-        "friendsofphp/php-cs-fixer": "^2.11"
+        "orchestra/testbench": ">=3.5",
+        "orchestra/database": ">=3.5",
+        "friendsofphp/php-cs-fixer": "^2.11",
+        "sempro/phpunit-pretty-print": "^1.1"
     },
     "extra": {
         "laravel": {
@@ -41,7 +43,8 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Imtigger\\LaravelJobStatus\\": "tests"
+            "Imtigger\\LaravelJobStatus\\Tests\\": "tests",
+            "Imtigger\\LaravelJobStatus\\Tests\\Data\\": "tests/_data"
         }
     },
     "scripts": {

config/job-status.php

@@ -2,4 +2,5 @@
 
 return [
     'model' => \Imtigger\LaravelJobStatus\JobStatus::class,
+    'event_manager' => \Imtigger\LaravelJobStatus\EventManagers\DefaultEventManager::class,
 ];

src/migrations/2017_05_01_000000_create_job_statuses_table.php renamed to database/migrations/2017_05_01_000000_create_job_statuses_table.php

@@ -6,7 +6,9 @@
          beStrictAboutCoversAnnotation="true"
          beStrictAboutOutputDuringTests="true"
          beStrictAboutTodoAnnotatedTests="true"
-         verbose="true">
+         verbose="true"
+         colors="true"
+         printerClass="Sempro\PHPUnitPrettyPrinter\PrettyPrinter">
     <testsuite name="default">
         <directory suffix="Test.php">tests</directory>
     </testsuite>
@@ -16,4 +18,11 @@
             <directory suffix=".php">src</directory>
         </whitelist>
     </filter>
+    <php>
+        <env name="DB_HOST" value="127.0.0.1"/>
+        <env name="DB_DATABASE" value="job_status"/>
+        <env name="DB_USERNAME" value="root"/>
+        <env name="DB_PASSWORD" value=""/>
+        <env name="APP_KEY" value="base64:c4nauF70phCYhDTA71kqmrJy+jv6CA+85PNurbM/PPw="/>
+    </php>
 </phpunit>

phpunit.xml

@@ -0,0 +1,29 @@
+<?php
+
+namespace Imtigger\LaravelJobStatus;
+
+use Closure;
+use Illuminate\Contracts\Container\Container;
+
+class Dispatcher extends \Illuminate\Bus\Dispatcher
+{
+    private $updater;
+
+    public function __construct(Container $container, Closure $queueResolver, JobStatusUpdater $updater)
+    {
+        $this->updater = $updater;
+
+        parent::__construct($container, $queueResolver);
+    }
+
+    public function dispatch($command)
+    {
+        $result = parent::dispatch($command);
+
+        $this->updater->update($command, [
+            'job_id' => $result,
+        ]);
+
+        return $result;
+    }
+}

src/Dispatcher.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Imtigger\LaravelJobStatus\EventManagers;
+
+use Carbon\Carbon;
+use Illuminate\Queue\Events\JobExceptionOccurred;
+use Illuminate\Queue\Events\JobFailed;
+use Illuminate\Queue\Events\JobProcessed;
+use Illuminate\Queue\Events\JobProcessing;
+
+class DefaultEventManager extends EventManager
+{
+    public function before(JobProcessing $event): void
+    {
+        $this->getUpdater()->update($event, [
+            'status' => $this->getEntity()::STATUS_EXECUTING,
+            'job_id' => $event->job->getJobId(),
+            'queue' => $event->job->getQueue(),
+            'started_at' => Carbon::now(),
+        ]);
+    }
+
+    public function after(JobProcessed $event): void
+    {
+        $this->getUpdater()->update($event, [
+            'status' => $this->getEntity()::STATUS_FINISHED,
+            'finished_at' => Carbon::now(),
+        ]);
+    }
+
+    public function failing(JobFailed $event): void
+    {
+        $this->getUpdater()->update($event, [
+            'status' => $this->getEntity()::STATUS_FAILED,
+            'finished_at' => Carbon::now(),
+        ]);
+    }
+
+    public function exceptionOccurred(JobExceptionOccurred $event): void
+    {
+        $this->getUpdater()->update($event, [
+            'status' => $this->getEntity()::STATUS_RETRYING,
+            'finished_at' => Carbon::now(),
+            'output' => ['message' => $event->exception->getMessage()],
+        ]);
+    }
+}

src/EventManagers/DefaultEventManager.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Imtigger\LaravelJobStatus\EventManagers;
+
+use Illuminate\Queue\Events\JobExceptionOccurred;
+use Illuminate\Queue\Events\JobFailed;
+use Illuminate\Queue\Events\JobProcessed;
+use Illuminate\Queue\Events\JobProcessing;
+use Imtigger\LaravelJobStatus\JobStatus;
+use Imtigger\LaravelJobStatus\JobStatusUpdater;
+
+abstract class EventManager
+{
+    abstract public function before(JobProcessing $event): void;
+
+    abstract public function after(JobProcessed $event): void;
+
+    abstract public function failing(JobFailed $event): void;
+
+    abstract public function exceptionOccurred(JobExceptionOccurred $event): void;
+
+    private $updater;
+
+    private $entity;
+
+    public function __construct(JobStatusUpdater $updater)
+    {
+        $this->updater = $updater;
+        $this->entity = app(config('job-status.model'));
+    }
+
+    /**
+     * @return JobStatusUpdater
+     */
+    protected function getUpdater()
+    {
+        return $this->updater;
+    }
+
+    /**
+     * @return JobStatus
+     */
+    protected function getEntity()
+    {
+        return $this->entity;
+    }
+}

src/EventManagers/EventManager.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Imtigger\LaravelJobStatus\EventManagers;
+
+use Carbon\Carbon;
+use Illuminate\Queue\Events\JobExceptionOccurred;
+use Illuminate\Queue\Events\JobFailed;
+use Illuminate\Queue\Events\JobProcessed;
+use Illuminate\Queue\Events\JobProcessing;
+
+class LegacyEventManager extends EventManager
+{
+    public function before(JobProcessing $event): void
+    {
+        $this->getUpdater()->update($event, [
+            'status' => $this->getEntity()::STATUS_EXECUTING,
+            'job_id' => $event->job->getJobId(),
+            'queue' => $event->job->getQueue(),
+            'started_at' => Carbon::now(),
+        ]);
+    }
+
+    public function after(JobProcessed $event): void
+    {
+        $this->getUpdater()->update($event, [
+            'status' => $this->getEntity()::STATUS_FINISHED,
+            'finished_at' => Carbon::now(),
+        ]);
+    }
+
+    public function failing(JobFailed $event): void
+    {
+        $this->getUpdater()->update($event, [
+            'status' => $this->getEntity()::STATUS_FAILED,
+            'finished_at' => Carbon::now(),
+        ]);
+    }
+
+    public function exceptionOccurred(JobExceptionOccurred $event): void
+    {
+        $this->getUpdater()->update($event, [
+            'status' => $this->getEntity()::STATUS_FAILED,
+            'finished_at' => Carbon::now(),
+            'output' => ['message' => $event->exception->getMessage()],
+        ]);
+    }
+}

src/EventManagers/LegacyEventManager.php

@@ -24,6 +24,7 @@
  * @property mixed  $is_executing
  * @property mixed  $is_failed
  * @property mixed  $is_finished
+ * @property mixed  $is_retrying
  * @method   static \Illuminate\Database\Query\Builder|\Imtigger\LaravelJobStatus\JobStatus whereAttempts($value)
  * @method   static \Illuminate\Database\Query\Builder|\Imtigger\LaravelJobStatus\JobStatus whereCreatedAt($value)
  * @method   static \Illuminate\Database\Query\Builder|\Imtigger\LaravelJobStatus\JobStatus whereFinishedAt($value)
@@ -45,21 +46,17 @@ class JobStatus extends Model
     const STATUS_EXECUTING = 'executing';
     const STATUS_FINISHED = 'finished';
     const STATUS_FAILED = 'failed';
+    const STATUS_RETRYING = 'retrying';
 
     public $dates = ['started_at', 'finished_at', 'created_at', 'updated_at'];
     protected $guarded = [];
 
-    /* Accessor */
-    public function getInputAttribute($value)
-    {
-        return json_decode($value, true);
-    }
-
-    public function getOutputAttribute($value)
-    {
-        return json_decode($value, true);
-    }
+    protected $casts = [
+        'input' => 'array',
+        'output' => 'array',
+    ];
 
+    /* Accessor */
     public function getProgressPercentageAttribute()
     {
         return $this->progress_max !== 0 ? round(100 * $this->progress_now / $this->progress_max) : 0;
@@ -90,15 +87,9 @@ public function getIsQueuedAttribute()
         return $this->status === self::STATUS_QUEUED;
     }
 
-    /* Mutator */
-    public function setInputAttribute($value)
-    {
-        $this->attributes['input'] = json_encode($value);
-    }
-
-    public function setOutputAttribute($value)
+    public function getIsRetryingAttribute()
     {
-        $this->attributes['output'] = json_encode($value);
+        return $this->status === self::STATUS_RETRYING;
     }
 
     public static function getAllowedStatuses()
@@ -108,6 +99,7 @@ public static function getAllowedStatuses()
             self::STATUS_EXECUTING,
             self::STATUS_FINISHED,
             self::STATUS_FAILED,
+            self::STATUS_RETRYING,
         ];
     }
 }