Take expiry dates into account when setting the cache duration

Resolves #187
craftcms · Mar 14, 2024 · 3fbcff8 · 3fbcff8
1 parent 86798bc
commit 3fbcff8
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Release Notes for Element API
 
+## 4.1.0 - 2024-03-14
+
+- Element API now requires Craft 4.3.0+ or 5.0.0+.
+- Endpoints are no longer cached beyond the lowest expiry date in the results. ([#187](https://github.com/craftcms/element-api/issues/187))
+
 ## 4.0.0 - 2024-03-11
 
 - Added Craft 5 compatibility. ([#186](https://github.com/craftcms/element-api/pull/186))

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ It’s powered by Phil Sturgeon’s excellent [Fractal](http://fractal.thephplea
 
 ## Requirements
 
-This plugin requires Craft CMS 4.0.0+ or 5.0.0+.
+This plugin requires Craft CMS 4.3.0+ or 5.0.0+.
 
 ## Installation
 

diff --git a/composer.json b/composer.json
@@ -26,7 +26,7 @@
   "minimum-stability": "dev",
   "prefer-stable": true,
   "require": {
-    "craftcms/cms": "^4.0.0-RC3|^5.0.0-beta.1",
+    "craftcms/cms": "^4.3.0|^5.0.0-beta.1",
     "league/fractal": "^0.20.1"
   },
   "require-dev": {

diff --git a/composer.lock b/composer.lock
diff --git a/src/controllers/DefaultController.php b/src/controllers/DefaultController.php
@@ -123,7 +123,7 @@ public function actionIndex(string $pattern): Response
                 }
 
                 $elementsService = Craft::$app->getElements();
-                $elementsService->startCollectingCacheTags();
+                $elementsService->startCollectingCacheInfo();
             }
 
             // Extract config settings that aren't meant for createResource()
@@ -233,9 +233,17 @@ public function actionIndex(string $pattern): Response
             }
 
             /** @phpstan-ignore-next-line */
-            $dep = $elementsService->stopCollectingCacheTags();
+            [$dep, $maxDuration] = $elementsService->stopCollectingCacheInfo();
             $dep->tags[] = 'element-api';
 
+            if ($maxDuration) {
+                if ($expire !== null) {
+                    $expire = min($expire, $maxDuration);
+                } else {
+                    $expire = $maxDuration;
+                }
+            }
+
             $cachedContent = $this->response->content;
             if (isset($contentType)) {
                 $cachedContent = "data:$contentType,$cachedContent";