Merge remote-tracking branch 'origin/master' into features/improve-accompanying-course-summary

src/Bundle/ChillMainBundle/Controller/SearchController.php

@@ -36,6 +36,7 @@ use Chill\MainBundle\Search\SearchProvider;
 use Symfony\Contracts\Translation\TranslatorInterface;
 use Chill\MainBundle\Pagination\PaginatorFactory;
 use Chill\MainBundle\Search\SearchApi;
+use Symfony\Component\HttpFoundation\Exception\BadRequestException;
 
 /**
  * Class SearchController
@@ -151,11 +152,14 @@ class SearchController extends AbstractController
     {
         //TODO this is an incomplete implementation
         $query = $request->query->get('q', '');
+        $types = $request->query->get('type', []);
 
-        $results = $this->searchApi->getResults($query, 0, 150);
-        $paginator = $this->paginatorFactory->create(count($results));
+        if (count($types) === 0) {
+            throw new BadRequestException("The request must contains at "
+                ." one type");
+        }
 
-        $collection = new Collection($results, $paginator);
+        $collection = $this->searchApi->getResults($query, $types, []);
 
         return $this->json($collection);
     }

src/Bundle/ChillMainBundle/Controller/UserApiController.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Chill\MainBundle\Controller;
+
+use Chill\MainBundle\CRUD\Controller\ApiController;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\Routing\Annotation\Route;
+
+class UserApiController extends ApiController
+{
+    /**
+     * @Route(
+     *      "/api/1.0/main/whoami.{_format}",
+     *      name="chill_main_user_whoami",
+     *      requirements={
+     *          "_format": "json"
+     *          }
+     *      )
+     */
+    public function whoami($_format): JsonResponse
+    {
+        return $this->json($this->getUser(), JsonResponse::HTTP_OK, [],
+            [ "groups" => [ "read" ] ]);
+    }
+    
+}

src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php

@@ -347,7 +347,28 @@ class ChillMainExtension extends Extension implements PrependExtensionInterface,
                             ]
                         ],
                     ]
-                ]
+                ],
+                [
+                    'class' => \Chill\MainBundle\Entity\User::class,
+                    'controller' => \Chill\MainBundle\Controller\UserApiController::class,
+                    'name' => 'user',
+                    'base_path' => '/api/1.0/main/user',
+                    'base_role' => 'ROLE_USER',
+                    'actions' => [
+                        '_index' => [
+                            'methods' => [
+                                Request::METHOD_GET => true,
+                                Request::METHOD_HEAD => true
+                            ],
+                        ],
+                        '_entity' => [
+                            'methods' => [
+                                Request::METHOD_GET => true,
+                                Request::METHOD_HEAD => true,
+                            ]
+                        ],
+                    ]
+                ],
             ]
         ]);
     }

src/Bundle/ChillMainBundle/Search/SearchApi.php

@@ -2,88 +2,169 @@
 
 namespace Chill\MainBundle\Search;
 
-use Chill\PersonBundle\Entity\Person;
-use Chill\ThirdPartyBundle\Entity\ThirdParty;
+use Chill\MainBundle\Serializer\Model\Collection;
+use Chill\MainBundle\Pagination\PaginatorFactory;
+use Chill\PersonBundle\Search\SearchPersonApiProvider;
+use Chill\ThirdPartyBundle\Search\ThirdPartyApiSearch;
+use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Query\ResultSetMappingBuilder;
 use Chill\MainBundle\Search\SearchProvider;
 use Symfony\Component\VarDumper\Resources\functions\dump;
 
 /**
- *  ***Warning*** This is an incomplete implementation ***Warning***
  */
 class SearchApi
 {
     private EntityManagerInterface $em;
-    private SearchProvider $search;
+    private PaginatorFactory $paginator;
 
-    public function __construct(EntityManagerInterface $em, SearchProvider $search)
+    private array $providers = [];
+
+    public function __construct(
+        EntityManagerInterface $em,
+        SearchPersonApiProvider $searchPerson,
+        ThirdPartyApiSearch $thirdPartyApiSearch,
+        PaginatorFactory $paginator
+    )
     {
         $this->em = $em;
-        $this->search = $search;
+        $this->providers[] = $searchPerson;
+        $this->providers[] = $thirdPartyApiSearch;
+        $this->paginator = $paginator;
     }
 
     /**
      * @return Model/Result[]
      */
-    public function getResults(string $query, int $offset, int $maxResult): array
+    public function getResults(string $pattern, array $types, array $parameters): Collection
     {
-        // **warning again**: this is an incomplete implementation 
-        $results = [];
+        $queries = $this->findQueries($pattern, $types, $parameters);
 
-        foreach ($this->getPersons($query) as $p) {
-            $results[] = new Model\Result((float)\rand(0, 100) / 100, $p);
-        }
-        foreach ($this->getThirdParties($query) as $t) {
-            $results[] = new Model\Result((float)\rand(0, 100) / 100, $t);
-        }
+        $total = $this->countItems($queries, $types, $parameters);
+        $paginator = $this->paginator->create($total);
 
-        \usort($results, function(Model\Result $a, Model\Result $b) {
-            return ($a->getRelevance() <=> $b->getRelevance()) * -1;
-        });
+        $rawResults = $this->fetchRawResult($queries, $types, $parameters, $paginator);
 
-        return $results;
+        $this->prepareProviders($rawResults);
+        $results = $this->buildResults($rawResults);
+
+        $collection = new Collection($results, $paginator);
+
+        return $collection;
     }
 
-    public function countResults(string $query): int
+    private function findQueries($pattern, array $types, array $parameters): array
     {
-        return 0;
+        return \array_map(
+            fn($p) => $p->provideQuery($pattern, $parameters),
+            $this->findProviders($pattern, $types, $parameters),
+        );
     }
 
-    private function getThirdParties(string $query)
+    private function findProviders(string $pattern, array $types, array $parameters): array
     {
-        $thirdPartiesIds = $this->em->createQuery('SELECT t.id FROM '.ThirdParty::class.' t')
-            ->getScalarResult();
-        $nbResults = rand(0, 15);
-
-        if ($nbResults === 1) {
-            $nbResults++;
-        } elseif ($nbResults === 0) {
-            return [];
-        }
-        $ids = \array_map(function ($e) use ($thirdPartiesIds) { return $thirdPartiesIds[$e]['id'];}, 
-            \array_rand($thirdPartiesIds, $nbResults));
-
-        $a = $this->em->getRepository(ThirdParty::class)
-            ->findById($ids);
-        return $a;
+        return \array_filter(
+            $this->providers,
+            fn($p) => $p->supportsTypes($pattern, $types, $parameters)
+        );
     }
 
-    private function getPersons(string $query)
+    private function countItems($providers, $types, $parameters): int
     {
-        $params = [
-            SearchInterface::SEARCH_PREVIEW_OPTION => false
-            ];
-        $search = $this->search->getResultByName($query, 'person_regular', 0, 50, $params, 'json');
-        $ids = \array_map(function($r) { return $r['id']; }, $search['results']);
+        list($countQuery, $parameters) = $this->buildCountQuery($providers, $types, $parameters);
+        $rsmCount = new ResultSetMappingBuilder($this->em);
+        $rsmCount->addScalarResult('count', 'count');
+        $countNq = $this->em->createNativeQuery($countQuery, $rsmCount);
+        $countNq->setParameters($parameters);
+        
+        return $countNq->getSingleScalarResult();
+    }
 
+    private function buildCountQuery(array $queries, $types, $parameters)
+    {
+        $query = "SELECT COUNT(sq.key) AS count FROM ({union_unordered}) AS sq";
+        $unions = [];
+        $parameters = [];
 
-        if (count($ids) === 0) {
-            return [];
+        foreach ($queries as $q) {
+            $unions[] = $q->buildQuery();
+            $parameters = \array_merge($parameters, $q->buildParameters());
         }
 
-        return $this->em->getRepository(Person::class)
-            ->findById($ids)
+        $unionUnordered = \implode(" UNION ", $unions);
+
+        return [
+            \strtr($query, [ '{union_unordered}' => $unionUnordered ]),
+            $parameters
+        ];
+    }
+
+    private function buildUnionQuery(array $queries, $types, $parameters)
+    {
+        $query = "{unions} ORDER BY pertinence DESC";
+        $unions = [];
+        $parameters = [];
+
+        foreach ($queries as $q) {
+            $unions[] = $q->buildQuery();
+            $parameters = \array_merge($parameters, $q->buildParameters());
+        }
+
+        $union = \implode(" UNION ", $unions);
+
+        return [
+            \strtr($query, [ '{unions}' => $union]),
+            $parameters
+        ];
+    }
+
+    private function fetchRawResult($queries, $types, $parameters, $paginator): array
+    {
+        list($union, $parameters) = $this->buildUnionQuery($queries, $types, $parameters, $paginator);
+        $rsm = new ResultSetMappingBuilder($this->em);
+        $rsm->addScalarResult('key', 'key', Types::STRING)
+            ->addScalarResult('metadata', 'metadata', Types::JSON)
+            ->addScalarResult('pertinence', 'pertinence', Types::FLOAT)
             ;
+
+        $nq = $this->em->createNativeQuery($union, $rsm);
+        $nq->setParameters($parameters);
+        
+        return $nq->getResult();
+    }
+
+    private function prepareProviders($rawResults)
+    {
+        $metadatas = [];
+        foreach ($rawResults as $r) {
+            foreach ($this->providers as $k => $p) {
+                if ($p->supportsResult($r['key'], $r['metadata'])) {
+                    $metadatas[$k][] = $r['metadata'];
+                    break;
+                } 
+            }
+        }
+
+        foreach ($metadatas as $k => $m) {
+            $this->providers[$k]->prepare($m);
+        }
+    }
+
+    private function buildResults($rawResults)
+    {
+        foreach ($rawResults as $r) {
+            foreach ($this->providers as $k => $p) {
+                if ($p->supportsResult($r['key'], $r['metadata'])) {
+                    $items[] = (new SearchApiResult($r['pertinence']))
+                        ->setResult(
+                            $p->getResult($r['key'], $r['metadata'], $r['pertinence'])
+                        );
+                    break;
+                } 
+            }
+        }
+
+        return $items ?? [];
     }
-    
 }

src/Bundle/ChillMainBundle/Search/SearchApiInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Chill\MainBundle\Search;
+
+use Chill\MainBundle\Search\SearchApiQuery;
+
+interface SearchApiInterface
+{
+    public function provideQuery(string $pattern, array $parameters): SearchApiQuery;
+
+    public function supportsTypes(string $pattern, array $types, array $parameters): bool;
+
+    public function prepare(array $metadatas): void;
+
+    public function supportsResult(string $key, array $metadatas): bool;
+
+    public function getResult(string $key, array $metadata, float $pertinence);
+}

src/Bundle/ChillMainBundle/Search/SearchApiQuery.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace Chill\MainBundle\Search;
+
+class SearchApiQuery
+{
+    private ?string $selectKey;
+    private array $selectKeyParams = [];
+    private ?string $jsonbMetadata;
+    private array $jsonbMetadataParams = [];
+    private ?string $pertinence;
+    private array $pertinenceParams = [];
+    private ?string $fromClause;
+    private array $fromClauseParams = [];
+    private ?string $whereClause;
+    private array $whereClauseParams = [];
+
+    public function setSelectKey(string $selectKey, array $params = []): self
+    {
+        $this->selectKey = $selectKey;
+        $this->selectKeyParams = $params;
+
+        return $this;
+    }
+
+    public function setSelectJsonbMetadata(string $jsonbMetadata, array $params = []): self
+    {
+        $this->jsonbMetadata = $jsonbMetadata;
+        $this->jsonbMetadataParams = $params;
+
+        return $this;
+    }
+
+    public function setSelectPertinence(string $pertinence, array $params = []): self
+    {
+        $this->pertinence = $pertinence;
+        $this->pertinenceParams = $params;
+
+        return $this;
+    }
+
+    public function setFromClause(string $fromClause, array $params = []): self
+    {
+        $this->fromClause = $fromClause;
+        $this->fromClauseParams = $params;
+
+        return $this;
+    }
+
+    public function setWhereClause(string $whereClause, array $params = []): self
+    {
+        $this->whereClause = $whereClause;
+        $this->whereClauseParams = $params;
+
+        return $this;
+    }
+
+    public function buildQuery(): string
+    {
+        return \strtr("SELECT
+            '{key}' AS key,
+            {metadata} AS metadata,
+            {pertinence} AS pertinence
+        FROM {from}
+        WHERE {where}
+        ", [
+            '{key}' => $this->selectKey,
+            '{metadata}' => $this->jsonbMetadata,
+            '{pertinence}' => $this->pertinence,
+            '{from}' => $this->fromClause,
+            '{where}' => $this->whereClause
+        ]);
+    }
+
+    public function buildParameters(): array
+    {
+        return \array_merge(
+            $this->selectKeyParams,
+            $this->jsonbMetadataParams,
+            $this->pertinenceParams,
+            $this->fromClauseParams,
+            $this->whereClauseParams
+        );
+    }
+}

src/Bundle/ChillMainBundle/Search/SearchApiResult.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Chill\MainBundle\Search;
+
+use Symfony\Component\Serializer\Annotation as Serializer;
+
+class SearchApiResult
+{
+    private float $pertinence;
+
+    private $result;
+
+    public function __construct(float $relevance)
+    {
+        $this->relevance = $relevance;
+    }
+
+    public function setResult($result): self
+    {
+        $this->result = $result;
+
+        return $this;
+    } 
+
+    /**
+     * @Serializer\Groups({"read"})
+     */
+    public function getResult()
+    {
+        return $this->result;
+    }
+
+    /**
+     * @Serializer\Groups({"read"})
+     */
+    public function getRelevance(): float
+    {
+        return $this->relevance;
+    }
+}

src/Bundle/ChillMainBundle/Tests/Controller/SearchApiControllerTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Bundle\ChillMainBundle\Tests\Controller;
+
+use Chill\MainBundle\Test\PrepareClientTrait;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+use Symfony\Component\HttpFoundation\Request;
+
+class SearchApiControllerTest extends WebTestCase
+{
+    use PrepareClientTrait;
+
+    /**
+     * @dataProvider generateSearchData
+     */
+    public function testSearch(string $pattern, array $types)
+    {
+        $client = $this->getClientAuthenticated();
+
+        $client->request(
+            Request::METHOD_GET,
+            '/api/1.0/search.json',
+            [ 'q' => $pattern, 'type' => $types ]
+        );
+
+        $this->assertResponseIsSuccessful();
+    }
+
+    public function generateSearchData()
+    {
+        yield ['per', ['person', 'thirdparty'] ];
+        yield ['per', ['thirdparty'] ];
+        yield ['per', ['person'] ];
+        yield ['fjklmeqjfkdqjklrmefdqjklm', ['person', 'thirdparty'] ];
+    }
+}

src/Bundle/ChillMainBundle/Tests/Controller/UserApiControllerTest.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Chill\MainBundle\Tests\Controller;
+
+use Chill\MainBundle\Test\PrepareClientTrait;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+
+class UserApiControllerTest extends WebTestCase
+{
+    use PrepareClientTrait;
+
+    public function testIndex()
+    {
+        $client = $this->getClientAuthenticated();
+
+        $client->request(Request::METHOD_GET, '/api/1.0/main/user.json');
+
+        $this->assertResponseIsSuccessful();
+
+        $data = \json_decode($client->getResponse()->getContent(), true);
+        $this->assertTrue(\array_key_exists('count', $data));
+        $this->assertGreaterThan(0, $data['count']);
+        $this->assertTrue(\array_key_exists('results', $data));
+
+        return $data['results'][0];
+    }
+
+    /**
+     * @depends testIndex
+     */
+    public function testEntity($existingUser)
+    {
+        $client = $this->getClientAuthenticated();
+
+        $client->request(Request::METHOD_GET, '/api/1.0/main/user/'.$existingUser['id'].'.json');
+
+        $this->assertResponseIsSuccessful();
+    }
+
+    public function testWhoami()
+    {
+        $client = $this->getClientAuthenticated();
+
+        $client->request(Request::METHOD_GET, '/api/1.0/main/whoami.json');
+
+        $this->assertResponseIsSuccessful();
+    }
+}

src/Bundle/ChillMainBundle/chill.api.specs.yaml

@@ -10,6 +10,19 @@ servers:
 
 components:
   schemas:
+    User:
+      type: object
+      properties:
+        id:
+          type: integer
+        type:
+          type: string
+          enum:
+            - user
+        username:
+          type: string
+        text:
+          type: string
     Center:
       type: object
       properties:
@@ -425,3 +438,46 @@ paths:
           description: "not found"
         401:
           description: "Unauthorized"
+
+
+  /1.0/main/user.json:
+    get:
+      tags:
+        - user
+      summary: Return a list of all user
+      responses:
+        200:
+          description: "ok"
+  /1.0/main/whoami.json:
+    get:
+      tags:
+        - user
+      summary: Return the currently authenticated user
+      responses:
+        200:
+          description: "ok"
+  /1.0/main/user/{id}.json:
+    get:
+      tags:
+        - user
+      summary: Return a user by id
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: The user id
+          schema:
+            type: integer
+            format: integer
+            minimum: 1
+      responses:
+        200:
+          description: "ok"
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+        404:
+          description: "not found"
+        401:
+          description: "Unauthorized"

src/Bundle/ChillMainBundle/config/services/search.yaml

@@ -5,6 +5,5 @@ services:
     Chill\MainBundle\Search\SearchProvider: '@chill_main.search_provider'
 
     Chill\MainBundle\Search\SearchApi:
-        arguments:
-          $em: '@Doctrine\ORM\EntityManagerInterface'
-          $search: '@Chill\MainBundle\Search\SearchProvider'
+        autowire: true
+        autoconfigure: true

src/Bundle/ChillPersonBundle/Repository/PersonRepository.php

@@ -37,6 +37,11 @@ final class PersonRepository
         return $this->repository->find($id, $lockMode, $lockVersion);
     }
 
+    public function findByIds($ids): array
+    {
+        return $this->repository->findBy(['id' => $ids]);
+    }
+
     /**
      * @param $centers
      * @param $firstResult

src/Bundle/ChillPersonBundle/Search/SearchPersonApiProvider.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Chill\PersonBundle\Search;
+
+use Chill\PersonBundle\Repository\PersonRepository;
+use Chill\MainBundle\Search\SearchApiQuery;
+use Chill\MainBundle\Search\SearchApiInterface;
+
+class SearchPersonApiProvider implements SearchApiInterface
+{
+    private PersonRepository $personRepository;
+
+    public function __construct(PersonRepository $personRepository)
+    {
+        $this->personRepository = $personRepository;
+    }
+    
+    public function provideQuery(string $pattern, array $parameters): SearchApiQuery
+    {
+        $query = new SearchApiQuery();
+        $query
+            ->setSelectKey("person")
+            ->setSelectJsonbMetadata("jsonb_build_object('id', person.id)")
+            ->setSelectPertinence("SIMILARITY(LOWER(UNACCENT(?)), person.fullnamecanonical)", [ $pattern ])
+            ->setFromClause("chill_person_person AS person")
+            ->setWhereClause("SIMILARITY(LOWER(UNACCENT(?)), person.fullnamecanonical) > 0.20", [ $pattern ])
+            ;
+
+        return $query;
+    }
+
+    public function supportsTypes(string $pattern, array $types, array $parameters): bool
+    {
+        return \in_array('person', $types);
+    }
+
+    public function prepare(array $metadatas): void
+    {
+        $ids = \array_map(fn($m) => $m['id'], $metadatas);
+
+        $this->personRepository->findByIds($ids);
+    }
+
+    public function supportsResult(string $key, array $metadatas): bool
+    {
+        return $key === 'person';
+    }
+
+    public function getResult(string $key, array $metadata, float $pertinence)
+    {
+        return $this->personRepository->find($metadata['id']);
+    }
+}

src/Bundle/ChillPersonBundle/config/services/search.yaml

@@ -28,3 +28,7 @@ services:
             $em: '@Doctrine\ORM\EntityManagerInterface'
             $tokenStorage: '@Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface'
             $authorizationHelper: '@Chill\MainBundle\Security\Authorization\AuthorizationHelper'
+
+    Chill\PersonBundle\Search\SearchPersonApiProvider:
+        autowire: true
+        autoconfigure: true

src/Bundle/ChillThirdPartyBundle/Search/ThirdPartyApiSearch.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Chill\ThirdPartyBundle\Search;
+
+use Chill\MainBundle\Search\SearchApiInterface;
+use Chill\MainBundle\Search\SearchApiQuery;
+use Chill\ThirdPartyBundle\Repository\ThirdPartyRepository;
+
+class ThirdPartyApiSearch implements SearchApiInterface
+{
+    private ThirdPartyRepository $thirdPartyRepository;
+
+    public function __construct(ThirdPartyRepository $thirdPartyRepository)
+    {
+        $this->thirdPartyRepository = $thirdPartyRepository;
+    }
+
+    public function provideQuery(string $pattern, array $parameters): SearchApiQuery
+    {
+        return (new SearchApiQuery)
+            ->setSelectKey('tparty')
+            ->setSelectJsonbMetadata("jsonb_build_object('id', tparty.id)")
+            ->setSelectPertinence("SIMILARITY(?, LOWER(UNACCENT(tparty.name)))", [ $pattern ])
+            ->setFromClause('chill_3party.third_party AS tparty')
+            ->setWhereClause('SIMILARITY(LOWER(UNACCENT(?)), LOWER(UNACCENT(tparty.name))) > 0.20', [ $pattern ])
+            ;
+    }
+
+    public function supportsTypes(string $pattern, array $types, array $parameters): bool
+    {
+        return \in_array('thirdparty', $types);
+    }
+
+    public function prepare(array $metadatas): void
+    {
+        
+    }
+
+    public function supportsResult(string $key, array $metadatas): bool
+    {
+        return $key === 'tparty';
+    }
+
+    public function getResult(string $key, array $metadata, float $pertinence)
+    {
+        return $this->thirdPartyRepository->find($metadata['id']);
+    }
+}

src/Bundle/ChillThirdPartyBundle/config/services/search.yaml

@@ -7,3 +7,7 @@ services:
             $paginatorFactory: '@Chill\MainBundle\Pagination\PaginatorFactory'
         tags:
             - { name: 'chill.search', alias: '3party' }
+
+    Chill\ThirdPartyBundle\Search\ThirdPartyApiSearch:
+        autowire: true
+        autoconfigure: true