Skip to content
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

Mark Framework Interfaces as API part 3 #32156

Merged

Conversation

mrtuvn
Copy link
Contributor

@mrtuvn mrtuvn commented Feb 14, 2021

Description (*)

The following interfaces marked as API

lib/internal/Magento/Framework/Async/CancelableDeferredInterface.php
lib/internal/Magento/Framework/Async/DeferredInterface.php
lib/internal/Magento/Framework/Autoload/AutoloaderInterface.php
lib/internal/Magento/Framework/Backup/SourceFileInterface.php
lib/internal/Magento/Framework/Cache/ConfigInterface.php
lib/internal/Magento/Framework/Cache/StaleCacheNotifierInterface.php
lib/internal/Magento/Framework/Code/Generator/CodeGeneratorInterface.php
lib/internal/Magento/Framework/Code/Minifier/AdapterInterface.php
lib/internal/Magento/Framework/Code/Reader/ClassReaderInterface.php
lib/internal/Magento/Framework/Code/ValidatorInterface.php
lib/internal/Magento/Framework/Component/ComponentRegistrarInterface.php
lib/internal/Magento/Framework/Crontab/CrontabManagerInterface.php
lib/internal/Magento/Framework/Crontab/TasksProviderInterface.php
lib/internal/Magento/Framework/Css/PreProcessor/ErrorHandlerInterface.php
lib/internal/Magento/Framework/DB/DataConverter/DataConverterInterface.php
lib/internal/Magento/Framework/DB/LoggerInterface.php
lib/internal/Magento/Framework/DB/MapperInterface.php
lib/internal/Magento/Framework/DB/Query/BatchIteratorInterface.php
lib/internal/Magento/Framework/DB/QueryInterface.php
lib/internal/Magento/Framework/DB/Select/QueryModifierInterface.php
lib/internal/Magento/Framework/DB/Select/RendererInterface.php
lib/internal/Magento/Framework/DB/Sequence/SequenceInterface.php
lib/internal/Magento/Framework/DB/Sql/ExpressionInterface.php
lib/internal/Magento/Framework/Data/Collection/Db/FetchStrategyInterface.php
lib/internal/Magento/Framework/Data/Collection/EntityFactoryInterface.php
lib/internal/Magento/Framework/Data/CollectionDataSourceInterface.php
lib/internal/Magento/Framework/Data/CollectionModifierInterface.php
lib/internal/Magento/Framework/Data/SearchResultInterface.php
lib/internal/Magento/Framework/Data/SearchResultProcessorInterface.php
lib/internal/Magento/Framework/Data/ValueSourceInterface.php
lib/internal/Magento/Framework/DataObject/IdentityGeneratorInterface.php
lib/internal/Magento/Framework/DataObject/IdentityInterface.php
lib/internal/Magento/Framework/DataObject/IdentityValidatorInterface.php
lib/internal/Magento/Framework/DataObject/KeyValueObjectInterface.php

Marked api as references
lib/internal/Magento/Framework/Api/CriteriaInterface (by lib/internal/Magento/Framework/DB/MapperInterface.php)

Should merge this before PR related below to avoid conflicts same file

Dependent Pull Requests

magento/magento2ce#32135

Fixed Issues (if relevant)

  1. Fixes Mark Framework interfaces as API part 3 #32026

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)
  • All automated tests passed successfully (all builds are green)

Sorry, something went wrong.

@m2-assistant
Copy link

m2-assistant bot commented Feb 14, 2021

Hi @mrtuvn. 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.5-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

@m2-community-project m2-community-project bot added the Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. label Feb 14, 2021
@mrtuvn mrtuvn force-pushed the api-interfaces-mark-3 branch from 3d88904 to c2d5157 Compare February 18, 2021 14:40
@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 18, 2021

rebased branch 2.5-develop

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 18, 2021

@magento run all tests

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 19, 2021

Public type 'Magento\Framework\DB\MapperInterface' references following non-public types:
Magento\Framework\Api\CriteriaInterface

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 20, 2021

Fixed static tests fail

@mrtuvn mrtuvn force-pushed the api-interfaces-mark-3 branch from c2d5157 to 45a9436 Compare February 20, 2021 07:08
@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 20, 2021

@magento run all tests

Copy link
Contributor

@eduard13 eduard13 left a comment

Choose a reason for hiding this comment

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

@mrtuvn please revert the api annotation for Magento/Framework/Api/CriteriaInterface as it has been already marked in scope of #32135. Let's add it as related PR.

Additionally, could you please enable the strict typing for the adjusted classes?

@eduard13 eduard13 added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Feb 22, 2021
@eduard13 eduard13 added this to the 2.5 milestone Feb 22, 2021
@mrtuvn mrtuvn force-pushed the api-interfaces-mark-3 branch from 45a9436 to 7d38777 Compare February 22, 2021 14:11
@mrtuvn mrtuvn requested a review from eduard13 February 22, 2021 14:12
@eduard13
Copy link
Contributor

@mrtuvn please update the PR description (for some reasons I don’t have the permission), Related Pull Requests section with the PR that I mentioned, so it will be used on building the environment.

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 22, 2021

Added related PR

@eduard13
Copy link
Contributor

@magento run Static Tests

@eduard13
Copy link
Contributor

@mrtuvn please add it according to the following doc.

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 23, 2021

@magento run all tests

@gabrieldagama
Copy link
Contributor

@magento-engcom-team
Copy link
Contributor

@gabrieldagama the branch with code successfully imported intomagento-engcom/magento2ce repository. Branch name: imported-magento-magento2-32156.

@magento-cicd2 magento-cicd2 merged commit 39c20d2 into magento:api-changes-develop Apr 13, 2021
@m2-assistant
Copy link

m2-assistant bot commented Apr 13, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Component: multiple Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. Progress: accept Project: API Changes QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope Release Line: 2.4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mark Framework interfaces as API part 3
7 participants