Merge branch 'release/2.29.0'

Author: adamwaclawczyk

Api/Data/NodeInterface.php

@@ -26,6 +26,7 @@ interface NodeInterface
     const ADDITIONAL_DATA = 'additional_data';
     const SELECTED_ITEM_ID = 'selected_item_id';
     const CUSTOMER_GROUPS = 'customer_groups';
+    const HIDE_IF_EMPTY = 'hide_if_empty';
 
     /**
      * Get node id
@@ -316,4 +317,16 @@ public function setCustomerGroups($customerGroups);
      * @return bool
      */
     public function isVisible($customerGroupId);
+
+
+    /**
+     * @return int
+     */
+    public function getHideIfEmpty();
+
+    /**
+     * @param int $hideIfEmpty
+     * @return $this
+     */
+    public function setHideIfEmpty($hideIfEmpty);
 }

Block/Adminhtml/Edit/Tab/Nodes.php

@@ -178,6 +178,7 @@ private function renderNodeList($level, $parent, $data)
         foreach ($nodes as $node) {
             $menu[] = [
                 'is_active' => $node->getIsActive(),
+                'hide_if_empty' => $node->getHideIfEmpty(),
                 'is_stored' => true,
                 'type' => $node->getType(),
                 'content' => $node->getContent(),

Block/Menu.php

@@ -24,6 +24,7 @@
 class Menu extends Template implements DataObject\IdentityInterface
 {
     const XML_SNOWMENU_GENERAL_CUSTOMER_GROUPS = 'snowmenu/general/customer_groups';
+    const XML_SNOWMENU_GENERAL_CACHE_TAGS = 'snowmenu/general/cache_tags';
 
     /**
      * @var MenuRepositoryInterface
@@ -84,6 +85,11 @@ class Menu extends Template implements DataObject\IdentityInterface
      */
     private $httpContext;
 
+    /**
+     * @var array
+     */
+    private $nodeTypeCaches = [];
+
     /**
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -97,6 +103,7 @@ public function __construct(
         ImageFile $imageFile,
         Escaper $escaper,
         Context $httpContext,
+        array $nodeTypeCaches = [],
         array $data = []
     ) {
         parent::__construct($context, $data);
@@ -110,6 +117,7 @@ public function __construct(
         $this->setTemplate($this->getMenuTemplate($this->_template));
         $this->submenuTemplate = $this->getSubmenuTemplate();
         $this->httpContext = $httpContext;
+        $this->nodeTypeCaches = $nodeTypeCaches;
     }
 
     /**
@@ -119,11 +127,22 @@ public function __construct(
      */
     public function getIdentities()
     {
-        return [
+        $tags = [
             \Snowdog\Menu\Model\Menu::CACHE_TAG . '_' . $this->loadMenu()->getId(),
             Block::CACHE_TAG,
             \Snowdog\Menu\Model\Menu::CACHE_TAG
         ];
+        if (!$this->canGatherEntityCacheTags()) {
+            return $tags;
+        }
+        $otherCacheTagsArrays = [];
+        foreach ($this->nodeTypeCaches as $provider) {
+            $entityCacheTags = $this->nodeTypeProvider->getProvider($provider)->getEntityCacheTags();
+            if (!empty($entityCacheTags)) {
+                $otherCacheTagsArrays[] = $entityCacheTags;
+            }
+        }
+        return array_merge($tags, ...$otherCacheTagsArrays);
     }
 
     protected function getCacheLifetime()
@@ -440,6 +459,9 @@ private function getSubmenuBlock($nodes, $parentNode, $level = 0)
         return $block;
     }
 
+    /**
+     * @SuppressWarnings(PHPMD.NPathComplexity)
+     */
     private function fetchData()
     {
         $nodes = $this->nodeRepository->getByMenu($this->loadMenu()->getId());
@@ -464,16 +486,29 @@ private function fetchData()
                 $result[$level][$parent] = [];
             }
             $result[$level][$parent][] = $node;
+            $idx = array_key_last($result[$level][$parent]);
             $type = $node->getType();
             if (!isset($types[$type])) {
                 $types[$type] = [];
             }
-            $types[$type][] = $node;
+            $types[$type][] = [
+                'node' => $node,
+                'path' => [$level, $parent, $idx]
+            ];
         }
         $this->nodes = $result;
 
         foreach ($types as $type => $nodes) {
-            $this->nodeTypeProvider->prepareData($type, $nodes);
+            $this->nodeTypeProvider->prepareData($type, array_column($nodes, 'node'));
+        }
+
+        foreach ($types['category'] ?? [] as $nodes) {
+            $categoryProvider = $this->nodeTypeProvider->getProvider('category');
+            $productCount = $categoryProvider->getCategoryProductCount($nodes['node']->getNodeId());
+            if (empty($productCount) && $nodes['node']->getHideIfEmpty()) {
+                [$level, $parent, $idx] = $nodes['path'];
+                unset($this->nodes[$level][$parent][$idx]);
+            }
         }
     }
 
@@ -509,6 +544,15 @@ private function getSubmenuTemplate()
         return $this->getMenuTemplate($baseSubmenuTemplate);
     }
 
+    private function canGatherEntityCacheTags()
+    {
+        if (!$this->_scopeConfig->isSetFlag(self::XML_SNOWMENU_GENERAL_CACHE_TAGS)) {
+            return false;
+        }
+
+        return !empty($this->nodeTypeCaches);
+    }
+
     public function getCustomerGroupId()
     {
         return $this->httpContext->getValue(\Magento\Customer\Model\Context::CONTEXT_GROUP);

Block/NodeType/Category.php

@@ -43,6 +43,15 @@ class Category extends AbstractNode
      * @var array
      */
     private $categories;
+    /**
+     * @var array
+     */
+    private $cacheTags;
+
+    /**
+     * @var array
+     */
+    private $categoryProductCounts;
 
     /**
      * Category constructor.
@@ -103,7 +112,14 @@ public function fetchData(array $nodes)
     {
         $storeId = $this->_storeManager->getStore()->getId();
 
-        list($this->nodes, $this->categoryUrls, $this->categories) = $this->_categoryModel->fetchData($nodes, $storeId);
+        [
+            $this->nodes,
+            $this->categoryUrls,
+            $this->categories,
+            $this->categoryProductCounts,
+            $this->cacheTags
+        ] = $this->_categoryModel->fetchData($nodes, $storeId);
+
     }
 
     /**
@@ -151,6 +167,22 @@ public function getCategoryUrl($nodeId, $storeId = null)
         return false;
     }
 
+    public function getCategoryProductCount($nodeId)
+    {
+        if (!isset($this->nodes[$nodeId])) {
+            throw new \InvalidArgumentException('Invalid node identifier specified');
+        }
+
+        $node = $this->nodes[$nodeId];
+        $categoryId = (int) $node->getContent();
+
+        if (isset($this->categoryProductCounts[$categoryId])) {
+            return $this->categoryProductCounts[$categoryId];
+        }
+
+        return 0;
+    }
+
     /**
      * @param int $nodeId
      *
@@ -199,4 +231,9 @@ public function getLabel()
     {
         return __("Category");
     }
+
+    public function getEntityCacheTags()
+    {
+        return $this->cacheTags;
+    }
 }

CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 
 ## [Unreleased]
+### Added
+- Dynamic menu improvements ([#317](https://github.com/SnowdogApps/magento2-menu/discussions/317))
+### Changed
+- Long Node cache tag in graphql ([#364](https://github.com/SnowdogApps/magento2-menu/pull/364))
+### Removed
+- Frontend console log (SMM-46)
+- Unused variables from phtml files ([#357](https://github.com/SnowdogApps/magento2-menu/pull/357))
+### Fixed
+- PHP8.4 module compilation errors ([#365](https://github.com/SnowdogApps/magento2-menu/issues/365))
+- Database prefix errors ([#368](https://github.com/SnowdogApps/magento2-menu/pull/368))
 
 ## [2.28.0] - 2025-03-25
 ### Added

Console/Command/NodesValidatorCommand.php

@@ -44,7 +44,7 @@ public function __construct(
         ValidationAggregateError $validationAggregateError,
         State $state,
         TreeTrace $treeTrace,
-        string $name = null
+        ?string $name = null
     ) {
         $this->menuRepository = $menuRepository;
         $this->nodeRepository = $nodeRepository;

Model/GraphQl/Resolver/DataProvider/Node.php

@@ -113,7 +113,8 @@ private function convertData(NodeInterface $node): array
             NodeInterface::UPDATE_TIME => $node->getUpdateTime(),
             NodeInterface::ADDITIONAL_DATA => $node->getAdditionalData(),
             NodeInterface::SELECTED_ITEM_ID => $node->getSelectedItemId(),
-            NodeInterface::CUSTOMER_GROUPS => $node->getCustomerGroups()
+            NodeInterface::CUSTOMER_GROUPS => $node->getCustomerGroups(),
+            NodeInterface::HIDE_IF_EMPTY => $node->getHideIfEmpty(),
         ];
     }
 

Model/GraphQl/Resolver/Menu.php

@@ -33,8 +33,8 @@ public function resolve(
         Field $field,
         $context,
         ResolveInfo $info,
-        array $value = null,
-        array $args = null
+        ?array $value = null,
+        ?array $args = null
     ) {
         $storeId = (int) $context->getExtensionAttributes()->getStore()->getId();
         $identifiers = $this->getIdentifiers($args);

Model/GraphQl/Resolver/Menu/Field/Nodes.php

@@ -27,8 +27,8 @@ public function resolve(
         Field $field,
         $context,
         ResolveInfo $info,
-        array $value = null,
-        array $args = null
+        ?array $value = null,
+        ?array $args = null
     ): array {
         if ($args === null) {
             $args = [];

Model/GraphQl/Resolver/Node.php

@@ -33,8 +33,8 @@ public function resolve(
         Field $field,
         $context,
         ResolveInfo $info,
-        array $value = null,
-        array $args = null
+        ?array $value = null,
+        ?array $args = null
     ) {
         if (!isset($args['identifier'])) {
             throw new GraphQlInputException(__('Menu identifier must be specified.'));