FEATURE: Add a method to calculate the cache lifetime of all nodes of a query

Author: daniellienert

Classes/Eel/ElasticSearchQueryBuilder.php

@@ -22,6 +22,8 @@
 use Neos\Eel\ProtectedContextAwareInterface;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
+use Neos\Flow\Utility\Now;
+use Neos\Utility\Arrays;
 
 /**
  * Query Builder for ElasticSearch Queries
@@ -73,6 +75,12 @@ class ElasticSearchQueryBuilder implements QueryBuilderInterface, ProtectedConte
      */
     protected $from;
 
+    /**
+     * @Flow\Inject(lazy=false)
+     * @var Now
+     */
+    protected $now;
+
     /**
      * This (internal) array stores, for the last search request, a mapping from Node Identifiers
      * to the full Elasticsearch Hit which was returned.
@@ -181,7 +189,7 @@ public function sort($configuration)
      */
     public function limit($limit)
     {
-        if (!$limit) {
+        if ($limit === null) {
             return $this;
         }
 
@@ -419,7 +427,7 @@ public function fieldBasedAggregation($name, $field, $type = 'terms', $parentPat
      * @return $this
      * @throws QueryBuildingException
      */
-    public function aggregation($name, array $aggregationDefinition, $parentPath = '')
+    public function aggregation(string $name, array $aggregationDefinition, $parentPath = ''): ElasticSearchQueryBuilder
     {
         $this->request->aggregation($name, $aggregationDefinition, $parentPath);
 
@@ -769,6 +777,68 @@ protected function convertHitsToNodes(array $hits)
         return array_values($nodes);
     }
 
+    /**
+     * This method will get the minimum of all allowed cache lifetimes for the
+     * nodes that would result from the current defined query. This means it will evaluate to the nearest future value of the
+     * hiddenBeforeDateTime or hiddenAfterDateTime properties of all nodes in the result.
+     *
+     * @return int
+     * @throws QueryBuildingException
+     * @throws \Flowpack\ElasticSearch\Exception
+     */
+    public function cacheLifetime(): int
+    {
+        $this->request->aggregation('minHiddenBeforeDateTime', [
+            'min' => [
+                'field' => '_hiddenBeforeDateTime'
+            ]
+        ]);
+
+        $this->request->aggregation('minHiddenAfterDateTime', [
+            'min' => [
+                'field' => '_hiddenAfterDateTime'
+            ]
+        ]);
+
+        $this->request->size(0);
+
+        $requestArray = $this->request->toArray();
+
+        $mustNot = Arrays::getValueByPath($requestArray, 'query.bool.filter.bool.must_not');
+
+        /* Remove exclusion of not yet visible nodes
+        - range:
+          _hiddenBeforeDateTime:
+            gt: now
+        */
+        unset($mustNot[1]);
+
+        $requestArray = Arrays::setValueByPath($requestArray, 'query.bool.filter.bool.must_not', array_values($mustNot));
+        $response = $this->elasticSearchClient->getIndex()->request('GET', '/_search', [], $requestArray);
+
+        $result = $response->getTreatedContent();
+
+        $convertDateResultToTimestamp = function (array $dateResult): int {
+            if (!isset($dateResult['value_as_string'])) {
+                return 0;
+            }
+            return (new \DateTime($dateResult['value_as_string']))->getTimestamp();
+        };
+
+        $minTimestamps = array_filter([
+            $convertDateResultToTimestamp(Arrays::getValueByPath($result, 'aggregations.minHiddenBeforeDateTime')),
+            $convertDateResultToTimestamp(Arrays::getValueByPath($result, 'aggregations.minHiddenAfterDateTime'))
+        ]);
+
+        if (empty($minTimestamps)) {
+            return 0;
+        }
+
+        $minTimestamp = min($minTimestamps);
+
+        return $minTimestamp > $this->now->getTimestamp() ? $minTimestamp - $this->now->getTimestamp() : 0;
+    }
+
     /**
      * Proxy method to access the public method of the Request object
      *

README.md

@@ -402,7 +402,7 @@ of an array or a string. Check the documentation \Neos\Utility\Arrays::getValueB
 
 **Important notice**
 
-The ViewHelper GetHitArrayForNode will return the raw hit result array. The path poperty allows you to access some
+The ViewHelper GetHitArrayForNode will return the raw hit result array. The path property allows you to access some
 specific data like the the sort data. If there is only one value for your path the value will be returned.
 If there is more data the full array will be returned by GetHitArrayForNode-VH. So you might have to use the
 ForViewHelper to access your sort values.
@@ -475,6 +475,29 @@ suggestionsQueryDefinition = Neos.Fusion:RawArray {
 suggestions = ${Search.query(site)...suggestions('my_suggestions', this.suggestionsQueryDefinition)}
 ```
 
+## Calculate the maximum cache time
+
+In order to set the maximum cache time of a fusion prototype that renders nodes fetched by `Search()`,
+the nearest future value of the hiddenBeforeDateTime or hiddenAfterDateTime properties of all nodes in the result needs to be calculated.
+
+	prototype(Acme.Blog:Listing) < prototype(Neos.Fusion:Collection) {
+		@context.searchQuery = ${Search.query(site).nodeType('Acme.Blog:Post')}
+	
+	    collection = ${searchQuery.execute()}
+	    itemName = 'node'
+	    itemRenderer = Acme.Blog:Post
+	    
+	     @cache {
+        	mode = 'cached'
+			maximumLifetime = ${searchQuery.cacheLifetime()}
+			
+        	entryTags {
+          	map = ${'NodeType_Acme.Blog:Post'}
+        	}
+    	}
+	}
+
+
 ## Advanced: Configuration of Indexing
 
 **The default configuration supports most usecases and often may not need to be touched, as this package comes

Tests/Functional/Eel/ElasticSearchQueryTest.php

@@ -14,6 +14,10 @@
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Command\NodeIndexCommandController;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Eel\ElasticSearchQueryBuilder;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Eel\ElasticSearchQueryResult;
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\QueryBuildingException;
+use Neos\ContentRepository\Exception\NodeExistsException;
+use Neos\ContentRepository\Exception\NodeTypeNotFoundException;
+use Neos\Flow\Mvc\Exception\StopActionException;
 use Neos\Flow\Persistence\QueryResultInterface;
 use Neos\Flow\Tests\FunctionalTestCase;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
@@ -339,6 +343,22 @@ public function sortValuesAreReturned()
         }
     }
 
+    /**
+     * @test
+     * @throws QueryBuildingException
+     * @throws \Flowpack\ElasticSearch\Exception
+     */
+    public function cacheLifetimeIsCalculatedCorrectly()
+    {
+        $cacheLifetime = $this->getQueryBuilder()
+            ->log($this->getLogMessagePrefix(__METHOD__))
+            ->nodeType('Neos.NodeTypes:Text')
+            ->sortAsc('title')
+            ->cacheLifetime();
+
+        $this->assertEquals(3600, $cacheLifetime);
+    }
+
     /**
      * @return string
      */
@@ -349,24 +369,36 @@ protected function getLogMessagePrefix($method)
 
     /**
      * Creates some sample nodes to run tests against
+     * @throws NodeExistsException
+     * @throws NodeTypeNotFoundException
+     * @throws StopActionException
      */
     protected function createNodesForNodeSearchTest()
     {
         $newDocumentNode1 = $this->siteNode->createNode('test-node-1', $this->nodeTypeManager->getNodeType('Neos.NodeTypes:Page'));
         $newDocumentNode1->setProperty('title', 'chicken');
         $newDocumentNode1->setProperty('title_analyzed', 'chicken');
 
-        $newContentNode = $newDocumentNode1->getNode('main')->createNode('document-1-text-1', $this->nodeTypeManager->getNodeType('Neos.NodeTypes:Text'));
-        $newContentNode->setProperty('text', 'A Scout smiles and whistles under all circumstances.');
+        $newContentNode1 = $newDocumentNode1->getNode('main')->createNode('document-1-text-1', $this->nodeTypeManager->getNodeType('Neos.NodeTypes:Text'));
+        $newContentNode1->setProperty('text', 'A Scout smiles and whistles under all circumstances.');
 
         $newDocumentNode2 = $this->siteNode->createNode('test-node-2', $this->nodeTypeManager->getNodeType('Neos.NodeTypes:Page'));
         $newDocumentNode2->setProperty('title', 'chicken');
         $newDocumentNode2->setProperty('title_analyzed', 'chicken');
 
+        // Nodes for cacheLifetime test
+        $newContentNode2 = $newDocumentNode2->getNode('main')->createNode('document-2-text-1', $this->nodeTypeManager->getNodeType('Neos.NodeTypes:Text'));
+        $newContentNode2->setProperty('text', 'Hidden after 2030-01-01');
+        $newContentNode2->setHiddenAfterDateTime(new \DateTime('@1532635200'));
+        $newContentNode3 = $newDocumentNode2->getNode('main')->createNode('document-2-text-2', $this->nodeTypeManager->getNodeType('Neos.NodeTypes:Text'));
+        $newContentNode3->setProperty('text', 'Hidden before 2018-07-18');
+        $newContentNode3->setHiddenBeforeDateTime(new \DateTime('@1532631600'));
+
         $newDocumentNode3 = $this->siteNode->createNode('test-node-3', $this->nodeTypeManager->getNodeType('Neos.NodeTypes:Page'));
         $newDocumentNode3->setProperty('title', 'egg');
         $newDocumentNode3->setProperty('title_analyzed', 'egg');
 
+
         $dimensionContext = $this->contextFactory->create([
             'workspaceName' => 'live',
             'dimensions' => ['language' => ['de']]
@@ -387,13 +419,15 @@ protected function createNodesForNodeSearchTest()
     }
 
     /**
-     * @return QueryBuilderInterface
+     * @return ElasticSearchQueryBuilder
+     * @throws QueryBuildingException
+     * @throws \Exception
      */
-    protected function getQueryBuilder()
+    protected function getQueryBuilder(): ElasticSearchQueryBuilder
     {
-        /** @var ElasticSearchQueryBuilder $query */
-        $query = $this->objectManager->get(ElasticSearchQueryBuilder::class);
+        $elasticSearchQueryBuilder = $this->objectManager->get(ElasticSearchQueryBuilder::class);
+        $this->inject($elasticSearchQueryBuilder, 'now', new \DateTimeImmutable('@1532628000'));
 
-        return $query->query($this->siteNode);
+        return $elasticSearchQueryBuilder->query($this->siteNode);
     }
 }