Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix incompatibility with laminas-escaper (2.7.1) #33353

Merged
merged 5 commits into from
Jul 30, 2021

Conversation

tufahu
Copy link
Contributor

@tufahu tufahu commented Jun 25, 2021

Description

laminas/laminas-escaper 2.7.1 use strict types and it breaks magento framework escaper

Fixed Issues

  1. Fixes Latest laminas/laminas-escaper (2.7.0 -> 2.7.1) breaks product and catalog category view pages #33346

@m2-assistant
Copy link

m2-assistant bot commented Jun 25, 2021

Hi @tufahu. Thank you for your contribution
Here are 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:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

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

@ihor-sviziev ihor-sviziev added the Severity: S1 Affects critical data or functionality and forces users to employ a workaround. label Jun 25, 2021
@ihor-sviziev
Copy link
Contributor

@magento run all tests

@magento-automated-testing
Copy link

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.

Copy link
Contributor

@ihor-sviziev ihor-sviziev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @tufahu,
Could you cover your changes with unit test?

@thomas-kl1
Copy link
Member

@ihor-sviziev is it a kind of joke?

@ihor-sviziev
Copy link
Contributor

@thomas-kl1, no, it's not. We definitely have a new case that isn't covered with any type of test. That's why we're having this issue.
I think it would be effortless to cover it with a unit test.

@hostep
Copy link
Contributor

hostep commented Jun 25, 2021

This is a super important fix, this needs to be turned into a hotfix ASAP in my opinion, maybe it's worth adding this to Magento's quality patches repo as well.

All Magento versions that have this laminas/laminas-escaper package (being: Magento 2.3.5 and higher) will crash when they upgrade to version 2.7.1 of this package.

Thanks @tufahu !

@thomas-kl1
Copy link
Member

That's why we're having this issue.
I think it would be effortless to cover it with a unit test.

@ihor-sviziev maybe as a maintainer you could push for strict and proper type signatures in method. Such unit tests doesn't belongs there when it's well typed..

Copy link
Contributor

@ihor-sviziev ihor-sviziev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on discussion with @sivaschenko (more detils see in magento/magento-semver#63 (comment)) - we should revert the adding strict types, as it will break backward compatibility for the cases when in the client code we have declared strict_types=1, but for some reason, using a different type.

lib/internal/Magento/Framework/Escaper.php Outdated Show resolved Hide resolved
lib/internal/Magento/Framework/Escaper.php Outdated Show resolved Hide resolved
lib/internal/Magento/Framework/Test/Unit/EscaperTest.php Outdated Show resolved Hide resolved
lib/internal/Magento/Framework/Test/Unit/EscaperTest.php Outdated Show resolved Hide resolved
Apply suggestions from code review
@ihor-sviziev
Copy link
Contributor

@magento run all tests

@magento-automated-testing
Copy link

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.

@ihor-sviziev
Copy link
Contributor

@magento run Unit Tests

@magento-automated-testing
Copy link

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 magento deleted a comment from magento-automated-testing bot Jul 30, 2021
@ihor-sviziev
Copy link
Contributor

@magento run Functional Tests B2B, Integration Tests

@magento-automated-testing
Copy link

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.

@andrewbess andrewbess merged commit 057e838 into magento:platform-health Jul 30, 2021
@m2-assistant
Copy link

m2-assistant bot commented Jul 30, 2021

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

@mrtuvn
Copy link
Contributor

mrtuvn commented Aug 10, 2021

Hi any queue or plan to sync this to mainline 2.4-develop
cc @sivaschenko @gabrieldagama

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: bug fix Award: special achievement Award: test coverage Component: Escaper Component: Test Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. Progress: ready for testing Project: Platform Health Release Line: 2.4 Severity: S1 Affects critical data or functionality and forces users to employ a workaround.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Latest laminas/laminas-escaper (2.7.0 -> 2.7.1) breaks product and catalog category view pages