Extracted logic from wysiwyg OnInsert controller to a model #29677

jmonteros422 · 2020-08-19T13:01:34Z

Description (*)

This PR Extracts logic from Magento\Cms\Controller\Adminhtml\Wysiwyg\Images\OnInsert::execute() controller to Magento\Cms\Model\Wysiwyg\Images\PrepareImage::execute() model

Dependent ASI Pull Request

PR: magento/adobe-stock-integration#1756

Fixed Issues

Fixes magento/adobe-stock-integration#1504: [2.1-develop] Insert rendition images to the content from media gallery instead of original images

…ages to the content from media gallery instead of original images - Extract logic from controller to a model to enable before plugin interception of parameters

m2-assistant · 2020-08-19T13:01:37Z

Hi @jmonteros422. 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

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

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

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

jmonteros422 · 2020-08-19T13:06:35Z

@magento run all tests

sivaschenko

Thanks for the pull request @jmonteros422 ! Please see my comments.

I have removed the information about relation from this PR as it can be processed independently, ASI PR should still keep the relation information (until this PR is merged)

Also please cover the extracted model with an integration test

sivaschenko · 2020-08-19T14:02:49Z

app/code/Magento/Cms/Controller/Adminhtml/Wysiwyg/Images/OnInsert.php

     */
    public function __construct(
        \Magento\Backend\App\Action\Context $context,
        \Magento\Framework\Registry $coreRegistry,
-        \Magento\Framework\Controller\Result\RawFactory $resultRawFactory
+        \Magento\Framework\Controller\Result\RawFactory $resultRawFactory,
+        \Magento\Cms\Model\Wysiwyg\Images\PrepareImage $prepareImage


Please add the constructor dependency in a backwards-compatible way.

See "Adding a constructor parameter" section of https://devdocs.magento.com/contributor-guide/backward-compatible-development/

sivaschenko · 2020-08-19T14:03:36Z

app/code/Magento/Cms/Model/Wysiwyg/Images/PrepareImage.php

+use Magento\Catalog\Helper\Data;
+use Magento\Cms\Helper\Wysiwyg\Images as ImagesHelper;
+
+class PrepareImage


Let's make the class name more meaningful

Suggested change

class PrepareImage

class GetInsertImageContent

sivaschenko · 2020-08-19T14:03:51Z

app/code/Magento/Cms/Controller/Adminhtml/Wysiwyg/Images/OnInsert.php

+    /**
+     * @var \Magento\Cms\Model\Wysiwyg\Images\PrepareImage
+     */
+    protected $prepareImage;


Suggested change

protected $prepareImage;

protected $getInsterImageContent;

sivaschenko · 2020-08-19T14:04:17Z

app/code/Magento/Cms/Controller/Adminhtml/Wysiwyg/Images/OnInsert.php

-            $image = $imagesHelper->getImageHtmlDeclaration($filename, $asIs);
-        }
+        /** @var \Magento\Cms\Model\Wysiwyg\Images\PrepareImage $image */
+        $image = $this->prepareImage->execute($request->getParams());


I'd avoid one-use variables like $image

sivaschenko · 2020-08-19T14:05:45Z

app/code/Magento/Cms/Controller/Adminhtml/Wysiwyg/Images/OnInsert.php

-        } else {
-            $image = $imagesHelper->getImageHtmlDeclaration($filename, $asIs);
-        }
+        /** @var \Magento\Cms\Model\Wysiwyg\Images\PrepareImage $image */


Incorrect and not necessary annotation. $image is a string and that is already defined as a return type of called method

sivaschenko · 2020-08-19T14:08:16Z

app/code/Magento/Cms/Model/Wysiwyg/Images/PrepareImage.php

+    public function execute(array $data): string
+    {
+        $filename = $this->imagesHelper->idDecode($data['filename']);
+        $storeId = (int)$data['store_id'];


Store id value was previously retrieved from store field

sivaschenko · 2020-08-19T14:10:26Z

app/code/Magento/Cms/Model/Wysiwyg/Images/PrepareImage.php

+     * @param array $data
+     * @return string
+     */
+    public function execute(array $data): string


It's better to have the meaningful parameters:

Suggested change

public function execute(array $data): string

public function execute(string $endcodedFilename, int $storeId, bool $forceStaticPath, bool $renderAsTag): string

sivaschenko · 2020-08-19T14:12:58Z

app/code/Magento/Cms/Model/Wysiwyg/Images/PrepareImage.php

+        $filename = $this->imagesHelper->idDecode($data['filename']);
+        $storeId = (int)$data['store_id'];
+
+        $this->catalogHelper->setStoreId($storeId);


Can you please check why this call to catalog helper is needed.

@sivaschenko , did a check on different store view with and without that call and seems to not change anything on the rendered text in the content. I just included it on the model to not miss anything out from the original class. Let me know your thoughts.

sivaschenko · 2020-08-19T14:15:28Z

app/code/Magento/Cms/Model/Wysiwyg/Images/PrepareImage.php

+        if ($data['force_static_path']) {
+            // phpcs:ignore Magento2.Functions.DiscouragedFunction
+            $image = parse_url($this->imagesHelper->getCurrentUrl() . $filename, PHP_URL_PATH);
+        } else {
+            $image = $this->imagesHelper->getImageHtmlDeclaration($filename, $data['as_is']);
+        }
+
+        return $image;


Possible to remove unnecessary variable and simplify the code

Suggested change

if ($data['force_static_path']) {

// phpcs:ignore Magento2.Functions.DiscouragedFunction

$image = parse_url($this->imagesHelper->getCurrentUrl() . $filename, PHP_URL_PATH);

} else {

$image = $this->imagesHelper->getImageHtmlDeclaration($filename, $data['as_is']);

}

return $image;

if ($data['force_static_path']) {

// phpcs:ignore Magento2.Functions.DiscouragedFunction

return parse_url($this->imagesHelper->getCurrentUrl() . $filename, PHP_URL_PATH);

}

return $this->imagesHelper->getImageHtmlDeclaration($filename, $data['as_is']);

…content from media gallery instead of original images - Extracted logic from wysiwyg OnInsert controller to a model

jmonteros422 · 2020-08-21T06:25:09Z

@magento run all tests

…to-the-content-from-media-gallery-instead-of-original-images

… a model to enable before plugin interception of parameters - Test failure fixes. Made store_id parameter optional.

jmonteros422 · 2020-08-21T09:23:42Z

@magento run all tests

… a model to enable before plugin interception of parameters - Fix static test

jmonteros422 · 2020-08-21T14:02:12Z

@magento run all tests

…Insert controller to a model - Integration test

sivaschenko · 2020-08-26T12:00:50Z

@magento run Functional Tests B2B

sivaschenko · 2020-08-27T11:44:23Z

Previous tests failed as they have been triggered from dependent ASI PR

sivaschenko · 2020-08-27T11:44:31Z

@magento run all tests

sidolov · 2020-08-27T15:06:56Z

app/code/Magento/Cms/Controller/Adminhtml/Wysiwyg/Images/OnInsert.php

-     * @param \Magento\Framework\Controller\Result\RawFactory $resultRawFactory
+     * @var GetInsertImageContent
+     */
+    protected $getInsertImageContent;


Should be private.

Pull Request state was updated. Re-review required.

sivaschenko · 2020-08-28T10:23:57Z

@magento run all tests

…to-the-content-from-media-gallery-instead-of-original-images

sivaschenko · 2020-09-01T19:22:18Z

@magento run all tests

m2-assistant · 2020-09-02T14:26:27Z

Hi @jmonteros422, 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.

magento/adobe-stock-integration#1504:[Related PR] Insert rendition im…

ff37e3f

…ages to the content from media gallery instead of original images - Extract logic from controller to a model to enable before plugin interception of parameters

jmonteros422 added Component: Cms Component: MediaContentApi Project: ASI Component: MediaGalleryIntegration labels Aug 19, 2020

jmonteros422 requested a review from sivaschenko August 19, 2020 13:01

ghost added the Progress: pending review label Aug 19, 2020

magento-engcom-team added Release Line: 2.4 and removed Component: MediaContentApi Component: MediaGalleryIntegration labels Aug 19, 2020

jmonteros422 changed the title ~~magento/adobe-stock-integration#1504:[Related M2 PR] Insert rendition images to the content from media gallery instead of original images~~ #1504:[Related M2 PR] Insert rendition images to the content from media gallery instead of original images Aug 19, 2020

sivaschenko requested changes Aug 19, 2020

View reviewed changes

ghost assigned sivaschenko Aug 19, 2020

ghost added Progress: needs update and removed Progress: pending review labels Aug 19, 2020

sivaschenko changed the title ~~#1504:[Related M2 PR] Insert rendition images to the content from media gallery instead of original images~~ Extracted logic from wysiwyg OnInsert controller to a model Aug 19, 2020

sivaschenko added Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Severity: S2 Major restrictions or short-term circumventions are required until a fix is available. labels Aug 19, 2020

jmonteros422 mentioned this pull request Aug 19, 2020

#1504: [2.1-develop] Insert rendition images to the content from media gallery instead of original images magento/adobe-stock-integration#1756

Merged

magento/adobe-stock-integration#1504: Insert rendition images to the …

29d0707

…content from media gallery instead of original images - Extracted logic from wysiwyg OnInsert controller to a model

jmonteros422 changed the title ~~Extracted logic from wysiwyg OnInsert controller to a model~~ [WIP] Extracted logic from wysiwyg OnInsert controller to a model Aug 21, 2020

jmonteros422 added 2 commits August 21, 2020 16:21

Merge branch '2.4-develop' into 1504-M2-repo-Insert-rendition-images-…

c06a44c

…to-the-content-from-media-gallery-instead-of-original-images

magento/adobe-stock-integration#1504:Extract logic from controller to…

e228d76

… a model to enable before plugin interception of parameters - Test failure fixes. Made store_id parameter optional.

magento/adobe-stock-integration#1504:Extract logic from controller to…

408cdb7

… a model to enable before plugin interception of parameters - Fix static test

magento/adobe-stock-integration#1504: Extracted logic from wysiwyg On…

45849cc

…Insert controller to a model - Integration test

chalov-anton added Progress: ready for testing QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope and removed Progress: testing in progress labels Aug 26, 2020

ghost added Progress: extended testing and removed Progress: ready for testing labels Aug 26, 2020

engcom-Foxtrot self-assigned this Aug 26, 2020

ghost added Progress: accept and removed Progress: extended testing labels Aug 27, 2020

sidolov requested changes Aug 27, 2020

View reviewed changes

ghost assigned sidolov Aug 27, 2020

ghost added Progress: needs update and removed Progress: accept labels Aug 27, 2020

magento#29677: Corrected property access level

6f1f676

sivaschenko approved these changes Aug 28, 2020

View reviewed changes

ghost added Progress: ready for testing Progress: testing in progress Progress: accept and removed Progress: needs update Progress: ready for testing Progress: testing in progress labels Aug 28, 2020

sivaschenko added 2 commits September 1, 2020 20:20

magento#29677: Returned existing behaviour

ab2782f

Merge branch '2.4-develop' into 1504-M2-repo-Insert-rendition-images-…

78beb69

…to-the-content-from-media-gallery-instead-of-original-images

magento-engcom-team merged commit e7ca769 into magento:2.4-develop Sep 2, 2020

	public function execute(array $data): string
	public function execute(string $endcodedFilename, int $storeId, bool $forceStaticPath, bool $renderAsTag): string

Extracted logic from wysiwyg OnInsert controller to a model #29677

Extracted logic from wysiwyg OnInsert controller to a model #29677

Uh oh!

Conversation

jmonteros422 commented Aug 19, 2020 • edited by sivaschenko Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Dependent ASI Pull Request

Fixed Issues

Uh oh!

m2-assistant bot commented Aug 19, 2020

Uh oh!

jmonteros422 commented Aug 19, 2020

Uh oh!

sivaschenko left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmonteros422 commented Aug 21, 2020

Uh oh!

jmonteros422 commented Aug 21, 2020

Uh oh!

jmonteros422 commented Aug 21, 2020

Uh oh!

sivaschenko commented Aug 26, 2020

Uh oh!

sivaschenko commented Aug 27, 2020

Uh oh!

sivaschenko commented Aug 27, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sivaschenko commented Aug 28, 2020

Uh oh!

sivaschenko commented Sep 1, 2020

Uh oh!

m2-assistant bot commented Sep 2, 2020

Uh oh!

Uh oh!

jmonteros422 commented Aug 19, 2020 •

edited by sivaschenko

Loading

sivaschenko left a comment •

edited

Loading