Merge pull request #1771 from algolia/chore/MAGE-1341-prepare-release-3.16.0

cammonro · web-flow · commit 4ad1016701e3 · 2025-06-26T08:22:35.000-04:00
MAGE-1341 Prepare release 3.16.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,17 +1,6 @@
 # CHANGE LOG
 
-## 3.16.0-beta.2
-
-### Updates
-- Credentials form expanded by default in admin
-- Removed deprecated methods from Entity Helpers
-- Removed every calls to deprecated `AlgoliaHelper`'s methods in the codebase, `AlgoliaConnector` is now targeted directly. (`AlgoliaHelper` will be deleted in a future v3.17.0)
-- Updated integration tests
-
-### Breaking Changes
-- `ProductHelper::setSettings()` is now taking `IndexOptions` objects as two first parameters instead of index names (strings).
-
-## 3.16.0-beta.1
+## 3.16.0
 
 ### Features
 
@@ -21,7 +10,7 @@
 - CLI commands are now provided to run explicit full reindex of all entities and stores.
 - Products and CMS pages can now be reindexed directly from Magento admin grids.
 - The indexing queue cron job can now be configured from the Magento admin.
-- Dynamic faceting through Algolia merchandsiing rules is now supported in Magento via an opt-in feature flag.
+- Dynamic faceting through Algolia merchandising rules is now supported in Magento via an opt-in feature flag.
 - No code redirects via merchandising rules in Algolia are now supported in Magento for both Autocomplete and InstantSearch. Support is enabled by default for Autocomplete.
 - Integration tests and unit tests added
 
@@ -30,6 +19,8 @@
 - Replica data patches and delete operations have been enhanced to handle potential latency when detaching from the primary index.
 - Prices are now indexed using store scoped currency codes.
 - Fixed WSOD error on invalid creds when using manual SKU indexer (also included in 3.15.1).
+- Fixed Recommend model validation when configuring through the Magento admin 
+- Fixed edge case with null queries - thank you @PromInc 
 
 ### Updates
 - `beforecontent.html` is no longer used and has been deprecated. If you're overriding or referencing this file, please update your layout and customizations accordingly.
@@ -43,6 +34,29 @@
 - InstantSearch has been updated to v4.78.
 - Autocomplete has been updated to v1.18.1.
 - PHP API client has been pinned to 4.18.3 (also included in 3.15.1).
+- Credentials form expanded by default in admin
+- Removed deprecated methods from Entity Helpers
+- Removed every call to deprecated `AlgoliaHelper`'s methods in the codebase, `AlgoliaConnector` is now targeted directly. (`AlgoliaHelper` will be removed in a future v3.17.0)
+- Updated integration tests
+
+### Breaking Changes
+- `ProductHelper::setSettings()` is now taking `IndexOptions` objects as two first parameters instead of index names (strings).
+
+## 3.15.1
+
+### Features
+- Algolia's [Query Categorization feature](https://www.algolia.com/doc/integration/magento-2/how-it-works/query-categorization) is now compatible with the extension.
+
+### Updates
+- Updated integration tests to use `AlgoliaConnector`
+- Updated `ReplicaManager` service to handle multi stores properly with a `$storeId` parameter.
+- Pinned PHP Client version to 4.18.3
+
+### Bug Fixes
+- Fixed `RebuildReplicasPatch` bug where replica detach logic wasn't properly applied in some cases.
+- Fixed a bug where credentials errors weren't gracefully handled on the SKU reindexing form
+- Fixed a bug where the `q` parameter wasn't properly handled in case it was missing on the catalogsearch page. (thanks @PromInc)
+- Fixed Recommend model validation when configuration is saved in the Magento admin.
 
 ## 3.15.0
 
@@ -56,6 +70,7 @@
 - Added a feature to enable automatic price indexing within the Advanced section of the configuration (This feature should help alleviate issues where missing pricing records prevent Algolia from being able to index products. See [documentation](https://www.algolia.com/doc/integration/magento-2/troubleshooting/data-indexes-queues/#price-index-dependencies) for further details.)
 - Reorganization of the test folders
 - Added unit and integration tests for full page cache (FPC)
+- Added new CLI command for synonyms deduplication
 
 ### Updates
 - Tests: Added possibility to run tests with multiple applications IDs.
diff --git a/README.md b/README.md
@@ -1,9 +1,8 @@
 Algolia Search & Discovery extension for Magento 2
 ==================================================
 
-![Latest version](https://img.shields.io/badge/latest-3.15.0-green)
+![Latest version](https://img.shields.io/badge/latest-3.16.0-green)
 ![Magento 2](https://img.shields.io/badge/Magento-2.4.6+-orange)
-![Beta version](https://img.shields.io/badge/beta-3.16.0--beta.1-purple)
 
 ![PHP](https://img.shields.io/badge/PHP-8.1%2C8.2%2C8.3-blue)
 
@@ -36,17 +35,18 @@ Magento 2.3 and earlier versions are no longer supported by the Algolia extensio
 
 Version 3.x of our extension is compatible with Magento 2.4. Review the [Customisation](https://github.com/algolia/algoliasearch-magento-2#customisation) section to learn more about the differences between our extension versions.
 
-| Extension Version | End of Life | Magento                      | PHP                                    |
-|-------------------|-------------|------------------------------|----------------------------------------|
+| Extension Version | End of Life | Magento            | PHP                                    |
+|-------------------|-------------|--------------------|----------------------------------------|
 | v3.7.x            | 10/10/2023  | `~2.3.7\|\|~2.4.5\|\|~2.4.6` | `~7.3.0\|\|~7.4.0\|\|~8.1.0\|\|~8.2.0` |
-| v3.8.x            | 3/8/2023    | `~2.4.5\|\|~2.4.6`           | `~7.4.0\|\|~8.1.0\|\|~8.2.0`           |
-| v3.9.x            | 10/13/2023  | `~2.4.5\|\|~2.4.6`           | `~7.4.0\|\|~8.1.0\|\|~8.2.0`           |
-| v3.10.x           | 12/12/2023  | `~2.4.6`                     | `~8.1.0\|\|~8.2.0`                     |
-| v3.11.x           | 1/26/2024   | `~2.4.6`                     | `~8.1.0\|\|~8.2.0`                     |
-| v3.12.x           | 8/2/2024    | `~2.4.6`                     | `~8.1.0\|\|~8.2.0`                     |
-| v3.13.x           | N/A         | `~2.4.6`                     | `~8.1.0\|\|~8.2.0`                     |
-| v3.14.x           | N/A         | `~2.4.6\|\|~2.4.7`           | `~8.1.0\|\|~8.2.0\|\|~8.3.0`           |
-| v3.15.x           | N/A         | `~2.4.6\|\|~2.4.7`           | `~8.1.0\|\|~8.2.0\|\|~8.3.0`           |
+| v3.8.x            | 3/8/2023    | `~2.4.5\|\|~2.4.6` | `~7.4.0\|\|~8.1.0\|\|~8.2.0`           |
+| v3.9.x            | 10/13/2023  | `~2.4.5\|\|~2.4.6` | `~7.4.0\|\|~8.1.0\|\|~8.2.0`           |
+| v3.10.x           | 12/12/2023  | `~2.4.6`           | `~8.1.0\|\|~8.2.0`                     |
+| v3.11.x           | 1/26/2024   | `~2.4.6`           | `~8.1.0\|\|~8.2.0`                     |
+| v3.12.x           | 8/2/2024    | `~2.4.6`           | `~8.1.0\|\|~8.2.0`                     |
+| v3.13.x           | N/A         | `~2.4.6`           | `~8.1.0\|\|~8.2.0`                     |
+| v3.14.x           | N/A         | `~2.4.6\|\|~2.4.7` | `~8.1.0\|\|~8.2.0\|\|~8.3.0`           |
+| v3.15.x           | N/A         | `~2.4.6\|\|~2.4.7` | `~8.1.0\|\|~8.2.0\|\|~8.3.0`           |
+| v3.16.x           | N/A         | `~2.4.6\|\|~2.4.7` | `~8.1.0\|\|~8.2.0\|\|~8.3.0`           |
 
 ## Documentation
 
diff --git a/Test/Unit/Logger/AlgoliaLoggerTest.php b/Test/Unit/Logger/AlgoliaLoggerTest.php
diff --git a/Test/Unit/Logger/Handler/AbstractHandlerTest.php b/Test/Unit/Logger/Handler/AbstractHandlerTest.php
@@ -0,0 +1,45 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Test\Unit\Logger\Handler;
+
+use Magento\Framework\Logger\Handler\Base;
+use PHPUnit\Framework\TestCase;
+
+abstract class AbstractHandlerTest extends TestCase
+{
+    protected ?Base $handler = null;
+
+    /**
+     * Monolog v3 uses LogRecord
+     * v2 uses arrays only
+     */
+    protected function makeLogRecord(int $level, string $message)
+    {
+        if (class_exists(\Monolog\LogRecord::class)) {
+            // Monolog v3
+            $levelEnum = $this->convertLevelToEnum($level);
+            return new \Monolog\LogRecord(
+                new \DateTimeImmutable(),
+                'test',
+                $levelEnum,
+                $message
+            );
+        }
+
+        // Monolog v2
+        return [
+            'message' => $message,
+            'level' => $level
+        ];
+    }
+
+    protected function convertLevelToEnum(int $level): \Monolog\Level
+    {
+        if (class_exists(\Monolog\Level::class)) {
+            return \Monolog\Level::from($level);
+        }
+
+        throw new \RuntimeException('Monolog v3 Level enum not available');
+    }
+
+}
diff --git a/Test/Unit/Logger/Handler/AlgoliaLoggerHandlerTest.php b/Test/Unit/Logger/Handler/AlgoliaLoggerHandlerTest.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Test\Unit\Logger\Handler;
+
+use Algolia\AlgoliaSearch\Logger\Handler\AlgoliaLoggerHandler;
+use Magento\Framework\Filesystem\DriverInterface;
+
+class AlgoliaLoggerHandlerTest extends AbstractHandlerTest
+{
+    protected function setUp(): void
+    {
+        $this->handler = new AlgoliaLoggerHandler(
+            $this->createMock(DriverInterface::class)
+        );
+    }
+
+    public function testAlgoliaHandlerLogsEverything(): void
+    {
+        $debugRecord = $this->makeLogRecord(
+            \Monolog\Logger::DEBUG,
+            'Should log'
+        );
+
+        $infoRecord = $this->makeLogRecord(
+            \Monolog\Logger::INFO,
+            'Should log'
+        );
+
+        $errorRecord = $this->makeLogRecord(
+            \Monolog\Logger::ERROR,
+            'Should log'
+        );
+
+        $this->assertTrue($this->handler->isHandling($debugRecord), 'DEBUG should be handled');
+        $this->assertTrue($this->handler->isHandling($infoRecord), 'INFO should be handled');
+        $this->assertTrue($this->handler->isHandling($errorRecord), 'ERROR should be handled');
+    }
+}
diff --git a/Test/Unit/Logger/Handler/SystemLoggerHandlerTest.php b/Test/Unit/Logger/Handler/SystemLoggerHandlerTest.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Test\Unit\Logger\Handler;
+
+use Algolia\AlgoliaSearch\Logger\Handler\SystemLoggerHandler;
+use Magento\Framework\Filesystem\DriverInterface;
+use Magento\Framework\Logger\Handler\Exception as ExceptionHandler;
+
+class SystemLoggerHandlerTest extends AbstractHandlerTest
+{
+    /**
+     * @throws \Exception
+     */
+    protected function setUp(): void
+    {
+        $this->handler = new SystemLoggerHandler(
+            $this->createMock(DriverInterface::class),
+            $this->createMock(ExceptionHandler::class),
+        );
+    }
+
+    public function testSystemHandlerFiltersBelowError(): void
+    {
+        $infoRecord = $this->makeLogRecord(
+            \Monolog\Logger::INFO,
+            'Should not log'
+        );
+
+        $errorRecord = $this->makeLogRecord(
+             \Monolog\Logger::ERROR,
+            'Should log'
+        );
+
+        $this->assertFalse($this->handler->isHandling($infoRecord), 'INFO should be ignored');
+        $this->assertTrue($this->handler->isHandling($errorRecord), 'ERROR should be handled');
+    }
+}
diff --git a/composer.json b/composer.json
@@ -3,7 +3,7 @@
   "description": "Algolia Search & Discovery extension for Magento 2",
   "type": "magento2-module",
   "license": ["MIT"],
-  "version": "3.16.0-beta.1",
+  "version": "3.16.0",
   "require": {
     "php": "~8.1|~8.2|~8.3",
     "magento/framework": "~103.0",
diff --git a/etc/module.xml b/etc/module.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
-    <module name="Algolia_AlgoliaSearch" setup_version="3.16.0-beta.1">
+    <module name="Algolia_AlgoliaSearch" setup_version="3.16.0">
         <sequence>
             <module name="Magento_Theme"/>
             <module name="Magento_Backend"/>
