Merge pull request #46 from hove-io/task-bo-3164-add-ttl

[BO-3164] - Add cache with ttl
hove-io · Mar 22, 2024 · 6b566a4 · 6b566a4
2 parents c9fb2d7 + 7733d2c
commit 6b566a4
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 2 deletions.
diff --git a/Cache/Navitia.php b/Cache/Navitia.php
@@ -15,6 +15,7 @@ class Navitia extends Cache
     private string $urlApi = '';
     private string $token = '';
     private ?LoggerInterface $logger = null;
+    private ?string $cacheTtl = null;
 
     private function needToCheckPublicationDate(): bool
     {
@@ -56,6 +57,12 @@ public function setLogger(LoggerInterface $logger): self
         return $this;
     }
 
+    public function setCacheTtl(?string $cacheTtl = null): self
+    {
+        $this->cacheTtl = $cacheTtl;
+        return $this;
+    }
+
     public function generateCacheKey(?array $specificArgs): string
     {
         $backtrace = debug_backtrace()[1];
@@ -114,6 +121,9 @@ public function setCacheItem(string $cacheKey, $data): void
 
         $cacheItem->tag([$this->getCacheTag()]);
         $cacheItem->set($data);
+        if ($this->cacheTtl) {
+            $cacheItem->expiresAfter(intval($this->cacheTtl, 10));
+        }
         $this->cache->save($cacheItem);
     }
 

diff --git a/Configuration/NavitiaConfiguration.php b/Configuration/NavitiaConfiguration.php
@@ -50,6 +50,12 @@ class NavitiaConfiguration implements NavitiaConfigurationInterface
      */
     private $response_error;
 
+    /**
+     *
+     * @var ?string
+     */
+    private $cacheTtl = null;
+
     /**
      * Returns the Url of navitia configuration.
      *
@@ -177,6 +183,28 @@ public function setResponseError($response_error)
         return $this;
     }
 
+    /**
+     * Returns the Token of navitia configuration.
+     *
+     * @return ?string
+     */
+    public function getCacheTtl()
+    {
+        return $this->cacheTtl;
+    }
+
+    /**
+     * Set the cacheTtl of navitia configuration
+     *
+     * @param ?string $cacheTtl
+     * @return \Navitia\Component\Configuration\NavitiaConfiguration
+     */
+    public function setCacheTtl($cacheTtl = null)
+    {
+        $this->cacheTtl = $cacheTtl;
+        return $this;
+    }
+
         /**
      * {@inheritDoc}
      */

diff --git a/Service/NavitiaService.php b/Service/NavitiaService.php
@@ -137,12 +137,14 @@ public function generateRequest($api): NavitiaRequestInterface
     private function setCacheProperties(
         string $coverage,
         string $urlApi,
-        string $token
+        string $token,
+        ?string $cacheTtl = null
     ): void {
         if ($this->hasCache()) {
             $this->cache->setCoverage($coverage);
             $this->cache->setUrlApi($urlApi);
             $this->cache->setToken($token);
+            $this->cache->setCacheTtl($cacheTtl);
         }
     }
 
@@ -157,12 +159,13 @@ public function callApi(
         $baseUrl = $this->config->getUrl().'/'.$this->config->getVersion().'/';
         $url = $request->buildUrl($baseUrl);
         $token = $this->config->getToken();
+        $cacheTtl = $this->config->getCacheTtl();
         $this->log(
             $url,
             $request->getApiName(),
             array_merge($request->getParams(), array('token' => $token))
         );
-        $this->setCacheProperties($request->getRegion(), $baseUrl, $token);
+        $this->setCacheProperties($request->getRegion(), $baseUrl, $token, $cacheTtl);
         $curlResponse = $this->getApiResponse($url, $token, $enableCache);
 
         $response = $curlResponse['response'];