Issue 28656 inline translation rest api #28856

zaximus84 · 2020-06-23T18:12:58Z

Description (*)

When inline translation is enabled for the storefront, it should be limited to the frontend where HTML is rendered. However, making an API call to /rest/V1/integration/admin/token with bad credentials while inline translation is enabled results in inline translation markup around the error message in the API response.

Since inline translation markup is only useful in the adminhtml and frontend areas, this PR adds an area check in addition to the existing configuration checks before rendering inline translation markup.

Fixed Issues (if relevant)

Fixes Enabled Translation inline affect to result of REST APIs. #28656

Manual testing scenarios (*)

Go to admin
Stores > Settings > Configuration
In the left panel, expand Advanced and choose Developer
Expand selector the Translate Inline section
Set Enabled for Storefront to Yes
Click on save config
Try to login to admin as a user using API-
POST - {Baseurl}/rest/V1/integration/admin/token
Body - {"username": "","password": ""}
Confirm the response does not contain inline translation markup (a )

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)

…ranslated phrases for areas other than frontend and adminhtml.

…ate dependency

…rios, and add scenarios for all other areas where other enabled checks are true

m2-assistant · 2020-06-23T18:13:01Z

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

swnsma

Hi @zaximus84!
Please check my suggestions.
Also, please check failed tests.

swnsma · 2020-06-24T18:45:07Z

lib/internal/Magento/Framework/Translate/Inline.php

+     *
+     * @return bool
+     */
+    private function isAreaAllowed()


Suggested change

private function isAreaAllowed()

private function isAreaAllowed(): bool

swnsma · 2020-06-24T18:47:45Z

lib/internal/Magento/Framework/Translate/Inline.php

@@ -89,6 +103,7 @@ public function __construct(
        \Magento\Framework\Translate\Inline\ConfigInterface $config,
        \Magento\Framework\Translate\Inline\ParserInterface $parser,
        \Magento\Framework\Translate\Inline\StateInterface $state,
+        \Magento\Framework\App\State $appState,


Suggested change

\Magento\Framework\App\State $appState,

\Magento\Framework\App\State $appState = null,

swnsma · 2020-06-24T18:58:50Z

lib/internal/Magento/Framework/Translate/Inline.php

@@ -99,6 +114,7 @@ public function __construct(
        $this->config = $config;
        $this->parser = $parser;
        $this->state = $state;
+        $this->appState = $appState;


Suggested change

$this->appState = $appState;

$this->appState = $appState ?: \Magento\Framework\App\ObjectManager::getInstance()

->(\Magento\Framework\App\State::class);

swnsma · 2020-06-24T19:09:38Z

@magento run all tests

engcom-Charlie · 2020-06-30T11:39:25Z

@magento run all tests

engcom-Charlie · 2020-07-01T08:26:28Z

Hi @zaximus84, can You please fix failed tests and look through requested changes?

swnsma · 2020-07-07T17:34:38Z

@magento run all tests

engcom-Charlie · 2020-07-08T12:10:45Z

@magento run all tests

magento-engcom-team · 2020-07-13T12:58:31Z

Hi @swnsma, thank you for the review.
ENGCOM-7829 has been created to process this Pull Request

engcom-Alfa · 2020-07-14T09:16:00Z

✔️ QA Passed

Manual testing scenario:

Go to Admin-> Stores -> Configuration -> Advanced -> Developer -> Translate Inline;
Set Enabled for Storefront to Yes and Save;
Clean cache;
Go to Storefront -> Sign In

Actual Result: ✔️ Inline translate for Storefront is enabled

Try to login to admin as a user using API-
POST - {Baseurl}/rest/V1/integration/admin/token
Body - {"username": "","password": ""}

Before: ✖️ Result from rest API:

After: ✔️ Inline translation only affects frontend side and the response does not contain inline translation markup

{
  "message": "The account sign-in was incorrect or your account is disabled temporarily. Please wait and try again later.",
}

m2-assistant · 2020-07-23T08:57:46Z

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

Zach Nanninga added 3 commits June 19, 2020 11:24

ISSUE-28656 - Prevent inline translation markup from being added to t…

c1eeed2

…ranslated phrases for areas other than frontend and adminhtml.

ISSUE-28656 - Add basic unit test compatibility for new Inline app st…

35f7e8d

…ate dependency

ISSUE-28656 - Add frontend area (allowed) to existing isAllowed scena…

b444002

…rios, and add scenarios for all other areas where other enabled checks are true

ghost added this to Pending Review in Pull Requests Dashboard Jun 23, 2020

ghost added the Progress: pending review label Jun 23, 2020

magento-engcom-team added Component: Translate Release Line: 2.4 partners-contribution Pull Request is created by Magento Partner Partner: Blue Acorn iCi labels Jun 23, 2020

swnsma self-requested a review June 24, 2020 10:26

swnsma self-assigned this Jun 24, 2020

Merge branch '2.4-develop' into ISSUE-28656-inline-translation-rest-api

6fc4595

ghost added the Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. label Jun 24, 2020

swnsma requested changes Jun 24, 2020

View reviewed changes

ghost moved this from Pending Review to Changes Requested in Pull Requests Dashboard Jun 24, 2020

ghost added Progress: needs update and removed Progress: pending review labels Jun 24, 2020

swnsma added the Auto-Tests: Covered All changes in Pull Request is covered by auto-tests label Jun 24, 2020

swnsma added 2 commits June 26, 2020 18:18

Merge branch '2.4-develop' into ISSUE-28656-inline-translation-rest-api

e3726fc

Merge branch '2.4-develop' into ISSUE-28656-inline-translation-rest-api

9fc982c

engcom-Charlie self-assigned this Jun 30, 2020

swnsma and others added 2 commits July 2, 2020 18:44

Merge branch '2.4-develop' into ISSUE-28656-inline-translation-rest-api

285635b

code improvement; fix tests

a925a03

fix and refactor unit

9204022

ghost added Progress: review and removed Progress: needs update labels Jul 8, 2020

swnsma approved these changes Jul 13, 2020

View reviewed changes

ghost moved this from Review in Progress to Ready for Testing in Pull Requests Dashboard Jul 13, 2020

ghost added Progress: ready for testing and removed Progress: review labels Jul 13, 2020

swnsma added the Award: bug fix label Jul 13, 2020

engcom-Alfa self-assigned this Jul 14, 2020

engcom-Alfa moved this from Ready for Testing to Testing in Progress in Pull Requests Dashboard Jul 14, 2020

ghost added Progress: testing in progress and removed Progress: ready for testing labels Jul 14, 2020

engcom-Alfa moved this from Testing in Progress to Extended Testing (optional) in Pull Requests Dashboard Jul 14, 2020

ghost added Progress: extended testing and removed Progress: testing in progress labels Jul 14, 2020

engcom-Charlie added the QA: Ready to add to Regression Scope Should be analyzed and added to Regression Testing Scope(if applicable) label Jul 20, 2020

engcom-Alfa added QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope and removed QA: Ready to add to Regression Scope Should be analyzed and added to Regression Testing Scope(if applicable) labels Jul 22, 2020

engcom-Charlie moved this from Extended Testing (optional) to Merge in Progress in Pull Requests Dashboard Jul 22, 2020

ghost added Progress: accept and removed Progress: extended testing labels Jul 22, 2020

slavvka added the Severity: S1 Affects critical data or functionality and forces users to employ a workaround. label Jul 22, 2020

slavvka added this to the 2.4.1 milestone Jul 22, 2020

magento-engcom-team mentioned this pull request Jul 23, 2020

Enabled Translation inline affect to result of REST APIs. #28656

Closed

1 task

magento-engcom-team pushed a commit that referenced this pull request Jul 23, 2020

ENGCOM-7829: Issue 28656 inline translation rest api #28856

2b27fc8

magento-engcom-team merged commit 1b29b28 into magento:2.4-develop Jul 23, 2020

ghost moved this from Merge in Progress to Recently Merged in Pull Requests Dashboard Jul 23, 2020

hostep mentioned this pull request Jul 15, 2021

magento generate a broken js-translation.json file while deploying locale #18519

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue 28656 inline translation rest api #28856

Issue 28656 inline translation rest api #28856

zaximus84 commented Jun 23, 2020

m2-assistant bot commented Jun 23, 2020

swnsma left a comment •

edited

Loading

swnsma Jun 24, 2020

swnsma Jun 24, 2020

swnsma Jun 24, 2020

swnsma commented Jun 24, 2020

engcom-Charlie commented Jun 30, 2020

engcom-Charlie commented Jul 1, 2020

swnsma commented Jul 7, 2020

engcom-Charlie commented Jul 8, 2020

magento-engcom-team commented Jul 13, 2020

engcom-Alfa commented Jul 14, 2020

m2-assistant bot commented Jul 23, 2020

	private function isAreaAllowed()
	private function isAreaAllowed(): bool

	\Magento\Framework\App\State $appState,
	\Magento\Framework\App\State $appState = null,

	$this->appState = $appState;
	$this->appState = $appState ?: \Magento\Framework\App\ObjectManager::getInstance()
	->(\Magento\Framework\App\State::class);

Issue 28656 inline translation rest api #28856

Issue 28656 inline translation rest api #28856

Conversation

zaximus84 commented Jun 23, 2020

Description (*)

Fixed Issues (if relevant)

Manual testing scenarios (*)

Contribution checklist (*)

m2-assistant bot commented Jun 23, 2020

swnsma left a comment • edited Loading

Choose a reason for hiding this comment

swnsma Jun 24, 2020

Choose a reason for hiding this comment

swnsma Jun 24, 2020

Choose a reason for hiding this comment

swnsma Jun 24, 2020

Choose a reason for hiding this comment

swnsma commented Jun 24, 2020

engcom-Charlie commented Jun 30, 2020

engcom-Charlie commented Jul 1, 2020

swnsma commented Jul 7, 2020

engcom-Charlie commented Jul 8, 2020

magento-engcom-team commented Jul 13, 2020

engcom-Alfa commented Jul 14, 2020

m2-assistant bot commented Jul 23, 2020

swnsma left a comment •

edited

Loading