Skip to content

Fix Patch aliases usage (issue #31396) #38239

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 18 commits into
base: 2.4-develop
Choose a base branch
from
Open

Fix Patch aliases usage (issue #31396) #38239

wants to merge 18 commits into from

Conversation

thomas-kl1
Copy link
Member

@thomas-kl1 thomas-kl1 commented Dec 1, 2023 •
edited
Loading

Description (*)

Currently the aliases are useless and have no meaningful usage in codebase.

See documentation: https://developer.adobe.com/commerce/php/development/components/declarative-schema/patches/

public function getAliases()
{
/**
* This internal method, that means that some patches with time can change their names,
* but changing name should not affect installation process, that's why if we will change name of the patch
* we will add alias here
*/
return [];

Fixed Issues (if relevant)

  1. Fixes [Magento 2.3.x] Data/Schema Patches getAliases() causes errors during setup:upgrade #31396
  2. Fixes [Magento 2.3.x] Declarative Schema :: Data/Schema Patches getAliases() not working as expected #23031

Manual testing scenarios (*)

  1. Add a patch with aliases

  2. None of the aliases must exists in db

  3. Run setup:upgrade

  4. The patch and its aliases are added to patch_list table

  5. Add a patch with aliases

  6. Any of its aliases must exists in db

  7. Run setup:upgrade

  8. The patch is not ran because it's already applied previously by one of its aliases

Questions or comments

I did not edit the \Magento\Framework\Setup\Patch\PatchHistory::isApplied for BC purpose.
However it would have been better to have this method updated to get a PatchInterface as an argument and check for its aliases there.

A similarity attempt was tried here:#37682 but can be ignored

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 M2 Assistant
Copy link

m2-assistant bot commented Dec 1, 2023

Hi @thomas-kl1. 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:
  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.

@m2-github-services m2-github-services added Partner: Dn’D partners-contribution Pull Request is created by Magento Partner labels Dec 1, 2023
@m2-community-project m2-community-project bot added Priority: P3 May be fixed according to the position in the backlog. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. Progress: pending review labels Dec 1, 2023
@thomas-kl1
Copy link
Member Author

@magento run all tests

@magento-automated-testing Magento Automated Testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

@thomas-kl1 thomas-kl1 changed the title WP: Fix issue #31396 Fix Patch aliases usage (issue #31396) Dec 1, 2023
@thomas-kl1
Copy link
Member Author

@magento run all tests

@magento-automated-testing Magento Automated Testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

@thomas-kl1
Copy link
Member Author

@magento run all tests

@magento-automated-testing Magento Automated Testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

@thomas-kl1
Copy link
Member Author

@magento run all tests

@magento-automated-testing Magento Automated Testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

@thomas-kl1
Copy link
Member Author

Functional tests failures are not related to the PR.
Unit test must be updated accordingly.

@thomas-kl1
Copy link
Member Author

@magento run all tests

@magento-automated-testing Magento Automated Testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

@thomas-kl1
Copy link
Member Author

@magento run all tests

@magento-automated-testing Magento Automated Testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Hotel
engcom-Hotel reviewed Jun 30, 2025
View reviewed changes
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 @thomas-kl1,

Thanks for the contribution!

In this PR, you have attached this PR as a related pull request. As the related pull request is closed due this, we have closed the same.

Can we remove the above PR from this PR, so that we can move forward with this PR? Please update us on this, meanwhile we are moving this PR On Hold.

Thanks

@engcom-Hotel engcom-Hotel moved this from Pending Review to On Hold in Community Dashboard Jun 30, 2025
@thomas-kl1
Copy link
Member Author

@engcom-Hotel I've updated this PR description and removed the reference.

@engcom-Hotel
Copy link
Contributor

@magento run all tests

engcom-Hotel
engcom-Hotel requested changes Jul 1, 2025
View reviewed changes
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 @thomas-kl1,

Thanks for making the changes. Please fix the failed automated tests.

Thanks

@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from On Hold to Changes Requested in Community Dashboard Jul 1, 2025
@thomas-kl1
Copy link
Member Author

@engcom-Hotel

Regarding static test failures, it's related to the copyright header change, I'll check, could you give the new copyright to apply please?
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38239/079f4563d120ab5795fb65006c654d26/Statics/console-error-logs.html

Units tests failure are not related to this PR and seems related to RMA changes (not in scope of this PR):
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38239/5da9f12d3970de433b743d636689530d/Unit/console-error-logs.html

Webapi tests, I dont see how it's related to this PR change 🤔

Functional tests, I dont see how it's related to this PR change 🤔

@thomas-kl1
Copy link
Member Author

@magento run all tests

@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from Changes Requested to Ready for Testing in Community Dashboard Jul 2, 2025
@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from Ready for Testing to Review in Progress in Community Dashboard Jul 2, 2025
@engcom-Hotel engcom-Hotel moved this from Review in Progress to Ready for Testing in Community Dashboard Jul 2, 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 Jul 3, 2025
@engcom-Charlie engcom-Charlie self-assigned this Jul 3, 2025
@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from Ready for Testing to Testing in Progress in Community Dashboard Jul 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@engcom-Hotel engcom-Hotel engcom-Hotel approved these changes

Assignees

@engcom-Charlie engcom-Charlie

Labels
Priority: P3 May be fixed according to the position in the backlog. Progress: testing in progress Project: Community Picked PRs upvoted by the community Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
Community Dashboard
Status: Testing in Progress
Milestone
No milestone
7 participants
@thomas-kl1 @engcom-Hotel @sinhaparul @engcom-Bravo @engcom-Charlie @engcom-Dash @m2-github-services