ExternalVuFind: Cache results

maccabeelevine · Aug 22, 2024 · ecd7687 · ecd7687
1 parent a6f665d
commit ecd7687
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 18 deletions.
diff --git a/module/VuFind/src/VuFind/Connection/ExternalVuFind.php b/module/VuFind/src/VuFind/Connection/ExternalVuFind.php
@@ -43,9 +43,11 @@
  */
 class ExternalVuFind implements
     \VuFindHttp\HttpServiceAwareInterface,
+    \VuFind\Http\CachingDownloaderAwareInterface,
     LoggerAwareInterface
 {
     use \VuFindHttp\HttpServiceAwareTrait;
+    use \VuFind\Http\CachingDownloaderAwareTrait;
     use \VuFind\Log\LoggerAwareTrait;
 
     /**
@@ -55,6 +57,14 @@ class ExternalVuFind implements
      */
     protected $baseUrl = null;
 
+    /**
+     * Constructor
+     */
+    public function __construct()
+    {
+        $this->cacheOptionsSection = 'ExternalVuFind';
+    }
+
     /**
      * Set the API base URL.
      *
@@ -87,6 +97,9 @@ public function search(
             $this->logError('Must call setBaseUrl() before searching.');
             return [];
         }
+        if (!isset($this->cachingDownloader)) {
+            throw new \Exception('CachingDownloader initialization failed.');
+        }
 
         $params = [];
         $params[] = $requestParam . '=' . urlencode($queryString);
@@ -97,7 +110,7 @@ public function search(
         }
 
         try {
-            $response = $this->httpService->get($this->baseUrl . '/search', $params);
+            $arr = $this->cachingDownloader->downloadJson($this->baseUrl . '/search', $params, true);
         } catch (Exception $ex) {
             $this->logError(
                 'Exception during request: ' .
@@ -106,16 +119,6 @@ public function search(
             return [];
         }
 
-        if ($response->isServerError()) {
-            $this->logError(
-                'ExternalVuFind API HTTP Error: ' .
-                $response->getStatusCode()
-            );
-            return [];
-        }
-
-        $responseData = trim($response->getBody());
-        $arr = json_decode($responseData, true);
         return $arr ?? [];
     }
-}
+}
diff --git a/module/VuFind/src/VuFind/Http/CachingDownloader.php b/module/VuFind/src/VuFind/Http/CachingDownloader.php
@@ -192,10 +192,10 @@ public function download(
      *
      * @return stdClass
      */
-    public function downloadJson($url, $params = [])
+    public function downloadJson($url, $params = [], $associative = null)
     {
-        $decodeJson = function (\Laminas\Http\Response $response, $url) {
-            $decodedJson = json_decode($response->getBody());
+        $decodeJson = function (\Laminas\Http\Response $response, $url) use ($associative) {
+            $decodedJson = json_decode($response->getBody(), $associative);
             if ($decodedJson === null) {
                 throw new HttpDownloadException(
                     'Invalid response body',
@@ -211,4 +211,4 @@ public function downloadJson($url, $params = [])
 
         return $this->download($url, $params, $decodeJson);
     }
-}
+}
diff --git a/module/VuFind/src/VuFind/Recommend/ConsortialVuFindFactory.php b/module/VuFind/src/VuFind/Recommend/ConsortialVuFindFactory.php
@@ -70,9 +70,20 @@ public function __invoke(
             throw new \Exception('Unexpected options passed to factory.');
         }
 
+        $externalVuFind = $container->get(\VuFind\Connection\ExternalVuFind::class);
+
+        // Doing the construction of CachingDownloader explicitly until it is not a singleton
+        // $cachingDownloader = $container->get(\VuFind\Http\CachingDownloader::class);
+        $cachingDownloader = new \VuFind\Http\CachingDownloader(
+            $container->get(\VuFind\Cache\Manager::class),
+            $container->get(\VuFind\Config\PluginManager::class),
+        );
+        $cachingDownloader->setHttpService($container->get(\VuFindHttp\HttpService::class));
+
+        $externalVuFind->setCachingDownloader($cachingDownloader);
         return new $requestedName(
             $container->get(\VuFind\Config\PluginManager::class)->get('ExternalVuFind'),
-            $container->get(\VuFind\Connection\ExternalVuFind::class)
+            $externalVuFind
         );
     }
-}
+}