Release/3.16.0

.circleci/algolia-phpunit-code-coverage.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         colors="true"
+         columns="max"
+         beStrictAboutTestsThatDoNotTestAnything="false"
+         bootstrap="/var/www/html/dev/tests/unit/framework/bootstrap.php">
+    <coverage>
+        <include>
+            <directory suffix=".php">/var/www/html/vendor/algolia/algoliasearch-magento-2</directory>
+        </include>
+        <exclude>
+            <directory>/var/www/html/vendor/algolia/algoliasearch-magento-2/Test</directory>
+        </exclude>
+    </coverage>
+    <testsuites>
+        <testsuite name="Algolia_Unit_Tests">
+            <directory>/var/www/html/vendor/algolia/algoliasearch-magento-2/Test/Unit</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <includePath>.</includePath>
+        <ini name="memory_limit" value="-1"/>
+        <ini name="date.timezone" value="America/Los_Angeles"/>
+        <ini name="xdebug.max_nesting_level" value="200"/>
+    </php>
+    <listeners>
+        <listener class="Magento\Framework\TestFramework\Unit\Listener\ReplaceObjectManager"/>
+    </listeners>
+</phpunit>

.circleci/config.yml

@@ -2,17 +2,17 @@ version: 2.1
 
 orbs:
   php: circleci/[email protected]
+  slack: circleci/[email protected]
 
 executors:
   magento-executor:
     machine:
       image: ubuntu-2404:2024.11.1
       docker_layer_caching: true
 
-jobs:
-  magento-build:
-    executor:
-      name: magento-executor
+commands:
+  setup-magento-environment:
+    description: "Setup Magento environment with common configuration"
     parameters:
       php-version:
         type: string
@@ -32,13 +32,13 @@ jobs:
           name: Setup folder structure and override file
           command: |
             mkdir ~/Sites
-            mkdir ~/Sites/unit-tests
-            mkdir ~/Sites/unit-coverage
             cd ~/Sites
             cat \<<EOF > compose.override.yml
             services:
               phpfpm:
                 image: markoshust/magento-php:<< parameters.php-version >>-fpm
+              db:
+                image: mariadb:10.11
             EOF
       - run:
           name: Setup magento enterprise
@@ -64,24 +64,113 @@ jobs:
           command: |
             bin/magento setup:di:compile
             bin/magento module:status Algolia_AlgoliaSearch
+
+jobs:
+  magento-build:
+    executor:
+      name: magento-executor
+    parameters:
+      php-version:
+        type: string
+      magento-version:
+        type: string
+    steps:
+      - setup-magento-environment:
+          php-version: << parameters.php-version >>
+          magento-version: << parameters.magento-version >>
+      - run:
+          name: Create test directories
+          command: |
+            mkdir ~/Sites/unit-tests
+            mkdir ~/Sites/unit-coverage
+      - persist_to_workspace:
+          root: ~/Sites
+          paths:
+            - .
       - run:
           name: Run Unit Tests and copy results to CircleCI
           working_directory: ~/Sites
           command: |
-            bin/cli vendor/bin/phpunit --log-junit /var/www/html/dev/tests/unit/report/junit.xml /var/www/html/vendor/algolia/algoliasearch-magento-2/Test/Unit
+            bin/cli sed -i '/<extensions>/,/<\/extensions>/d' /var/www/html/dev/tests/unit/phpunit.xml.dist
+            bin/cli vendor/bin/phpunit -c /var/www/html/dev/tests/unit/phpunit.xml.dist --log-junit /var/www/html/dev/tests/unit/report/junit.xml /var/www/html/vendor/algolia/algoliasearch-magento-2/Test/Unit
             docker cp $(docker compose ps -q phpfpm):/var/www/html/dev/tests/unit/report/junit.xml ./unit-tests/
       - store_test_results:
           path: ~/Sites/unit-tests
+      - run:
+          name: Create Algolia-specific PHPUnit config for code coverage
+          working_directory: ~/Sites
+          command: |
+            cp ~/project/.circleci/algolia-phpunit-code-coverage.xml algolia-phpunit.xml
+            docker cp algolia-phpunit.xml $(docker compose ps -q phpfpm):/var/www/html/algolia-phpunit.xml
       - run:
           name: Run Unit Test Coverage and copy results to CircleCI
           working_directory: ~/Sites
           command: |
-            bin/cli php -d xdebug.mode=coverage vendor/bin/phpunit --log-junit /var/www/html/dev/tests/unit/report/junit.xml --coverage-html /var/www/html/dev/tests/unit/report --coverage-filter /var/www/html/vendor/algolia/algoliasearch-magento-2/ /var/www/html/vendor/algolia/algoliasearch-magento-2/Test/Unit
+            bin/cli php -d xdebug.mode=coverage vendor/bin/phpunit -c /var/www/html/algolia-phpunit.xml --log-junit /var/www/html/dev/tests/unit/report/junit.xml --coverage-html /var/www/html/dev/tests/unit/report --coverage-text
             docker cp $(docker compose ps -q phpfpm):/var/www/html/dev/tests/unit/report ./unit-coverage/
       - store_artifacts:
           path: ~/Sites/unit-coverage/report
           destination: test-results/magento-<< parameters.magento-version >>-php-<< parameters.php-version >>
 
+  magento-integration-test:
+    executor:
+      name: magento-executor
+    parameters:
+      php-version:
+        type: string
+      magento-version:
+        type: string
+    steps:
+      - setup-magento-environment:
+          php-version: << parameters.php-version >>
+          magento-version: << parameters.magento-version >>
+      - run:
+          name: Configure integration tests
+          working_directory: ~/Sites
+          command: |
+            bin/cli cp dev/tests/integration/phpunit.xml.dist dev/tests/integration/phpunit.xml
+      - run:
+          name: Create integration test environment file
+          working_directory: ~/Sites
+          command: |
+            echo "[email protected]" > .env
+            echo "MAGENTO_ADMIN_FIRST_NAME=john" >> .env
+            echo "MAGENTO_ADMIN_LAST_NAME=smith" >> .env
+            echo "MAGENTO_ADMIN_USER=john.smith" >> .env
+            echo "MAGENTO_ADMIN_PASSWORD=password123" >> .env
+            echo "MAGENTO_ADMIN_FRONTNAME=admin" >> .env
+            echo "MAGENTO_LOCALE=en_US" >> .env
+            echo "MAGENTO_CURRENCY=USD" >> .env
+            echo "MAGENTO_TIMEZONE=America/New_York" >> .env
+            echo "ALGOLIA_APPLICATION_ID=$ALGOLIA_APPLICATION_ID" >> .env
+            echo "ALGOLIA_SEARCH_KEY=$ALGOLIA_SEARCH_API_KEY" >> .env
+            echo "ALGOLIA_API_KEY=$ALGOLIA_API_KEY" >> .env
+            echo "INDEX_PREFIX=integration_test_" >> .env
+            docker cp .env $(docker compose ps -q phpfpm):/var/www/html/dev/tests/integration/.env
+      - run:
+          name: Prepare integration test environment
+          working_directory: ~/Sites
+          command: |
+            docker cp ../project/.circleci/install-config-mysql.php $(docker compose ps -q phpfpm):/var/www/html/dev/tests/integration/etc/install-config-mysql.php
+            bin/magento module:enable --all
+            bin/setup-integration-tests
+      - run:
+          name: Run Integration Tests
+          working_directory: ~/Sites
+          command: |
+            bin/cli bash -c "cd ./dev/tests/integration && export $(cat .env | xargs) && ../../../vendor/bin/phpunit --debug --exclude-group problematic ../../../vendor/algolia/algoliasearch-magento-2/Test/Integration/"
+
+  notify:
+    docker:
+      - image: cimg/base:current
+    steps:
+      - slack/notify:
+          event: fail
+          template: basic_fail_1
+      - slack/notify:
+          event: pass
+          template: success_tagged_deploy_1
+
 workflows:
   magento-build-and-test-workflow:
     jobs:
@@ -90,3 +179,20 @@ workflows:
             parameters:
               php-version: ["8.2"]
               magento-version: ["2.4.6-p11", "2.4.7-p6"]
+      - notify:
+          context: mage-slack
+#  magento-integration-test-workflow:
+#    when:
+#      or:
+#        - equal: [ main, << pipeline.git.branch >> ]
+#        - matches:
+#            pattern: ".*release.*"
+#            value: << pipeline.git.branch >>
+#    jobs:
+#      - magento-integration-test:
+#          matrix:
+#            parameters:
+#              php-version: ["8.2"]
+#              magento-version: ["2.4.7-p6"]
+#      - notify:
+#          context: mage-slack

.circleci/install-config-mysql.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+return [
+    'db-host' => 'db',
+    'db-user' => 'magento',
+    'db-password' => 'magento',
+    'db-name' => 'magento_integration_tests',
+    'db-prefix' => '',
+    'backend-frontname' => 'backend',
+    'search-engine' => 'opensearch',
+    'opensearch-host' => 'opensearch',
+    'admin-user' => \Magento\TestFramework\Bootstrap::ADMIN_NAME,
+    'admin-password' => \Magento\TestFramework\Bootstrap::ADMIN_PASSWORD,
+    'admin-email' => \Magento\TestFramework\Bootstrap::ADMIN_EMAIL,
+    'admin-firstname' => \Magento\TestFramework\Bootstrap::ADMIN_FIRSTNAME,
+    'admin-lastname' => \Magento\TestFramework\Bootstrap::ADMIN_LASTNAME,
+    'amqp-host' => 'rabbitmq',
+    'amqp-port' => '5672',
+    'amqp-user' => 'magento',
+    'amqp-password' => 'magento',
+    'consumers-wait-for-messages' => '0',
+    'session-save' => 'redis',
+    'session-save-redis-host' => 'redis',
+    'session-save-redis-port' => 6379,
+    'session-save-redis-db' => 5,
+    'session-save-redis-max-concurrency' => 20,
+    'cache-backend' => 'redis',
+    'cache-backend-redis-server' => 'redis',
+    'cache-backend-redis-db' => 4,
+    'cache-backend-redis-port' => 6379,
+    'page-cache' => 'redis',
+    'page-cache-redis-server' => 'redis',
+    'page-cache-redis-db' => 3,
+    'page-cache-redis-port' => 6379
+];

Api/Insights/EventProcessorInterface.php

@@ -91,7 +91,7 @@ public function convertAddToCart(
         string $eventName,
         string $indexName,
         Item   $item,
-        string $queryID = null
+        ?string $queryID = null
     ): array;
 
     /**
@@ -123,7 +123,7 @@ public function convertPurchaseForItems(
         string $eventName,
         string $indexName,
         array  $items,
-        string $queryID = null
+        ?string $queryID = null
     ): array;
 
 }

Api/LoggerInterface.php

@@ -0,0 +1,4 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api;
+interface LoggerInterface extends \Psr\Log\LoggerInterface {}

Api/Processor/BatchQueueProcessorInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\Processor;
+
+interface BatchQueueProcessorInterface
+{
+    public function processBatch(int $storeId, ?array $entityIds = null): void;
+}

Block/Adminhtml/LandingPage/Edit/AbstractButton.php

@@ -52,7 +52,7 @@ public function getObject()
             $landingPage->getResource()->load($landingPage, $modelId);
 
             return $landingPage;
-        } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
+        } catch (\Magento\Framework\Exception\NoSuchEntityException) {
         }
 
         return null;

Block/Adminhtml/Query/Edit/AbstractButton.php

@@ -52,7 +52,7 @@ public function getObject()
             $query->getResource()->load($query, $modelId);
 
             return $query;
-        } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
+        } catch (\Magento\Framework\Exception\NoSuchEntityException) {
         }
 
         return null;

Block/Adminhtml/Queue/Status.php

@@ -70,20 +70,12 @@ public function isQueueActive()
     public function getQueueRunnerStatus()
     {
         $status = 'unknown';
-        switch ($this->queueRunnerIndexer->getStatus()) {
-            case \Magento\Framework\Indexer\StateInterface::STATUS_VALID:
-                $status = 'Ready';
-
-                break;
-            case \Magento\Framework\Indexer\StateInterface::STATUS_INVALID:
-                $status = 'Reindex required';
-
-                break;
-            case \Magento\Framework\Indexer\StateInterface::STATUS_WORKING:
-                $status = 'Processing';
-
-                break;
-        }
+        $status = match ($this->queueRunnerIndexer->getStatus()) {
+            \Magento\Framework\Indexer\StateInterface::STATUS_VALID => 'Ready',
+            \Magento\Framework\Indexer\StateInterface::STATUS_INVALID => 'Reindex required',
+            \Magento\Framework\Indexer\StateInterface::STATUS_WORKING => 'Processing',
+            default => $status,
+        };
 
         return $status;
     }

Block/Adminhtml/Reindex/AbstractReindexAllButton.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Block\Adminhtml\Reindex;
+
+use Algolia\AlgoliaSearch\Helper\ConfigHelper;
+use Magento\Backend\Block\Widget\Context;
+use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
+
+abstract class AbstractReindexAllButton implements ButtonProviderInterface
+{
+    protected string $entity;
+
+    protected string $redirectPath;
+
+    public function __construct(
+        protected Context $context,
+        protected ConfigHelper $configHelper
+    ) {}
+
+    /**
+     * @return string
+     */
+    protected function getEntity(): string
+    {
+        return $this->entity;
+    }
+
+    /**
+     * @return string
+     */
+    protected function getRedirectPath(): string
+    {
+        return $this->redirectPath;
+    }
+
+    /**
+     * @return array
+     */
+    public function getButtonData(): array
+    {
+        $entity = $this->getEntity();
+        $redirectPath = $this->getRedirectPath();
+
+        $message = "Are you sure you want to reindex all $entity to Algolia ?";
+
+        if (!$this->configHelper->isQueueActive() && $entity === 'products') {
+            $message .= ' Warning : Your Indexing Queue is not activated. Depending on the size of the data you want to index, it may takes a lot of time and resources.';
+            $message .= 'We highly suggest to turn it on if you\'re performing a full product reindexing with a large catalog.';
+        }
+
+        $message = htmlentities(__($message));
+        $url = $this->context->getUrlBuilder()->getUrl('algolia_algoliasearch/indexingmanager/reindex');
+
+        return [
+            'label'      => __('Reindex All ' . ucfirst($this->getEntity()) . ' to Algolia'),
+            'class'      => 'algolia_reindex_all',
+            'on_click'   => "deleteConfirm('{$message}', '{$url}', {data:{'entity':'{$entity}', 'redirect': '{$redirectPath}'}})",
+            'sort_order' => 5,
+        ];
+    }
+}