III-6275 Make Labels findable by using Levenshtein distance

features/label/get.feature

@@ -24,9 +24,9 @@ Feature: Test the UDB3 labels API
     And the response body should be valid JSON
     And the JSON response at "totalItems" should be 4
     And the JSON response at "member/0/name" should be "special_label"
-    And the JSON response at "member/1/name" should be "special_label*"
-    And the JSON response at "member/2/name" should be "special_label#"
-    And the JSON response at "member/3/name" should be "special-label"
+    And the JSON response at "member/1/name" should be "special-label"
+    And the JSON response at "member/2/name" should be "special_label*"
+    And the JSON response at "member/3/name" should be "special_label#"
 
   Scenario: Hide excluded labels if suggestion is true
     When I create a label with a random name of 10 characters

src/Http/Label/SearchLabelsRequestHandler.php

@@ -31,7 +31,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface
 
         $totalEntities = $this->labelRepository->searchTotalLabels($query);
 
-        $entities = $totalEntities > 0 ? $this->labelRepository->search($query) : [];
+        $entities = $totalEntities > 0 ? $this->labelRepository->searchByLevenshtein($query) : [];
 
         return new PagedCollectionResponse(
             $query->getLimit() ?? 0,

src/Label/ReadModels/JSON/Repository/AppConfigReadRepositoryDecorator.php

@@ -56,6 +56,11 @@ public function search(Query $query): array
         return $this->repository->search($query);
     }
 
+    public function searchByLevenshtein(Query $query): array
+    {
+        return $this->repository->searchByLevenshtein($query);
+    }
+
     public function searchTotalLabels(Query $query): int
     {
         return $this->repository->searchTotalLabels($query);

src/Label/ReadModels/JSON/Repository/Doctrine/DBALReadRepository.php

@@ -118,6 +118,24 @@ public function search(Query $query): array
         return $this->getResults($queryBuilder);
     }
 
+    /**
+     * @return Entity[]
+     */
+    public function searchByLevenshtein(Query $query): array
+    {
+        $entities = $this->search($query);
+
+        $reference = $query->getValue();
+        usort($entities, function ($entityA, $entityB) use ($reference) {
+            $distanceA = levenshtein($reference, $entityA->getName());
+            $distanceB = levenshtein($reference, $entityB->getName());
+
+            return $distanceA - $distanceB;
+        });
+
+        return $entities;
+    }
+
     public function searchTotalLabels(Query $query): int
     {
         $queryBuilder = $this->createSearchQuery($query);

src/Label/ReadModels/JSON/Repository/GodUserReadRepositoryDecorator.php

@@ -46,6 +46,11 @@ public function search(Query $query): array
         return $this->repository->search($query);
     }
 
+    public function searchByLevenshtein(Query $query): array
+    {
+        return $this->repository->searchByLevenshtein($query);
+    }
+
     public function searchTotalLabels(Query $query): int
     {
         return $this->repository->searchTotalLabels($query);

src/Label/ReadModels/JSON/Repository/ReadRepositoryInterface.php

@@ -16,5 +16,7 @@ public function canUseLabel(string $userId, string $name): bool;
 
     public function search(Query $query): array;
 
+    public function searchByLevenshtein(Query $query): array;
+
     public function searchTotalLabels(Query $query): int;
 }

tests/Http/Label/SearchLabelsRequestHandlerTest.php

@@ -69,7 +69,7 @@ public function it_can_search_labels(): void
             ->willReturn(count($this->labels));
 
         $this->labelRepository->expects($this->once())
-            ->method('search')
+            ->method('searchByLevenshtein')
             ->with(new Query('label', '123', 5, 2))
             ->willReturn($this->labels);
 

tests/Label/ReadModels/JSON/Repository/Doctrine/DBALReadRepositoryTest.php

@@ -324,6 +324,52 @@ public function it_filters_excluded_labels_if_suggestions_is_true(): void
         $this->assertEquals([], $entities);
     }
 
+    /**
+     * @test
+     */
+    public function it_gets_labels_alphabetically_by_default(): void
+    {
+        $search = new Query(
+            'wandel',
+            null,
+            null,
+            null,
+            true
+        );
+        $entities = $this->dbalReadRepository->search($search);
+        $this->assertEquals(
+            [
+                $this->entityByName,
+                $this->entityPrivateNoAccess,
+                $this->entityPrivateAccess,
+            ],
+            $entities
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function it_can_get_labels_levenshtein_distance(): void
+    {
+        $search = new Query(
+            'wandel',
+            null,
+            null,
+            null,
+            true
+        );
+        $entities = $this->dbalReadRepository->searchByLevenshtein($search);
+        $this->assertEquals(
+            [
+                $this->entityPrivateAccess,
+                $this->entityByName,
+                $this->entityPrivateNoAccess,
+            ],
+            $entities
+        );
+    }
+
     /**
      * @test
      */