magento/magento:5023 - It is not possible to add MS tile image meta via default_head_blocks.xml

# Introduced a new class that provides URL for MS tile image during page config metadata generation

Author: Vasilii Burlacu

lib/internal/Magento/Framework/View/Page/Config.php

@@ -137,11 +137,6 @@ class Config
         'robots' => null,
     ];
 
-    /**
-     * @var array
-     */
-    private $additionalMetaAssets = ['msapplication-TileImage'];
-
     /**
      * @var \Magento\Framework\App\State
      */
@@ -556,31 +551,6 @@ public function addBodyClass($className)
         return $this;
     }
 
-    /**
-     * Retrieve the additional meta assets
-     *
-     * @return array
-     */
-    public function getAdditionalMetaAssets()
-    {
-        return $this->additionalMetaAssets;
-    }
-
-    /**
-     * Adjust metadata content url
-     *
-     * @param string $content
-     * @return string $content
-     */
-    public function getMetaAssetUrl($content)
-    {
-        if (!parse_url($content, PHP_URL_SCHEME)) {
-            return $this->assetRepo->getUrl($content);
-        }
-
-        return $content;
-    }
-
     /**
      * Set additional element attribute
      *

lib/internal/Magento/Framework/View/Page/Config/Metadata/MsApplicationTileImage.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Framework\View\Page\Config\Metadata;
+
+use Magento\Framework\View\Asset\Repository as AssetRepository;
+
+/**
+ * Class MsApplicationTileImage
+ *
+ * Returns the URL for page `msapplication-TileImage` meta
+ */
+class MsApplicationTileImage
+{
+    /**#@+
+     * Constant of asset name
+     */
+    const META_NAME = 'msapplication-TileImage';
+
+    /**
+     * @var AssetRepository
+     */
+    private $assetRepo;
+
+    /**
+     * @param AssetRepository $assetRepo
+     */
+    public function __construct(AssetRepository $assetRepo)
+    {
+        $this->assetRepo = $assetRepo;
+    }
+
+    /**
+     * Get asset URL from given metadata content
+     *
+     * @param string $content
+     *
+     * @return string
+     */
+    public function getUrl(string $content): string
+    {
+        if (!parse_url($content, PHP_URL_SCHEME)) {
+            return $this->assetRepo->getUrl($content);
+        }
+
+        return $content;
+    }
+}

lib/internal/Magento/Framework/View/Page/Config/Renderer.php

@@ -9,6 +9,7 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\View\Asset\GroupedCollection;
 use Magento\Framework\View\Page\Config;
+use Magento\Framework\View\Page\Config\Metadata\MsApplicationTileImage;
 
 /**
  * Page config Renderer model
@@ -74,28 +75,37 @@ class Renderer implements RendererInterface
      */
     protected $urlBuilder;
 
+    /**
+     * @var MsApplicationTileImage
+     */
+    private $msApplicationTileImage;
+
     /**
      * @param Config $pageConfig
      * @param \Magento\Framework\View\Asset\MergeService $assetMergeService
      * @param \Magento\Framework\UrlInterface $urlBuilder
      * @param \Magento\Framework\Escaper $escaper
      * @param \Magento\Framework\Stdlib\StringUtils $string
      * @param \Psr\Log\LoggerInterface $logger
+     * @param MsApplicationTileImage|null $msApplicationTileImage
      */
     public function __construct(
         Config $pageConfig,
         \Magento\Framework\View\Asset\MergeService $assetMergeService,
         \Magento\Framework\UrlInterface $urlBuilder,
         \Magento\Framework\Escaper $escaper,
         \Magento\Framework\Stdlib\StringUtils $string,
-        \Psr\Log\LoggerInterface $logger
+        \Psr\Log\LoggerInterface $logger,
+        MsApplicationTileImage $msApplicationTileImage = null
     ) {
         $this->pageConfig = $pageConfig;
         $this->assetMergeService = $assetMergeService;
         $this->urlBuilder = $urlBuilder;
         $this->escaper = $escaper;
         $this->string = $string;
         $this->logger = $logger;
+        $this->msApplicationTileImage = $msApplicationTileImage ?:
+            \Magento\Framework\App\ObjectManager::getInstance()->get(MsApplicationTileImage::class);
     }
 
     /**
@@ -179,8 +189,8 @@ protected function processMetadataContent($name, $content)
         if (method_exists($this->pageConfig, $method)) {
             $content = $this->pageConfig->$method();
         }
-        if ($content && in_array($name, $this->pageConfig->getAdditionalMetaAssets())) {
-            $content = $this->pageConfig->getMetaAssetUrl($content);
+        if ($content && $name === $this->msApplicationTileImage::META_NAME) {
+            $content = $this->msApplicationTileImage->getUrl($content);
         }
 
         return $content;

lib/internal/Magento/Framework/View/Test/Unit/Page/Config/RendererTest.php

@@ -8,6 +8,7 @@
 
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use Magento\Framework\View\Asset\GroupedCollection;
+use Magento\Framework\View\Page\Config\Metadata\MsApplicationTileImage;
 use Magento\Framework\View\Page\Config\Renderer;
 use Magento\Framework\View\Page\Config\Generator;
 
@@ -58,6 +59,11 @@ class RendererTest extends \PHPUnit\Framework\TestCase
      */
     protected $loggerMock;
 
+    /**
+     * @var MsApplicationTileImage|\PHPUnit_Framework_MockObject_MockObject
+     */
+    protected $msApplicationTileImageMock;
+
     /**
      * @var \Magento\Framework\View\Asset\GroupedCollection|\PHPUnit_Framework_MockObject_MockObject
      */
@@ -99,6 +105,10 @@ protected function setUp()
         $this->loggerMock = $this->getMockBuilder(\Psr\Log\LoggerInterface::class)
             ->getMock();
 
+        $this->msApplicationTileImageMock = $this->getMockBuilder(MsApplicationTileImage::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
         $this->assetsCollection = $this->getMockBuilder(\Magento\Framework\View\Asset\GroupedCollection::class)
             ->setMethods(['getGroups'])
             ->disableOriginalConstructor()
@@ -120,7 +130,8 @@ protected function setUp()
                 'urlBuilder' => $this->urlBuilderMock,
                 'escaper' => $this->escaperMock,
                 'string' => $this->stringMock,
-                'logger' => $this->loggerMock
+                'logger' => $this->loggerMock,
+                'msApplicationTileImage' => $this->msApplicationTileImageMock
             ]
         );
     }
@@ -147,15 +158,17 @@ public function testRenderMetadata()
             'content_type' => 'content_type_value',
             'x_ua_compatible' => 'x_ua_compatible_value',
             'media_type' => 'media_type_value',
-            'og:video:secure_url' => 'secure_url'
+            'og:video:secure_url' => 'secure_url',
+            'msapplication-TileImage' => 'https://site.domain/ms-tile.jpg'
         ];
         $metadataValueCharset = 'newCharsetValue';
 
         $expected = '<meta charset="newCharsetValue"/>' . "\n"
             . '<meta name="metadataName" content="metadataValue"/>' . "\n"
             . '<meta http-equiv="Content-Type" content="content_type_value"/>' . "\n"
             . '<meta http-equiv="X-UA-Compatible" content="x_ua_compatible_value"/>' . "\n"
-            . '<meta property="og:video:secure_url" content="secure_url"/>' . "\n";
+            . '<meta property="og:video:secure_url" content="secure_url"/>' . "\n"
+            . '<meta name="msapplication-TileImage" content="https://site.domain/ms-tile.jpg"/>' . "\n";
 
         $this->stringMock->expects($this->at(0))
             ->method('upperCaseWords')
@@ -171,10 +184,36 @@ public function testRenderMetadata()
             ->method('getMetadata')
             ->will($this->returnValue($metadata));
 
+        $this->msApplicationTileImageMock
+            ->expects($this->once())
+            ->method('getUrl')
+            ->with('https://site.domain/ms-tile.jpg')
+            ->will($this->returnValue('https://site.domain/ms-tile.jpg'));
+
+        $this->assertEquals($expected, $this->renderer->renderMetadata());
+    }
+
+    /**
+     * Test renderMetadata when it has 'msapplication-TileImage' meta passed
+     */
+    public function testRenderMetadataWithMsApplicationTileImageAsset()
+    {
+        $metadata = [
+            'msapplication-TileImage' => 'images/ms-tile.jpg'
+        ];
+        $expectedMetaUrl = 'https://site.domain/images/ms-tile.jpg';
+        $expected = '<meta name="msapplication-TileImage" content="' . $expectedMetaUrl . '"/>' . "\n";
+
         $this->pageConfigMock
-            ->expects($this->any())
-            ->method('getAdditionalMetaAssets')
-            ->will($this->returnValue(['msapplication-TileImage']));
+            ->expects($this->once())
+            ->method('getMetadata')
+            ->will($this->returnValue($metadata));
+
+        $this->msApplicationTileImageMock
+            ->expects($this->once())
+            ->method('getUrl')
+            ->with('images/ms-tile.jpg')
+            ->will($this->returnValue($expectedMetaUrl));
 
         $this->assertEquals($expected, $this->renderer->renderMetadata());
     }

lib/internal/Magento/Framework/View/Test/Unit/Page/ConfigTest.php

@@ -377,26 +377,6 @@ public function testAddRss()
         $this->assertInstanceOf(\Magento\Framework\View\Page\Config::class, $this->model->addRss($title, $href));
     }
 
-    /**
-     * Testing case for getting meta asset URL with URL in content
-     */
-    public function testGetMetaAssetUrlWithUrlInContent()
-    {
-        $this->assetRepo->expects($this->never())->method('getUrl');
-        $this->assertEquals('http://test.com/image.png', $this->model->getMetaAssetUrl('http://test.com/image.png'));
-    }
-
-    /**
-     * Testing case for getting meta asset URL without URL in content
-     */
-    public function testGetMetaAssetUrlWithoutUrlInContent()
-    {
-        $this->assetRepo->expects($this->once())->method('getUrl')->with('image.png')->will(
-            $this->returnValue('http://test.com/image.png')
-        );
-        $this->assertEquals('http://test.com/image.png', $this->model->getMetaAssetUrl('image.png'));
-    }
-
     public function testAddBodyClass()
     {
         $className = 'test class';