Padosoft\SuperCacheInvalidate\Helpers\SuperCacheInvalidationHelper

Complexity

Total Complexity

26

Size/Duplication

Total Lines	191
Duplicated Lines	0 %

Importance

Changes	7
Bugs	1	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	insertInvalidationEvent()	0	64	6
A	getCacheInvalidationEventsProcessedPartitionName()	0	24	6
A	getCacheInvalidationTimestampsPartitionName()	0	18	4
A	releaseShardLock()	0	6	2
A	getCacheInvalidationEventsPartitionName()	0	20	4
A	acquireShardLock()	0	17	4

<?php

namespace Padosoft\SuperCacheInvalidate\Helpers;

use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Redis;
use Illuminate\Support\Carbon;

class SuperCacheInvalidationHelper
{
    /**
     * Insert a cache invalidation event into the database.
     *
     * @param string      $type                  'key' or 'tag'
     * @param string      $identifier            The cache key or tag to invalidate
     * @param string|null $connection_name       The Redis Connection name (optional, 'default')
     * @param string|null $reason                Reason for invalidation (optional)
     * @param int|null    $totalShards           Total number of shards (from config if null)
     * @param int|null    $priority              Priority of the event
     * @param array|null  $associatedIdentifiers Optional array of associated tags or keys
     */
    public function insertInvalidationEvent(
        string $type,
        string $identifier,
        ?string $connection_name = null,
        ?string $reason = null,
        ?int $totalShards = 0,
        ?int $priority = 0,
        ?array $associatedIdentifiers = [],

The parameter $associatedIdentifiers is not used and could be removed.

    ): void {
        $shard = crc32($identifier) % ($totalShards > 0 ? $totalShards : config('super_cache_invalidate.total_shards', 10));

        $redisConnectionName = $connection_name ?? config('super_cache_invalidate.default_connection_name');
        $data = [
            'type' => $type,
            'identifier' => $identifier,
            'connection_name' => $redisConnectionName,
            'reason' => $reason,
            'priority' => $priority,
            'event_time' => now(),
            'processed' => 0,
            'shard' => $shard,
        ];

        $maxAttempts = 5;
        $attempts = 0;
        $insertOk = false;

        while ($attempts < $maxAttempts && !$insertOk) {
            //DB::beginTransaction();

            try {
                // Cerca di bloccare il record per l'inserimento
                $partitionCache_invalidation_events = $this->getCacheInvalidationEventsPartitionName($shard, $priority);

It seems like $priority can also be of type null; however, parameter $priorityId of Padosoft\SuperCacheInvalidate\Helpers\SuperCacheInvalidationHelper::getCacheInvalidationEventsPartitionName() does only seem to accept integer, maybe add an additional type check?

                //$eventId = DB::table(DB::raw("`cache_invalidation_events` PARTITION ({$partitionCache_invalidation_events})"))->insertGetId($data);
                DB::table(DB::raw("`cache_invalidation_events` PARTITION ({$partitionCache_invalidation_events})"))->insert($data);
                // Insert associated identifiers
                // TODO JB 31/12/2024: per adesso commentato, da riattivare quando tutto funziona alla perfezione usando la partizione,
                // anche perchè la chiave primaria è data da id e partiton_key, per cui va capito cosa restituisce insertGetId e se è bloccante
                /*
                if (!empty($associatedIdentifiers)) {
                    $associations = [];
                    foreach ($associatedIdentifiers as $associated) {
                        $associations[] = [
                            'event_id' => $eventId,
                            'associated_type' => $associated['type'], // 'key' or 'tag'
                            'associated_identifier' => $associated['identifier'],
                            'connection_name' => $associated['connection_name'],
                            'created_at' => now(),
                        ];
                    }
                    DB::table('cache_invalidation_event_associations')->insert($associations);
                }
                */
                $insertOk = true;
                //DB::commit(); // Completa la transazione
            } catch (\Throwable $e) {
                //DB::rollBack(); // Annulla la transazione in caso di errore
                $attempts++;
                Log::error("SuperCacheInvalidate: impossibile eseguire insert, tentativo $attempts di $maxAttempts: " . $e->getMessage());
                // Logica per gestire i tentativi falliti
                if ($attempts >= $maxAttempts) {
                    // Salta il record dopo il numero massimo di tentativi
                    Log::error("SuperCacheInvalidate: impossibile eseguire insert dopo $maxAttempts tentativi: " . $e->getMessage());
                }
            }
        }
    }

    /**
     * Acquire a lock for processing a shard.
     *
     * @param  int          $shardId         The shard number
     * @param  int          $lockTimeout     Lock timeout in seconds
     * @param  string       $connection_name The Redis Connection name
     * @return string|false The lock value if acquired, false otherwise
     */
    public function acquireShardLock(int $shardId, int $priority, int $lockTimeout, string $connection_name): bool|string
    {
        $lockKey = 'shard_lock:' . $shardId . '_' . $priority;
        // Il metodo has/exists occupa troppa memoria!!!
        $retrieveValue = Redis::connection($connection_name)->get($lockKey);
        if ($retrieveValue !== null) {
            // Lock già attivo
            return false;
        }
        $lockValue = uniqid('', true);
        $isLocked = Redis::connection($connection_name)->set($lockKey, $lockValue);

        if ($lockTimeout > 0) {
            Redis::connection($connection_name)->expire($lockKey, $lockTimeout);
        }

        return $isLocked ? $lockValue : false;
    }

    /**
     * Release the lock for a shard.
     *
     * @param int    $shardId         The shard number
     * @param string $lockValue       The lock value to validate ownership
     * @param string $connection_name The Redis Connection name
     */
    public function releaseShardLock(int $shardId, int $priority, string $lockValue, string $connection_name): void
    {
        $lockKey = 'shard_lock:' . $shardId . '_' . $priority;
        $currentValue = Redis::connection($connection_name)->get($lockKey);
        if ($currentValue === $lockValue) {
            Redis::connection($connection_name)->del($lockKey);
        }
    }

    public function getCacheInvalidationEventsPartitionName(int $shardId, int $priorityId): string
    {
        // Calcola il valore della partizione
        $shards = config('super_cache_invalidate.total_shards', 10);
        $priorities = [0, 1];

        $partitionValueId = ($priorityId * $shards) + $shardId + 1;

        // Partitions for unprocessed events
        foreach ($priorities as $priority) {
            for ($shard = 0; $shard < $shards; $shard++) {
                $partitionName = "p_unprocessed_s{$shard}_p{$priority}";
                $partitionValue = ($priority * $shards) + $shard + 1;
                if ($partitionValueId < $partitionValue) {
                    return $partitionName;
                }
            }
        }

        return '';
    }

    public function getCacheInvalidationTimestampsPartitionName(Carbon $event_time): string

The parameter $event_time is not used and could be removed.

    {
        $now = now();
        $partitionValueId = ($now->year * 100 + $now->weekOfYear) + 1;
        $startYear = 2024;
        $endYear = 2030;

        for ($year = $startYear; $year <= $endYear; $year++) {
            for ($week = 1; $week <= 53; $week++) {
                $partitionName = "p_{$year}w{$week}";
                $partitionValue = ($year * 100 + $week) + 1;
                if ($partitionValueId < $partitionValue) {
                    return $partitionName;
                }
            }
        }

        return '';
    }

    public function getCacheInvalidationEventsProcessedPartitionName(int $shardId, int $priorityId, string $event_time): string
    {
        // Calcola il valore della partizione
        $shards = config('super_cache_invalidate.total_shards', 10);
        $priorities = [0, 1];
        $eventTime = Carbon::parse($event_time);
        $partitionValueId = ($eventTime->year * 10000) + ($eventTime->weekOfYear * 100) + ($priorityId * $shards) + $shardId;
        // Partitions for processed events
        for ($year = $eventTime->year; $year <= ($eventTime->year + 1); $year++) {
            for ($week = $eventTime->weekOfYear; $week <= $eventTime->weekOfYear + 1; $week++) {
                foreach ($priorities as $priority) {
                    for ($shard = 0; $shard < $shards; $shard++) {
                        $partitionKey = ($year * 10000) + ($week * 100) + ($priority * $shards) + $shard;
                        $partitionValue = $partitionKey + 1;
                        $partitionName = "p_s{$shard}_p{$priority}_{$year}w{$week}";
                        if ($partitionValueId < $partitionValue) {
                            return $partitionName;
                        }
                    }
                }
            }
        }

        return '';
    }
}