Merge branch 'master' of github.com:archtechx/tenancy into add-postgres-rls-support

.github/workflows/ci.yml

@@ -119,4 +119,4 @@ jobs:
       - name: Install composer dependencies
         run: composer install
       - name: Run phpstan
-        run: vendor/bin/phpstan analyse
+        run: vendor/bin/phpstan analyse --xdebug

Dockerfile

@@ -15,7 +15,7 @@ RUN apt-get update \
     && curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add - \
     && curl https://packages.microsoft.com/config/ubuntu/20.04/prod.list > /etc/apt/sources.list.d/mssql-release.list \
     && apt-get update \
-    && ACCEPT_EULA=Y apt-get install -y unixodbc-dev msodbcsql17
+    && ACCEPT_EULA=Y apt-get install -y unixodbc-dev=2.3.7 unixodbc=2.3.7 odbcinst1debian2=2.3.7 odbcinst=2.3.7 msodbcsql17
 
 # set PHP version
 RUN update-alternatives --set php /usr/bin/php$PHP_VERSION \

assets/TenancyServiceProvider.stub.php

@@ -4,14 +4,14 @@ declare(strict_types=1);
 
 namespace App\Providers;
 
+use Stancl\Tenancy\Jobs;
+use Stancl\Tenancy\Events;
+use Stancl\Tenancy\Listeners;
+use Stancl\Tenancy\Middleware;
+use Stancl\JobPipeline\JobPipeline;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
-use Stancl\JobPipeline\JobPipeline;
-use Stancl\Tenancy\Events;
-use Stancl\Tenancy\Jobs;
-use Stancl\Tenancy\Listeners;
-use Stancl\Tenancy\Middleware;
 
 class TenancyServiceProvider extends ServiceProvider
 {
@@ -120,6 +120,21 @@ class TenancyServiceProvider extends ServiceProvider
         ];
     }
 
+    protected function overrideUrlInTenantContext(): void
+    {
+        /**
+         * Example of CLI tenant URL root override:
+         *
+         * UrlTenancyBootstrapper::$rootUrlOverride = function (Tenant $tenant) {
+         *     $baseUrl = env('APP_URL');
+         *     $scheme = str($baseUrl)->before('://');
+         *     $hostname = str($baseUrl)->after($scheme . '://');
+         *
+         *     return $scheme . '://' . $tenant->getTenantKey() . '.' . $hostname;
+         * };
+         */
+    }
+
     public function register()
     {
         //
@@ -131,6 +146,7 @@ class TenancyServiceProvider extends ServiceProvider
         $this->mapRoutes();
 
         $this->makeTenancyMiddlewareHighestPriority();
+        $this->overrideUrlInTenantContext();
     }
 
     protected function bootEvents()

assets/config.php

@@ -102,6 +102,7 @@ return [
         Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper::class,
         Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper::class,
         Stancl\Tenancy\Bootstrappers\BatchTenancyBootstrapper::class,
+        // Stancl\Tenancy\Bootstrappers\UrlTenancyBootstrapper::class,
         // Stancl\Tenancy\Bootstrappers\SessionTenancyBootstrapper::class,
         // Stancl\Tenancy\Bootstrappers\MailTenancyBootstrapper::class, // Queueing mail requires using QueueTenancyBootstrapper with $forceRefresh set to true
         // Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper::class, // Note: phpredis is needed
@@ -257,7 +258,7 @@ return [
     ],
 
     /**
-     * Redis tenancy config. Used by RedisTenancyBoostrapper.
+     * Redis tenancy config. Used by RedisTenancyBootstrapper.
      *
      * Note: You need phpredis to use Redis tenancy.
      *
@@ -285,6 +286,7 @@ return [
         // Stancl\Tenancy\Features\TelescopeTags::class,
         // Stancl\Tenancy\Features\TenantConfig::class, // https://tenancyforlaravel.com/docs/v3/features/tenant-config
         // Stancl\Tenancy\Features\CrossDomainRedirect::class, // https://tenancyforlaravel.com/docs/v3/features/cross-domain-redirect
+        // Stancl\Tenancy\Features\ViteBundler::class,
     ],
 
     /**

assets/impersonation-migrations/2020_05_15_000010_create_tenant_user_impersonation_tokens_table.php

@@ -20,6 +20,7 @@ return new class extends Migration
             $table->string('token', 128)->primary();
             $table->string(Tenancy::tenantKeyColumn());
             $table->string('user_id');
+            $table->boolean('remember');
             $table->string('auth_guard');
             $table->string('redirect_url');
             $table->timestamp('created_at');

composer.json

@@ -17,17 +17,19 @@
     "require": {
         "php": "^8.2",
         "ext-json": "*",
-        "illuminate/support": "^10.1",
+        "illuminate/support": "^10.0",
+        "facade/ignition-contracts": "^1.0.2",
         "spatie/ignition": "^1.4",
-        "ramsey/uuid": "^4.0",
+        "ramsey/uuid": "^4.7.3",
         "stancl/jobpipeline": "2.0.0-rc1",
-        "stancl/virtualcolumn": "^1.3"
+        "stancl/virtualcolumn": "^1.3.1",
+        "spatie/invade": "^1.1"
     },
     "require-dev": {
-        "laravel/framework": "^10.1",
+        "laravel/framework": "^10.0",
         "orchestra/testbench": "^8.0",
-        "league/flysystem-aws-s3-v3": "^3.0",
-        "doctrine/dbal": "^2.10",
+        "league/flysystem-aws-s3-v3": "^3.12.2",
+        "doctrine/dbal": "^3.6.0",
         "spatie/valuestore": "^1.2.5",
         "pestphp/pest": "^1.21",
         "nunomaduro/larastan": "^2.4",

doctum/.gitignore

@@ -0,0 +1,3 @@
+build/
+cache/
+vendor/

doctum/composer.json

@@ -0,0 +1,8 @@
+{
+    "require": {
+        "code-lts/doctum": "v5.5.x-dev"
+    },
+    "scripts": {
+        "doctum": "./vendor/bin/doctum.php update doctum.php --output-format=github --force --ignore-parse-errors --no-ansi --no-progress -v"
+    }
+}

doctum/doctum.php

@@ -0,0 +1,30 @@
+<?php
+
+require __DIR__.'/vendor/autoload.php';
+
+use Doctum\Doctum;
+use Symfony\Component\Finder\Finder;
+use Doctum\Version\GitVersionCollection;
+use Doctum\RemoteRepository\GitHubRemoteRepository;
+
+$iterator = Finder::create()
+    ->files()
+    ->name('*.php')
+    ->in($dir = __DIR__ . '/../src');
+
+$versions = GitVersionCollection::create($dir)
+    ->add('1.x', 'Tenancy 1.x')
+    ->add('2.x', 'Tenancy 2.x')
+    ->add('3.x', 'Tenancy 3.x')
+    ->add('master', 'Tenancy Dev');
+
+return new Doctum($iterator, [
+    'title' => 'Tenancy for Laravel API Documentation',
+    'versions' => $versions,
+    'build_dir' => __DIR__ . '/build/%version%',
+    'cache_dir' => __DIR__ . '/cache/%version%',
+    'default_opened_level' => 2,
+    'base_url' => 'https://api.tenancyforlaravel.com/',
+    'favicon' => 'https://tenancyforlaravel.com/favicon.ico',
+    'remote_repository' => new GitHubRemoteRepository('archtechx/tenancy', dirname($dir)),
+]);

phpstan.neon

@@ -40,10 +40,6 @@ parameters:
             message: '#Illuminate\\Routing\\UrlGenerator#'
             paths:
                 - src/Bootstrappers/FilesystemTenancyBootstrapper.php
-        -
-            message: '#select\(\) expects string, Illuminate\\Database\\Query\\Expression given#'
-            paths:
-                - src/Database/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php
         -
             message: '#Trying to invoke Closure\|null but it might not be a callable#'
             paths:

src/Bootstrappers/BroadcastTenancyBootstrapper.php

@@ -0,0 +1,95 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Bootstrappers;
+
+use Illuminate\Broadcasting\BroadcastManager;
+use Illuminate\Config\Repository;
+use Illuminate\Contracts\Broadcasting\Broadcaster;
+use Illuminate\Foundation\Application;
+use Stancl\Tenancy\Contracts\TenancyBootstrapper;
+use Stancl\Tenancy\Contracts\Tenant;
+use Stancl\Tenancy\TenancyBroadcastManager;
+
+class BroadcastTenancyBootstrapper implements TenancyBootstrapper
+{
+    /**
+     * Tenant properties to be mapped to config (similarly to the TenantConfig feature).
+     *
+     * For example:
+     * [
+     *     'config.key.name' => 'tenant_property',
+     * ]
+     */
+    public static array $credentialsMap = [];
+
+    public static string|null $broadcaster = null;
+
+    protected array $originalConfig = [];
+    protected BroadcastManager|null $originalBroadcastManager = null;
+    protected Broadcaster|null $originalBroadcaster = null;
+
+    public static array $mapPresets = [
+        'pusher' => [
+            'broadcasting.connections.pusher.key' => 'pusher_key',
+            'broadcasting.connections.pusher.secret' => 'pusher_secret',
+            'broadcasting.connections.pusher.app_id' => 'pusher_app_id',
+            'broadcasting.connections.pusher.options.cluster' => 'pusher_cluster',
+        ],
+        'ably' => [
+            'broadcasting.connections.ably.key' => 'ably_key',
+            'broadcasting.connections.ably.public' => 'ably_public',
+        ],
+    ];
+
+    public function __construct(
+        protected Repository $config,
+        protected Application $app
+    ) {
+        static::$broadcaster ??= $config->get('broadcasting.default');
+        static::$credentialsMap = array_merge(static::$credentialsMap, static::$mapPresets[static::$broadcaster] ?? []);
+    }
+
+    public function bootstrap(Tenant $tenant): void
+    {
+        $this->originalBroadcastManager = $this->app->make(BroadcastManager::class);
+        $this->originalBroadcaster = $this->app->make(Broadcaster::class);
+
+        $this->setConfig($tenant);
+
+        // Make BroadcastManager resolve to a custom BroadcastManager which makes the broadcasters use the tenant credentials
+        $this->app->extend(BroadcastManager::class, function (BroadcastManager $broadcastManager) {
+            return new TenancyBroadcastManager($this->app);
+        });
+    }
+
+    public function revert(): void
+    {
+        // Change the BroadcastManager and Broadcaster singletons back to what they were before initializing tenancy
+        $this->app->singleton(BroadcastManager::class, fn (Application $app) => $this->originalBroadcastManager);
+        $this->app->singleton(Broadcaster::class, fn (Application $app) => $this->originalBroadcaster);
+
+        $this->unsetConfig();
+    }
+
+    protected function setConfig(Tenant $tenant): void
+    {
+        foreach (static::$credentialsMap as $configKey => $storageKey) {
+            $override = $tenant->$storageKey;
+
+            if (array_key_exists($storageKey, $tenant->getAttributes())) {
+                $this->originalConfig[$configKey] ??= $this->config->get($configKey);
+
+                $this->config->set($configKey, $override);
+            }
+        }
+    }
+
+    protected function unsetConfig(): void
+    {
+        foreach ($this->originalConfig as $key => $value) {
+            $this->config->set($key, $value);
+        }
+    }
+}

src/Bootstrappers/UrlTenancyBootstrapper.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Bootstrappers;
+
+use Closure;
+use Illuminate\Config\Repository;
+use Illuminate\Contracts\Routing\UrlGenerator;
+use Stancl\Tenancy\Contracts\TenancyBootstrapper;
+use Stancl\Tenancy\Contracts\Tenant;
+
+class UrlTenancyBootstrapper implements TenancyBootstrapper
+{
+    public static Closure|null $rootUrlOverride = null;
+    protected string|null $originalRootUrl = null;
+
+    public function __construct(
+        protected UrlGenerator $urlGenerator,
+        protected Repository $config,
+    ) {
+    }
+
+    public function bootstrap(Tenant $tenant): void
+    {
+        $this->originalRootUrl = $this->urlGenerator->to('/');
+
+        if (static::$rootUrlOverride) {
+            $newRootUrl = (static::$rootUrlOverride)($tenant);
+
+            $this->urlGenerator->forceRootUrl($newRootUrl);
+            $this->config->set('app.url', $newRootUrl);
+        }
+    }
+
+    public function revert(): void
+    {
+        $this->urlGenerator->forceRootUrl($this->originalRootUrl);
+        $this->config->set('app.url', $this->originalRootUrl);
+    }
+}

src/Database/Models/ImpersonationToken.php

@@ -18,6 +18,7 @@ use Stancl\Tenancy\Exceptions\StatefulGuardRequiredException;
  * @property string $user_id
  * @property string $auth_guard
  * @property string $redirect_url
+ * @property bool $remember
  * @property Carbon $created_at
  */
 class ImpersonationToken extends Model
@@ -33,9 +34,8 @@ class ImpersonationToken extends Model
     public $incrementing = false;
 
     protected $table = 'tenant_user_impersonation_tokens';
-
-    protected $dates = [
-        'created_at',
+    protected $casts = [
+        'created_at' => 'datetime',
     ];
 
     public static function booted(): void

src/Database/Models/Tenant.php

@@ -32,6 +32,8 @@ class Tenant extends Model implements Contracts\Tenant
         Concerns\InitializationHelpers,
         Concerns\InvalidatesResolverCache;
 
+    protected static $modelsShouldPreventAccessingMissingAttributes = false;
+
     protected $table = 'tenants';
     protected $primaryKey = 'id';
     protected $guarded = [];

src/Database/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php

@@ -41,7 +41,8 @@ class PermissionControlledMySQLDatabaseManager extends MySQLDatabaseManager impl
 
     protected function isVersion8(): bool
     {
-        $version = $this->database()->select($this->database()->raw('select version()'))[0]->{'version()'};
+        $versionSelect = (string) $this->database()->raw('select version()')->getValue($this->database()->getQueryGrammar());
+        $version = $this->database()->select($versionSelect)[0]->{'version()'};
 
         return version_compare($version, '8.0.0') >= 0;
     }

src/Exceptions/ModelNotSyncMasterException.php

@@ -6,10 +6,12 @@ namespace Stancl\Tenancy\Exceptions;
 
 use Exception;
 
+// todo@v4 improve all exception messages
+
 class ModelNotSyncMasterException extends Exception
 {
     public function __construct(string $class)
     {
-        parent::__construct("Model of $class class is not an SyncMaster model. Make sure you're using the central model to make changes to synced resources when you're in the central context");
+        parent::__construct("Model of $class class is not a SyncMaster model. Make sure you're using the central model to make changes to synced resources when you're in the central context");
     }
 }

src/Features/UserImpersonation.php

@@ -18,12 +18,13 @@ class UserImpersonation implements Feature
 
     public function bootstrap(Tenancy $tenancy): void
     {
-        $tenancy->macro('impersonate', function (Tenant $tenant, string $userId, string $redirectUrl, string $authGuard = null): ImpersonationToken {
+        $tenancy->macro('impersonate', function (Tenant $tenant, string $userId, string $redirectUrl, string|null $authGuard = null, bool $remember = false): ImpersonationToken {
             return ImpersonationToken::create([
                 Tenancy::tenantKeyColumn() => $tenant->getTenantKey(),
                 'user_id' => $userId,
                 'redirect_url' => $redirectUrl,
                 'auth_guard' => $authGuard,
+                'remember' => $remember,
             ]);
         });
     }
@@ -44,7 +45,7 @@ class UserImpersonation implements Feature
 
         abort_unless($tokenTenantId === $currentTenantId, 403);
 
-        Auth::guard($token->auth_guard)->loginUsingId($token->user_id);
+        Auth::guard($token->auth_guard)->loginUsingId($token->user_id, $token->remember);
 
         $token->delete();
 

src/Features/ViteBundler.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Features;
+
+use Illuminate\Foundation\Application;
+use Stancl\Tenancy\Contracts\Feature;
+use Stancl\Tenancy\Tenancy;
+use Stancl\Tenancy\Vite;
+
+class ViteBundler implements Feature
+{
+    /** @var Application */
+    protected $app;
+
+    public function __construct(Application $app)
+    {
+        $this->app = $app;
+    }
+
+    public function bootstrap(Tenancy $tenancy): void
+    {
+        $this->app->singleton(\Illuminate\Foundation\Vite::class, Vite::class);
+    }
+}

src/TenancyBroadcastManager.php

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy; // todo new Overrides namespace?
+
+use Illuminate\Broadcasting\Broadcasters\Broadcaster;
+use Illuminate\Broadcasting\BroadcastManager;
+use Illuminate\Contracts\Broadcasting\Broadcaster as BroadcasterContract;
+use Illuminate\Contracts\Foundation\Application;
+
+class TenancyBroadcastManager extends BroadcastManager
+{
+    /**
+     * Names of broadcasters to always recreate using $this->resolve() (even when they're
+     * cached and available in the $broadcasters property).
+     *
+     * The reason for recreating the broadcasters is
+     * to make your app use the correct broadcaster credentials when tenancy is initialized.
+     */
+    public static array $tenantBroadcasters = ['pusher', 'ably'];
+
+    /**
+     * Override the get method so that the broadcasters in $tenantBroadcasters
+     * always get freshly resolved even when they're cached and available in the $broadcasters property,
+     * and that the resolved broadcaster will override the BroadcasterContract::class singleton.
+     *
+     * If there's a cached broadcaster with the same name as $name,
+     * give its channels to the newly resolved bootstrapper.
+     */
+    protected function get($name)
+    {
+        if (in_array($name, static::$tenantBroadcasters)) {
+            /** @var Broadcaster|null $originalBroadcaster */
+            $originalBroadcaster = $this->app->make(BroadcasterContract::class);
+            $newBroadcaster = $this->resolve($name);
+
+            // If there is a current broadcaster, give its channels to the newly resolved one
+            // Broadcasters only have to implement the Illuminate\Contracts\Broadcasting\Broadcaster contract
+            // Which doesn't require the channels property
+            // So passing the channels is only needed for Illuminate\Broadcasting\Broadcasters\Broadcaster instances
+            if ($originalBroadcaster instanceof Broadcaster && $newBroadcaster instanceof Broadcaster) {
+                $this->passChannelsFromOriginalBroadcaster($originalBroadcaster, $newBroadcaster);
+            }
+
+            $this->app->singleton(BroadcasterContract::class, fn (Application $app) => $newBroadcaster);
+
+            return $newBroadcaster;
+        }
+
+        return parent::get($name);
+    }
+
+    // Because, unlike the original broadcaster, the newly resolved broadcaster won't have the channels registered using routes/channels.php
+    // Using it for broadcasting won't work, unless we make it have the original broadcaster's channels
+    protected function passChannelsFromOriginalBroadcaster(Broadcaster $originalBroadcaster, Broadcaster $newBroadcaster): void
+    {
+        // invade() because channels can't be retrieved through any of the broadcaster's public methods
+        $originalBroadcaster = invade($originalBroadcaster);
+
+        foreach ($originalBroadcaster->channels as $channel => $callback) {
+            $newBroadcaster->channel($channel, $callback, $originalBroadcaster->retrieveChannelOptions($channel));
+        }
+    }
+}

src/TenancyServiceProvider.php

@@ -62,6 +62,7 @@ class TenancyServiceProvider extends ServiceProvider
         $this->app->singleton(Commands\Rollback::class, function ($app) {
             return new Commands\Rollback($app['migrator']);
         });
+
         $this->app->singleton(Commands\Seed::class, function ($app) {
             return new Commands\Seed($app['db']);
         });

src/Vite.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy;
+
+use Illuminate\Foundation\Vite as BaseVite;
+
+class Vite extends BaseVite // todo move to a different directory in v4
+{
+    /**
+     * Generate an asset path for the application.
+     *
+     * @param  string  $path
+     * @param  bool|null  $secure
+     * @return string
+     */
+    protected function assetPath($path, $secure = null)
+    {
+        return global_asset($path);
+    }
+}

tests/BootstrapperTest.php

@@ -3,31 +3,38 @@
 declare(strict_types=1);
 
 use Illuminate\Support\Str;
-use Illuminate\Mail\MailManager;
 use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\URL;
 use Stancl\JobPipeline\JobPipeline;
 use Illuminate\Support\Facades\File;
 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\Route;
 use Illuminate\Support\Facades\Storage;
 use Stancl\Tenancy\Events\TenancyEnded;
 use Stancl\Tenancy\Jobs\CreateDatabase;
 use Stancl\Tenancy\Events\TenantCreated;
 use Stancl\Tenancy\Events\TenantDeleted;
 use Stancl\Tenancy\Events\DeletingTenant;
+use Stancl\Tenancy\TenancyBroadcastManager;
 use Illuminate\Filesystem\FilesystemAdapter;
+use Illuminate\Broadcasting\BroadcastManager;
 use Stancl\Tenancy\Events\TenancyInitialized;
 use Stancl\Tenancy\Jobs\CreateStorageSymlinks;
 use Stancl\Tenancy\Jobs\RemoveStorageSymlinks;
 use Stancl\Tenancy\Listeners\BootstrapTenancy;
+use Stancl\Tenancy\Tests\Etc\TestingBroadcaster;
 use Stancl\Tenancy\Listeners\DeleteTenantStorage;
 use Stancl\Tenancy\Listeners\RevertToCentralContext;
+use Stancl\Tenancy\Bootstrappers\UrlTenancyBootstrapper;
 use Stancl\Tenancy\Bootstrappers\MailTenancyBootstrapper;
 use Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper;
 use Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper;
+use Stancl\Tenancy\Middleware\InitializeTenancyBySubdomain;
 use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
+use Stancl\Tenancy\Bootstrappers\BroadcastTenancyBootstrapper;
 use Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper;
 
 beforeEach(function () {
@@ -328,6 +335,82 @@ test('local storage public urls are generated correctly', function() {
     expect(File::isDirectory($tenantStoragePath))->toBeFalse();
 });
 
+test('BroadcastTenancyBootstrapper binds TenancyBroadcastManager to BroadcastManager and reverts the binding when tenancy is ended', function() {
+    expect(app(BroadcastManager::class))->toBeInstanceOf(BroadcastManager::class);
+
+    tenancy()->initialize(Tenant::create());
+
+    expect(app(BroadcastManager::class))->toBeInstanceOf(TenancyBroadcastManager::class);
+
+    tenancy()->end();
+
+    expect(app(BroadcastManager::class))->toBeInstanceOf(BroadcastManager::class);
+});
+
+test('BroadcastTenancyBootstrapper maps tenant broadcaster credentials to config as specified in the $credentialsMap property and reverts the config after ending tenancy', function() {
+    config([
+        'broadcasting.connections.testing.driver' => 'testing',
+        'broadcasting.connections.testing.message' => $defaultMessage = 'default',
+    ]);
+
+    BroadcastTenancyBootstrapper::$credentialsMap = [
+        'broadcasting.connections.testing.message' => 'testing_broadcaster_message',
+    ];
+
+    $tenant = Tenant::create(['testing_broadcaster_message' => $tenantMessage = 'first testing']);
+    $tenant2 = Tenant::create(['testing_broadcaster_message' => $secondTenantMessage = 'second testing']);
+
+    tenancy()->initialize($tenant);
+
+    expect(array_key_exists('testing_broadcaster_message', tenant()->getAttributes()))->toBeTrue();
+    expect(config('broadcasting.connections.testing.message'))->toBe($tenantMessage);
+
+    tenancy()->initialize($tenant2);
+
+    expect(config('broadcasting.connections.testing.message'))->toBe($secondTenantMessage);
+
+    tenancy()->end();
+
+    expect(config('broadcasting.connections.testing.message'))->toBe($defaultMessage);
+});
+
+test('BroadcastTenancyBootstrapper makes the app use broadcasters with the correct credentials', function() {
+    config([
+        'broadcasting.default' => 'testing',
+        'broadcasting.connections.testing.driver' => 'testing',
+        'broadcasting.connections.testing.message' => $defaultMessage = 'default',
+    ]);
+
+    TenancyBroadcastManager::$tenantBroadcasters[] = 'testing';
+    BroadcastTenancyBootstrapper::$credentialsMap = [
+        'broadcasting.connections.testing.message' => 'testing_broadcaster_message',
+    ];
+
+    $registerTestingBroadcaster = fn() => app(BroadcastManager::class)->extend('testing', fn($app, $config) => new TestingBroadcaster($config['message']));
+
+    $registerTestingBroadcaster();
+
+    expect(invade(app(BroadcastManager::class)->driver())->message)->toBe($defaultMessage);
+
+    $tenant = Tenant::create(['testing_broadcaster_message' => $tenantMessage = 'first testing']);
+    $tenant2 = Tenant::create(['testing_broadcaster_message' => $secondTenantMessage = 'second testing']);
+
+    tenancy()->initialize($tenant);
+    $registerTestingBroadcaster();
+
+    expect(invade(app(BroadcastManager::class)->driver())->message)->toBe($tenantMessage);
+
+    tenancy()->initialize($tenant2);
+    $registerTestingBroadcaster();
+
+    expect(invade(app(BroadcastManager::class)->driver())->message)->toBe($secondTenantMessage);
+
+    tenancy()->end();
+    $registerTestingBroadcaster();
+
+    expect(invade(app(BroadcastManager::class)->driver())->message)->toBe($defaultMessage);
+});
+
 test('MailTenancyBootstrapper maps tenant mail credentials to config as specified in the $credentialsMap property and makes the mailer use tenant credentials', function() {
     MailTenancyBootstrapper::$credentialsMap = [
         'mail.mailers.smtp.username' => 'smtp_username',
@@ -380,3 +463,48 @@ function getDiskPrefix(string $disk): string
 
     return $prefix;
 }
+
+test('url bootstrapper overrides the root url when tenancy gets initialized and reverts the url to the central one after tenancy ends', function() {
+    config(['tenancy.bootstrappers.url' => UrlTenancyBootstrapper::class]);
+
+    Route::group([
+        'middleware' => InitializeTenancyBySubdomain::class,
+    ], function () {
+        Route::get('/', function () {
+            return true;
+        })->name('home');
+    });
+
+    $baseUrl = url(route('home'));
+    config(['app.url' => $baseUrl]);
+
+    $rootUrlOverride = function (Tenant $tenant) use ($baseUrl) {
+        $scheme = str($baseUrl)->before('://');
+        $hostname = str($baseUrl)->after($scheme . '://');
+
+        return $scheme . '://' . $tenant->getTenantKey() . '.' . $hostname;
+    };
+
+    UrlTenancyBootstrapper::$rootUrlOverride = $rootUrlOverride;
+
+    $tenant = Tenant::create();
+    $tenantUrl = $rootUrlOverride($tenant);
+
+    expect($tenantUrl)->not()->toBe($baseUrl);
+
+    expect(url(route('home')))->toBe($baseUrl);
+    expect(URL::to('/'))->toBe($baseUrl);
+    expect(config('app.url'))->toBe($baseUrl);
+
+    tenancy()->initialize($tenant);
+
+    expect(url(route('home')))->toBe($tenantUrl);
+    expect(URL::to('/'))->toBe($tenantUrl);
+    expect(config('app.url'))->toBe($tenantUrl);
+
+    tenancy()->end();
+
+    expect(url(route('home')))->toBe($baseUrl);
+    expect(URL::to('/'))->toBe($baseUrl);
+    expect(config('app.url'))->toBe($baseUrl);
+});

tests/BroadcastingTest.php

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Support\Facades\Event;
+use Stancl\Tenancy\Events\TenancyEnded;
+use Illuminate\Support\Facades\Broadcast;
+use Stancl\Tenancy\TenancyBroadcastManager;
+use Illuminate\Broadcasting\BroadcastManager;
+use Stancl\Tenancy\Events\TenancyInitialized;
+use Stancl\Tenancy\Listeners\BootstrapTenancy;
+use Stancl\Tenancy\Tests\Etc\TestingBroadcaster;
+use Stancl\Tenancy\Listeners\RevertToCentralContext;
+use Illuminate\Contracts\Broadcasting\Broadcaster as BroadcasterContract;
+
+beforeEach(function() {
+    withTenantDatabases();
+    Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
+    Event::listen(TenancyEnded::class, RevertToCentralContext::class);
+});
+
+test('bound broadcaster instance is the same before initializing tenancy and after ending it', function() {
+    config(['broadcasting.default' => 'null']);
+    TenancyBroadcastManager::$tenantBroadcasters[] = 'null';
+
+    $originalBroadcaster = app(BroadcasterContract::class);
+
+    tenancy()->initialize(Tenant::create());
+
+    // TenancyBroadcastManager binds new broadcaster
+    $tenantBroadcaster = app(BroadcastManager::class)->driver();
+
+    expect($tenantBroadcaster)->not()->toBe($originalBroadcaster);
+
+    tenancy()->end();
+
+    expect($originalBroadcaster)->toBe(app(BroadcasterContract::class));
+});
+
+test('new broadcasters get the channels from the previously bound broadcaster', function() {
+    config([
+        'broadcasting.default' => $driver = 'testing',
+        'broadcasting.connections.testing.driver' => $driver,
+    ]);
+
+    TenancyBroadcastManager::$tenantBroadcasters[] = $driver;
+
+    $registerTestingBroadcaster = fn() => app(BroadcastManager::class)->extend('testing', fn($app, $config) => new TestingBroadcaster('testing'));
+    $getCurrentChannels = fn() => array_keys(invade(app(BroadcastManager::class)->driver())->channels);
+
+    $registerTestingBroadcaster();
+    Broadcast::channel($channel = 'testing-channel', fn() => true);
+
+    expect($channel)->toBeIn($getCurrentChannels());
+
+    tenancy()->initialize(Tenant::create());
+    $registerTestingBroadcaster();
+
+    expect($channel)->toBeIn($getCurrentChannels());
+
+    tenancy()->end();
+    $registerTestingBroadcaster();
+
+    expect($channel)->toBeIn($getCurrentChannels());
+});

tests/Etc/TestingBroadcaster.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Stancl\Tenancy\Tests\Etc;
+
+use Illuminate\Broadcasting\Broadcasters\Broadcaster;
+
+class TestingBroadcaster extends Broadcaster {
+    public function __construct(
+        public string $message
+    ) {}
+
+    public function auth($request)
+    {
+        return true;
+    }
+
+    public function validAuthenticationResponse($request, $result)
+    {
+        return true;
+    }
+
+    public function broadcast(array $channels, $event, array $payload = [])
+    {
+    }
+}

tests/EventListenerTest.php

@@ -79,7 +79,7 @@ test('ing events can be used to cancel db creation', function () {
     });
 
     $tenant = Tenant::create();
-    dispatch_now(new CreateDatabase($tenant));
+    dispatch_sync(new CreateDatabase($tenant));
 
     pest()->assertFalse($tenant->database()->manager()->databaseExists(
         $tenant->database()->getName()
@@ -171,12 +171,13 @@ test('database is not migrated if creation is disabled', function () {
         })->toListener()
     );
 
-    Tenant::create([
+    $tenant = Tenant::create([
         'tenancy_create_database' => false,
         'tenancy_db_name' => 'already_created',
     ]);
 
-    expect(pest()->hasFailed())->toBeFalse();
+    // assert test didn't fail
+    $this->assertTrue($tenant->exists());
 });
 
 class FooListener extends QueueableListener

tests/Features/ViteBundlerTest.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Foundation\Vite;
+use Stancl\Tenancy\Tests\Etc\Tenant;
+use Stancl\Tenancy\Vite as StanclVite;
+use Stancl\Tenancy\Features\ViteBundler;
+
+test('vite helper uses our custom class', function() {
+    $vite = app(Vite::class);
+
+    expect($vite)->toBeInstanceOf(Vite::class);
+    expect($vite)->not()->toBeInstanceOf(StanclVite::class);
+
+    config([
+        'tenancy.features' => [ViteBundler::class],
+    ]);
+
+    $tenant = Tenant::create();
+
+    tenancy()->initialize($tenant);
+
+    app()->forgetInstance(Vite::class);
+
+    $vite = app(Vite::class);
+
+    expect($vite)->toBeInstanceOf(StanclVite::class);
+});

tests/TenantDatabaseManagerTest.php

@@ -302,7 +302,7 @@ test('database credentials can be provided to PermissionControlledMySQLDatabaseM
     $mysql2DB->statement("CREATE USER `{$username}`@`%` IDENTIFIED BY '{$password}';");
     $mysql2DB->statement("GRANT ALL PRIVILEGES ON *.* TO `{$username}`@`%` identified by '{$password}' WITH GRANT OPTION;");
     $mysql2DB->statement("FLUSH PRIVILEGES;");
-    
+
     DB::purge('mysql2'); // forget the mysql2 connection so that it uses the new credentials the next time
 
     config(['database.connections.mysql2.username' => $username]);
@@ -347,7 +347,7 @@ test('tenant database can be created by using the username and password from ten
     $mysqlDB->statement("CREATE USER `{$username}`@`%` IDENTIFIED BY '{$password}';");
     $mysqlDB->statement("GRANT ALL PRIVILEGES ON *.* TO `{$username}`@`%` identified by '{$password}' WITH GRANT OPTION;");
     $mysqlDB->statement("FLUSH PRIVILEGES;");
-    
+
     DB::purge('mysql2'); // forget the mysql2 connection so that it uses the new credentials the next time
 
     // Remove `mysql` credentials to make sure we will be using the credentials from the tenant config

tests/TestCase.php

@@ -4,16 +4,17 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Tests;
 
-use Dotenv\Dotenv;
-use Illuminate\Foundation\Application;
-use Illuminate\Support\Facades\Redis;
 use PDO;
-use Stancl\Tenancy\Bootstrappers\BatchTenancyBootstrapper;
-use Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper;
-use Stancl\Tenancy\Facades\GlobalCache;
+use Dotenv\Dotenv;
 use Stancl\Tenancy\Facades\Tenancy;
-use Stancl\Tenancy\TenancyServiceProvider;
 use Stancl\Tenancy\Tests\Etc\Tenant;
+use Illuminate\Support\Facades\Redis;
+use Illuminate\Foundation\Application;
+use Stancl\Tenancy\Facades\GlobalCache;
+use Stancl\Tenancy\TenancyServiceProvider;
+use Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper;
+use Stancl\Tenancy\Bootstrappers\BroadcastTenancyBootstrapper;
+use Stancl\Tenancy\Bootstrappers\UrlTenancyBootstrapper;
 use Stancl\Tenancy\Bootstrappers\MailTenancyBootstrapper;
 
 abstract class TestCase extends \Orchestra\Testbench\TestCase
@@ -105,7 +106,9 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase
                 '--force' => true,
             ],
             'tenancy.bootstrappers.redis' => RedisTenancyBootstrapper::class, // todo1 change this to []? two tests in TenantDatabaseManagerTest are failing with that
+            'tenancy.bootstrappers.broadcast' => BroadcastTenancyBootstrapper::class, // todo1 change this to []? two tests in TenantDatabaseManagerTest are failing with that
             'tenancy.bootstrappers.mail' => MailTenancyBootstrapper::class,
+            'tenancy.bootstrappers.url' => UrlTenancyBootstrapper::class,
             'queue.connections.central' => [
                 'driver' => 'sync',
                 'central' => true,
@@ -115,7 +118,9 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase
         ]);
 
         $app->singleton(RedisTenancyBootstrapper::class); // todo (Samuel) use proper approach eg config for singleton registration
+        $app->singleton(BroadcastTenancyBootstrapper::class);
         $app->singleton(MailTenancyBootstrapper::class);
+        $app->singleton(UrlTenancyBootstrapper::class);
     }
 
     protected function getPackageProviders($app)