EV-267: Added index service

Author: cableman

baseline.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<files psalm-version="5.16.0@2897ba636551a8cb61601cc26f6ccfbba6c36591">
+  <file src="src/Api/State/EventRepresentationProvider.php">
+    <MissingTemplateParam>
+      <code>ProviderInterface</code>
+    </MissingTemplateParam>
+  </file>
+  <file src="src/Command/FixturesLoadCommand.php">
+    <UndefinedDocblockClass>
+      <code>\HttpException</code>
+    </UndefinedDocblockClass>
+  </file>
+  <file src="src/Fixtures/FixtureLoader.php">
+    <InvalidArgument>
+      <code><![CDATA[[
+                'index' => $indexName,
+                'body' => [
+                    'settings' => [
+                        'number_of_shards' => 5,
+                        'number_of_replicas' => 0,
+                    ],
+                ],
+            ]]]></code>
+    </InvalidArgument>
+    <PossiblyUndefinedMethod>
+      <code>getStatusCode</code>
+      <code>getStatusCode</code>
+    </PossiblyUndefinedMethod>
+    <UndefinedClass>
+      <code>\HttpException</code>
+    </UndefinedClass>
+    <UndefinedDocblockClass>
+      <code>\HttpException</code>
+      <code>\HttpException</code>
+    </UndefinedDocblockClass>
+  </file>
+  <file src="src/Service/EsIndex.php">
+    <UndefinedClass>
+      <code>\IndexInterface</code>
+    </UndefinedClass>
+  </file>
+</files>

composer.json

@@ -9,6 +9,7 @@
         "php": ">=8.2",
         "ext-ctype": "*",
         "ext-iconv": "*",
+        "ext-http": "*",
         "api-platform/core": "^3.2",
         "doctrine/doctrine-bundle": "^2.11",
         "doctrine/doctrine-migrations-bundle": "^3.3",

src/Command/FixturesLoadCommand.php

@@ -4,6 +4,9 @@
 
 use App\Fixtures\FixtureLoader;
 use App\Model\IndexNames;
+use Elastic\Elasticsearch\Exception\ClientResponseException;
+use Elastic\Elasticsearch\Exception\MissingParameterException;
+use Elastic\Elasticsearch\Exception\ServerResponseException;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Completion\CompletionInput;
@@ -12,6 +15,10 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 
 #[AsCommand(
     name: 'app:fixtures:load',
@@ -31,35 +38,46 @@ protected function configure(): void
         $this->addArgument(
             'index',
             InputArgument::REQUIRED,
-            sprintf('Index to dump (one of %s)', implode(', ', IndexNames::values())),
+            sprintf('Index to populate with fixture data (one of %s)', implode(', ', IndexNames::values())),
             null,
             function (CompletionInput $input): array {
                 return array_filter(IndexNames::values(), fn ($item) => str_starts_with($item, $input->getCompletionValue()));
             }
         )
-        ->addOption('url', null, InputOption::VALUE_OPTIONAL, 'Remote url to read data from', 'https://raw.githubusercontent.com/itk-dev/event-database-imports/develop/src/DataFixtures/indexes/[index].json');
+        ->addOption('url', null, InputOption::VALUE_OPTIONAL, 'Remote url to read fixture data from', 'https://raw.githubusercontent.com/itk-dev/event-database-imports/develop/src/DataFixtures/indexes/[index].json');
     }
 
+    /**
+     * @throws RedirectionExceptionInterface
+     * @throws ClientExceptionInterface
+     * @throws \JsonException
+     * @throws TransportExceptionInterface
+     * @throws ClientResponseException
+     * @throws ServerExceptionInterface
+     * @throws \HttpException
+     * @throws ServerResponseException
+     * @throws MissingParameterException
+     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
-        $index = $input->getArgument('index');
+        $indexName = $input->getArgument('index');
         $url = (string) $input->getOption('url');
-        $url = strtr($url, ['[index]' => $index]);
+        $url = strtr($url, ['[index]' => $indexName]);
 
         if ('dev' !== $this->appEnv) {
             $io->error('This command should only be executed in development environment.');
 
             return Command::FAILURE;
         }
 
-        if (!in_array($index, IndexNames::values())) {
-            $io->error(sprintf('Index %s does not exist', $index));
+        if (!in_array($indexName, IndexNames::values())) {
+            $io->error(sprintf('Index %s does not exist', $indexName));
 
             return Command::FAILURE;
         }
 
-        $this->loader->process($index, $url);
+        $this->loader->process($indexName, $url);
 
         return Command::SUCCESS;
     }

src/Exception/AppException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace App\Exception;
+
+abstract class AppException extends \Exception
+{
+}

src/Exception/IndexException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace App\Exception;
+
+class IndexException extends AppException
+{
+}

src/Fixtures/FixtureLoader.php

@@ -2,48 +2,101 @@
 
 namespace App\Fixtures;
 
+use App\Service\IndexInterface;
 use Elastic\Elasticsearch\Client;
 use Elastic\Elasticsearch\Exception\ClientResponseException;
 use Elastic\Elasticsearch\Exception\MissingParameterException;
 use Elastic\Elasticsearch\Exception\ServerResponseException;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 class FixtureLoader
 {
     public function __construct(
         private readonly HttpClientInterface $httpClient,
+        private readonly IndexInterface $index,
         private readonly Client $client
     ) {
     }
 
+    /**
+     * @throws RedirectionExceptionInterface
+     * @throws ClientExceptionInterface
+     * @throws \JsonException
+     * @throws TransportExceptionInterface
+     * @throws ClientResponseException
+     * @throws ServerExceptionInterface
+     * @throws \HttpException
+     * @throws ServerResponseException
+     * @throws MissingParameterException
+     * @throws \Exception
+     */
     public function process(string $indexName, string $url): void
     {
         $items = $this->download($url);
 
-        $configuration = [
-            'index' => $indexName,
-            'body' => [
-                'settings' => [
-                    'number_of_shards' => 5,
-                    'number_of_replicas' => 0,
-                ],
-            ],
-        ];
+        $this->createIndex($indexName);
+        $this->indexItems($indexName, $items);
+    }
+
+    /**
+     * Download data as JSON from a given URL.
+     *
+     * @param string $url
+     *   The URL from which to download the data
+     *
+     * @return array
+     *   The downloaded data as an associative array
+     *
+     * @throws \HttpException
+     *   If unable to download the fixture data
+     * @throws \JsonException
+     *    If there is an error, decoding the downloaded data
+     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
+     *   If a client exception occurs during the HTTP request
+     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
+     *   If a redirection exception occurs during the HTTP request
+     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
+     *   If a server exception occurs during the HTTP request
+     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
+     *   If a transport exception occurs during the HTTP request
+     */
+    private function download(string $url): array
+    {
+        $response = $this->httpClient->request('GET', $url);
 
-        try {
-            $response = $this->client->indices()->create($configuration);
-        } catch (ClientResponseException|MissingParameterException|ServerResponseException $e) {
-            // Ignore index exists error.
+        if (Response::HTTP_OK !== $response->getStatusCode()) {
+            throw new \HttpException('Unable to download fixture data');
         }
 
+        return json_decode($response->getContent(), true, 512, JSON_THROW_ON_ERROR);
+    }
+
+    /**
+     * Index items in Elasticsearch.
+     *
+     * @param string $indexName
+     *    The name of the index in Elasticsearch where the items should be indexed
+     * @param array $items
+     *   The items to be indexed in Elasticsearch. Each item should be an associative array.
+     *
+     * @throws \Exception
+     *   If unable to add an item to the index
+     */
+    private function indexItems(string $indexName, array $items): void
+    {
         foreach ($items as $item) {
             $params = [
                 'index' => $indexName,
                 'id' => $item['entityId'],
                 'body' => $item,
             ];
             try {
+                // No other places in this part of the frontend should index data, hence it's not in the index service.
                 $response = $this->client->index($params);
 
                 if (!in_array($response->getStatusCode(), [Response::HTTP_OK, Response::HTTP_CREATED, Response::HTTP_NO_CONTENT])) {
@@ -55,14 +108,33 @@ public function process(string $indexName, string $url): void
         }
     }
 
-    private function download($url): array
+    /**
+     * Creates an index with the given name if it does not already exist.
+     *
+     * @param string $indexName
+     *   The name of the index
+     *
+     * @throws clientResponseException
+     *   If an error occurs during the Elasticsearch client request
+     * @throws missingParameterException
+     *   If the required parameter is missing
+     * @throws serverResponseException
+     *   If the server returns an error during the Elasticsearch request
+     */
+    private function createIndex(string $indexName): void
     {
-        $response = $this->httpClient->request('GET', $url);
-
-        if (Response::HTTP_OK !== $response->getStatusCode()) {
-            throw new \HttpException('Unable to download fixture data');
+        if (!$this->index->indexExists($indexName)) {
+            // This creation of the index is not in den index service as this is the only place it should be used. In
+            // production and in many cases, you should connect to the index managed by the backend (imports).
+            $this->client->indices()->create([
+                'index' => $indexName,
+                'body' => [
+                    'settings' => [
+                        'number_of_shards' => 5,
+                        'number_of_replicas' => 0,
+                    ],
+                ],
+            ]);
         }
-
-        return json_decode($response->getContent(), true, 512, JSON_THROW_ON_ERROR);
     }
 }

src/Service/ElasticSearchIndex.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Service;
+
+use App\Exception\IndexException;
+use Elastic\Elasticsearch\Client;
+use Elastic\Elasticsearch\Exception\ClientResponseException;
+use Elastic\Elasticsearch\Exception\ServerResponseException;
+use Elastic\Elasticsearch\Response\Elasticsearch;
+use Symfony\Component\HttpFoundation\Response;
+
+class ElasticSearchIndex implements \IndexInterface
+{
+    public function __construct(
+        private readonly Client $client
+    ) {
+    }
+
+    public function indexExists($indexName): bool
+    {
+        try {
+            /** @var Elasticsearch $response */
+            $response = $this->client->indices()->getAlias(['name' => $indexName]);
+
+            return Response::HTTP_OK === $response->getStatusCode();
+        } catch (ClientResponseException|ServerResponseException $e) {
+            if (Response::HTTP_NOT_FOUND === $e->getCode()) {
+                return false;
+            }
+
+            throw new IndexException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+}

src/Service/IndexInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Service;
+
+interface IndexInterface
+{
+    /**
+     * Checks if the given index exists.
+     *
+     * @param string $indexName
+     *   The name of the index to check.
+     *
+     * @return bool
+     *   True if the index exists, false otherwise.
+     */
+    public function indexExists(string $indexName): bool;
+}