Skip to content

feat: Include updated_at timestamp in UserCacheService cache key #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
roncodes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Include updated_at timestamp in UserCacheService cache key #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Http/Controllers/Internal/v1/UserController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ public function current(Request $request)

// Try to get from server cache
$companyId = session('company');
$cachedData = UserCacheService::get($user->id, $companyId);
$cachedData = UserCacheService::get($user, $companyId);

if ($cachedData) {
// Return cached data with cache headers
Expand All @@ -202,7 +202,7 @@ public function current(Request $request)
$userArray = $userData->toArray($request);

// Store in cache
UserCacheService::put($user->id, $companyId, $userArray);
UserCacheService::put($user, $companyId, $userArray);

// Return with cache headers
return response()->json(['user' => $userArray])
Expand Down
2 changes: 2 additions & 0 deletions src/Models/User.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1343,6 +1343,8 @@ public function assignSingleRole($role): self
$this->companyUser->assignSingleRole($role);

// Invalidate user cache after role change
// Note: With updated_at in cache key, this provides immediate invalidation
// while the timestamp-based key provides automatic cache busting
\Fleetbase\Services\UserCacheService::invalidateUser($this);

return $this;
Expand Down
2 changes: 2 additions & 0 deletions src/Observers/UserObserver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ class UserObserver
public function updated(User $user): void
{
// Invalidate user cache when user is updated
// Note: With updated_at in cache key, this provides immediate invalidation
// while the timestamp-based key provides automatic cache busting
UserCacheService::invalidateUser($user);

// Invalidate organizations cache (user might be an owner)
Expand Down
51 changes: 31 additions & 20 deletions src/Services/UserCacheService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,29 +25,34 @@ class UserCacheService

/**
* Generate cache key for a user and company.
* Includes the user's updated_at timestamp for automatic cache busting.
*
* @param int|string $userId
* @param User $user
* @param string $companyId
* @return string
*/
public static function getCacheKey($userId, string $companyId): string
public static function getCacheKey(User $user, string $companyId): string
{
return self::CACHE_PREFIX . $userId . ':' . $companyId;
return self::CACHE_PREFIX . $user->uuid . ':' . $companyId . ':' . $user->updated_at->timestamp;
}

/**
* Get cached user data.
*
* @param int|string $userId
* @param User $user
* @param string $companyId
* @return array|null
*/
public static function get($userId, string $companyId): ?array
public static function get(User $user, string $companyId): ?array
{
$cacheKey = self::getCacheKey($userId, $companyId);
$cacheKey = self::getCacheKey($user, $companyId);

try {
$cached = Cache::get($cacheKey);

if ($cached) {
Log::debug('User cache hit', [
'user_id' => $userId,
'user_id' => $user->uuid,
'company_id' => $companyId,
'cache_key' => $cacheKey,
]);
Expand All @@ -57,7 +62,7 @@ public static function get($userId, string $companyId): ?array
} catch (\Exception $e) {
Log::error('Failed to get user cache', [
'error' => $e->getMessage(),
'user_id' => $userId,
'user_id' => $user->uuid,
'company_id' => $companyId,
]);

Expand All @@ -68,18 +73,22 @@ public static function get($userId, string $companyId): ?array
/**
* Store user data in cache.
*
* @param int|string $userId
* @param User $user
* @param string $companyId
* @param array $data
* @param int|null $ttl
* @return bool
*/
public static function put($userId, string $companyId, array $data, ?int $ttl = null): bool
public static function put(User $user, string $companyId, array $data, ?int $ttl = null): bool
{
$cacheKey = self::getCacheKey($userId, $companyId);
$cacheKey = self::getCacheKey($user, $companyId);
$ttl = $ttl ?? self::CACHE_TTL;

try {
Cache::put($cacheKey, $data, $ttl);

Log::debug('User cache stored', [
'user_id' => $userId,
'user_id' => $user->uuid,
'company_id' => $companyId,
'cache_key' => $cacheKey,
'ttl' => $ttl,
Expand All @@ -89,7 +98,7 @@ public static function put($userId, string $companyId, array $data, ?int $ttl =
} catch (\Exception $e) {
Log::error('Failed to store user cache', [
'error' => $e->getMessage(),
'user_id' => $userId,
'user_id' => $user->uuid,
'company_id' => $companyId,
]);

Expand All @@ -108,7 +117,7 @@ public static function invalidateUser(User $user): void

// Clear cache for each company
foreach ($companies as $companyId) {
$cacheKey = self::getCacheKey($user->id, $companyId);
$cacheKey = self::getCacheKey($user, $companyId);
Cache::forget($cacheKey);

Log::debug('User cache invalidated', [
Expand All @@ -121,7 +130,7 @@ public static function invalidateUser(User $user): void
// Also clear for current session company if different
$sessionCompany = session('company');
if ($sessionCompany && !in_array($sessionCompany, $companies)) {
$cacheKey = self::getCacheKey($user->id, $sessionCompany);
$cacheKey = self::getCacheKey($user, $sessionCompany);
Cache::forget($cacheKey);

Log::debug('User cache invalidated for session company', [
Expand All @@ -141,24 +150,26 @@ public static function invalidateUser(User $user): void
/**
* Invalidate cache for a specific user and company.
*
* @param int|string $userId
* @param User $user
* @param string $companyId
* @return void
*/
public static function invalidate($userId, string $companyId): void
public static function invalidate(User $user, string $companyId): void
{
$cacheKey = self::getCacheKey($userId, $companyId);
$cacheKey = self::getCacheKey($user, $companyId);

try {
Cache::forget($cacheKey);

Log::debug('User cache invalidated', [
'user_id' => $userId,
'user_id' => $user->uuid,
'company_id' => $companyId,
'cache_key' => $cacheKey,
]);
} catch (\Exception $e) {
Log::error('Failed to invalidate user cache', [
'error' => $e->getMessage(),
'user_id' => $userId,
'user_id' => $user->uuid,
'company_id' => $companyId,
]);
}
Expand Down