[4.x] Add batch tenancy queue bootstrapper

.github/workflows/ci.yml

@@ -5,9 +5,9 @@ env:
 
 on:
   push:
-    branches: [ 3.x, 2.x, master ]
+    branches: [ 3.x, 2.x ]
   pull_request:
-    branches: [ 3.x, 2.x, master ]
+    branches: [ 3.x, 2.x ]
 
 jobs:
   tests:

assets/config.php

@@ -33,6 +33,7 @@
         Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper::class,
         Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper::class,
         // Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper::class, // Note: phpredis is needed
+        // Stancl\Tenancy\Bootstrappers\BatchTenancyBootstrapper::class,
     ],
 
     /**

src/Bootstrappers/BatchTenancyBootstrapper.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Stancl\Tenancy\Bootstrappers;
+
+use Illuminate\Bus\BatchRepository;
+use Illuminate\Bus\DatabaseBatchRepository;
+use Illuminate\Support\Facades\DB;
+use ReflectionClass;
+use Stancl\Tenancy\Contracts\TenancyBootstrapper;
+use Stancl\Tenancy\Contracts\Tenant;
+
+class BatchTenancyBootstrapper implements TenancyBootstrapper
+{
+    /**
+     * The database previous connection instance.
+     *
+     * @var \Illuminate\Database\Connection
+     */
+    protected $previousConnection = null;
+
+    public function bootstrap(Tenant $tenant)
+    {
+        $batchRepository = app(BatchRepository::class);
+
+        if ($batchRepository instanceof DatabaseBatchRepository) {
+            /**
+             * Access the resolved batch repository instance and update its connection to use the tenant connection
+             */
+            $batchRepositoryReflection = new ReflectionClass($batchRepository);
+            $connectionProperty        = $batchRepositoryReflection->getProperty('connection');
+            $connectionProperty->setAccessible(true);
+            $connection = $connectionProperty->getValue($batchRepository);
+
+            $this->previousConnection = $connection;
+
+            $connectionProperty->setValue($batchRepository, DB::connection('tenant'));
+        }
+    }
+
+    public function revert()
+    {
+        if ($this->previousConnection) {
+            /**
+             * Access the resolved batch repository instance and replace its connection with the previously replaced one
+             */
+            $batchRepository = app(BatchRepository::class);
+
+            $batchRepositoryReflection = new ReflectionClass($batchRepository);
+            $connectionProperty        = $batchRepositoryReflection->getProperty('connection');
+            $connectionProperty->setAccessible(true);
+
+            $connectionProperty->setValue($batchRepository, $this->previousConnection);
+            $this->previousConnection = null;
+        }
+    }
+}

tests/BatchTest.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Stancl\Tenancy\Tests;
+
+use Illuminate\Bus\BatchRepository;
+use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Str;
+use ReflectionClass;
+use Stancl\Tenancy\Bootstrappers\BatchTenancyBootstrapper;
+use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
+use Stancl\Tenancy\Events\TenancyEnded;
+use Stancl\Tenancy\Events\TenancyInitialized;
+use Stancl\Tenancy\Listeners\BootstrapTenancy;
+use Stancl\Tenancy\Listeners\RevertToCentralContext;
+use Stancl\Tenancy\Tests\Etc\Tenant;
+
+class BatchTest extends TestCase
+{
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->app->singleton(BatchTenancyBootstrapper::class);
+
+        config([
+            'tenancy.bootstrappers' => [
+                DatabaseTenancyBootstrapper::class,
+                BatchTenancyBootstrapper::class,
+            ],
+        ]);
+
+        Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
+        Event::listen(TenancyEnded::class, RevertToCentralContext::class);
+    }
+
+    /** @test */
+    public function batch_repository_is_set_to_tenant_connection_and_reverted()
+    {
+        if (! version_compare(app()->version(), '8.0', '>=')) {
+            $this->markTestSkipped('Job batches are only supported in Laravel 8+');
+        }
+
+        $tenant = Tenant::create();
+
+        $this->assertEquals('central', $this->getBatchRepositoryConnectionName(), 'Expected initial connection to be central');
+
+        tenancy()->initialize($tenant);
+
+        $this->assertEquals('tenant', $this->getBatchRepositoryConnectionName(), 'Expected tenant connection to be tenant');
+
+        tenancy()->end();
+
+        $this->assertEquals('central', $this->getBatchRepositoryConnectionName(), 'Expected the reverted connection to be central');
+    }
+
+
+    private function getBatchRepositoryConnectionName(): string
+    {
+        $batchRepository = app(BatchRepository::class);
+
+        $batchRepositoryReflection = new ReflectionClass($batchRepository);
+        $connectionProperty        = $batchRepositoryReflection->getProperty('connection');
+        $connectionProperty->setAccessible(true);
+        $connection = $connectionProperty->getValue($batchRepository);
+
+        return $connection->getName();
+    }
+
+}