MC-15298: Allow admin to opt out of admin analytics tracking

danielrenaud · danielrenaud · commit 912f8c5a9633 · 2019-08-08T16:24:59.000-05:00
diff --git a/app/code/Magento/AdminAnalytics/ViewModel/Metadata.php b/app/code/Magento/AdminAnalytics/ViewModel/Metadata.php
@@ -3,20 +3,17 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-namespace Magento\AdminAnalytics\Block;
+namespace Magento\AdminAnalytics\ViewModel;
 
-use Magento\Backend\Block\Template;
-use Magento\Backend\Block\Template\Context;
 use Magento\Framework\App\ProductMetadataInterface;
 use Magento\Backend\Model\Auth\Session;
 use Magento\Framework\App\State;
+use Magento\Framework\View\Element\Block\ArgumentInterface;
 
 /**
  * Gets user version and mode
- *
- * @api
  */
-class Metadata extends Template
+class Metadata implements ArgumentInterface
 {
     /**
      * @var State
@@ -34,23 +31,18 @@ class Metadata extends Template
     private $productMetadata;
 
     /**
-     * @param Context $context
      * @param ProductMetadataInterface $productMetadata
      * @param Session $authSession
      * @param State $appState
-     * @param array $data
      */
     public function __construct(
-        Context $context,
         ProductMetadataInterface $productMetadata,
         Session $authSession,
-        State $appState,
-        array $data = []
+        State $appState
     ) {
         $this->productMetadata = $productMetadata;
         $this->authSession = $authSession;
         $this->appState = $appState;
-        parent::__construct($context, $data);
     }
 
     /**
diff --git a/app/code/Magento/AdminAnalytics/ViewModel/Notification.php b/app/code/Magento/AdminAnalytics/ViewModel/Notification.php
@@ -5,14 +5,14 @@
  */
 declare(strict_types=1);
 
-namespace Magento\AdminAnalytics\Block;
+namespace Magento\AdminAnalytics\ViewModel;
 
 use Magento\Framework\View\Element\Block\ArgumentInterface;
 use Magento\AdminAnalytics\Model\Condition\CanViewNotification as AdminAnalyticsNotification;
 use Magento\ReleaseNotification\Model\Condition\CanViewNotification as ReleaseNotification;
 
 /**
- * Class Notification
+ * Control display of admin analytics and release notification modals
  */
 class Notification implements ArgumentInterface
 {
diff --git a/app/code/Magento/AdminAnalytics/view/adminhtml/layout/adminhtml_dashboard_index.xml b/app/code/Magento/AdminAnalytics/view/adminhtml/layout/adminhtml_dashboard_index.xml
@@ -14,7 +14,7 @@
             </uiComponent>
             <block name="tracking_notification" as="tracking_notification" template="Magento_AdminAnalytics::notification.phtml">
                 <arguments>
-                    <argument name="notification" xsi:type="object">Magento\AdminAnalytics\Block\Notification</argument>
+                    <argument name="notification" xsi:type="object">Magento\AdminAnalytics\ViewModel\Notification</argument>
                 </arguments>
             </block>
         </referenceContainer>
diff --git a/app/code/Magento/AdminAnalytics/view/adminhtml/layout/default.xml b/app/code/Magento/AdminAnalytics/view/adminhtml/layout/default.xml
@@ -8,9 +8,10 @@
 <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd" >
     <body>
         <referenceContainer name="header">
-            <block class="Magento\AdminAnalytics\Block\Metadata" name="tracking" as="tracking" template="Magento_AdminAnalytics::tracking.phtml" ifconfig="admin/usage/enabled">
+            <block name="tracking" as="tracking" template="Magento_AdminAnalytics::tracking.phtml" ifconfig="admin/usage/enabled">
                 <arguments>
                     <argument name="tracking_url" xsi:type="string">//assets.adobedtm.com/launch-EN30eb7ffa064444f1b8b0368ef38fd3a9.min.js</argument>
+                    <argument name="metadata" xsi:type="object">Magento\AdminAnalytics\ViewModel\Metadata</argument>
                 </arguments>
             </block>
         </referenceContainer>
diff --git a/app/code/Magento/AdminAnalytics/view/adminhtml/templates/tracking.phtml b/app/code/Magento/AdminAnalytics/view/adminhtml/templates/tracking.phtml
@@ -8,8 +8,8 @@
 <script src="<?= $block->escapeUrl($block->getTrackingUrl()) ?>" async></script>
 <script>
     var adminAnalyticsMetadata = {
-        "version": "<?= $block->escapeJs($block->getMagentoVersion()) ?>",
-        "user": "<?= $block->escapeJs($block->getCurrentUser()) ?>",
-        "mode": "<?= $block->escapeJs($block->getMode()) ?>"
+        "version": "<?= $block->escapeJs($block->getMetadata()->getMagentoVersion()) ?>",
+        "user": "<?= $block->escapeJs($block->getMetadata()->getCurrentUser()) ?>",
+        "mode": "<?= $block->escapeJs($block->getMetadata()->getMode()) ?>"
     };
 </script>
