Merge pull request #4 from code-q-web-factory/FEATURE/requests-cache

FEATURE: Add request cache

Author: gradinarufelix

Classes/Domain/Service/ZoomApiService.php

@@ -26,6 +26,11 @@ class ZoomApiService
      */
     protected array $settings;
 
+    /**
+     * @var VariableFrontend
+     */
+    protected $requestsCache;
+
     /**
      * @throws Exception
      */
@@ -62,10 +67,19 @@ private function generateJwt(string $zoomApiKey, string $zoomApiSecret): string
      */
     public function getUpcomingMeetings(): array
     {
-        return $this->fetchData(
+        $cacheEntryIdentifier = 'upcomingMeetings';
+
+        /** @var array|bool $upcomingMeetings */
+        if (($upcomingMeetings = $this->requestsCache->get($cacheEntryIdentifier)) !== false) {
+            return $upcomingMeetings;
+        }
+
+        $upcomingMeetings = $this->fetchData(
             "users/me/meetings?type=upcoming",
             'meetings'
         );
+        $this->requestsCache->set($cacheEntryIdentifier, $upcomingMeetings);
+        return $upcomingMeetings;
     }
 
     /**
@@ -78,6 +92,13 @@ public function getUpcomingMeetings(): array
      */
     public function getRecordings($from, $to): array
     {
+        $cacheEntryIdentifier = sprintf('recordings_%s_%s', $from, $to);
+
+        /** @var array|bool $recordings */
+        if (($recordings = $this->requestsCache->get($cacheEntryIdentifier)) !== false) {
+            return $recordings;
+        }
+
         if (is_string($from)) {
             $from = new DateTimeImmutable($from);
         } elseIf ($from instanceof DateTime) {
@@ -94,7 +115,9 @@ public function getRecordings($from, $to): array
             throw new \InvalidArgumentException('The from date must be after the to date');
         }
 
-        return $this->fetchDataForDateRange($from, $to);
+        $recordings = $this->fetchDataForDateRange($from, $to);
+        $this->requestsCache->set($cacheEntryIdentifier, $recordings);
+        return $recordings;
     }
 
     private function fetchDataForDateRange(DateTimeImmutable $from, DateTimeImmutable $to): array

Configuration/Caches.yaml

@@ -0,0 +1,5 @@
+CodeQ_ZoomApi_Requests:
+  frontend: Neos\Cache\Frontend\VariableFrontend
+  backend: Neos\Cache\Backend\FileBackend
+  backendOptions:
+    defaultLifetime: 0

Configuration/Objects.yaml

@@ -0,0 +1,9 @@
+CodeQ\ZoomApi\Domain\Service\ZoomApiService:
+  properties:
+    requestsCache:
+      object:
+        factoryObjectName: Neos\Flow\Cache\CacheManager
+        factoryMethodName: getCache
+        arguments:
+          1:
+            value: CodeQ_ZoomApi_Requests

README.md

@@ -34,3 +34,19 @@ CodeQ.ZoomApi.getRecordings(Date.create('2021-01-01'), Date.now())
 ```
 
 Be aware, that this helper currently does not implement caching.
+
+## Performance and Caching
+
+Beware, that the package does not cache the requests by default. Thus, using these Eel helpers on
+heavily frequented pages can lead to rate limit issues with the Zoom API. This package provides
+a request cache to tackle that issue. 
+
+By default, the cache is disabled. To enable the cache, configure the lifetime at your convenience:
+
+```yaml
+CodeQ_ZoomApi_Requests:
+  backendOptions:
+    defaultLifetime: 600 # e.g. 60 seconds * 10 minutes = 600 seconds
+```
+
+Of course, you can also switch to a different cache backend at your convenience.