Magento2: Javascript error thrown from uiComponent 'notification_area' if messages are malformed

Created on 2 May 2018 · 6Comments · Source: magento/magento2

A javascript error is thrown from the uiComponent notification_area in Magento backend when the parameter $content of the class \Magento\Ui\TemplateEngine\Xhtml\Result::wrapContent is empty or false. As the parameter is provided, no PHP error is thrown and the parameter doesn't have a strict type like string.
The javascript error blocks all others frontend behavior.

The \Magento\Ui\TemplateEngine\Xhtml\Result::wrapContent method return a requireJs dependency but cause of the empty/false value, javascript throw this error:

Uncaught SyntaxError: Unexpected token } in JSON at position 33
    at JSON.parse (<anonymous>)
    at getNodeData (scripts.js:87)
    at Array.map (<anonymous>)
    at scripts.js:117

The position 33 is the following javascript piece of code returned by the method \Magento\Ui\TemplateEngine\Xhtml\Result::wrapContent

{"*": {"Magento_Ui/js/core/app": }}

Preconditions

Magento 2.2.3
PHP 7.1
MariaDB 15.1
MAMPro with Apache 2.4
A notification message providing a potential json_encode error

Steps to reproduce

Have a notification providing a json_encode error as this one will return false if not successful:
We discovered a third party module from Wyomind providing this issue because the notification message has the following content (see attachment) with a malformed UTF8 and

Expected result

No javascript error thrown thanks to a try/catch and log the issue
A way to catch json_encode error and provide the issue in console.log

Actual result

Uncaught SyntaxError: Unexpected token } in JSON at position 33
    at JSON.parse (<anonymous>)
    at getNodeData (scripts.js:87)
    at Array.map (<anonymous>)
    at scripts.js:117

Js position 33 is:
{"*": {"Magento_Ui/js/core/app": }}

There is json_encode function called at \Magento\Ui\TemplateEngine\Xhtml\Result::appendLayoutConfiguration to encode the configuration in json, however in some cases it can return false if any issue happens. The function json_last_error_msg() permits to determine what was the last error returned. In my case, it was a Malformed UTF-8 characters, possibly incorrectly encoded issue

Solution:

One of the solution is of course making sure that no error can happen in json_encode, however a platform like Magento support third parties extension and those may provide issue, it's important to reduce the fields of blocking issue. So, in the case of the notification_area, it's better to totally not display the notifications but inform at least the user that there is a blocking issue by displaying an error message in the notification area then they should contact the admin instead of blocking completely the backend cause of this javascript error.

As workaround, we did temporary the following into the method \Magento\Ui\TemplateEngine\Xhtml\Result::wrapContent

    protected function wrapContent($content)
    {
        if (empty($content)) {
            return '';
        }

        return '<script type="text/x-magento-init"><![CDATA['
        . '{"*": {"Magento_Ui/js/core/app": ' . str_replace(['<![CDATA[', ']]>'], '', $content) . '}}'
        . ']]></script>';
    }

FrameworSerialize Fixed in 2.2.x Clear Description Confirmed Format is valid Ready for Work Reproduced on 2.2.x Reproduced on 2.3.x help wanted

Source

sylvainraye

👍6

Most helpful comment

I've been experiencing this exact problem this week (M2.2.1). I too am using a Wyomind extension.

Your workaround at least allowed me to use the admin.

acampos1916 on 4 May 2018

👍4

All 6 comments

I've been experiencing this exact problem this week (M2.2.1). I too am using a Wyomind extension.

Your workaround at least allowed me to use the admin.

acampos1916 on 4 May 2018

👍4

Having the same issue, also have the Wyomind extension installed.

Can confirm the above solution/workaround resolves the issue.

powierski on 11 Jun 2018

👍1

I've been experiencing this exact problem this week (M2.2.1). I too am using a Wyomind extension.

Your workaround at least allowed me to use the admin.

The empty $content return ' ' gave me a warning in the dashboard. I changed it instead to the following, and it didn't give me any kind of warning.

        if (empty($content)) {
            return '<script type="text/x-magento-init"><![CDATA[{}]]></script>';
        }

(P.s i used a Wyomind extension as well)

AlekosDordas on 25 Oct 2018

Hi @sdzhepa. Thank you for working on this issue.
Looks like this issue is already verified and confirmed. But if your want to validate it one more time, please, go though the following instruction:

[ ] 1. Add/Edit Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

[ ] 2. Verify that the issue is reproducible on 2.3-develop branch
Details
- Add the comment @magento-engcom-team give me 2.3-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and _stop verification process here_!
[ ] 3. Verify that the issue is reproducible on 2.2-develop branch.
Details
- Add the comment @magento-engcom-team give me 2.2-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x
[ ] 4. If the issue is not relevant or is not reproducible any more, feel free to close it.

magento-engcom-team on 14 Jan 2019

Hi @quisse. Thank you for working on this issue.
Looks like this issue is already verified and confirmed. But if your want to validate it one more time, please, go though the following instruction:

[ ] 1. Add/Edit Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

[ ] 2. Verify that the issue is reproducible on 2.3-develop branch
Details
- Add the comment @magento-engcom-team give me 2.3-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and _stop verification process here_!
[ ] 3. Verify that the issue is reproducible on 2.2-develop branch.
Details
- Add the comment @magento-engcom-team give me 2.2-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x
[ ] 4. If the issue is not relevant or is not reproducible any more, feel free to close it.

magento-engcom-team on 14 Jan 2019

Hi @sylvainraye. Thank you for your report.
The issue has been fixed in magento/magento2#20271 by @quisse in 2.2-develop branch
Related commit(s):

The fix will be available with the upcoming 2.2.8 release.

magento-engcom-team on 18 Jan 2019

Was this page helpful?

0 / 5 - 0 ratings