🔃 [EngCom] Public Pull Requests - 2.1-develop

Accepted Public Pull Requests:
 - #17553: [Backport] Fix #10687 - Product image roles disappearing (by @eduard13)


Fixed GitHub Issues:
 - #10687: Product image roles randomly disappear (reported by @boxyman) has been fixed in #17553 by @eduard13 in 2.1-develop branch
   Related commits:
     1. abb3c4a
     2. 2be962d
     3. 6a8fadf

Author: ishakhsuvarov

app/code/Magento/Catalog/Model/ProductRepository.php

@@ -455,25 +455,19 @@ protected function processMediaGallery(ProductInterface $product, $mediaGalleryE
                     $newEntries[] = $entry;
                 }
             }
-            foreach ($existingMediaGallery as $key => &$existingEntry) {
-                if (isset($entriesById[$existingEntry['value_id']])) {
-                    $updatedEntry = $entriesById[$existingEntry['value_id']];
-                    if ($updatedEntry['file'] === null) {
-                        unset($updatedEntry['file']);
-                    }
-                    $existingMediaGallery[$key] = array_merge($existingEntry, $updatedEntry);
-                } else {
-                    //set the removed flag
-                    $existingEntry['removed'] = true;
-                }
-            }
+            $existingMediaGallery = $this->processingExistingImages($existingMediaGallery, $entriesById);
             $product->setData('media_gallery', ["images" => $existingMediaGallery]);
         } else {
             $newEntries = $mediaGalleryEntries;
         }
 
-        $this->getMediaGalleryProcessor()->clearMediaAttribute($product, array_keys($product->getMediaAttributes()));
         $images = $product->getMediaGallery('images');
+        if ($images) {
+            $images = $this->determineImageRoles($product, $images);
+        }
+
+        $this->getMediaGalleryProcessor()->clearMediaAttribute($product, array_keys($product->getMediaAttributes()));
+
         if ($images) {
             foreach ($images as $image) {
                 if (!isset($image['removed']) && !empty($image['types'])) {
@@ -482,25 +476,8 @@ protected function processMediaGallery(ProductInterface $product, $mediaGalleryE
             }
         }
 
-        foreach ($newEntries as $newEntry) {
-            if (!isset($newEntry['content'])) {
-                throw new InputException(__('The image content is not valid.'));
-            }
-            /** @var ImageContentInterface $contentDataObject */
-            $contentDataObject = $this->contentFactory->create()
-                ->setName($newEntry['content']['data'][ImageContentInterface::NAME])
-                ->setBase64EncodedData($newEntry['content']['data'][ImageContentInterface::BASE64_ENCODED_DATA])
-                ->setType($newEntry['content']['data'][ImageContentInterface::TYPE]);
-            $newEntry['content'] = $contentDataObject;
-            $this->processNewMediaGalleryEntry($product, $newEntry);
+        $this->processingNewEntries($newEntries, $product, $entriesById);
 
-            $finalGallery = $product->getData('media_gallery');
-            $newEntryId = key(array_diff_key($product->getData('media_gallery')['images'], $entriesById));
-            $newEntry = array_replace_recursive($newEntry, $finalGallery['images'][$newEntryId]);
-            $entriesById[$newEntryId] = $newEntry;
-            $finalGallery['images'][$newEntryId] = $newEntry;
-            $product->setData('media_gallery', $finalGallery);
-        }
         return $this;
     }
 
@@ -674,6 +651,32 @@ protected function addFilterGroupToCollection(
         }
     }
 
+    /**
+     * Ascertain image roles, if they are not set against the gallery entries
+     *
+     * @param ProductInterface $product
+     * @param array $images
+     * @return array
+     */
+    private function determineImageRoles(ProductInterface $product, array $images)
+    {
+        $imagesWithRoles = [];
+        foreach ($images as $image) {
+            if (!isset($image['types'])) {
+                $image['types'] = [];
+                if (isset($image['file'])) {
+                    foreach (array_keys($product->getMediaAttributes()) as $attribute) {
+                        if ($image['file'] == $product->getData($attribute)) {
+                            $image['types'][] = $attribute;
+                        }
+                    }
+                }
+            }
+            $imagesWithRoles[] = $image;
+        }
+        return $imagesWithRoles;
+    }
+
     /**
      * Apply custom filters to product collection.
      *
@@ -729,4 +732,59 @@ private function getMediaGalleryProcessor()
         }
         return $this->mediaGalleryProcessor;
     }
+
+    /**
+     * @param array $existingMediaGallery
+     * @param array $entriesById
+     * @return array
+     */
+    private function processingExistingImages(array $existingMediaGallery, array $entriesById)
+    {
+        foreach ($existingMediaGallery as $key => &$existingEntry) {
+            if (isset($entriesById[$existingEntry['value_id']])) {
+                $updatedEntry = $entriesById[$existingEntry['value_id']];
+                if ($updatedEntry['file'] === null) {
+                    unset($updatedEntry['file']);
+                }
+                $existingMediaGallery[$key] = array_merge($existingEntry, $updatedEntry);
+            } else {
+                //set the removed flag
+                $existingEntry['removed'] = true;
+            }
+        }
+
+        return $existingMediaGallery;
+    }
+
+    /**
+     * @param array $newEntries
+     * @param ProductInterface $product
+     * @param array $entriesById
+     * @return void
+     * @throws InputException
+     * @throws LocalizedException
+     * @throws StateException
+     */
+    private function processingNewEntries(array $newEntries, ProductInterface $product, array $entriesById)
+    {
+        foreach ($newEntries as $newEntry) {
+            if (!isset($newEntry['content'])) {
+                throw new InputException(__('The image content is not valid.'));
+            }
+            /** @var ImageContentInterface $contentDataObject */
+            $contentDataObject = $this->contentFactory->create()
+                ->setName($newEntry['content']['data'][ImageContentInterface::NAME])
+                ->setBase64EncodedData($newEntry['content']['data'][ImageContentInterface::BASE64_ENCODED_DATA])
+                ->setType($newEntry['content']['data'][ImageContentInterface::TYPE]);
+            $newEntry['content'] = $contentDataObject;
+            $this->processNewMediaGalleryEntry($product, $newEntry);
+
+            $finalGallery = $product->getData('media_gallery');
+            $newEntryId = key(array_diff_key($product->getData('media_gallery')['images'], $entriesById));
+            $newEntry = array_replace_recursive($newEntry, $finalGallery['images'][$newEntryId]);
+            $entriesById[$newEntryId] = $newEntry;
+            $finalGallery['images'][$newEntryId] = $newEntry;
+            $product->setData('media_gallery', $finalGallery);
+        }
+    }
 }