archtechx/tenancy
1
0
Fork 0
mirror of https://github.com/archtechx/tenancy.git synced 2025-12-12 19:34:04 +00:00
Code Activity

Implement changes from review on GH

Browse source
This commit is contained in:
Samuel Štancl 2020-05-13 00:31:30 +02:00
parent b7c8f1fba7
commit a756b9b3bc
8 changed files with 224 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/Contracts/UniqueIdentifierGenerator.php
View file

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

7
src/Database/Models/TenantPivot.php
View file

@ -3,13 +3,18 @@
namespace Stancl\Tenancy\Database\Models;
use Illuminate\Database\Eloquent\Relations\Pivot;
use Stancl\Tenancy\Contracts\Syncable;
class TenantPivot extends Pivot
{
public static function booted()
{
static::saved(function (self $pivot) {
$pivot->pivotParent->triggerSyncEvent();
$parent = $pivot->pivotParent;
if ($parent instanceof Syncable) {
$parent->triggerSyncEvent();
}
});
}
}

116
src/Events/Listeners/UpdateSyncedResource.php
View file

@ -5,6 +5,7 @@ namespace Stancl\Tenancy\Events\Listeners;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\Pivot;
use Stancl\Tenancy\Contracts\SyncMaster;
use Stancl\Tenancy\Events\SyncedResourceChangedInForeignDatabase;
use Stancl\Tenancy\Events\SyncedResourceSaved;
use Stancl\Tenancy\Exceptions\ModelNotSyncMaster;
@ -18,53 +19,74 @@ class UpdateSyncedResource extends QueueableListener
// We update the central record only if the event comes from tenant context.
if ($event->tenant) {
/** @var Model|SyncMaster $centralModel */
$centralModel = $event->model->getCentralModelName()
::where($event->model->getGlobalIdentifierKeyName(), $event->model->getGlobalIdentifierKey())
->first();
// We disable events for this call, to avoid triggering this event & listener again.
$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());
$tenants = $this->updateResourceInCentralDatabaseAndGetTenants($event, $syncedAttributes);
} 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;
$tenants = $this->getTenantsForCentralModel($event->model);
}
tenancy()->runForMultiple($tenants, function () use ($event, $syncedAttributes) {
$this->updateResourceInTenantDatabases($tenants, $event, $syncedAttributes);
}
protected function getTenantsForCentralModel($centralModel)
{
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');
return $centralModel->tenants;
}
protected function updateResourceInCentralDatabaseAndGetTenants($event, $syncedAttributes)
{
/** @var Model|SyncMaster $centralModel */
$centralModel = $event->model->getCentralModelName()
::where($event->model->getGlobalIdentifierKeyName(), $event->model->getGlobalIdentifierKey())
->first();
// We disable events for this call, to avoid triggering this event & listener again.
$event->model->getCentralModelName()::withoutEvents(function () use (&$centralModel, $syncedAttributes, $event) {
if ($centralModel) {
$centralModel->update($syncedAttributes);
event(new SyncedResourceChangedInForeignDatabase($event->model, null));
} 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());
event(new SyncedResourceChangedInForeignDatabase($event->model, null));
}
});
// If the model was just created, the mapping of the tenant to the user likely doesn't exist, so we create it.
$currentTenantMapping = function ($model) use ($event) {
return ((string) $model->pivot->tenant_id) === ((string) $event->tenant->getTenantKey());
};
$mappingExists = $centralModel->tenants->contains($currentTenantMapping);
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());
});
}
return $centralModel->tenants->filter(function ($model) use ($currentTenantMapping) {
// Remove the mapping for the current tenant.
return !$currentTenantMapping($model);
});
}
protected function updateResourceInTenantDatabases($tenants, $event, $syncedAttributes)
{
tenancy()->runForMultiple($tenants, function ($tenant) use ($event, $syncedAttributes) {
// Forget instance state and find the model,
// again in the current tenant's context.
@ -84,13 +106,15 @@ class UpdateSyncedResource extends QueueableListener
// 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) {
$localModelClass::withoutEvents(function () use ($localModelClass, $localModel, $syncedAttributes, $eventModel, $tenant) {
if ($localModel) {
$localModel->update($syncedAttributes);
} else {
// When creating, we use all columns, not just the synced ones.
$localModelClass::create($eventModel->getAttributes());
$localModel = $localModelClass::create($eventModel->getAttributes());
}
event(new SyncedResourceChangedInForeignDatabase($localModel, $tenant));
});
});
}

21
src/Events/SyncedResourceChangedInForeignDatabase.php Normal file
View file

@ -0,0 +1,21 @@
<?php
namespace Stancl\Tenancy\Events;
use Stancl\Tenancy\Contracts\Syncable;
use Stancl\Tenancy\Contracts\TenantWithDatabase;
class SyncedResourceChangedInForeignDatabase
{
/** @var Syncable */
public $model;
/** @var TenantWithDatabase|null */
public $tenant;
public function __construct(Syncable $model, ?TenantWithDatabase $tenant)
{
$this->model = $model;
$this->tenant = $tenant;
}
}

6
src/Events/SyncedResourceSaved.php
View file

@ -4,17 +4,17 @@ namespace Stancl\Tenancy\Events;
use Illuminate\Database\Eloquent\Model;
use Stancl\Tenancy\Contracts\Syncable;
use Stancl\Tenancy\Contracts\Tenant;
use Stancl\Tenancy\Contracts\TenantWithDatabase;
class SyncedResourceSaved
{
/** @var Syncable|Model */
public $model;
/** @var Tenant|Model|null */
/** @var TenantWithDatabase|Model|null */
public $tenant;
public function __construct(Syncable $model, ?Tenant $tenant)
public function __construct(Syncable $model, ?TenantWithDatabase $tenant)
{
$this->model = $model;
$this->tenant = $tenant;

3
src/UniqueIDGenerators/UUIDGenerator.php
View file

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