Merge pull request #1757 from algolia/feat/MAGE-1260-deprecated-cleanup

MAGE-1260: Remove deprecated methods/classes for 3.16

Author: damcou

Block/Algolia.php

@@ -2,7 +2,6 @@
 
 namespace Algolia\AlgoliaSearch\Block;
 
-use Algolia\AlgoliaSearch\Helper\AlgoliaHelper;
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
 use Algolia\AlgoliaSearch\Helper\Configuration\AutocompleteHelper;
 use Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper;
@@ -15,6 +14,7 @@
 use Algolia\AlgoliaSearch\Model\LandingPage as LandingPageModel;
 use Algolia\AlgoliaSearch\Registry\CurrentCategory;
 use Algolia\AlgoliaSearch\Registry\CurrentProduct;
+use Algolia\AlgoliaSearch\Service\AlgoliaConnector;
 use Algolia\AlgoliaSearch\Service\Product\SortingTransformer;
 use Magento\Catalog\Api\Data\CategoryInterface;
 use Magento\Catalog\Api\Data\ProductInterface;
@@ -50,7 +50,7 @@ public function __construct(
         protected Currency              $currency,
         protected Format                $format,
         protected CurrentProduct        $currentProduct,
-        protected AlgoliaHelper         $algoliaHelper,
+        protected AlgoliaConnector      $algoliaConnector,
         protected UrlHelper             $urlHelper,
         protected FormKey               $formKey,
         protected HttpContext           $httpContext,
@@ -107,11 +107,6 @@ public function getCatalogSearchHelper(): CatalogSearchHelper
         return $this->catalogSearchHelper;
     }
 
-    public function getAlgoliaHelper(): AlgoliaHelper
-    {
-        return $this->algoliaHelper;
-    }
-
     public function getPersonalizationHelper(): PersonalizationHelper
     {
         return $this->personalizationHelper;
@@ -212,7 +207,7 @@ protected function getAddToCartUrl($additional = []): string
         $urlParamName = ActionInterface::PARAM_NAME_URL_ENCODED;
         $routeParams = [
             $urlParamName => $continueUrl,
-            '_secure' => $this->algoliaHelper->getRequest()->isSecure(),
+            '_secure' => $this->getRequest()->isSecure(),
         ];
         if ($additional !== []) {
             $routeParams = array_merge($routeParams, $additional);

Block/Configuration.php

@@ -82,7 +82,7 @@ public function getConfiguration()
 
         $suggestionHelper = $this->getSuggestionHelper();
 
-        $algoliaHelper = $this->getAlgoliaHelper();
+        $algoliaConnector = $this->algoliaConnector;
 
         $persoHelper = $this->getPersonalizationHelper();
 
@@ -225,7 +225,7 @@ public function getConfiguration()
             // Legacy misnomer - retained for backward compatibility
             'indexName' => $coreHelper->getBaseIndexName(),
             'baseIndexName' => $coreHelper->getBaseIndexName(),
-            'apiKey' => $algoliaHelper->generateSearchSecuredApiKey(
+            'apiKey' => $algoliaConnector->generateSearchSecuredApiKey(
                 $config->getSearchOnlyAPIKey(),
                 $attributesToFilter,
                 $this->getStoreId()

CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGE LOG
 
+## 3.16.0-beta.2
+
+### Updates
+- 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
 
 ### Features

Controller/Adminhtml/Reindex/Save.php

@@ -10,6 +10,7 @@
 use Algolia\AlgoliaSearch\Helper\Data as DataHelper;
 use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
 use Algolia\AlgoliaSearch\Service\Product\IndexBuilder as ProductIndexBuilder;
+use Algolia\AlgoliaSearch\Service\Product\RecordBuilder as ProductRecordBuilder;
 use Magento\Backend\App\Action\Context;
 use Magento\Catalog\Api\ProductRepositoryInterface;
 use Magento\Framework\Controller\ResultFactory;
@@ -27,6 +28,7 @@ public function __construct(
         protected StoreManagerInterface $storeManager,
         protected DataHelper $dataHelper,
         protected ProductHelper $productHelper,
+        protected ProductRecordBuilder $productRecordBuilder,
         protected ProductIndexBuilder $productIndexBuilder
     ) {
         parent::__construct($context);
@@ -147,7 +149,7 @@ protected function checkAndReindex($product, $stores)
 
             try {
                 $product = $this->productRepository->get($product->getSku(), false, $storeId);
-                $this->productHelper->canProductBeReindexed($product, $storeId);
+                $this->productRecordBuilder->canProductBeReindexed($product, $storeId);
             } catch (ProductDisabledException $e) {
                 // Product status is a Website specific attribute
                 $this->messageManager->addErrorMessage(

Helper/AlgoliaHelper.php

@@ -15,7 +15,7 @@
 use Magento\Framework\Exception\NoSuchEntityException;
 
 /**
- * @deprecated (will be removed in v3.16.0)
+ * @deprecated (will be removed from the codebase in v3.17.0)
  */
 class AlgoliaHelper extends AbstractHelper
 {

Helper/Entity/CategoryHelper.php

@@ -8,7 +8,6 @@
 use Algolia\AlgoliaSearch\Service\Category\RecordBuilder as CategoryRecordBuilder;
 use Algolia\AlgoliaSearch\Service\IndexNameFetcher;
 use Magento\Catalog\Model\Category;
-use Magento\Catalog\Model\Category as MagentoCategory;
 use Magento\Catalog\Model\CategoryRepository;
 use Magento\Catalog\Model\ResourceModel\Category\Collection as CategoryCollection;
 use Magento\Catalog\Model\ResourceModel\Category\CollectionFactory as CategoryCollectionFactory;
@@ -197,18 +196,6 @@ public function getAllAttributes()
         return $this->categoryAttributes;
     }
 
-    /**
-     * @param MagentoCategory $category
-     * @return array|mixed|null
-     * @throws LocalizedException
-     *
-     * @deprecated (will be removed in v3.16.0)
-     */
-    public function getObject(Category $category)
-    {
-        return $this->categoryRecordBuilder->buildRecord($category);
-    }
-
     /**
      * @return int|mixed
      * @throws LocalizedException
@@ -259,23 +246,9 @@ public function isCategoryActive($category, $storeId = null)
      *
      * @return string|null
      *
-     * @deprecated (will be removed in v3.16.0)
      */
     public function getCategoryName($categoryId, $storeId = null)
     {
         return $this->categoryRecordBuilder->getCategoryName($categoryId, $storeId);
     }
-
-    /**
-     * @param $filterNotIncludedCategories
-     * @param $storeId
-     * @return array
-     * @throws LocalizedException
-     *
-     * @deprecated (will be removed in v3.16.0)
-     */
-    public function getCoreCategories($filterNotIncludedCategories = true, $storeId = null)
-    {
-        return $this->categoryRecordBuilder->getCoreCategories($filterNotIncludedCategories, $storeId);
-    }
 }