MC-15298: Allow admin to opt out of admin analytics tracking - Updated files based on review

Author: michellbrito

app/code/Magento/AdminAnalytics/Block/Metadata.php

@@ -5,8 +5,8 @@
  */
 namespace Magento\AdminAnalytics\Block;
 
-use Magento\Framework\View\Element\Template;
-use Magento\Framework\View\Element\Template\Context;
+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;

app/code/Magento/AdminAnalytics/Block/Notification.php

@@ -27,7 +27,6 @@ class Notification implements ArgumentInterface
     private $canViewNotificationRelease;
 
     /**
-     * Notification constructor.
      * @param AdminAnalyticsNotification $canViewNotificationAnalytics
      * @param ReleaseNotification $canViewNotificationRelease
      */

app/code/Magento/AdminAnalytics/Controller/Adminhtml/Config/DisableAdminUsage.php

@@ -38,10 +38,10 @@ class DisableAdminUsage extends Action implements HttpPostActionInterface
     /**
      * DisableAdminUsage constructor.
      *
-     * @param Action\Context           $context
+     * @param Action\Context $context
      * @param ProductMetadataInterface $productMetadata
-     * @param NotificationLogger       $notificationLogger
-     * @param Factory                  $configFactory
+     * @param NotificationLogger $notificationLogger
+     * @param Factory $configFactory
      */
     public function __construct(
         Action\Context $context,
@@ -56,7 +56,7 @@ public function __construct(
     }
 
     /**
-     * Changes the value of config/admin/usage/enabled
+     * Change the value of config/admin/usage/enabled
      */
     private function disableAdminUsage()
     {
@@ -70,7 +70,7 @@ private function disableAdminUsage()
      *
      * @return ResultInterface
      */
-    private function markUserNotified() : ResultInterface
+    private function markUserNotified(): ResultInterface
     {
         $responseContent = [
             'success' => $this->notificationLogger->log(

app/code/Magento/AdminAnalytics/Controller/Adminhtml/Config/EnableAdminUsage.php

@@ -36,12 +36,10 @@ class EnableAdminUsage extends Action implements HttpPostActionInterface
     private $notificationLogger;
 
     /**
-     * MarkUserNotified constructor.
-     *
-     * @param Action\Context           $context
+     * @param Action\Context $context
      * @param ProductMetadataInterface $productMetadata
-     * @param NotificationLogger       $notificationLogger
-     * @param Factory                  $configFactory
+     * @param NotificationLogger $notificationLogger
+     * @param Factory $configFactory
      */
     public function __construct(
         Action\Context $context,
@@ -56,7 +54,7 @@ public function __construct(
     }
 
     /**
-     * Changes the value of config/admin/usage/enabled
+     * Change the value of config/admin/usage/enabled
      */
     private function enableAdminUsage()
     {
@@ -70,7 +68,7 @@ private function enableAdminUsage()
      *
      * @return ResultInterface
      */
-    private function markUserNotified() : ResultInterface
+    private function markUserNotified(): ResultInterface
     {
         $responseContent = [
             'success' => $this->notificationLogger->log(

app/code/Magento/AdminAnalytics/Model/Condition/CanViewNotification.php

@@ -12,7 +12,7 @@
 use Magento\Framework\App\CacheInterface;
 
 /**
- * Dynamic validator for UI admin analytics notification, manage UI component visibility.
+ * Dynamic validator for UI admin analytics notification, control UI component visibility.
  */
 class CanViewNotification implements VisibilityConditionInterface
 {
@@ -41,7 +41,7 @@ class CanViewNotification implements VisibilityConditionInterface
     private $cacheStorage;
 
     /**
-     * @param Logger         $viewerLogger
+     * @param Logger $viewerLogger
      * @param CacheInterface $cacheStorage
      */
     public function __construct(

app/code/Magento/AdminAnalytics/Model/ResourceModel/Viewer/Logger.php

@@ -51,7 +51,7 @@ public function __construct(
      * @param string $lastViewVersion
      * @return bool
      */
-    public function log(string $lastViewVersion) : bool
+    public function log(string $lastViewVersion): bool
     {
         /** @var \Magento\Framework\DB\Adapter\AdapterInterface $connection */
         $connection = $this->resource->getConnection(ResourceConnection::DEFAULT_CONNECTION);
@@ -72,7 +72,7 @@ public function log(string $lastViewVersion) : bool
      *
      * @return Log
      */
-    public function get() : Log
+    public function get(): Log
     {
         return $this->logFactory->create(['data' => $this->loadLatestLogData()]);
     }
@@ -82,7 +82,7 @@ public function get() : Log
      *
      * @return boolean
      */
-    public function checkLogExists() : bool
+    public function checkLogExists(): bool
     {
         $data = $this->logFactory->create(['data' => $this->loadLatestLogData()]);
         $lastViewedVersion = $data->getLastViewVersion();
@@ -94,7 +94,7 @@ public function checkLogExists() : bool
      *
      * @return array
      */
-    private function loadLatestLogData() : array
+    private function loadLatestLogData(): array
     {
         $connection = $this->resource->getConnection();
         $select = $connection->select()

app/code/Magento/AdminAnalytics/README.md

@@ -1 +1 @@
-The purpose of Magento\AdminAnalytics module is gather information on which features the users uses and sends it to adobe analytics
+The purpose of Magento\AdminAnalytics module is to gather information on which features the admins use, to help improve Magento admin experience.

app/code/Magento/AdminAnalytics/Test/Mftf/Section/AdminUsageConfigSection.xml

@@ -9,7 +9,6 @@
 <sections xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:noNamespaceSchemaLocation="urn:magento:mftf:Page/etc/SectionObject.xsd">
     <section name="AdminUsageConfigSection">
-
         <element name="adminUsageHeader" type="text" selector="#admin_usage-head"/>
         <element name="adminUsageOptions" type="select" selector="#admin_usage_enabled"/>
     </section>