Final adjustments to the implementation

Author: lbajsarowicz

app/code/Magento/Cms/Block/BlockByIdentifier.php

@@ -9,6 +9,7 @@
 
 use Magento\Cms\Api\Data\BlockInterface;
 use Magento\Cms\Api\GetBlockByIdentifierInterface;
+use Magento\Cms\Model\Block as BlockModel;
 use Magento\Cms\Model\Template\FilterProvider;
 use Magento\Framework\DataObject\IdentityInterface;
 use Magento\Framework\Exception\NoSuchEntityException;
@@ -45,6 +46,13 @@ class BlockByIdentifier extends AbstractBlock implements IdentityInterface
      */
     private $cmsBlock;
 
+    /**
+     * @param GetBlockByIdentifierInterface $blockByIdentifier
+     * @param StoreManagerInterface $storeManager
+     * @param FilterProvider $filterProvider
+     * @param Context $context
+     * @param array $data
+     */
     public function __construct(
         GetBlockByIdentifierInterface $blockByIdentifier,
         StoreManagerInterface $storeManager,
@@ -89,7 +97,7 @@ private function filterOutput(string $content): string
     /**
      * Loads the CMS block by `identifier` provided as an argument
      *
-     * @return BlockInterface
+     * @return BlockInterface|BlockModel
      * @throws NoSuchEntityException
      */
     private function getCmsBlock(): BlockInterface
@@ -142,17 +150,13 @@ public function getIdentities(): array
 
         try {
             $cmsBlock = $this->getCmsBlock();
-
-            $identities[] = self::CACHE_KEY_PREFIX . '_' . $cmsBlock->getId();
-
-            if (method_exists($this->getCmsBlock(), 'getStores')) {
-                foreach ($cmsBlock->getStores() as $storeId) {
-                    $identities[] = self::CACHE_KEY_PREFIX . '_' . $this->getIdentifier() . '_' . $storeId;
-                }
+            if ($cmsBlock instanceof IdentityInterface) {
+                $identities = array_merge($identities, $cmsBlock->getIdentities());
             }
             // phpcs:disable Magento2.CodeAnalysis.EmptyBlock.DetectedCatch
         } catch (NoSuchEntityException $e) {
         }
+
         return $identities;
     }
 }

app/code/Magento/Cms/Test/Unit/Block/BlockByIdentifierTest.php

@@ -10,6 +10,7 @@
 use Magento\Cms\Api\Data\BlockInterface;
 use Magento\Cms\Api\GetBlockByIdentifierInterface;
 use Magento\Cms\Block\BlockByIdentifier;
+use Magento\Cms\Model\Block;
 use Magento\Cms\Model\Template\FilterProvider;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Event\ManagerInterface;
@@ -21,6 +22,9 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
+/**
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class BlockByIdentifierTest extends TestCase
 {
     private const STUB_MODULE_OUTPUT_DISABLED = false;
@@ -37,6 +41,8 @@ class BlockByIdentifierTest extends TestCase
         BlockByIdentifier::CACHE_KEY_PREFIX . '_' . self::STUB_UNAVAILABLE_IDENTIFIER,
         BlockByIdentifier::CACHE_KEY_PREFIX . '_' . self::STUB_UNAVAILABLE_IDENTIFIER . '_' . self::STUB_DEFAULT_STORE
     ];
+    private const STUB_CMS_BLOCK_IDENTITY_BY_ID = 'CMS_BLOCK_' . self::STUB_CMS_BLOCK_ID;
+    private const STUB_CMS_BLOCK_IDENTITY_BY_IDENTIFIER = 'CMS_BLOCK_' . self::STUB_EXISTING_IDENTIFIER;
 
     /** @var MockObject|GetBlockByIdentifierInterface */
     private $getBlockByIdentifierMock;
@@ -108,14 +114,19 @@ public function testBlockReturnsCmsContentsWhenIdentifierFound(): void
         $this->assertSame(self::ASSERT_CONTENT_HTML, $block->toHtml());
     }
 
-    public function testBlockCacheIdentitiesContainExplicitScopeInformation(): void
+    public function testBlockCacheIdentitiesContainCmsBlockIdentities(): void
     {
         // Given
-        $cmsBlockMock = $this->getCmsBlockMock(
-            self::STUB_CMS_BLOCK_ID,
-            self::STUB_EXISTING_IDENTIFIER,
-            self::STUB_CONTENT
+        $cmsBlockMock = $this->createMock(Block::class);
+        $cmsBlockMock->method('getId')->willReturn(self::STUB_CMS_BLOCK_ID);
+        $cmsBlockMock->method('getIdentifier')->willReturn(self::STUB_EXISTING_IDENTIFIER);
+        $cmsBlockMock->method('getIdentities')->willReturn(
+            [
+                self::STUB_CMS_BLOCK_IDENTITY_BY_ID,
+                self::STUB_CMS_BLOCK_IDENTITY_BY_IDENTIFIER
+            ]
         );
+
         $this->storeMock->method('getId')->willReturn(self::STUB_DEFAULT_STORE);
         $this->getBlockByIdentifierMock->method('execute')
             ->with(self::STUB_EXISTING_IDENTIFIER, self::STUB_DEFAULT_STORE)
@@ -127,10 +138,8 @@ public function testBlockCacheIdentitiesContainExplicitScopeInformation(): void
 
         // Then
         $this->assertContains($this->getIdentityStubById(self::STUB_CMS_BLOCK_ID), $identities);
-        $this->assertContains(
-            $this->getIdentityStubByIdentifier(self::STUB_EXISTING_IDENTIFIER, self::STUB_DEFAULT_STORE),
-            $identities
-        );
+        $this->assertContains(self::STUB_CMS_BLOCK_IDENTITY_BY_ID, $identities);
+        $this->assertContains(self::STUB_CMS_BLOCK_IDENTITY_BY_IDENTIFIER, $identities);
     }
 
     /**