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

Resolve misc to-dos (#26)

Browse source 
* Resolve delete tenant storage todo

* Delete outdated todo (resolved in #25)

* Delete resource syncing todo (resolved in #11)

* Make it clear that getArgsForTenant() is used during cache invalidation

* Delete redundant __call() and __callStatic() annotations

* Fix code style (php-cs-fixer)

* Revert %tenant_id% to-do removal

* Test all cached resolvers instead of just the domain one

* Make docblock more concise, delete renaming to-do (the name seems fine)

* Fix method in tests

* If route is the only resolver arg, use the tenant as the cache key instead of encoded route instance

* Resolve to-do

* make docblock more clear

* Add comments to getResolverArgument()

* Rename $id to $tenantKey

* Fix code style (php-cs-fixer)

* Add regression test for forgetting tenant parameters of cached tenants

* Forget route parameter when tenant gets resolved

* Add parameter type

* Simplify getCacheKey()

* Resolvers wip

* Resolvers wip

* Fix code style (php-cs-fixer)

* Bring back the route instance check to getCacheKey, fix test

* add todo

* add assertion

---------

Co-authored-by: PHP CS Fixer <phpcsfixer@example.com>
Co-authored-by: Samuel Štancl <samuel.stancl@gmail.com>
Co-authored-by: Samuel Štancl <samuel@archte.ch>
This commit is contained in:
lukinovec 2024-02-10 18:38:05 +01:00 • committed by GitHub
parent 80b1183fbf
commit aa1437fb5e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 140 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/Resolvers/Contracts/CachedTenantResolver.php
View file

@ -62,11 +62,13 @@ abstract class CachedTenantResolver implements TenantResolver
}
/**
* Get all the arg combinations for resolve() that can be used to find this tenant.
* Get all possible argument combinations for resolve() which can be used for caching the tenant.
*
* This is used during tenant cache invalidation.
*
* @return array[]
*/
abstract public function getArgsForTenant(Tenant $tenant): array; // todo@v4 make it clear that this is only used for cache *invalidation*
abstract public function getArgsForTenant(Tenant $tenant): array;
public static function shouldCache(): bool
{

21
src/Resolvers/PathTenantResolver.php
View file

@ -7,6 +7,7 @@ namespace Stancl\Tenancy\Resolvers;
use Illuminate\Routing\Route;
use Stancl\Tenancy\Contracts\Tenant;
use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedByPathException;
use Stancl\Tenancy\PathIdentificationManager;
class PathTenantResolver extends Contracts\CachedTenantResolver
{
@ -37,6 +38,26 @@ class PathTenantResolver extends Contracts\CachedTenantResolver
];
}
public function resolved(Tenant $tenant, mixed ...$args): void
{
/** @var Route $route */
$route = $args[0];
$route->forgetParameter(PathIdentificationManager::getTenantParameterName());
}
public function getCacheKey(mixed ...$args): string
{
// todo@samuel: fix the coupling here. when this is called from the cachedresolver, $args are the tenant key. when it's called from within this class, $args are a Route instance
// the logic shouldn't have to be coupled to where it's being called from
// $args[0] can be either a Route instance with the tenant key as a parameter
// Or the tenant key
$args = [$args[0] instanceof Route ? $args[0]->parameter(static::tenantParameterName()) : $args[0]];
return '_tenancy_resolver:' . static::class . ':' . json_encode($args);
}
public static function tenantParameterName(): string
{
return config('tenancy.identification.resolvers.' . static::class . '.tenant_parameter_name') ?? 'tenant';