Merge branch 'master' into feature/storage-url

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,21 +0,0 @@
----
-name: "\U0001F41B Bug Report"
-about: Report unexpected behavior with stancl/tenancy.
-title: ''
-labels: bug
-assignees: stancl
-
----
-
-#### Describe the bug
-<!-- A clear and concise description of what the bug is. -->
-
-#### Steps to reproduce
-
-
-#### Expected behavior
-A clear and concise description of what you expected to happen.
-
-#### Your setup
- - Laravel version: [e.g. 8.2.0]
- - stancl/tenancy version: [e.g. 3.1.0]

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,48 @@
+name: 🐛 Bug Report
+description: Report unexpected behavior with stancl/tenancy.
+labels: ["bug"]
+assignees:
+  - stancl
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before opening a bug report, please search for the behaviour in the existing issues.
+        ---
+        Thank you for taking the time to file a bug report. To address this bug as fast as possible, we need some information.
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Bug description
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: Step-by-step guide for reproducing the bug in a fresh Laravel application.
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+
+  - type: input
+    id: laravel-version
+    attributes:
+      label: Laravel version
+      placeholder: "e.g. 8.2.0"
+    validations:
+      required: true
+  - type: input
+    id: tenancy-version
+    attributes:
+      label: stancl/tenancy version
+      placeholder: "e.g. 3.1.0"
+    validations:
+      required: true

.github/workflows/ci.yml

@@ -5,9 +5,9 @@ env:
 
 on:
   push:
-    branches: [ 3.x, 2.x, master ]
+    branches: [ master ]
   pull_request:
-    branches: [ 3.x, 2.x, master ]
+    branches: [ master ]
 
 jobs:
   tests:
@@ -15,8 +15,8 @@ jobs:
 
     strategy:
       matrix:
-        php: ["7.4", "8.0"]
+        php: ["8.1"]
-        laravel: ["^6.0", "^8.0"]
+        laravel: ["^9.0"]
 
     steps:
     - uses: actions/checkout@v2
@@ -26,7 +26,3 @@ jobs:
       run: docker-compose exec -T test composer require --no-interaction "laravel/framework:${{ matrix.laravel }}"
     - name: Run tests
       run: ./test
-    - name: Send code coverage to codecov
-      env:
-        CODECOV_TOKEN: 24382d15-84e7-4a55-bea4-c4df96a24a9b
-      run: bash <(curl -s https://codecov.io/bash)

.gitignore

@@ -8,3 +8,6 @@ psysh
 phpunit_var_*.xml
 coverage/
 clover.xml
+tenant-schema-test.dump
+tests/Etc/tmp/queuetest.json
+docker-compose.override.yml

CONTRIBUTING.md

@@ -9,3 +9,16 @@ StyleCI will flag code style violations in your pull requests.
 Run `docker-compose up -d` to start the containers. Then run `./test` to run the tests.
 
 When you're done testing, run `docker-compose down` to shut down the containers.
+
+### Docker on M1
+
+You can add:
+```yaml
+services:
+  mysql:
+    platform: linux/amd64
+  mysql2:
+    platform: linux/amd64
+```
+
+to `docker-compose.override.yml` to make `docker-compose up-d` work on M1.

Dockerfile

@@ -24,13 +24,13 @@ ENV LANG=en_GB.UTF-8
 
 # install some OS packages we need
 RUN apt-get update
-RUN apt-get install -y --no-install-recommends libfreetype6-dev libjpeg62-turbo-dev libpng-dev libgmp-dev libldap2-dev netcat curl sqlite3 libsqlite3-dev libpq-dev libzip-dev unzip vim-tiny gosu git
+RUN apt-get install -y --no-install-recommends libfreetype6-dev libjpeg62-turbo-dev libpng-dev libgmp-dev libldap2-dev netcat curl mariadb-client sqlite3 libsqlite3-dev libpq-dev libzip-dev unzip vim-tiny gosu git
     # install php extensions
 RUN docker-php-ext-configure pgsql -with-pgsql=/usr/local/pgsql \
     # && if [ "${PHP_VERSION}" = "7.4" ]; then docker-php-ext-configure gd --with-freetype --with-jpeg; else docker-php-ext-configure gd --with-freetype-dir=/usr/include/ --with-jpeg-dir=/usr/include/; fi \
     && docker-php-ext-install -j$(nproc) gd pdo pdo_mysql pdo_pgsql pdo_sqlite pgsql zip gmp bcmath pcntl ldap sysvmsg exif \
     # install the redis php extension
-    && pecl install redis-5.3.2 \
+    && pecl install redis-5.3.7 \
     && docker-php-ext-enable redis \
     # install the pcov extention
     && pecl install pcov \

README.md

@@ -3,10 +3,9 @@
 </p>
 
 <p align="center">
-    <a href="https://laravel.com"><img alt="Laravel 6.x/7.x/8.x" src="https://img.shields.io/badge/laravel-6.x/7.x/8.x-red.svg"></a>
+    <a href="https://laravel.com"><img alt="Laravel 9.x" src="https://img.shields.io/badge/laravel-9.x-red.svg"></a>
     <a href="https://packagist.org/packages/stancl/tenancy"><img alt="Latest Stable Version" src="https://poser.pugx.org/stancl/tenancy/version"></a>
     <a href="https://github.com/stancl/tenancy/actions"><img alt="GitHub Actions CI status" src="https://github.com/stancl/tenancy/workflows/CI/badge.svg"></a>
-    <a href="https://codecov.io/gh/stancl/tenancy"><img alt="codecov" src="https://codecov.io/gh/stancl/tenancy/branch/3.x/graph/badge.svg"></a>
     <a href="https://github.com/stancl/tenancy/blob/3.x/DONATIONS.md"><img alt="Donate" src="https://img.shields.io/badge/Donate-%3C3-red"></a>
 </p>
 

assets/config.php

@@ -42,7 +42,8 @@ return [
         'central_connection' => env('DB_CONNECTION', 'central'),
 
         /**
-         * Connection used as a "template" for the tenant database connection.
+         * Connection used as a "template" for the dynamically created tenant database connection.
+         * Note: don't name your template connection tenant. That name is reserved by package.
          */
         'template_tenant_connection' => null,
 

composer.json

@@ -11,17 +11,16 @@
     ],
     "require": {
         "ext-json": "*",
-        "illuminate/support": "^6.0|^7.0|^8.0",
+        "illuminate/support": "^6.0|^7.0|^8.0|^9.0",
         "facade/ignition-contracts": "^1.0",
         "ramsey/uuid": "^3.7|^4.0",
-        "stancl/jobpipeline": "^1.0",
+        "stancl/jobpipeline": "dev-master",
-        "stancl/virtualcolumn": "^1.0"
+        "stancl/virtualcolumn": "dev-master"
     },
     "require-dev": {
-        "vlucas/phpdotenv": "^3.3|^4.0|^5.0",
+        "laravel/framework": "^6.0|^7.0|^8.0|^9.0",
-        "laravel/framework": "^6.0|^7.0|^8.0",
+        "orchestra/testbench": "^4.0|^5.0|^6.0|^7.0",
-        "orchestra/testbench-browser-kit": "^4.0|^5.0|^6.0",
+        "league/flysystem-aws-s3-v3": "^1.0|^3.0",
-        "league/flysystem-aws-s3-v3": "~1.0",
         "doctrine/dbal": "^2.10",
         "spatie/valuestore": "^1.2.5"
     },
@@ -49,6 +48,12 @@
             }
         }
     },
+    "scripts": {
+        "docker-up": "PHP_VERSION=8.0.11 docker-compose up -d",
+        "docker-down": "PHP_VERSION=8.0.11 docker-compose down",
+        "docker-rebuild": "PHP_VERSION=8.0.11 docker-compose up -d --no-deps --build",
+        "test": "PHP_VERSION=8.0.11 ./test"
+    },
     "minimum-stability": "dev",
     "prefer-stable": true
 }

docker-compose.yml

@@ -4,7 +4,7 @@ services:
         build:
             context: .
             args:
-              PHP_VERSION: ${PHP_VERSION}
+              PHP_VERSION: ${PHP_VERSION:-8.1}
         depends_on:
             mysql:
                 condition: service_healthy

src/Bootstrappers/DatabaseTenancyBootstrapper.php

@@ -6,6 +6,7 @@ namespace Stancl\Tenancy\Bootstrappers;
 
 use Stancl\Tenancy\Contracts\TenancyBootstrapper;
 use Stancl\Tenancy\Contracts\Tenant;
+use Stancl\Tenancy\Contracts\TenantWithDatabase;
 use Stancl\Tenancy\Database\DatabaseManager;
 use Stancl\Tenancy\Exceptions\TenantDatabaseDoesNotExistException;
 

src/Bootstrappers/FilesystemTenancyBootstrapper.php

@@ -5,7 +5,6 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Bootstrappers;
 
 use Illuminate\Contracts\Foundation\Application;
-use Illuminate\Filesystem\FilesystemAdapter;
 use Illuminate\Support\Facades\Storage;
 use League\Flysystem\Adapter\Local as LocalAdapter;
 use Stancl\Tenancy\Contracts\TenancyBootstrapper;
@@ -55,20 +54,24 @@ class FilesystemTenancyBootstrapper implements TenancyBootstrapper
         }
 
         // Storage facade
-        foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) {
+        Storage::forgetDisk($this->app['config']['tenancy.filesystem.disks']);
-            /** @var FilesystemAdapter $filesystemDisk */
-            $filesystemDisk = Storage::disk($disk);
-            $this->originalPaths['disks']['path'][$disk] = $filesystemDisk->getAdapter()->getPathPrefix();
 
-            if ($root = str_replace(
+        foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) {
-                '%storage_path%',
+            // todo@v4 \League\Flysystem\PathPrefixer is making this a lot more painful in flysystem v2
-                storage_path(),
+
-                $this->app['config']["tenancy.filesystem.root_override.{$disk}"] ?? ''
+            $originalRoot = $this->app['config']["filesystems.disks.{$disk}.root"];
-            )) {
+            $this->originalPaths['disks']['path'][$disk] = $originalRoot;
-                $filesystemDisk->getAdapter()->setPathPrefix($finalPrefix = $root);
+
-            } else {
+            $finalPrefix = str_replace(
-                $root = $this->app['config']["filesystems.disks.{$disk}.root"];
+                ['%storage_path%', '%tenant%'],
-                $filesystemDisk->getAdapter()->setPathPrefix($finalPrefix = $root . "/{$suffix}");
+                [storage_path(), $tenant->getTenantKey()],
+                $this->app['config']["tenancy.filesystem.root_override.{$disk}"] ?? '',
+            );
+
+            if (! $finalPrefix) {
+                $finalPrefix = $originalRoot
+                    ? rtrim($originalRoot, '/') . '/'. $suffix
+                    : $suffix;
             }
 
             $this->app['config']["filesystems.disks.{$disk}.root"] = $finalPrefix;
@@ -101,6 +104,7 @@ class FilesystemTenancyBootstrapper implements TenancyBootstrapper
         $this->app['url']->setAssetRoot($this->app['config']['app.asset_url']);
 
         // Storage facade
+        Storage::forgetDisk($this->app['config']['tenancy.filesystem.disks']);
         foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) {
             /** @var FilesystemAdapter $filesystemDisk */
             $filesystemDisk = Storage::disk($disk);

src/Bootstrappers/QueueTenancyBootstrapper.php

@@ -4,14 +4,18 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Bootstrappers;
 
+use Illuminate\Support\Str;
 use Illuminate\Config\Repository;
-use Illuminate\Contracts\Events\Dispatcher;
-use Illuminate\Contracts\Foundation\Application;
-use Illuminate\Queue\Events\JobProcessing;
 use Illuminate\Queue\QueueManager;
-use Illuminate\Support\Testing\Fakes\QueueFake;
-use Stancl\Tenancy\Contracts\TenancyBootstrapper;
 use Stancl\Tenancy\Contracts\Tenant;
+use Illuminate\Queue\Events\JobFailed;
+use Illuminate\Queue\Events\JobProcessed;
+use Illuminate\Queue\Events\JobProcessing;
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Queue\Events\JobRetryRequested;
+use Illuminate\Support\Testing\Fakes\QueueFake;
+use Illuminate\Contracts\Foundation\Application;
+use Stancl\Tenancy\Contracts\TenancyBootstrapper;
 
 class QueueTenancyBootstrapper implements TenancyBootstrapper
 {
@@ -21,6 +25,16 @@ class QueueTenancyBootstrapper implements TenancyBootstrapper
     /** @var QueueManager */
     protected $queue;
 
+    /**
+     * Don't persist the same tenant across multiple jobs even if they have the same tenant ID.
+     *
+     * This is useful when you're changing the tenant's state (e.g. properties in the `data` column) and want the next job to initialize tenancy again
+     * with the new data. Features like the Tenant Config are only executed when tenancy is initialized, so the re-initialization is needed in some cases.
+     *
+     * @var bool
+     */
+    public static $forceRefresh = false;
+
     /**
      * The normal constructor is only executed after tenancy is bootstrapped.
      * However, we're registering a hook to initialize tenancy. Therefore,
@@ -28,7 +42,7 @@ class QueueTenancyBootstrapper implements TenancyBootstrapper
      */
     public static function __constructStatic(Application $app)
     {
-        static::setUpJobListener($app->make(Dispatcher::class));
+        static::setUpJobListener($app->make(Dispatcher::class), $app->runningUnitTests());
     }
 
     public function __construct(Repository $config, QueueManager $queue)
@@ -39,25 +53,90 @@ class QueueTenancyBootstrapper implements TenancyBootstrapper
         $this->setUpPayloadGenerator();
     }
 
-    protected static function setUpJobListener($dispatcher)
+    protected static function setUpJobListener($dispatcher, $runningTests)
     {
-        $dispatcher->listen(JobProcessing::class, function ($event) {
+        $previousTenant = null;
-            $tenantId = $event->job->payload()['tenant_id'] ?? null;
 
-            // The job is not tenant-aware
+        $dispatcher->listen(JobProcessing::class, function ($event) use (&$previousTenant) {
-            if (! $tenantId) {
+            $previousTenant = tenant();
-                return;
-            }
 
-            // Tenancy is already initialized for the tenant (e.g. dispatchNow was used)
+            static::initializeTenancyForQueue($event->job->payload()['tenant_id'] ?? null);
-            if (tenancy()->initialized && tenant()->getTenantKey() === $tenantId) {
-                return;
-            }
-
-            // Tenancy was either not initialized, or initialized for a different tenant.
-            // Therefore, we initialize it for the correct tenant.
-            tenancy()->initialize(tenancy()->find($tenantId));
         });
+
+        if (version_compare(app()->version(), '8.64', '>=')) {
+            // JobRetryRequested only exists since Laravel 8.64
+            $dispatcher->listen(JobRetryRequested::class, function ($event) use (&$previousTenant) {
+                $previousTenant = tenant();
+
+                static::initializeTenancyForQueue($event->payload()['tenant_id'] ?? null);
+            });
+        }
+
+        // If we're running tests, we make sure to clean up after any artisan('queue:work') calls
+        $revertToPreviousState = function ($event) use (&$previousTenant, $runningTests) {
+            if ($runningTests) {
+                static::revertToPreviousState($event, $previousTenant);
+            }
+        };
+
+        $dispatcher->listen(JobProcessed::class, $revertToPreviousState); // artisan('queue:work') which succeeds
+        $dispatcher->listen(JobFailed::class, $revertToPreviousState); // artisan('queue:work') which fails
+    }
+
+    protected static function initializeTenancyForQueue($tenantId)
+    {
+        if (! $tenantId) {
+            // The job is not tenant-aware
+            if (tenancy()->initialized) {
+                // Tenancy was initialized, so we revert back to the central context
+                tenancy()->end();
+            }
+
+            return;
+        }
+
+        if (static::$forceRefresh) {
+            // Re-initialize tenancy between all jobs
+            if (tenancy()->initialized) {
+                tenancy()->end();
+            }
+
+            tenancy()->initialize(tenancy()->find($tenantId));
+
+            return;
+        }
+
+        if (tenancy()->initialized) {
+            // Tenancy is already initialized
+            if (tenant()->getTenantKey() === $tenantId) {
+                // It's initialized for the same tenant (e.g. dispatchNow was used, or the previous job also ran for this tenant)
+                return;
+            }
+        }
+
+        // Tenancy was either not initialized, or initialized for a different tenant.
+        // Therefore, we initialize it for the correct tenant.
+        tenancy()->initialize(tenancy()->find($tenantId));
+    }
+
+    protected static function revertToPreviousState($event, &$previousTenant)
+    {
+        $tenantId = $event->job->payload()['tenant_id'] ?? null;
+
+        // The job was not tenant-aware
+        if (! $tenantId) {
+            return;
+        }
+
+        // Revert back to the previous tenant
+        if (tenant() && $previousTenant && $previousTenant->isNot(tenant())) {
+            tenancy()->initialize($previousTenant);
+        }
+
+        // End tenancy
+        if (tenant() && (! $previousTenant)) {
+            tenancy()->end();
+        }
     }
 
     protected function setUpPayloadGenerator()

src/CacheManager.php

@@ -20,8 +20,10 @@ class CacheManager extends BaseCacheManager
         $tags = [config('tenancy.cache.tag_base') . tenant()->getTenantKey()];
 
         if ($method === 'tags') {
-            if (count($parameters) !== 1) {
+            $count = count($parameters);
-                throw new \Exception("Method tags() takes exactly 1 argument. {count($parameters)} passed.");
+            
+            if ($count !== 1) {
+                throw new \Exception("Method tags() takes exactly 1 argument. $count passed.");
             }
 
             $names = $parameters[0];

src/Commands/Migrate.php

@@ -8,32 +8,26 @@ use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Database\Console\Migrations\MigrateCommand;
 use Illuminate\Database\Migrations\Migrator;
 use Stancl\Tenancy\Concerns\DealsWithMigrations;
+use Stancl\Tenancy\Concerns\ExtendsLaravelCommand;
 use Stancl\Tenancy\Concerns\HasATenantsOption;
 use Stancl\Tenancy\Events\DatabaseMigrated;
 use Stancl\Tenancy\Events\MigratingDatabase;
 
 class Migrate extends MigrateCommand
 {
-    use HasATenantsOption, DealsWithMigrations;
+    use HasATenantsOption, DealsWithMigrations, ExtendsLaravelCommand;
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Run migrations for tenant(s)';
 
-    /**
+    protected static function getTenantCommandName(): string
-     * Create a new command instance.
+    {
-     *
+        return 'tenants:migrate';
-     * @param Migrator $migrator
+    }
-     * @param Dispatcher $dispatcher
+
-     */
     public function __construct(Migrator $migrator, Dispatcher $dispatcher)
     {
         parent::__construct($migrator, $dispatcher);
 
-        $this->setName('tenants:migrate');
         $this->specifyParameters();
     }
 
@@ -55,7 +49,7 @@ class Migrate extends MigrateCommand
         }
 
         tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
-            $this->line("Tenant: {$tenant['id']}");
+            $this->line("Tenant: {$tenant->getTenantKey()}");
 
             event(new MigratingDatabase($tenant));
 

src/Commands/MigrateFresh.php

@@ -7,6 +7,7 @@ namespace Stancl\Tenancy\Commands;
 use Illuminate\Console\Command;
 use Stancl\Tenancy\Concerns\DealsWithMigrations;
 use Stancl\Tenancy\Concerns\HasATenantsOption;
+use Symfony\Component\Console\Input\InputOption;
 
 final class MigrateFresh extends Command
 {
@@ -23,6 +24,8 @@ final class MigrateFresh extends Command
     {
         parent::__construct();
 
+        $this->addOption('--drop-views', null, InputOption::VALUE_NONE, 'Drop views along with tenant tables.', null);
+
         $this->setName('tenants:migrate-fresh');
     }
 
@@ -37,6 +40,7 @@ final class MigrateFresh extends Command
             $this->info('Dropping tables.');
             $this->call('db:wipe', array_filter([
                 '--database' => 'tenant',
+                '--drop-views' => $this->option('drop-views'),
                 '--force' => true,
             ]));
 

src/Commands/Rollback.php

@@ -7,13 +7,19 @@ namespace Stancl\Tenancy\Commands;
 use Illuminate\Database\Console\Migrations\RollbackCommand;
 use Illuminate\Database\Migrations\Migrator;
 use Stancl\Tenancy\Concerns\DealsWithMigrations;
+use Stancl\Tenancy\Concerns\ExtendsLaravelCommand;
 use Stancl\Tenancy\Concerns\HasATenantsOption;
 use Stancl\Tenancy\Events\DatabaseRolledBack;
 use Stancl\Tenancy\Events\RollingBackDatabase;
 
 class Rollback extends RollbackCommand
 {
-    use HasATenantsOption, DealsWithMigrations;
+    use HasATenantsOption, DealsWithMigrations, ExtendsLaravelCommand;
+
+    protected static function getTenantCommandName(): string
+    {
+        return 'tenants:rollback';
+    }
 
     /**
      * The console command description.
@@ -31,8 +37,7 @@ class Rollback extends RollbackCommand
     {
         parent::__construct($migrator);
 
-        $this->setName('tenants:rollback');
+        $this->specifyTenantSignature();
-        $this->specifyParameters();
     }
 
     /**
@@ -53,7 +58,7 @@ class Rollback extends RollbackCommand
         }
 
         tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
-            $this->line("Tenant: {$tenant['id']}");
+            $this->line("Tenant: {$tenant->getTenantKey()}");
 
             event(new RollingBackDatabase($tenant));
 

src/Commands/Run.php

@@ -33,8 +33,7 @@ class Run extends Command
     public function handle()
     {
         tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
-            $this->line("Tenant: {$tenant['id']}");
+            $this->line("Tenant: {$tenant->getTenantKey()}");
-            tenancy()->initialize($tenant);
 
             $callback = function ($prefix = '') {
                 return function ($arguments, $argument) use ($prefix) {

src/Commands/Seed.php

@@ -51,7 +51,7 @@ class Seed extends SeedCommand
         }
 
         tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
-            $this->line("Tenant: {$tenant['id']}");
+            $this->line("Tenant: {$tenant->getTenantKey()}");
 
             event(new SeedingDatabase($tenant));
 

src/Commands/TenantDump.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Database\ConnectionResolverInterface;
+use Illuminate\Database\Console\DumpCommand;
+use Stancl\Tenancy\Contracts\Tenant;
+use Symfony\Component\Console\Input\InputOption;
+
+class TenantDump extends DumpCommand
+{
+    public function __construct()
+    {
+        parent::__construct();
+
+        $this->setName('tenants:dump');
+        $this->specifyParameters();
+    }
+
+
+    public function handle(ConnectionResolverInterface $connections, Dispatcher $dispatcher): int
+    {
+        $this->tenant()->run(fn() => parent::handle($connections, $dispatcher));
+
+        return Command::SUCCESS;
+    }
+
+    public function tenant(): Tenant
+    {
+        $tenant = $this->option('tenant')
+            ?? tenant()
+            ?? $this->ask('What tenant do you want to dump the schema for?')
+            ?? tenancy()->query()->first();
+
+        if (! $tenant instanceof Tenant) {
+            $tenant = tenancy()->find($tenant);
+        }
+
+        throw_if(! $tenant, 'Could not identify the tenant to use for dumping the schema.');
+
+        return $tenant;
+    }
+
+    protected function getOptions(): array
+    {
+        return array_merge([
+            ['tenant', null, InputOption::VALUE_OPTIONAL, '', null],
+        ], parent::getOptions());
+    }
+}

src/Commands/TenantList.php

@@ -36,9 +36,9 @@ class TenantList extends Command
             ->cursor()
             ->each(function (Tenant $tenant) {
                 if ($tenant->domains) {
-                    $this->line("[Tenant] id: {$tenant['id']} @ " . implode('; ', $tenant->domains->pluck('domain')->toArray() ?? []));
+                    $this->line("[Tenant] {$tenant->getTenantKeyName()}: {$tenant->getTenantKey()} @ " . implode('; ', $tenant->domains->pluck('domain')->toArray() ?? []));
                 } else {
-                    $this->line("[Tenant] id: {$tenant['id']}");
+                    $this->line("[Tenant] {$tenant->getTenantKeyName()}: {$tenant->getTenantKey()}");
                 }
             });
     }

src/Concerns/ExtendsLaravelCommand.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Stancl\Tenancy\Concerns;
+
+trait ExtendsLaravelCommand
+{
+    protected function specifyTenantSignature(): void
+    {
+        $this->specifyParameters();
+    }
+
+    public function getName(): ?string
+    {
+        return static::getTenantCommandName();
+    }
+
+    public static function getDefaultName(): ?string
+    {
+        return static::getTenantCommandName();
+    }
+
+    abstract protected static function getTenantCommandName(): string;
+}

src/Database/DatabaseManager.php

@@ -7,10 +7,12 @@ namespace Stancl\Tenancy\Database;
 use Illuminate\Config\Repository;
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Database\DatabaseManager as BaseDatabaseManager;
+use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
 use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
 use Stancl\Tenancy\Contracts\TenantWithDatabase;
 use Stancl\Tenancy\Exceptions\DatabaseManagerNotRegisteredException;
 use Stancl\Tenancy\Exceptions\TenantDatabaseAlreadyExistsException;
+use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException;
 
 /**
  * @internal Class is subject to breaking changes in minor and patch versions.
@@ -38,7 +40,7 @@ class DatabaseManager
      */
     public function connectToTenant(TenantWithDatabase $tenant)
     {
-        $this->database->purge('tenant');
+        $this->purgeTenantConnection();
         $this->createTenantConnection($tenant);
         $this->setDefaultConnection('tenant');
     }
@@ -48,10 +50,7 @@ class DatabaseManager
      */
     public function reconnectToCentral()
     {
-        if (tenancy()->initialized) {
+        $this->purgeTenantConnection();
-            $this->database->purge('tenant');
-        }
-
         $this->setDefaultConnection($this->config->get('tenancy.database.central_connection'));
     }
 
@@ -60,7 +59,7 @@ class DatabaseManager
      */
     public function setDefaultConnection(string $connection)
     {
-        $this->app['config']['database.default'] = $connection;
+        $this->config['database.default'] = $connection;
         $this->database->setDefaultConnection($connection);
     }
 
@@ -69,7 +68,19 @@ class DatabaseManager
      */
     public function createTenantConnection(TenantWithDatabase $tenant)
     {
-        $this->app['config']['database.connections.tenant'] = $tenant->database()->connection();
+        $this->config['database.connections.tenant'] = $tenant->database()->connection();
+    }
+
+    /**
+     * Purge the tenant database connection.
+     */
+    public function purgeTenantConnection()
+    {
+        if (array_key_exists('tenant', $this->database->getConnections())) {
+            $this->database->purge('tenant');
+        }
+
+        unset($this->config['database.connections.tenant']);
     }
 
     /**
@@ -81,8 +92,14 @@ class DatabaseManager
      */
     public function ensureTenantCanBeCreated(TenantWithDatabase $tenant): void
     {
-        if ($tenant->database()->manager()->databaseExists($database = $tenant->database()->getName())) {
+        $manager = $tenant->database()->manager();
+
+        if ($manager->databaseExists($database = $tenant->database()->getName())) {
             throw new TenantDatabaseAlreadyExistsException($database);
         }
+
+        if ($manager instanceof ManagesDatabaseUsers && $manager->userExists($username = $tenant->database()->getUsername())) {
+            throw new TenantDatabaseUserAlreadyExistsException($username);
+        }
     }
 }

src/Exceptions/TenantCouldNotBeIdentifiedById.php

@@ -9,7 +9,7 @@ use Facade\IgnitionContracts\ProvidesSolution;
 use Facade\IgnitionContracts\Solution;
 use Stancl\Tenancy\Contracts\TenantCouldNotBeIdentifiedException;
 
-// todo: in v3 this should be suffixed with Exception
+// todo: in v4 this should be suffixed with Exception
 class TenantCouldNotBeIdentifiedById extends TenantCouldNotBeIdentifiedException implements ProvidesSolution
 {
     public function __construct($tenant_id)

src/Features/UniversalRoutes.php

@@ -40,7 +40,7 @@ class UniversalRoutes implements Feature
         }
 
         // Loop one level deep and check if the route's middleware
-        // groups have the searhced middleware group inside them
+        // groups have the searched middleware group inside them
         $middlewareGroups = Router::getMiddlewareGroups();
         foreach ($route->gatherMiddleware() as $inner) {
             if (! $inner instanceof Closure && isset($middlewareGroups[$inner]) && in_array($middleware, $middlewareGroups[$inner], true)) {

src/Jobs/CreateDatabase.php

@@ -36,8 +36,8 @@ class CreateDatabase implements ShouldQueue
             return false;
         }
 
-        $databaseManager->ensureTenantCanBeCreated($this->tenant);
         $this->tenant->database()->makeCredentials();
+        $databaseManager->ensureTenantCanBeCreated($this->tenant);
         $this->tenant->database()->manager()->createDatabase($this->tenant);
 
         event(new DatabaseCreated($this->tenant));

src/Middleware/CheckTenantForMaintenanceMode.php

@@ -5,7 +5,7 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Middleware;
 
 use Closure;
-use Illuminate\Foundation\Http\Exceptions\MaintenanceModeException;
+use Symfony\Component\HttpKernel\Exception\HttpException;
 use Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode;
 use Stancl\Tenancy\Exceptions\TenancyNotInitializedException;
 use Symfony\Component\HttpFoundation\IpUtils;
@@ -29,7 +29,12 @@ class CheckTenantForMaintenanceMode extends CheckForMaintenanceMode
                 return $next($request);
             }
 
-            throw new MaintenanceModeException($data['time'], $data['retry'], $data['message']);
+            throw new HttpException(
+                503,
+                'Service Unavailable',
+                null,
+                isset($data['retry']) ? ['Retry-After' => $data['retry']] : []
+            );
         }
 
         return $next($request);

src/Tenancy.php

@@ -66,10 +66,10 @@ class Tenancy
             return;
         }
 
-        $this->initialized = false;
-
         event(new Events\TenancyEnded($this));
 
+        $this->initialized = false;
+
         $this->tenant = null;
     }
 

src/TenancyServiceProvider.php

@@ -7,6 +7,7 @@ namespace Stancl\Tenancy;
 use Illuminate\Cache\CacheManager;
 use Illuminate\Support\ServiceProvider;
 use Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper;
+use Stancl\Tenancy\Contracts\Domain;
 use Stancl\Tenancy\Contracts\Tenant;
 use Stancl\Tenancy\Resolvers\DomainTenantResolver;
 
@@ -88,6 +89,7 @@ class TenancyServiceProvider extends ServiceProvider
             Commands\Migrate::class,
             Commands\Rollback::class,
             Commands\TenantList::class,
+            Commands\TenantDump::class,
             Commands\MigrateFresh::class,
         ]);
 

src/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php

@@ -7,7 +7,6 @@ namespace Stancl\Tenancy\TenantDatabaseManagers;
 use Stancl\Tenancy\Concerns\CreatesDatabaseUsers;
 use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
 use Stancl\Tenancy\DatabaseConfig;
-use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException;
 
 class PermissionControlledMySQLDatabaseManager extends MySQLDatabaseManager implements ManagesDatabaseUsers
 {
@@ -26,10 +25,6 @@ class PermissionControlledMySQLDatabaseManager extends MySQLDatabaseManager impl
         $hostname = $databaseConfig->connection()['host'];
         $password = $databaseConfig->getPassword();
 
-        if ($this->userExists($username)) {
-            throw new TenantDatabaseUserAlreadyExistsException($username);
-        }
-
         $this->database()->statement("CREATE USER `{$username}`@`%` IDENTIFIED BY '{$password}'");
 
         $grants = implode(', ', static::$grants);

src/TenantDatabaseManagers/PostgreSQLSchemaManager.php

@@ -46,7 +46,11 @@ class PostgreSQLSchemaManager implements TenantDatabaseManager
 
     public function makeConnectionConfig(array $baseConfig, string $databaseName): array
     {
-        $baseConfig['schema'] = $databaseName;
+        if (version_compare(app()->version(), '9.0', '>=')) {
+            $baseConfig['search_path'] = $databaseName;
+        } else {
+            $baseConfig['schema'] = $databaseName;
+        }
 
         return $baseConfig;
     }

tests/BootstrapperTest.php

@@ -4,26 +4,31 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Tests;
 
-use Illuminate\Support\Facades\Cache;
+use Illuminate\Filesystem\FilesystemAdapter;
+use ReflectionObject;
+use ReflectionProperty;
+use Illuminate\Support\Str;
 use Illuminate\Support\Facades\DB;
+use Stancl\JobPipeline\JobPipeline;
+use Stancl\Tenancy\Tests\Etc\Tenant;
+use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Redis;
 use Illuminate\Support\Facades\Storage;
-use Stancl\JobPipeline\JobPipeline;
-use Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper;
-use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
-use Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper;
-use Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper;
 use Stancl\Tenancy\Events\TenancyEnded;
 use Stancl\Tenancy\Events\TenancyInitialized;
 use Stancl\Tenancy\Events\TenantCreated;
 use Stancl\Tenancy\Events\TenantDeleted;
+use Stancl\Tenancy\Events\TenancyInitialized;
 use Stancl\Tenancy\Jobs\CreateDatabase;
 use Stancl\Tenancy\Jobs\CreateStorageSymlinks;
 use Stancl\Tenancy\Jobs\RemoveStorageSymlinks;
 use Stancl\Tenancy\Listeners\BootstrapTenancy;
 use Stancl\Tenancy\Listeners\RevertToCentralContext;
-use Stancl\Tenancy\Tests\Etc\Tenant;
+use Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper;
+use Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper;
+use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
+use Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper;
 
 class BootstrapperTest extends TestCase
 {
@@ -168,6 +173,7 @@ class BootstrapperTest extends TestCase
         $tenant2 = Tenant::create();
 
         tenancy()->initialize($tenant1);
+
         Storage::disk('public')->put('foo', 'bar');
         $this->assertSame('bar', Storage::disk('public')->get('foo'));
 
@@ -187,30 +193,38 @@ class BootstrapperTest extends TestCase
         $this->assertFalse(Storage::disk('public')->exists('foo'));
         $this->assertFalse(Storage::disk('public')->exists('abc'));
 
+        $expected_storage_path = $old_storage_path . '/tenant' . tenant('id'); // /tenant = suffix base
+
+        // Check that disk prefixes respect the root_override logic
+        $this->assertSame($expected_storage_path . '/app/', $this->getDiskPrefix('local'));
+        $this->assertSame($expected_storage_path . '/app/public/', $this->getDiskPrefix('public'));
+        $this->assertSame('tenant' . tenant('id') . '/', $this->getDiskPrefix('s3'), '/');
+
         // Check suffixing logic
         $new_storage_path = storage_path();
-        $this->assertEquals($old_storage_path . '/' . config('tenancy.filesystem.suffix_base') . tenant('id'), $new_storage_path);
+        $this->assertEquals($expected_storage_path, $new_storage_path);
+    }
 
-        foreach (config('tenancy.filesystem.disks') as $disk) {
+    protected function getDiskPrefix(string $disk): string
-            $suffix = config('tenancy.filesystem.suffix_base') . tenant('id');
+    {
+        /** @var FilesystemAdapter $disk */
+        $disk = Storage::disk($disk);
+        $adapter = $disk->getAdapter();
 
-            /** @var FilesystemAdapter $filesystemDisk */
+        if (! Str::startsWith(app()->version(), '9.')) {
-            $filesystemDisk = Storage::disk($disk);
+            return $adapter->getPathPrefix();
-
-            $current_path_prefix = $filesystemDisk->getAdapter()->getPathPrefix();
-
-            if ($override = config("tenancy.filesystem.root_override.{$disk}")) {
-                $correct_path_prefix = str_replace('%storage_path%', storage_path(), $override);
-            } else {
-                if ($base = $old_storage_facade_roots[$disk]) {
-                    $correct_path_prefix = $base . "/$suffix/";
-                } else {
-                    $correct_path_prefix = "$suffix/";
-                }
-            }
-
-            $this->assertSame($correct_path_prefix, $current_path_prefix);
         }
+
+        $prefixer = (new ReflectionObject($adapter))->getProperty('prefixer');
+        $prefixer->setAccessible(true);
+
+        // reflection -> instance
+        $prefixer = $prefixer->getValue($adapter);
+
+        $prefix = (new ReflectionProperty($prefixer, 'prefix'));
+        $prefix->setAccessible(true);
+
+        return $prefix->getValue($prefixer);
     }
 
     /** @test */

tests/CommandsTest.php

@@ -95,6 +95,38 @@ class CommandsTest extends TestCase
         $this->assertTrue(Schema::hasTable('users'));
     }
 
+    /** @test */
+    public function migrate_command_loads_schema_state()
+    {
+        $tenant = Tenant::create();
+
+        $this->assertFalse(Schema::hasTable('schema_users'));
+        $this->assertFalse(Schema::hasTable('users'));
+
+        Artisan::call('tenants:migrate --schema-path="tests/Etc/tenant-schema.dump"');
+
+        $this->assertFalse(Schema::hasTable('schema_users'));
+        $this->assertFalse(Schema::hasTable('users'));
+
+        tenancy()->initialize($tenant);
+
+        // Check for both tables to see if missing migrations also get executed
+        $this->assertTrue(Schema::hasTable('schema_users'));
+        $this->assertTrue(Schema::hasTable('users'));
+    }
+
+    /** @test */
+    public function dump_command_works()
+    {
+        $tenant = Tenant::create();
+        Artisan::call('tenants:migrate');
+
+        tenancy()->initialize($tenant);
+
+        Artisan::call('tenants:dump --path="tests/Etc/tenant-schema-test.dump"');
+        $this->assertFileExists('tests/Etc/tenant-schema-test.dump');
+    }
+
     /** @test */
     public function rollback_command_works()
     {

tests/DatabaseUsersTest.php

@@ -10,6 +10,7 @@ use Illuminate\Support\Str;
 use Stancl\JobPipeline\JobPipeline;
 use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
 use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
+use Stancl\Tenancy\Events\DatabaseCreated;
 use Stancl\Tenancy\Events\TenancyInitialized;
 use Stancl\Tenancy\Events\TenantCreated;
 use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException;
@@ -67,14 +68,18 @@ class DatabaseUsersTest extends TestCase
         $this->assertTrue($manager->databaseExists($tenant->database()->getName()));
 
         $this->expectException(TenantDatabaseUserAlreadyExistsException::class);
+        Event::fake([DatabaseCreated::class]);
+
         $tenant2 = Tenant::create([
             'tenancy_db_username' => $username,
         ]);
 
         /** @var ManagesDatabaseUsers $manager */
-        $manager = $tenant2->database()->manager();
+        $manager2 = $tenant2->database()->manager();
+
         // database was not created because of DB transaction
-        $this->assertFalse($manager->databaseExists($tenant2->database()->getName()));
+        $this->assertFalse($manager2->databaseExists($tenant2->database()->getName()));
+        Event::assertNotDispatched(DatabaseCreated::class);
     }
 
     /** @test */

tests/Etc/ConsoleKernel.php

@@ -4,15 +4,10 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Tests\Etc;
 
-use Orchestra\Testbench\Console\Kernel;
+use Orchestra\Testbench\Foundation\Console\Kernel;
 
 class ConsoleKernel extends Kernel
 {
-    /**
-     * The Artisan commands provided by your application.
-     *
-     * @var array
-     */
     protected $commands = [
         ExampleCommand::class,
         AddUserCommand::class,

tests/Etc/tenant-schema.dump

@@ -0,0 +1,66 @@
+/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
+/*!40103 SET TIME_ZONE='+00:00' */;
+/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
+/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
+/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
+/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
+DROP TABLE IF EXISTS `failed_jobs`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!40101 SET character_set_client = utf8 */;
+CREATE TABLE `failed_jobs` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+  `uuid` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
+  `connection` text COLLATE utf8mb4_unicode_ci NOT NULL,
+  `queue` text COLLATE utf8mb4_unicode_ci NOT NULL,
+  `payload` longtext COLLATE utf8mb4_unicode_ci NOT NULL,
+  `exception` longtext COLLATE utf8mb4_unicode_ci NOT NULL,
+  `failed_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `failed_jobs_uuid_unique` (`uuid`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+DROP TABLE IF EXISTS `migrations`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!40101 SET character_set_client = utf8 */;
+CREATE TABLE `migrations` (
+  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
+  `migration` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
+  `batch` int(11) NOT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+DROP TABLE IF EXISTS `password_resets`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!40101 SET character_set_client = utf8 */;
+CREATE TABLE `password_resets` (
+  `email` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
+  `token` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
+  `created_at` timestamp NULL DEFAULT NULL,
+  KEY `password_resets_email_index` (`email`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+DROP TABLE IF EXISTS `users`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!40101 SET character_set_client = utf8 */;
+CREATE TABLE `schema_users` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+  `name` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
+  `email` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
+  `email_verified_at` timestamp NULL DEFAULT NULL,
+  `password` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
+  `remember_token` varchar(100) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
+  `created_at` timestamp NULL DEFAULT NULL,
+  `updated_at` timestamp NULL DEFAULT NULL,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `users_email_unique` (`email`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
+
+/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
+/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
+/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
+/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
+
+INSERT INTO `migrations` VALUES (2,'2014_10_12_100000_testbench_create_password_resets_table',1);
+INSERT INTO `migrations` VALUES (3,'2019_08_19_000000_testbench_create_failed_jobs_table',1);

tests/Etc/tmp/queuetest.json

@@ -1 +0,0 @@
-{"tenant_id":"The current tenant id is: acme"}

tests/MaintenanceModeTest.php

@@ -4,12 +4,14 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Tests;
 
+use Symfony\Component\HttpKernel\Exception\HttpException;
 use Illuminate\Foundation\Http\Exceptions\MaintenanceModeException;
 use Illuminate\Support\Facades\Route;
 use Stancl\Tenancy\Database\Concerns\MaintenanceMode;
 use Stancl\Tenancy\Middleware\CheckTenantForMaintenanceMode;
 use Stancl\Tenancy\Middleware\InitializeTenancyByDomain;
 use Stancl\Tenancy\Tests\Etc\Tenant;
+use Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException;
 
 class MaintenanceModeTest extends TestCase
 {
@@ -32,7 +34,7 @@ class MaintenanceModeTest extends TestCase
 
         $tenant->putDownForMaintenance();
 
-        $this->expectException(MaintenanceModeException::class);
+        $this->expectException(HttpException::class);
         $this->withoutExceptionHandling()
             ->get('http://acme.localhost/foo');
     }

tests/QueueTest.php

@@ -4,18 +4,33 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Tests;
 
+use Closure;
+use Exception;
+use Illuminate\Support\Str;
 use Illuminate\Bus\Queueable;
+use Spatie\Valuestore\Valuestore;
+use Illuminate\Support\Facades\DB;
+use Stancl\Tenancy\Tests\Etc\User;
+use Stancl\JobPipeline\JobPipeline;
+use Stancl\Tenancy\Tests\Etc\Tenant;
+use Illuminate\Support\Facades\Event;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Schema;
+use Stancl\Tenancy\Events\TenancyEnded;
+use Stancl\Tenancy\Jobs\CreateDatabase;
+use Illuminate\Queue\InteractsWithQueue;
+use Stancl\Tenancy\Events\TenantCreated;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Queue\Events\JobProcessed;
+use Illuminate\Queue\Events\JobProcessing;
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\Events\JobProcessing;
+use PDO;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
-use Illuminate\Support\Facades\Event;
-use Spatie\Valuestore\Valuestore;
-use Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper;
 use Stancl\Tenancy\Events\TenancyInitialized;
 use Stancl\Tenancy\Listeners\BootstrapTenancy;
-use Stancl\Tenancy\Tests\Etc\Tenant;
+use Stancl\Tenancy\Listeners\RevertToCentralContext;
+use Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper;
+use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
 
 class QueueTest extends TestCase
 {
@@ -31,13 +46,68 @@ class QueueTest extends TestCase
         config([
             'tenancy.bootstrappers' => [
                 QueueTenancyBootstrapper::class,
+                DatabaseTenancyBootstrapper::class,
             ],
             'queue.default' => 'redis',
         ]);
 
         Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
+        Event::listen(TenancyEnded::class, RevertToCentralContext::class);
 
-        $this->valuestore = Valuestore::make(__DIR__ . '/Etc/tmp/queuetest.json')->flush();
+        $this->createValueStore();
+    }
+
+    public function tearDown(): void
+    {
+        $this->valuestore->flush();
+    }
+
+    protected function createValueStore(): void
+    {
+        $valueStorePath = __DIR__ . '/Etc/tmp/queuetest.json';
+
+        if (! file_exists($valueStorePath)) {
+            // The directory sometimes goes missing as well when the file is deleted in git
+            if (! is_dir(__DIR__ . '/Etc/tmp')) {
+                mkdir(__DIR__ . '/Etc/tmp');
+            }
+
+            file_put_contents($valueStorePath, '');
+        }
+
+        $this->valuestore = Valuestore::make($valueStorePath)->flush();
+    }
+
+    protected function withFailedJobs()
+    {
+        Schema::connection('central')->create('failed_jobs', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('uuid')->unique();
+            $table->text('connection');
+            $table->text('queue');
+            $table->longText('payload');
+            $table->longText('exception');
+            $table->timestamp('failed_at')->useCurrent();
+        });
+    }
+
+    protected function withUsers()
+    {
+        Schema::create('users', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('name');
+            $table->string('email')->unique();
+            $table->string('password');
+            $table->rememberToken();
+            $table->timestamps();
+        });
+    }
+
+    protected function withTenantDatabases()
+    {
+        Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) {
+            return $event->tenant;
+        })->toListener());
     }
 
     /** @test */
@@ -49,7 +119,7 @@ class QueueTest extends TestCase
 
         tenancy()->initialize($tenant);
 
-        Event::fake([JobProcessing::class]);
+        Event::fake([JobProcessing::class, JobProcessed::class]);
 
         dispatch(new TestJob($this->valuestore));
 
@@ -79,21 +149,95 @@ class QueueTest extends TestCase
         });
     }
 
-    /** @test */
+    /**
-    public function tenancy_is_initialized_inside_queues()
+     * @test
+     *
+     * @testWith [true]
+     *           [false]
+     */
+    public function tenancy_is_initialized_inside_queues(bool $shouldEndTenancy)
     {
-        $tenant = Tenant::create([
+        $this->withTenantDatabases();
-            'id' => 'acme',
+        $this->withFailedJobs();
-        ]);
+
+        $tenant = Tenant::create();
 
         tenancy()->initialize($tenant);
 
-        dispatch(new TestJob($this->valuestore));
+        $this->withUsers();
+
+        $user = User::create(['name' => 'Foo', 'email' => 'foo@bar.com', 'password' => 'secret']);
+
+        $this->valuestore->put('userName', 'Bar');
+
+        dispatch(new TestJob($this->valuestore, $user));
 
         $this->assertFalse($this->valuestore->has('tenant_id'));
+
+        if ($shouldEndTenancy) {
+            tenancy()->end();
+        }
+
         $this->artisan('queue:work --once');
 
-        $this->assertSame('The current tenant id is: acme', $this->valuestore->get('tenant_id'));
+        $this->assertSame(0, DB::connection('central')->table('failed_jobs')->count());
+
+        $this->assertSame('The current tenant id is: ' . $tenant->id, $this->valuestore->get('tenant_id'));
+
+        $tenant->run(function () use ($user) {
+            $this->assertSame('Bar', $user->fresh()->name);
+        });
+    }
+
+    /**
+     * @test
+     *
+     * @testWith [true]
+     *           [false]
+     */
+    public function tenancy_is_initialized_when_retrying_jobs(bool $shouldEndTenancy)
+    {
+        if (! Str::startsWith(app()->version(), '8')) {
+            $this->markTestSkipped('queue:retry tenancy is only supported in Laravel 8');
+        }
+
+        $this->withFailedJobs();
+        $this->withTenantDatabases();
+
+        $tenant = Tenant::create();
+
+        tenancy()->initialize($tenant);
+
+        $this->withUsers();
+
+        $user = User::create(['name' => 'Foo', 'email' => 'foo@bar.com', 'password' => 'secret']);
+
+        $this->valuestore->put('userName', 'Bar');
+        $this->valuestore->put('shouldFail', true);
+
+        dispatch(new TestJob($this->valuestore, $user));
+
+        $this->assertFalse($this->valuestore->has('tenant_id'));
+
+        if ($shouldEndTenancy) {
+            tenancy()->end();
+        }
+
+        $this->artisan('queue:work --once');
+
+        $this->assertSame(1, DB::connection('central')->table('failed_jobs')->count());
+        $this->assertNull($this->valuestore->get('tenant_id')); // job failed
+
+        $this->artisan('queue:retry all');
+        $this->artisan('queue:work --once');
+
+        $this->assertSame(0, DB::connection('central')->table('failed_jobs')->count());
+
+        $this->assertSame('The current tenant id is: ' . $tenant->id, $this->valuestore->get('tenant_id')); // job succeeded
+
+        $tenant->run(function () use ($user) {
+            $this->assertSame('Bar', $user->fresh()->name);
+        });
     }
 
     /** @test */
@@ -127,13 +271,31 @@ class TestJob implements ShouldQueue
     /** @var Valuestore */
     protected $valuestore;
 
-    public function __construct(Valuestore $valuestore)
+    /** @var User|null */
+    protected $user;
+
+    public function __construct(Valuestore $valuestore, User $user = null)
     {
         $this->valuestore = $valuestore;
+        $this->user = $user;
     }
 
     public function handle()
     {
+        if ($this->valuestore->get('shouldFail')) {
+            $this->valuestore->put('shouldFail', false);
+
+            throw new Exception('failing');
+        }
+
+        if ($this->user) {
+            assert($this->user->getConnectionName() === 'tenant');
+        }
+
         $this->valuestore->put('tenant_id', 'The current tenant id is: ' . tenant('id'));
+
+        if ($userName = $this->valuestore->get('userName')) {
+            $this->user->update(['name' => $userName]);
+        }
     }
 }

tests/TenantDatabaseManagerTest.php

@@ -4,17 +4,21 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Tests;
 
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Facades\Schema;
 use Illuminate\Support\Str;
 use PDO;
 use Stancl\JobPipeline\JobPipeline;
 use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
 use Stancl\Tenancy\Database\DatabaseManager;
+use Stancl\Tenancy\Events\TenancyEnded;
 use Stancl\Tenancy\Events\TenancyInitialized;
 use Stancl\Tenancy\Events\TenantCreated;
 use Stancl\Tenancy\Exceptions\TenantDatabaseAlreadyExistsException;
 use Stancl\Tenancy\Jobs\CreateDatabase;
 use Stancl\Tenancy\Listeners\BootstrapTenancy;
+use Stancl\Tenancy\Listeners\RevertToCentralContext;
 use Stancl\Tenancy\TenantDatabaseManagers\MySQLDatabaseManager;
 use Stancl\Tenancy\TenantDatabaseManagers\PermissionControlledMySQLDatabaseManager;
 use Stancl\Tenancy\TenantDatabaseManagers\PostgreSQLDatabaseManager;
@@ -102,6 +106,52 @@ class TenantDatabaseManagerTest extends TestCase
         ];
     }
 
+    /** @test */
+    public function the_tenant_connection_is_fully_removed()
+    {
+        config([
+            'tenancy.boostrappers' => [
+                DatabaseTenancyBootstrapper::class,
+            ],
+        ]);
+
+        Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) {
+            return $event->tenant;
+        })->toListener());
+
+        Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
+        Event::listen(TenancyEnded::class, RevertToCentralContext::class);
+
+        $tenant = Tenant::create();
+
+        $this->assertSame(['central'], array_keys(app('db')->getConnections()));
+        $this->assertArrayNotHasKey('tenant', config('database.connections'));
+
+        tenancy()->initialize($tenant);
+
+        $this->createUsersTable();
+
+        $this->assertSame(['central', 'tenant'], array_keys(app('db')->getConnections()));
+        $this->assertArrayHasKey('tenant', config('database.connections'));
+
+        tenancy()->end();
+
+        $this->assertSame(['central'], array_keys(app('db')->getConnections()));
+        $this->assertNull(config('database.connections.tenant'));
+    }
+
+    protected function createUsersTable()
+    {
+        Schema::create('users', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('name');
+            $table->string('email')->unique();
+            $table->string('password');
+            $table->rememberToken();
+            $table->timestamps();
+        });
+    }
+
     /** @test */
     public function db_name_is_prefixed_with_db_path_when_sqlite_is_used()
     {
@@ -144,7 +194,11 @@ class TenantDatabaseManagerTest extends TestCase
         ]);
         tenancy()->initialize($tenant);
 
-        $this->assertSame($tenant->database()->getName(), config('database.connections.' . config('database.default') . '.schema'));
+        $schemaConfig = version_compare(app()->version(), '9.0', '>=') ? 
+            config('database.connections.' . config('database.default') . '.search_path') :
+            config('database.connections.' . config('database.default') . '.schema');
+
+        $this->assertSame($tenant->database()->getName(), $schemaConfig);
         $this->assertSame($originalDatabaseName, config(['database.connections.pgsql.database']));
     }
 
@@ -217,5 +271,6 @@ class TenantDatabaseManagerTest extends TestCase
     /** @test */
     public function path_used_by_sqlite_manager_can_be_customized()
     {
+        $this->markTestIncomplete();
     }
 }

tests/TestCase.php

@@ -48,7 +48,11 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase
     protected function getEnvironmentSetUp($app)
     {
         if (file_exists(__DIR__ . '/../.env')) {
-            \Dotenv\Dotenv::create(__DIR__ . '/..')->load();
+            if (method_exists(\Dotenv\Dotenv::class, 'createImmutable')) {
+                \Dotenv\Dotenv::createImmutable(__DIR__ . '/..')->load();
+            } else {
+                \Dotenv\Dotenv::create(__DIR__ . '/..')->load();
+            }
         }
 
         $app['config']->set([
@@ -83,6 +87,7 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase
                 'public',
                 's3',
             ],
+            'filesystems.disks.s3.bucket' => 'foo',
             'tenancy.redis.tenancy' => env('TENANCY_TEST_REDIS_TENANCY', true),
             'database.redis.client' => env('TENANCY_TEST_REDIS_CLIENT', 'phpredis'),
             'tenancy.redis.prefixed_connections' => ['default'],