fix(DynamicContentSubscriber): Mautic 5 migration CI test

.github/workflows/tests.yml

@@ -0,0 +1,150 @@
+name: Mautic Build and Test
+
+on:
+  push:
+    branches:
+      - staging # Main branch
+      - '[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
+
+jobs:
+  phpunit:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php-versions: ['8.0'] # The supported PHP versions
+        db-types: ['mysql'] # can be: ['mysql', 'mariadb'] but not necessary for this plugin that does not add any DB schema
+        mautic-versions: ['5.1'] # The supported Mautic versions
+
+    name: Tests on PHP ${{ matrix.php-versions }}, ${{ matrix.db-types }}, Mautic ${{ matrix.mautic-versions }}
+
+    services:
+      database:
+        image: ${{ matrix.db-types == 'mysql' && 'mysql:8.0' || 'mariadb:10.3' }}
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+          MYSQL_DATABASE: mautictest
+        ports:
+          - 3306
+        options: >-
+          --shm-size=2gb
+          --name=${{ matrix.db-types }}
+          --tmpfs=/var/lib/mysql
+          --health-cmd="mysqladmin ping"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=3
+
+    steps:
+    - name: Checkout Mautic
+      uses: actions/checkout@v4
+      with:
+        repository: mautic/mautic
+        ref: ${{ matrix.mautic-versions }}
+
+    - name: Checkout this plugin
+      uses: actions/checkout@v4
+      with:
+        path: ${{ env.PLUGIN_DIR }}
+
+    - name: Setup PHP, with composer and extensions
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-versions }}
+        ini-values: -dpcov.enabled=0, pcov.directory=."
+        extensions: mbstring, xml, ctype, iconv, intl, pdo_sqlite, mysql, pdo_mysql
+        coverage: pcov
+
+    - name: add MySQL config file
+      run: |
+        mysqldump --version
+        mysqldump --print-defaults
+        cp .github/ci-files/.my.cnf ~/.my.cnf
+        mysqldump --print-defaults
+
+    - name: Set SYMFONY_ENV to test
+      run: |
+        echo "SYMFONY_ENV=test" >> $GITHUB_ENV
+        echo "MAUTIC_ENV=test" >> $GITHUB_ENV
+
+    - name: Install Composer dependencies
+      run: |
+        composer install
+
+    # - name: Get composer cache directory
+    #   id: composer-cache
+    #   run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+    # - name: Cache composer dependencies
+    #   uses: actions/cache@v4
+    #   with:
+    #     path: ${{ steps.composer-cache.outputs.dir }}
+    #     key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+    #     restore-keys: ${{ runner.os }}-composer-
+
+    - name: Install Mautic
+      env:
+        DB_PORT: ${{ job.services.database.ports[3306] }}
+      run: |
+        cp ./.github/ci-files/local.php ./app/config/local.php
+        php bin/console mautic:install --force http://localhost
+
+    - name: Install Plugins
+      env:
+        DB_PORT: ${{ job.services.database.ports[3306] }}
+      run: php bin/console mautic:plugins:install --env=dev
+
+    # - name: Run static analysis
+    #   env:
+    #     COMPOSER_ALLOW_SUPERUSER: 1
+    #   run: composer phpstan -- --no-progress
+
+    - name: Run Code Style check
+      run: bin/php-cs-fixer fix ${{ env.PLUGIN_DIR }} --config=.php-cs-fixer.php -v --dry-run --show-progress=dots --diff
+
+    # - name: PHPSTAN - baseline (debug, enable if you need to regenerate baseline for all PHP versions)
+    #   run: bin/phpstan --configuration=${{ env.PLUGIN_DIR }}/phpstan.neon --generate-baseline=var/logs/phpstan-baseline-${{ matrix.php-versions }}.neon --allow-empty-baseline
+
+    - name: PHPSTAN
+      run: bin/phpstan --configuration=${{ env.PLUGIN_DIR }}/phpstan.neon
+
+    - name: Rector
+      run: composer rector -- --dry-run --no-progress-bar ${{ env.PLUGIN_DIR }}
+
+    - name: Twig Lint
+      run: bin/console lint:twig ${{ env.PLUGIN_DIR }}
+
+    - name: Create writable directory
+      run: mkdir -p ./media/files/temp && chmod -R 777 ./media/files/temp
+
+    - name: Run PHPUNIT tests
+      env:
+        DB_PORT: ${{ job.services.database.ports[3306] }}
+      # run: XDEBUG_MODE=coverage APP_DEBUG=0 php -dpcov.enabled=1 -dpcov.directory=. -dpcov.exclude="~tests|themes|vendor~" bin/phpunit -d memory_limit=1G --bootstrap vendor/autoload.php --configuration ${{ env.PLUGIN_DIR }}/phpunit.xml --coverage-clover=${{ env.PLUGIN_DIR }}/coverage.xml --coverage-text
+      run: XDEBUG_MODE=coverage APP_DEBUG=0 php -dpcov.enabled=1 -dpcov.directory=. bin/phpunit -d memory_limit=1G --bootstrap vendor/autoload.php --configuration ${{ env.PLUGIN_DIR }}/phpunit.xml --filter=CustomObjectsBundle --coverage-clover=${{ env.PLUGIN_DIR }}/coverage.xml --coverage-text
+
+    # - name: Coverage report (debug)
+    #   run: cat ${{ env.PLUGIN_DIR }}/coverage.xml
+
+    #  - name: Upload coverage report
+    #     if: ${{ matrix.php-versions == '8.0' && matrix.db-types == 'mysql' && matrix.mautic-versions == '4.4' }} # upload just once, change for your matrix
+    #     uses: codecov/codecov-action@v3
+    #     with:
+    #     token: ${{ secrets.CODECOV_TOKEN }}
+    #     fail_ci_if_error: true
+    #     working-directory: ${{ env.PLUGIN_DIR }}
+    #     verbose: true
+
+    - name: Upload logs as artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: mautic-logs
+        path: var/logs/

Assets/js/custom-objects.js

@@ -44,8 +44,9 @@ CustomObjects = {
             'id': valueField.attr('id'),
             'name': valueField.attr('name'),
             'autocomplete': valueField.attr('autocomplete'),
-            'value': valueField.attr('value')
+            'value': valueField.val()
         };
+        const fieldType = selectedField.attr('data-field-type');
 
         operatorSelect.empty();
 
@@ -67,17 +68,40 @@ CustomObjects = {
                 newValueField.append(
                     mQuery("<option></option>")
                         .attr('value', optionValue)
-                        .attr('selected', valueField.attr('value') == optionValue)
+                        .attr('selected', valueField.val() === optionValue)
                         .text(options[optionValue])
                 );
-            };
+            }
+        }
+
+        if (fieldType === 'date') {
+            newValueField.datetimepicker({
+                timepicker: false,
+                format: 'Y-m-d',
+                lazyInit: true,
+                validateOnBlur: false,
+                allowBlank: true,
+                scrollMonth: false,
+                scrollInput: false,
+                closeOnDateSelect: true
+            });
+        } else if (fieldType === 'datetime') {
+            newValueField.datetimepicker({
+                format: 'Y-m-d H:i',
+                lazyInit: true,
+                validateOnBlur: false,
+                allowBlank: true,
+                scrollMonth: false,
+                scrollInput: false
+            });
         }
 
         if (isEmptyOperator) {
-            newValueField.attr('readonly', true);
+            newValueField.val(null);
             newValueField.attr('value', '');
+            newValueField.attr('disabled', 'disabled');
         } else {
-            newValueField.attr('value', valueFieldAttrs['value']);
+            newValueField.val(valueField.val());
         }
 
         newValueField.attr(valueFieldAttrs);

Command/CustomItemsScheduledExportCommand.php

@@ -4,8 +4,7 @@
 
 namespace MauticPlugin\CustomObjectsBundle\Command;
 
-use Mautic\CoreBundle\Helper\ExitCode;
-use Mautic\CoreBundle\Templating\Helper\FormatterHelper;
+use Mautic\CoreBundle\Twig\Helper\FormatterHelper;
 use MauticPlugin\CustomObjectsBundle\CustomItemEvents;
 use MauticPlugin\CustomObjectsBundle\Event\CustomItemExportSchedulerEvent;
 use MauticPlugin\CustomObjectsBundle\Model\CustomItemExportSchedulerModel;
@@ -19,19 +18,11 @@ class CustomItemsScheduledExportCommand extends Command
 {
     public const COMMAND_NAME = 'mautic:custom_items:scheduled_export';
 
-    private CustomItemExportSchedulerModel $customItemExportSchedulerModel;
-    private EventDispatcherInterface $eventDispatcher;
-    private FormatterHelper $formatterHelper;
-
     public function __construct(
-        CustomItemExportSchedulerModel $customItemExportSchedulerModel,
-        EventDispatcherInterface $eventDispatcher,
-        FormatterHelper $formatterHelper
+        private CustomItemExportSchedulerModel $customItemExportSchedulerModel,
+        private EventDispatcherInterface $eventDispatcher,
+        private FormatterHelper $formatterHelper
     ) {
-        $this->customItemExportSchedulerModel = $customItemExportSchedulerModel;
-        $this->eventDispatcher                = $eventDispatcher;
-        $this->formatterHelper                = $formatterHelper;
-
         parent::__construct();
     }
 
@@ -58,14 +49,14 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         foreach ($customItemExportSchedulers as $customItemExportScheduler) {
             $customItemExportSchedulerEvent = new CustomItemExportSchedulerEvent($customItemExportScheduler);
-            $this->eventDispatcher->dispatch(CustomItemEvents::CUSTOM_ITEM_PREPARE_EXPORT_FILE, $customItemExportSchedulerEvent);
-            $this->eventDispatcher->dispatch(CustomItemEvents::CUSTOM_ITEM_MAIL_EXPORT_FILE, $customItemExportSchedulerEvent);
-            $this->eventDispatcher->dispatch(CustomItemEvents::POST_EXPORT_MAIL_SENT, $customItemExportSchedulerEvent);
+            $this->eventDispatcher->dispatch($customItemExportSchedulerEvent, CustomItemEvents::CUSTOM_ITEM_PREPARE_EXPORT_FILE);
+            $this->eventDispatcher->dispatch($customItemExportSchedulerEvent, CustomItemEvents::CUSTOM_ITEM_MAIL_EXPORT_FILE);
+            $this->eventDispatcher->dispatch($customItemExportSchedulerEvent, CustomItemEvents::POST_EXPORT_MAIL_SENT);
             ++$count;
         }
 
         $output->writeln('CustomItem export email(s) sent: '.$count);
 
-        return ExitCode::SUCCESS;
+        return Command::SUCCESS;
     }
 }

Command/GenerateSampleDataCommand.php

@@ -5,43 +5,28 @@
 namespace MauticPlugin\CustomObjectsBundle\Command;
 
 use Doctrine\DBAL\Connection;
-use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Exception;
 use Doctrine\ORM\EntityManager;
 use MauticPlugin\CustomObjectsBundle\Helper\RandomHelper;
-use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
+use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 use Symfony\Component\Console\Style\SymfonyStyle;
 
-class GenerateSampleDataCommand extends ContainerAwareCommand
+class GenerateSampleDataCommand extends Command
 {
-    /**
-     * @var EntityManager
-     */
-    private $entityManager;
-
-    /**
-     * @var RandomHelper
-     */
-    private $randomHelper;
-
-    /**
-     * @var Connection
-     */
-    private $connection;
+    private Connection $connection;
 
     public function __construct(
-        EntityManager $entityManager,
-        RandomHelper $randomHelper
+        private EntityManager $entityManager,
+        private RandomHelper $randomHelper
     ) {
         parent::__construct();
 
-        $this->entityManager     = $entityManager;
-        $this->randomHelper      = $randomHelper;
-        $this->connection        = $entityManager->getConnection();
+        $this->connection = $entityManager->getConnection();
     }
 
     /**
@@ -111,8 +96,6 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
     /**
      * @return int[]
-     *
-     * @throws DBALException
      */
     private function createCustomObjectsWithItems(): array
     {
@@ -150,13 +133,16 @@ private function createCustomObjectsWithItems(): array
         return [$coProductId, $cfPriceId, $coOrderId];
     }
 
+    /**
+     * @throws Exception
+     */
     private function cleanupDB(): void
     {
         $query = 'delete from '.MAUTIC_TABLE_PREFIX.'leads where 1';
-        $this->connection->query($query);
+        $this->connection->executeQuery($query);
 
         $query = 'delete from '.MAUTIC_TABLE_PREFIX.'custom_object where 1';
-        $this->connection->query($query);
+        $this->connection->executeQuery($query);
     }
 
     private function generateContact(int $coProductId, int $cfPriceId, int $coOrderId, int $priceLimit): void
@@ -220,9 +206,11 @@ private function generateProductRelations(int $contactId, int $coProductId, int
     }
 
     /**
+     * @param array<int|string, mixed> $row
+     *
      * @return int Last inserted row ID
      *
-     * @throws DBALException
+     * @throws Exception
      */
     private function insertInto(string $table, array $row): int
     {
@@ -235,13 +223,10 @@ function ($value) {
                     switch (gettype($value)) {
                         case 'string':
                             return "'$value'";
-                            break;
                         case 'integer':
                             return (string) $value;
-                            break;
                         case 'boolean':
                             return (bool) $value;
-                            break;
                         default:
                             $type = gettype($value);
                             throw new \InvalidArgumentException("Unsupported type '$type' for insert query");
@@ -256,7 +241,7 @@ function ($value) {
             VALUES ($values)
         ";
 
-        $this->connection->query($query);
+        $this->connection->executeQuery($query);
 
         return (int) $this->connection->lastInsertId();
     }