Upgrade the Algolia module

Last updated: October 9, 2026

Edit on GitHub

Warning

Starting from version 1.1.0, AlgoliaConfig::getIsActive() returns true when the Algolia credentials are set and no longer depends on the AlgoliaConstants::IS_ACTIVE configuration. If the ALGOLIA_APPLICATION_ID and ALGOLIA_SEARCH_API_KEY values are still set in the AWS Parameter Store or in the Back Office, the module exports search data to Algolia after the upgrade.

To prevent this, before you upgrade to version 1.1.0 or higher, do one of the following:

Remove the ALGOLIA_APPLICATION_ID and ALGOLIA_SEARCH_API_KEY values or set them to empty values in the AWS Parameter Store or, if you use the Back Office configuration, in Configuration > Integrations > Algolia.
On the project level, override getIsActive() in Pyz\Zed\Algolia\AlgoliaConfig and Pyz\Client\Algolia\AlgoliaConfig to return false in the environments where the Algolia integration must stay inactive.

Upgrading from version 1.* to version 2.*

Version 2.0.0 of the spryker-eco/algolia module introduces configurable sorting replicas and query suggestions. Sorting attributes for products and CMS pages, as well as query suggestion facet generation, are no longer hardcoded and must be configured at the project level.

Update the module

composer require -w spryker-eco/algolia:"^2.0.0"

Configure product sorting replicas

Product sorting attributes are now configurable and empty by default. To restore the previous behavior, create or update src/Pyz/Zed/Algolia/AlgoliaConfig.php:

<?php

namespace Pyz\Zed\Algolia;

use SprykerEco\Zed\Algolia\AlgoliaConfig as SprykerEcoAlgoliaConfig;

class AlgoliaConfig extends SprykerEcoAlgoliaConfig
{
    /**
     * @return array<string>
     */
    public function getProductSortingAttributes(): array
    {
        return [
            'rating',
            'abstract_name',
            'prices.eur.gross',
            'prices.eur.net',
        ];
    }
}

Each attribute gets ascending and descending replica indices created in Algolia. Adjust the list to match the sorting options available in your storefront.

Configure CMS page sorting replicas

CMS page sorting attributes are now empty by default. If your project uses CMS page sorting, add to src/Pyz/Zed/Algolia/AlgoliaConfig.php:

    /**
     * @return array<string>
     */
    public function getCmsPageSortingAttributes(): array
    {
        return ['name'];
    }

Query Suggestions facet generation attributes are now configurable and empty by default. To restore the previous behavior, add to src/Pyz/Zed/Algolia/AlgoliaConfig.php:

    /**
     * @return array<array<string>>
     */
    public function getSuggestionGenerateAttributes(): array
    {
        return [
            ['category'],
            ['attributes.brand'],
        ];
    }

Configure sort parameter to attribute mapping

If your storefront uses sort parameter names that differ from the Algolia attribute names used in replica indices—for example, the storefront sorts by name, but the replica index uses abstract_name—configure the mapping in src/Pyz/Client/Algolia/AlgoliaConfig.php:

<?php

namespace Pyz\Client\Algolia;

use SprykerEco\Client\Algolia\AlgoliaConfig as SprykerEcoAlgoliaConfig;

class AlgoliaConfig extends SprykerEcoAlgoliaConfig
{
    /**
     * @return array<string, string>
     */
    public function getProductSortingParamToAttributeMapping(): array
    {
        return [
            'name' => 'abstract_name',
        ];
    }
}

A similar method getCmsPageSortingParamToAttributeMapping() is available for CMS page sorting.