ACP2E-2392: [On-PREM] Dynamic block issue

- ui components can force a specific render type instead of relying on context

Author: aplapana

app/code/Magento/Catalog/Block/Widget/RecentlyViewed.php

@@ -13,4 +13,5 @@
  */
 class RecentlyViewed extends Wrapper implements \Magento\Widget\Block\BlockInterface
 {
+    protected const RENDER_TYPE = 'html';
 }

app/code/Magento/Ui/Block/Wrapper.php

@@ -14,6 +14,8 @@
  */
 class Wrapper extends \Magento\Framework\View\Element\Template
 {
+    protected const RENDER_TYPE = '';
+
     /**
      * @var UiComponentGenerator
      */
@@ -87,10 +89,10 @@ private function addDataToChildComponents(UiComponentInterface $uiComponent, arr
     public function renderApp($data = [])
     {
         /** @var \Magento\Ui\Component\AbstractComponent $uiComponent */
-        $uiComponent = $this->uiComponentGenerator
+        $uiComponent = $this->uiComponentGenerator //vezi generateXML aici de la layout
             ->generateUiComponent($this->getData('uiComponent'), $this->getLayout());
         $this->injectDataInDataSource($uiComponent, $this->getData());
         $this->addDataToChildComponents($uiComponent, $data);
-        return (string) $uiComponent->render();
+        return (string) $uiComponent->render(static::RENDER_TYPE);
     }
 }

app/code/Magento/Ui/Component/Listing.php

@@ -5,6 +5,9 @@
  */
 namespace Magento\Ui\Component;
 
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\View\Element\UiComponent\ContentType\ContentTypeFactory;
+use Magento\Framework\View\Element\UiComponent\ContextInterface;
 use Magento\Ui\Component\Listing\Columns;
 
 /**
@@ -20,6 +23,27 @@ class Listing extends AbstractComponent
      */
     protected $columns = [];
 
+    /**
+     * @var ContentTypeFactory
+     */
+    protected ContentTypeFactory $contentTypeFactory;
+
+    /**
+     * @param ContextInterface $context
+     * @param ContentTypeFactory|null $contentTypeFactory
+     * @param array $components
+     * @param array $data
+     */
+    public function __construct(
+        ContextInterface $context,
+        ?ContentTypeFactory $contentTypeFactory = null,
+        array $components = [],
+        array $data = []
+    ) {
+        $this->contentTypeFactory = $contentTypeFactory ?: ObjectManager::getInstance()->get(ContentTypeFactory::class);
+        parent::__construct($context, $components, $data);
+    }
+
     /**
      * Get component name
      *
@@ -37,4 +61,16 @@ public function getDataSourceData()
     {
         return ['data' => $this->getContext()->getDataProvider()->getData()];
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function render(string $contentType = '')
+    {
+        if ($contentType) {
+            return $this->contentTypeFactory->get($contentType)->render($this, $this->getTemplate());
+        }
+
+        return parent::render();
+    }
 }

app/code/Magento/Ui/Test/Unit/Component/ListingTest.php

@@ -8,6 +8,9 @@
 namespace Magento\Ui\Test\Unit\Component;
 
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\Framework\View\Element\UiComponent\ContentType\AbstractContentType;
+use Magento\Framework\View\Element\UiComponent\ContentType\ContentTypeFactory;
+use Magento\Framework\View\Element\UiComponent\ContentType\Html;
 use Magento\Framework\View\Element\UiComponent\ContextInterface;
 use Magento\Framework\View\Element\UiComponent\Processor;
 use Magento\Ui\Component\Listing;
@@ -26,6 +29,11 @@ class ListingTest extends TestCase
      */
     protected $objectManager;
 
+    /**
+     * @var ContentTypeFactory|MockObject
+     */
+    private ContentTypeFactory $contentTypeFactory;
+
     /**
      * @inheritdoc
      */
@@ -39,6 +47,8 @@ protected function setUp(): void
             '',
             false
         );
+
+        $this->contentTypeFactory = $this->createMock(ContentTypeFactory::class);
     }
 
     /**
@@ -103,4 +113,48 @@ public function testPrepare(): void
 
         $listing->prepare();
     }
+
+    /**
+     * @return void
+     */
+    public function testRenderSpecificContentType(): void
+    {
+        $html = 'html output';
+        $renderer = $this->createMock(Html::class);
+        $renderer->expects($this->once())->method('render')->willReturn($html);
+        $this->contentTypeFactory->expects($this->once())
+            ->method('get')
+            ->with('html')
+            ->willReturn($renderer);
+
+        /** @var Listing $listing */
+        $listing = $this->objectManager->getObject(
+            Listing::class,
+            [
+                'context' => $this->contextMock,
+                'contentTypeFactory' => $this->contentTypeFactory
+            ]
+        );
+        $this->assertSame($html, $listing->render('html'));
+    }
+
+    /**
+     * @return void
+     */
+    public function testRenderParent()
+    {
+        $html = 'html output';
+        $renderer = $this->createMock(AbstractContentType::class);
+        $renderer->expects($this->once())->method('render')->willReturn($html);
+        $this->contextMock->expects($this->once())->method('getRenderEngine')->willReturn($renderer);
+
+        /** @var Listing $listing */
+        $listing = $this->objectManager->getObject(
+            Listing::class,
+            [
+                'context' => $this->contextMock
+            ]
+        );
+        $this->assertSame($html, $listing->render());
+    }
 }