Introduced MediaContent and MediaContentApi modules #27536

sivaschenko · 2020-04-01T16:13:19Z

Depends on:

Description (*)

The Magento_MediaContent module provides implementations for managing relations between content and media files used in that content.

Additionally observers have been added to Cms and Catalog modules to save the relation of corresponding entities to MediaContent storage

Story

magento/adobe-stock-integration#717: User sees pages the image is used in Magento

Related Pull Requests

magento/adobe-stock-integration#1235

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
All automated tests passed successfully (all builds are green)

m2-assistant · 2020-04-01T16:13:22Z

Hi @sivaschenko. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Guide documentation.

sivaschenko · 2020-04-02T17:41:48Z

app/code/Magento/MediaContentCatalog/Observer/Product.php

+    {
+        /** @var CatalogProduct $model */
+        $model = $observer->getEvent()->getData('product');
+        if ($model instanceof AbstractModel) {


Suggested change

if ($model instanceof AbstractModel) {

if ($model instanceof \Magento\Catalog\Model\Product) {

@sivaschenko will this work if this preference will be changed <preference for="Magento\Catalog\Api\Data\ProductInterface" type="Magento\Catalog\Model\Product" /> and Magento\Catalog\Api\Data\ProductInterface will have another implementation?

If not can we leave AbstractModel instance identification? I can hardly imagine the case when the Magento\Catalog\Api\Data\ProductInterface can have another implementation but if this possible from the di perspective it can break the process. Or I missed something?

@naydav can you please address this question?

app/code/Magento/MediaContent/etc/db_schema.xml

…media-content

maghamed

Do we expect to expose any of those newly created APIs via WEB API ?

maghamed · 2020-04-02T19:37:19Z

app/code/Magento/MediaContentApi/Api/ExtractAssetFromContentInterface.php

+     * @param string $content
+     * @return AssetInterface[]
+     */
+    public function execute(string $content): array;


what's $content in this case?

A "content" in the scope of the MediaContent domain is an alias to any kind of an object property which possibly contains a media asset. For example, a product object has a description which probably includes a media asset. A category object description and image also can have a media asset as a part of storage data.

How somebody (a developer) knows what to put in this property? Where to find list of supported aliases?

Data, selected for this property, is a developer choice made on next conclusion: if an object has a property which possibly contains a media asset, to get it from this property it needs to be sent to this Interface implementation. For example, currently, we represented a declaration of content properties in di:
https://github.com/magento/magento2/pull/27536/files/b6e79cf870273936cb70ffc05add1fa73a9e3334#diff-bcf67dbc51c19997838fdb60cee182abR9-R16

List of aliases, in that case, is a list of properties declared manually based on data structure and a possibility to have a media asset in properties.

@buskamuza that's a parser that looks for image mentions in any content/text/string. Should we change the naming to make it better understandable or improving comments would be enough?

maghamed · 2020-04-02T19:39:41Z

app/code/Magento/MediaContentApi/Api/GetContentWithAssetInterface.php

+    /**
+     * @param int $assetId
+     *
+     * @return array


what's the format of return result ? Not looking at implementation it's not clear

It's ContentIdentityInterface[] (introduced data interface), the code is updated

app/code/Magento/MediaContent/Model/UnassignAsset.php

app/code/Magento/MediaContent/composer.json

sidolov · 2020-04-02T21:14:28Z

app/code/Magento/MediaContent/etc/di.xml

+    <preference for="Magento\MediaContentApi\Api\UnassignAssetInterface" type="Magento\MediaContent\Model\UnassignAsset"/>
+    <preference for="Magento\MediaContentApi\Api\GetAssetsUsedInContentInterface" type="Magento\MediaContent\Model\GetAssetsUsedInContent"/>
+    <preference for="Magento\MediaContentApi\Api\GetContentWithAssetInterface" type="Magento\MediaContent\Model\GetContentWithAsset"/>
+    <preference for="Magento\MediaContentApi\Api\ExtractAssetFromContentInterface" type="Magento\MediaContent\Model\ExtractAssetFromContent"/>


Why interface and implementation located in one module and marked as API? It does not make sense for me. It would be better to leave the interface only.

The interface is used for injecting the service, the model is used for di configuration

That change was requested by @naydav at the online review

app/code/Magento/MediaContent/Model/Content/ConfigInterface.php

app/code/Magento/MediaContent/Model/Content/Config.php

sivaschenko

Review with Valerii

app/code/Magento/MediaContent/Model/ContentIdentity.php

sivaschenko · 2020-04-14T16:44:34Z

app/code/Magento/MediaContent/Model/ContentIdentity.php

+    /**
+     * @inheritdoc
+     */
+    public function setExtensionAttributes(ContentIdentityExtensionInterface $extensionAttributes): void


Delete all setExtensionAttributes if it works with webapi

app/code/Magento/MediaContent/Model/GetAssetIdsUsedInContent.php

app/code/Magento/MediaContent/Model/GetContentWithAssets.php

app/code/Magento/MediaContent/Model/RemoveRelationsForAssetIds.php

app/code/Magento/MediaContent/Model/UpdateRelations.php

sivaschenko · 2020-04-14T17:06:48Z

app/code/Magento/MediaContent/Plugin/MediaGalleryAssetDeleteByDirectoryPath.php

+     * @param string $path
+     * @return int[]
+     */
+    private function getAssetIdsByDirectoryPath(string $path): array


Update after MediaGallery PR is merged

sivaschenko · 2020-04-14T17:07:50Z

app/code/Magento/MediaContent/Plugin/MediaGalleryAssetDeleteByPath.php

+        \Closure $proceed,
+        string $mediaAssetPath
+    ) : void {
+        $asset = $this->getByPath->execute($mediaAssetPath);


update after merge of MediaGallery PR

app/code/Magento/MediaContentCatalog/Observer/Category.php

sivaschenko · 2020-04-14T17:23:44Z

app/code/Magento/MediaContentCms/Observer/Page.php

+     *
+     * @param Observer $observer
+     */
+    public function execute(Observer $observer): void


Observers appear to be deprecated (but not documented)

lenaorobei · 2020-04-16T19:11:01Z

Performance build: https://bamboo.corp.magento.com/browse/MCCE24-MCCE24405-1

VladimirZaets · 2020-04-16T20:46:53Z

@magento run tests

VladimirZaets · 2020-04-16T20:47:39Z

@magento run all tests

…tent

VladimirZaets · 2020-04-16T22:10:41Z

@magento run all tests

VladimirZaets · 2020-04-17T00:04:20Z

@magento run all tests

sivaschenko · 2020-04-19T16:51:05Z

The pull request was tested with Used In functionality on Adobe Stock Integration

…content

m2-assistant · 2020-04-20T15:48:01Z

Hi @sivaschenko, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

ghost added the Progress: pending review label Apr 1, 2020

magento-engcom-team added Component: Catalog Component: Cms Component: MediaContent Release Line: 2.4 labels Apr 1, 2020

sivaschenko requested review from coderimus, sidolov, slavvka and naydav April 1, 2020 16:13

Introduced MediaContent and MediaContentApi modules

d88ed42

sivaschenko requested review from angelgonzalezi4 and VladimirZaets and removed request for angelgonzalezi4 April 1, 2020 16:23

sivaschenko added 3 commits April 1, 2020 17:54

#27536: Included MediaContent modules in root composer.json

49f254a

#27536: Code review changes

6cd1dac

#27536: Code review changes

b6e79cf

sivaschenko commented Apr 2, 2020

View reviewed changes

ghost assigned sivaschenko Apr 2, 2020

sivaschenko commented Apr 2, 2020

View reviewed changes

app/code/Magento/MediaContent/etc/db_schema.xml Outdated Show resolved Hide resolved

Merge remote-tracking branch 'mainline/2.4-develop' into sivaschenko-…

123d06a

…media-content

maghamed reviewed Apr 2, 2020

View reviewed changes

ghost assigned maghamed Apr 2, 2020

sidolov requested changes Apr 2, 2020

View reviewed changes

ghost assigned sidolov Apr 2, 2020

ghost added Progress: needs update and removed Progress: pending review labels Apr 2, 2020

#27536: Review fixes

23fb914

sivaschenko commented Apr 14, 2020

View reviewed changes

app/code/Magento/MediaContent/Model/Content/ConfigInterface.php Outdated Show resolved Hide resolved

sivaschenko commented Apr 14, 2020

View reviewed changes

app/code/Magento/MediaContent/Model/Content/Config.php Outdated Show resolved Hide resolved

sivaschenko commented Apr 14, 2020

View reviewed changes

sivaschenko added the has dependency label Apr 15, 2020

Changes according to review

73fb878

magento-engcom-team added Component: MediaContentApi and removed Component: Catalog Component: Cms labels Apr 16, 2020

Merge branch '2.4-develop' into media-content

c013df9

VladimirZaets added 2 commits April 16, 2020 16:55

Fix integration and static tests

4d33b02

Merge remote-tracking branch 'ivashenko/media-content' into media-con…

dd9bf0c

…tent

Fix plugin namespace

2db43c2

Merge branch '2.4-develop' into media-content

3a5a830

sivaschenko mentioned this pull request Apr 18, 2020

Media Content Moved to Magento and Used In functionality magento/adobe-stock-integration#1235

Merged

Corrected classes and search patterns

4b6e8f6

sivaschenko added 4 commits April 19, 2020 20:49

Fixed static tests

76ba852

Merge branch '2.4-develop' of github.com:magento/magento2 into media-…

8d05d0e

…content

Fixed integration tests

44cb07a

Updated db_schema_whitelist.json

1c521b1

magento-engcom-team merged commit 1e28f35 into magento:2.4-develop Apr 20, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduced MediaContent and MediaContentApi modules #27536

Introduced MediaContent and MediaContentApi modules #27536

sivaschenko commented Apr 1, 2020 •

edited

Loading

m2-assistant bot commented Apr 1, 2020

sivaschenko Apr 2, 2020

coderimus Apr 2, 2020

sivaschenko Apr 2, 2020

coderimus Apr 2, 2020

sivaschenko Apr 3, 2020

maghamed left a comment

maghamed Apr 2, 2020

coderimus Apr 2, 2020

buskamuza Apr 2, 2020

coderimus Apr 3, 2020

sivaschenko Apr 3, 2020

maghamed Apr 2, 2020

sivaschenko Apr 3, 2020

sidolov Apr 2, 2020 •

edited

Loading

sivaschenko Apr 3, 2020

sivaschenko left a comment

sivaschenko Apr 14, 2020

sivaschenko Apr 14, 2020

sivaschenko Apr 14, 2020

sivaschenko Apr 14, 2020

lenaorobei commented Apr 16, 2020

VladimirZaets commented Apr 16, 2020

VladimirZaets commented Apr 16, 2020

VladimirZaets commented Apr 16, 2020

VladimirZaets commented Apr 17, 2020

sivaschenko commented Apr 19, 2020

m2-assistant bot commented Apr 20, 2020

	if ($model instanceof AbstractModel) {
	if ($model instanceof \Magento\Catalog\Model\Product) {

Introduced MediaContent and MediaContentApi modules #27536

Introduced MediaContent and MediaContentApi modules #27536

Conversation

sivaschenko commented Apr 1, 2020 • edited Loading

Description (*)

Story

Related Pull Requests

Contribution checklist (*)

m2-assistant bot commented Apr 1, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maghamed left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sidolov Apr 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sivaschenko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lenaorobei commented Apr 16, 2020

VladimirZaets commented Apr 16, 2020

VladimirZaets commented Apr 16, 2020

VladimirZaets commented Apr 16, 2020

VladimirZaets commented Apr 17, 2020

sivaschenko commented Apr 19, 2020

m2-assistant bot commented Apr 20, 2020

sivaschenko commented Apr 1, 2020 •

edited

Loading

sidolov Apr 2, 2020 •

edited

Loading