src/Elasticsearch/Product/CustomFieldUpdater.php line 37

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Elasticsearch\Product;
  5. use OpenSearch\Client;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenContainerEvent;
  7. use Shopware\Core\Framework\Log\Package;
  8. use Shopware\Core\System\CustomField\CustomFieldDefinition;
  9. use Shopware\Core\System\CustomField\CustomFieldTypes;
  10. use Shopware\Elasticsearch\Framework\ElasticsearchHelper;
  11. use Shopware\Elasticsearch\Framework\ElasticsearchOutdatedIndexDetector;
  12. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  14. /**
  15.  * @internal
  16.  */
  17. #[Package('core')]
  18. class CustomFieldUpdater implements EventSubscriberInterface
  19. {
  20.     /**
  21.      * @internal
  22.      */
  23.     public function __construct(
  24.         private readonly ElasticsearchOutdatedIndexDetector $indexDetector,
  25.         private readonly Client $client,
  26.         private readonly ElasticsearchHelper $elasticsearchHelper
  27.     ) {
  28.     }
  30.     public static function getSubscribedEvents(): array
  31.     {
  32.         return [
  33.             EntityWrittenContainerEvent::class => 'onNewCustomFieldCreated',
  34.         ];
  35.     }
  37.     public function onNewCustomFieldCreated(EntityWrittenContainerEvent $containerEvent): void
  38.     {
  39.         $event = $containerEvent->getEventByEntityName(CustomFieldDefinition::ENTITY_NAME);
  41.         if ($event === null) {
  42.             return;
  43.         }
  45.         if (!$this->elasticsearchHelper->allowIndexing()) {
  46.             return;
  47.         }
  49.         $newCreatedFields = [];
  51.         foreach ($event->getWriteResults() as $writeResult) {
  52.             $existence = $writeResult->getExistence();
  54.             if ($existence && $existence->exists()) {
  55.                 continue;
  56.             }
  58.             /** @var array<mixed> $esType */
  59.             $esType = self::getTypeFromCustomFieldType($writeResult->getProperty('type'));
  61.             $newCreatedFields[(string) $writeResult->getProperty('name')] = $esType;
  62.         }
  64.         if (\count($newCreatedFields) === 0) {
  65.             return;
  66.         }
  68.         $this->createNewFieldsInIndices($newCreatedFields);
  69.     }
  71.     /**
  72.      * @return array<mixed>
  73.      */
  74.     public static function getTypeFromCustomFieldType(string $type): array
  75.     {
  76.         return match ($type) {
  77.             CustomFieldTypes::INT => [
  78.                 'type' => 'long',
  79.             ],
  80.             CustomFieldTypes::FLOAT => [
  81.                 'type' => 'double',
  82.             ],
  83.             CustomFieldTypes::BOOL => [
  84.                 'type' => 'boolean',
  85.             ],
  86.             CustomFieldTypes::DATETIME => [
  87.                 'type' => 'date',
  88.                 'format' => 'yyyy-MM-dd HH:mm:ss.000',
  89.                 'ignore_malformed' => true,
  90.             ],
  91.             CustomFieldTypes::PRICE, CustomFieldTypes::JSON => [
  92.                 'type' => 'object',
  93.                 'dynamic' => true,
  94.             ],
  95.             CustomFieldTypes::HTML, CustomFieldTypes::TEXT => [
  96.                 'type' => 'text',
  97.             ],
  98.             default => [
  99.                 'type' => 'keyword',
  100.             ],
  101.         };
  102.     }
  104.     /**
  105.      * @param array<string, array<mixed>> $newCreatedFields
  106.      */
  107.     private function createNewFieldsInIndices(array $newCreatedFields): void
  108.     {
  109.         $indices = $this->indexDetector->getAllUsedIndices();
  111.         foreach ($indices as $indexName) {
  112.             $body = [
  113.                 'properties' => [
  114.                     'customFields' => [
  115.                         'properties' => $newCreatedFields,
  116.                     ],
  117.                 ],
  118.             ];
  120.             // For some reason, we need to include the includes to prevent merge conflicts.
  121.             // This error can happen for example after updating from version <6.4.
  122.             $current = $this->client->indices()->get(['index' => $indexName]);
  123.             $includes = $current[$indexName]['mappings']['_source']['includes'] ?? [];
  124.             if ($includes !== []) {
  125.                 $body['_source'] = [
  126.                     'includes' => $includes,
  127.                 ];
  128.             }
  130.             $this->client->indices()->putMapping([
  131.                 'index' => $indexName,
  132.                 'body' => $body,
  133.             ]);
  134.         }
  135.     }
  136. }