Mark Framework interfaces as API part 2 #32140

mrtuvn · 2021-02-12T14:01:54Z

Description (*)

Mark following interfaces as API + Added strict_types

lib/internal/Magento/Framework/App/CsrfAwareActionInterface.php
lib/internal/Magento/Framework/App/DefaultPathInterface.php
lib/internal/Magento/Framework/App/DeploymentConfig/ImporterInterface.php
lib/internal/Magento/Framework/App/DeploymentConfig/ValidatorInterface.php
lib/internal/Magento/Framework/App/DeploymentConfig/Writer/FormatterInterface.php
lib/internal/Magento/Framework/App/DesignInterface.php
lib/internal/Magento/Framework/App/EnvironmentInterface.php
lib/internal/Magento/Framework/App/ExceptionHandlerInterface.php
lib/internal/Magento/Framework/App/FeedFactoryInterface.php
lib/internal/Magento/Framework/App/FeedInterface.php
lib/internal/Magento/Framework/App/HttpRequestInterface.php
lib/internal/Magento/Framework/App/ObjectManager/ConfigWriterInterface.php
lib/internal/Magento/Framework/App/PageCache/NotCacheableInterface.php
lib/internal/Magento/Framework/App/Request/ValidatorInterface.php
lib/internal/Magento/Framework/App/ResourceConnection/ConfigInterface.php
lib/internal/Magento/Framework/App/ResourceConnection/ConnectionAdapterInterface.php
lib/internal/Magento/Framework/App/Response/FileInterface.php
lib/internal/Magento/Framework/App/Response/HeaderProvider/HeaderProviderInterface.php
lib/internal/Magento/Framework/App/Response/RedirectInterface.php
lib/internal/Magento/Framework/App/Router/NoRouteHandlerInterface.php
lib/internal/Magento/Framework/App/Router/PathConfigInterface.php
lib/internal/Magento/Framework/App/RouterInterface.php
lib/internal/Magento/Framework/App/RouterListInterface.php
lib/internal/Magento/Framework/App/Rss/RssManagerInterface.php
lib/internal/Magento/Framework/App/Rss/UrlBuilderInterface.php
lib/internal/Magento/Framework/App/Scope/ValidatorInterface.php
lib/internal/Magento/Framework/App/ScopeFallbackResolverInterface.php
lib/internal/Magento/Framework/App/ScopeResolverInterface.php
lib/internal/Magento/Framework/App/ScopeTreeProviderInterface.php
lib/internal/Magento/Framework/App/ScopeValidatorInterface.php
lib/internal/Magento/Framework/App/View/Asset/MaterializationStrategy/StrategyInterface.php
lib/internal/Magento/Framework/App/View/Deployment/Version/StorageInterface.php

Also marked api for references class/interfaces

lib/internal/Magento/Framework/\App/Request/InvalidRequestException
lib/internal/Magento/Framework/Interception/ObjectManager/ConfigInterface
lib/internal/Magento/Framework/App/Response/Http
lib/internal/Magento/Framework/App/Request/Http

lib/internal/Magento/Framework/ObjectManager/RelationsInterface.php
lib/internal/Magento/Framework/ObjectManager/ConfigInterface.php
lib/internal/Magento/Framework/ObjectManager/ConfigCacheInterface.php
lib/internal/Magento/Framework/Interception/ConfigInterface.php

lib/internal/Magento/Framework/DB/LoggerInterface (by lib/internal/Magento/Framework/App/ResourceConnection/ConnectionAdapterInterface.php)

lib/internal/Magento/Framework/View/DesignInterface (by
lib/internal/Magento/Framework/App/DesignInterface.php)

Related Pull Requests

#32142
#32156

Fixed Issues (if relevant)

Fixes Mark Framework interfaces as API part 2 #32025

Manual testing scenarios (*)

...
...

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)

m2-assistant · 2021-02-12T14:01:56Z

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:

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

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

mrtuvn · 2021-02-18T14:47:46Z

Rebased 2.5-develop

mrtuvn · 2021-02-18T18:45:10Z

@magento run all tests

mrtuvn · 2021-02-19T04:59:35Z

Public type 'Magento\Framework\App\CsrfAwareActionInterface' references following non-public types:
Magento\Framework\App\Request\InvalidRequestException

Public type 'Magento\Framework\App\DesignInterface' references following non-public types:
Magento\Framework\View\DesignInterface

Public type 'Magento\Framework\App\EnvironmentInterface' references following non-public types:
Magento\Framework\Interception\ObjectManager\ConfigInterface

Public type 'Magento\Framework\App\ExceptionHandlerInterface' references following non-public types:
Magento\Framework\App\Response\Http
Magento\Framework\App\Request\Http

Public type 'Magento\Framework\App\ResourceConnection\ConnectionAdapterInterface' references following non-public types:
Magento\Framework\DB\LoggerInterface

mrtuvn · 2021-02-21T02:17:56Z

@magento run Functional Tests B2B, Static Tests

mrtuvn · 2021-02-22T02:52:31Z

@magento run Functional Tests B2B

eduard13 · 2021-02-22T08:03:01Z

@mrtuvn instead of marking the api classes that are failing on Static Tests, it's better to take a quick look, maybe they were already mentioned in scope of another PRs. For example, here you are marking as api:

lib/internal/Magento/Framework/DB/LoggerInterface - but this was already marked in another your PR Mark Framework Interfaces as API part 3 #32156

This will cause a lot of conflicts while merging them.

Please add all the PRs that you find useful for your PR, as related.

Please let me know if any questions arise.

mrtuvn · 2021-02-24T16:34:56Z

@magento run Static Tests, Unit Tests

mrtuvn · 2021-02-25T02:04:58Z

@magento run Static Tests

mrtuvn · 2021-02-25T04:10:31Z

@magento run Database Compare, Functional Tests B2B, Functional Tests CE, Functional Tests EE, Integration Tests, Magento Health Index, Sample Data Tests B2B, Sample Data Tests CE, Sample Data Tests EE, Semantic Version Checker, WebAPI Tests

eduard13 · 2021-02-25T07:29:34Z

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

eduard13 · 2021-02-26T07:10:54Z

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

mrtuvn · 2021-02-26T08:01:06Z

@magento run all tests

eduard13 · 2021-03-01T06:28:12Z

@magento run Functional Tests EE, WebAPI Tests

gabrieldagama · 2021-04-13T10:04:46Z

lib/internal/Magento/Framework/App/Response/Http.php

@@ -131,7 +133,7 @@ public function sendVary()
     */
    public function setPublicHeaders($ttl)
    {
-        if ($ttl < 0 || !preg_match('/^[0-9]+$/', $ttl)) {
+        if ($ttl < 0 || !is_numeric($ttl)) {


We are not looking for code changes with these issues, please revert as it was.

This change introduce since i added strict_type at the first line of fine! This change pass test too should i revert strict_type in only this

In this case, let's create a separate PR to add the strict type and the code change. On this scope, we are looking just for API marking.

updating it

Update hollymolly up update update types fix fail tests update strict type for preg_match 2rd argument Update revert origin code resolve conflicts

mrtuvn · 2021-04-13T15:47:24Z

@magento run all tests

mrtuvn · 2021-04-13T22:34:48Z

@magento run Functional Tests B2B

mrtuvn · 2021-04-14T10:33:25Z

@gabrieldagama all green tests and ready!

gabrieldagama · 2021-05-06T09:07:26Z

@magento import code to https://github.com/magento-engcom/magento2ce

magento-engcom-team · 2021-05-06T09:09:50Z

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

m2-assistant · 2021-05-06T12:40:48Z

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.

m2-community-project bot added Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. Progress: pending review labels Feb 12, 2021

mrtuvn force-pushed the api-interfaces-mark-2 branch from d7afbfb to c83e092 Compare February 18, 2021 14:47

mrtuvn force-pushed the api-interfaces-mark-2 branch 2 times, most recently from 4a1eca6 to f997658 Compare February 20, 2021 09:08

mrtuvn force-pushed the api-interfaces-mark-2 branch from f997658 to 78f9a27 Compare February 22, 2021 15:07

gabrieldagama added this to the 2.5 milestone Feb 22, 2021

mrtuvn force-pushed the api-interfaces-mark-2 branch 2 times, most recently from 1eeb928 to a9bb8b2 Compare February 24, 2021 16:33

eduard13 self-requested a review February 25, 2021 07:39

eduard13 self-assigned this Feb 25, 2021

eduard13 added the Project: API Changes label Feb 25, 2021

m2-community-project bot added Progress: review and removed Progress: pending review labels Feb 25, 2021

mrtuvn force-pushed the api-interfaces-mark-2 branch from a9bb8b2 to 06092bb Compare February 26, 2021 08:00

eduard13 added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Feb 26, 2021

m2-community-project bot added Progress: extended testing Progress: accept and removed Progress: ready for testing Progress: extended testing labels Apr 6, 2021

gabrieldagama changed the base branch from 2.4-develop to api-changes-develop April 13, 2021 10:03

m2-community-project bot added Progress: ready for testing and removed Progress: accept labels Apr 13, 2021

gabrieldagama suggested changes Apr 13, 2021

View reviewed changes

m2-community-project bot assigned gabrieldagama Apr 13, 2021

m2-community-project bot added Progress: needs update Progress: review and removed Progress: ready for testing Progress: needs update labels Apr 13, 2021

mrtuvn force-pushed the api-interfaces-mark-2 branch from 909c294 to 123fe6b Compare April 13, 2021 14:06

mrtuvn requested a review from gabrieldagama April 13, 2021 14:06

Mark Framework interfaces as API part 2

789c540

Update hollymolly up update update types fix fail tests update strict type for preg_match 2rd argument Update revert origin code resolve conflicts

mrtuvn force-pushed the api-interfaces-mark-2 branch from 123fe6b to 789c540 Compare April 13, 2021 15:46

Merge branch 'api-changes-develop' into api-interfaces-mark-2

68ff23a

gabrieldagama approved these changes May 5, 2021

View reviewed changes

m2-community-project bot added Progress: ready for testing Progress: accept and removed Progress: review Progress: ready for testing labels May 5, 2021

magento-cicd2 merged commit d0afdf9 into magento:api-changes-develop May 6, 2021

Mark Framework interfaces as API part 2 #32140

Mark Framework interfaces as API part 2 #32140

Uh oh!

Conversation

mrtuvn commented Feb 12, 2021 • edited by gabrieldagama Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Uh oh!

m2-assistant bot commented Feb 12, 2021

Uh oh!

mrtuvn commented Feb 18, 2021

Uh oh!

mrtuvn commented Feb 18, 2021

Uh oh!

mrtuvn commented Feb 19, 2021

Uh oh!

mrtuvn commented Feb 21, 2021

Uh oh!

mrtuvn commented Feb 22, 2021

Uh oh!

eduard13 commented Feb 22, 2021

Uh oh!

mrtuvn commented Feb 24, 2021

Uh oh!

mrtuvn commented Feb 25, 2021

Uh oh!

mrtuvn commented Feb 25, 2021

Uh oh!

eduard13 commented Feb 25, 2021

Uh oh!

eduard13 commented Feb 26, 2021

Uh oh!

mrtuvn commented Feb 26, 2021

Uh oh!

eduard13 commented Mar 1, 2021

Uh oh!

gabrieldagama Apr 13, 2021

Choose a reason for hiding this comment

Uh oh!

mrtuvn Apr 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gabrieldagama Apr 13, 2021

Choose a reason for hiding this comment

Uh oh!

mrtuvn Apr 13, 2021

Choose a reason for hiding this comment

Uh oh!

mrtuvn commented Apr 13, 2021

Uh oh!

mrtuvn commented Apr 13, 2021

Uh oh!

mrtuvn commented Apr 14, 2021

Uh oh!

gabrieldagama commented May 6, 2021

Uh oh!

magento-engcom-team commented May 6, 2021

Uh oh!

m2-assistant bot commented May 6, 2021

Uh oh!

Uh oh!

mrtuvn commented Feb 12, 2021 •

edited by gabrieldagama

Loading

mrtuvn Apr 13, 2021 •

edited

Loading