#1440: create an endpoint for saving asset attributes

MediaGalleryUi/Controller/Adminhtml/Image/SaveDetails.php

@@ -0,0 +1,169 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MediaGalleryUi\Controller\Adminhtml\Image;
+
+use Exception;
+use Magento\Backend\App\Action;
+use Magento\Backend\App\Action\Context;
+use Magento\Framework\App\Action\HttpPostActionInterface;
+use Magento\Framework\Controller\Result\Json;
+use Magento\Framework\Controller\ResultFactory;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\MediaGalleryApi\Api\Data\AssetKeywordsInterfaceFactory;
+use Magento\MediaGalleryApi\Api\Data\AssetInterfaceFactory;
+use Magento\MediaGalleryApi\Api\GetAssetsByIdsInterface;
+use Magento\MediaGalleryApi\Api\SaveAssetsInterface;
+use Magento\MediaGalleryApi\Api\SaveAssetsKeywordsInterface;
+use Psr\Log\LoggerInterface;
+
+class SaveDetails extends Action implements HttpPostActionInterface
+{
+    private const HTTP_OK = 200;
+    private const HTTP_INTERNAL_ERROR = 500;
+    private const HTTP_BAD_REQUEST = 400;
+
+    /**
+     * @see _isAllowed()
+     */
+    public const ADMIN_RESOURCE = 'Magento_Cms::media_gallery';
+
+    /**
+     * @var SaveAssetsInterface
+     */
+    private $saveAssets;
+
+    /**
+     * @var SaveAssetsKeywordsInterface
+     */
+    private $saveAssetKeywords;
+
+    /**
+     * @var AssetKeywordsInterfaceFactory
+     */
+    private $assetKeywordsFactory;
+
+    /**
+     * @var AssetInterfaceFactory
+     */
+    private $assetFactory;
+
+    /**
+     * @var GetAssetsByIdsInterface
+     */
+    private $getAssetsByIds;
+
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * SaveDetails constructor.
+     *
+     * @param Context $context
+     * @param SaveAssetsInterface $saveAssets
+     * @param SaveAssetsKeywordsInterface $saveAssetKeywords
+     * @param AssetInterfaceFactory $assetFactory
+     * @param AssetKeywordsInterfaceFactory $assetKeywordsFactory
+     * @param GetAssetsByIdsInterface $getAssetsByIds
+     * @param LoggerInterface $logger
+     */
+    public function __construct(
+        Context $context,
+        SaveAssetsInterface $saveAssets,
+        SaveAssetsKeywordsInterface $saveAssetKeywords,
+        AssetInterfaceFactory $assetFactory,
+        AssetKeywordsInterfaceFactory $assetKeywordsFactory,
+        GetAssetsByIdsInterface $getAssetsByIds,
+        LoggerInterface $logger
+    ) {
+        parent::__construct($context);
+
+        $this->saveAssets = $saveAssets;
+        $this->saveAssetKeywords = $saveAssetKeywords;
+        $this->assetFactory = $assetFactory;
+        $this->assetKeywordsFactory = $assetKeywordsFactory;
+        $this->getAssetsByIds = $getAssetsByIds;
+        $this->logger = $logger;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function execute()
+    {
+        /** @var Json $resultJson */
+        $resultJson = $this->resultFactory->create(ResultFactory::TYPE_JSON);
+        $imageId = (int) $this->getRequest()->getParam('id');
+        $title = $this->getRequest()->getParam('title');
+        $description = $this->getRequest()->getParam('description');
+        $imageKeywords = (array) $this->getRequest()->getParam('keywords');
+
+        if ($imageId === 0) {
+            $responseContent = [
+                'success' => false,
+                'message' => __('Image ID is required.'),
+            ];
+            $resultJson->setHttpResponseCode(self::HTTP_BAD_REQUEST);
+            $resultJson->setData($responseContent);
+
+            return $resultJson;
+        }
+
+        try {
+            $asset = current($this->getAssetsByIds->execute([$imageId]));
+            $updatedAsset = $this->assetFactory->create(
+                [
+                    'path' => $asset->getPath(),
+                    'contentType' => $asset->getContentType(),
+                    'width' => $asset->getWidth(),
+                    'height' => $asset->getHeight(),
+                    'size' => $asset->getSize(),
+                    'id' => $asset->getId(),
+                    'title' => $title,
+                    'description' => $description,
+                    'source' => $asset->getSource(),
+                    'hash' => $asset->getHash(),
+                    'created_at' => $asset->getCreatedAt(),
+                    'updated_at' => $asset->getUpdatedAt()
+                ]
+            );
+            $this->saveAssets->execute([$updatedAsset]);
+
+            $assetKeywords = $this->assetKeywordsFactory->create([
+                'assetId' => $imageId,
+                'keywords' => $imageKeywords
+            ]);
+            $this->saveAssetKeywords->execute([$assetKeywords]);
+
+            $responseCode = self::HTTP_OK;
+            $responseContent = [
+                'success' => true,
+                'message' => __('You have successfully saved the image "%image"', ['image' => $title]),
+            ];
+        } catch (LocalizedException $exception) {
+            $responseCode = self::HTTP_BAD_REQUEST;
+            $responseContent = [
+                'success' => false,
+                'message' => $exception->getMessage(),
+            ];
+        } catch (Exception $exception) {
+            $this->logger->critical($exception);
+            $responseCode = self::HTTP_INTERNAL_ERROR;
+            $responseContent = [
+                'success' => false,
+                'message' => __('An error occurred on attempt to save image.'),
+            ];
+        }
+
+        $resultJson->setHttpResponseCode($responseCode);
+        $resultJson->setData($responseContent);
+
+        return $resultJson;
+    }
+}

MediaGalleryUi/Test/Mftf/ActionGroup/AdminEnhancedMediaGalleryEditImageDetailsActionGroup.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+
+<actionGroups xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+              xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/actionGroupSchema.xsd">
+    <actionGroup name="AdminEnhancedMediaGalleryEditImageDetailsActionGroup">
+        <annotations>
+            <description>Opens Edit image details panel panel for the first image in the media gallery grid</description>
+        </annotations>
+
+        <click selector="{{AdminEnhancedMediaGalleryImageActionsSection.openContextMenu}}" stepKey="openContextMenu"/>
+        <click selector="{{AdminEnhancedMediaGalleryImageActionsSection.edit}}" stepKey="edit"/>
+        <waitForLoadingMaskToDisappear stepKey="waitForLoadingMaskToDisappear"/>
+    </actionGroup>
+</actionGroups>

MediaGalleryUi/Test/Mftf/ActionGroup/AdminEnhancedMediaGalleryImageDetailsSaveActionGroup.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+
+<actionGroups xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+              xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/actionGroupSchema.xsd">
+    <actionGroup name="AdminEnhancedMediaGalleryImageDetailsSaveActionGroup">
+        <annotations>
+            <description>Save image details from the View Details panel</description>
+        </annotations>
+        <arguments>
+            <argument name="title" type="string" defaultValue="magento"/>
+            <argument name="description" type="string" defaultValue="Test Description"/>
+        </arguments>
+
+        <fillField selector="{{AdminEnhancedMediaGalleryEditDetailsSection.title}}" userInput="{{title}}" stepKey="setTitle" />
+        <fillField selector="{{AdminEnhancedMediaGalleryEditDetailsSection.description}}" userInput="{{description}}" stepKey="setDescription" />
+        <click selector="{{AdminEnhancedMediaGalleryEditDetailsSection.save}}" stepKey="saveDetails"/>
+        <waitForLoadingMaskToDisappear stepKey="waitForLoadingMaskToDisappear"/>
+    </actionGroup>
+</actionGroups>

MediaGalleryUi/Test/Mftf/ActionGroup/AdminEnhancedMediaGalleryVerifyImageDetailsWithDescriptionActionGroup.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+
+<actionGroups xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+              xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/actionGroupSchema.xsd">
+    <actionGroup name="AdminEnhancedMediaGalleryVerifyImageDetailsWithDescriptionActionGroup">
+        <annotations>
+            <description>Verifies image information on the View Details panel including the description</description>
+        </annotations>
+        <arguments>
+            <argument name="image"/>
+        </arguments>
+
+        <grabTextFrom selector="{{AdminEnhancedMediaGalleryViewDetailsSection.title}}" stepKey="grabImageTitle"/>
+        <assertStringContainsString stepKey="verifyImageTitle">
+            <actualResult type="variable">grabImageTitle</actualResult>
+            <expectedResult type="string">{{image.fileName}}</expectedResult>
+        </assertStringContainsString>
+
+        <grabTextFrom selector="{{AdminEnhancedMediaGalleryViewDetailsSection.contentType}}" stepKey="grabContentType"/>
+        <assertStringContainsStringIgnoringCase stepKey="verifyContentType">
+            <actualResult type="variable">grabContentType</actualResult>
+            <expectedResult type="string">{{image.extension}}</expectedResult>
+        </assertStringContainsStringIgnoringCase>
+
+        <grabTextFrom selector="{{AdminEnhancedMediaGalleryViewDetailsSection.type}}" stepKey="grabType"/>
+        <assertStringContainsString stepKey="verifyType">
+            <actualResult type="variable">grabType</actualResult>
+            <expectedResult type="string">Image</expectedResult>
+        </assertStringContainsString>
+
+        <grabTextFrom selector="{{AdminEnhancedMediaGalleryViewDetailsSection.description}}" stepKey="grabDescription"/>
+        <assertStringContainsString stepKey="verifyDescription">
+            <actualResult type="variable">grabDescription</actualResult>
+            <expectedResult type="string">Test Description</expectedResult>
+        </assertStringContainsString>
+    </actionGroup>
+</actionGroups>

MediaGalleryUi/Test/Mftf/ActionGroup/AdminMediaGalleryEnhancedEnableActionGroup.xml

@@ -16,6 +16,7 @@
         <waitForPageLoad stepKey="waitForPageLoad"/>
         <scrollTo selector="{{AdminConfigSystemSection.enhancedMediaGalleryFieldset}}" stepKey="scrollToEnhancedMediaGalleryFieldset"/>
         <conditionalClick stepKey="expandEnhancedMediaGalleryTab" selector="{{AdminConfigSystemSection.enhancedMediaGalleryFieldset}}" dependentSelector="{{AdminConfigSystemSection.enhancedMediaGalleryEnabledField}}" visible="false" />
+        <waitForElementVisible selector="{{AdminConfigSystemSection.enhancedMediaGalleryFieldset}}" stepKey="waitForFieldset" />
         <selectOption userInput="{{enabled}}" selector="{{AdminConfigSystemSection.enhancedMediaGalleryEnabledField}}" stepKey="enableOrDisableMediaGallery"/>
         <click selector="{{AdminConfigSystemSection.saveConfig}}" stepKey="saveConfiguration"/>
         <waitForPageLoad stepKey="waitForConfigurationToSave"/>

MediaGalleryUi/Test/Mftf/Section/AdminEnhancedMediaGalleryEditDetailsSection.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+
+<sections xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:noNamespaceSchemaLocation="urn:magento:mftf:Page/etc/SectionObject.xsd">
+    <section name="AdminEnhancedMediaGalleryEditDetailsSection">
+        <element name="title" type="input" selector="#title"/>
+        <element name="fileName" type="text" selector="#path"/>
+        <element name="description" type="textarea" selector="#description"/>
+        <element name="cancel" type="button" selector="#image-details-action-cancel"/>
+        <element name="save" type="button" selector="#image-details-action-save"/>
+    </section>
+</sections>

MediaGalleryUi/Test/Mftf/Section/AdminEnhancedMediaGalleryImageActionsSection.xml

@@ -11,6 +11,7 @@
         <element name="openContextMenu" type="button" selector=".three-dots"/>
         <element name="viewDetails" type="button" selector="[data-ui-id='action-image-details']"/>
         <element name="delete" type="button" selector="[data-ui-id='action-delete']"/>
+        <element name="edit" type="button" selector="[data-ui-id='action-edit']"/>
         <element name="imageInGrid" type="button" selector="//img[@class='media-gallery-image-column'][contains(@src, '{{imageName}}')]" parameterized="true"/>
     </section>
 </sections>

MediaGalleryUi/Test/Mftf/Section/AdminEnhancedMediaGalleryViewDetailsSection.xml

@@ -12,6 +12,7 @@
         <element name="contentType" type="text" selector="[data-ui-id='content-type']"/>
         <element name="type" type="text" selector="//div[@class='attribute']/span[contains(text(), 'Type')]/following-sibling::div"/>
         <element name="height" type="text" selector="//div[@class='attribute']/span[contains(text(), 'Height')]/following-sibling::div"/>
+        <element name="description" type="text" selector=".image-details p"/>
         <element name="delete" type="button" selector="//div[@class='media-gallery-image-details-modal']//button[contains(@class, 'delete')]"/>
         <element name="confirmDelete" type="button" selector=".action-accept"/>
         <element name="addImage" type="button" selector=".add-image-action"/>

MediaGalleryUi/Test/Mftf/Test/AdminMediaGalleryEditSaveImageDetailsTest.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+
+<tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/testSchema.xsd">
+    <test name="AdminMediaGalleryEditSaveImageDetailsTest">
+        <annotations>
+            <features value="MediaGallery"/>
+            <useCaseId value="https://github.com/magento/adobe-stock-integration/issues/724"/>
+            <title value="User edits image meta data in media gallery"/>
+            <stories value="[Story # 38] User views basic image attributes in Media Gallery"/>
+            <testCaseId value="https://studio.cucumber.io/projects/131313/test-plan/folders/1320712/scenarios/3961351"/>
+            <description value="User edits image meta data in Standalone Media Gallery"/>
+            <severity value="CRITICAL"/>
+            <group value="media_gallery_ui"/>
+        </annotations>
+        <before>
+            <actionGroup ref="AdminLoginActionGroup" stepKey="loginAsAdmin"/>
+            <actionGroup ref="AdminOpenMediaGalleryForPageNoEditorActionGroup" stepKey="openMediaGalleryForPage"/>
+        </before>
+        <after>
+            <actionGroup ref="AdminEnhancedMediaGalleryImageDetailsDeleteActionGroup" stepKey="deleteImage"/>
+        </after>
+
+        <actionGroup ref="AdminEnhancedMediaGalleryUploadImageActionGroup" stepKey="uploadImage">
+            <argument name="image" value="ImageUpload"/>
+        </actionGroup>
+        <actionGroup ref="AdminEnhancedMediaGalleryEditImageDetailsActionGroup" stepKey="editImageDetails"/>
+        <actionGroup ref="AdminEnhancedMediaGalleryImageDetailsSaveActionGroup" stepKey="saveImage"/>
+        <actionGroup ref="AdminEnhancedMediaGalleryViewImageDetails" stepKey="viewImageDetails"/>
+        <actionGroup ref="AdminEnhancedMediaGalleryVerifyImageDetailsWithDescriptionActionGroup" stepKey="verifyImageDetails">
+            <argument name="image" value="ImageUpload"/>
+        </actionGroup>
+    </test>
+</tests>

MediaGalleryUi/Test/Mftf/Test/AdminStandaloneMediaGalleryEditSaveImageDetailsTest.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+
+<tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/testSchema.xsd">
+    <test name="AdminStandaloneMediaGalleryEditSaveImageDetailsTest">
+        <annotations>
+            <features value="MediaGallery"/>
+            <useCaseId value="https://github.com/magento/adobe-stock-integration/issues/724"/>
+            <title value="User edits image meta data in standalone media gallery"/>
+            <stories value="[Story # 38] User views basic image attributes in Media Gallery"/>
+            <testCaseId value="https://studio.cucumber.io/projects/131313/test-plan/folders/1320712/scenarios/3961351"/>
+            <description value="User edits image meta data in Standalone Media Gallery"/>
+            <severity value="CRITICAL"/>
+            <group value="media_gallery_ui"/>
+        </annotations>
+        <before>
+            <actionGroup ref="AdminLoginActionGroup" stepKey="loginAsAdmin"/>
+            <actionGroup ref="AdminOpenStandaloneMediaGalleryActionGroup" stepKey="openStandaloneMediaGallery"/>
+        </before>
+        <after>
+            <actionGroup ref="AdminEnhancedMediaGalleryImageDetailsDeleteActionGroup" stepKey="deleteImage"/>
+        </after>
+
+        <actionGroup ref="AdminEnhancedMediaGalleryUploadImageActionGroup" stepKey="uploadImage">
+            <argument name="image" value="ImageUpload"/>
+        </actionGroup>
+        <actionGroup ref="AdminEnhancedMediaGalleryEditImageDetailsActionGroup" stepKey="editImageDetails"/>
+        <actionGroup ref="AdminEnhancedMediaGalleryImageDetailsSaveActionGroup" stepKey="saveImage"/>
+        <actionGroup ref="AdminEnhancedMediaGalleryViewImageDetails" stepKey="viewImageDetails"/>
+        <actionGroup ref="AdminEnhancedMediaGalleryVerifyImageDetailsWithDescriptionActionGroup" stepKey="verifyImageDetails">
+            <argument name="image" value="ImageUpload"/>
+        </actionGroup>
+    </test>
+</tests>

MediaGalleryUi/view/adminhtml/layout/media_gallery_index_index.xml

@@ -21,6 +21,12 @@
                     <argument name="imageDetailsUrl" xsi:type="url" path="media_gallery/image/details"/>
                 </arguments>
             </block>
+            <block name="image.edit.details" class="Magento\Backend\Block\Template" template="Magento_MediaGalleryUi::image_edit_details.phtml">
+                <arguments>
+                    <argument name="imageEditDetailsUrl" xsi:type="url" path="media_gallery/image/details"/>
+                    <argument name="saveDetailsUrl" xsi:type="url" path="media_gallery/image/saveDetails"/>
+                </arguments>
+            </block>
         </block>
     </container>
 </layout>