FOUR-20257, FOUR-21030 - Grafana + Metrics + Cache

.env.example

@@ -47,3 +47,5 @@ OPEN_AI_SECRET="sk-O2D..."
 AI_MICROSERVICE_HOST="http://localhost:8010"
 PROCESS_REQUEST_ERRORS_RATE_LIMIT=1
 PROCESS_REQUEST_ERRORS_RATE_LIMIT_DURATION=86400
+CACHE_SETTING_DRIVER=cache_settings
+CACHE_SETTING_PREFIX=settings

ProcessMaker/Cache/AbstractCacheFactory.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace ProcessMaker\Cache;
+
+use Illuminate\Cache\CacheManager;
+use ProcessMaker\Cache\Monitoring\CacheMetricsDecorator;
+use ProcessMaker\Cache\Monitoring\CacheMetricsInterface;
+use ProcessMaker\Cache\Monitoring\PrometheusMetricsManager;
+
+abstract class AbstractCacheFactory implements CacheFactoryInterface
+{
+    protected static ?CacheInterface $testInstance = null;
+
+    /**
+     * Set a test instance for the factory
+     *
+     * @param CacheInterface|null $instance
+     */
+    public static function setTestInstance(?CacheInterface $instance): void
+    {
+        static::$testInstance = $instance;
+    }
+
+    /**
+     * Create a new cache instance with metrics monitoring
+     *
+     * @param CacheManager $cacheManager
+     * @param CacheMetricsInterface $metrics
+     * @return CacheInterface
+     */
+    public static function create(CacheManager $cacheManager, CacheMetricsInterface $metrics): CacheInterface
+    {
+        if (static::$testInstance !== null) {
+            return static::$testInstance;
+        }
+
+        // Create base cache instance
+        $cache = static::createInstance($cacheManager);
+
+        // Wrap with metrics decorator
+        return new CacheMetricsDecorator($cache, $metrics);
+    }
+
+    /**
+     * Get the current cache instance
+     *
+     * @return CacheInterface
+     */
+    protected static function getInstance(): CacheInterface
+    {
+        return static::create(app('cache'), app()->make(PrometheusMetricsManager::class));
+    }
+
+    /**
+     * Create the specific cache instance
+     *
+     * @param CacheManager $cacheManager
+     * @return CacheInterface
+     */
+    abstract protected static function createInstance(CacheManager $cacheManager): CacheInterface;
+}

ProcessMaker/Cache/CacheFactoryInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace ProcessMaker\Cache;
+
+use Illuminate\Cache\CacheManager;
+use ProcessMaker\Cache\Monitoring\CacheMetricsInterface;
+
+interface CacheFactoryInterface
+{
+    /**
+     * Create a new cache instance with metrics monitoring
+     *
+     * @param CacheManager $cacheManager
+     * @param CacheMetricsInterface $metrics
+     * @return CacheInterface
+     */
+    public static function create(CacheManager $cacheManager, CacheMetricsInterface $metrics): CacheInterface;
+}

ProcessMaker/Cache/CacheInterface.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace ProcessMaker\Cache;
+
+interface CacheInterface
+{
+    /**
+     * Fetches a value from the cache.
+     *
+     * @param string $key     The unique key of this item in the cache.
+     * @param mixed  $default Default value to return if the key does not exist.
+     *
+     * @return mixed The value of the item from the cache, or $default in case of cache miss.
+     */
+    public function get(string $key, mixed $default = null): mixed;
+
+    /**
+     * Fetches a value from the cache, or stores the value from the callback if the key exists.
+     *
+     * @param string $key The unique key of this item in the cache.
+     * @param callable $callback The callback that will return the value to store in the cache.
+     *
+     * @return mixed The value of the item from the cache, or $default in case of cache miss.
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function getOrCache(string $key, callable $callback): mixed;
+
+    /**
+     * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
+     *
+     * @param string                 $key   The key of the item to store.
+     * @param mixed                  $value The value of the item to store, must be serializable.
+     * @param null|int|\DateInterval $ttl   Optional. The TTL value of this item. If no value is sent and
+     *                                      the driver supports TTL then the library may set a default value
+     *                                      for it or let the driver take care of that.
+     *
+     * @return bool True on success and false on failure.
+     */
+    public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool;
+
+    /**
+     * Delete an item from the cache by its unique key.
+     *
+     * @param string $key The unique cache key of the item to delete.
+     *
+     * @return bool True if the item was successfully removed. False if there was an error.
+     */
+    public function delete(string $key): bool;
+
+    /**
+     * Wipes clean the entire cache's keys.
+     *
+     * @return bool True on success and false on failure.
+     */
+    public function clear(): bool;
+
+    /**
+     * Determines whether an item is present in the cache.
+     *
+     * @param string $key The unique cache key of the item to check for.
+     *
+     * @return bool True if the item is present in the cache, false otherwise.
+     */
+    public function has(string $key): bool;
+
+    /**
+     * Determines whether an item is missing from the cache.
+     *
+     * @param string $key The unique cache key of the item to check for.
+     *
+     * @return bool True if the item is missing from the cache, false otherwise.
+     */
+    public function missing(string $key): bool;
+
+    /**
+     * Creates a cache key based on provided parameters
+     *
+     * @param array $params Key parameters
+     * @return string Generated cache key
+     */
+    public function createKey(array $params): string;
+}

ProcessMaker/Cache/CacheManagerBase.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace ProcessMaker\Cache;
+
+use Exception;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\Redis;
+
+abstract class CacheManagerBase
+{
+    /**
+     * The available cache connections.
+     *
+     * @var array
+     */
+    protected const AVAILABLE_CONNECTIONS = ['redis', 'cache_settings'];
+
+    /**
+     * Retrieve an array of cache keys that match a specific pattern.
+     *
+     * @param string $pattern The pattern to match.
+     * @param string|null $connection The cache connection to use.
+     *
+     * @return array An array of cache keys that match the pattern.
+     */
+    public function getKeysByPattern(string $pattern, string $connection = null, string $prefix = null): array
+    {
+        if (!$connection) {
+            $connection = config('cache.default');
+        }
+
+        if (!$prefix) {
+            $prefix = config('cache.prefix');
+        }
+
+        if (!in_array($connection, self::AVAILABLE_CONNECTIONS)) {
+            throw new CacheManagerException('`getKeysByPattern` method only supports Redis connections.');
+        }
+
+        try {
+            // Get all keys
+            $keys = Redis::connection($connection)->keys($prefix . '*');
+
+            // Filter keys by pattern
+            return array_filter($keys, fn ($key) => preg_match('/' . $pattern . '/', $key));
+        } catch (Exception $e) {
+            Log::info('CacheManagerBase: ' . $e->getMessage());
+        }
+
+        return [];
+    }
+}

ProcessMaker/Cache/CacheManagerException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace ProcessMaker\Cache;
+
+use Exception;
+
+class CacheManagerException extends Exception
+{
+}