Improved error message when requirejs fails to load a component. #38971

hostep · 2024-07-24T18:17:35Z

Description (*)

When something goes wrong when trying to load a dependency through requirejs, the error message is not very clear and it's hard to find the real problem based on the error message.

Here we improve the error message and output more detailed information about the problem, which should help frontend developers in figuring out bugs in their code.

Related Pull Requests

N/A

Fixed Issues (if relevant)

Fixes Suggestion for improved error reporting for require.js loading problems #36761

Manual testing scenarios (*)

Manually introduce a bug in the code: open the file app/code/Magento/Checkout/view/frontend/web/js/view/summary/abstract-total.js and add this problematic line:

--- a/app/code/Magento/Checkout/view/frontend/web/js/view/summary/abstract-total.js
+++ b/app/code/Magento/Checkout/view/frontend/web/js/view/summary/abstract-total.js
@@ -13,6 +13,8 @@ define([
     'use strict';

     return Component.extend({
+        problem: window.unexistingProp.unexistingProp,
+
         /**
          * @param {*} price
          * @return {*|String}

Have a Magento shop setup with at least one saleable product in the database
On the frontend, put the product in your cart and go to the checkout
Look at your browsers inspector

Before the changes, not clear what the problem is:

After the changes: a lot more clearer what the problem is:

Questions or comments

There are almost no automated tests around this functionality, so I'm not bothering adding a test, because I don't know how I should do this.

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)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

m2-assistant · 2024-07-24T18:17:39Z

Hi @hostep. Thank you for your contribution!
Here are some useful tips on 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
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

hostep · 2024-07-24T18:18:02Z

@magento run all tests

engcom-November · 2024-09-19T07:30:42Z

Hello @hostep,

Thank you for the collaboration and contribution!

✔️ QA Passed

Steps to reproduce:

Manually introduce a bug in the code: open the file app/code/Magento/Checkout/view/frontend/web/js/view/summary/abstract-total.js and add this problematic line:

--- a/app/code/Magento/Checkout/view/frontend/web/js/view/summary/abstract-total.js
+++ b/app/code/Magento/Checkout/view/frontend/web/js/view/summary/abstract-total.js
@@ -13,6 +13,8 @@ define([
     'use strict';

     return Component.extend({
+        problem: window.unexistingProp.unexistingProp,
+
         /**
          * @param {*} price
          * @return {*|String}

Go to frontend and add a product to cart.
Open console on checkout page.

Before: ✖️

Log was not pointing to exact problem.

After: ✔️

Getting clear log of where the problem lies.

Since the issue linked to pr is marked as feature request moving this to on hold till we get PO confirmation on the same.

Thank you.

engcom-Charlie · 2024-11-13T09:31:55Z

As we got the confirmation from Product Owner on this PR to proceed further, removing it from On hold. Moving it to Extended Testing as the build is failing.

Thank you!

engcom-Charlie · 2024-11-18T06:43:40Z

@magento run all tests

engcom-Charlie · 2024-11-18T10:47:20Z

@magento run Functional Tests B2B, Functional Tests CE, Unit Tests

engcom-Charlie · 2024-11-18T13:43:28Z

@magento run Functional Tests B2B

engcom-Charlie · 2024-11-19T06:45:01Z

@magento run all tests

engcom-Charlie · 2024-11-19T09:32:57Z

@magento run Functional Tests B2B, Functional Tests EE, Unit Tests

engcom-Charlie · 2024-11-19T13:45:31Z

The Functional EE failures are not consistent in recent 2 builds on same code. They are not part of PR or not failing because of PR changes. The tests failures seems to be flaky.

Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38971/d42efc67fe5cefb7a7fa6b31cc8677ba/Functional/allure-report-ee/index.html#categories

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38971/a6bc715eb2f9825ebd2187f75e3a972b/Functional/allure-report-ee/index.html#categories

engcom-Charlie · 2024-11-20T05:56:33Z

@magento run Functional Tests B2B

engcom-Charlie · 2024-11-20T10:06:47Z

The Functional B2B failures are not consistent in recent 2 builds on same code. They are not part of PR or not failing because of PR changes. The tests failures seems to be flaky hence moving this PR to Merge in Progress.

Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38971/c9baa554ca4955a06ec35f6fc9c18caf/Functional/allure-report-b2b/index.html#categories

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38971/0817dc7a1a44928fdc648e96df33e321/Functional/allure-report-b2b/index.html#categories

Improved error message when requirejs fails to load a component.

2819b42

m2-community-project bot added the Progress: pending review label Jul 24, 2024

ihor-sviziev approved these changes Jul 25, 2024

View reviewed changes

m2-community-project bot assigned ihor-sviziev Jul 25, 2024

m2-community-project bot added Progress: ready for testing and removed Progress: pending review labels Jul 25, 2024

engcom-Bravo added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Jul 26, 2024

engcom-Hotel added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Jul 29, 2024

engcom-November self-assigned this Sep 19, 2024

engcom-November added Progress: on hold and removed Progress: ready for testing labels Sep 19, 2024

engcom-Charlie self-assigned this Nov 13, 2024

m2-community-project bot added Progress: ready for testing and removed Progress: on hold labels Nov 13, 2024

Merge branch '2.4-develop' into fix-for-issue-36761

b66f992

Merge branch '2.4-develop' into fix-for-issue-36761

8f9a461

magento-devops-reposync-svc merged commit f6924b4 into magento:2.4-develop Dec 4, 2024
10 of 12 checks passed

Improved error message when requirejs fails to load a component. #38971

Improved error message when requirejs fails to load a component. #38971

Uh oh!

Conversation

hostep commented Jul 24, 2024

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Uh oh!

m2-assistant bot commented Jul 24, 2024

Uh oh!

hostep commented Jul 24, 2024

Uh oh!

engcom-November commented Sep 19, 2024

✔️ QA Passed

Before: ✖️

After: ✔️

Uh oh!

engcom-Charlie commented Nov 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

engcom-Charlie commented Nov 18, 2024

Uh oh!

engcom-Charlie commented Nov 18, 2024

Uh oh!

engcom-Charlie commented Nov 18, 2024

Uh oh!

engcom-Charlie commented Nov 19, 2024

Uh oh!

engcom-Charlie commented Nov 19, 2024

Uh oh!

engcom-Charlie commented Nov 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

engcom-Charlie commented Nov 20, 2024

Uh oh!

engcom-Charlie commented Nov 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

engcom-Charlie commented Nov 13, 2024 •

edited

Loading

engcom-Charlie commented Nov 19, 2024 •

edited

Loading

engcom-Charlie commented Nov 20, 2024 •

edited

Loading