MAGETWO-61018: [Github] Unable to add video to product via REST api #7153

Author: igrybkov

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

@@ -289,6 +289,7 @@ protected function getCacheKey($data)
      */
     protected function initializeProductData(array $productData, $createNew)
     {
+        unset($productData['media_gallery']);
         if ($createNew) {
             $product = $this->productFactory->create();
             if ($this->storeManager->hasSingleStore()) {
@@ -437,8 +438,15 @@ private function processLinks(\Magento\Catalog\Api\Data\ProductInterface $produc
     }
 
     /**
-     * @param ProductInterface $product
-     * @param array $mediaGalleryEntries
+     * Process Media gallery data before save product.
+     *
+     * Compare Media Gallery Entries Data with existing Media Gallery
+     * * If Media entry has not value_id set it as new
+     * * If Existing entry 'value_id' absent in Media Gallery set 'removed' flag
+     * * Merge Existing and new media gallery
+     *
+     * @param ProductInterface $product contains only existing media gallery items
+     * @param array $mediaGalleryEntries array which contains all media gallery items
      * @return $this
      * @throws InputException
      * @throws StateException
@@ -448,11 +456,10 @@ protected function processMediaGallery(ProductInterface $product, $mediaGalleryE
     {
         $existingMediaGallery = $product->getMediaGallery('images');
         $newEntries = [];
+        $entriesById = [];
         if (!empty($existingMediaGallery)) {
-            $entriesById = [];
             foreach ($mediaGalleryEntries as $entry) {
-                if (isset($entry['id'])) {
-                    $entry['value_id'] = $entry['id'];
+                if (isset($entry['value_id'])) {
                     $entriesById[$entry['value_id']] = $entry;
                 } else {
                     $newEntries[] = $entry;
@@ -461,6 +468,9 @@ protected function processMediaGallery(ProductInterface $product, $mediaGalleryE
             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
@@ -488,11 +498,18 @@ protected function processMediaGallery(ProductInterface $product, $mediaGalleryE
             }
             /** @var ImageContentInterface $contentDataObject */
             $contentDataObject = $this->contentFactory->create()
-                ->setName($newEntry['content'][ImageContentInterface::NAME])
-                ->setBase64EncodedData($newEntry['content'][ImageContentInterface::BASE64_ENCODED_DATA])
-                ->setType($newEntry['content'][ImageContentInterface::TYPE]);
+                ->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);
         }
         return $this;
     }
@@ -520,8 +537,6 @@ public function save(\Magento\Catalog\Api\Data\ProductInterface $product, $saveO
         $productDataArray = $this->extensibleDataObjectConverter
             ->toNestedArray($product, [], \Magento\Catalog\Api\Data\ProductInterface::class);
         $productDataArray = array_replace($productDataArray, $product->getData());
-        unset($productDataArray['media_gallery']);
-
         $ignoreLinksFlag = $product->getData('ignore_links_flag');
         $productLinks = null;
         if (!$ignoreLinksFlag && $ignoreLinksFlag !== null) {
@@ -531,8 +546,8 @@ public function save(\Magento\Catalog\Api\Data\ProductInterface $product, $saveO
         $product = $this->initializeProductData($productDataArray, empty($existingProduct));
 
         $this->processLinks($product, $productLinks);
-        if (isset($productDataArray['media_gallery_entries'])) {
-            $this->processMediaGallery($product, $productDataArray['media_gallery_entries']);
+        if (isset($productDataArray['media_gallery'])) {
+            $this->processMediaGallery($product, $productDataArray['media_gallery']['images']);
         }
 
         if (!$product->getOptionsReadonly()) {

app/code/Magento/Catalog/Test/Unit/Model/ProductRepositoryTest.php

@@ -1154,29 +1154,35 @@ public function testSaveExistingWithNewMediaGalleryEntries()
     {
         $this->storeManagerMock->expects($this->any())->method('getWebsites')->willReturn([1 => 'default']);
         $newEntriesData = [
-            [
-                "label" => "label_text",
-                'position' => 10,
-                'disabled' => false,
-                'types' => ['image', 'small_image'],
-                'content' => [
-                    ImageContentInterface::NAME => 'filename',
-                    ImageContentInterface::TYPE => 'image/jpeg',
-                    ImageContentInterface::BASE64_ENCODED_DATA => 'encoded_content',
-                ],
-                'media_type' => 'media_type',
-            ],
+            'images' =>
+                [
+                    [
+                        'value_id' => null,
+                        'label' => "label_text",
+                        'position' => 10,
+                        'disabled' => false,
+                        'types' => ['image', 'small_image'],
+                        'content' => [
+                            'data' => [
+                                ImageContentInterface::NAME => 'filename',
+                                ImageContentInterface::TYPE => 'image/jpeg',
+                                ImageContentInterface::BASE64_ENCODED_DATA => 'encoded_content',
+                            ],
+                        ],
+                        'media_type' => 'media_type',
+                    ]
+                ]
         ];
 
         $this->setupProductMocksForSave();
         //media gallery data
-        $this->productData['media_gallery_entries'] = $newEntriesData;
+        $this->productData['media_gallery'] = $newEntriesData;
         $this->extensibleDataObjectConverterMock
             ->expects($this->once())
             ->method('toNestedArray')
             ->will($this->returnValue($this->productData));
 
-        $this->initializedProductMock->setData('media_gallery', []);
+        $this->initializedProductMock->setData('media_gallery', $newEntriesData);
         $this->initializedProductMock->expects($this->any())
             ->method('getMediaAttributes')
             ->willReturn(["image" => "imageAttribute", "small_image" => "small_image_attribute"]);
@@ -1277,7 +1283,7 @@ public function testSaveExistingWithMediaGalleryEntries()
         //update one entry, delete one entry
         $newEntries = [
             [
-                'id' => 5,
+                'value_id' => 5,
                 "label" => "new_label_text",
                 'file' => 'filename1',
                 'position' => 10,
@@ -1304,7 +1310,7 @@ public function testSaveExistingWithMediaGalleryEntries()
 
         $expectedResult = [
             [
-                'id' => 5,
+                'value_id' => 5,
                 'value_id' => 5,
                 "label" => "new_label_text",
                 'file' => 'filename1',
@@ -1321,7 +1327,7 @@ public function testSaveExistingWithMediaGalleryEntries()
 
         $this->setupProductMocksForSave();
         //media gallery data
-        $this->productData['media_gallery_entries'] = $newEntries;
+        $this->productData['media_gallery']['images'] = $newEntries;
         $this->extensibleDataObjectConverterMock
             ->expects($this->once())
             ->method('toNestedArray')

dev/tests/api-functional/testsuite/Magento/Catalog/Api/ProductAttributeMediaGalleryManagementInterfaceTest.php

@@ -615,4 +615,49 @@ public function testGetListForAbsentSku()
         }
         $this->_webApiCall($serviceInfo, $requestData);
     }
+
+    /**
+     * @magentoApiDataFixture Magento/Catalog/_files/product_simple.php
+     */
+    public function testAddProductVideo()
+    {
+        $videoContent = [
+            'media_type' => 'external-video',
+            'video_provider' => 'vimeo',
+            'video_url' => 'https://vimeo.com/testUrl',
+            'video_title' => 'Vimeo Test Title',
+            'video_description' => 'test description',
+            'video_metadata' => 'video meta data'
+        ];
+
+        $requestData = [
+            'id' => null,
+            'media_type' => 'external-video',
+            'label' => 'Image Text',
+            'position' => 1,
+            'types' => null,
+            'disabled' => false,
+            'content' => [
+                ImageContentInterface::BASE64_ENCODED_DATA => base64_encode(file_get_contents($this->testImagePath)),
+                ImageContentInterface::TYPE => 'image/jpeg',
+                ImageContentInterface::NAME => 'test_image.jpg'
+            ],
+            'extension_attributes' => [
+                'video_content' => $videoContent
+            ]
+        ];
+
+        $actualResult = $this->_webApiCall($this->createServiceInfo, ['sku' => 'simple', 'entry' => $requestData]);
+        $targetProduct = $this->getTargetSimpleProduct();
+        $mediaGallery = $targetProduct->getData('media_gallery');
+
+        $this->assertCount(1, $mediaGallery['images']);
+        $updatedImage = array_shift($mediaGallery['images']);
+        $this->assertEquals($actualResult, $updatedImage['value_id']);
+        $this->assertEquals('Image Text', $updatedImage['label']);
+        $this->assertEquals(1, $updatedImage['position']);
+        $this->assertEquals(0, $updatedImage['disabled']);
+        $this->assertStringStartsWith('/t/e/test_image', $updatedImage['file']);
+        $this->assertEquals($videoContent, array_intersect($updatedImage, $videoContent));
+    }
 }