Chore: Catalog Widget - Replace Block Escaping with Escaper #37082

pykettk · 2023-03-09T01:33:51Z

Description (*)

Refactors the Magento_CatalogWidget module to replace $block escaping functions with $escaper escaping functions.

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)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

Resolved issues:

resolves [Issue] Chore: Catalog Widget - Replace Block Escaping with Escaper #37107: Chore: Catalog Widget - Replace Block Escaping with Escaper

m2-assistant · 2023-03-09T01:33:54Z

Hi @pykettk. Thank you for your contribution!
Here are some useful tips on 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
Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

pykettk · 2023-03-09T01:38:58Z

@magento create issue

andrewbess

Hello @pykettk
Thank you for your contribution here.

engcom-Lima · 2023-03-15T12:51:36Z

✔️ QA Passed

Preconditions:

Install fresh Magento 2.4-develop and PHP 8.1

Manual testing scenario:

In code base verify $block replaces with $escaper in the app/code/Magento/CatalogWidget/view/adminhtml/templates/product/widget/conditions.phtml

and app/code/Magento/CatalogWidget/view/frontend/templates/product/widget/content/grid.phtml

Before: ✖️

After: ✔️

Additionally tested:

Create, Edit and deleted the widget.
Verified the created widget functionality in the frontend.
Verified the admin grid of widget.

No additional manual testing is required as a part of regression cycle as this PR is related to the refactoring of the code base.

As builds are failed. Hence, moving this PR to Extended testing

engcom-Lima · 2023-03-15T12:52:05Z

@magento run all tests

magento-automated-testing · 2023-03-15T12:52:11Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Delta · 2023-03-16T07:23:26Z

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE, Static Tests, Unit Tests

magento-automated-testing · 2023-03-16T07:23:31Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

magento-automated-testing · 2023-03-16T10:00:35Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

magento-automated-testing · 2023-03-16T10:33:48Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Delta · 2023-03-16T11:38:54Z

@magento run Static Tests

magento-automated-testing · 2023-03-16T11:38:59Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

magento-automated-testing · 2023-03-16T11:58:19Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Charlie · 2023-03-20T13:37:56Z

Hi @pykettk,

Thank you for the contribution!

As your branch is forked from https://github.com/mage-os/mageos-magento2.git, we can not able to work on it. Can you please have a look at them else we have to create a new PR from branch forked from https://github.com/magento/magento2.git and close this one.

Thank you!

pykettk · 2023-03-20T16:02:25Z

@engcom-Charlie What changes would you like me to make?

engcom-Charlie · 2023-03-21T05:48:25Z

@magento run Static Tests

magento-automated-testing · 2023-03-21T05:48:33Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Lima · 2023-03-21T10:33:42Z

Hi @pykettk ,

@engcom-Charlie What changes would you like me to make?

In order to move ahead to merge in progress all builds should be green. As build is failing our team have to work on it but as your PR is forked from mage-os we can't proceed further on it.
Please check this comment and please act accordingly.

Thanks

pykettk · 2023-03-21T14:14:42Z

@engcom-Lima Your response doesn't answer the question. Please act accordingly and please have a look at them are not clear instructions. I'm more than happy to help unstick this problem but it is not clear to me what you need me to do. Please do not close this PR whilst I am showing a willingness to be helpful 🙂

pykettk · 2023-03-21T14:15:36Z

@magento run Static Tests

magento-automated-testing · 2023-03-21T14:15:47Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Charlie · 2023-03-23T06:25:59Z

Hi @pykettk,

In general, when PR is showing build failures, we need to work on it. It will get move to Merge only when the build is successful. For this PR, we engcom team, not able to work on your PR as your branch is forked from https://github.com/mage-os/mageos-magento2.git

As mentioned in comment, either you please have a look at the build failures or please raise a new PR from branch forked from https://github.com/magento/magento2.git and close this one.

Thank you!

pykettk · 2023-03-23T23:09:50Z

@engcom-Charlie I'd really like to look at the failing checks however the report is unavailable - see below.

Please advise.

pykettk · 2023-03-23T23:10:52Z

@magento run Static Tests

magento-automated-testing · 2023-03-23T23:11:02Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

fredden

I've manually run vendor/bin/phpcs --standard=Magento2Framework -sp --basepath=$PWD --colors app/code/Magento/CatalogWidget/view/frontend/templates/product/widget/content/grid.phtml app/code/Magento/CatalogWidget/view/adminhtml/templates/product/widget/conditions.phtml and this is what it is complaining about:

FILE: app/code/Magento/CatalogWidget/view/adminhtml/templates/product/widget/conditions.phtml
--------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------
 17 | WARNING | Line exceeds 120 characters; contains 122 characters
    |         | (Generic.Files.LineLength.TooLong)
 40 | WARNING | Line exceeds 120 characters; contains 123 characters
    |         | (Generic.Files.LineLength.TooLong)
--------------------------------------------------------------------------------------------------------

I suspect this is why the automated Static Tests are failing. There were no complains from vendor/bin/phpmd which is also run as part of the automated Static Tests.

fredden · 2023-03-24T10:32:42Z

app/code/Magento/CatalogWidget/view/adminhtml/templates/product/widget/conditions.phtml

-$fieldId = $element->getHtmlContainerId() ? ' id="' . $block->escapeHtmlAttr($element->getHtmlContainerId()) . '"' : '';
-$fieldClass = 'field admin__field field-' . $block->escapeHtmlAttr($element->getId()) . ' '
-    . $block->escapeHtmlAttr($element->getCssClass());
+$fieldId = $element->getHtmlContainerId() ? ' id="' . $escaper->escapeHtmlAttr($element->getHtmlContainerId()) . '"' : '';


phpcs says this line is too long (122 characters, limit is 120)

fredden · 2023-03-24T10:32:52Z

app/code/Magento/CatalogWidget/view/adminhtml/templates/product/widget/conditions.phtml

@@ -31,8 +37,8 @@ $fieldAttributes = $fieldId . ' class="' . $fieldClass . '" '
        "Magento_Rule/rules",
        "prototype"
    ], function(VarienRulesForm){
-        window.{$block->escapeJs($block->getHtmlId())} = new VarienRulesForm('{$block->escapeJs($block->getHtmlId())}',
-         '{$block->escapeUrl($block->getNewChildUrl())}');
+        window.{$escaper->escapeJs($block->getHtmlId())} = new VarienRulesForm('{$escaper->escapeJs($block->getHtmlId())}',


phpcs says this line is too long (123 characters, limit is 120)

fredden · 2023-03-24T10:45:25Z

I've manually run vendor/bin/phpcs --standard=Magento2Framework ...

Note that I have magento/magento-coding-standard#417 applied locally, so when I say Magento2Framework, I mean Magento2 and Magento2Framework.

pykettk · 2023-03-24T20:17:30Z

Thanks for the input, @fredden , this is very helpful! I'll look to get these resolved now 🙂

Chore: Catalog Widget - Replace Block Escaping with Escaper

e22c6b1

m2-github-services added Partner: Fisheye partners-contribution Pull Request is created by Magento Partner labels Mar 9, 2023

m2-assistant bot mentioned this pull request Mar 9, 2023

[Issue] Chore: Catalog Widget - Replace Block Escaping with Escaper #37107

Closed

5 tasks

m2-community-project bot added the Progress: pending review label Mar 9, 2023

andrewbess approved these changes Mar 9, 2023

View reviewed changes

m2-community-project bot assigned andrewbess Mar 9, 2023

m2-community-project bot added Progress: ready for testing Priority: P2 A defect with this priority could have functionality issues which are not to expectations. and removed Progress: pending review labels Mar 9, 2023

engcom-Lima self-assigned this Mar 15, 2023

m2-community-project bot added Progress: testing in progress and removed Progress: ready for testing labels Mar 15, 2023

m2-community-project bot added Progress: extended testing and removed Progress: testing in progress labels Mar 15, 2023

engcom-Delta self-assigned this Mar 16, 2023

m2-community-project bot added Progress: ready for testing Progress: extended testing and removed Progress: extended testing Progress: ready for testing labels Mar 16, 2023

engcom-Charlie self-assigned this Mar 20, 2023

m2-community-project bot added Progress: ready for testing and removed Progress: extended testing labels Mar 20, 2023

m2-community-project bot added Progress: extended testing and removed Progress: ready for testing labels Mar 21, 2023

fredden reviewed Mar 24, 2023

View reviewed changes

m2-community-project bot assigned fredden Mar 24, 2023

m2-community-project bot added Progress: review and removed Progress: extended testing labels Mar 24, 2023

pykettk closed this Sep 7, 2023

m2-community-project bot removed the Progress: review label Sep 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chore: Catalog Widget - Replace Block Escaping with Escaper #37082

Chore: Catalog Widget - Replace Block Escaping with Escaper #37082

pykettk commented Mar 9, 2023 •

edited by m2-assistant bot

Loading

m2-assistant bot commented Mar 9, 2023

pykettk commented Mar 9, 2023

andrewbess left a comment

engcom-Lima commented Mar 15, 2023

engcom-Lima commented Mar 15, 2023

magento-automated-testing bot commented Mar 15, 2023

engcom-Delta commented Mar 16, 2023

magento-automated-testing bot commented Mar 16, 2023

magento-automated-testing bot commented Mar 16, 2023

magento-automated-testing bot commented Mar 16, 2023

engcom-Delta commented Mar 16, 2023

magento-automated-testing bot commented Mar 16, 2023

magento-automated-testing bot commented Mar 16, 2023

engcom-Charlie commented Mar 20, 2023

pykettk commented Mar 20, 2023

engcom-Charlie commented Mar 21, 2023

magento-automated-testing bot commented Mar 21, 2023

engcom-Lima commented Mar 21, 2023 •

edited

Loading

pykettk commented Mar 21, 2023 •

edited

Loading

pykettk commented Mar 21, 2023

magento-automated-testing bot commented Mar 21, 2023

engcom-Charlie commented Mar 23, 2023

pykettk commented Mar 23, 2023 •

edited

Loading

pykettk commented Mar 23, 2023

magento-automated-testing bot commented Mar 23, 2023

fredden left a comment

fredden Mar 24, 2023

fredden Mar 24, 2023

fredden commented Mar 24, 2023

pykettk commented Mar 24, 2023

Chore: Catalog Widget - Replace Block Escaping with Escaper #37082

Chore: Catalog Widget - Replace Block Escaping with Escaper #37082

Conversation

pykettk commented Mar 9, 2023 • edited by m2-assistant bot Loading

Description (*)

Contribution checklist (*)

Resolved issues:

m2-assistant bot commented Mar 9, 2023

pykettk commented Mar 9, 2023

andrewbess left a comment

Choose a reason for hiding this comment

engcom-Lima commented Mar 15, 2023

engcom-Lima commented Mar 15, 2023

magento-automated-testing bot commented Mar 15, 2023

engcom-Delta commented Mar 16, 2023

magento-automated-testing bot commented Mar 16, 2023

magento-automated-testing bot commented Mar 16, 2023

magento-automated-testing bot commented Mar 16, 2023

engcom-Delta commented Mar 16, 2023

magento-automated-testing bot commented Mar 16, 2023

magento-automated-testing bot commented Mar 16, 2023

engcom-Charlie commented Mar 20, 2023

pykettk commented Mar 20, 2023

engcom-Charlie commented Mar 21, 2023

magento-automated-testing bot commented Mar 21, 2023

engcom-Lima commented Mar 21, 2023 • edited Loading

pykettk commented Mar 21, 2023 • edited Loading

pykettk commented Mar 21, 2023

magento-automated-testing bot commented Mar 21, 2023

engcom-Charlie commented Mar 23, 2023

pykettk commented Mar 23, 2023 • edited Loading

pykettk commented Mar 23, 2023

magento-automated-testing bot commented Mar 23, 2023

fredden left a comment

Choose a reason for hiding this comment

fredden Mar 24, 2023

Choose a reason for hiding this comment

fredden Mar 24, 2023

Choose a reason for hiding this comment

fredden commented Mar 24, 2023

pykettk commented Mar 24, 2023

pykettk commented Mar 9, 2023 •

edited by m2-assistant bot

Loading

engcom-Lima commented Mar 21, 2023 •

edited

Loading

pykettk commented Mar 21, 2023 •

edited

Loading

pykettk commented Mar 23, 2023 •

edited

Loading