Computed proper cache keys

Author: rimi-itk

mago.toml

@@ -50,20 +50,20 @@ excessive-parameter-list = {
 
 # Our API client has many methods.
 too-many-methods = {
-  threshold = 32
+  threshold = 33
 }
 
 # Our API client is not really that complex …
 cyclomatic-complexity = {
-  threshold = 45
+  threshold = 47
 }
 
 too-many-properties = {
   threshold = 11
 }
 
 kan-defect = {
-  threshold = 2.41
+  threshold = 2.48
 }
 
 [analyzer]

src/ApiClient.php

@@ -92,7 +92,7 @@ public function __construct(array $options)
     public function getServiceIndex(): array
     {
         $cache = $this->getCache();
-        $cacheKey = sha1(__METHOD__);
+        $cacheKey = $this->computeCacheKey(['method' => __METHOD__]);
 
         // @mago-ignore analysis:less-specific-return-statement
         return $cache->get($cacheKey, function (CacheItemInterface $item): array {
@@ -412,7 +412,7 @@ public function getDocumentContent(Document $document): ResponseInterface
     protected function getAccessToken(): array
     {
         $cache = $this->getCache();
-        $cacheKey = sha1(__METHOD__);
+        $cacheKey = $this->computeCacheKey(['method' => __METHOD__]);
 
         return $cache->get($cacheKey, function (CacheItemInterface $item): array {
             $client = $this->client();
@@ -536,7 +536,7 @@ protected function getSearchRequestUrl(string $rel, array $values): string
 
         try {
             $cache = $this->getCache();
-            $cacheKey = sha1(__METHOD__.'|||'.$rel);
+            $cacheKey = $this->computeCacheKey(['method' => __METHOD__, 'rel' => $rel]);
 
             $url = $cache->get($cacheKey, function (CacheItemInterface $item) use ($url) {
                 $item->expiresAfter((int) $this->options['cache_item_lifetime']);
@@ -586,6 +586,28 @@ protected function getCache(): CacheInterface
         return new ProxyAdapter(pool: $pool);
     }
 
+    /**
+     * Compute a cache key based on the client configuration and a context.
+     *
+     * @param array<string, string> $context
+     */
+    protected function computeCacheKey(array $context): string
+    {
+        if (0 === count($context)) {
+            throw new RuntimeException('Cache key context cannot be empty');
+        }
+        try {
+            return sha1(json_encode($this->options + [$context], JSON_THROW_ON_ERROR));
+        } catch (\Exception $exception) {
+            // JSON encode context without throwing any exceptions.
+            $encodedContext = (string) json_encode($context);
+            throw new RuntimeException(
+                sprintf('Cannot compute cache key for context %s', $encodedContext),
+                previous: $exception,
+            );
+        }
+    }
+
     /**
      * @return Atom[]
      *