MAGE-1104 Replace deprecated registry with observer based category retrieval

Author: cammonro

Observer/AddAlgoliaAssetsObserver.php

@@ -2,13 +2,15 @@
 
 namespace Algolia\AlgoliaSearch\Observer;
 
+use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
+use Algolia\AlgoliaSearch\Registry\CurrentCategory;
 use Algolia\AlgoliaSearch\Service\AlgoliaCredentialsManager;
 use Magento\Catalog\Model\Category;
 use Magento\Framework\App\Request\Http;
+use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
 use Magento\Framework\Exception\NoSuchEntityException;
-use Magento\Framework\Registry;
 use Magento\Framework\View\Layout;
 use Magento\Framework\View\Page\Config as PageConfig;
 use Magento\Store\Model\StoreManagerInterface;
@@ -20,7 +22,7 @@ class AddAlgoliaAssetsObserver implements ObserverInterface
 {
     public function __construct(
         protected ConfigHelper $config,
-        protected Registry $registry,
+        protected CurrentCategory $category,
         protected StoreManagerInterface $storeManager,
         protected PageConfig $pageConfig,
         protected Http $request,
@@ -29,13 +31,13 @@ public function __construct(
     {}
 
     /**
-     * @throws NoSuchEntityException
+     * @throws NoSuchEntityException|AlgoliaException
      */
-    public function execute(\Magento\Framework\Event\Observer $observer)
+    public function execute(Observer $observer): void
     {
         $actionName = $this->request->getFullActionName();
         if ($actionName === 'swagger_index_index') {
-            return $this;
+            return;
         }
         $storeId = $this->storeManager->getStore()->getId();
         if ($this->config->isEnabledFrontEnd($storeId)) {
@@ -51,15 +53,33 @@ public function execute(\Magento\Framework\Event\Observer $observer)
         }
     }
 
-    private function loadPreventBackendRenderingHandle(Layout $layout, int $storeId): void
+    /**
+     * Repository does not guarantee this underlying model but only the interface
+     * but getDisplayMode is only available on model
+     *
+     * @throws AlgoliaException
+     */
+    public function getCategory(): Category
     {
-        if ($this->config->preventBackendRendering($storeId) === false) {
-            return;
+        $category = $this->category->get();
+        if (!$category instanceof Category) {
+            throw new AlgoliaException("Unexpected category object encountered.");
         }
+        return $category;
+    }
+
+    /**
+     * @throws AlgoliaException
+     */
+    private function loadPreventBackendRenderingHandle(Layout $layout, int $storeId): void
+    {
+        if (!$this->config->preventBackendRendering($storeId)) {
+        return;
+    }
+
+        $category = $this->getCategory();
 
-        /** @var Category $category */
-        $category = $this->registry->registry('current_category');
-        if (!$category) {
+        if (!$category->getId()) {
             return;
         }
 

Observer/RegisterCurrentCategoryObserver.php

@@ -21,7 +21,7 @@ public function __construct(CurrentCategory $currentCategory) {
      */
     public function execute(Observer $observer)
     {
-        /** @var CategoryInterface */
+        /** @var $category CategoryInterface */
         $category = $observer->getEvent()->getData('category');
         $this->currentCategory->set($category);
     }