magento/magento2

Add PHP 8 Union Types Support for function Return Type

Opened this issue · 5 comments

karyna-t commented

In PHP 8, new Union types feature was introduced.
(see details https://wiki.php.net/rfc/union_types_v2)

e.g. it's possible to create a function with a signature like
function baz(): Foo|Bar|int { ...
were return type is a union.

Right now Magento will not work properly with such a feature. There are several places where we're using Parameter's Class (e.g. for code generation):

Such places should be adjusted to work properly with union types.
The main reason for this adjustments it's because 3rd-party developers may develop some new extensions and declare them to support only php >= 8.0.
in such modules they may use this PHP8-feature.

Expected result (*)

Magento should not break when union types are used in the function return type. It should properly generate code and so on.

Actual result (*)

Right now Magento can't handle union types introduced in php 8.

Related issues:

#34263
#34265

m2-assistant commented

Hi @karyna-tsymbal-atwix. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

  • Summary of the issue
  • Information on your environment
  • Steps to reproduce
  • Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, please, review the Magento Contributor Assistant documentation.

Please, add a comment to assign the issue: @magento I am working on this

⚠️ According to the Magento Contribution requirements, all issues 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 issues 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-assistant commented

Hi @engcom-November. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

  • 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

    DetailsIf the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

  • 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

  • 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

  • 4. Verify that the issue is reproducible on 2.4-develop branch

    Details- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
    - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
    - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

  • 5. Add label Issue: Confirmed once verification is complete.

  • 6. Make sure that automatic system confirms that report has been added to the backlog.

engcom-November commented

Hi @karyna-tsymbal-atwix ,
We have gone through the main description and found that this is not related to any bug of Magento but it can be a good feature to have in Magento. Hence marking this ticket as a feature request to process further.
Thank you.

barbazul commented

+1 to this.

We recently run into an issue where the GraphQl introspection stopped working after merging a big feature branch that included a third party module.

Turns out the module included a Resolver with multiple public methods that returned union types and that was the reason. We patched the module to remove the type hints and it fixed the issue.

We were very surprised to discover that Magento claims to support PHP 8.1 but clearly there are limits to such support which are not declared in any place of the documentation.

At the very least, the Coding Standard could raise a warning when union types are used.

barbazul commented

As discussed in magento/magento-coding-standard#431 this issue should be treated as a bug and not a feature request.

As per the documentation, the usage of Union and Intersection return types is implied to be supported as part of the PHP 8.1 support.

  • 👍2