Merge branch 'master' into cache-prefix

tests/BootstrapperTest.php

@@ -3,8 +3,8 @@
 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\Bootstrappers\PrefixCacheTenancyBootstrapper;
@@ -12,23 +12,30 @@ 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;
 use Stancl\Tenancy\CacheManager;
 
@@ -333,6 +340,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',
@@ -385,3 +468,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);
+});