[12.x] Introduce Job@resolveQueuedJobClass() (#54613)

* introduce Job@resolveQueuedJobClass

* remove unused method

* style

Author: cosmastech

src/Illuminate/Contracts/Queue/Job.php

@@ -133,14 +133,23 @@ public function retryUntil();
     public function getName();
 
     /**
-     * Get the resolved name of the queued job class.
+     * Get the display name of the queued job class.
      *
      * Resolves the name of "wrapped" jobs such as class-based handlers.
      *
      * @return string
      */
     public function resolveName();
 
+    /**
+     * Get the class of the queued job.
+     *
+     * Resolves the class of "wrapped" jobs such as class-based handlers.
+     *
+     * @return string
+     */
+    public function resolveQueuedJobClass();
+
     /**
      * Get the name of the connection the job belongs to.
      *

src/Illuminate/Queue/CallQueuedHandler.php

@@ -218,7 +218,7 @@ protected function ensureUniqueJobLockIsReleased($command)
      */
     protected function handleModelNotFound(Job $job, $e)
     {
-        $class = $job->resolveName();
+        $class = $job->resolveQueuedJobClass();
 
         try {
             $reflectionClass = new ReflectionClass($class);

src/Illuminate/Queue/Jobs/Job.php

@@ -357,7 +357,7 @@ public function getName()
     }
 
     /**
-     * Get the resolved name of the queued job class.
+     * Get the resolved display name of the queued job class.
      *
      * Resolves the name of "wrapped" jobs such as class-based handlers.
      *
@@ -368,6 +368,18 @@ public function resolveName()
         return JobName::resolve($this->getName(), $this->payload());
     }
 
+    /**
+     * Get the class of the queued job.
+     *
+     * Resolves the class of "wrapped" jobs such as class-based handlers.
+     *
+     * @return string
+     */
+    public function resolveQueuedJobClass()
+    {
+        return JobName::resolveClassName($this->getName(), $this->payload());
+    }
+
     /**
      * Get the name of the connection the job belongs to.
      *

src/Illuminate/Queue/Jobs/JobName.php

@@ -32,4 +32,20 @@ public static function resolve($name, $payload)
 
         return $name;
     }
+
+    /**
+     * Get the class name for queued job class.
+     *
+     * @param  string  $name
+     * @param  array<string, mixed>  $payload
+     * @return string
+     */
+    public static function resolveClassName($name, $payload)
+    {
+        if (is_string($payload['data']['commandName'] ?? null)) {
+            return $payload['data']['commandName'];
+        }
+
+        return $name;
+    }
 }

tests/Integration/Queue/CallQueuedHandlerTest.php

@@ -90,7 +90,7 @@ public function testJobIsMarkedAsFailedIfModelNotFoundExceptionIsThrown()
         $instance = new CallQueuedHandler(new Dispatcher($this->app), $this->app);
 
         $job = m::mock(Job::class);
-        $job->shouldReceive('resolveName')->andReturn(__CLASS__);
+        $job->shouldReceive('resolveQueuedJobClass')->andReturn(__CLASS__);
         $job->shouldReceive('fail')->once();
 
         $instance->call($job, [
@@ -106,7 +106,7 @@ public function testJobIsDeletedIfHasDeleteProperty()
 
         $job = m::mock(Job::class);
         $job->shouldReceive('getConnectionName')->andReturn('connection');
-        $job->shouldReceive('resolveName')->andReturn(CallQueuedHandlerExceptionThrower::class);
+        $job->shouldReceive('resolveQueuedJobClass')->andReturn(CallQueuedHandlerExceptionThrower::class);
         $job->shouldReceive('markAsFailed')->never();
         $job->shouldReceive('isDeleted')->andReturn(false);
         $job->shouldReceive('delete')->once();
@@ -127,7 +127,7 @@ public function testJobIsDeletedIfHasDeleteAttribute()
 
         $job = m::mock(Job::class);
         $job->shouldReceive('getConnectionName')->andReturn('connection');
-        $job->shouldReceive('resolveName')->andReturn(CallQueuedHandlerAttributeExceptionThrower::class);
+        $job->shouldReceive('resolveQueuedJobClass')->andReturn(CallQueuedHandlerAttributeExceptionThrower::class);
         $job->shouldReceive('markAsFailed')->never();
         $job->shouldReceive('isDeleted')->andReturn(false);
         $job->shouldReceive('delete')->once();

tests/Integration/Queue/DeleteModelWhenMissingTest.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Queue;
+
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Schema;
+use Orchestra\Testbench\Attributes\WithMigration;
+
+#[WithMigration]
+#[WithMigration('queue')]
+class DeleteModelWhenMissingTest extends QueueTestCase
+{
+    protected function defineEnvironment($app)
+    {
+        parent::defineEnvironment($app);
+        $app['config']->set('queue.default', 'database');
+        $this->driver = 'database';
+    }
+
+    protected function defineDatabaseMigrations()
+    {
+        Schema::create('delete_model_test_models', function (Blueprint $table) {
+            $table->id();
+            $table->string('name');
+        });
+    }
+
+    protected function destroyDatabaseMigrations()
+    {
+        Schema::dropIfExists('delete_model_test_models');
+    }
+
+    #[\Override]
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        DeleteMissingModelJob::$handled = false;
+    }
+
+    public function test_deleteModelWhenMissing_and_display_name(): void
+    {
+        $model = MyTestModel::query()->create(['name' => 'test']);
+
+        DeleteMissingModelJob::dispatch($model);
+
+        MyTestModel::query()->where('name', 'test')->delete();
+
+        $this->runQueueWorkerCommand(['--once' => '1']);
+
+        $this->assertFalse(DeleteMissingModelJob::$handled);
+        $this->assertNull(\DB::table('failed_jobs')->first());
+    }
+}
+
+class DeleteMissingModelJob implements ShouldQueue
+{
+    use InteractsWithQueue;
+    use Dispatchable;
+    use SerializesModels;
+
+    public static bool $handled = false;
+
+    public $deleteWhenMissingModels = true;
+
+    public function __construct(public MyTestModel $model)
+    {
+    }
+
+    public function displayName(): string
+    {
+        return 'sorry-ma-forgot-to-take-out-the-trash';
+    }
+
+    public function handle()
+    {
+        self::$handled = true;
+    }
+}
+
+class MyTestModel extends Model
+{
+    protected $table = 'delete_model_test_models';
+
+    public $timestamps = false;
+
+    protected $guarded = [];
+}

tests/Queue/QueueWorkerTest.php

@@ -662,6 +662,11 @@ public function timeout()
     {
         return time() + 60;
     }
+
+    public function resolveQueuedJobClass()
+    {
+        return 'WorkerFakeJob';
+    }
 }
 
 class LoopBreakerException extends RuntimeException