Index cities in elastic + add endpoint to retrieve them

Author: bailletced

.env

@@ -11,3 +11,4 @@ CORS_ALLOW_ORIGIN='^https?://(localhost|127\.0\.0\.1)(:[0-9]+)?$'
 REDIS_URL=redis://redis:6379
 LOCK_DSN=flock
 SENTRY_DSN=
+CITIES_DOWNLOAD_URL="https://datanova.laposte.fr/data-fair/api/v1/datasets/laposte-hexasmal/raw"

compose.yaml

@@ -98,6 +98,7 @@ services:
       ELASTIC_PASSWORD:
       SYNCHRO_SECRET_KEY:
       REDIS_URL:
+      CITIES_DOWNLOAD_URL:
     depends_on:
       - db
       - redis

config/packages/api_platform.yaml

@@ -14,6 +14,7 @@ api_platform:
       - "%kernel.project_dir%/src/FieldHolder/Community/Domain/Exception/"
       - "%kernel.project_dir%/src/Field/Domain/Exception/"
       - "%kernel.project_dir%/src/System/Infrastructure/ApiPlatform/Resource/"
+      - "%kernel.project_dir%/src/City/Infrastructure/ApiPlatform/Resource/"
   formats:
     json: ["application/json"]
     jsonld: ["application/ld+json"]

config/services.yaml

@@ -11,6 +11,9 @@ services:
   _defaults:
     autowire: true # Automatically injects dependencies in your services.
     autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
+    bind:
+      $citiesDownloadUrl: "%env(CITIES_DOWNLOAD_URL)%"
+      $targetPath: "%kernel.project_dir%/var/data/cities.csv"
 
   # makes classes in src/ available to be used as services
   # this creates a service per class whose id is the fully-qualified class name
@@ -54,6 +57,8 @@ services:
       $elasticsearchHost: "%env(ELASTICSEARCH_IRI)%"
   App\Core\Domain\Service\Search\SearchServiceInterface:
     class: App\Core\Infrastructure\Service\OfficialElasticSearchService
+  App\Core\Domain\Service\Search\CitiesDownloaderInterface:
+    class: App\Core\Infrastructure\Symfony\Service\LaposteCitiesDownloader
 
   App\Core\Infrastructure\ElasticSearch\Helper\OfficialElasticSearchHelper:
     arguments:

etc/cron.d/backend

@@ -22,4 +22,4 @@ HOME=/var/www/html
 #
 # m h  dom mon dow   command
 
-30 18 * * * www-data /usr/bin/php $HOME/bin/console app:write:indexes > /proc/1/fd/1 2>/proc/1/fd/2
+30 18 * * * www-data /usr/bin/php $HOME/bin/console app:index:communities > /proc/1/fd/1 2>/proc/1/fd/2

src/City/Infrastructure/ApiPlatform/Filter/NameFilter.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\City\Infrastructure\ApiPlatform\Filter;
+
+use ApiPlatform\Metadata\FilterInterface;
+use Symfony\Component\PropertyInfo\Type;
+
+final class NameFilter implements FilterInterface
+{
+    public function getDescription(string $resourceClass): array
+    {
+        return [
+            'name' => [
+                'property' => 'name',
+                'type' => Type::BUILTIN_TYPE_STRING,
+                'required' => false,
+            ],
+        ];
+    }
+}

src/City/Infrastructure/ApiPlatform/Resource/CityResource.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\City\Infrastructure\ApiPlatform\Resource;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\GetCollection;
+use App\City\Infrastructure\ApiPlatform\State\Provider\CityCollectionProvider;
+use App\City\Infrastructure\ApiPlatform\Filter\NameFilter;
+use App\Field\Domain\Model\Field;
+
+#[ApiResource(
+    shortName: 'City',
+    cacheHeaders: [
+        'public' => true,
+        'max_age' => 3600,
+    ],
+    uriTemplate: '/cities',
+    operations: [
+        new GetCollection(
+            filters: [
+                NameFilter::class,
+            ],
+            provider: CityCollectionProvider::class,
+        ),
+    ],
+)]
+final class CityResource
+{
+    /**
+     * @param Field[] $fields
+     */
+    public function __construct(
+        public string $name,
+
+        public string $postCode,
+    ) {
+    }
+
+    public static function fromModel(array $city): self
+    {
+        return new self(
+            $city['cityName'],
+            $city['postCode'],
+        );
+    }
+}

src/City/Infrastructure/ApiPlatform/State/Provider/CityCollectionProvider.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\City\Infrastructure\ApiPlatform\State\Provider;
+
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\State\Pagination\Pagination;
+use ApiPlatform\State\ProviderInterface;
+use App\City\Infrastructure\ApiPlatform\Resource\CityResource;
+use App\Core\Domain\Search\Service\SearchServiceInterface;
+use App\Shared\Infrastructure\ApiPlatform\State\Paginator;
+
+/**
+ * @implements ProviderInterface<CityResource>
+ */
+final class CityCollectionProvider implements ProviderInterface
+{
+    public function __construct(
+        private Pagination $pagination,
+        private SearchServiceInterface $searchService,
+    ) {
+    }
+
+    /**
+     * @return Paginator<CityResource>|list<CityResource>
+     */
+    public function provide(Operation $operation, array $uriVariables = [], array $context = []): Paginator|array
+    {
+        $name = $context['filters']['name'] ?? null;
+        $page = $itemsPerPage = null;
+        $cities = [];
+
+        if ($this->pagination->isEnabled($operation, $context)) {
+            $page = $this->pagination->getPage($context);
+            $itemsPerPage = $this->pagination->getLimit($operation, $context);
+        }
+
+        if ($name !== null) {
+            $cities = $this->searchService->searchCities($name, $itemsPerPage, $page - 1);
+        };
+
+        $resources = [];
+        foreach ($cities as $city) {
+            $resources[] = CityResource::fromModel($city);
+        }
+
+        return $resources;
+    }
+}

src/Core/Domain/Search/Service/CitiesDownloaderInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Core\Domain\Search\Service;
+
+interface CitiesDownloaderInterface
+{
+    /**
+     * @return array<{cityName: string, postCode: int}>
+     */
+    public function getCities(): array;
+}

src/Core/Domain/Search/Service/SearchServiceInterface.php

@@ -22,6 +22,8 @@ public function searchDioceseIds(string $text, int $limit, int $offset): array;
 
     public function findDiocese(string $text): ?Community;
 
+    public function searchCities(string $text, int $limit, int $offset): array;
+
     /**
      * @return string[]
      */