Merge pull request #1781 from sivaschenko/model-view-responsibility-separation

sivaschenko · web-flow · commit 13c22e15d718 · 2020-08-29T17:16:14.000+01:00
[Refactoring] Model view responsibility separation
diff --git a/AdobeStockAdminUi/Controller/Adminhtml/System/Config/TestConnection.php b/AdobeStockAdminUi/Controller/Adminhtml/System/Config/TestConnection.php
@@ -12,15 +12,14 @@
 use Magento\AdobeStockClientApi\Api\ClientInterface;
 use Magento\Backend\App\Action;
 use Magento\Backend\App\Action\Context;
-use Magento\Framework\App\Action\HttpGetActionInterface;
-use Magento\Framework\Controller\Result\Json;
+use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\Framework\Controller\Result\JsonFactory;
 use Magento\Framework\Controller\ResultInterface;
 
 /**
  * Controller used for testing connection to Adobe Stock API from stores configuration
  */
-class TestConnection extends Action implements HttpGetActionInterface
+class TestConnection extends Action implements HttpPostActionInterface
 {
     /**
      * Authorization level of a basic admin session.
@@ -74,7 +73,7 @@ public function __construct(
      *
      * @return ResultInterface
      */
-    public function execute() : ResultInterface
+    public function execute(): ResultInterface
     {
         try {
             $params = $this->getRequest()->getParams();
@@ -89,8 +88,7 @@ public function execute() : ResultInterface
             $isConnectionEstablished = false;
         }
 
-        $resultJson = $this->resultJsonFactory->create();
-        return $resultJson->setData(
+        return $this->resultJsonFactory->create()->setData(
             [
                 'success' => $isConnectionEstablished,
                 'message' => $message->render(),
diff --git a/AdobeStockAdminUi/view/adminhtml/web/js/connection.js b/AdobeStockAdminUi/view/adminhtml/web/js/connection.js
@@ -75,7 +75,7 @@ define([
             this.visible(false);
 
             $.ajax({
-                type: 'GET',
+                type: 'POST',
                 url: this.url,
                 dataType: 'json',
                 data: {
diff --git a/AdobeStockAsset/Model/GetAssetById.php b/AdobeStockAsset/Model/GetAssetById.php
@@ -63,8 +63,7 @@ public function execute(int $adobeId): Document
 
         $items = $this->getAssetList->execute($searchCriteria)->getItems();
         if (empty($items) || 1 < count($items)) {
-            $message = __('Requested image doesn\'t exists');
-            throw new NoSuchEntityException($message);
+            throw new NoSuchEntityException(__('Requested asset does not exist.'));
         }
 
         return reset($items);
diff --git a/AdobeStockAsset/Model/GetAssetList.php b/AdobeStockAsset/Model/GetAssetList.php
@@ -14,7 +14,6 @@
 use Magento\Framework\Api\Search\SearchResultInterface;
 use Magento\Framework\Exception\AuthenticationException;
 use Magento\Framework\Exception\LocalizedException;
-use Magento\Framework\UrlInterface;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -32,11 +31,6 @@ class GetAssetList implements GetAssetListInterface
      */
     private $client;
 
-    /**
-     * @var UrlInterface
-     */
-    private $url;
-
     /**
      * @var LoggerInterface
      */
@@ -45,18 +39,15 @@ class GetAssetList implements GetAssetListInterface
     /**
      * GetAssetList constructor.
      * @param ClientInterface $client
-     * @param UrlInterface $url
      * @param LoggerInterface $log
      * @param AppendAttributes $appendAttributes
      */
     public function __construct(
         ClientInterface $client,
-        UrlInterface $url,
         LoggerInterface $log,
         AppendAttributes $appendAttributes
     ) {
         $this->client = $client;
-        $this->url = $url;
         $this->log = $log;
         $this->appendAttributes = $appendAttributes;
     }
@@ -72,20 +63,7 @@ public function execute(SearchCriteriaInterface $searchCriteria): SearchResultIn
 
             return $searchResult;
         } catch (AuthenticationException $exception) {
-            throw new LocalizedException(
-                __(
-                    'Failed to authenticate to Adobe Stock API. <br> Please correct the API credentials in '
-                    . '<a href="%1">Configuration → System → Adobe Stock Integration.</a>',
-                    $this->url->getUrl(
-                        'adminhtml/system_config/edit',
-                        [
-                            'section' => 'system',
-                            '_fragment' => 'system_adobe_stock_integration-link'
-                        ]
-                    )
-                ),
-                $exception
-            );
+            throw $exception;
         } catch (\Exception $exception) {
             $this->log->critical($exception);
             throw new LocalizedException(
diff --git a/AdobeStockImage/Model/GetRelatedImages.php b/AdobeStockImage/Model/GetRelatedImages.php
@@ -13,6 +13,7 @@
 use Magento\Framework\Api\FilterBuilder;
 use Magento\Framework\Api\Search\Document;
 use Magento\Framework\Api\Search\SearchCriteriaBuilder;
+use Magento\Framework\Exception\AuthenticationException;
 use Magento\Framework\Exception\LocalizedException;
 use Psr\Log\LoggerInterface;
 
@@ -92,6 +93,8 @@ public function execute(int $imageId, int $limit): array
                 );
             }
             return $relatedImageGroups;
+        } catch (AuthenticationException $exception) {
+            throw $exception;
         } catch (\Exception $exception) {
             $this->logger->critical($exception);
             throw new LocalizedException(
diff --git a/AdobeStockImageAdminUi/Controller/Adminhtml/License/License.php b/AdobeStockImageAdminUi/Controller/Adminhtml/License/License.php
@@ -14,6 +14,7 @@
 use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\Framework\Controller\Result\Json;
 use Magento\Framework\Controller\ResultFactory;
+use Magento\Framework\Exception\AuthenticationException;
 use Magento\Framework\Exception\LocalizedException;
 use Psr\Log\LoggerInterface;
 
@@ -90,6 +91,25 @@ public function execute()
                 'success' => true,
                 'message' => __('The image was licensed and saved successfully.'),
             ];
+        } catch (AuthenticationException $exception) {
+            $responseCode = self::HTTP_BAD_REQUEST;
+            $responseContent = [
+                'success' => false,
+                'is_licensed' => $isLicensed,
+                'message' => __(
+                    'Failed to authenticate to Adobe Stock API. <br> Please correct the API credentials in '
+                    . '<a href="%url">Configuration → System → Adobe Stock Integration.</a>',
+                    [
+                        'url' => $this->getUrl(
+                            'adminhtml/system_config/edit',
+                            [
+                                'section' => 'system',
+                                '_fragment' => 'system_adobe_stock_integration-link'
+                            ]
+                        )
+                    ]
+                )
+            ];
         } catch (LocalizedException $exception) {
             $responseCode = self::HTTP_BAD_REQUEST;
             $responseContent = [
diff --git a/AdobeStockImageAdminUi/Controller/Adminhtml/License/SaveLicensed.php b/AdobeStockImageAdminUi/Controller/Adminhtml/License/SaveLicensed.php
@@ -13,6 +13,7 @@
 use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\Framework\Controller\Result\Json;
 use Magento\Framework\Controller\ResultFactory;
+use Magento\Framework\Exception\AuthenticationException;
 use Magento\Framework\Exception\LocalizedException;
 use Psr\Log\LoggerInterface;
 
@@ -74,6 +75,24 @@ public function execute()
                 'success' => true,
                 'message' => __('You have successfully downloaded the licensed image.'),
             ];
+        } catch (AuthenticationException $exception) {
+            $responseCode = self::HTTP_BAD_REQUEST;
+            $responseContent = [
+                'success' => false,
+                'message' => __(
+                    'Failed to authenticate to Adobe Stock API. <br> Please correct the API credentials in '
+                    . '<a href="%url">Configuration → System → Adobe Stock Integration.</a>',
+                    [
+                        'url' => $this->getUrl(
+                            'adminhtml/system_config/edit',
+                            [
+                                'section' => 'system',
+                                '_fragment' => 'system_adobe_stock_integration-link'
+                            ]
+                        )
+                    ]
+                ),
+            ];
         } catch (LocalizedException $exception) {
             $responseCode = self::HTTP_BAD_REQUEST;
             $responseContent = [
diff --git a/AdobeStockImageAdminUi/Controller/Adminhtml/Preview/Download.php b/AdobeStockImageAdminUi/Controller/Adminhtml/Preview/Download.php
@@ -14,6 +14,7 @@
 use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\Framework\Controller\Result\Json;
 use Magento\Framework\Controller\ResultFactory;
+use Magento\Framework\Exception\AuthenticationException;
 use Magento\Framework\Exception\LocalizedException;
 use Psr\Log\LoggerInterface;
 
@@ -87,6 +88,24 @@ public function execute()
                 'success' => true,
                 'message' => __('You have successfully downloaded the image.'),
             ];
+        } catch (AuthenticationException $exception) {
+            $responseCode = self::HTTP_BAD_REQUEST;
+            $responseContent = [
+                'success' => false,
+                'message' => __(
+                    'Failed to authenticate to Adobe Stock API. <br> Please correct the API credentials in '
+                    . '<a href="%url">Configuration → System → Adobe Stock Integration.</a>',
+                    [
+                        'url' => $this->getUrl(
+                            'adminhtml/system_config/edit',
+                            [
+                                'section' => 'system',
+                                '_fragment' => 'system_adobe_stock_integration-link'
+                            ]
+                        )
+                    ]
+                ),
+            ];
         } catch (LocalizedException $exception) {
             $responseCode = self::HTTP_BAD_REQUEST;
             $responseContent = [
diff --git a/AdobeStockImageAdminUi/Controller/Adminhtml/Preview/RelatedImages.php b/AdobeStockImageAdminUi/Controller/Adminhtml/Preview/RelatedImages.php
@@ -12,7 +12,7 @@
 use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\Controller\Result\Json;
 use Magento\Framework\Controller\ResultFactory;
-use Psr\Log\LoggerInterface;
+use Magento\Framework\Exception\AuthenticationException;
 
 /**
  * Controller providing related images (same model and same series) for the provided Adobe Stock asset id
@@ -34,26 +34,18 @@ class RelatedImages extends Action implements HttpGetActionInterface
      */
     private $getRelatedImages;
 
-    /**
-     * @var LoggerInterface
-     */
-    private $logger;
-
     /**
      * RelatedImages constructor.
      *
      * @param Action\Context $context
      * @param GetRelatedImagesInterface $getRelatedImages
-     * @param LoggerInterface $logger
      */
     public function __construct(
         Action\Context $context,
-        GetRelatedImagesInterface $getRelatedImages,
-        LoggerInterface $logger
+        GetRelatedImagesInterface $getRelatedImages
     ) {
         parent::__construct($context);
         $this->getRelatedImages = $getRelatedImages;
-        $this->logger = $logger;
     }
     /**
      * @inheritdoc
@@ -72,9 +64,26 @@ public function execute()
                 'message' => __('Get related images finished successfully'),
                 'result' => $relatedImages
             ];
+        } catch (AuthenticationException $exception) {
+            $responseCode = self::HTTP_INTERNAL_ERROR;
+            $responseContent = [
+                'success' => false,
+                'message' => __(
+                    'Failed to authenticate to Adobe Stock API. <br> Please correct the API credentials in '
+                    . '<a href="%url">Configuration → System → Adobe Stock Integration.</a>',
+                    [
+                        'url' => $this->getUrl(
+                            'adminhtml/system_config/edit',
+                            [
+                                'section' => 'system',
+                                '_fragment' => 'system_adobe_stock_integration-link'
+                            ]
+                        )
+                    ]
+                )
+            ];
         } catch (\Exception $exception) {
             $responseCode = self::HTTP_INTERNAL_ERROR;
-            $this->logger->critical($exception);
             $responseContent = [
                 'success' => false,
                 'message' => __('An error occurred on attempt to fetch related images.'),
diff --git a/AdobeStockImageAdminUi/Model/Listing/DataProvider.php b/AdobeStockImageAdminUi/Model/Listing/DataProvider.php
@@ -14,6 +14,8 @@
 use Magento\Framework\Api\Search\SearchCriteriaBuilder;
 use Magento\Framework\Api\Search\SearchResultInterface;
 use Magento\Framework\App\RequestInterface;
+use Magento\Framework\Exception\AuthenticationException;
+use Magento\Framework\UrlInterface;
 use Magento\Framework\View\Element\UiComponent\DataProvider\DataProvider as UiComponentDataProvider;
 
 /**
@@ -27,7 +29,11 @@ class DataProvider extends UiComponentDataProvider
     private $getImageList;
 
     /**
-     * DataProvider constructor.
+     * @var UrlInterface
+     */
+    private $url;
+
+    /**
      * @param string $name
      * @param string $primaryFieldName
      * @param string $requestFieldName
@@ -36,6 +42,7 @@ class DataProvider extends UiComponentDataProvider
      * @param RequestInterface $request
      * @param FilterBuilder $filterBuilder
      * @param GetImageListInterface $getImageList
+     * @param UrlInterface $url
      * @param array $meta
      * @param array $data
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
@@ -49,6 +56,7 @@ public function __construct(
         RequestInterface $request,
         FilterBuilder $filterBuilder,
         GetImageListInterface $getImageList,
+        UrlInterface $url,
         array $meta = [],
         array $data = []
     ) {
@@ -64,6 +72,7 @@ public function __construct(
             $data
         );
         $this->getImageList = $getImageList;
+        $this->url = $url;
     }
 
     /**
@@ -73,6 +82,24 @@ public function getData()
     {
         try {
             return $this->searchResultToOutput($this->getSearchResult());
+        } catch (AuthenticationException $exception) {
+            return [
+                'items' => [],
+                'totalRecords' => 0,
+                'errorMessage' => __(
+                    'Failed to authenticate to Adobe Stock API. <br> Please correct the API credentials in '
+                    . '<a href="%url">Configuration → System → Adobe Stock Integration.</a>',
+                    [
+                        'url' => $this->url->getUrl(
+                            'adminhtml/system_config/edit',
+                            [
+                                'section' => 'system',
+                                '_fragment' => 'system_adobe_stock_integration-link'
+                            ]
+                        )
+                    ]
+                )
+            ];
         } catch (\Exception $exception) {
             return [
                 'items' => [],
diff --git a/dev/tests/unit/phpunit.xml b/dev/tests/unit/phpunit.xml

Original file line number	Diff line number	Diff line change
`@@ -63,8 +63,7 @@ public function execute(int $adobeId): Document`
`63`	`63`
`64`	`64`	`$items = $this->getAssetList->execute($searchCriteria)->getItems();`
`65`	`65`	`if (empty($items) \|\| 1 < count($items)) {`
`66`		`- $message = __('Requested image doesn\'t exists');`
`67`		`- throw new NoSuchEntityException($message);`
	`66`	`+ throw new NoSuchEntityException(__('Requested asset does not exist.'));`
`68`	`67`	`}`
`69`	`68`
`70`	`69`	`return reset($items);`