Feature/mage 725 - category versioning

Api/CategoryVersionLoggerInterface.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api;
+
+use Magento\Catalog\Model\Category;
+use Magento\Framework\Exception\AlreadyExistsException;
+use Magento\Framework\Exception\NoSuchEntityException;
+
+interface CategoryVersionLoggerInterface
+{
+    /**
+     * Category save events are store scope sensitive.
+     *
+     * @param Category $category
+     * @param int $storedId
+     * @return void
+     * @throws NoSuchEntityException
+     * @throws AlreadyExistsException
+     */
+    public function logCategoryChange(Category $category, int $storedId = 0): void;
+
+    /**
+     * Category move events are not store scoped and must be handled differently.
+     *
+     * @param Category $category
+     * @return void
+     * @throws NoSuchEntityException
+     * @throws AlreadyExistsException
+     */
+    public function logCategoryMove(Category $category): void;
+}

Api/CategoryVersionRepositoryInterface.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api;
+
+use Algolia\AlgoliaSearch\Api\Data\CategoryVersionInterface;
+use Algolia\AlgoliaSearch\Api\Data\CategoryVersionSearchResultsInterface;
+use Magento\Framework\Exception\AlreadyExistsException;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\Api\SearchCriteriaInterface;
+
+interface CategoryVersionRepositoryInterface
+{
+    /**
+     * @param int $id
+     * @return CategoryVersionInterface
+     * @throws NoSuchEntityException
+     */
+    public function getById(int $id): CategoryVersionInterface;
+
+    /**
+     * @return CategoryVersionInterface
+     */
+    public function getNew(): CategoryVersionInterface;
+
+    /**
+     * @param CategoryVersionInterface $version
+     * @return CategoryVersionInterface
+     * @throws AlreadyExistsException
+     */
+    public function save(CategoryVersionInterface $version): CategoryVersionInterface;
+
+    /**
+     * @param SearchCriteriaInterface|null $searchCriteria
+     * @return CategoryVersionSearchResultsInterface
+     */
+    public function getList(SearchCriteriaInterface $searchCriteria = null): CategoryVersionSearchResultsInterface;
+}

Api/Data/CategoryVersionAttributeInterface.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\Data;
+
+use Algolia\AlgoliaSearch\Api\Data\CategoryVersionInterface;
+
+interface CategoryVersionAttributeInterface
+{
+    /**
+     * @param int|null $storeId
+     * @return CategoryVersionAttributeInterface
+     */
+    public function load(int $categoryId, int $storeId = null): CategoryVersionAttributeInterface;
+
+    /**
+     * Does this category have versions?
+     * @param int|null $storeId
+     * @return bool
+     */
+    public function hasVersions(int $storeId = null): bool;
+
+    /**
+     * Get all versions of this category
+     * @param int|null $storeId
+     * @return CategoryVersionInterface[]
+     */
+    public function getVersions(int $storeId = null): array;
+
+    /**
+     * Get all possible request paths that can be used as category filters
+     * @param int|null $storeId
+     * @return string[]
+     */
+    public function getSearchFilters(int $storeId = null): array;
+
+}

Api/Data/CategoryVersionInterface.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\Data;
+
+use Magento\Framework\Api\ExtensibleDataInterface;
+
+interface CategoryVersionInterface extends ExtensibleDataInterface
+{
+    const KEY_CATEGORY_ID = 'entity_id';
+    const KEY_STORE_ID = 'store_id';
+    const KEY_OLD_VALUE = 'old_value';
+    const KEY_NEW_VALUE = 'new_value';
+    const KEY_CREATED_AT = 'created_at';
+    const KEY_UPDATED_AT = 'updated_at';
+    const KEY_INDEXED_AT = 'indexed_at';
+    const KEY_RESOLVED_AT = 'resolved_at';
+
+    public function getCategoryId(): int;
+    public function setCategoryId(int $categoryId): CategoryVersionInterface;
+
+    public function getStoreId(): int;
+    public function setStoreId(int $storeId): CategoryVersionInterface;
+
+    public function getOldValue(): string;
+    public function setOldValue(string $val): CategoryVersionInterface;
+
+    public function getNewValue(): string;
+    public function setNewValue(string $val): CategoryVersionInterface;
+
+    public function getUpdatedAt(): string;
+    public function setUpdatedAt(?string $val): CategoryVersionInterface;
+
+}

Api/Data/CategoryVersionSearchResultsInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\Data;
+
+use Magento\Framework\Api\SearchResultsInterface;
+
+interface CategoryVersionSearchResultsInterface extends SearchResultsInterface
+{
+
+    /**
+     * Get list of category versions
+     *
+     * @return CategoryVersionInterface[]
+     */
+    public function getItems();
+
+    /**
+     * Set category version list
+     *
+     * @param CategoryVersionInterface[] $items
+     * @return $this
+     */
+    public function setItems(array $items);
+}

Block/Algolia.php

@@ -10,6 +10,7 @@
 use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
 use Algolia\AlgoliaSearch\Helper\Entity\SuggestionHelper;
 use Algolia\AlgoliaSearch\Helper\LandingPageHelper;
+use Algolia\AlgoliaSearch\Registry\CurrentCategory;
 use Magento\Catalog\Model\Product;
 use Magento\Checkout\Model\Session as CheckoutSession;
 use Magento\Customer\Model\Context as CustomerContext;
@@ -25,6 +26,7 @@
 use Magento\Framework\View\Element\Template;
 use Magento\Sales\Model\Order;
 use Magento\Search\Helper\Data as CatalogSearchHelper;
+use Magento\Catalog\Api\CategoryRepositoryInterface;
 
 class Algolia extends Template implements CollectionDataSourceInterface
 {
@@ -97,6 +99,9 @@ class Algolia extends Template implements CollectionDataSourceInterface
      */
     protected $date;
 
+    /** @var CurrentCategory  */
+    protected CurrentCategory $currentCategory;
+
     protected $priceKey;
 
     /**
@@ -119,6 +124,7 @@ class Algolia extends Template implements CollectionDataSourceInterface
      * @param CheckoutSession $checkoutSession
      * @param DateTime $date
      * @param array $data
+     * @param CategoryRepositoryInterface $categoryRepository
      */
     public function __construct(
         Template\Context $context,
@@ -139,6 +145,7 @@ public function __construct(
         PersonalizationHelper $personalizationHelper,
         CheckoutSession $checkoutSession,
         DateTime $date,
+        CurrentCategory $currentCategory,
         array $data = []
     ) {
         $this->config = $config;
@@ -158,6 +165,7 @@ public function __construct(
         $this->personalizationHelper = $personalizationHelper;
         $this->checkoutSession = $checkoutSession;
         $this->date = $date;
+        $this->currentCategory = $currentCategory;
 
         parent::__construct($context, $data);
     }
@@ -255,7 +263,7 @@ public function getStoreId()
 
     public function getCurrentCategory()
     {
-        return $this->registry->registry('current_category');
+        return $this->currentCategory->get();
     }
 
     /** @return Product */

Block/Configuration.php

@@ -122,6 +122,7 @@ public function getConfiguration()
         if ($config->isInstantEnabled()
             && $config->replaceCategories()
             && $request->getControllerName() === 'category') {
+
             $category = $this->getCurrentCategory();
 
             if ($category && $category->getDisplayMode() !== 'PAGE') {
@@ -278,6 +279,8 @@ public function getConfiguration()
                 'level' => $level,
                 'parentCategory' => $parentCategoryName,
                 'childCategories' => $childCategories,
+                'hasCategoryVersions' => $this->hasCategoryVersions(),
+                'alternatePaths' => array_values($this->getAlternatePaths($path)),
                 'url' => $this->getUrl('*/*/*', ['_use_rewrite' => true, '_forced_secure' => true])
             ],
             'showCatsNotIncludedInNavigation' => $config->showCatsNotIncludedInNavigation(),
@@ -427,4 +430,21 @@ protected function getLandingPageConfiguration()
     {
         return $this->isLandingPage() ? $this->getCurrentLandingPage()->getConfiguration() : json_encode([]);
     }
+
+    protected function hasCategoryVersions(): bool
+    {
+        if (!$this->config->isCategoryVersionTrackingEnabled()) return false;
+        return (bool) $this->getCurrentCategory()->getExtensionAttributes()->getAlgoliaCategoryVersions()?->hasVersions();
+    }
+
+    protected function getAlternatePaths(string $mainPath): array
+    {
+        if (!$this->config->isCategoryVersionTrackingEnabled() || !$this->hasCategoryVersions()) return [];
+        return array_unique(
+            array_merge(
+                [$mainPath],
+                $this->getCurrentCategory()->getExtensionAttributes()->getAlgoliaCategoryVersions()->getSearchFilters()
+            )
+        );
+    }
 }

Helper/ConfigHelper.php

@@ -55,6 +55,7 @@ class ConfigHelper
     public const USE_ADAPTIVE_IMAGE = 'algoliasearch_products/products/use_adaptive_image';
     public const ENABLE_VISUAL_MERCHANDISING = 'algoliasearch_products/products/enable_visual_merchandising';
     public const CATEGORY_PAGE_ID_ATTRIBUTE_NAME = 'algoliasearch_products/products/category_page_id_attribute_name';
+    public const ENABLE_CATEGORY_VERSIONS = 'algoliasearch_products/products/enable_category_versions';
 
     public const CATEGORY_ATTRIBUTES = 'algoliasearch_categories/categories/category_additional_attributes';
     public const CATEGORY_CUSTOM_RANKING = 'algoliasearch_categories/categories/custom_ranking_category_attributes';
@@ -910,6 +911,15 @@ public function getCategoryPageIdAttributeName($storeId = null): string
         return (string) $this->configInterface->getValue(self::CATEGORY_PAGE_ID_ATTRIBUTE_NAME, ScopeInterface::SCOPE_STORE, $storeId);
     }
 
+    /**
+     * @param $storeId
+     * @return bool
+     */
+    public function isCategoryVersionTrackingEnabled($storeId = null): bool
+    {
+        return $this->configInterface->isSetFlag(self::ENABLE_CATEGORY_VERSIONS, ScopeInterface::SCOPE_STORE, $storeId);
+    }
+
     /**
      * @param $storeId
      * @return mixed

Model/CategoryVersion.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Model;
+
+use Algolia\AlgoliaSearch\Api\Data\CategoryVersionInterface;
+use Magento\Framework\DataObject\IdentityInterface;
+use Magento\Framework\Model\AbstractExtensibleModel;
+
+class CategoryVersion extends AbstractExtensibleModel implements IdentityInterface, CategoryVersionInterface
+{
+    const CACHE_TAG = 'algoliasearch_category_version';
+    protected $_cacheTag = self::CACHE_TAG;
+    protected $_eventPrefix = 'algoliasearch_category_version';
+
+    protected function _construct()
+    {
+        $this->_init(ResourceModel\CategoryVersion::class);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getIdentities(): array
+    {
+        return [self::CACHE_TAG . '_' . $this->getId()];
+    }
+
+    public function getCategoryId(): int
+    {
+        return $this->getData(CategoryVersionInterface::KEY_CATEGORY_ID);
+    }
+
+    public function setCategoryId(int $categoryId): CategoryVersionInterface
+    {
+        return $this->setData(CategoryVersionInterface::KEY_CATEGORY_ID, $categoryId);
+    }
+
+    public function getStoreId(): int
+    {
+        return $this->getData(CategoryVersionInterface::KEY_STORE_ID);
+    }
+
+    public function setStoreId(int $storeId): CategoryVersionInterface
+    {
+        return $this->setData(CategoryVersionInterface::KEY_STORE_ID, $storeId);
+    }
+
+    public function getOldValue(): string
+    {
+        return $this->getData(CategoryVersionInterface::KEY_OLD_VALUE);
+    }
+
+    public function setOldValue(string $val): CategoryVersionInterface
+    {
+        return $this->setData(CategoryVersionInterface::KEY_OLD_VALUE, $val);
+    }
+
+    public function getNewValue(): string
+    {
+        return $this->getData(CategoryVersionInterface::KEY_NEW_VALUE);
+    }
+
+    public function setNewValue(string $val): CategoryVersionInterface
+    {
+        return $this->setData(CategoryVersionInterface::KEY_NEW_VALUE, $val);
+    }
+
+    public function getUpdatedAt(): string
+    {
+        return $this->getData(CategoryVersionInterface::KEY_UPDATED_AT);
+    }
+
+    public function setUpdatedAt(?string $val): CategoryVersionInterface
+    {
+        return $this->setData(CategoryVersionInterface::KEY_UPDATED_AT, $val);
+    }
+}