lib/internal/Magento/Framework/Mview/View/Subscription.php - 2.4-develop - githubmirror/magento2

lib/internal/Magento/Framework/Mview/View/Subscription.php
446 строк13 KB
Sumesh P
AC-14567: MView mechanism silently ignores errors on trigger execution
26 май 2025, 10:12
26 май 2025, 10:1274d5449
<?php
/**
 * Copyright 2014 Adobe
 * All rights reserved.
 */

namespace Magento\Framework\Mview\View;

use Magento\Framework\App\ObjectManager;
use Magento\Framework\App\ResourceConnection;
use Magento\Framework\DB\Adapter\AdapterInterface;
use Magento\Framework\DB\Ddl\Trigger;
use Magento\Framework\DB\Ddl\TriggerFactory;
use Magento\Framework\Exception\ConfigurationMismatchException;
use Magento\Framework\Mview\Config;
use Magento\Framework\Mview\ViewInterface;

/**
 * Mview subscription.
 *
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class Subscription implements SubscriptionInterface, SubscriptionTriggersInterface
{
    /**
     * Database connection
     *
     * @var AdapterInterface
     */
    protected $connection;

    /**
     * @var TriggerFactory
     */
    protected $triggerFactory;

    /**
     * @var CollectionInterface
     */
    protected $viewCollection;

    /**
     * @var string
     */
    protected $view;

    /**
     * @var string
     */
    protected $tableName;

    /**
     * @var string
     */
    protected $columnName;

    /**
     * List of views linked to the same entity as the current view
     *
     * @var array
     */
    protected $linkedViews = [];

    /**
     * List of columns that can be updated in any subscribed table
     * without creating a new change log entry
     *
     * @var array
     */
    private $ignoredUpdateColumns;

    /**
     * List of columns that can be updated in a specific subscribed table
     * for a specific view without creating a new change log entry
     *
     * @var array
     */
    private $ignoredUpdateColumnsBySubscription = [];

    /**
     * @var Resource
     */
    protected $resource;

    /**
     * @var Config
     */
    private $mviewConfig;

    /**
     * @var SubscriptionStatementPostprocessorInterface
     */
    private $statementPostprocessor;

    /**
     * @var Trigger[]
     */
    private $triggers = [];

    /**
     * @param ResourceConnection $resource
     * @param TriggerFactory $triggerFactory
     * @param CollectionInterface $viewCollection
     * @param ViewInterface $view
     * @param string $tableName
     * @param string $columnName
     * @param array $ignoredUpdateColumns
     * @param array $ignoredUpdateColumnsBySubscription
     * @param Config|null $mviewConfig
     * @param SubscriptionStatementPostprocessorInterface|null $statementPostprocessor
     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
     */
    public function __construct(
        ResourceConnection $resource,
        TriggerFactory $triggerFactory,
        CollectionInterface $viewCollection,
        ViewInterface $view,
        $tableName,
        $columnName,
        $ignoredUpdateColumns = [],
        $ignoredUpdateColumnsBySubscription = [],
        ?Config $mviewConfig = null,
        ?SubscriptionStatementPostprocessorInterface $statementPostprocessor = null
    ) {
        $this->connection = $resource->getConnection();
        $this->triggerFactory = $triggerFactory;
        $this->viewCollection = $viewCollection;
        $this->view = $view;
        $this->tableName = $tableName;
        $this->columnName = $columnName;
        $this->resource = $resource;
        $this->ignoredUpdateColumns = $ignoredUpdateColumns;
        $this->ignoredUpdateColumnsBySubscription = $ignoredUpdateColumnsBySubscription;
        $this->mviewConfig = $mviewConfig ?? ObjectManager::getInstance()->get(Config::class);
        $this->statementPostprocessor = $statementPostprocessor
            ?? ObjectManager::getInstance()->get(SubscriptionStatementPostprocessorInterface::class);
    }

    /**
     * Create subscription
     *
     * @param bool $save
     * @return SubscriptionInterface
     */
    public function create(bool $save = true)
    {
        foreach (Trigger::getListOfEvents() as $event) {
            $triggerName = $this->getAfterEventTriggerName($event);
            /** @var Trigger $trigger */
            $trigger = $this->triggerFactory->create()
                ->setName($triggerName)
                ->setTime(Trigger::TIME_AFTER)
                ->setEvent($event)
                ->setTable($this->resource->getTableName($this->tableName));

            $trigger->addStatement($this->buildStatement($event, $this->getView()));

            // Add statements for linked views
            foreach ($this->getLinkedViews() as $view) {
                /** @var ViewInterface $view */
                $trigger->addStatement($this->buildStatement($event, $view));
            }
            $this->triggers[] = $trigger;

            if ($save) {
                $this->saveTrigger($trigger);
            }
        }

        return $this;
    }

    /**
     * Get all triggers for the subscription
     *
     * @return Trigger[]
     */
    public function getTriggers(): array
    {
        return $this->triggers;
    }

    /**
     * Save a trigger to the DB
     *
     * @param Trigger $trigger
     * @return void
     * @throws \Zend_Db_Exception
     */
    public function saveTrigger(Trigger $trigger): void
    {
        $this->connection->dropTrigger($trigger->getName());
        $this->connection->createTrigger($trigger);
    }

    /**
     * Remove subscription
     *
     * @return SubscriptionInterface
     */
    public function remove()
    {
        foreach (Trigger::getListOfEvents() as $event) {
            $triggerName = $this->getAfterEventTriggerName($event);
            /** @var Trigger $trigger */
            $trigger = $this->triggerFactory->create()
                ->setName($triggerName)
                ->setTime(Trigger::TIME_AFTER)
                ->setEvent($event)
                ->setTable($this->resource->getTableName($this->getTableName()));

            // Add statements for linked views
            foreach ($this->getLinkedViews() as $view) {
                /** @var ViewInterface $view */
                $trigger->addStatement($this->buildStatement($event, $view));
            }

            $this->connection->dropTrigger($trigger->getName());

            // Re-create trigger if trigger used by linked views
            if ($trigger->getStatements()) {
                $this->connection->createTrigger($trigger);
            }
        }

        return $this;
    }

    /**
     * Retrieve list of linked views
     *
     * @return array
     */
    protected function getLinkedViews()
    {
        if (!$this->linkedViews) {
            $viewList = $this->viewCollection->getViewsByStateMode(StateInterface::MODE_ENABLED);

            foreach ($viewList as $view) {
                /** @var ViewInterface $view */
                // Skip the current view
                if ($view->getId() == $this->getView()->getId()) {
                    continue;
                }
                // Search in view subscriptions
                foreach ($view->getSubscriptions() as $subscription) {
                    if ($subscription['name'] != $this->getTableName()) {
                        continue;
                    }
                    $this->linkedViews[] = $view;
                }
            }
        }
        return $this->linkedViews;
    }

    /**
     * Prepare columns for trigger statement. Should be protected in order to serve new approach
     *
     * @param ViewInterface $view
     * @param string $event
     * @return array
     * @throws \Exception
     */
    protected function prepareColumns(ViewInterface $view, string $event): array
    {
        $changelog = $view->getChangelog();
        $prefix = $event === Trigger::EVENT_DELETE ? 'OLD.' : 'NEW.';
        $subscriptionData = $this->mviewConfig
            ->getView($changelog->getViewId())['subscriptions'][$this->getTableName()];
        $columns = [
            'column_names' => [
                'entity_id' => $this->connection->quoteIdentifier($changelog->getColumnName())
            ],
            'column_values' => [
                'entity_id' => $this->getEntityColumn($prefix, $view)
            ]
        ];

        if (!empty($subscriptionData['additional_columns'])) {
            $processor = $this->getProcessor();
            $columns = array_replace_recursive(
                $columns,
                $processor->getTriggerColumns($prefix, $subscriptionData['additional_columns'])
            );
        }

        return $columns;
    }

    /**
     * Build trigger statement for INSERT, UPDATE, DELETE events
     *
     * @param string $event
     * @param ViewInterface $view
     * @return string
     */
    protected function buildStatement(string $event, ViewInterface $view): string
    {
        $trigger = "%sINSERT INTO %s (%s) VALUES (%s);";
        $changelog = $view->getChangelog();

        switch ($event) {
            case Trigger::EVENT_UPDATE:
                $tableName = $this->resource->getTableName($this->getTableName());
                if ($this->connection->isTableExists($tableName) &&
                    $describe = $this->connection->describeTable($tableName)
                ) {
                    $columnNames = array_column($describe, 'COLUMN_NAME');
                    $ignoredColumnsBySubscription = array_filter(
                        $this->ignoredUpdateColumnsBySubscription[$changelog->getViewId()][$this->getTableName()] ?? []
                    );
                    $ignoredColumns = array_merge(
                        $this->ignoredUpdateColumns,
                        array_keys($ignoredColumnsBySubscription)
                    );
                    $columnNames = array_diff($columnNames, $ignoredColumns);
                    if ($columnNames) {
                        $columns = [];
                        foreach ($columnNames as $columnName) {
                            $columns[] = sprintf(
                                'NOT(NEW.%1$s <=> OLD.%1$s)',
                                $this->connection->quoteIdentifier($columnName)
                            );
                        }
                        $trigger = sprintf(
                            "IF (%s) THEN %s END IF;",
                            implode(' OR ', $columns),
                            $trigger
                        );
                    }
                }
                break;
        }
        $columns = $this->prepareColumns($view, $event);

        $statement = sprintf(
            $trigger,
            $this->getProcessor()->getPreStatements(),
            $this->connection->quoteIdentifier($this->resource->getTableName($changelog->getName())),
            implode(', ', $columns['column_names']),
            implode(', ', $columns['column_values'])
        );
        $statement = $this->statementPostprocessor->process($this->getTableName(), $event, $statement);

        return $statement;
    }

    /**
     * Instantiate and retrieve additional columns processor
     *
     * @return AdditionalColumnProcessorInterface
     * @throws ConfigurationMismatchException
     */
    private function getProcessor(): AdditionalColumnProcessorInterface
    {
        $subscriptionData = $this->mviewConfig->getView($this->getView()->getId())['subscriptions'];
        $processorClass = $subscriptionData[$this->getTableName()]['processor'];
        $processor = ObjectManager::getInstance()->get($processorClass);

        if (!$processor instanceof AdditionalColumnProcessorInterface) {
            throw new ConfigurationMismatchException(
                'Processor should implement ' . AdditionalColumnProcessorInterface::class
            );
        }

        return $processor;
    }

    /**
     * Get subscription column for a view
     *
     * @param string $prefix
     * @param ViewInterface $view
     * @return string
     */
    public function getEntityColumn(string $prefix, ViewInterface $view): string
    {
        return $prefix . $this->connection->quoteIdentifier($this->getSubscriptionColumn($view));
    }

    /**
     * Returns subscription column name by view
     *
     * @param ViewInterface $view
     * @return string
     */
    private function getSubscriptionColumn(ViewInterface $view): string
    {
        $subscriptions = $view->getSubscriptions();
        if (!isset($subscriptions[$this->getTableName()]['column'])) {
            throw new \RuntimeException(sprintf('Column name for view with id "%s" doesn\'t exist', $view->getId()));
        }

        return $subscriptions[$this->getTableName()]['column'];
    }

    /**
     * Build an "after" event for the given table and event
     *
     * @param string $event The DB level event, like "update" or "insert"
     *
     * @return string
     */
    private function getAfterEventTriggerName($event)
    {
        return $this->resource->getTriggerName(
            $this->resource->getTableName($this->getTableName()),
            Trigger::TIME_AFTER,
            $event
        );
    }

    /**
     * Retrieve View related to subscription
     *
     * @return ViewInterface
     * @codeCoverageIgnore
     */
    public function getView()
    {
        return $this->view;
    }

    /**
     * Retrieve table name
     *
     * @return string
     * @codeCoverageIgnore
     */
    public function getTableName()
    {
        return $this->tableName;
    }

    /**
     * Retrieve table column name
     *
     * @return string
     * @codeCoverageIgnore
     */
    public function getColumnName()
    {
        return $this->columnName;
    }
}