Add support for Apache Solr

.github/workflows/test.yml

@@ -50,3 +50,11 @@ jobs:
             directory: 'packages/seal-algolia-adapter'
             docker: false
         secrets: inherit
+
+    solr-adapter:
+        name: Solr Adapter
+        uses: ./.github/workflows/callable-test.yml
+        with:
+            directory: 'packages/seal-solr-adapter'
+            docker: true
+        secrets: inherit

README.md

@@ -37,7 +37,7 @@ At current state collect here different search engines which are around and coul
  - [Opensearch](#opensearch) - [schranz-search/seal-opensearch-adapter](packages/seal-opensearch-adapter)
  - [Meilisearch](#meilisearch) - [schranz-search/seal-meilisearch-adapter](packages/seal-meilisearch-adapter)
  - [Algolia](#algolia) - [schranz-search/seal-algolia-adapter](packages/seal-algolia-adapter)
- - [Solr](#solr) (help wanted [#73](https://github.com/schranz-search/schranz-search/pull/73))
+ - [Solr](#solr) - [schranz-search/seal-solr-adapter](packages/seal-solr-adapter)
  - [Typesense](#typesense) (work in progress [#76](https://github.com/schranz-search/schranz-search/pull/76))
  - [Zinc Labs](#zinc-labs) (work in progress  [#79](https://github.com/schranz-search/schranz-search/pull/79))
  - [RediSearch](#redisearch)
@@ -80,7 +80,7 @@ Fork of Elasticsearch also written in Java.
  - Server: [Opensearch Server](https://github.com/opensearch-project/OpenSearch)
  - PHP Client: [Opensearch PHP](https://github.com/opensearch-project/opensearch-php)
 
-Implementation: [schranz-search/seal-elasticsearch-adapter](packages/seal-opensearch-adapter)
+Implementation: [schranz-search/seal-opensearch-adapter](packages/seal-opensearch-adapter)
 
 ### Meilisearch
 
@@ -107,7 +107,7 @@ A search engine under the Apache Project based on Lucene written in Java:
  - Server: [Solr Server](https://github.com/apache/solr)
  - PHP Client: [Solarium PHP](https://github.com/solariumphp/solarium) seems to be a well maintained Client
 
-Implementation: help wanted [#73](https://github.com/schranz-search/schranz-search/pull/73)
+Implementation: [schranz-search/seal-solr-adapter](packages/seal-solr-adapter)
 
 ### Typesense
 

config.subsplit-publish.json

@@ -15,6 +15,11 @@
             "directory": "packages/seal-opensearch-adapter",
             "target": "[email protected]:schranz-search/seal-opensearch-adapter.git"
         },
+        {
+            "name": "SEALSolrAdapter",
+            "directory": "packages/seal-solr-adapter",
+            "target": "[email protected]:schranz-search/seal-solr-adapter.git"
+        },
         {
             "name": "SEALMeilisearchAdapter",
             "directory": "packages/seal-meilisearch-adapter",

packages/seal-solr-adapter/.gitattributes

@@ -0,0 +1,4 @@
+.gitattributes export-ignore
+.gitignore export-ignore
+composer.lock export-ignore
+/Tests export-ignore

packages/seal-solr-adapter/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [alexander-schranz]

packages/seal-solr-adapter/.gitignore

@@ -0,0 +1,6 @@
+/vendor/
+/composer.phar
+/phpunit.xml
+/.phpunit.result.cache
+/Tests/var
+/docker-compose.override.yml

packages/seal-solr-adapter/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alexander Schranz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/seal-solr-adapter/README.md

@@ -0,0 +1,56 @@
+<div align="center">
+    <img alt="Schranz Search Logo with a Seal on it with a magnifying glass" src="https://avatars.githubusercontent.com/u/120221538?s=400&v=5" width="200" height="200">
+</div>
+
+<h1 align="center">Schranz Search SEAL <br /> Solr Adapter</h1>
+
+<br />
+<br />
+
+The `SolrAdapter` write the documents into a [Apache Solr](https://github.com/apache/solr) server instance. The Apache Solr server is running in the [`cloud mode`](https://solr.apache.org/guide/solr/latest/getting-started/tutorial-solrcloud.html) as we require to use collections for indexes.
+
+> **Note**:
+> This is part of the `schranz-search/schranz-search` project create issues in the [main repository](https://github.com/schranz-search/schranz-search).
+
+> **Warning**:
+> This project is heavily under development and not ready for production.
+
+## Installation
+
+Use [composer](https://getcomposer.org/) for install the package:
+
+```bash
+composer require schranz-search/seal schranz-search/seal-solr-adapter
+```
+
+## Usage.
+
+The following code shows how to create an Engine using this Adapter:
+
+```php
+<?php
+
+use Solr\Client;
+use Solarium\Core\Client\Adapter\Curl;
+use Schranz\Search\SEAL\Adapter\Solr\SolrAdapter;
+use Schranz\Search\SEAL\Engine;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+
+$client = new Client(new Curl(), new EventDispatcher(), [
+    'endpoint' => [
+        'localhost' => [
+            'host' => '127.0.0.1',
+            'port' => '8983',
+            // authenticated required for configset api https://solr.apache.org/guide/8_9/configsets-api.html
+            // alternative set solr.disableConfigSetsCreateAuthChecks=true in your server setup
+            'username' => 'solr',
+            'password' => 'SolrRocks',
+        ],
+    ]
+]);
+
+$engine = new Engine(
+    new SolrAdapter($client),
+    $schema,
+);
+```

packages/seal-solr-adapter/SolrAdapter.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Schranz\Search\SEAL\Adapter\Solr;
+
+use Solarium\Client;
+use Schranz\Search\SEAL\Adapter\AdapterInterface;
+use Schranz\Search\SEAL\Adapter\ConnectionInterface;
+use Schranz\Search\SEAL\Adapter\SchemaManagerInterface;
+
+final class SolrAdapter implements AdapterInterface
+{
+    private readonly ConnectionInterface $connection;
+
+    private readonly SchemaManagerInterface $schemaManager;
+
+    public function __construct(
+        private readonly Client $client,
+        ?ConnectionInterface $connection = null,
+        ?SchemaManagerInterface $schemaManager = null,
+    ) {
+        $this->connection = $connection ?? new SolrConnection($client);
+        $this->schemaManager = $schemaManager ?? new SolrSchemaManager($client);
+    }
+
+    public function getSchemaManager(): SchemaManagerInterface
+    {
+        return $this->schemaManager;
+    }
+
+    public function getConnection(): ConnectionInterface
+    {
+        return $this->connection;
+    }
+}

packages/seal-solr-adapter/SolrConnection.php

@@ -0,0 +1,207 @@
+<?php
+
+namespace Schranz\Search\SEAL\Adapter\Solr;
+
+use Schranz\Search\SEAL\Marshaller\FlattenMarshaller;
+use Schranz\Search\SEAL\Schema\Exception\FieldByPathNotFoundException;
+use Schranz\Search\SEAL\Task\SyncTask;
+use Solarium\Client;
+use Schranz\Search\SEAL\Adapter\ConnectionInterface;
+use Schranz\Search\SEAL\Schema\Field;
+use Schranz\Search\SEAL\Schema\Index;
+use Schranz\Search\SEAL\Search\Condition;
+use Schranz\Search\SEAL\Search\Result;
+use Schranz\Search\SEAL\Search\Search;
+use Schranz\Search\SEAL\Task\TaskInterface;
+
+final class SolrConnection implements ConnectionInterface
+{
+    private FlattenMarshaller $marshaller;
+
+    public function __construct(
+        private readonly Client $client,
+    ) {
+        $this->marshaller = new FlattenMarshaller();
+    }
+
+    public function save(Index $index, array $document, array $options = []): ?TaskInterface
+    {
+        $identifierField = $index->getIdentifierField();
+
+        /** @var string|null $identifier */
+        $identifier = ((string) $document[$identifierField->name]) ?? null;
+
+        $marshalledDocument = $this->marshaller->marshall($index->fields, $document);
+        $marshalledDocument['id'] = $identifier; // Solr currently does not support set another identifier then id: https://github.com/schranz-search/schranz-search/issues/87
+
+        $update = $this->client->createUpdate();
+        $indexDocument = $update->createDocument($marshalledDocument);
+
+        $update->addDocuments([$indexDocument]);
+        $update->addCommit();
+
+        $this->client->getEndpoint()
+            ->setCollection($index->name);
+
+        $this->client->update($update);
+
+        if (true !== ($options['return_slow_promise_result'] ?? false)) {
+            return null;
+        }
+
+        return new SyncTask(null);
+    }
+
+    public function delete(Index $index, string $identifier, array $options = []): ?TaskInterface
+    {
+        $update = $this->client->createUpdate();
+        $update->addDeleteById($identifier);
+        $update->addCommit();
+
+        $this->client->getEndpoint()
+            ->setCollection($index->name);
+
+        $this->client->update($update);
+
+        if (true !== ($options['return_slow_promise_result'] ?? false)) {
+            return null;
+        }
+
+        return new SyncTask(null);
+    }
+
+    public function search(Search $search): Result
+    {
+        // optimized single document query
+        if (
+            count($search->indexes) === 1
+            && count($search->filters) === 1
+            && $search->filters[0] instanceof Condition\IdentifierCondition
+            && $search->offset === 0
+            && $search->limit === 1
+        ) {
+            $this->client->getEndpoint()
+                ->setCollection($search->indexes[\array_key_first($search->indexes)]->name);
+
+            $query = $this->client->createRealtimeGet();
+            $query->addId($search->filters[0]->identifier);
+            $result = $this->client->realtimeGet($query);
+
+            if (!$result->getNumFound()) {
+                return new Result(
+                    $this->hitsToDocuments($search->indexes, []),
+                    0
+                );
+            }
+
+            return new Result(
+                $this->hitsToDocuments($search->indexes, [$result->getDocument()]),
+                1
+            );
+        }
+
+        if (count($search->indexes) !== 1) {
+            throw new \RuntimeException('Solr does not yet support search multiple indexes: https://github.com/schranz-search/schranz-search/issues/86');
+        }
+
+        $index = $search->indexes[\array_key_first($search->indexes)];
+        $this->client->getEndpoint()
+            ->setCollection($index->name);
+
+        $query = $this->client->createSelect();
+        $helper = $query->getHelper();
+
+        $queryText = null;
+
+        $filters = [];
+        foreach ($search->filters as $filter) {
+            match (true) {
+                $filter instanceof Condition\SearchCondition => $queryText = $filter->query,
+                $filter instanceof Condition\IdentifierCondition => $filters[] = $index->getIdentifierField()->name . ':' . $helper->escapeTerm($filter->identifier),
+                $filter instanceof Condition\EqualCondition => $filters[] = $this->getFilterField($search->indexes, $filter->field) . ':' . $helper->escapeTerm($filter->value),
+                $filter instanceof Condition\NotEqualCondition => $filters[] = '-' . $this->getFilterField($search->indexes, $filter->field) . ':' . $helper->escapeTerm($helper->escapeTerm($filter->value)),
+                $filter instanceof Condition\GreaterThanCondition => $filters[] = $this->getFilterField($search->indexes, $filter->field) . ':{' . $helper->escapeTerm($filter->value) . ' TO *}',
+                $filter instanceof Condition\GreaterThanEqualCondition => $filters[] = $this->getFilterField($search->indexes, $filter->field) . ':[' . $helper->escapeTerm($filter->value) . ' TO *]',
+                $filter instanceof Condition\LessThanCondition => $filters[] = $this->getFilterField($search->indexes, $filter->field) . ':{* TO ' . $helper->escapeTerm($filter->value) . '}',
+                $filter instanceof Condition\LessThanEqualCondition => $filters[] = $this->getFilterField($search->indexes, $filter->field) . ':[* TO ' . $helper->escapeTerm($filter->value) . ']',
+                default => throw new \LogicException($filter::class . ' filter not implemented.'),
+            };
+        }
+
+        if ($queryText !== null) {
+            $dismax = $query->getDisMax();
+            $dismax->setQueryFields(implode(' ', $index->searchableFields));
+
+            $query->setQuery($queryText);
+        }
+
+        foreach ($filters as $key => $filter) {
+            $query->createFilterQuery('filter_' . $key)->setQuery($filter);
+        }
+
+        if ($search->offset) {
+            $query->setStart($search->offset);
+        }
+
+        if ($search->limit) {
+            $query->setRows($search->limit);
+        }
+
+        foreach ($search->sortBys as $field => $direction) {
+            $query->addSort($field, $direction);
+        }
+
+        $result = $this->client->select($query);
+
+        return new Result(
+            $this->hitsToDocuments($search->indexes, $result->getDocuments()),
+            $result->getNumFound()
+        );
+    }
+
+    /**
+     * @param Index[] $indexes
+     * @param iterable<\Solarium\QueryType\Select\Result\Document> $hits
+     *
+     * @return \Generator<array<string, mixed>>
+     */
+    private function hitsToDocuments(array $indexes, iterable $hits): \Generator
+    {
+        $index = $indexes[\array_key_first($indexes)];
+
+        foreach ($hits as $hit) {
+            $hit = $hit->getFields();
+
+            unset($hit['_version_']);
+
+            if ($index->getIdentifierField()->name !== 'id') {
+                // Solr currently does not support set another identifier then id: https://github.com/schranz-search/schranz-search/issues/87
+                $id = $hit['id'];
+                unset($hit['id']);
+
+                $hit[$index->getIdentifierField()->name] = $id;
+            }
+
+            yield $this->marshaller->unmarshall($index->fields, $hit);
+        }
+    }
+
+    private function getFilterField(array $indexes, string $name): string
+    {
+        foreach ($indexes as $index) {
+            try {
+                $field = $index->getFieldByPath($name);
+
+                if ($field instanceof Field\TextField) {
+                    return $name . '.raw';
+                }
+
+                return $name;
+            } catch (FieldByPathNotFoundException $e) {
+                // ignore when field is not found and use go to next index instead
+            }
+        }
+
+        return $name;
+    }
+}