[Pipeline] #1245170 - Prevent empty pipeline

opensearch-project/OpenSearch#15032
Elastic-Suite · Sep 20, 2024 · 0f20b8a · 0f20b8a
1 parent 092cc71
commit 0f20b8a
Show file tree

Hide file tree

Showing 9 changed files with 65 additions and 16 deletions.
diff --git a/composer.json b/composer.json
@@ -13,7 +13,7 @@
     ],
     "require": {
         "php": ">=8.2",
-        "api-platform/core": "^3.2",
+        "api-platform/core": "~3.3.0",
         "cweagans/composer-patches": "^1.7",
         "opensearch-project/opensearch-php": "^2.1",
         "lexik/jwt-authentication-bundle": "^2.14",

diff --git a/src/Doctrine/Filter/SearchFilterWithDefault.php b/src/Doctrine/Filter/SearchFilterWithDefault.php
@@ -25,7 +25,6 @@
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
-// todo upgrade @Pigau ajouter des tests concerant ce filtre ?
 class SearchFilterWithDefault extends GallySearchFilter
 {
     use SearchFilterTrait;

diff --git a/src/Index/Service/IndexSettings.php b/src/Index/Service/IndexSettings.php
@@ -433,9 +433,11 @@ public function getDynamicIndexSettings(Metadata $metadata, LocalizedCatalog|int
         $complexeSourceField = $this->sourceFieldRepository->getComplexeFields($metadata);
         $settings += ['mapping.nested_fields.limit' => \count($complexeSourceField)];
 
-        // Add default pipeline
+        // Add default pipeline if any processor are defined.
         $pipeline = $this->pipelineRepository->createByMetadata($metadata);
-        $settings['default_pipeline'] = $pipeline->getName();
+        if ($pipeline) {
+            $settings['default_pipeline'] = $pipeline->getName();
+        }
 
         return $settings;
     }

diff --git a/src/Index/Tests/Unit/IndexSettingsTest.php b/src/Index/Tests/Unit/IndexSettingsTest.php
@@ -25,7 +25,7 @@ class IndexSettingsTest extends AbstractTestCase
      *
      * @dataProvider dynamicAttributeDataProvider
      */
-    public function testDynamicIndexSettings(string $fieldName, int $expectedNestedFieldsLimit, string $expectedDefaultPipeline)
+    public function testDynamicIndexSettings(string $fieldName, int $expectedNestedFieldsLimit)
     {
         static::loadFixture(
             [
@@ -43,15 +43,14 @@ public function testDynamicIndexSettings(string $fieldName, int $expectedNestedF
         $settings = $indexSettings->getDynamicIndexSettings($metadata, $localizedCatalogs);
 
         $this->assertEquals($expectedNestedFieldsLimit, $settings['mapping.nested_fields.limit']);
-        $this->assertEquals($expectedDefaultPipeline, $settings['default_pipeline']);
     }
 
     protected function dynamicAttributeDataProvider(): array
     {
         return [
-            ['source_field_1.yaml', 0, 'test-gally-llm-pipeline-product'],
-            ['source_field_2.yaml', 2, 'test-gally-llm-pipeline-product'],
-            ['source_field_3.yaml', 4, 'test-gally-llm-pipeline-product'],
+            ['source_field_1.yaml', 0],
+            ['source_field_2.yaml', 2],
+            ['source_field_3.yaml', 4],
         ];
     }
 }
diff --git a/src/Search/Repository/Ingest/PipelineRepository.php b/src/Search/Repository/Ingest/PipelineRepository.php
@@ -63,7 +63,7 @@ public function get(string $name): ?IngestPipeline
     /**
      * @throws \Exception
      */
-    public function createByMetadata(Metadata $metadata): IngestPipeline
+    public function createByMetadata(Metadata $metadata): ?IngestPipeline
     {
         $pipelineName = $this->pipelinePrefix . $metadata->getEntity();
         $processors = [];
@@ -72,6 +72,8 @@ public function createByMetadata(Metadata $metadata): IngestPipeline
             $processors = array_merge($processors, $processorsProvider->getProcessors($metadata));
         }
 
-        return $this->create($pipelineName, $pipelineName, $processors);
+        return empty($processors)
+            ? null
+            : $this->create($pipelineName, $pipelineName, $processors);
     }
 }
diff --git a/src/Search/Repository/Ingest/PipelineRepositoryInterface.php b/src/Search/Repository/Ingest/PipelineRepositoryInterface.php
@@ -37,5 +37,5 @@ public function get(string $name): ?IngestPipeline;
      *
      * @param Metadata $metadata metadata
      */
-    public function createByMetadata(Metadata $metadata): IngestPipeline;
+    public function createByMetadata(Metadata $metadata): ?IngestPipeline;
 }
diff --git a/src/Search/Resources/config/test/services.yaml b/src/Search/Resources/config/test/services.yaml
@@ -3,3 +3,7 @@ services:
         class: Gally\Search\Tests\Service\SearchSettingsProvider
         arguments:
             - '%gally.search_settings%'
+
+    Gally\Search\Tests\Mock\DummyProcessorProvider:
+        tags:
+            - { name: gally.search.ingest_pipeline_processors_provider }
diff --git a/src/Search/Tests/Mock/DummyProcessorProvider.php b/src/Search/Tests/Mock/DummyProcessorProvider.php
@@ -0,0 +1,34 @@
+<?php
+/**
+ * DISCLAIMER.
+ *
+ * Do not edit or add to this file if you wish to upgrade Gally to newer versions in the future.
+ *
+ * @author    Gally Team <[email protected]>
+ * @copyright 2022-present Smile
+ * @license   Open Software License v. 3.0 (OSL-3.0)
+ */
+
+declare(strict_types=1);
+
+namespace Gally\Search\Tests\Mock;
+
+use Gally\Metadata\Entity\Metadata;
+use Gally\Search\Service\IngestPipelineProcessorProvider;
+
+class DummyProcessorProvider implements IngestPipelineProcessorProvider
+{
+    public function getProcessors(Metadata $metadata): array
+    {
+        return 'category' === $metadata->getEntity()
+            ? [
+                [
+                    'set' => [
+                        'field' => 'dummy',
+                        'value' => ['test'],
+                    ],
+                ],
+            ]
+            : [];
+    }
+}
diff --git a/src/Search/Tests/Unit/Repository/IngestPipelineRepositoryTest.php b/src/Search/Tests/Unit/Repository/IngestPipelineRepositoryTest.php
@@ -199,9 +199,15 @@ public function testCreateByMetadata(): void
         $expectedPipeline = new IngestPipeline(
             'test-gally-llm-pipeline-category',
             'test-gally-llm-pipeline-category',
-            []
+            [
+                'set' => [
+                    'field' => 'dummy',
+                    'value' => ['test'],
+                ],
+            ]
         );
         $actualPipeline = $ingestPipelineRepository->createByMetadata($metadataRepository->findByEntity('category'));
+
         $this->assertEquals($expectedPipeline->getName(), $actualPipeline->getName());
         $this->assertEquals($expectedPipeline->getDescription(), $actualPipeline->getDescription());
         $this->assertGreaterThanOrEqual(\count($expectedPipeline->getProcessors()), \count($actualPipeline->getProcessors()));
@@ -212,8 +218,11 @@ public function testCreateByMetadata(): void
             []
         );
         $actualPipeline = $ingestPipelineRepository->createByMetadata($metadataRepository->findByEntity('product_document'));
-        $this->assertEquals($expectedPipeline->getName(), $actualPipeline->getName());
-        $this->assertEquals($expectedPipeline->getDescription(), $actualPipeline->getDescription());
-        $this->assertGreaterThanOrEqual(\count($expectedPipeline->getProcessors()), \count($actualPipeline->getProcessors()));
+        // If pipeline doesn't have any processor it will be not created.
+        if ($actualPipeline) {
+            $this->assertEquals($expectedPipeline->getName(), $actualPipeline->getName());
+            $this->assertEquals($expectedPipeline->getDescription(), $actualPipeline->getDescription());
+            $this->assertGreaterThanOrEqual(\count($expectedPipeline->getProcessors()), \count($actualPipeline->getProcessors()));
+        }
     }
 }