Static test fix - reduce coupling in page data provider with service

Author: Mohamed-Asar

app/code/Magento/Cms/Model/Page/DataProvider.php

@@ -6,8 +6,7 @@
 namespace Magento\Cms\Model\Page;
 
 use Magento\Cms\Api\Data\PageInterface;
-use Magento\Cms\Api\PageRepositoryInterface;
-use Magento\Cms\Model\PageFactory;
+use Magento\Cms\Model\Page\Service\PageService;
 use Magento\Cms\Model\ResourceModel\Page\CollectionFactory;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\Request\DataPersistorInterface;
@@ -33,11 +32,6 @@ class DataProvider extends ModifierPoolDataProvider
      */
     protected $loadedData;
 
-    /**
-     * @var PageRepositoryInterface
-     */
-    private $pageRepository;
-
     /**
      * @var AuthorizationInterface
      */
@@ -49,14 +43,9 @@ class DataProvider extends ModifierPoolDataProvider
     private $request;
 
     /**
-     * @var CustomLayoutManagerInterface
-     */
-    private $customLayoutManager;
-
-    /**
-     * @var PageFactory
+     * @var PageService
      */
-    private $pageFactory;
+    private $pageService;
 
     /**
      * @var LoggerInterface
@@ -74,9 +63,7 @@ class DataProvider extends ModifierPoolDataProvider
      * @param PoolInterface|null $pool
      * @param AuthorizationInterface|null $auth
      * @param RequestInterface|null $request
-     * @param CustomLayoutManagerInterface|null $customLayoutManager
-     * @param PageRepositoryInterface|null $pageRepository
-     * @param PageFactory|null $pageFactory
+     * @param PageService|null $pageService
      * @param LoggerInterface|null $logger
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -91,9 +78,7 @@ public function __construct(
         ?PoolInterface $pool = null,
         ?AuthorizationInterface $auth = null,
         ?RequestInterface $request = null,
-        ?CustomLayoutManagerInterface $customLayoutManager = null,
-        ?PageRepositoryInterface $pageRepository = null,
-        ?PageFactory $pageFactory = null,
+        ?PageService $pageService = null,
         ?LoggerInterface $logger = null
     ) {
         parent::__construct($name, $primaryFieldName, $requestFieldName, $meta, $data, $pool);
@@ -102,10 +87,7 @@ public function __construct(
         $this->auth = $auth ?? ObjectManager::getInstance()->get(AuthorizationInterface::class);
         $this->meta = $this->prepareMeta($this->meta);
         $this->request = $request ?? ObjectManager::getInstance()->get(RequestInterface::class);
-        $this->customLayoutManager = $customLayoutManager
-            ?? ObjectManager::getInstance()->get(CustomLayoutManagerInterface::class);
-        $this->pageRepository = $pageRepository ?? ObjectManager::getInstance()->get(PageRepositoryInterface::class);
-        $this->pageFactory = $pageFactory ?: ObjectManager::getInstance()->get(PageFactory::class);
+        $this->pageService = $pageService ?: ObjectManager::getInstance()->get(PageService::class);
         $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
     }
 
@@ -150,22 +132,16 @@ private function getCurrentPage(): PageInterface
     {
         $pageId = $this->getPageId();
         if ($pageId) {
-            try {
-                $page = $this->pageRepository->getById($pageId);
-            } catch (LocalizedException $exception) {
-                $page = $this->pageFactory->create();
-            }
-
-            return $page;
+            return $this->pageService->getPageById($pageId);
         }
 
         $data = $this->dataPersistor->get('cms_page');
         if (empty($data)) {
-            return $this->pageFactory->create();
+            return $this->pageService->createPageFactory();
         }
         $this->dataPersistor->clear('cms_page');
 
-        return $this->pageFactory->create()
+        return $this->pageService->createPageFactory()
             ->setData($data);
     }
 
@@ -217,11 +193,11 @@ public function getMeta()
         try {
             $pageId = $this->getPageId();
             if ($pageId) {
-                $page = $this->pageRepository->getById($pageId);
+                $page = $this->pageService->getPageById($pageId);
                 if ($page->getCustomLayoutUpdateXml() || $page->getLayoutUpdateXml()) {
                     $options[] = ['label' => 'Use existing layout update XML', 'value' => '_existing_'];
                 }
-                foreach ($this->customLayoutManager->fetchAvailableFiles($page) as $layoutFile) {
+                foreach ($this->pageService->fetchAvailableCustomLayouts($page) as $layoutFile) {
                     $options[] = ['label' => $layoutFile, 'value' => $layoutFile];
                 }
             }

app/code/Magento/Cms/Model/Page/Service/PageService.php

@@ -0,0 +1,66 @@
+<?php
+/**
+ * Copyright 2015 Adobe
+ * All Rights Reserved.
+ */
+namespace Magento\Cms\Model\Page\Service;
+
+use Magento\Cms\Api\Data\PageInterface;
+use Magento\Cms\Api\PageRepositoryInterface;
+use Magento\Cms\Model\Page\CustomLayoutManagerInterface;
+use Magento\Cms\Model\PageFactory;
+use Magento\Framework\Exception\LocalizedException;
+
+/**
+ * Cms Page Service Class
+ */
+class PageService
+{
+    /**
+     * @param PageRepositoryInterface $pageRepository
+     * @param PageFactory $pageFactory
+     * @param CustomLayoutManagerInterface $customLayoutManager
+     */
+    public function __construct(
+        private PageRepositoryInterface $pageRepository,
+        private PageFactory $pageFactory,
+        private CustomLayoutManagerInterface $customLayoutManager,
+    ) {
+    }
+
+    /**
+     * To get the page by its ID. If the page not exists, a new page instance is returned
+     *
+     * @param int $id
+     * @return PageInterface
+     */
+    public function getPageById(int $id): PageInterface
+    {
+        try {
+            return $this->pageRepository->getById($id);
+        } catch (LocalizedException) {
+            return $this->pageFactory->create();
+        }
+    }
+
+    /**
+     * To create pagefactory class
+     *
+     * @return PageInterface
+     */
+    public function createPageFactory(): PageInterface
+    {
+        return $this->pageFactory->create();
+    }
+
+    /**
+     * Fetches the available custom layouts for a given page.
+     *
+     * @param PageInterface $page
+     * @return array
+     */
+    public function fetchAvailableCustomLayouts(PageInterface $page): array
+    {
+        return $this->customLayoutManager->fetchAvailableFiles($page);
+    }
+}