Skip to content

improve error handling SchemaBuilder #39799

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

Open
wants to merge 6 commits into
base: 2.4-develop
Choose a base branch
from

Conversation

Genaker
Copy link

@Genaker Genaker commented Apr 10, 2025

Extending error context :
Previousle:
Warning: Undefined array key "type" in /var/www/html/magento/vendor/magento/framework/Setup/Declaration/Schema/Db/SchemaBuilder.php on line 91

Few Moments later:
Warning: Undefined array key "type" in /var/www/html/magento/vendor/magento/framework/Setup/Declaration/Schema/Db/SchemaBuilder.php on line 91 Error processing table catalog_eav_attribute column is_used_in_autocomplete

image

Help undersend the issue without heavy debugging!

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes magento/magento2#<issue_number>

Manual testing scenarios (*)

  1. ...
  2. ...

Questions or comments

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)

Resolved issues:

  1. resolves [Issue] improve error handling SchemaBuilder #39816: improve error handling SchemaBuilder

Extending error context : 
Previous: 
```Warning: Undefined array key "type" in /var/www/html/magento/vendor/magento/framework/Setup/Declaration/Schema/Db/SchemaBuilder.php on line 91```

Now: 
```Warning: Undefined array key "type" in /var/www/html/magento/vendor/magento/framework/Setup/Declaration/Schema/Db/SchemaBuilder.php on line 91
Error processing table catalog_eav_attribute column is_used_in_autocomplete```

Help undersend the issue without heavy debugging!
Copy link

m2-assistant bot commented Apr 10, 2025

Hi @Genaker. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ 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
  13. 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.

@orkuncv
Copy link

orkuncv commented Apr 15, 2025

For tables that are defined without columns and marked with disabled="true", like the example below:
<table name="amasty_stockstatus_quantityranges" resource="default" engine="innodb" comment="amasty_stockstatus_quantityranges" disabled="true"/>

You could consider adding the following check in your processing logic, e.g., around line 89:
if (!isset($tableColumns['column'])) { error_log("Missing 'column' key for table '{$keyTable}': " . json_encode($tableColumns)); continue; }

@Genaker
Copy link
Author

Genaker commented Apr 15, 2025

For tables that are defined without columns and marked with disabled="true", like the example below:

<table name="amasty_stockstatus_quantityranges" resource="default" engine="innodb" comment="amasty_stockstatus_quantityranges" disabled="true"/>

You could consider adding the following check in your processing logic, e.g., around line 89:

`if (!isset($tableColumns['column'])) {

error_log("Missing 'column' key for table '{$keyTable}': " . json_encode($tableColumns));

continue;

}`

is it for me? Who should add?

@engcom-Hotel
Copy link
Contributor

@magento create issue

@engcom-Hotel engcom-Hotel added the Priority: P3 May be fixed according to the position in the backlog. label Apr 15, 2025
@github-project-automation github-project-automation bot moved this to Pending Review in Pull Requests Dashboard Apr 15, 2025
@engcom-Charlie engcom-Charlie added the Project: Community Picked PRs upvoted by the community label May 13, 2025
@engcom-Bravo engcom-Bravo added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label May 14, 2025
@engcom-Hotel
Copy link
Contributor

@magento run all tests

Copy link
Contributor

@engcom-Hotel engcom-Hotel left a comment

Choose a reason for hiding this comment

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

Hello @Genaker,

Thanks for the contribution!

Please refer to the below review points & fix the failed static tests. Other failures seems flaky to me.

Thanks


// Throw a new exception with the extended message
// This preserves the original error but adds our context
throw new \Exception($errorMessage, $e->getCode(), $e);
Copy link
Contributor

Choose a reason for hiding this comment

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

With throwing the error also ensure that the new error message is properly surfaced in logs.

"%s\nError processing table %s column %s",
$e->getMessage(),
$keyTable,
$keyColumn
Copy link
Contributor

Choose a reason for hiding this comment

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

As per this comment #39799 (comment), please add a check with table is defined without columns.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hello @engcom-Hotel , the check is already there at line 101


// Throw a new exception with the extended message
// This preserves the original error but adds our context
throw new \Exception($errorMessage, $e->getCode(), $e);
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of rethrowing a generic \Exception, consider a specific exception type, e.g., \Magento\Framework\Exception\LocalizedException

Copy link
Author

Choose a reason for hiding this comment

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

unfortunately i can't do this now. However feel free edit this PR.

@engcom-Hotel engcom-Hotel moved this from Pending Review to Changes Requested in Community Dashboard May 19, 2025
@engcom-Dash engcom-Dash self-assigned this May 21, 2025
@engcom-Dash
Copy link
Contributor

@magento run all tests

@engcom-Dash
Copy link
Contributor

@magento run all tests

@engcom-Dash
Copy link
Contributor

Hello @engcom-Hotel I have fixed the review comments, static & unit test failures. Could you please review it ?

@engcom-Dash engcom-Dash moved this from Changes Requested to Pending Review in Community Dashboard May 23, 2025
@engcom-Hotel
Copy link
Contributor

@magento run Database Compare, Integration Tests, WebAPI Tests

Copy link
Contributor

@engcom-Hotel engcom-Hotel left a comment

Choose a reason for hiding this comment

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

Hello @Genaker,

Please sign the CLA, meanwhile we are moving this PR On Hold.

Thanks

@engcom-Hotel engcom-Hotel moved this from Review in Progress to Ready for Testing in Community Dashboard May 23, 2025
@engcom-Hotel engcom-Hotel moved this from Ready for Testing to On Hold in Community Dashboard May 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: P3 May be fixed according to the position in the backlog. Progress: on hold Progress: ready for testing Project: Community Picked PRs upvoted by the community Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
Status: On Hold
Development

Successfully merging this pull request may close these issues.

[Issue] improve error handling SchemaBuilder
6 participants