Merge pull request #2 from intouchinsight/fix-log-failed-jobs

Failed Jobs & Container Overrides

Author: craig-roy

src/Console/QueueWorkBatchCommand.php

@@ -15,6 +15,7 @@
 use Illuminate\Console\Command;
 use Illuminate\Contracts\Cache\Repository as Cache;
 use Illuminate\Foundation\Exceptions\Handler;
+use Illuminate\Queue\Events\JobFailed;
 use Illuminate\Queue\QueueManager;
 use Illuminate\Queue\Worker;
 use Illuminate\Queue\WorkerOptions;
@@ -56,6 +57,10 @@ public function __construct(QueueManager $manager, Worker $worker, Handler $exce
 
     public function handle()
     {
+        $this->laravel['events']->listen(JobFailed::class, function ($event) {
+            $this->logFailedJob($event);
+        });
+
         try {
             $this->runJob();
         } catch (\Throwable $e) {
@@ -109,4 +114,20 @@ protected function gatherWorkerOptions()
             maxTries: $this->option('tries'),
         );
     }
+
+    /**
+     * Store a failed job event.
+     *
+     * @param  \Illuminate\Queue\Events\JobFailed  $event
+     * @return void
+     */
+    protected function logFailedJob(JobFailed $event)
+    {
+        $this->laravel['queue.failer']->log(
+            $event->connectionName,
+            $event->job->getQueue(),
+            $event->job->getRawBody(),
+            $event->exception
+        );
+    }
 }

src/Contracts/JobContainerOverrides.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Laravel Queue for AWS Batch.
+ *
+ * @author    Luke Waite <[email protected]>
+ * @copyright 2017 Luke Waite
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ *
+ * @link      https://github.com/lukewaite/laravel-queue-aws-batch
+ */
+
+namespace LukeWaite\LaravelQueueAwsBatch\Contracts;
+
+/**
+ * Should return an array representing the contents of the containerOverrides
+ * property documented in the AWS Batch SubmitJob API reference.
+ *
+ * In the event of no overrides, should return null.
+ *
+ * https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html
+ *
+ * [
+ *   "command": ["string"],
+ *   "environment": [
+ *     [
+ *       "name": "string",
+ *       "value": "string"
+ *     ]
+ *   ],
+ *   "memory": number,
+ *   "vcpus": number
+ * ]
+ *
+ * Interface JobContainerOverrides
+ * @package LukeWaite\LaravelQueueAwsBatch\Contracts
+ */
+interface JobContainerOverrides
+{
+    public function getBatchContainerOverrides();
+}

src/Queues/BatchQueue.php

@@ -16,6 +16,7 @@
 use Illuminate\Database\Connection;
 use Illuminate\Queue\DatabaseQueue;
 use Illuminate\Queue\Jobs\DatabaseJobRecord;
+use LukeWaite\LaravelQueueAwsBatch\Contracts\JobContainerOverrides;
 use LukeWaite\LaravelQueueAwsBatch\Exceptions\JobNotFoundException;
 use LukeWaite\LaravelQueueAwsBatch\Exceptions\UnsupportedException;
 use LukeWaite\LaravelQueueAwsBatch\Jobs\BatchJob;
@@ -76,26 +77,42 @@ protected function getBatchDisplayName($job)
      * Push a raw payload to the database, then to AWS Batch, with a given delay.
      *
      * @param  string|null  $queue
-     * @param  string  $payload
+     * @param  array  $payload
      * @param  string  $jobName
      * @return int
      */
     protected function pushToBatch($queue, $payload, $jobName)
     {
         $jobId = $this->pushToDatabase($queue, $payload);
 
-        $this->batch->submitJob([
+        $payload = [
             'jobDefinition' => $this->jobDefinition,
             'jobName' => $jobName,
             'jobQueue' => $this->getQueue($queue),
             'parameters' => [
                 'jobId' => $jobId,
-            ],
-        ]);
+            ]
+        ];
+
+        if (isset($job) && is_object($job) && $this->implementsJobContainerOverrides($job)) {
+            /** @var JobContainerOverrides $job */
+            $overrides = $job->getBatchContainerOverrides();
+
+            if (isset($overrides)) {
+                $payload['containerOverrides'] = $overrides;
+            }
+        }
+
+        $this->batch->submitJob($payload);
 
         return $jobId;
     }
 
+    private function implementsJobContainerOverrides($job)
+    {
+        return $job instanceof JobContainerOverrides;
+    }
+
     public function getJobById($id)
     {
         $this->database->beginTransaction();