MC-23553: Invalid Template Strings when Translate Inline enabled #32002

namlier · 2021-02-09T10:24:54Z

Bug P2

Description (*)

This is a usability issue.

Fixed Issues (if relevant)

Fixes Invalid Template Strings when Translate Inline enabled #32000

Manual testing scenarios (*)

Preconditions:

Magento installed
Several products and a customer is created
Add product to cart on storefront
Login to admin area
Go to stores > Configuration > Advanced > Developer > Translate Inline
Set Enabled for Storefront option to Yes and save configuration
Flush Cache
Template strings are shown with formatting when inline translation is enabled.

Expected: Text remains the same
Actual: Text shows formatting characters like {{ }}

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 · 2021-02-09T10:24:57Z

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

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

ℹ️ 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

namlier · 2021-02-10T10:43:17Z

@magento run all tests

thomas-kl1 · 2021-02-09T11:34:54Z

lib/internal/Magento/Framework/Escaper.php

+            if ($translateInline->isAllowed()) {
+                return $this->inlineSensitiveEscapeHthmlAttr((string) $string);
+            }
+
+            return $this->getEscaper()
+                ->escapeHtmlAttr((string) $string);


Use ternary operator to avoid too much early returns

Can you, please, confirm that it will look better?

Suggested change

if ($translateInline->isAllowed()) {

return $this->inlineSensitiveEscapeHthmlAttr((string) $string);

}

return $this->getEscaper()

->escapeHtmlAttr((string) $string);

return $translateInline->isAllowed() ?

$this->inlineSensitiveEscapeHthmlAttr($string) :

$this->getEscaper()

->escapeHtmlAttr($string);

@thomas-kl1

Yes, like this:

Suggested change

if ($translateInline->isAllowed()) {

return $this->inlineSensitiveEscapeHthmlAttr((string) $string);

}

return $this->getEscaper()

->escapeHtmlAttr((string) $string);

$translateInline = $this->getTranslateInline();

return $translateInline->isAllowed()

? $this->inlineSensitiveEscapeHthmlAttr((string) $string)

: $this->getEscaper()->escapeHtmlAttr((string) $string);

zakdma · 2021-02-11T10:51:34Z

lib/internal/Magento/Framework/Escaper.php

+     */
+    private function inlineSensitiveEscapeHthmlAttr(string $text): string
+    {
+        $escaper = $this->getEscaper();


Please check that string has length more or eq 6 before.

Thank you, fixed.

zakdma · 2021-02-11T10:52:57Z

lib/internal/Magento/Framework/Test/Unit/EscaperTest.php

+     * @return void
+     * @dataProvider escapeHtmlAttrWithInlineProvider
+     */
+    public function testEscapeHtmlAttrWithInline(string $input, string $output): void


Please dont contract words. Rename
testEscapeHtmlAttributeWithInlineTranslateEnabled

zakdma · 2021-02-11T10:54:02Z

lib/internal/Magento/Framework/Test/Unit/EscaperTest.php

+     *
+     * @return array
+     */
+    public function escapeHtmlAttrWithInlineProvider(): array


Please dont contract words. Rename
escapeHtmlAttributeWithInlineTranslateEnabledDataProvider

namlier · 2021-02-15T09:44:17Z

@magento run all tests

namlier · 2021-02-15T12:21:49Z

@magento run all tests

dmitriyprime · 2021-02-17T15:48:57Z

✔️ QA passed

Before:

After:

zakdma · 2021-02-24T12:06:29Z

@magento import code to https://github.com/magento-tsg/magento2ce

magento-engcom-team · 2021-02-24T12:10:06Z

@zakdma, an error occurred during the Pull Request import.

magento-engcom-team · 2021-02-24T12:10:38Z

@zakdma the branch with code successfully imported intomagento-tsg/magento2ce repository. Branch name: imported-magento-magento2-32002.

m2-assistant · 2021-03-03T07:42:42Z

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

ihor-sviziev · 2021-10-25T09:34:52Z

lib/internal/Magento/Framework/Escaper.php

@@ -3,6 +3,7 @@
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
+declare(strict_types=1);


@mastiuhin-olexandr @zakdma,
FYI this change caused a regression #34413.
Please be careful with adding strict_types and not checking all the methods that might be affected.

MC-23553: Invalid Template Strings when Translate Inline enabled

1a481b4

m2-community-project bot added Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. labels Feb 9, 2021

magento-engcom-team added Component: Escaper Component: Test Release Line: 2.4 labels Feb 9, 2021

m2-community-project bot added this to Pending Review in High Priority Pull Requests Dashboard Feb 9, 2021

m2-community-project bot added the Progress: pending review label Feb 9, 2021

thomas-kl1 reviewed Feb 10, 2021

View reviewed changes

m2-community-project bot assigned thomas-kl1 Feb 10, 2021

m2-community-project bot moved this from Pending Review to Review in Progress in High Priority Pull Requests Dashboard Feb 10, 2021

m2-community-project bot added Progress: review and removed Progress: pending review labels Feb 10, 2021

thomas-kl1 removed their assignment Feb 10, 2021

m2-community-project bot moved this from Review in Progress to Pending Review in High Priority Pull Requests Dashboard Feb 10, 2021

m2-community-project bot added Progress: pending review and removed Progress: review labels Feb 10, 2021

zakdma suggested changes Feb 11, 2021

View reviewed changes

m2-community-project bot assigned zakdma Feb 11, 2021

m2-community-project bot moved this from Pending Review to Changes Requested in High Priority Pull Requests Dashboard Feb 11, 2021

m2-community-project bot added Progress: needs update and removed Progress: pending review labels Feb 11, 2021

mastiuhin-olexandr added 2 commits February 15, 2021 11:39

Merge remote-tracking branch 'origin/2.4-develop' into MC-23553

88e4207

MC-23553: Invalid Template Strings when Translate Inline enabled

bdf7a1e

m2-community-project bot moved this from Changes Requested to Review in Progress in High Priority Pull Requests Dashboard Feb 15, 2021

m2-community-project bot removed the Progress: needs update label Feb 15, 2021

engcom-Bravo self-assigned this Feb 19, 2021

engcom-Bravo moved this from Ready for Testing to Testing in Progress in High Priority Pull Requests Dashboard Feb 19, 2021

m2-community-project bot moved this from Testing in Progress to Ready for Testing in High Priority Pull Requests Dashboard Feb 19, 2021

m2-community-project bot moved this from Ready for Testing to Testing in Progress in High Priority Pull Requests Dashboard Feb 19, 2021

m2-community-project bot added Progress: testing in progress and removed Progress: ready for testing labels Feb 19, 2021

engcom-Bravo removed their assignment Feb 19, 2021

engcom-Bravo moved this from Testing in Progress to Ready for Testing in High Priority Pull Requests Dashboard Feb 19, 2021

m2-community-project bot added Progress: ready for testing and removed Progress: testing in progress labels Feb 19, 2021

engcom-Oscar moved this from Ready for Testing to Merge in Progress in High Priority Pull Requests Dashboard Mar 2, 2021

m2-community-project bot added Progress: accept and removed Progress: ready for testing labels Mar 2, 2021

magento-engcom-team added the Component: Translation label Mar 2, 2021

m2-community-project bot moved this from Merge in Progress to Ready for Testing in High Priority Pull Requests Dashboard Mar 2, 2021

m2-community-project bot added Progress: ready for testing and removed Progress: accept labels Mar 2, 2021

magento-engcom-team merged commit 159197c into magento:2.4-develop Mar 3, 2021

engcom-Foxtrot moved this from Ready for Testing to Recently Merged in High Priority Pull Requests Dashboard Mar 11, 2021

magento-engcom-team removed this from Recently Merged in High Priority Pull Requests Dashboard Oct 14, 2021

hostep mentioned this pull request Oct 23, 2021

M 2.4.3-p1 - TypeError: htmlspecialchars() expects parameter 1 to be string, null given in vendor/magento/framework/Escaper.php:417 #34413

Closed

4 tasks

ihor-sviziev reviewed Oct 25, 2021

View reviewed changes

m2-community-project bot assigned ihor-sviziev Oct 25, 2021

m2-community-project bot removed the Progress: ready for testing label Oct 25, 2021

ihor-sviziev removed their assignment Oct 25, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MC-23553: Invalid Template Strings when Translate Inline enabled #32002

MC-23553: Invalid Template Strings when Translate Inline enabled #32002

namlier commented Feb 9, 2021

m2-assistant bot commented Feb 9, 2021

namlier commented Feb 10, 2021

thomas-kl1 Feb 9, 2021

namlier Feb 15, 2021

namlier Feb 15, 2021

thomas-kl1 Feb 15, 2021

namlier Feb 15, 2021

zakdma Feb 11, 2021

namlier Feb 15, 2021

zakdma Feb 11, 2021

namlier Feb 15, 2021

zakdma Feb 11, 2021

namlier Feb 15, 2021

namlier commented Feb 15, 2021

namlier commented Feb 15, 2021

dmitriyprime commented Feb 17, 2021

zakdma commented Feb 24, 2021

magento-engcom-team commented Feb 24, 2021

magento-engcom-team commented Feb 24, 2021

m2-assistant bot commented Mar 3, 2021

ihor-sviziev Oct 25, 2021

MC-23553: Invalid Template Strings when Translate Inline enabled #32002

MC-23553: Invalid Template Strings when Translate Inline enabled #32002

Conversation

namlier commented Feb 9, 2021

Bug P2

Description (*)

Fixed Issues (if relevant)

Manual testing scenarios (*)

Contribution checklist (*)

m2-assistant bot commented Feb 9, 2021

namlier commented Feb 10, 2021

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

namlier commented Feb 15, 2021

namlier commented Feb 15, 2021

dmitriyprime commented Feb 17, 2021

zakdma commented Feb 24, 2021

magento-engcom-team commented Feb 24, 2021

magento-engcom-team commented Feb 24, 2021

m2-assistant bot commented Mar 3, 2021

Choose a reason for hiding this comment