Bring back MakeQueueTenantAwareAction

Author: nolanpro

ProcessMaker/Multitenancy/MakeQueueTenantAwareAction.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ProcessMaker\Multitenancy;
+
+use Spatie\Multitenancy\Actions\MakeQueueTenantAwareAction as BaseMakeQueueTenantAwareAction;
+
+class MakeQueueTenantAwareAction extends BaseMakeQueueTenantAwareAction
+{
+    /**
+     * We're handling tenant aware queues manually, however, we still need to implement this because for some
+     * reason the Spatie package calls it in Multitenancy::start(), weather it's a configured action or not.
+     */
+    public function execute() : void
+    {
+        // Do nothing
+    }
+}

ProcessMaker/Providers/ProcessMakerServiceProvider.php

@@ -11,6 +11,7 @@
 use Illuminate\Notifications\Events\NotificationSent;
 use Illuminate\Queue\Events\JobAttempted;
 use Illuminate\Queue\Events\JobProcessing;
+use Illuminate\Queue\Events\JobRetryRequested;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Env;
 use Illuminate\Support\Facades;
@@ -236,52 +237,75 @@ public function register(): void
     }
 
     /**
-     * Register app-level events.
+     * In multitenancy, we need to bootstrap a new app with the tenant id set.
+     * This is because queue workers are long-running processes that are not
+     * tenant aware.
      */
-    protected static function registerEvents(): void
+    private static function bootstrapTenantApp(JobProcessing|JobRetryRequested $event): void
     {
-        Facades\Event::listen(JobProcessing::class, function ($event) {
-            Context::hydrate($event->job->payload()['illuminate:log:context'] ?? null);
-            $tenantId = Context::get(config('multitenancy.current_tenant_context_key'));
-            if ($tenantId) {
-                if (!method_exists($event->job, 'getRedisQueue')) {
-                    // Not a redis job
-                    return;
-                }
+        Context::hydrate($event->job->payload()['illuminate:log:context'] ?? null);
+        $tenantId = Context::get(config('multitenancy.current_tenant_context_key'));
+        if ($tenantId) {
+            if (!method_exists($event->job, 'getRedisQueue')) {
+                // Not a redis job
+                return;
+            }
 
-                // Save the landlord's config values so we can reset them later
-                if (self::$landlordValues === null) {
-                    foreach (TenantBootstrapper::$landlordKeysToSave as $key) {
-                        self::$landlordValues[$key] = $_SERVER[$key] ?? '';
-                    }
+            // Save the landlord's config values so we can reset them later
+            if (self::$landlordValues === null) {
+                foreach (TenantBootstrapper::$landlordKeysToSave as $key) {
+                    self::$landlordValues[$key] = $_SERVER[$key] ?? '';
                 }
+            }
 
-                // Create a new tenant app instance
-                $_SERVER['TENANT'] = $tenantId;
-                $_ENV['TENANT'] = $tenantId;
-                $tenantApp = require app()->bootstrapPath('app.php');
-                $tenantApp->instance('landlordValues', self::$landlordValues);
-                $tenantApp->make(\Illuminate\Contracts\Console\Kernel::class)->bootstrap();
+            // Create a new tenant app instance
+            $_SERVER['TENANT'] = $tenantId;
+            $_ENV['TENANT'] = $tenantId;
+            $tenantApp = require app()->bootstrapPath('app.php');
+            $tenantApp->instance('landlordValues', self::$landlordValues);
+            $tenantApp->make(\Illuminate\Contracts\Console\Kernel::class)->bootstrap();
 
-                // Change the job's app service container to the tenant app
-                $event->job->getRedisQueue()->setContainer($tenantApp);
-            }
-        });
+            // Change the job's app service container to the tenant app
+            $event->job->getRedisQueue()->setContainer($tenantApp);
+        }
+    }
 
-        Facades\Event::listen(JobAttempted::class, function ($event) {
-            if (!method_exists($event->job, 'getRedisQueue')) {
-                // Not a redis job
-                return;
-            }
+    private static function resetTenantApp($event): void
+    {
+        if (!method_exists($event->job, 'getRedisQueue')) {
+            // Not a redis job
+            return;
+        }
 
-            unset($_SERVER['TENANT']);
-            unset($_ENV['TENANT']);
+        unset($_SERVER['TENANT']);
+        unset($_ENV['TENANT']);
 
-            // Restore the original values since the tenant boostrapper modified them
-            foreach (self::$landlordValues as $key => $value) {
-                $_SERVER[$key] = $value;
-                $_ENV[$key] = $value;
-            }
+        if (!self::$landlordValues) {
+            return;
+        }
+
+        // Restore the original values since the tenant boostrapper modified them
+        foreach (self::$landlordValues as $key => $value) {
+            $_SERVER[$key] = $value;
+            $_ENV[$key] = $value;
+        }
+    }
+
+    /**
+     * Register app-level events.
+     */
+    protected static function registerEvents(): void
+    {
+        Facades\Event::listen(JobProcessing::class, function (JobProcessing $event) {
+            self::bootstrapTenantApp($event);
+        });
+
+        Facades\Event::listen(JobRetryRequested::class, function (JobRetryRequested $event) {
+            self::bootstrapTenantApp($event);
+        });
+
+        Facades\Event::listen(JobAttempted::class, function (JobAttempted $event) {
+            self::resetTenantApp($event);
         });
 
         // Listen to the events for our core screen

config/multitenancy.php

@@ -87,6 +87,7 @@
     'actions' => [
         'make_tenant_current_action' => MakeTenantCurrentAction::class,
         'forget_current_tenant_action' => ForgetCurrentTenantAction::class,
+        'make_queue_tenant_aware_action' => ProcessMaker\Multitenancy\MakeQueueTenantAwareAction::class,
         'migrate_tenant' => MigrateTenantAction::class,
     ],