Merge pull request #52 from exponea/release/1.1.3

Release: v1.1.3

Author: vlmed

Model/System/Message/ErrorsMessageNotification.php

@@ -9,6 +9,8 @@
 
 use Bloomreach\EngagementConnector\Model\ExportQueueModel;
 use Bloomreach\EngagementConnector\Model\ResourceModel\ExportQueue\CollectionFactory;
+use Bloomreach\EngagementConnector\System\ConfigProvider;
+use Magento\Framework\App\CacheInterface;
 use Magento\Framework\Notification\MessageInterface;
 use Magento\Framework\Phrase;
 
@@ -21,19 +23,38 @@ class ErrorsMessageNotification implements MessageInterface
      * Message identity
      */
     private const MESSAGE_IDENTITY = 'bloomreach_errors_system_notification';
+    private const HAS_ERRORS_CACHE_VALUE = 'has_errors';
+    private const NO_ERRORS_CACHE_VALUE = 'no_errors';
+    private const CACHE_LIFETIME = 600;
 
     /**
      * @var CollectionFactory
      */
     private $exportQueueCollectionFactory;
 
+    /**
+     * @var ConfigProvider
+     */
+    private $configProvider;
+
+    /**
+     * @var CacheInterface
+     */
+    private $cacheManagement;
+
     /**
      * @param CollectionFactory $exportQueueCollectionFactory
+     * @param ConfigProvider $configProvider
+     * @param CacheInterface $cacheManagement
      */
     public function __construct(
-        CollectionFactory $exportQueueCollectionFactory
+        CollectionFactory $exportQueueCollectionFactory,
+        ConfigProvider $configProvider,
+        CacheInterface $cacheManagement
     ) {
+        $this->configProvider = $configProvider;
         $this->exportQueueCollectionFactory = $exportQueueCollectionFactory;
+        $this->cacheManagement = $cacheManagement;
     }
 
     /**
@@ -53,7 +74,9 @@ public function getIdentity(): string
      */
     public function isDisplayed(): bool
     {
-        return $this->isNeedToShow();
+        return $this->configProvider->isEnabled()
+            && $this->configProvider->isSystemNotificationEnabled()
+            && $this->isNeedToShow();
     }
 
     /**
@@ -84,10 +107,35 @@ public function getSeverity(): int
 
     /**
      * Show the error message if need it
+     * - save data to cache
      *
      * @return bool
      */
     private function isNeedToShow(): bool
+    {
+        $result = $this->cacheManagement->load($this->getIdentity());
+
+        if (is_string($result) && $result) {
+            return $result === self::HAS_ERRORS_CACHE_VALUE;
+        }
+
+        $hasErrors = $this->hasRecentErrorRecords();
+        $this->cacheManagement->save(
+            $hasErrors ? self::HAS_ERRORS_CACHE_VALUE : self::NO_ERRORS_CACHE_VALUE,
+            $this->getIdentity(),
+            ['BLOCK_HTML'],
+            self::CACHE_LIFETIME
+        );
+
+        return $hasErrors;
+    }
+
+    /**
+     * Has recent error records
+     *
+     * @return bool
+     */
+    private function hasRecentErrorRecords(): bool
     {
         $periodOfTime = date('Y-m-d H:i:s', strtotime('-24 hours'));
         return (bool) $this->exportQueueCollectionFactory->create()

RELEASELOG.md

@@ -1,3 +1,12 @@
+# v1.1.3
+
+- Fixes
+  - Resolved an issue where system notifications were still displayed when the extension was disabled
+- Additions
+  - Added a new setting to enable or disable system notifications. This setting is enabled by default
+- Improvements
+  - Optimized system notification logic by implementing a 10-minute caching mechanism to reduce redundant executions when admin panel pages are loaded
+  - 
 # v1.1.2
 
 - Changes

System/ConfigProvider.php

@@ -223,6 +223,11 @@ class ConfigProvider
      */
     public const XPATH_USE_STATIC_IPS = 'bloomreach_engagement/general/use_static_ips';
 
+    /**
+     * System notification enabled
+     */
+    public const XPATH_SYSTEM_NOTIFICATIONS_ENABLED = 'bloomreach_engagement/general/system_notifications_enabled';
+
     /**
      * Feed enabled config type
      */
@@ -810,4 +815,14 @@ public function isUseStaticIps(
     ): bool {
         return $this->scopeConfig->isSetFlag(self::XPATH_USE_STATIC_IPS, $scopeType, $scopeCode);
     }
+
+    /**
+     * Get system notifications enabled config
+     *
+     * @return bool
+     */
+    public function isSystemNotificationEnabled(): bool
+    {
+        return $this->scopeConfig->isSetFlag(self::XPATH_SYSTEM_NOTIFICATIONS_ENABLED);
+    }
 }

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "bloomreach/bloomreach-engagement-connector-magento",
-    "version": "1.1.2",
+    "version": "1.1.3",
     "description": "The module provides the Bloomreach integration with Magento 2.",
     "type": "magento2-module",
     "authors": [

doc/user_guide.pdf

@@ -109,6 +109,13 @@
                     </depends>
                     <validate>required-entry validate-zero-or-greater validate-digits</validate>
                 </field>
+                <field id="system_notifications_enabled" translate="label" type="select" sortOrder="120" showInDefault="1">
+                    <label>Enable System Notifications</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    <depends>
+                        <field id="enable">1</field>
+                    </depends>
+                </field>
             </group>
             <group id="http_basic_auth" translate="label" type="text" sortOrder="20" showInDefault="1">
                 <label>HTTP Basic Authentication</label>

etc/adminhtml/system.xml

@@ -16,6 +16,7 @@
                 <request_timeout>60</request_timeout>
                 <retry_base_wait_time>60</retry_base_wait_time>
                 <retry_max_wait_time>240</retry_max_wait_time>
+                <system_notifications_enabled>1</system_notifications_enabled>
             </general>
             <http_basic_auth>
                 <enabled>0</enabled>

etc/config.xml

@@ -7,5 +7,5 @@
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
-    <module name="Bloomreach_EngagementConnector" setup_version="1.1.2"/>
+    <module name="Bloomreach_EngagementConnector" setup_version="1.1.3"/>
 </config>