[12.x] Set job instance on "failed" command instance (#55617)

* Add failing test

* Update test to expect the new argument

* Set the job instance when creating a new instance of command after failure

* Update CallQueuedHandler.php

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: willrowe

src/Illuminate/Queue/CallQueuedHandler.php

@@ -274,12 +274,17 @@ protected function ensureUniqueJobLockIsReleasedViaContext()
      * @param  array  $data
      * @param  \Throwable|null  $e
      * @param  string  $uuid
+     * @param  \Illuminate\Contracts\Queue\Job|null  $job
      * @return void
      */
-    public function failed(array $data, $e, string $uuid)
+    public function failed(array $data, $e, string $uuid, ?Job $job = null)
     {
         $command = $this->getCommand($data);
 
+        if (! is_null($job)) {
+            $command = $this->setJobInstanceIfNecessary($job, $command);
+        }
+
         if (! $command instanceof ShouldBeUniqueUntilProcessing) {
             $this->ensureUniqueJobLockIsReleased($command);
         }

src/Illuminate/Queue/Jobs/Job.php

@@ -251,7 +251,7 @@ protected function failed($e)
         [$class, $method] = JobName::parse($payload['job']);
 
         if (method_exists($this->instance = $this->resolve($class), 'failed')) {
-            $this->instance->failed($payload['data'], $e, $payload['uuid'] ?? '');
+            $this->instance->failed($payload['data'], $e, $payload['uuid'] ?? '', $this);
         }
     }
 

tests/Queue/QueueBeanstalkdJobTest.php

@@ -7,6 +7,7 @@
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Queue\Events\JobFailed;
 use Illuminate\Queue\Jobs\BeanstalkdJob;
+use Illuminate\Queue\Jobs\Job;
 use Mockery as m;
 use Pheanstalk\Contract\JobIdInterface;
 use Pheanstalk\Contract\PheanstalkManagerInterface;
@@ -39,7 +40,7 @@ public function testFailProperlyCallsTheJobHandler()
         $job->getPheanstalkJob()->shouldReceive('getData')->andReturn(json_encode(['job' => 'foo', 'uuid' => 'test-uuid', 'data' => ['data']]));
         $job->getContainer()->shouldReceive('make')->once()->with('foo')->andReturn($handler = m::mock(BeanstalkdJobTestFailedTest::class));
         $job->getPheanstalk()->shouldReceive('delete')->once()->with($job->getPheanstalkJob())->andReturnSelf();
-        $handler->shouldReceive('failed')->once()->with(['data'], m::type(Exception::class), 'test-uuid');
+        $handler->shouldReceive('failed')->once()->with(['data'], m::type(Exception::class), 'test-uuid', m::type(Job::class));
         $job->getContainer()->shouldReceive('make')->once()->with(Dispatcher::class)->andReturn($events = m::mock(Dispatcher::class));
         $events->shouldReceive('dispatch')->once()->with(m::type(JobFailed::class))->andReturnNull();
 

tests/Queue/QueueSyncQueueTest.php

@@ -61,6 +61,28 @@ public function testFailedJobGetsHandledWhenAnExceptionIsThrown()
         Container::setInstance();
     }
 
+    public function testFailedJobHasAccessToJobInstance()
+    {
+        unset($_SERVER['__sync.failed']);
+
+        $sync = new SyncQueue;
+        $container = new Container;
+        $container->bind(\Illuminate\Contracts\Events\Dispatcher::class, \Illuminate\Events\Dispatcher::class);
+        $container->bind(\Illuminate\Contracts\Bus\Dispatcher::class, \Illuminate\Bus\Dispatcher::class);
+        $container->bind(\Illuminate\Contracts\Container\Container::class, \Illuminate\Container\Container::class);
+        $sync->setContainer($container);
+
+        SyncQueue::createPayloadUsing(function ($connection, $queue, $payload) {
+            return ['data' => ['extra' => 'extraValue']];
+        });
+
+        try {
+            $sync->push(new FailingSyncQueueJob());
+        } catch (LogicException $e) {
+            $this->assertSame('extraValue', $_SERVER['__sync.failed']);
+        }
+    }
+
     public function testCreatesPayloadObject()
     {
         $sync = new SyncQueue;
@@ -177,6 +199,23 @@ public function failed()
     }
 }
 
+class FailingSyncQueueJob implements ShouldQueue
+{
+    use InteractsWithQueue;
+
+    public function handle()
+    {
+        throw new LogicException();
+    }
+
+    public function failed()
+    {
+        $payload = $this->job->payload();
+
+        $_SERVER['__sync.failed'] = $payload['data']['extra'];
+    }
+}
+
 class SyncQueueJob implements ShouldQueue
 {
     use InteractsWithQueue;