Merge pull request #588 from Joel-Jensen/main

[Bugfix]: Jobs with `ShouldBeEncrypted` need to be decrypted

Author: masterix21

src/Actions/MakeQueueTenantAwareAction.php

@@ -2,6 +2,7 @@
 
 namespace Spatie\Multitenancy\Actions;
 
+use Illuminate\Contracts\Encryption\Encrypter;
 use Illuminate\Queue\Events\JobProcessing;
 use Illuminate\Queue\Events\JobRetryRequested;
 use Illuminate\Support\Arr;
@@ -49,8 +50,14 @@ protected function isTenantAware(JobProcessing|JobRetryRequested $event): bool
     {
         $payload = $this->getEventPayload($event);
 
+        $serializedCommand = $payload['data']['command'];
+
+        if (! str_starts_with($serializedCommand, 'O:')) {
+            $serializedCommand = app(Encrypter::class)->decrypt($serializedCommand);
+        }
+
         try {
-            $command = unserialize($payload['data']['command']);
+            $command = unserialize($serializedCommand);
         } catch (Throwable) {
             /**
              * We might need the tenant to unserialize jobs as models could
@@ -62,7 +69,7 @@ protected function isTenantAware(JobProcessing|JobRetryRequested $event): bool
                 $tenant?->makeCurrent();
             }
 
-            $command = unserialize($payload['data']['command']);
+            $command = unserialize($serializedCommand);
         }
 
         $job = $this->getJobFromQueueable($command);

tests/Feature/TenantAwareJobs/QueueIsTenantAwareByDefaultTest.php

@@ -4,6 +4,7 @@
 use Illuminate\Queue\Events\JobFailed;
 use Illuminate\Support\Facades\Event;
 use Spatie\Multitenancy\Models\Tenant;
+use Spatie\Multitenancy\Tests\Feature\TenantAwareJobs\TestClasses\EncryptedTenantAware;
 use Spatie\Multitenancy\Tests\Feature\TenantAwareJobs\TestClasses\NotTenantAwareTestJob;
 use Spatie\Multitenancy\Tests\Feature\TenantAwareJobs\TestClasses\TenantAwareTestJob;
 use Spatie\Multitenancy\Tests\Feature\TenantAwareJobs\TestClasses\TestJob;
@@ -102,3 +103,16 @@
     $currentTenantIdInJob = $this->valuestore->get('tenantId');
     expect($currentTenantIdInJob)->toBeNull();
 });
+
+it('will decrypt encrypted jobs', function () {
+    config()->set('multitenancy.queues_are_tenant_aware_by_default', true);
+
+    $this->tenant->makeCurrent();
+
+    $job = new EncryptedTenantAware($this->valuestore);
+    app(Dispatcher::class)->dispatch($job);
+
+    $this->artisan('queue:work --once')->assertExitCode(0);
+
+    Event::assertNotDispatched(JobFailed::class);
+});

tests/Feature/TenantAwareJobs/TestClasses/EncryptedTenantAware.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Spatie\Multitenancy\Tests\Feature\TenantAwareJobs\TestClasses;
+
+use Illuminate\Contracts\Queue\ShouldBeEncrypted;
+use Spatie\Multitenancy\Jobs\TenantAware;
+
+class EncryptedTenantAware extends TestJob implements TenantAware, ShouldBeEncrypted
+{
+}