Shared users - complete

src/Contracts/SyncMaster.php

@@ -3,12 +3,13 @@
 namespace Stancl\Tenancy\Contracts;
 
 use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
-// todo rename?
 /**
  * @property-read Tenant[]|Collection $tenants
  */
 interface SyncMaster extends Syncable
 {
-    public function tenants(); // Probably should return BelongsToMany
+    public function tenants(): BelongsToMany;
+    public function getTenantModelName(): string;
 }

src/Contracts/Syncable.php

@@ -2,7 +2,6 @@
 
 namespace Stancl\Tenancy\Contracts;
 
-// todo add comments
 interface Syncable
 {
     public function getGlobalIdentifierKeyName(): string;

src/Contracts/UniqueIdentifierGenerator.php

@@ -4,12 +4,12 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Contracts;
 
-use Stancl\Tenancy\Database\Models\Tenant;
+use Illuminate\Database\Eloquent\Model;
 
 interface UniqueIdentifierGenerator
 {
     /**
      * Generate a unique identifier.
      */
-    public static function generate(Tenant $tenant): string;
+    public static function generate(Model $model): string;
 }

src/Database/Models/Concerns/ResourceSyncing.php

@@ -3,14 +3,32 @@
 namespace Stancl\Tenancy\Database\Models\Concerns;
 
 use Stancl\Tenancy\Contracts\Syncable;
+use Stancl\Tenancy\Contracts\UniqueIdentifierGenerator;
 use Stancl\Tenancy\Events\SyncedResourceSaved;
 
 trait ResourceSyncing
 {
     public static function bootResourceSyncing()
     {
-        static::saving(function (Syncable $model) {
-            event(new SyncedResourceSaved($model, tenant()));
+        static::saved(function (Syncable $model) {
+            /** @var ResourceSyncing $model */
+
+            $model->triggerSyncEvent();
+        });
+
+        static::creating(function (self $model) {
+            if (! $model->getAttribute($model->getGlobalIdentifierKeyName()) && app()->bound(UniqueIdentifierGenerator::class)) {
+                $model->setAttribute(
+                    $model->getGlobalIdentifierKeyName(),
+                    app(UniqueIdentifierGenerator::class)->generate($model)
+                );
+            }
         });
     }
+
+    public function triggerSyncEvent()
+    {
+        /** @var Syncable $this */
+        event(new SyncedResourceSaved($this, tenant()));
+    }
 }

src/Database/Models/TenantPivot.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Stancl\Tenancy\Database\Models;
+
+use Illuminate\Database\Eloquent\Relations\Pivot;
+
+class TenantPivot extends Pivot
+{
+    public static function booted()
+    {
+        static::saved(function (self $pivot) {
+            $pivot->pivotParent->triggerSyncEvent();
+        });
+    }
+}

src/DatabaseManager.php

@@ -42,9 +42,9 @@ class DatabaseManager
      */
     public function connectToTenant(TenantWithDatabase $tenant)
     {
+        $this->database->purge('tenant');
         $this->createTenantConnection($tenant);
         $this->setDefaultConnection('tenant');
-        $this->database->purge('tenant');
     }
 
     /**
@@ -55,6 +55,7 @@ class DatabaseManager
         if (tenancy()->initialized) {
             $this->database->purge('tenant');
         }
+
         $this->setDefaultConnection($this->config->get('tenancy.central_connection'));
     }
 

src/Events/Listeners/QueueableListener.php

@@ -4,12 +4,13 @@ namespace Stancl\Tenancy\Events\Listeners;
 
 use Illuminate\Contracts\Queue\ShouldQueue;
 
+/**
+ * @method handle(object $event)
+ */
 abstract class QueueableListener implements ShouldQueue
 {
     public static $shouldQueue = false;
 
-    abstract public function handle();
-
     public function shouldQueue($event)
     {
         if (static::$shouldQueue) {

src/Events/Listeners/UpdateSyncedResource.php

@@ -3,12 +3,15 @@
 namespace Stancl\Tenancy\Events\Listeners;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\Pivot;
 use Stancl\Tenancy\Contracts\SyncMaster;
-use Stancl\Tenancy\Contracts\Tenant;
 use Stancl\Tenancy\Events\SyncedResourceSaved;
+use Stancl\Tenancy\Exceptions\ModelNotSyncMaster;
 
-class UpdateSyncedResource
+class UpdateSyncedResource extends QueueableListener
 {
+    public static $shouldQueue = false;
+
     public function handle(SyncedResourceSaved $event)
     {
         $syncedAttributes = $event->model->only($event->model->getSyncedAttributeNames());
@@ -21,34 +24,74 @@ class UpdateSyncedResource
                 ->first();
 
             // We disable events for this call, to avoid triggering this event & listener again.
-            $centralModel->withoutEvents(function () use ($centralModel, $syncedAttributes) {
+            $event->model->getCentralModelName()::withoutEvents(function () use (&$centralModel, $syncedAttributes, $event) {
+                if ($centralModel) {
                     $centralModel->update($syncedAttributes);
+                } else {
+                    // If the resource doesn't exist at all in the central DB,we create
+                    // the record with all attributes, not just the synced ones.
+                    $centralModel = $event->model->getCentralModelName()::create($event->model->getAttributes());
+                }
             });
 
+            // If the model was just created, the mapping of the tenant to the user likely doesn't exist, so we create it.
+            $mappingExists = $centralModel->tenants->contains(function ($model) use ($event) {
+                return $model->tenant_id === $event->tenant->getTenantKey();
+            });
+
+            if (! $mappingExists) {
+                // Here we should call TenantPivot, but we call general Pivot, so that this works
+                // even if people use their own pivot model that is not based on our TenantPivot
+                Pivot::withoutEvents(function () use ($centralModel, $event) {
+                    $centralModel->tenants()->attach($event->tenant->getTenantKey());
+                });
+            }
+
             $tenants = $centralModel->tenants->except($event->tenant->getTenantKey());
         } else {
             $centralModel = $event->model;
+
+            if (! $centralModel instanceof SyncMaster) {
+                // If we're trying to use a tenant User model instead of the central User model, for example.
+                throw new ModelNotSyncMaster(get_class($centralModel));
+           }
+
+            /** @var SyncMaster|Model $centralModel */
+
+            // Since this model is "dirty" (taken by reference from the event), it might have the tenants
+            // relationship already loaded and cached. For this reason, we refresh the relationship.
+            $centralModel->load('tenants');
             $tenants = $centralModel->tenants;
         }
 
-        foreach ($tenants as $tenant) {
-            // todo: performance optimization - $tenant->run() does tenancy()->end() after each call.
-            // we dont want that when we want to initialize for the next tenant afterwards rather than for the previous tenant
-            // so we should write a method like run() for running things on multiple tenants efficiently
-
-            $tenant->run(function () use ($event, $syncedAttributes) {
+        tenancy()->runForMultiple($tenants, function () use ($event, $syncedAttributes) {
             // Forget instance state and find the model,
             // again in the current tenant's context.
 
-                /** @var Tenant|Model $model */                
-                $localModel = $event->model::find($event->model->getKey());
+            $eventModel = $event->model;
+
+            if ($eventModel instanceof SyncMaster) {
+                // If event model comes from central DB, we get the tenant model name to run the query
+                $localModelClass = $eventModel->getTenantModelName();
+            } else {
+                $localModelClass = get_class($eventModel);
+            }
+
+            /** @var Model|null */
+            $localModel = $localModelClass::firstWhere($event->model->getGlobalIdentifierKeyName(), $event->model->getGlobalIdentifierKey());
 
             // Also: We're syncing attributes, not columns, which is
             // why we're using Eloquent instead of direct DB queries.
 
             // We disable events for this call, to avoid triggering this event & listener again.
+            $localModelClass::withoutEvents(function () use ($localModelClass, $localModel, $syncedAttributes, $eventModel) {
+                if ($localModel) {
                     $localModel->update($syncedAttributes);
+                } else {
+                    // When creating, we use all columns, not just the synced ones.
+                    $localModelClass::create($eventModel->getAttributes());
+                }
+            });
         });
     }
 }
-}

src/Exceptions/ModelNotSyncMaster.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Stancl\Tenancy\Exceptions;
+
+use Exception;
+
+class ModelNotSyncMaster 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 resouces when you're in the central context");
+    }
+}

src/Tenancy.php

@@ -33,6 +33,10 @@ class Tenancy
 
     public function end(): void
     {
+        if (! $this->initialized) {
+            return;
+        }
+
         $this->initialized = false;
 
         event(new Events\TenancyEnded($this));
@@ -68,4 +72,28 @@ class Tenancy
     {
         return $this->model()->find($id);
     }
+
+    /**
+     * Run a callback for multiple tenants.
+     * More performant than running $tenant->run() one by one.
+     *
+     * @param Tenant[]|\Illuminate\Support\Collection $tenants
+     * @param callable $callback
+     * @return void
+     */
+    public function runForMultiple($tenants, callable $callback)
+    {
+        $originalTenant = $this->tenant;
+
+        foreach ($tenants as $tenant) {
+            $this->initialize($tenant);
+            $callback($tenant);
+        }
+
+        if ($originalTenant) {
+            $this->initialize($originalTenant);
+        } else {
+            $this->end();
+        }
+    }
 }

src/UniqueIDGenerators/UUIDGenerator.php

@@ -4,13 +4,13 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\UniqueIDGenerators;
 
+use Illuminate\Database\Eloquent\Model;
 use Ramsey\Uuid\Uuid;
 use Stancl\Tenancy\Contracts\UniqueIdentifierGenerator;
-use Stancl\Tenancy\Database\Models\Tenant;
 
 class UUIDGenerator implements UniqueIdentifierGenerator
 {
-    public static function generate(Tenant $tenant): string
+    public static function generate(Model $model): string
     {
         return Uuid::uuid4()->toString();
     }

tests/v3/ResourceSyncingTest.php

@@ -3,12 +3,16 @@
 namespace Stancl\Tenancy\Tests\v3;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+use Illuminate\Events\CallQueuedListener;
 use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Facades\Queue;
 use Stancl\Tenancy\Contracts\Syncable;
 use Stancl\Tenancy\Contracts\SyncMaster;
 use Stancl\Tenancy\Database\Models\Concerns\CentralConnection;
 use Stancl\Tenancy\Database\Models\Concerns\ResourceSyncing;
 use Stancl\Tenancy\Database\Models\Tenant;
+use Stancl\Tenancy\Database\Models\TenantPivot;
 use Stancl\Tenancy\Events\Listeners\BootstrapTenancy;
 use Stancl\Tenancy\Events\Listeners\JobPipeline;
 use Stancl\Tenancy\Events\Listeners\RevertToCentralContext;
@@ -17,6 +21,7 @@ use Stancl\Tenancy\Events\SyncedResourceSaved;
 use Stancl\Tenancy\Events\TenancyEnded;
 use Stancl\Tenancy\Events\TenancyInitialized;
 use Stancl\Tenancy\Events\TenantCreated;
+use Stancl\Tenancy\Exceptions\ModelNotSyncMaster;
 use Stancl\Tenancy\Jobs\CreateDatabase;
 use Stancl\Tenancy\TenancyBootstrappers\DatabaseTenancyBootstrapper;
 use Stancl\Tenancy\Tests\TestCase;
@@ -28,7 +33,7 @@ class ResourceSyncingTest extends TestCase
         parent::setUp();
 
         config(['tenancy.bootstrappers' => [
-            DatabaseTenancyBootstrapper::class
+            DatabaseTenancyBootstrapper::class,
         ]]);
 
         Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) {
@@ -37,19 +42,38 @@ class ResourceSyncingTest extends TestCase
 
         Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
         Event::listen(TenancyEnded::class, RevertToCentralContext::class);
+
+        UpdateSyncedResource::$shouldQueue = false; // global state cleanup
+        Event::listen(SyncedResourceSaved::class, UpdateSyncedResource::class);
+
+        $this->artisan('migrate', [
+            '--path' => [
+                __DIR__ . '/../Etc/synced_resource_migrations',
+                __DIR__ . '/../Etc/synced_resource_migrations/users'
+            ],
+            '--realpath' => true,
+        ])->assertExitCode(0);
+    }
+
+    protected function migrateTenants()
+    {
+        $this->artisan('tenants:migrate', [
+            '--path' => __DIR__ . '/../Etc/synced_resource_migrations/users',
+            '--realpath' => true,
+        ])->assertExitCode(0);
     }
 
     /** @test */
     public function an_event_is_triggered_when_a_synced_resource_is_changed()
     {
-        $this->loadLaravelMigrations();
-
         Event::fake([SyncedResourceSaved::class]);
 
         $user = User::create([
             'name' => 'Foo',
             'email' => 'foo@email.com',
             'password' => 'secret',
+            'global_id' => 'foo',
+            'role' => 'foo',
         ]);
 
         Event::assertDispatched(SyncedResourceSaved::class, function (SyncedResourceSaved $event) use ($user) {
@@ -60,16 +84,6 @@ class ResourceSyncingTest extends TestCase
     /** @test */
     public function only_the_synced_columns_are_updated_in_the_central_db()
     {
-        Event::listen(SyncedResourceSaved::class, UpdateSyncedResource::class);
-
-        $this->artisan('migrate', [
-            '--path' => [
-                __DIR__ . '/../Etc/synced_resource_migrations',
-                __DIR__ . '/../Etc/synced_resource_migrations/users'
-            ],
-            '--realpath' => true,
-        ])->assertExitCode(0);
-
         // Create user in central DB
         $user = CentralUser::create([
             'global_id' => 'acme',
@@ -80,10 +94,7 @@ class ResourceSyncingTest extends TestCase
         ]);
 
         $tenant = Tenant::create();
-        $this->artisan('tenants:migrate', [
-            '--path' => __DIR__ . '/../Etc/synced_resource_migrations/users',
-            '--realpath' => true,
-        ])->assertExitCode(0);
+        $this->migrateTenants();
 
         tenancy()->initialize($tenant);
 
@@ -127,15 +138,306 @@ class ResourceSyncingTest extends TestCase
     }
 
     /** @test */
-    public function the_synced_columns_are_updated_in_other_tenant_dbs_where_the_resource_exists()
+    public function creating_the_resource_in_tenant_database_creates_it_in_central_database_and_creates_the_mapping()
     {
-        // todo
+        // Assert no user in central DB
+        $this->assertCount(0, User::all());
+
+        $tenant = Tenant::create();
+        $this->migrateTenants();
+
+        tenancy()->initialize($tenant);
+
+        // Create the same user in tenant DB
+        User::create([
+            'global_id' => 'acme',
+            'name' => 'John Doe',
+            'email' => 'john@localhost',
+            'password' => 'secret',
+            'role' => 'commenter', // unsynced
+        ]);
+
+        tenancy()->end();
+
+        // Asset user was created
+        $this->assertSame('acme', CentralUser::first()->global_id);
+        $this->assertSame('commenter', CentralUser::first()->role);
+
+        // Assert mapping was created
+        $this->assertCount(1, CentralUser::first()->tenants);
+
+        // Assert role change doesn't cascade
+        CentralUser::first()->update(['role' => 'central superadmin']);
+        tenancy()->initialize($tenant);
+        $this->assertSame('commenter', User::first()->role);
     }
 
     /** @test */
-    public function global_id_is_generated_using_id_generatr_when_its_not_supplied()
+    public function trying_to_update_synced_resources_from_central_context_using_tenant_models_results_in_an_exception()
     {
-        // todo
+        $this->creating_the_resource_in_tenant_database_creates_it_in_central_database_and_creates_the_mapping();
+
+        tenancy()->end();
+        $this->assertFalse(tenancy()->initialized);
+
+        $this->expectException(ModelNotSyncMaster::class);
+        User::first()->update(['role' => 'foobar']);
+    }
+
+    /** @test */
+    public function attaching_a_tenant_to_the_central_resource_triggers_a_pull_from_the_tenant_db()
+    {
+        $centralUser = CentralUser::create([
+            'global_id' => 'acme',
+            'name' => 'John Doe',
+            'email' => 'john@localhost',
+            'password' => 'secret',
+            'role' => 'commenter', // unsynced
+        ]);
+
+        $tenant = Tenant::create([
+            'id' => 't1',
+        ]);
+        $this->migrateTenants();
+
+        $tenant->run(function () {
+            $this->assertCount(0, User::all());
+        });
+
+        $centralUser->tenants()->attach('t1');
+
+        $tenant->run(function () {
+            $this->assertCount(1, User::all());
+        });
+    }
+
+    /** @test */
+    public function resources_are_synced_only_to_workspaces_that_have_the_resource()
+    {
+        $centralUser = CentralUser::create([
+            'global_id' => 'acme',
+            'name' => 'John Doe',
+            'email' => 'john@localhost',
+            'password' => 'secret',
+            'role' => 'commenter', // unsynced
+        ]);
+
+        $t1 = Tenant::create([
+            'id' => 't1',
+        ]);
+
+        $t2 = Tenant::create([
+            'id' => 't2',
+        ]);
+
+        $t3 = Tenant::create([
+            'id' => 't3',
+        ]);
+        $this->migrateTenants();
+
+        $centralUser->tenants()->attach('t1');
+        $centralUser->tenants()->attach('t2');
+        // t3 is not attached
+
+        $t1->run(function () {
+            // assert user exists
+            $this->assertCount(1, User::all());
+        });
+
+        $t2->run(function () {
+            // assert user exists
+            $this->assertCount(1, User::all());
+        });
+
+        $t3->run(function () {
+            // assert user does NOT exist
+            $this->assertCount(0, User::all());
+        });
+    }
+
+    /** @test */
+    public function when_a_resource_exists_in_other_tenant_dbs_but_is_CREATED_in_a_tenant_db_the_synced_columns_are_updated_in_the_other_dbs()
+    {
+        // create shared resource
+        $centralUser = CentralUser::create([
+            'global_id' => 'acme',
+            'name' => 'John Doe',
+            'email' => 'john@localhost',
+            'password' => 'secret',
+            'role' => 'commenter', // unsynced
+        ]);
+
+        $t1 = Tenant::create([
+            'id' => 't1',
+        ]);
+        $t2 = Tenant::create([
+            'id' => 't2',
+        ]);
+        $this->migrateTenants();
+
+        // Copy (cascade) user to t1 DB
+        $centralUser->tenants()->attach('t1');
+
+        $t2->run(function () {
+            // Create user with the same global ID in t2 database
+            User::create([
+                'global_id' => 'acme',
+                'name' => 'John Foo', // changed
+                'email' => 'john@foo', // changed
+                'password' => 'secret',
+                'role' => 'superadmin', // unsynced
+            ]);
+        });
+
+        $centralUser = CentralUser::first();
+        $this->assertSame('John Foo', $centralUser->name); // name changed
+        $this->assertSame('john@foo', $centralUser->email); // email changed
+        $this->assertSame('commenter', $centralUser->role); // role didn't change
+
+        $t1->run(function () {
+            $user = User::first();
+            $this->assertSame('John Foo', $user->name); // name changed
+            $this->assertSame('john@foo', $user->email); // email changed
+            $this->assertSame('commenter', $user->role); // role didn't change, i.e. is the same as from the original copy from central
+        });
+    }
+
+    /** @test */
+    public function the_synced_columns_are_updated_in_other_tenant_dbs_where_the_resource_exists()
+    {
+        // create shared resource
+        $centralUser = CentralUser::create([
+            'global_id' => 'acme',
+            'name' => 'John Doe',
+            'email' => 'john@localhost',
+            'password' => 'secret',
+            'role' => 'commenter', // unsynced
+        ]);
+
+        $t1 = Tenant::create([
+            'id' => 't1',
+        ]);
+        $t2 = Tenant::create([
+            'id' => 't2',
+        ]);
+        $t3 = Tenant::create([
+            'id' => 't3',
+        ]);
+        $this->migrateTenants();
+
+        // Copy (cascade) user to t1 DB
+        $centralUser->tenants()->attach('t1');
+        $centralUser->tenants()->attach('t2');
+        $centralUser->tenants()->attach('t3');
+
+        $t3->run(function () {
+            User::first()->update([
+                'name' => 'John 3',
+                'role' => 'employee', // unsynced
+            ]);
+
+            $this->assertSame('employee', User::first()->role);
+        });
+
+        // Check that change was cascaded to other tenants
+        $t1->run($check = function () {
+            $user = User::first();
+
+            $this->assertSame('John 3', $user->name); // synced
+            $this->assertSame('commenter', $user->role); // unsynced
+        });
+        $t2->run($check);
+
+        // Check that change bubbled up to central DB
+        $this->assertSame(1, CentralUser::count());
+        $centralUser = CentralUser::first();
+        $this->assertSame('John 3', $centralUser->name); // synced
+        $this->assertSame('commenter', $centralUser->role); // unsynced
+    }
+
+    /** @test */
+    public function global_id_is_generated_using_id_generator_when_its_not_supplied()
+    {
+        $user = CentralUser::create([
+            'name' => 'John Doe',
+            'email' => 'john@doe',
+            'password' => 'secret',
+            'role' => 'employee',
+        ]);
+
+        $this->assertNotNull($user->global_id);
+    }
+
+    /** @test */
+    public function when_the_resource_doesnt_exist_in_the_tenant_db_non_synced_columns_will_cascade_too()
+    {
+        $centralUser = CentralUser::create([
+            'name' => 'John Doe',
+            'email' => 'john@doe',
+            'password' => 'secret',
+            'role' => 'employee',
+        ]);
+
+        $t1 = Tenant::create([
+            'id' => 't1',
+        ]);
+
+        $this->migrateTenants();
+
+        $centralUser->tenants()->attach('t1');
+
+        $t1->run(function () {
+            $this->assertSame('employee', User::first()->role);
+        });
+    }
+
+    /** @test */
+    public function when_the_resource_doesnt_exist_in_the_central_db_non_synced_columns_will_bubble_up_too()
+    {
+        $t1 = Tenant::create([
+            'id' => 't1',
+        ]);
+
+        $this->migrateTenants();
+
+        $t1->run(function () {
+            User::create([
+                'name' => 'John Doe',
+                'email' => 'john@doe',
+                'password' => 'secret',
+                'role' => 'employee',
+            ]);
+        });
+
+        $this->assertSame('employee', CentralUser::first()->role);
+    }
+
+    /** @test */
+    public function the_listener_can_be_queued()
+    {
+        Queue::fake();
+        UpdateSyncedResource::$shouldQueue = true;
+
+        $t1 = Tenant::create([
+            'id' => 't1',
+        ]);
+
+        $this->migrateTenants();
+
+        Queue::assertNothingPushed();
+
+        $t1->run(function () {
+            User::create([
+                'name' => 'John Doe',
+                'email' => 'john@doe',
+                'password' => 'secret',
+                'role' => 'employee',
+            ]);
+        });
+
+        Queue::assertPushed(CallQueuedListener::class, function (CallQueuedListener $job) {
+            return $job->class === UpdateSyncedResource::class;
+        });
     }
 }
 
@@ -147,9 +449,20 @@ class CentralUser extends Model implements SyncMaster
     public $timestamps = false;
     public $table = 'users';
 
-    public function tenants()
+    public function tenants(): BelongsToMany
     {
-        return $this->belongsToMany(Tenant::class, 'tenant_users', 'global_user_id', 'global_user_id');
+        return $this->belongsToMany(Tenant::class, 'tenant_users', 'tenant_id', 'global_user_id')
+            ->using(TenantPivot::class);
+    }
+
+    public function getTenantModelName(): string
+    {
+        return User::class;
+    }
+
+    public function getTenantIdColumnInMapTable(): string
+    {
+        return 'tenant_id';
     }
 
     public function getGlobalIdentifierKey(): string