B2B-2677: [MediaGallery]Implement data caching for GraphQL results on resolver level

- Fix overinvalidation

Author: danmooney2

app/code/Magento/CatalogGraphQl/Plugin/Product/UpdateIdentities.php

@@ -13,7 +13,7 @@
 
 /**
  * This is a plugin to \Magento\Catalog\Model\Product.
- * It is to add media gallery identities to product identities.
+ * It is used to add media gallery identities to product identities for invalidation purposes.
  */
 class UpdateIdentities
 {
@@ -31,15 +31,15 @@ public function __construct(SerializerInterface $serializer)
     }
 
     /**
-     * Set product media gallery changed after add image to the product
+     * Flag product media gallery as changed after adding or updating image, or on product removal
      *
      * @param Product $subject
      * @param array $result
      * @return array
      */
     public function afterGetIdentities(Product $subject, array $result): array
     {
-        if ($subject->isDeleted() || $this->isMediaGalleryChanged($subject)) {
+        if (!$subject->isObjectNew() && ($subject->isDeleted() || $this->isMediaGalleryChanged($subject))) {
             $result[] = sprintf('%s_%s', ResolverCacheIdentity::CACHE_TAG, $subject->getId());
         }
         return $result;
@@ -53,12 +53,29 @@ public function afterGetIdentities(Product $subject, array $result): array
      */
     private function isMediaGalleryChanged(Product $product): bool
     {
-        $mediaGalleryImages = $product->getMediaGallery('images');
+        if (!$product->hasDataChanges()) {
+            return false;
+        }
+
+        $mediaGalleryImages = $product->getMediaGallery('images') ?? [];
+
+        $origMediaGalleryImages = $product->getOrigData('media_gallery')['images'] ?? [];
+
+        $origMediaGalleryImageKeys = array_keys($origMediaGalleryImages);
+        $mediaGalleryImageKeys = array_keys($mediaGalleryImages);
+
+        if ($origMediaGalleryImageKeys !== $mediaGalleryImageKeys) {
+            return false;
+        }
+
+        // remove keys from original array that are not in new array; some keys are omitted from the new array on save
+        foreach ($mediaGalleryImages as $key => $mediaGalleryImage) {
+            $origMediaGalleryImages[$key] = array_intersect_key($origMediaGalleryImages[$key], $mediaGalleryImage);
+        }
+
         $mediaGalleryImagesSerializedString = $this->serializer->serialize($mediaGalleryImages);
-        $origMediaGallery = $product->getOrigData('media_gallery');
-        $origMediaGalleryImages = is_array($origMediaGallery) && array_key_exists('images', $origMediaGallery)
-            ? $origMediaGallery['images'] : null;
         $origMediaGalleryImagesSerializedString = $this->serializer->serialize($origMediaGalleryImages);
+
         return $origMediaGalleryImagesSerializedString != $mediaGalleryImagesSerializedString;
     }
 }

dev/tests/api-functional/testsuite/Magento/GraphQl/Catalog/ResolverCache/MediaGalleryTest.php

@@ -104,13 +104,22 @@ public function testSavingProductInAdminWithoutChangesDoesNotInvalidateResolverC
         ]);
 
         $productData = $product->getData();
+
+        // video_* keys are not passed to the controller when saving an image
+        foreach ($productData['media_gallery']['images'] as &$image) {
+            $image = array_filter($image, function ($key) {
+                return strpos($key, 'video') === false;
+            }, ARRAY_FILTER_USE_KEY);
+        }
+
         unset($productData['entity_id']);
 
         $adminProductSaveController->getRequest()->setPostValue([
             'id' => $product->getId(),
             'product' => $productData,
             'set' => 4, // attribute set id
             'type' => 'simple',
+            'store' => 1,
         ]);
 
         $messageManager->expects($this->never())->method('addErrorMessage');
@@ -299,6 +308,12 @@ private function assertMediaGalleryResolverCacheRecordExists(ProductInterface $p
     {
         $cacheKey = $this->getCacheKeyForMediaGalleryResolver($product);
         $cacheEntry = $this->graphQlResolverCache->load($cacheKey);
+
+        $this->assertNotFalse(
+            $cacheEntry,
+            sprintf('Media gallery cache entry for product with sku "%s" does not exist', $product->getSku())
+        );
+
         $cacheEntryDecoded = json_decode($cacheEntry, true);
 
         $this->assertEquals(
@@ -317,7 +332,8 @@ private function assertMediaGalleryResolverCacheRecordDoesNotExist(ProductInterf
     {
         $cacheKey = $this->getCacheKeyForMediaGalleryResolver($product);
         $this->assertFalse(
-            $this->graphQlResolverCache->test($cacheKey)
+            $this->graphQlResolverCache->test($cacheKey),
+            sprintf('Media gallery cache entry for product with sku "%s" exists', $product->getSku())
         );
     }