From 342c67fe022271ac1005fa9d7a2af96781b202cb Mon Sep 17 00:00:00 2001 From: lukinovec Date: Wed, 1 Feb 2023 06:55:26 +0100 Subject: [PATCH 1/8] Add skip-failing option to the Migrate command (#945) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add and test Migrate command's skip-failing option * Improve naming * Move migration event dispatching inside try block * Change test name * Fix skip-failing test * Use QueryException instead of Exception * Correct TenantDatabaseDoesNotExistException import * Correct test * Check for the the testing env in DB bootstrapper * Correct the Migrate command * Fix code style (php-cs-fixer) * add docs todo * Add QueryException to the Migrat command try/catch * Return status codes in Migrate * Fix code style (php-cs-fixer) * Add test for not stopping tenants:migrate after the first failure * Update Migrate command * Fix code style (php-cs-fixer) * Fix code style (php-cs-fixer) * Use `getTenants()` * Use withtenantDatabases where needed * Add withTenantDatabases to test --------- Co-authored-by: PHP CS Fixer Co-authored-by: Samuel Štancl --- .../DatabaseTenancyBootstrapper.php | 2 +- src/Commands/Migrate.php | 27 ++++++++---- tests/AutomaticModeTest.php | 6 +++ tests/BatchTest.php | 2 + tests/CommandsTest.php | 42 +++++++++++++++++++ tests/MailTest.php | 4 ++ tests/Pest.php | 11 +++++ tests/QueueTest.php | 21 +++++----- 8 files changed, 95 insertions(+), 20 deletions(-) diff --git a/src/Bootstrappers/DatabaseTenancyBootstrapper.php b/src/Bootstrappers/DatabaseTenancyBootstrapper.php index c6dba079..f058dc43 100644 --- a/src/Bootstrappers/DatabaseTenancyBootstrapper.php +++ b/src/Bootstrappers/DatabaseTenancyBootstrapper.php @@ -25,7 +25,7 @@ class DatabaseTenancyBootstrapper implements TenancyBootstrapper /** @var TenantWithDatabase $tenant */ // Better debugging, but breaks cached lookup in prod - if (app()->environment('local')) { + if (app()->environment('local') || app()->environment('testing')) { // todo@docs mention this change in v4 upgrade guide https://github.com/archtechx/tenancy/pull/945#issuecomment-1268206149 $database = $tenant->database()->getName(); if (! $tenant->database()->manager()->databaseExists($database)) { throw new TenantDatabaseDoesNotExistException($database); diff --git a/src/Commands/Migrate.php b/src/Commands/Migrate.php index 0d2fceaa..47b95bd2 100644 --- a/src/Commands/Migrate.php +++ b/src/Commands/Migrate.php @@ -7,9 +7,11 @@ namespace Stancl\Tenancy\Commands; use Illuminate\Contracts\Events\Dispatcher; use Illuminate\Database\Console\Migrations\MigrateCommand; use Illuminate\Database\Migrations\Migrator; +use Illuminate\Database\QueryException; use Stancl\Tenancy\Concerns\DealsWithMigrations; use Stancl\Tenancy\Concerns\ExtendsLaravelCommand; use Stancl\Tenancy\Concerns\HasTenantOptions; +use Stancl\Tenancy\Database\Exceptions\TenantDatabaseDoesNotExistException; use Stancl\Tenancy\Events\DatabaseMigrated; use Stancl\Tenancy\Events\MigratingDatabase; @@ -28,6 +30,8 @@ class Migrate extends MigrateCommand { parent::__construct($migrator, $dispatcher); + $this->addOption('skip-failing'); + $this->specifyParameters(); } @@ -43,16 +47,23 @@ class Migrate extends MigrateCommand return 1; } - tenancy()->runForMultiple($this->getTenants(), function ($tenant) { - $this->components->info("Tenant: {$tenant->getTenantKey()}"); + foreach ($this->getTenants() as $tenant) { + try { + $tenant->run(function ($tenant) { + $this->line("Tenant: {$tenant->getTenantKey()}"); - event(new MigratingDatabase($tenant)); + event(new MigratingDatabase($tenant)); + // Migrate + parent::handle(); - // Migrate - parent::handle(); - - event(new DatabaseMigrated($tenant)); - }); + event(new DatabaseMigrated($tenant)); + }); + } catch (TenantDatabaseDoesNotExistException|QueryException $th) { + if (! $this->option('skip-failing')) { + throw $th; + } + } + } return 0; } diff --git a/tests/AutomaticModeTest.php b/tests/AutomaticModeTest.php index fc740fc1..1a0948ea 100644 --- a/tests/AutomaticModeTest.php +++ b/tests/AutomaticModeTest.php @@ -50,6 +50,8 @@ test('context is switched when tenancy is reinitialized', function () { }); test('central helper runs callbacks in the central state', function () { + withTenantDatabases(); + tenancy()->initialize($tenant = Tenant::create()); tenancy()->central(function () { @@ -60,6 +62,8 @@ test('central helper runs callbacks in the central state', function () { }); test('central helper returns the value from the callback', function () { + withTenantDatabases(); + tenancy()->initialize(Tenant::create()); pest()->assertSame('foo', tenancy()->central(function () { @@ -68,6 +72,8 @@ test('central helper returns the value from the callback', function () { }); test('central helper reverts back to tenant context', function () { + withTenantDatabases(); + tenancy()->initialize($tenant = Tenant::create()); tenancy()->central(function () { diff --git a/tests/BatchTest.php b/tests/BatchTest.php index 629a4e61..24cb7c59 100644 --- a/tests/BatchTest.php +++ b/tests/BatchTest.php @@ -23,6 +23,8 @@ beforeEach(function () { }); test('batch repository is set to tenant connection and reverted', function () { + withTenantDatabases(); + $tenant = Tenant::create(); $tenant2 = Tenant::create(); diff --git a/tests/CommandsTest.php b/tests/CommandsTest.php index 444830d1..e5da16b7 100644 --- a/tests/CommandsTest.php +++ b/tests/CommandsTest.php @@ -18,11 +18,13 @@ use Stancl\Tenancy\Events\TenantCreated; use Stancl\Tenancy\Events\TenantDeleted; use Stancl\Tenancy\Tests\Etc\TestSeeder; use Stancl\Tenancy\Events\DeletingTenant; +use Stancl\Tenancy\Events\DatabaseMigrated; use Stancl\Tenancy\Tests\Etc\ExampleSeeder; use Stancl\Tenancy\Events\TenancyInitialized; use Stancl\Tenancy\Listeners\BootstrapTenancy; use Stancl\Tenancy\Listeners\RevertToCentralContext; use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper; +use Stancl\Tenancy\Database\Exceptions\TenantDatabaseDoesNotExistException; beforeEach(function () { if (file_exists($schemaPath = 'tests/Etc/tenant-schema-test.dump')) { @@ -109,6 +111,46 @@ test('migrate command loads schema state', function () { expect(Schema::hasTable('users'))->toBeTrue(); }); +test('migrate command only throws exceptions if skip-failing is not passed', function() { + Tenant::create(); + + $tenantWithoutDatabase = Tenant::create(); + $databaseToDrop = $tenantWithoutDatabase->run(fn() => DB::connection()->getDatabaseName()); + + DB::statement("DROP DATABASE `$databaseToDrop`"); + + Tenant::create(); + + expect(fn() => pest()->artisan('tenants:migrate --schema-path="tests/Etc/tenant-schema.dump"'))->toThrow(TenantDatabaseDoesNotExistException::class); + expect(fn() => pest()->artisan('tenants:migrate --schema-path="tests/Etc/tenant-schema.dump" --skip-failing'))->not()->toThrow(TenantDatabaseDoesNotExistException::class); +}); + +test('migrate command does not stop after the first failure if skip-failing is passed', function() { + $tenants = collect([ + Tenant::create(), + $tenantWithoutDatabase = Tenant::create(), + Tenant::create(), + ]); + + $migratedTenants = 0; + + Event::listen(DatabaseMigrated::class, function() use (&$migratedTenants) { + $migratedTenants++; + }); + + $databaseToDrop = $tenantWithoutDatabase->run(fn() => DB::connection()->getDatabaseName()); + + DB::statement("DROP DATABASE `$databaseToDrop`"); + + Artisan::call('tenants:migrate', [ + '--schema-path' => '"tests/Etc/tenant-schema.dump"', + '--skip-failing' => true, + '--tenants' => $tenants->pluck('id')->toArray(), + ]); + + expect($migratedTenants)->toBe(2); +}); + test('dump command works', function () { $tenant = Tenant::create(); $schemaPath = 'tests/Etc/tenant-schema-test.dump'; diff --git a/tests/MailTest.php b/tests/MailTest.php index 544fda1b..c530b7e8 100644 --- a/tests/MailTest.php +++ b/tests/MailTest.php @@ -27,6 +27,8 @@ function assertMailerTransportUsesPassword(string|null $password) { }; test('mailer transport uses the correct credentials', function() { + withTenantDatabases(); + config(['mail.default' => 'smtp', 'mail.mailers.smtp.password' => $defaultPassword = 'DEFAULT']); MailTenancyBootstrapper::$credentialsMap = ['mail.mailers.smtp.password' => 'smtp_password']; @@ -52,6 +54,8 @@ test('mailer transport uses the correct credentials', function() { test('initializing and ending tenancy binds a fresh MailManager instance without cached mailers', function() { + withTenantDatabases(); + $mailers = fn() => invade(app(MailManager::class))->mailers; app(MailManager::class)->mailer('smtp'); diff --git a/tests/Pest.php b/tests/Pest.php index d7ca8c22..5380da0a 100644 --- a/tests/Pest.php +++ b/tests/Pest.php @@ -1,6 +1,10 @@ in(__DIR__); @@ -8,3 +12,10 @@ function pest(): TestCase { return Pest\TestSuite::getInstance()->test; } + +function withTenantDatabases() +{ + Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) { + return $event->tenant; + })->toListener()); +} diff --git a/tests/QueueTest.php b/tests/QueueTest.php index c1fa24b8..f88b3934 100644 --- a/tests/QueueTest.php +++ b/tests/QueueTest.php @@ -3,23 +3,23 @@ declare(strict_types=1); use Illuminate\Bus\Queueable; -use Illuminate\Contracts\Queue\ShouldQueue; -use Illuminate\Foundation\Bus\Dispatchable; -use Illuminate\Queue\InteractsWithQueue; -use Illuminate\Queue\SerializesModels; 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 Stancl\Tenancy\Events\TenancyInitialized; use Stancl\Tenancy\Listeners\BootstrapTenancy; use Stancl\Tenancy\Listeners\RevertToCentralContext; @@ -48,6 +48,8 @@ afterEach(function () { }); test('tenant id is passed to tenant queues', function () { + withTenantDatabases(); + config(['queue.default' => 'sync']); $tenant = Tenant::create(); @@ -64,6 +66,8 @@ test('tenant id is passed to tenant queues', function () { }); test('tenant id is not passed to central queues', function () { + withTenantDatabases(); + $tenant = Tenant::create(); tenancy()->initialize($tenant); @@ -156,6 +160,8 @@ test('tenancy is initialized when retrying jobs', function (bool $shouldEndTenan })->with([true, false]); test('the tenant used by the job doesnt change when the current tenant changes', function () { + withTenantDatabases(); + $tenant1 = Tenant::create([ 'id' => 'acme', ]); @@ -217,13 +223,6 @@ function withUsers() }); } -function withTenantDatabases() -{ - Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) { - return $event->tenant; - })->toListener()); -} - class TestJob implements ShouldQueue { use Dispatchable, InteractsWithQueue, Queueable, SerializesModels; From 087733d5dbd3ea3c53c38bb927905fb9e9c6be8e Mon Sep 17 00:00:00 2001 From: Abrar Ahmad Date: Wed, 1 Feb 2023 11:02:03 +0500 Subject: [PATCH 2/8] Allow defining the tenant connection template using array syntax in config (#1040) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * `template_tenant_connection` can be array or string * Update TenantDatabaseManagerTest.php * Update TenantDatabaseManagerTest.php * Update TenantDatabaseManagerTest.php * Update DatabaseConfig.php * partial database config for template * Update tests/TenantDatabaseManagerTest.php Co-authored-by: lukinovec * update test name * improve test names * add comments --------- Co-authored-by: lukinovec Co-authored-by: Samuel Štancl --- src/Database/DatabaseConfig.php | 42 ++++++++++------ tests/TenantDatabaseManagerTest.php | 75 +++++++++++++++++++++++++++++ 2 files changed, 103 insertions(+), 14 deletions(-) diff --git a/src/Database/DatabaseConfig.php b/src/Database/DatabaseConfig.php index 309d828f..52cb464c 100644 --- a/src/Database/DatabaseConfig.php +++ b/src/Database/DatabaseConfig.php @@ -87,7 +87,7 @@ class DatabaseConfig { $this->tenant->setInternal('db_name', $this->getName()); - if ($this->connectionDriverManager($this->getTemplateConnectionName()) instanceof Contracts\ManagesDatabaseUsers) { + if ($this->connectionDriverManager($this->getTemplateConnectionDriver()) instanceof Contracts\ManagesDatabaseUsers) { $this->tenant->setInternal('db_username', $this->getUsername() ?? (static::$usernameGenerator)($this->tenant)); $this->tenant->setInternal('db_password', $this->getPassword() ?? (static::$passwordGenerator)($this->tenant)); } @@ -97,11 +97,29 @@ class DatabaseConfig } } - public function getTemplateConnectionName(): string + public function getTemplateConnectionDriver(): string { - return $this->tenant->getInternal('db_connection') - ?? config('tenancy.database.template_tenant_connection') - ?? config('tenancy.database.central_connection'); + return $this->getTemplateConnection()['driver']; + } + + public function getTemplateConnection(): array + { + if ($template = $this->tenant->getInternal('db_connection')) { + return config("database.connections.{$template}"); + } + + if ($template = config('tenancy.database.template_tenant_connection')) { + return is_array($template) ? array_merge($this->getCentralConnection(), $template) : config("database.connections.{$template}"); + } + + return $this->getCentralConnection(); + } + + protected function getCentralConnection(): array + { + $centralConnectionName = config('tenancy.database.central_connection'); + + return config("database.connections.{$centralConnectionName}"); } public function getTenantHostConnectionName(): string @@ -114,8 +132,7 @@ class DatabaseConfig */ public function connection(): array { - $template = $this->getTemplateConnectionName(); - $templateConnection = config("database.connections.{$template}"); + $templateConnection = $this->getTemplateConnection(); return $this->manager()->makeConnectionConfig( array_merge($templateConnection, $this->tenantConfig()), @@ -129,10 +146,9 @@ class DatabaseConfig public function hostConnection(): array { $config = $this->tenantConfig(); - $template = $this->getTemplateConnectionName(); - $templateConnection = config("database.connections.{$template}"); + $templateConnection = $this->getTemplateConnection(); - if ($this->connectionDriverManager($template) instanceof Contracts\ManagesDatabaseUsers) { + if ($this->connectionDriverManager($this->getTemplateConnectionDriver()) instanceof Contracts\ManagesDatabaseUsers) { // We're removing the username and password because user with these credentials is not created yet // If you need to provide username and password when using PermissionControlledMySQLDatabaseManager, // consider creating a new connection and use it as `tenancy_db_connection` tenant config key @@ -196,7 +212,7 @@ class DatabaseConfig $tenantHostConnectionName = $this->getTenantHostConnectionName(); config(["database.connections.{$tenantHostConnectionName}" => $this->hostConnection()]); - $manager = $this->connectionDriverManager($tenantHostConnectionName); + $manager = $this->connectionDriverManager(config("database.connections.{$tenantHostConnectionName}.driver")); if ($manager instanceof Contracts\StatefulTenantDatabaseManager) { $manager->setConnection($tenantHostConnectionName); @@ -211,10 +227,8 @@ class DatabaseConfig * * @throws DatabaseManagerNotRegisteredException */ - protected function connectionDriverManager(string $connectionName): Contracts\TenantDatabaseManager + protected function connectionDriverManager(string $driver): Contracts\TenantDatabaseManager { - $driver = config("database.connections.{$connectionName}.driver"); - $databaseManagers = config('tenancy.database.managers'); if (! array_key_exists($driver, $databaseManagers)) { diff --git a/tests/TenantDatabaseManagerTest.php b/tests/TenantDatabaseManagerTest.php index 19b74e21..5d9a15d6 100644 --- a/tests/TenantDatabaseManagerTest.php +++ b/tests/TenantDatabaseManagerTest.php @@ -390,6 +390,81 @@ test('path used by sqlite manager can be customized', function () { expect(file_exists($customPath . '/' . $name))->toBeTrue(); }); +test('the tenant connection template can be specified either by name or as a connection array', function () { + Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) { + return $event->tenant; + })->toListener()); + + config([ + 'tenancy.database.managers.mysql' => MySQLDatabaseManager::class, + 'tenancy.database.template_tenant_connection' => 'mysql', + ]); + + $name = 'foo' . Str::random(8); + $tenant = Tenant::create([ + 'tenancy_db_name' => $name, + ]); + + /** @var MySQLDatabaseManager $manager */ + $manager = $tenant->database()->manager(); + expect($manager->databaseExists($name))->toBeTrue(); + expect($manager->database()->getConfig('host'))->toBe('mysql'); + + config([ + 'tenancy.database.template_tenant_connection' => [ + 'driver' => 'mysql', + 'url' => null, + 'host' => 'mysql2', + 'port' => '3306', + 'database' => 'main', + 'username' => 'root', + 'password' => 'password', + 'unix_socket' => '', + 'charset' => 'utf8mb4', + 'collation' => 'utf8mb4_unicode_ci', + 'prefix' => '', + 'prefix_indexes' => true, + 'strict' => true, + 'engine' => null, + 'options' => [], + ], + ]); + + $tenant = Tenant::create([ + 'tenancy_db_name' => $name, + ]); + + /** @var MySQLDatabaseManager $manager */ + $manager = $tenant->database()->manager(); + expect($manager->databaseExists($name))->toBeTrue(); // tenant connection works + expect($manager->database()->getConfig('host'))->toBe('mysql2'); +}); + +test('partial tenant connection templates get merged into the central connection template', function () { + Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) { + return $event->tenant; + })->toListener()); + + config([ + 'database.connections.central.url' => 'example.com', + 'tenancy.database.template_tenant_connection' => [ + 'url' => null, + 'host' => 'mysql2', + ], + ]); + + $name = 'foo' . Str::random(8); + $tenant = Tenant::create([ + 'tenancy_db_name' => $name, + ]); + + /** @var MySQLDatabaseManager $manager */ + $manager = $tenant->database()->manager(); + expect($manager->databaseExists($name))->toBeTrue(); // tenant connection works + expect($manager->database()->getConfig('host'))->toBe('mysql2'); + expect($manager->database()->getConfig('url'))->toBeNull(); +}); + // Datasets dataset('database_managers', [ ['mysql', MySQLDatabaseManager::class], From 758fbc8a750fd394611601c029e4aeccae3cdb5d Mon Sep 17 00:00:00 2001 From: Abrar Ahmad Date: Thu, 2 Feb 2023 10:39:35 +0500 Subject: [PATCH 3/8] Use polymorphic table for mapping resources to tenants (#997) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * wip * Fix code style (php-cs-fixer) * adjust tests * Update ResourceSyncingPolymorphicTest.php * Update SyncMaster.php * correct method name * Update ResourceSyncingPolymorphicTest.php * use BelongsToMany return type * separate pivot model for each approach * ability to publish migrations * remove unsed import * use resource migrations from asset * anonymous migration for `tenant_resources` table * rename file * rename classes * trait * add back using statement * revert to unset change * use unset approach * use unset approach * Assert `tenants` are accessible * Update ResourceSyncingUsingPolymorphicTest.php * improve `tenants` assertions * improve assertions * remove `getResourceTenantModelName` method and use config * use `BelongsToMany` for `tenants` method return type * Fix code style (php-cs-fixer) * revert type * use correct key * test right resources are accessible from the tenant * Update tests/ResourceSyncingUsingPolymorphicTest.php --------- Co-authored-by: PHP CS Fixer Co-authored-by: Samuel Štancl --- ...1_000002_create_tenant_resources_table.php | 25 ++ src/Database/Concerns/ResourceSyncing.php | 8 + src/Database/Concerns/TriggerSyncEvent.php | 21 + src/Database/Models/TenantMorphPivot.php | 13 + src/Database/Models/TenantPivot.php | 13 +- src/TenancyServiceProvider.php | 4 + ..._11_000001_test_create_companies_table.php | 30 ++ tests/ResourceSyncingTest.php | 2 +- tests/ResourceSyncingUsingPolymorphicTest.php | 398 ++++++++++++++++++ 9 files changed, 502 insertions(+), 12 deletions(-) create mode 100644 assets/resource-syncing-migrations/2020_05_11_000002_create_tenant_resources_table.php create mode 100644 src/Database/Concerns/TriggerSyncEvent.php create mode 100644 src/Database/Models/TenantMorphPivot.php create mode 100644 tests/Etc/synced_resource_migrations/companies/2020_05_11_000001_test_create_companies_table.php create mode 100644 tests/ResourceSyncingUsingPolymorphicTest.php diff --git a/assets/resource-syncing-migrations/2020_05_11_000002_create_tenant_resources_table.php b/assets/resource-syncing-migrations/2020_05_11_000002_create_tenant_resources_table.php new file mode 100644 index 00000000..3e8ef18f --- /dev/null +++ b/assets/resource-syncing-migrations/2020_05_11_000002_create_tenant_resources_table.php @@ -0,0 +1,25 @@ +increments('id'); + $table->string('tenant_id'); + $table->string('resource_global_id'); + $table->string('tenant_resources_type'); + }); + } + + public function down(): void + { + Schema::dropIfExists('tenant_resources'); + } +}; diff --git a/src/Database/Concerns/ResourceSyncing.php b/src/Database/Concerns/ResourceSyncing.php index ea9f83b4..9caacda5 100644 --- a/src/Database/Concerns/ResourceSyncing.php +++ b/src/Database/Concerns/ResourceSyncing.php @@ -4,8 +4,10 @@ declare(strict_types=1); namespace Stancl\Tenancy\Database\Concerns; +use Illuminate\Database\Eloquent\Relations\MorphToMany; use Stancl\Tenancy\Contracts\Syncable; use Stancl\Tenancy\Contracts\UniqueIdentifierGenerator; +use Stancl\Tenancy\Database\Models\TenantMorphPivot; use Stancl\Tenancy\Events\SyncedResourceSaved; trait ResourceSyncing @@ -43,4 +45,10 @@ trait ResourceSyncing { return true; } + + public function tenants(): MorphToMany + { + return $this->morphToMany(config('tenancy.models.tenant'), 'tenant_resources', 'tenant_resources', 'resource_global_id', 'tenant_id', 'global_id') + ->using(TenantMorphPivot::class); + } } diff --git a/src/Database/Concerns/TriggerSyncEvent.php b/src/Database/Concerns/TriggerSyncEvent.php new file mode 100644 index 00000000..13207762 --- /dev/null +++ b/src/Database/Concerns/TriggerSyncEvent.php @@ -0,0 +1,21 @@ +pivotParent; + + if ($parent instanceof Syncable && $parent->shouldSync()) { + $parent->triggerSyncEvent(); + } + }); + } +} diff --git a/src/Database/Models/TenantMorphPivot.php b/src/Database/Models/TenantMorphPivot.php new file mode 100644 index 00000000..b10d9d32 --- /dev/null +++ b/src/Database/Models/TenantMorphPivot.php @@ -0,0 +1,13 @@ +pivotParent; - - if ($parent instanceof Syncable && $parent->shouldSync()) { - $parent->triggerSyncEvent(); - } - }); - } + use TriggerSyncEvent; } diff --git a/src/TenancyServiceProvider.php b/src/TenancyServiceProvider.php index ee34ef1e..23fb6473 100644 --- a/src/TenancyServiceProvider.php +++ b/src/TenancyServiceProvider.php @@ -106,6 +106,10 @@ class TenancyServiceProvider extends ServiceProvider __DIR__ . '/../assets/impersonation-migrations/' => database_path('migrations'), ], 'impersonation-migrations'); + $this->publishes([ + __DIR__ . '/../assets/resource-syncing-migrations/' => database_path('migrations'), + ], 'resource-syncing-migrations'); + $this->publishes([ __DIR__ . '/../assets/tenant_routes.stub.php' => base_path('routes/tenant.php'), ], 'routes'); diff --git a/tests/Etc/synced_resource_migrations/companies/2020_05_11_000001_test_create_companies_table.php b/tests/Etc/synced_resource_migrations/companies/2020_05_11_000001_test_create_companies_table.php new file mode 100644 index 00000000..2d61a45d --- /dev/null +++ b/tests/Etc/synced_resource_migrations/companies/2020_05_11_000001_test_create_companies_table.php @@ -0,0 +1,30 @@ +increments('id'); + $table->string('global_id')->unique(); + $table->string('name'); + $table->string('email'); + }); + } + + public function down() + { + Schema::dropIfExists('companies'); + } +} diff --git a/tests/ResourceSyncingTest.php b/tests/ResourceSyncingTest.php index 811b8d1a..a988178e 100644 --- a/tests/ResourceSyncingTest.php +++ b/tests/ResourceSyncingTest.php @@ -832,7 +832,7 @@ function migrateUsersTableForTenants(): void // Tenant model used for resource syncing setup class ResourceTenant extends Tenant { - public function users() + public function users(): BelongsToMany { return $this->belongsToMany(CentralUser::class, 'tenant_users', 'tenant_id', 'global_user_id', 'id', 'global_id') ->using(TenantPivot::class); diff --git a/tests/ResourceSyncingUsingPolymorphicTest.php b/tests/ResourceSyncingUsingPolymorphicTest.php new file mode 100644 index 00000000..408fd4ef --- /dev/null +++ b/tests/ResourceSyncingUsingPolymorphicTest.php @@ -0,0 +1,398 @@ + [ + DatabaseTenancyBootstrapper::class, + ], + 'tenancy.models.tenant' => ResourceTenantUsingPolymorphic::class, + ]); + + Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) { + return $event->tenant; + })->toListener()); + + DatabaseConfig::generateDatabaseNamesUsing(function () { + return 'db' . Str::random(16); + }); + + Event::listen(TenancyInitialized::class, BootstrapTenancy::class); + Event::listen(TenancyEnded::class, RevertToCentralContext::class); + + UpdateSyncedResource::$shouldQueue = false; // Global state cleanup + Event::listen(SyncedResourceSaved::class, UpdateSyncedResource::class); + + // Run migrations on central connection + pest()->artisan('migrate', [ + '--path' => [ + __DIR__ . '/../assets/resource-syncing-migrations', + __DIR__ . '/Etc/synced_resource_migrations/users', + __DIR__ . '/Etc/synced_resource_migrations/companies', + ], + '--realpath' => true, + ])->assertExitCode(0); +}); + +test('resource syncing works using a single pivot table for multiple models when syncing from central to tenant', function () { + $tenant1 = ResourceTenantUsingPolymorphic::create(['id' => 't1']); + migrateUsersTableForTenants(); + + $centralUser = CentralUserUsingPolymorphic::create([ + 'global_id' => 'acme', + 'name' => 'John Doe', + 'email' => 'john@localhost', + 'password' => 'password', + 'role' => 'commenter', + ]); + + $tenant1->run(function () { + expect(TenantUserUsingPolymorphic::all())->toHaveCount(0); + }); + + $centralUser->tenants()->attach('t1'); + + // Assert `tenants` are accessible + expect($centralUser->tenants->pluck('id')->toArray())->toBe(['t1']); + + // Users are accessible from tenant + expect($tenant1->users()->pluck('email')->toArray())->toBe(['john@localhost']); + + // Assert User resource is synced + $tenant1->run(function () use ($centralUser) { + $tenantUser = TenantUserUsingPolymorphic::first()->toArray(); + $centralUser = $centralUser->withoutRelations()->toArray(); + unset($centralUser['id'], $tenantUser['id']); + + expect($tenantUser)->toBe($centralUser); + }); + + $tenant2 = ResourceTenantUsingPolymorphic::create(['id' => 't2']); + migrateCompaniesTableForTenants(); + + $centralCompany = CentralCompanyUsingPolymorphic::create([ + 'global_id' => 'acme', + 'name' => 'ArchTech', + 'email' => 'archtech@localhost', + ]); + + $tenant2->run(function () { + expect(TenantCompanyUsingPolymorphic::all())->toHaveCount(0); + }); + + $centralCompany->tenants()->attach('t2'); + + // Assert `tenants` are accessible + expect($centralCompany->tenants->pluck('id')->toArray())->toBe(['t2']); + + // Companies are accessible from tenant + expect($tenant2->companies()->pluck('email')->toArray())->toBe(['archtech@localhost']); + + // Assert Company resource is synced + $tenant2->run(function () use ($centralCompany) { + $tenantCompany = TenantCompanyUsingPolymorphic::first()->toArray(); + $centralCompany = $centralCompany->withoutRelations()->toArray(); + + unset($centralCompany['id'], $tenantCompany['id']); + + expect($tenantCompany)->toBe($centralCompany); + }); +}); + +test('resource syncing works using a single pivot table for multiple models when syncing from tenant to central', function () { + $tenant1 = ResourceTenantUsingPolymorphic::create(['id' => 't1']); + migrateUsersTableForTenants(); + + tenancy()->initialize($tenant1); + + $tenantUser = TenantUserUsingPolymorphic::create([ + 'name' => 'John Doe', + 'email' => 'john@localhost', + 'password' => 'password', + 'role' => 'commenter', + ]); + + tenancy()->end(); + + // Assert User resource is synced + $centralUser = CentralUserUsingPolymorphic::first(); + + // Assert `tenants` are accessible + expect($centralUser->tenants->pluck('id')->toArray())->toBe(['t1']); + + // Users are accessible from tenant + expect($tenant1->users()->pluck('email')->toArray())->toBe(['john@localhost']); + + $centralUser = $centralUser->withoutRelations()->toArray(); + $tenantUser = $tenantUser->toArray(); + unset($centralUser['id'], $tenantUser['id']); + + // array keys use a different order here + expect($tenantUser)->toEqualCanonicalizing($centralUser); + + $tenant2 = ResourceTenantUsingPolymorphic::create(['id' => 't2']); + migrateCompaniesTableForTenants(); + + tenancy()->initialize($tenant2); + + $tenantCompany = TenantCompanyUsingPolymorphic::create([ + 'global_id' => 'acme', + 'name' => 'tenant comp', + 'email' => 'company@localhost', + ]); + + tenancy()->end(); + + // Assert Company resource is synced + $centralCompany = CentralCompanyUsingPolymorphic::first(); + + // Assert `tenants` are accessible + expect($centralCompany->tenants->pluck('id')->toArray())->toBe(['t2']); + + // Companies are accessible from tenant + expect($tenant2->companies()->pluck('email')->toArray())->toBe(['company@localhost']); + + $centralCompany = $centralCompany->withoutRelations()->toArray(); + $tenantCompany = $tenantCompany->toArray(); + unset($centralCompany['id'], $tenantCompany['id']); + + expect($tenantCompany)->toBe($centralCompany); +}); + +test('right resources are accessible from the tenant', function () { + $tenant1 = ResourceTenantUsingPolymorphic::create(['id' => 't1']); + $tenant2 = ResourceTenantUsingPolymorphic::create(['id' => 't2']); + migrateUsersTableForTenants(); + + $user1 = CentralUserUsingPolymorphic::create([ + 'global_id' => 'user1', + 'name' => 'user1', + 'email' => 'user1@localhost', + 'password' => 'password', + 'role' => 'commenter', + ]); + + $user2 = CentralUserUsingPolymorphic::create([ + 'global_id' => 'user2', + 'name' => 'user2', + 'email' => 'user2@localhost', + 'password' => 'password', + 'role' => 'commenter', + ]); + + $user3 = CentralUserUsingPolymorphic::create([ + 'global_id' => 'user3', + 'name' => 'user3', + 'email' => 'user3@localhost', + 'password' => 'password', + 'role' => 'commenter', + ]); + + $user1->tenants()->attach('t1'); + $user2->tenants()->attach('t1'); + $user3->tenants()->attach('t2'); + + expect($tenant1->users()->pluck('email')->toArray())->toBe([$user1->email, $user2->email]); + expect($tenant2->users()->pluck('email')->toArray())->toBe([$user3->email]); +}); + +function migrateCompaniesTableForTenants(): void +{ + pest()->artisan('tenants:migrate', [ + '--path' => __DIR__ . '/Etc/synced_resource_migrations/companies', + '--realpath' => true, + ])->assertExitCode(0); +} + +// Tenant model used for resource syncing setup +class ResourceTenantUsingPolymorphic extends Tenant +{ + public function users(): MorphToMany + { + return $this->morphedByMany(CentralUserUsingPolymorphic::class, 'tenant_resources', 'tenant_resources', 'tenant_id', 'resource_global_id', 'id', 'global_id') + ->using(TenantMorphPivot::class); + } + + public function companies(): MorphToMany + { + return $this->morphedByMany(CentralCompanyUsingPolymorphic::class, 'tenant_resources', 'tenant_resources', 'tenant_id', 'resource_global_id', 'id', 'global_id') + ->using(TenantMorphPivot::class); + } +} + +class CentralUserUsingPolymorphic extends Model implements SyncMaster +{ + use ResourceSyncing, CentralConnection; + + protected $guarded = []; + + public $timestamps = false; + + public $table = 'users'; + + public function getTenantModelName(): string + { + return TenantUserUsingPolymorphic::class; + } + + public function getGlobalIdentifierKey(): string|int + { + return $this->getAttribute($this->getGlobalIdentifierKeyName()); + } + + public function getGlobalIdentifierKeyName(): string + { + return 'global_id'; + } + + public function getCentralModelName(): string + { + return static::class; + } + + public function getSyncedAttributeNames(): array + { + return [ + 'global_id', + 'name', + 'password', + 'email', + ]; + } +} + +class TenantUserUsingPolymorphic extends Model implements Syncable +{ + use ResourceSyncing; + + protected $table = 'users'; + + protected $guarded = []; + + public $timestamps = false; + + public function getGlobalIdentifierKey(): string|int + { + return $this->getAttribute($this->getGlobalIdentifierKeyName()); + } + + public function getGlobalIdentifierKeyName(): string + { + return 'global_id'; + } + + public function getCentralModelName(): string + { + return CentralUserUsingPolymorphic::class; + } + + public function getSyncedAttributeNames(): array + { + return [ + 'global_id', + 'name', + 'password', + 'email', + ]; + } +} + +class CentralCompanyUsingPolymorphic extends Model implements SyncMaster +{ + use ResourceSyncing, CentralConnection; + + protected $guarded = []; + + public $timestamps = false; + + public $table = 'companies'; + + public function getTenantModelName(): string + { + return TenantCompanyUsingPolymorphic::class; + } + + public function getGlobalIdentifierKey(): string|int + { + return $this->getAttribute($this->getGlobalIdentifierKeyName()); + } + + public function getGlobalIdentifierKeyName(): string + { + return 'global_id'; + } + + public function getCentralModelName(): string + { + return static::class; + } + + public function getSyncedAttributeNames(): array + { + return [ + 'global_id', + 'name', + 'email', + ]; + } +} + +class TenantCompanyUsingPolymorphic extends Model implements Syncable +{ + use ResourceSyncing; + + protected $table = 'companies'; + + protected $guarded = []; + + public $timestamps = false; + + public function getGlobalIdentifierKey(): string|int + { + return $this->getAttribute($this->getGlobalIdentifierKeyName()); + } + + public function getGlobalIdentifierKeyName(): string + { + return 'global_id'; + } + + public function getCentralModelName(): string + { + return CentralCompanyUsingPolymorphic::class; + } + + public function getSyncedAttributeNames(): array + { + return [ + 'global_id', + 'name', + 'email', + ]; + } +} + From a006e498816c16444b65be8537534f360c97b9c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samuel=20=C5=A0tancl?= Date: Thu, 16 Feb 2023 17:20:55 +0100 Subject: [PATCH 4/8] specify version of odbc libraries --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 5dfe442c..421e43d8 100644 --- a/Dockerfile +++ b/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 \ From 617e9a7a7392705d058e4f030c68795d30a8a93f Mon Sep 17 00:00:00 2001 From: lukinovec Date: Fri, 17 Feb 2023 10:56:43 +0100 Subject: [PATCH 5/8] [4.x] Allow user to customize tenant's URL root in CLI (#1044) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add UrlTenancyBootstrapper * Fix code style (php-cs-fixer) * Move URL overriding to a separate method, call it in `boot()` * Test URL root overriding * Change parameter formatting Co-authored-by: Samuel Štancl * Fix code style (php-cs-fixer) * Improve URL bootstrapper test * Move `$scheme` and `$hostname` to the closure * Update code example comment * Hardcode values instead of referencing variables * Delete extra line --------- Co-authored-by: PHP CS Fixer Co-authored-by: Samuel Štancl --- assets/TenancyServiceProvider.stub.php | 26 ++++++++--- assets/config.php | 1 + src/Bootstrappers/UrlTenancyBootstrapper.php | 35 +++++++++++++++ tests/BootstrapperTest.php | 46 +++++++++++++++++++- 4 files changed, 102 insertions(+), 6 deletions(-) create mode 100644 src/Bootstrappers/UrlTenancyBootstrapper.php diff --git a/assets/TenancyServiceProvider.stub.php b/assets/TenancyServiceProvider.stub.php index 6735b37f..a2679061 100644 --- a/assets/TenancyServiceProvider.stub.php +++ b/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 { @@ -118,6 +118,21 @@ class TenancyServiceProvider extends ServiceProvider ]; } + protected function overrideUrlInTenantContext(): void + { + /** + * Example of CLI tenant URL root override: + * + * UrlTenancyBootstrapper::$rootUrlOverride = function (Tenant $tenant) { + * $baseUrl = url('/'); + * $scheme = str($baseUrl)->before('://'); + * $hostname = str($baseUrl)->after($scheme . '://'); + * + * return $scheme . '://' . $tenant->getTenantKey() . '.' . $hostname; + *}; + */ + } + public function register() { // @@ -129,6 +144,7 @@ class TenancyServiceProvider extends ServiceProvider $this->mapRoutes(); $this->makeTenancyMiddlewareHighestPriority(); + $this->overrideUrlInTenantContext(); } protected function bootEvents() diff --git a/assets/config.php b/assets/config.php index c6f3e5a9..bbfa9974 100644 --- a/assets/config.php +++ b/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 diff --git a/src/Bootstrappers/UrlTenancyBootstrapper.php b/src/Bootstrappers/UrlTenancyBootstrapper.php new file mode 100644 index 00000000..0a4122a6 --- /dev/null +++ b/src/Bootstrappers/UrlTenancyBootstrapper.php @@ -0,0 +1,35 @@ +originalRootUrl = $this->urlGenerator->to('/'); + + if (static::$rootUrlOverride) { + $this->urlGenerator->forceRootUrl((static::$rootUrlOverride)($tenant)); + } + } + + public function revert(): void + { + $this->urlGenerator->forceRootUrl($this->originalRootUrl); + } +} diff --git a/tests/BootstrapperTest.php b/tests/BootstrapperTest.php index 3cc50b58..fc2d4709 100644 --- a/tests/BootstrapperTest.php +++ b/tests/BootstrapperTest.php @@ -3,14 +3,15 @@ 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; @@ -24,9 +25,11 @@ use Stancl\Tenancy\Jobs\RemoveStorageSymlinks; use Stancl\Tenancy\Listeners\BootstrapTenancy; 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\FilesystemTenancyBootstrapper; @@ -380,3 +383,44 @@ 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')); + + $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); + + tenancy()->initialize($tenant); + + expect(url(route('home')))->toBe($tenantUrl); + expect(URL::to('/'))->toBe($tenantUrl); + + tenancy()->end(); + + expect(url(route('home')))->toBe($baseUrl); + expect(URL::to('/'))->toBe($baseUrl); +}); From fbdb13f392ba137f8e771099574beb4dcb6cfa0c Mon Sep 17 00:00:00 2001 From: lukinovec Date: Sat, 18 Feb 2023 13:01:17 +0100 Subject: [PATCH 6/8] [4.x] Set `app.url` config in UrlTenancyBootstrapper (#1068) * Set `app.url` config in UrlTenancyBootstrapper * Add assertions * Set base app URL in config * Make UrlTenancyBootstrapper a singleton --- src/Bootstrappers/UrlTenancyBootstrapper.php | 8 +++++++- tests/BootstrapperTest.php | 4 ++++ tests/TestCase.php | 16 +++++++++------- 3 files changed, 20 insertions(+), 8 deletions(-) diff --git a/src/Bootstrappers/UrlTenancyBootstrapper.php b/src/Bootstrappers/UrlTenancyBootstrapper.php index 0a4122a6..db27c8c5 100644 --- a/src/Bootstrappers/UrlTenancyBootstrapper.php +++ b/src/Bootstrappers/UrlTenancyBootstrapper.php @@ -5,6 +5,7 @@ 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; @@ -16,6 +17,7 @@ class UrlTenancyBootstrapper implements TenancyBootstrapper public function __construct( protected UrlGenerator $urlGenerator, + protected Repository $config, ) { } @@ -24,12 +26,16 @@ class UrlTenancyBootstrapper implements TenancyBootstrapper $this->originalRootUrl = $this->urlGenerator->to('/'); if (static::$rootUrlOverride) { - $this->urlGenerator->forceRootUrl((static::$rootUrlOverride)($tenant)); + $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); } } diff --git a/tests/BootstrapperTest.php b/tests/BootstrapperTest.php index fc2d4709..fbc4f0b3 100644 --- a/tests/BootstrapperTest.php +++ b/tests/BootstrapperTest.php @@ -396,6 +396,7 @@ test('url bootstrapper overrides the root url when tenancy gets initialized and }); $baseUrl = url(route('home')); + config(['app.url' => $baseUrl]); $rootUrlOverride = function (Tenant $tenant) use ($baseUrl) { $scheme = str($baseUrl)->before('://'); @@ -413,14 +414,17 @@ test('url bootstrapper overrides the root url when tenancy gets initialized and 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); }); diff --git a/tests/TestCase.php b/tests/TestCase.php index 07af199f..f6589688 100644 --- a/tests/TestCase.php +++ b/tests/TestCase.php @@ -4,17 +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\UrlTenancyBootstrapper; use Stancl\Tenancy\Bootstrappers\MailTenancyBootstrapper; +use Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper; abstract class TestCase extends \Orchestra\Testbench\TestCase { @@ -106,6 +106,7 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase ], 'tenancy.bootstrappers.redis' => RedisTenancyBootstrapper::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, @@ -116,6 +117,7 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase $app->singleton(RedisTenancyBootstrapper::class); // todo (Samuel) use proper approach eg config for singleton registration $app->singleton(MailTenancyBootstrapper::class); + $app->singleton(UrlTenancyBootstrapper::class); } protected function getPackageProviders($app) From d7a4982cd3f85b1718cca5a9acce83a3cc4fec7c Mon Sep 17 00:00:00 2001 From: lukinovec Date: Sat, 18 Feb 2023 15:52:55 +0100 Subject: [PATCH 7/8] [4.x] Make broadcasting work with Tenancy (#1027) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add BroadcastTenancyBootstrapper and TenancyBroadcastManager * Fix code style (php-cs-fixer) * Bind original BroadcastManager again on `revert()` * Fix code style (php-cs-fixer) * Move manager to correct directory * Fix property type * Make BroadcastTenancyBootstrapper a singleton in tests * Fix code style (php-cs-fixer) * Bind the original broadcaster instance on `revert()` * Instead of just forgetting the old broadcaster instance, bind the new one * Add BroadcastTenancyBootstrapper tests * Separate the test * Fix code style (php-cs-fixer) * Add bootstrapper test * Add broadcaster channels test * Clean up BootstrapperTest * Fix BroadcastingTest * Add comments to TenancyBroadcastManager * Add BroadcastTenancyBootstrapper comments * Simplify BroadcastManager extension, remove setDriver method * Add comment * Fix PHPStan errors * Fix PHPStan errors * Remove duplicate import * Fix test * Delete `::class` from test name Co-authored-by: Samuel Štancl * Create databases for newly created tenants in BroadcastingTest * move spatie/invade to require --------- Co-authored-by: PHP CS Fixer Co-authored-by: Samuel Štancl --- composer.json | 3 +- .../BroadcastTenancyBootstrapper.php | 95 +++++++++++++++++++ src/TenancyBroadcastManager.php | 65 +++++++++++++ tests/BootstrapperTest.php | 80 ++++++++++++++++ tests/BroadcastingTest.php | 65 +++++++++++++ tests/Etc/TestingBroadcaster.php | 25 +++++ tests/TestCase.php | 5 +- 7 files changed, 336 insertions(+), 2 deletions(-) create mode 100644 src/Bootstrappers/BroadcastTenancyBootstrapper.php create mode 100644 src/TenancyBroadcastManager.php create mode 100644 tests/BroadcastingTest.php create mode 100644 tests/Etc/TestingBroadcaster.php diff --git a/composer.json b/composer.json index 0ca231c4..bb11040e 100644 --- a/composer.json +++ b/composer.json @@ -21,7 +21,8 @@ "spatie/ignition": "^1.4", "ramsey/uuid": "^4.0", "stancl/jobpipeline": "^1.0", - "stancl/virtualcolumn": "^1.3" + "stancl/virtualcolumn": "^1.3", + "spatie/invade": "^1.1" }, "require-dev": { "laravel/framework": "^9.38", diff --git a/src/Bootstrappers/BroadcastTenancyBootstrapper.php b/src/Bootstrappers/BroadcastTenancyBootstrapper.php new file mode 100644 index 00000000..2f625437 --- /dev/null +++ b/src/Bootstrappers/BroadcastTenancyBootstrapper.php @@ -0,0 +1,95 @@ + '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); + } + } +} diff --git a/src/TenancyBroadcastManager.php b/src/TenancyBroadcastManager.php new file mode 100644 index 00000000..59e30b57 --- /dev/null +++ b/src/TenancyBroadcastManager.php @@ -0,0 +1,65 @@ +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)); + } + } +} diff --git a/tests/BootstrapperTest.php b/tests/BootstrapperTest.php index fbc4f0b3..7350f0a8 100644 --- a/tests/BootstrapperTest.php +++ b/tests/BootstrapperTest.php @@ -18,11 +18,14 @@ 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; @@ -31,6 +34,7 @@ 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 () { @@ -331,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', diff --git a/tests/BroadcastingTest.php b/tests/BroadcastingTest.php new file mode 100644 index 00000000..aeb70de2 --- /dev/null +++ b/tests/BroadcastingTest.php @@ -0,0 +1,65 @@ + '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()); +}); diff --git a/tests/Etc/TestingBroadcaster.php b/tests/Etc/TestingBroadcaster.php new file mode 100644 index 00000000..23efb74c --- /dev/null +++ b/tests/Etc/TestingBroadcaster.php @@ -0,0 +1,25 @@ + 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' => [ @@ -116,6 +118,7 @@ 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); } From e61a26d6048519f58193e6c85483ebb4285bade0 Mon Sep 17 00:00:00 2001 From: lukinovec Date: Mon, 20 Feb 2023 23:47:10 +0100 Subject: [PATCH 8/8] Add L10 support to 4.x (merge 3.x to master) (#1071) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * exclude master from CI * Add space after 'up' in 'docker-compose up-d' (#900) * Fix ArgumentCountError on the TenantAssetsController (#894) * Fix ArgumentCount exception on the TenantAssetsController when no `$path` is provided * CS * CS * Handle null case explicitly * code style Co-authored-by: Bram Wubs Co-authored-by: Samuel Štancl * Add support for nested tenant config override (#920) * feat: add support for nested tenant config override * test: ensure nested tenant values are mapped * fix: typo mistake (#954) * [3.x] Add Vite helper for tenancy (#956) * Add Vite helper for tenancy * Move Vite bundler to an Optional Feature * Rename to foundation vite * Add ViteBundlerTest * Add missing end of file * Update tests * remove unnecessary end() call Co-authored-by: Samuel Štancl * rewrite ViteBundlerTest to phpunit syntax * skip vite test in Laravel < 9 * convert ViteBundler to PHP 7 syntax * remove import of nonexistent class in older Laravel versions * remove import of Foundation\Vite in tests * try to exclude Vite.php from coverage report * remove typehint * update channel name * Cache crash fix (#1048) * Don't prevent accessing missing Tenant attributes. (#1045) * [3.x] L10 compatibility (#1065) * Bump dependencies for Laravel 10 * Update GitHub Actions for Laravel 10 * ci: do not test L10 using PHP 7.3 * drop < L9 support * use `dispatch_sync` instead of `dispatch_now` * migrate phpunit configuration * Update ci.yml * drop laravel < 9 support * misc L10 fixes, new docker image * specify odbc version * wip * properly list php versions as strings * minor changes * Add `getValue($queryGrammar)` to raw query * Clean up `isVersion8` code * rewrite hasFailed assertion * phpunit schema update * Upgrade `doctrine/dbal` --------- Co-authored-by: Samuel Štancl Co-authored-by: Samuel Štancl Co-authored-by: lukinovec * Update ci.yml * Fix code style (php-cs-fixer) * Update dependencies * Change invade version * Delete ViteBundlerTest * Fix PHPStan error * Delete PHPStan error ignore * Fix CONTRIBUTING.md * Delete ViteBundler remains * Bring back ViteBundler * Convert ViteBundlerTest to Pest * Update ci.yml --------- Co-authored-by: Samuel Štancl Co-authored-by: Bram Wubs Co-authored-by: Bram Wubs Co-authored-by: Samuel Štancl Co-authored-by: George Bishop Co-authored-by: Anbuselvan Rocky <15264938+anburocky3@users.noreply.github.com> Co-authored-by: Wilsen Hernández <13445515+wilsenhc@users.noreply.github.com> Co-authored-by: Joel Stein Co-authored-by: Guilherme Saade Co-authored-by: PHP CS Fixer --- .github/workflows/ci.yml | 8 +++-- assets/config.php | 3 +- composer.json | 17 ++++++----- phpstan.neon | 4 --- src/Database/Models/ImpersonationToken.php | 5 ++-- src/Database/Models/Tenant.php | 2 ++ ...rmissionControlledMySQLDatabaseManager.php | 3 +- src/Features/ViteBundler.php | 26 +++++++++++++++++ src/TenancyServiceProvider.php | 1 + src/Vite.php | 22 ++++++++++++++ tests/EventListenerTest.php | 7 +++-- tests/Features/ViteBundlerTest.php | 29 +++++++++++++++++++ tests/TenantDatabaseManagerTest.php | 4 +-- 13 files changed, 107 insertions(+), 24 deletions(-) create mode 100644 src/Features/ViteBundler.php create mode 100644 src/Vite.php create mode 100644 tests/Features/ViteBundlerTest.php diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 314d6e4c..8ecb863b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -15,7 +15,11 @@ jobs: strategy: matrix: - laravel: ['^9.0'] + include: + - laravel: 9 + php: "8.0" + - laravel: 10 + php: "8.1" steps: - name: Checkout @@ -23,7 +27,7 @@ jobs: - name: Install Composer dependencies run: | - composer require "laravel/framework:${{ matrix.laravel }}" --no-interaction --no-update + composer require "laravel/framework:^${{ matrix.laravel }}.0" --no-interaction --no-update composer update --prefer-dist --no-interaction - name: Run tests run: ./vendor/bin/pest diff --git a/assets/config.php b/assets/config.php index bbfa9974..7fc6c928 100644 --- a/assets/config.php +++ b/assets/config.php @@ -258,7 +258,7 @@ return [ ], /** - * Redis tenancy config. Used by RedisTenancyBoostrapper. + * Redis tenancy config. Used by RedisTenancyBootstrapper. * * Note: You need phpredis to use Redis tenancy. * @@ -286,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, ], /** diff --git a/composer.json b/composer.json index bb11040e..b5734c1b 100644 --- a/composer.json +++ b/composer.json @@ -17,18 +17,19 @@ "require": { "php": "^8.2", "ext-json": "*", - "illuminate/support": "^9.38", + "illuminate/support": "^9.38|^10.0", + "facade/ignition-contracts": "^1.0.2", "spatie/ignition": "^1.4", - "ramsey/uuid": "^4.0", - "stancl/jobpipeline": "^1.0", - "stancl/virtualcolumn": "^1.3", + "ramsey/uuid": "^4.7.3", + "stancl/jobpipeline": "^1.6.2", + "stancl/virtualcolumn": "^1.3.1", "spatie/invade": "^1.1" }, "require-dev": { - "laravel/framework": "^9.38", - "orchestra/testbench": "^7.0", - "league/flysystem-aws-s3-v3": "^3.0", - "doctrine/dbal": "^2.10", + "laravel/framework": "^9.38|^10.0", + "orchestra/testbench": "^7.0|^8.0", + "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", diff --git a/phpstan.neon b/phpstan.neon index 91e9f3af..19cda805 100644 --- a/phpstan.neon +++ b/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: diff --git a/src/Database/Models/ImpersonationToken.php b/src/Database/Models/ImpersonationToken.php index 05d17ad4..3d7b595b 100644 --- a/src/Database/Models/ImpersonationToken.php +++ b/src/Database/Models/ImpersonationToken.php @@ -33,9 +33,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 diff --git a/src/Database/Models/Tenant.php b/src/Database/Models/Tenant.php index 37c2af2d..c3574942 100644 --- a/src/Database/Models/Tenant.php +++ b/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 = []; diff --git a/src/Database/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php b/src/Database/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php index f7e7440e..308d8786 100644 --- a/src/Database/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php +++ b/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; } diff --git a/src/Features/ViteBundler.php b/src/Features/ViteBundler.php new file mode 100644 index 00000000..e3fee2fa --- /dev/null +++ b/src/Features/ViteBundler.php @@ -0,0 +1,26 @@ +app = $app; + } + + public function bootstrap(Tenancy $tenancy): void + { + $this->app->singleton(\Illuminate\Foundation\Vite::class, Vite::class); + } +} diff --git a/src/TenancyServiceProvider.php b/src/TenancyServiceProvider.php index 23fb6473..bde37055 100644 --- a/src/TenancyServiceProvider.php +++ b/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']); }); diff --git a/src/Vite.php b/src/Vite.php new file mode 100644 index 00000000..ca47fcc3 --- /dev/null +++ b/src/Vite.php @@ -0,0 +1,22 @@ +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 diff --git a/tests/Features/ViteBundlerTest.php b/tests/Features/ViteBundlerTest.php new file mode 100644 index 00000000..0d4c9069 --- /dev/null +++ b/tests/Features/ViteBundlerTest.php @@ -0,0 +1,29 @@ +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); +}); diff --git a/tests/TenantDatabaseManagerTest.php b/tests/TenantDatabaseManagerTest.php index 5d9a15d6..c776d7a1 100644 --- a/tests/TenantDatabaseManagerTest.php +++ b/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