diff --git a/src/Bootstrappers/DatabaseTenancyBootstrapper.php b/src/Bootstrappers/DatabaseTenancyBootstrapper.php index 08b36f1d4..175d8b569 100644 --- a/src/Bootstrappers/DatabaseTenancyBootstrapper.php +++ b/src/Bootstrappers/DatabaseTenancyBootstrapper.php @@ -53,8 +53,8 @@ public function bootstrap(Tenant $tenant): void { /** @var TenantWithDatabase $tenant */ if (data_get($tenant->database()->getTemplateConnection(), 'url')) { - // The package works with individual parts of the database connection config, so DATABASE_URL is not supported. - // When DATABASE_URL is set, this bootstrapper can silently fail i.e. keep using the template connection's database URL + // The package works with individual parts of the database connection config, so DB_URL is not supported. + // When DB_URL is set, this bootstrapper can silently fail i.e. keep using the template connection's database URL // which takes precedence over individual segments of the connection config. This issue can be hard to debug as it can be // production-specific. Therefore, we throw an exception (that effectively blocks all tenant pages) to prevent incorrect DB use. throw new Exception('The template connection must NOT have URL defined. Specify the connection using individual parts instead of a database URL.'); diff --git a/tests/Bootstrappers/DatabaseTenancyBootstrapperTest.php b/tests/Bootstrappers/DatabaseTenancyBootstrapperTest.php index 637626721..4debea9e4 100644 --- a/tests/Bootstrappers/DatabaseTenancyBootstrapperTest.php +++ b/tests/Bootstrappers/DatabaseTenancyBootstrapperTest.php @@ -12,7 +12,6 @@ use Stancl\Tenancy\Tests\Etc\Tenant; use Illuminate\Support\Str; use Illuminate\Support\Facades\DB; -use Illuminate\Database\QueryException; use Stancl\Tenancy\Database\TenantDatabaseManagers\MySQLDatabaseManager; use Stancl\Tenancy\Database\TenantDatabaseManagers\SQLiteDatabaseManager; use Stancl\Tenancy\Database\TenantDatabaseManagers\PostgreSQLDatabaseManager; @@ -116,7 +115,9 @@ expect(fn () => tenancy()->initialize($tenant))->toThrow(RuntimeException::class); // Connection should be reverted back to central - expect(DB::connection()->getName())->toBe('central'); + $centralConnection = config('tenancy.database.central_connection'); + + expect(DB::connection()->getName())->toBe($centralConnection); } else { expect(fn() => tenancy()->initialize($tenant))->not()->toThrow(Throwable::class); @@ -128,25 +129,22 @@ 'hardening disabled' => false, ])->with('db_managers'); -test('database tenancy bootstrapper throws an exception if DATABASE_URL is set', function (string|null $databaseUrl) { - config(['database.connections.central.url' => $databaseUrl]); - +test('database tenancy bootstrapper throws an exception if DB_URL is set', function (string|null $databaseUrl) { config(['tenancy.bootstrappers' => [DatabaseTenancyBootstrapper::class]]); Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) { return $event->tenant; })->toListener()); - if ($databaseUrl) { - expect(fn() => Tenant::create())->toThrow(QueryException::class); - } else { - expect(function() { - $tenant1 = Tenant::create(); + $tenant = Tenant::create(); - pest()->artisan('tenants:migrate'); + config(['database.connections.central.url' => $databaseUrl]); - tenancy()->initialize($tenant1); - })->not()->toThrow(Throwable::class); + if ($databaseUrl) { + expect(fn() => tenancy()->initialize($tenant)) + ->toThrow(Exception::class, 'The template connection must NOT have URL defined.'); + } else { + expect(fn() => tenancy()->initialize($tenant))->not()->toThrow(Throwable::class); } })->with(['abc.us-east-1.rds.amazonaws.com', null]); diff --git a/tests/TestCase.php b/tests/TestCase.php index cbc6f57ec..eb58a0d9c 100644 --- a/tests/TestCase.php +++ b/tests/TestCase.php @@ -131,7 +131,7 @@ protected function getEnvironmentSetUp($app) 'cache.stores.apc' => ['driver' => 'apc'], 'database.connections.central' => [ 'driver' => 'mysql', - 'url' => env('DATABASE_URL'), + 'url' => env('DB_URL'), 'host' => 'mysql', 'port' => env('DB_PORT', '3306'), 'database' => 'main',