fix(DynamicContentSubscriber): complete Mautic 5 migration of filter evaluation

.github/workflows/tests.yml

@@ -7,7 +7,9 @@ on:
       - '[0-9]+\.[0-9]+'
       - development
       - beta
+      - 'fix/**'
   pull_request:
+  workflow_dispatch:
 
 env:
   PLUGIN_DIR: plugins/CustomObjectsBundle # Same as extra.install-directory-name in composer.json

.gitignore

@@ -1,3 +1,4 @@
 /vendor/*
 /Tests/Coverage/*
-.idea
+.idea
+.superpowers/

Config/config.php

@@ -410,6 +410,7 @@
                     'mautic.campaign.model.event',
                     'event_dispatcher',
                     'custom_object.helper.token_formatter',
+                    'custom_object.helper.filter_evaluator',
                     '%mautic.custom_item_fetch_limit_per_lead%',
                 ],
             ],
@@ -636,6 +637,22 @@
             'custom_object.helper.token_formatter' => [
                 'class'     => MauticPlugin\CustomObjectsBundle\Helper\TokenFormatter::class,
             ],
+            'custom_object.helper.filter_evaluator' => [
+                'class' => MauticPlugin\CustomObjectsBundle\Helper\FilterEvaluator::class,
+            ],
+            'custom_object.helper.contact_filter_matcher' => [
+                'class'     => MauticPlugin\CustomObjectsBundle\Helper\ContactFilterMatcher::class,
+                'arguments' => [
+                    'mautic.custom.model.field',
+                    'mautic.custom.model.object',
+                    'mautic.custom.model.item',
+                    'mautic.lead.repository.company',
+                    'doctrine.dbal.default_connection',
+                    'custom_object.helper.filter_evaluator',
+                    '%mautic.custom_item_fetch_limit_per_lead%',
+                ],
+            ],
+
             'custom_object.data_persister.custom_item' => [
                 'class'     => MauticPlugin\CustomObjectsBundle\DataPersister\CustomItemDataPersister::class,
                 'tag'       => 'api_platform.data_persister',

Config/services.php

@@ -3,6 +3,8 @@
 declare(strict_types=1);
 
 use Mautic\CoreBundle\DependencyInjection\MauticCoreExtension;
+use MauticPlugin\CustomObjectsBundle\Helper\ContactFilterMatcher;
+use MauticPlugin\CustomObjectsBundle\Helper\FilterEvaluator;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
 return function (ContainerConfigurator $configurator): void {
@@ -17,10 +19,17 @@
         'Report/ReportColumnsBuilder.php',
         'Serializer/ApiNormalizer.php',
         'Extension/CustomItemListeningExtension.php',
+        // Registered explicitly in config.php so the int $leadCustomItemFetchLimit arg can be set
+        'Helper/ContactFilterMatcher.php',
+        'Helper/FilterEvaluator.php',
     ];
 
     $services->load('MauticPlugin\\CustomObjectsBundle\\', '../')
         ->exclude('../{'.implode(',', array_merge(MauticCoreExtension::DEFAULT_EXCLUDES, $excludes)).'}');
 
     $services->load('MauticPlugin\\CustomObjectsBundle\\Repository\\', '../Repository/*Repository.php');
+
+    // Aliases so autowiring resolves the config.php-registered services by class name
+    $services->alias(ContactFilterMatcher::class, 'custom_object.helper.contact_filter_matcher')->public();
+    $services->alias(FilterEvaluator::class, 'custom_object.helper.filter_evaluator')->public();
 };

CustomObjectsBundle.php

@@ -4,8 +4,6 @@
 
 namespace MauticPlugin\CustomObjectsBundle;
 
-use Doctrine\DBAL\Schema\Schema;
-use Mautic\CoreBundle\Factory\MauticFactory;
 use Mautic\IntegrationsBundle\Bundle\AbstractPluginBundle;
 use MauticPlugin\CustomObjectsBundle\DependencyInjection\Compiler\CustomFieldTypePass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -19,15 +17,4 @@ public function build(ContainerBuilder $container): void
     {
         $container->addCompilerPass(new CustomFieldTypePass());
     }
-
-    /**
-     * In some rare cases it can happen that the plugin tables weren't created on plugin install.
-     * Create them on plugin update if they are missing.
-     */
-    protected static function installAllTablesIfMissing(Schema $schema, string $tablePrefix, MauticFactory $factory, array $metadata = null): void
-    {
-        if (!$schema->hasTable($tablePrefix.'custom_object')) {
-            self::installPluginSchema($metadata, $factory, null);
-        }
-    }
 }

EventListener/DynamicContentSubscriber.php

@@ -6,32 +6,23 @@
 
 use Mautic\DynamicContentBundle\DynamicContentEvents;
 use Mautic\DynamicContentBundle\Event\ContactFiltersEvaluateEvent;
-use Mautic\EmailBundle\EventListener\MatchFilterForLeadTrait;
-use MauticPlugin\CustomObjectsBundle\Exception\InvalidArgumentException;
 use MauticPlugin\CustomObjectsBundle\Exception\InvalidSegmentFilterException;
-use MauticPlugin\CustomObjectsBundle\Exception\NotFoundException;
-use MauticPlugin\CustomObjectsBundle\Helper\QueryFilterHelper;
+use MauticPlugin\CustomObjectsBundle\Helper\ContactFilterMatcher;
 use MauticPlugin\CustomObjectsBundle\Provider\ConfigProvider;
-use MauticPlugin\CustomObjectsBundle\Repository\DbalQueryTrait;
 use MauticPlugin\CustomObjectsBundle\Segment\Query\Filter\QueryFilterFactory;
-use Psr\Log\LoggerInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 class DynamicContentSubscriber implements EventSubscriberInterface
 {
-    use MatchFilterForLeadTrait;
-    use DbalQueryTrait;
-
     public function __construct(
         private QueryFilterFactory $queryFilterFactory,
-        private QueryFilterHelper $queryFilterHelper,
+        private ContactFilterMatcher $contactFilterMatcher,
         private ConfigProvider $configProvider,
-        private LoggerInterface $logger
     ) {
     }
 
     /**
-     * @return mixed[]
+     * @return array<string,array{string,int}>
      */
     public static function getSubscribedEvents(): array
     {
@@ -40,47 +31,38 @@ public static function getSubscribedEvents(): array
         ];
     }
 
-    /**
-     * @throws InvalidArgumentException
-     * @throws NotFoundException
-     */
     public function evaluateFilters(ContactFiltersEvaluateEvent $event): void
     {
-        if (!$this->configProvider->pluginIsEnabled()) {
+        if ($event->isEvaluated()
+            || !$this->configProvider->pluginIsEnabled()
+            || !$this->hasCustomObjectFilters($event->getFilters())
+        ) {
             return;
         }
 
-        $eventFilters = $event->getFilters();
-
-        if ($event->isEvaluated()) {
-            return;
-        }
-
-        foreach ($eventFilters as $key => $eventFilter) {
-            $queryAlias = "filter_{$key}";
-
-            try {
-                $filterQueryBuilder = $this->queryFilterFactory->configureQueryBuilderFromSegmentFilter($eventFilter, $queryAlias);
-            } catch (InvalidSegmentFilterException $e) {
-                continue;
-            }
-
-            $this->queryFilterHelper->addContactIdRestriction($filterQueryBuilder, $queryAlias, (int) $event->getContact()->getId());
+        $event->setIsEvaluated(true);
+        $event->stopPropagation();
+        $contact = $event->getContact();
+        $event->setIsMatched($this->contactFilterMatcher->match(
+            $event->getFilters(),
+            array_merge(['id' => $contact->getId()], $contact->getProfileFields())
+        ));
+    }
 
+    /**
+     * @param mixed[] $filters
+     */
+    private function hasCustomObjectFilters(array $filters): bool
+    {
+        foreach ($filters as $filter) {
             try {
-                if ($this->executeSelect($filterQueryBuilder)->rowCount()) {
-                    $event->setIsEvaluated(true);
-                    $event->setIsMatched(true);
-                } else {
-                    $event->setIsEvaluated(true);
-                }
-            } catch (\PDOException $e) {
-                $this->logger->error('Failed to evaluate dynamic content for custom object '.$e->getMessage());
+                $this->queryFilterFactory->configureQueryBuilderFromSegmentFilter($filter, 'filter');
 
-                throw $e;
+                return true;
+            } catch (InvalidSegmentFilterException) {
             }
-
-            $event->stopPropagation();  // The filter is ours, we won't allow no more processing
         }
+
+        return false;
     }
 }

EventListener/PluginSchemaSubscriber.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MauticPlugin\CustomObjectsBundle\EventListener;
+
+use Mautic\PluginBundle\Event\PluginInstallEvent;
+use Mautic\PluginBundle\Event\PluginUpdateEvent;
+use Mautic\PluginBundle\PluginEvents;
+use MauticPlugin\CustomObjectsBundle\Helper\PluginSchemaInstaller;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * Keeps the plugin's tables in place via the supported event API.
+ *
+ * Mautic still calls PluginBundleBase::onPluginInstall(), but it is marked
+ * "@deprecated To be removed in 5.0. Listen to PluginEvents::ON_PLUGIN_INSTALL instead",
+ * so schema creation cannot keep relying on it. AbstractPluginBundle additionally
+ * overrides onPluginUpdate() to run the migration engine, which means the old
+ * create-missing-tables safety net no longer runs at all.
+ */
+class PluginSchemaSubscriber implements EventSubscriberInterface
+{
+    private const PLUGIN_NAME = 'Custom Objects';
+
+    public function __construct(private PluginSchemaInstaller $schemaInstaller)
+    {
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            PluginEvents::ON_PLUGIN_INSTALL => 'onPluginInstall',
+            PluginEvents::ON_PLUGIN_UPDATE  => 'onPluginUpdate',
+        ];
+    }
+
+    public function onPluginInstall(PluginInstallEvent $event): void
+    {
+        if (!$event->checkContext(self::PLUGIN_NAME)) {
+            return;
+        }
+
+        $this->schemaInstaller->ensureTablesExist();
+    }
+
+    /**
+     * In some rare cases the plugin tables are not created on install. Create the
+     * missing ones on update so the plugin can recover without a reinstall.
+     */
+    public function onPluginUpdate(PluginUpdateEvent $event): void
+    {
+        if (!$event->checkContext(self::PLUGIN_NAME)) {
+            return;
+        }
+
+        $this->schemaInstaller->ensureTablesExist();
+    }
+}