Merge pull request #5480 from magento-trigger/MC-32086

[TR] [AR] Report account is unavailable after URL change
magento · Mar 24, 2020 · 9ba1009 · 9ba1009
2 parents fa1a862 + 421048c
commit 9ba1009
Show file tree

Hide file tree

Showing 11 changed files with 594 additions and 68 deletions.
diff --git a/app/code/Magento/Analytics/Cron/SignUp.php b/app/code/Magento/Analytics/Cron/SignUp.php
@@ -7,6 +7,7 @@
 
 use Magento\Analytics\Model\Config\Backend\Enabled\SubscriptionHandler;
 use Magento\Analytics\Model\Connector;
+use Magento\Framework\Exception\NotFoundException;
 use Magento\Framework\FlagManager;
 use Magento\Framework\App\Config\ReinitableConfigInterface;
 use Magento\Framework\App\Config\Storage\WriterInterface;
@@ -57,22 +58,24 @@ public function __construct(
     }
 
     /**
-     * Execute scheduled subscription operation
+     * Execute scheduled subscription operation.
+     *
      * In case of failure writes message to notifications inbox
      *
      * @return bool
+     * @throws NotFoundException
      */
     public function execute()
     {
-        $attemptsCount = $this->flagManager->getFlagData(SubscriptionHandler::ATTEMPTS_REVERSE_COUNTER_FLAG_CODE);
+        $attemptsCount = (int)$this->flagManager->getFlagData(SubscriptionHandler::ATTEMPTS_REVERSE_COUNTER_FLAG_CODE);
 
-        if (($attemptsCount === null) || ($attemptsCount <= 0)) {
+        if ($attemptsCount <= 0) {
             $this->deleteAnalyticsCronExpr();
             $this->flagManager->deleteFlag(SubscriptionHandler::ATTEMPTS_REVERSE_COUNTER_FLAG_CODE);
             return false;
         }
 
-        $attemptsCount -= 1;
+        $attemptsCount--;
         $this->flagManager->saveFlag(SubscriptionHandler::ATTEMPTS_REVERSE_COUNTER_FLAG_CODE, $attemptsCount);
         $signUpResult = $this->connector->execute('signUp');
         if ($signUpResult === false) {

diff --git a/app/code/Magento/Analytics/Cron/Update.php b/app/code/Magento/Analytics/Cron/Update.php
@@ -8,6 +8,7 @@
 use Magento\Analytics\Model\AnalyticsToken;
 use Magento\Analytics\Model\Config\Backend\Baseurl\SubscriptionUpdateHandler;
 use Magento\Analytics\Model\Connector;
+use Magento\Framework\Exception\NotFoundException;
 use Magento\Framework\FlagManager;
 use Magento\Framework\App\Config\ReinitableConfigInterface;
 use Magento\Framework\App\Config\Storage\WriterInterface;
@@ -67,26 +68,37 @@ public function __construct(
      * Execute scheduled update operation
      *
      * @return bool
+     * @throws NotFoundException
      */
     public function execute()
     {
         $result = false;
-        $attemptsCount = $this->flagManager
+        $attemptsCount = (int)$this->flagManager
             ->getFlagData(SubscriptionUpdateHandler::SUBSCRIPTION_UPDATE_REVERSE_COUNTER_FLAG_CODE);
 
-        if ($attemptsCount) {
-            $attemptsCount -= 1;
+        if (($attemptsCount > 0) && $this->analyticsToken->isTokenExist()) {
+            $attemptsCount--;
+            $this->flagManager
+                ->saveFlag(SubscriptionUpdateHandler::SUBSCRIPTION_UPDATE_REVERSE_COUNTER_FLAG_CODE, $attemptsCount);
             $result = $this->connector->execute('update');
         }
 
         if ($result || ($attemptsCount <= 0) || (!$this->analyticsToken->isTokenExist())) {
-            $this->flagManager
-                ->deleteFlag(SubscriptionUpdateHandler::SUBSCRIPTION_UPDATE_REVERSE_COUNTER_FLAG_CODE);
-            $this->flagManager->deleteFlag(SubscriptionUpdateHandler::PREVIOUS_BASE_URL_FLAG_CODE);
-            $this->configWriter->delete(SubscriptionUpdateHandler::UPDATE_CRON_STRING_PATH);
-            $this->reinitableConfig->reinit();
+            $this->exitFromUpdateProcess();
         }
 
         return $result;
     }
+
+    /**
+     * Clean-up flags and refresh configuration
+     */
+    private function exitFromUpdateProcess(): void
+    {
+        $this->flagManager
+            ->deleteFlag(SubscriptionUpdateHandler::SUBSCRIPTION_UPDATE_REVERSE_COUNTER_FLAG_CODE);
+        $this->flagManager->deleteFlag(SubscriptionUpdateHandler::PREVIOUS_BASE_URL_FLAG_CODE);
+        $this->configWriter->delete(SubscriptionUpdateHandler::UPDATE_CRON_STRING_PATH);
+        $this->reinitableConfig->reinit();
+    }
 }
diff --git a/app/code/Magento/Analytics/Setup/Patch/Data/ActivateDataCollection.php b/app/code/Magento/Analytics/Setup/Patch/Data/ActivateDataCollection.php
@@ -0,0 +1,95 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\Analytics\Setup\Patch\Data;
+
+use Magento\Analytics\Model\Config\Backend\CollectionTime;
+use Magento\Analytics\Model\SubscriptionStatusProvider;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Setup\Patch\DataPatchInterface;
+
+/**
+ * Activate data collection mechanism
+ */
+class ActivateDataCollection implements DataPatchInterface
+{
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
+    /**
+     * @var SubscriptionStatusProvider
+     */
+    private $subscriptionStatusProvider;
+
+    /**
+     * @var string
+     */
+    private $analyticsCollectionTimeConfigPath = 'analytics/general/collection_time';
+
+    /**
+     * @var CollectionTime
+     */
+    private $collectionTimeBackendModel;
+
+    /**
+     * @param ScopeConfigInterface $scopeConfig
+     * @param SubscriptionStatusProvider $subscriptionStatusProvider
+     * @param CollectionTime $collectionTimeBackendModel
+     */
+    public function __construct(
+        ScopeConfigInterface $scopeConfig,
+        SubscriptionStatusProvider $subscriptionStatusProvider,
+        CollectionTime $collectionTimeBackendModel
+    ) {
+        $this->scopeConfig = $scopeConfig;
+        $this->subscriptionStatusProvider = $subscriptionStatusProvider;
+        $this->collectionTimeBackendModel = $collectionTimeBackendModel;
+    }
+
+    /**
+     * @inheritDoc
+     *
+     * @throws LocalizedException
+     */
+    public function apply()
+    {
+        $subscriptionStatus = $this->subscriptionStatusProvider->getStatus();
+        $isCollectionProcessActivated = $this->scopeConfig->getValue(CollectionTime::CRON_SCHEDULE_PATH);
+        if ($subscriptionStatus !== $this->subscriptionStatusProvider->getStatusForDisabledSubscription()
+            && !$isCollectionProcessActivated
+        ) {
+            $this->collectionTimeBackendModel
+                ->setValue($this->scopeConfig->getValue($this->analyticsCollectionTimeConfigPath));
+            $this->collectionTimeBackendModel->setPath($this->analyticsCollectionTimeConfigPath);
+            $this->collectionTimeBackendModel->afterSave();
+        }
+
+        return $this;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getAliases()
+    {
+        return [];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function getDependencies()
+    {
+        return [
+            PrepareInitialConfig::class,
+        ];
+    }
+}
diff --git a/app/code/Magento/Analytics/Setup/Patch/Data/PrepareInitialConfig.php b/app/code/Magento/Analytics/Setup/Patch/Data/PrepareInitialConfig.php
@@ -4,17 +4,18 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\Analytics\Setup\Patch\Data;
 
 use Magento\Analytics\Model\Config\Backend\Enabled\SubscriptionHandler;
+use Magento\Config\Model\Config\Source\Enabledisable;
 use Magento\Framework\Setup\ModuleDataSetupInterface;
 use Magento\Framework\Setup\Patch\DataPatchInterface;
 use Magento\Framework\Setup\Patch\PatchVersionInterface;
 
 /**
- * Initial patch.
- *
- * @package Magento\Analytics\Setup\Patch
+ * Active subscription process for Advanced Reporting
  */
 class PrepareInitialConfig implements DataPatchInterface, PatchVersionInterface
 {
@@ -24,66 +25,63 @@ class PrepareInitialConfig implements DataPatchInterface, PatchVersionInterface
     private $moduleDataSetup;
 
     /**
-     * PrepareInitialConfig constructor.
+     * @var SubscriptionHandler
+     */
+    private $subscriptionHandler;
+
+    /**
+     * @var string
+     */
+    private $subscriptionEnabledConfigPath = 'analytics/subscription/enabled';
+
+    /**
      * @param ModuleDataSetupInterface $moduleDataSetup
+     * @param SubscriptionHandler $subscriptionHandler
      */
     public function __construct(
-        ModuleDataSetupInterface $moduleDataSetup
+        ModuleDataSetupInterface $moduleDataSetup,
+        SubscriptionHandler $subscriptionHandler
     ) {
         $this->moduleDataSetup = $moduleDataSetup;
+        $this->subscriptionHandler = $subscriptionHandler;
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function apply()
     {
-        $this->moduleDataSetup->getConnection()->insertMultiple(
+        $this->moduleDataSetup->getConnection()->insert(
             $this->moduleDataSetup->getTable('core_config_data'),
             [
-                [
-                    'scope' => 'default',
-                    'scope_id' => 0,
-                    'path' => 'analytics/subscription/enabled',
-                    'value' => 1
-                ],
-                [
-                    'scope' => 'default',
-                    'scope_id' => 0,
-                    'path' => SubscriptionHandler::CRON_STRING_PATH,
-                    'value' => join(' ', SubscriptionHandler::CRON_EXPR_ARRAY)
-                ]
+                'path' => $this->subscriptionEnabledConfigPath,
+                'value' => Enabledisable::ENABLE_VALUE,
             ]
         );
 
-        $this->moduleDataSetup->getConnection()->insert(
-            $this->moduleDataSetup->getTable('flag'),
-            [
-                'flag_code' => SubscriptionHandler::ATTEMPTS_REVERSE_COUNTER_FLAG_CODE,
-                'state' => 0,
-                'flag_data' => 24,
-            ]
-        );
+        $this->subscriptionHandler->processEnabled();
+
+        return $this;
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public static function getDependencies()
     {
         return [];
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public static function getVersion()
     {
         return '2.0.0';
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function getAliases()
     {

diff --git a/app/code/Magento/Analytics/Test/Unit/Cron/UpdateTest.php b/app/code/Magento/Analytics/Test/Unit/Cron/UpdateTest.php
@@ -11,6 +11,7 @@
 use Magento\Analytics\Model\Connector;
 use Magento\Framework\App\Config\ReinitableConfigInterface;
 use Magento\Framework\App\Config\Storage\WriterInterface;
+use Magento\Framework\Exception\NotFoundException;
 use Magento\Framework\FlagManager;
 
 class UpdateTest extends \PHPUnit\Framework\TestCase
@@ -45,6 +46,9 @@ class UpdateTest extends \PHPUnit\Framework\TestCase
      */
     private $update;
 
+    /**
+     * @inheritDoc
+     */
     protected function setUp()
     {
         $this->connectorMock =  $this->getMockBuilder(Connector::class)
@@ -74,6 +78,7 @@ protected function setUp()
 
     /**
      * @return void
+     * @throws NotFoundException
      */
     public function testExecuteWithoutToken()
     {
@@ -82,12 +87,12 @@ public function testExecuteWithoutToken()
             ->with(SubscriptionUpdateHandler::SUBSCRIPTION_UPDATE_REVERSE_COUNTER_FLAG_CODE)
             ->willReturn(10);
         $this->connectorMock
-            ->expects($this->once())
+            ->expects($this->never())
             ->method('execute')
             ->with('update')
             ->willReturn(false);
         $this->analyticsTokenMock
-            ->expects($this->once())
+            ->expects($this->any())
             ->method('isTokenExist')
             ->willReturn(false);
         $this->addFinalOutputAsserts();
@@ -120,6 +125,7 @@ private function addFinalOutputAsserts(bool $isExecuted = true)
      * @param $counterData
      * @return void
      * @dataProvider executeWithEmptyReverseCounterDataProvider
+     * @throws NotFoundException
      */
     public function testExecuteWithEmptyReverseCounter($counterData)
     {
@@ -159,6 +165,7 @@ public function executeWithEmptyReverseCounterDataProvider()
      * @param bool $functionResult
      * @return void
      * @dataProvider executeRegularScenarioDataProvider
+     * @throws NotFoundException
      */
     public function testExecuteRegularScenario(
         int $reverseCount,
@@ -170,6 +177,10 @@ public function testExecuteRegularScenario(
             ->method('getFlagData')
             ->with(SubscriptionUpdateHandler::SUBSCRIPTION_UPDATE_REVERSE_COUNTER_FLAG_CODE)
             ->willReturn($reverseCount);
+        $this->flagManagerMock
+            ->expects($this->once())
+            ->method('saveFlag')
+            ->with(SubscriptionUpdateHandler::SUBSCRIPTION_UPDATE_REVERSE_COUNTER_FLAG_CODE, $reverseCount - 1);
         $this->connectorMock
             ->expects($this->once())
             ->method('execute')

diff --git a/app/code/Magento/Analytics/etc/adminhtml/system.xml b/app/code/Magento/Analytics/etc/adminhtml/system.xml
@@ -28,6 +28,9 @@
                     <label>Time of day to send data</label>
                     <frontend_model>Magento\Analytics\Block\Adminhtml\System\Config\CollectionTimeLabel</frontend_model>
                     <backend_model>Magento\Analytics\Model\Config\Backend\CollectionTime</backend_model>
+                    <depends>
+                        <field id="analytics/general/enabled">1</field>
+                    </depends>
                 </field>
                 <field id="vertical" translate="hint label comment" type="select" sortOrder="30" showInDefault="1" showInWebsite="1">
                     <hint>Industry Data</hint>
@@ -36,9 +39,9 @@
                     <source_model>Magento\Analytics\Model\Config\Source\Vertical</source_model>
                     <backend_model>Magento\Analytics\Model\Config\Backend\Vertical</backend_model>
                     <frontend_model>Magento\Analytics\Block\Adminhtml\System\Config\Vertical</frontend_model>
-					<depends>
-						<field id="analytics/general/enabled">1</field>
-					</depends>
+                    <depends>
+                        <field id="analytics/general/enabled">1</field>
+                    </depends>
                 </field>
                 <field id="additional_comment" translate="label comment" type="label" sortOrder="40" showInDefault="1">
                     <label><![CDATA[<strong>Get more insights from Magento Business Intelligence</strong>]]></label>

diff --git a/app/code/Magento/Analytics/etc/di.xml b/app/code/Magento/Analytics/etc/di.xml
@@ -6,7 +6,7 @@
  */
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
-    <preference for="Magento\Analytics\ReportXML\ConfigInterface" type="Magento\Analytics\ReportXML\Config" />
+    <preference for="Magento\Analytics\ReportXml\ConfigInterface" type="Magento\Analytics\ReportXml\Config" />
     <preference for="Magento\Analytics\Model\ConfigInterface" type="Magento\Analytics\Model\Config" />
     <preference for="Magento\Analytics\Model\ReportWriterInterface" type="Magento\Analytics\Model\ReportWriter" />
     <preference for="Magento\Analytics\Api\LinkProviderInterface" type="Magento\Analytics\Model\LinkProvider" />