magento2-login-as-customer/issues/104: Global refactoring

naydav · naydav · commit b179a935cba1 · 2020-04-28T00:43:05.000-05:00
- Builds fixes
diff --git a/app/code/Magento/LoginAsCustomer/Cron/DeleteExpiredAuthenticationData.php b/app/code/Magento/LoginAsCustomer/Cron/DeleteExpiredAuthenticationData.php
@@ -11,7 +11,7 @@
 use Magento\LoginAsCustomerApi\Api\DeleteExpiredAuthenticationDataInterface;
 
 /**
- * elete expired authentication data cron task
+ * Delete expired authentication data cron task
  */
 class DeleteExpiredAuthenticationData
 {
@@ -38,7 +38,7 @@ public function __construct(
     }
 
     /**
-     * elete expired authentication data
+     * Delete expired authentication data
      */
     public function execute(): void
     {
diff --git a/app/code/Magento/LoginAsCustomer/Model/AuthenticateCustomer.php b/app/code/Magento/LoginAsCustomer/Model/AuthenticateCustomer.php
@@ -14,6 +14,8 @@
 
 /**
  * @inheritdoc
+ *
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  */
 class AuthenticateCustomer implements AuthenticateCustomerInterface
 {
diff --git a/app/code/Magento/LoginAsCustomer/Model/AuthenticationData.php b/app/code/Magento/LoginAsCustomer/Model/AuthenticationData.php
@@ -46,15 +46,15 @@ public function __construct(
     }
 
     /**
-     * @return int
+     * @inheritdoc
      */
     public function getCustomerId(): int
     {
         return $this->customerId;
     }
 
     /**
-     * @return int
+     * @inheritdoc
      */
     public function getAdminId(): int
     {
diff --git a/app/code/Magento/LoginAsCustomerLog/Model/Login.php b/app/code/Magento/LoginAsCustomerLog/Model/Login.php
@@ -13,9 +13,7 @@
 class Login extends \Magento\Framework\Model\AbstractModel
 {
     /**
-     * Initialize resource model
-     *
-     * @return void
+     * @inheritdoc
      */
     protected function _construct()
     {
diff --git a/app/code/Magento/LoginAsCustomerLog/Model/ResourceModel/Login.php b/app/code/Magento/LoginAsCustomerLog/Model/ResourceModel/Login.php
@@ -13,10 +13,7 @@
 class Login extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 {
     /**
-     * Initialize resource model
-     * Get tablename from config
-     *
-     * @return void
+     * @inheritdoc
      */
     protected function _construct()
     {
diff --git a/app/code/Magento/LoginAsCustomerLog/Model/ResourceModel/Login/Collection.php b/app/code/Magento/LoginAsCustomerLog/Model/ResourceModel/Login/Collection.php
@@ -13,10 +13,7 @@
 class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
 {
     /**
-     * Constructor
-     * Configures collection
-     *
-     * @return void
+     * @inheritdoc
      */
     protected function _construct()
     {
diff --git a/app/code/Magento/LoginAsCustomerLog/Model/ResourceModel/Login/Grid/Collection.php b/app/code/Magento/LoginAsCustomerLog/Model/ResourceModel/Login/Grid/Collection.php
@@ -13,10 +13,7 @@
 class Collection extends \Magento\LoginAsCustomerLog\Model\ResourceModel\Login\Collection
 {
     /**
-     * Constructor
-     * Configures collection
-     *
-     * @return void
+     * @inheritdoc
      */
     protected function _construct()
     {
diff --git a/app/code/Magento/LoginAsCustomerPageCache/Plugin/PageCache/Model/Config/DisablePageCacheIfNeededPlugin.php b/app/code/Magento/LoginAsCustomerPageCache/Plugin/PageCache/Model/Config/DisablePageCacheIfNeededPlugin.php
@@ -14,6 +14,8 @@
 
 /**
  * Disable PageCache if enabled corresponding option in configuration
+ *
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  */
 class DisablePageCacheIfNeededPlugin
 {
diff --git a/app/code/Magento/LoginAsCustomerSales/Plugin/AdminAddCommentOnOrderPlacementPlugin.php b/app/code/Magento/LoginAsCustomerSales/Plugin/AdminAddCommentOnOrderPlacementPlugin.php
@@ -12,6 +12,8 @@
 
 /**
  * Add comment after order placed by admin using admin panel.
+ *
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  */
 class AdminAddCommentOnOrderPlacementPlugin
 {
diff --git a/app/code/Magento/LoginAsCustomerSales/Plugin/AuthenticateCustomerPlugin.php b/app/code/Magento/LoginAsCustomerSales/Plugin/AuthenticateCustomerPlugin.php
@@ -15,7 +15,11 @@
 use Magento\LoginAsCustomerApi\Api\Data\AuthenticationDataInterface;
 
 /**
- * Class AuthenticateCustomer Plugin
+ * \Magento\LoginAsCustomerApi\Api\AuthenticateCustomerInterface Plugin
+ *
+ * Remove all items from guest shopping cart before execute. Mark customer cart as not-guest after execute
+ *
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  */
 class AuthenticateCustomerPlugin
 {
diff --git a/app/code/Magento/LoginAsCustomerSales/Plugin/FrontAddCommentOnOrderPlacementPlugin.php b/app/code/Magento/LoginAsCustomerSales/Plugin/FrontAddCommentOnOrderPlacementPlugin.php
@@ -13,6 +13,8 @@
 
 /**
  * Add comment after order placed by admin using login-as-customer.
+ *
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  */
 class FrontAddCommentOnOrderPlacementPlugin
 {
diff --git a/app/code/Magento/LoginAsCustomerSales/composer.json b/app/code/Magento/LoginAsCustomerSales/composer.json
@@ -12,7 +12,7 @@
         "magento/module-user": "*"
     },
     "suggest": {
-        "magento/sales": "*",
+        "magento/module-sales": "*",
         "magento/module-login-as-customer-api": "*"
     },
     "type": "magento2-module",
diff --git a/app/code/Magento/LoginAsCustomerUi/Controller/Adminhtml/Login/Login.php b/app/code/Magento/LoginAsCustomerUi/Controller/Adminhtml/Login/Login.php
@@ -150,6 +150,8 @@ public function execute(): ResultInterface
     }
 
     /**
+     * Get login proceed redirect url
+     *
      * @param string $secret
      * @param int|null $storeId
      * @return string
diff --git a/app/code/Magento/LoginAsCustomerUi/Model/Config/Source/StoreViewLogin.php b/app/code/Magento/LoginAsCustomerUi/Model/Config/Source/StoreViewLogin.php
@@ -8,7 +8,7 @@
 namespace Magento\LoginAsCustomerUi\Model\Config\Source;
 
 /**
- * Class StoreViewLogin
+ * @inheritdoc
  */
 class StoreViewLogin implements \Magento\Framework\Data\OptionSourceInterface
 {
@@ -23,9 +23,7 @@ class StoreViewLogin implements \Magento\Framework\Data\OptionSourceInterface
     private const MANUAL = 1;
 
     /**
-     * Options int
-     *
-     * @return array
+     * @inheritdoc
      */
     public function toOptionArray(): array
     {
diff --git a/app/code/Magento/LoginAsCustomerUi/ViewModel/Configuration.php b/app/code/Magento/LoginAsCustomerUi/ViewModel/Configuration.php
@@ -8,22 +8,20 @@
 namespace Magento\LoginAsCustomerUi\ViewModel;
 
 use Magento\Customer\Model\Context;
+use Magento\LoginAsCustomer\Model\Config;
 use Magento\LoginAsCustomerApi\Api\ConfigInterface;
 
 /**
  * View model to get extension configuration in the template
  */
 class Configuration implements \Magento\Framework\View\Element\Block\ArgumentInterface
 {
-
     /**
-     * @var \Magento\LoginAsCustomer\Model\Config
+     * @var Config
      */
     private $config;
 
     /**
-     * Customer session
-     *
      * @var \Magento\Framework\App\Http\Context
      */
     private $httpContext;
@@ -42,6 +40,7 @@ public function __construct(
 
     /**
      * Retrieve true if login as a customer is enabled
+     *
      * @return bool
      */
     public function isEnabled(): bool
diff --git a/app/code/Magento/LoginAsCustomerUi/view/frontend/templates/html/notices.phtml b/app/code/Magento/LoginAsCustomerUi/view/frontend/templates/html/notices.phtml
@@ -8,13 +8,14 @@
  * @var \Magento\Framework\View\Element\Template $block
  * @var \Magento\Framework\Escaper $escaper
  */
+$viewFileUrl = $block->getViewFileUrl('Magento_LoginAsCustomerUi::images/magento-icon.svg');
 ?>
 <?php if ($block->getConfig()->isEnabled()) : ?>
     <div  data-bind="scope: 'loginAsCustomer'" >
         <div class="lac-notification clearfix" data-bind="visible: isVisible" style="display: none">
             <div class="top-container">
                 <div class="lac-notification-icon wrapper">
-                    <img class="logo-img" src="<?= $escaper->escapeUrl($block->getViewFileUrl('Magento_LoginAsCustomerUi::images/magento-icon.svg')) ?>" alt="Magento" />
+                    <img class="logo-img"  src="<?= $escaper->escapeUrl($viewFileUrl) ?>" alt="Magento" />
                 </div>
                 <div class="lac-notification-text wrapper">
                     <span data-bind="html: notificationText"></span>
diff --git a/app/code/Magento/LoginAsCustomerUi/view/frontend/templates/html/notices/logout-link.phtml b/app/code/Magento/LoginAsCustomerUi/view/frontend/templates/html/notices/logout-link.phtml
@@ -14,7 +14,8 @@ if ($block->isLoggedIn()) {
 }
 ?>
 
-<a class="lac-notification-close-link" <?= /* @noEscape */ $block->getLinkAttributes() ?><?= /* @noEscape */ $dataPostParam ?>>
+<a class="lac-notification-close-link" <?= /* @noEscape */ $block->getLinkAttributes()
+?><?= /* @noEscape */ $dataPostParam ?>>
     <?= $escaper->escapeHtml(__('Close Session')) ?>
 </a>
 
diff --git a/app/code/Magento/LoginAsCustomerUi/view/frontend/templates/login.phtml b/app/code/Magento/LoginAsCustomerUi/view/frontend/templates/login.phtml
@@ -10,7 +10,7 @@
 {
     "*": {
         "Magento_LoginAsCustomerUi/js/login": {
-            "redirectUrl": "<?= $block->getUrl('customer/account/index') ?>"
+            "redirectUrl": "<?= /* @noEscape */ $block->getUrl('customer/account/index') ?>"
         }
     }
 }
diff --git a/app/code/Magento/LoginAsCustomerUi/view/frontend/web/css/source/_module.less b/app/code/Magento/LoginAsCustomerUi/view/frontend/web/css/source/_module.less
@@ -4,64 +4,62 @@
  */
 
 & when (@media-common = true) {
+  .lac-notification {
+    background-color: #373330;
+    color: #fff;
+    font-size: 16px;
 
-    .lac-notification {
-        background-color: #373330;
-        color: #fff;
-        font-size: 16px;
+    .lac-notification-icon {
+      float: left;
+      margin: 10px 25px 10px 10px;
 
-        .lac-notification-icon {
-            float:left;
-            margin: 10px 25px 10px 10px;
+      .logo-img {
+        display: block
+      }
+    }
 
-            .logo-img {
-                display: block
-            }
-        }
+    .lac-notification-text {
+      float: left;
+      padding: 15px 0;
+    }
 
-        .lac-notification-text {
-            float:left;
-            padding: 15px 0;
-        }
+    .lac-notification-links {
+      float: right;
+      padding: 15px 0;
 
-        .lac-notification-links {
-            float: right;
-            padding: 15px 0;
-            a {
-                color:#fff;
-                font-size: 14px;
-            }
+      a {
+        color: #fff;
+        font-size: 14px;
+      }
 
-            .lac-notification-close-link {
-                &:after {
-                    content: ' ';
-                    vertical-align: middle;
-                    display: inline-block;
-                    background: url('../Magento_LoginAsCustomerUi/images/close.svg');
-                    height: 12px;
-                    width: 12px;
-                    margin-left: 5px;
-                }
-            }
+      .lac-notification-close-link {
+        &:after {
+          content: ' ';
+          background: url('../Magento_LoginAsCustomerUi/images/close.svg');
+          display: inline-block;
+          height: 12px;
+          margin-left: 5px;
+          vertical-align: middle;
+          width: 12px;
         }
+      }
     }
+  }
 }
 
-
 .media-width(@extremum, @break) when (@extremum = 'max') and (@break = @screen__m) {
-    .lac-notification {
-        padding: 5px 0;
-
-        .lac-notification-icon {
-            display: none;
-        }
+  .lac-notification {
+    padding: 5px 0;
 
-        .lac-notification-text,
-        .lac-notification-links {
-            float: none;
-            text-align: center;
-            padding: 5px 0;
-        }
+    .lac-notification-icon {
+      display: none;
+    }
 
+    .lac-notification-text,
+    .lac-notification-links {
+      float: none;
+      padding: 5px 0;
+      text-align: center;
     }
+  }
 }
diff --git a/dev/tests/static/testsuite/Magento/Test/Integrity/Magento/Framework/Api/_files/ExtensibleInterfacesTest/blacklist_ce.txt b/dev/tests/static/testsuite/Magento/Test/Integrity/Magento/Framework/Api/_files/ExtensibleInterfacesTest/blacklist_ce.txt
@@ -1,4 +1,5 @@
 module Magento_Payment Model/Info.php
 module Magento_Customer Model/Address/AbstractAddress.php
 library magento/framework MessageQueue/Rpc/Publisher.php
-module Magento_GraphQl Model/Query/ContextInterface.php
+module Magento_GraphQl Model/Query/ContextInterface.php
+module Magento_LoginAsCustomerApi Api/Data/AuthenticationDataInterface.php

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`use Magento\LoginAsCustomerApi\Api\DeleteExpiredAuthenticationDataInterface;`
`12`	`12`
`13`	`13`	`/**`
`14`		`- * elete expired authentication data cron task`
	`14`	`+ * Delete expired authentication data cron task`
`15`	`15`	`*/`
`16`	`16`	`class DeleteExpiredAuthenticationData`
`17`	`17`	`{`
`@@ -38,7 +38,7 @@ public function __construct(`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`/**`
`41`		`- * elete expired authentication data`
	`41`	`+ * Delete expired authentication data`
`42`	`42`	`*/`
`43`	`43`	`public function execute(): void`
`44`	`44`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@`
`14`	`14`
`15`	`15`	`/**`
`16`	`16`	`* @inheritdoc`
	`17`	`+ *`
	`18`	`+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)`
`17`	`19`	`*/`
`18`	`20`	`class AuthenticateCustomer implements AuthenticateCustomerInterface`
`19`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,15 +46,15 @@ public function __construct(`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`/**`
`49`		`- * @return int`
	`49`	`+ * @inheritdoc`
`50`	`50`	`*/`
`51`	`51`	`public function getCustomerId(): int`
`52`	`52`	`{`
`53`	`53`	`return $this->customerId;`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`/**`
`57`		`- * @return int`
	`57`	`+ * @inheritdoc`
`58`	`58`	`*/`
`59`	`59`	`public function getAdminId(): int`
`60`	`60`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,7 @@`
`13`	`13`	`class Login extends \Magento\Framework\Model\AbstractModel`
`14`	`14`	`{`
`15`	`15`	`/**`
`16`		`- * Initialize resource model`
`17`		`- *`
`18`		`- * @return void`
	`16`	`+ * @inheritdoc`
`19`	`17`	`*/`
`20`	`18`	`protected function _construct()`
`21`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,10 +13,7 @@`
`13`	`13`	`class Login extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb`
`14`	`14`	`{`
`15`	`15`	`/**`
`16`		`- * Initialize resource model`
`17`		`- * Get tablename from config`
`18`		`- *`
`19`		`- * @return void`
	`16`	`+ * @inheritdoc`
`20`	`17`	`*/`
`21`	`18`	`protected function _construct()`
`22`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	`* Add comment after order placed by admin using admin panel.`
	`15`	`+ *`
	`16`	`+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)`
`15`	`17`	`*/`
`16`	`18`	`class AdminAddCommentOnOrderPlacementPlugin`
`17`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@`
`13`	`13`
`14`	`14`	`/**`
`15`	`15`	`* Add comment after order placed by admin using login-as-customer.`
	`16`	`+ *`
	`17`	`+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)`
`16`	`18`	`*/`
`17`	`19`	`class FrontAddCommentOnOrderPlacementPlugin`
`18`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -150,6 +150,8 @@ public function execute(): ResultInterface`
`150`	`150`	`}`
`151`	`151`
`152`	`152`	`/**`
	`153`	`+ * Get login proceed redirect url`
	`154`	`+ *`
`153`	`155`	`* @param string $secret`
`154`	`156`	`* @param int\|null $storeId`
`155`	`157`	`* @return string`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,8 @@ if ($block->isLoggedIn()) {`
`14`	`14`	`}`
`15`	`15`	`?>`
`16`	`16`
`17`		`-<a class="lac-notification-close-link" <?= /* @noEscape / $block->getLinkAttributes() ?><?= / @noEscape */ $dataPostParam ?>>`
	`17`	`+<a class="lac-notification-close-link" <?= /* @noEscape */ $block->getLinkAttributes()`
	`18`	`+?><?= /* @noEscape */ $dataPostParam ?>>`
`18`	`19`	`<?= $escaper->escapeHtml(__('Close Session')) ?>`
`19`	`20`	`</a>`
`20`	`21`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`{`
`11`	`11`	`"*": {`
`12`	`12`	`"Magento_LoginAsCustomerUi/js/login": {`
`13`		`- "redirectUrl": "<?= $block->getUrl('customer/account/index') ?>"`
	`13`	`+ "redirectUrl": "<?= /* @noEscape */ $block->getUrl('customer/account/index') ?>"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`