Skip to content

[Reproducible Builds] Diff in generated/metadata between the builds #33903

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
Merged
merged 1 commit into from
Sep 23, 2021
Merged

[Reproducible Builds] Diff in generated/metadata between the builds #33903

merged 1 commit into from
Sep 23, 2021

Conversation

ihor-sviziev
Copy link
Contributor

@ihor-sviziev ihor-sviziev commented Aug 25, 2021 •
edited by m2-assistant bot
Loading

Sort all configs in generated/metadata before writing to file

Description (*)

This is a follow-up on #23324 for the 2.4-develop branch.

It's really important to have Reproducible Builds. It will help to check diff between the builds, so you'll be sure that you deploy only needed changes to production.

The same steps to reproduce, Magento 2.3.7-p1 or 2.4-develop branch.

The diff between the builds is following:

Files build-1/generated/metadata/app_action_list.php and build-2/generated/metadata/app_action_list.php differ
Files build-1/generated/metadata/interception.php and build-2/generated/metadata/interception.php differ

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] [Reproducible Builds] Diff in generated/metadata between the builds #33928: [Reproducible Builds] Diff in generated/metadata between the builds

@ihor-sviziev
Make builds repeatable
6cf5ee9 
Sort all configs in generated/metadata before writing to file
@m2-assistant
Copy link

m2-assistant bot commented Aug 25, 2021

Hi @ihor-sviziev. Thank you for your contribution
Here are 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:

  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

ℹ️ 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.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

ihor-sviziev
ihor-sviziev commented Aug 25, 2021
View reviewed changes
setup/src/Magento/Setup/Module/Di/Compiler/Config/Reader.php
Comment on lines -103 to -106
// sort configuration to have it in the same order on every build
ksort($config['arguments']);
ksort($config['preferences']);
ksort($config['instanceTypes']);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note: this code was moved to setup/src/Magento/Setup/Module/Di/App/Task/Operation/Area.php

@BarnyShergold
Copy link

@magento run all tests

@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 re-request them if they don't show in a reasonable amount of time.

@BarnyShergold BarnyShergold self-assigned this Aug 25, 2021
@ihor-sviziev
Copy link
Contributor Author

Note: we also have a diff in the requirejs-config.js file, but that's a bit another story

@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 re-request them if they don't show in a reasonable amount of time.

@ihor-sviziev
Copy link
Contributor Author

In test results, I don't see any failures...
@magento run Functional Tests EE

@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 re-request them if they don't show in a reasonable amount of time.

@magento magento deleted a comment from magento-automated-testing bot Aug 26, 2021
@magento magento deleted a comment from magento-automated-testing bot Aug 26, 2021
@magento magento deleted a comment from magento-automated-testing bot Aug 26, 2021
@magento magento deleted a comment from magento-automated-testing bot Aug 26, 2021
@magento magento deleted a comment from magento-automated-testing bot Aug 26, 2021
BarnyShergold
BarnyShergold approved these changes Aug 26, 2021
View reviewed changes
Copy link

@BarnyShergold BarnyShergold left a comment

Choose a reason for hiding this comment

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

All looks good and the tests finally all passed! 😄

@magento-engcom-team
Copy link
Contributor

Hi @BarnyShergold, thank you for the review.
ENGCOM-9200 has been created to process this Pull Request
✳️ @BarnyShergold, could you please add one of the following labels to the Pull Request?

Label Description
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests

@ihor-sviziev
Copy link
Contributor Author

@magento create issue

@m2-assistant m2-assistant bot mentioned this pull request Aug 27, 2021
Closed
5 tasks
@magento-engcom-team
Copy link
Contributor

Hi @Den4ik, thank you for the review.
ENGCOM-9200 has been created to process this Pull Request
✳️ @Den4ik, could you please add one of the following labels to the Pull Request?

Label Description
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests

@BarnyShergold BarnyShergold added the Auto-Tests: Covered All changes in Pull Request is covered by auto-tests label Aug 27, 2021
@sivaschenko sivaschenko added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Sep 6, 2021
@sivaschenko
Copy link
Member

Set P2 priority and moved to "Merge in progress" as this appears to be a good improvement for maintenance operations

@sidolov sidolov mentioned this pull request Sep 23, 2021
Closed
magento-engcom-team pushed a commit that referenced this pull request Sep 23, 2021
@sidolov
ENGCOM-9200: [Reproducible Builds] Diff in generated/metadata between…
f6c7652 
… the builds #33903
@magento-engcom-team magento-engcom-team merged commit c940595 into magento:2.4-develop Sep 23, 2021
@m2-assistant
Copy link

m2-assistant bot commented Sep 23, 2021

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

@ihor-sviziev ihor-sviziev deleted the make-builds-repeatable branch September 24, 2021 04:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Den4ik Den4ik Den4ik approved these changes

@BarnyShergold BarnyShergold BarnyShergold approved these changes

Assignees

@Den4ik Den4ik

@BarnyShergold BarnyShergold

Labels
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Component: Interception Component: Setup Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: ready for testing Release Line: 2.4
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Issue] [Reproducible Builds] Diff in generated/metadata between the builds
5 participants
@ihor-sviziev @BarnyShergold @magento-engcom-team @sivaschenko @Den4ik