Relax Version Dependencies for recent Neos and Elasticsearch Versions

Classes/Domain/WorkspaceIndexingMode.php

@@ -0,0 +1,102 @@
+<?php
+namespace Flowpack\ElasticSearch\ContentGraphAdapter\Domain;
+
+/*
+ * This file is part of the Flowpack.ElasticSearch.ContentGraphAdapter package.
+ *
+ * (c) Contributors of the Neos Project - www.neos.io
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+use Neos\ContentRepository\InMemoryGraph\NodeAggregate\Node;
+use Neos\Flow\Annotations as Flow;
+
+/**
+ * The workspace indexing mode
+ * @Flow\Proxy(false)
+ */
+final class WorkspaceIndexingMode
+{
+    /**
+     * In this mode, only nodes in workspace live are indexed.
+     * Really fast but does not work on unpublished changes.
+     *
+     *        ┌────────┐
+     *        │ P:live │
+     *        └────────┘
+     *        ╱        ╲
+     *       ╱          ╲
+     * ┌────▼────┐    ┌─────────────┐
+     * │  C:live │    │  C:user-me  │ <--- not indexed
+     * └─────────┘    └─────────────┘
+     */
+    const MODE_ONLY_LIVE = 'onlyLive';
+
+    /**
+     * In this mode, nodes are only indexed in their origin workspace.
+     * Still quite fast but does not work on unpublished changes in edge cases.
+     *
+     *                            ┌────────────────┐
+     *                            │ P:live,user-me │ <--- visible in user-me only due to fallback
+     *                            └────────────────┘      thus only indexed in live, visible in user-me
+     *                             ╱             ╲        but with upserted content not from C:user-me but from C:live
+     *                            ╱               ╲
+     *                      ┌────▼────┐    ┌───────▼─────┐
+     * indexed in live ---> │  C:live │    │  C:user-me  │ <--- indexed in user-me
+     *                      └─────────┘    └─────────────┘
+     */
+    const MODE_ONLY_ORIGIN = 'onlyOrigin';
+
+    /**
+     * In this mode, nodes are indexed in all their covered workspaces.
+     * Not so fast due to creation of large amounts of duplicates.
+     *
+     *                            ┌────────────────┐
+     *                            │ P:live,user-me │ <--- indexed in both live and user-me
+     *                            └────────────────┘
+     *                             ╱             ╲
+     *                            ╱               ╲
+     *                      ┌────▼────┐    ┌───────▼─────┐
+     * indexed in live ---> │  C:live │    │  C:user-me  │ <--- indexed in user-me
+     *                      └─────────┘    └─────────────┘
+     */
+    const MODE_FULL = 'full';
+
+    /**
+     * @var string
+     */
+    private $value;
+
+    private function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+
+    public static function fromString(string $value): self
+    {
+        if ($value !== self::MODE_ONLY_LIVE && $value !== self::MODE_ONLY_ORIGIN && $value !== self::MODE_FULL) {
+            throw WorkspaceIndexingModeIsInvalid::becauseItIsNoneOfTheDefinedValues($value);
+        }
+
+        return new self($value);
+    }
+
+    public function isNodeToBeIndexed(Node $node): bool
+    {
+        switch ($this->value) {
+            case self::MODE_ONLY_LIVE:
+                return $node->getWorkspace()->getName() === 'live';
+            default:
+                return true;
+        }
+    }
+
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+}
+

Classes/Domain/WorkspaceIndexingModeIsInvalid.php

@@ -0,0 +1,27 @@
+<?php
+namespace Flowpack\ElasticSearch\ContentGraphAdapter\Domain;
+
+/*
+ * This file is part of the Flowpack.ElasticSearch.ContentGraphAdapter package.
+ *
+ * (c) Contributors of the Neos Project - www.neos.io
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+use Neos\Flow\Annotations as Flow;
+
+/**
+ * The exception to be thrown if an invalid workspace indexing mode was attempted to be initialized
+ * @Flow\Proxy(false)
+ */
+final class WorkspaceIndexingModeIsInvalid extends \DomainException
+{
+    public static function becauseItIsNoneOfTheDefinedValues(string $attemptedValue): self
+    {
+        return new self('Given value "' . $attemptedValue . '" is no valid workspace indexing mode, must be one of the defined constants.', 1625245635);
+    }
+}
+

Classes/Eel/ElasticSearchQuery.php

@@ -0,0 +1,147 @@
+<?php
+namespace Flowpack\ElasticSearch\ContentGraphAdapter\Eel;
+
+/*
+ * This file is part of the Flowpack.ElasticSearch.ContentGraphAdapter package.
+ *
+ * (c) Contributors of the Neos Project - www.neos.io
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Security\Context as SecurityContext;
+use Neos\ContentRepository\Domain\Model\NodeInterface;
+use Neos\ContentRepository\Domain\Service\ContentDimensionPresetSourceInterface;
+use Neos\ContentRepository\Search\Search\QueryBuilderInterface;
+use Neos\ContentRepository\DimensionSpace\DimensionSpace;
+use Neos\ContentRepository\InMemoryGraph\Dimension\DimensionSpacePointFactory;
+use Neos\ContentRepository\InMemoryGraph\ContentSubgraph\ContentSubgraphIdentifier;
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\Version6\Query\FilteredQuery as BaseElasticSearchQuery;
+
+/**
+ * Query Builder for ElasticSearch Queries
+ */
+class ElasticSearchQuery extends BaseElasticSearchQuery
+{
+    /**
+     * @Flow\Inject
+     * @var ContentDimensionPresetSourceInterface
+     */
+    protected $dimensionPresetSource;
+
+    /**
+     * @Flow\Inject
+     * @var SecurityContext
+     */
+    protected $securityContext;
+
+    /**
+     * @Flow\Inject
+     * @var DimensionSpacePointFactory
+     */
+    protected $dimensionSpacePointFactory;
+
+    /**
+     * These fields are not accepted in a count request and must therefore be removed before doing so
+     *
+     * @var array
+     */
+    protected $unsupportedFieldsInCountRequest = ['fields', 'sort', 'from', 'size', 'highlight', 'aggs', 'aggregations'];
+
+    /**
+     * Amount of total items in response without limit
+     *
+     * @var integer
+     */
+    protected $totalItems;
+
+    /**
+     * Sets the starting point for this query. Search result should only contain nodes that
+     * match the context of the given node and have it as parent node in their rootline.
+     *
+     * @param NodeInterface $contextNode
+     * @return QueryBuilderInterface
+     * @api
+     */
+    public function query(NodeInterface $contextNode)
+    {
+
+        // on indexing, the __parentPath is tokenized to contain ALL parent path parts,
+        // e.g. /foo, /foo/bar/, /foo/bar/baz; to speed up matching.. That's why we use a simple "term" filter here.
+        // http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-term-filter.html
+        $this->queryFilter('term', ['__parentPath' => $contextNode->getPath()]);
+
+        $workspaceName = $contextNode->getContext()->getWorkspace()->getName();
+
+        $coordinates = [];
+        foreach ($contextNode->getNodeData()->getDimensionValues() as $dimensionName => $rawDimensionValues) {
+            $coordinates[$dimensionName] = reset($rawDimensionValues);
+        }
+        $coordinates['_workspace'] = $contextNode->getContext()->getWorkspace()->getName();
+
+        $dimensionSpacePoint = new DimensionSpace\DimensionSpacePoint($coordinates);
+        $contentSubgraphIdentifier = new ContentSubgraphIdentifier($workspaceName, $dimensionSpacePoint);
+
+        $edgeFilter = [
+            'path' => '__hierarchyRelations',
+            'query' => [
+                'bool' => [
+                    'must' => [
+                        [
+                            'match' => [
+                                '__hierarchyRelations.subgraph' => (string) $contentSubgraphIdentifier,
+                            ],
+                        ],
+                    ],
+                    'should' => [],
+                    'must_not' => []
+                ]
+            ]
+        ];
+
+        if (!$contextNode->getContext()->isInvisibleContentShown()) {
+            $edgeFilter['query']['bool']['must_not'][] = [
+                'match' => [
+                    '__hierarchyRelations.hidden' => true,
+                ],
+            ];
+            $edgeFilter['query']['bool']['must_not'][] = [
+                'range' => [
+                    '__hierarchyRelations.hiddenBeforeDateTime' => [
+                        'gt' => 'now'
+                    ]
+                ]
+            ];
+            $edgeFilter['query']['bool']['must_not'][] = [
+                'range' => [
+                    '__hierarchyRelations.hiddenAfterDateTime' => [
+                        'lt' => 'now'
+                    ]
+                ]
+            ];
+        }
+
+        /*
+         * @todo make this work
+        if (!$contextNode->getContext()->isInaccessibleContentShown()) {
+            $edgeFilter['query']['bool']['minimum_should_match'] = 1;
+            foreach (array_keys($this->securityContext->getRoles()) as $roleName) {
+                $edgeFilter['query']['bool']['should'][] = [
+                    'term' => [
+                        '__hierarchyRelations.accessRoles' => $roleName
+                    ],
+                ];
+            }
+        }
+        */
+
+        $this->queryFilter('nested', $edgeFilter);
+
+        $this->contextNode = $contextNode;
+
+        return $this;
+    }
+}