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 Parameter Tokenizer omitting first char of key #29542

Merged
merged 3 commits into from
Sep 18, 2020

Conversation

marvinhinz
Copy link
Contributor

@marvinhinz marvinhinz commented Aug 14, 2020

Description (*)

\Magento\Framework\Filter\Template\Tokenizer\Parameter has to use a do-while-loop. not a while loop. Else the first char is ignored because $this->next() set the pointer to the second char before getting the first char. (copied from @bernd-reindl)

Fixed Issues (if relevant)

  1. Fixes \Magento\Framework\Filter\Template\Tokenizer\Parameter #29185

Manual testing scenarios (*)

  1. Create Custom Directive (for me typo3url with link parameter eg. {{typo3_link url='imprint'}}
  2. Use it in template (eg. email footer)
  3. Debug the new custom directive process($value, array $parameters, ?string $html) function
  4. Take a look at the $parameters array.
  5. It should contain url => "imprint" but is actually rl => "imprint"

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
Copy link

m2-assistant bot commented Aug 14, 2020

Hi @marvinhinz. 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:

  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

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

@marvinhinz
Copy link
Contributor Author

@magento run all tests

Copy link
Contributor

@lbajsarowicz lbajsarowicz left a comment

Choose a reason for hiding this comment

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

According to Magento Definition of Done could you provide automatic tests to cover the change?

@ghost ghost assigned lbajsarowicz Aug 14, 2020
@sidolov sidolov 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 14, 2020
@engcom-Charlie engcom-Charlie self-assigned this Aug 18, 2020
@engcom-Charlie
Copy link
Contributor

@magento run all tests

Copy link
Contributor

@lbajsarowicz lbajsarowicz left a comment

Choose a reason for hiding this comment

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

✔️ All green from my side.

@magento-engcom-team
Copy link
Contributor

Hi @lbajsarowicz, thank you for the review.
ENGCOM-8056 has been created to process this Pull Request
✳️ @lbajsarowicz, could you please add one of the following labels to the Pull Request?

Label Description
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests

@engcom-Alfa engcom-Alfa self-assigned this Sep 16, 2020
@engcom-Alfa
Copy link
Contributor

engcom-Alfa commented Sep 16, 2020

✔️ QA Passed

Manual testing scenario:

  1. Create Custom Directive as described in devdocs;
  2. Add created before directive to any CMS page ( {{lifetime should_bold="1"}} in my case);
  3. Open cms page with the custom directive;

Before: ✖️ $parameters of method "process($value, array $parameters, ?string $html): string" have a parameter "hould_bold"

2020-09-16_13-22

✖️ and the parameter was not applied

2020-09-16_13-25

After: ✔️ $parameters of method "process($value, array $parameters, ?string $html): string" have a parameter "should_bold"

2020-09-16_13-29

✔️ and the parameter was applied

2020-09-16_13-30

@engcom-Alfa engcom-Alfa added Auto-Tests: Covered All changes in Pull Request is covered by auto-tests QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope labels Sep 16, 2020
@magento-engcom-team magento-engcom-team merged commit 789bed8 into magento:2.4-develop Sep 18, 2020
@m2-assistant
Copy link

m2-assistant bot commented Sep 18, 2020

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

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 Component: Filter Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope Release Line: 2.4 Severity: S2 Major restrictions or short-term circumventions are required until a fix is available.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

\Magento\Framework\Filter\Template\Tokenizer\Parameter
6 participants