using messenger HandleTrait as QueryBus with appropriate result typing by bnowak · Pull Request #423 · phpstan/phpstan-symfony

bnowak · 2025-01-17T12:05:44Z

This PR goal is to determine correct result typing for QueryBus kind of classes which uses SF messenger HandleTrait internally and simply return its results.

tests/Type/Symfony/data/messenger_handle_trait.php

michaljusiega · 2025-02-27T11:10:05Z

@ondrejmirtes Sorry to disturb you, but I think this is one of the pieces that is missing in this whole puzzle to support. Can we move forward ?

bnowak · 2025-03-14T13:29:55Z

Hi @michaljusiega, thanks for your reply. I think we can add it - no problem. However, from my perspective it's more important to address the root issue (missing feature) of the topic (described here). My reasoning is without having this result interpreted on bus class level - this is much less useful in general.

ondrejmirtes · 2025-05-05T15:25:11Z

So this QueryBus class is something in your codebase and you want the same type inference that classes using HandleTrait and calling the handle method have?

You can simply write a dynamic return type extension for QueryBus::dispatch() that delegates the type resolution to new MethodCall($methodCall->var, 'handle', $methodCall->getArgs()).

bnowak · 2025-07-28T07:23:56Z

@ondrejmirtes It's ready for review now. You were right about my intentions, however I wanted to make it working for any class that uses HandleTrait internally. I didn't want to hardcoded it, so made it parameterized. I've added also support for interfaces. Please review in you free time 🙏

It's likely to be conflicted with my another PR about splitting tests, so once first of these PR will be merged I can resolve conflicts on another one. 😉

bnowak · 2025-08-29T07:37:14Z

@ondrejmirtes any chances to review & merge it soon, please? :)

ondrejmirtes · 2025-09-07T06:57:58Z

README.md

+{
+    public function __invoke(GetProductQuery $query): Product
+    {
+        return $this->productRepository->get($query->productId);


Can you please add comments to the code in README about the inferred types with and without the extension? I'm still not sure what it does.

Thanks for reply.

So it's about inferring types of query bus classes (from CQRS pattern) or any custom class which internally use messenger's HandleTrait to get and return result of any dispatched message. Without the extension phpstan is not able to recognize that and gives generic return type of bus class (which in fact is some more specified query result).

So the main difference is calling query bus classes, where based on passed/dispatched message we're getting its correct result type.

I've updated README a bit and the the direct outcome is shown in the end of it - it shows that we're getting Product type instead of generic mixed. If that's still not precised and unclear, please advice me what else I could add/adjust. Maybe my describing skills are not so good 😅

@ondrejmirtes any chances to re-look on this please?

@ondrejmirtes ping 🙏

@ondrejmirtes ping2 🙏

@ondrejmirtes please, could you take a look on this again? and sorry for bothering you so many times

bnowak · 2025-12-16T07:47:47Z

@ondrejmirtes could you review it again please?

src/Type/Symfony/MessengerHandleTraitWrapperReturnTypeExtension.php

bnowak · 2026-02-17T17:18:07Z

@VincentLanglet thank you for your reply and review. I've addressed your comments and also added support for union types in classes which use HandleTrait directly (not only on their wrappers/query buses).

Please take a look and re-review.

Will that change be automatically merged into 2.x branch as well when approved? 🤞

VincentLanglet · 2026-02-17T21:43:49Z

Oh, didn't see you were targeting the 1.4.x branch.

You should target the 2.0.x instead ; there is no feature added to the version 1.

VincentLanglet · 2026-02-18T15:03:09Z

tests/Type/Symfony/data/messenger_handle_trait.php

To avoid the failure on php 7.4 I think you have to replace : mixed by a phpdoc @return mixed (everywhere in this file)

thanks for advice. I've tried that, but with just adding phpdoc it didn't change anything. It started working when I simply removed native return type (it's mixed by default).

Now it should work (I've tested locally on PHP 7.4 & 8.4), but now one CI job failed (on github.com authentication). I don't see button for retrying it (perhaps I don't have such permissions).

@VincentLanglet could you take a look and rerun CI jobs, please?

I restarted the Ci it's ok

bnowak · 2026-02-18T15:29:48Z

@VincentLanglet rebased to 2.0.x branch, but there's still issue with failed CI job (mentioned here).

Could you take a look on that and re-review once again? I hope, I already covered everything in this PR 🙏

VincentLanglet · 2026-02-18T22:31:45Z

Since you initially requested changes @ondrejmirtes, your review is required here :)

bnowak · 2026-02-19T08:20:38Z

Thank you @VincentLanglet!

@ondrejmirtes kindly request to take a look at that🙏

bnowak mentioned this pull request Jan 17, 2025

Using messenger HandleTrait as QueryBus with appropriate result typing #424

Open

michaljusiega reviewed Feb 27, 2025

View reviewed changes

tests/Type/Symfony/data/messenger_handle_trait.php Show resolved Hide resolved

bnowak force-pushed the messenger-handle-trait-generic-typing-support branch from cc1869e to 9b62bd8 Compare July 25, 2025 09:20

bnowak marked this pull request as ready for review July 28, 2025 07:18

ondrejmirtes requested changes Sep 7, 2025

View reviewed changes

bnowak force-pushed the messenger-handle-trait-generic-typing-support branch from cdcaab5 to a9f07aa Compare September 8, 2025 05:29

bnowak requested a review from ondrejmirtes September 10, 2025 07:59

VincentLanglet reviewed Feb 14, 2026

View reviewed changes

src/Type/Symfony/MessengerHandleTraitWrapperReturnTypeExtension.php Outdated Show resolved Hide resolved

src/Type/Symfony/MessengerHandleTraitWrapperReturnTypeExtension.php Outdated Show resolved Hide resolved

bnowak requested a review from VincentLanglet February 17, 2026 17:18

bnowak force-pushed the messenger-handle-trait-generic-typing-support branch from 6c3da90 to 5e425db Compare February 18, 2026 14:41

bnowak changed the base branch from 1.4.x to 2.0.x February 18, 2026 14:42

bnowak force-pushed the messenger-handle-trait-generic-typing-support branch from 5e425db to 60d8836 Compare February 18, 2026 14:42

VincentLanglet reviewed Feb 18, 2026

View reviewed changes

bnowak requested a review from VincentLanglet February 18, 2026 15:31

VincentLanglet approved these changes Feb 18, 2026

View reviewed changes

Bartłomiej Nowak added 4 commits February 19, 2026 09:20

test-cases for using messenger HandleTrait as QueryBus

0921866

implementation

3a6ce55

implementation for interfaces

40a7163

move test parameters to test extension-test-neon file

9710361

Bartłomiej Nowak and others added 7 commits February 19, 2026 09:20

updated README.md

345eba5

updated README.md

7d085c6

test class name fix

51898bd

added union test-cases

6af73ff

support for handling union types

a4b9a78

messenger params injected as service argument

2342c1f

fixed return mixed type wrong inference

3dea9c3

bnowak force-pushed the messenger-handle-trait-generic-typing-support branch from 390c9d6 to 3dea9c3 Compare February 19, 2026 08:21

Conversation

bnowak commented Jan 17, 2025

Uh oh!

Uh oh!

michaljusiega commented Feb 27, 2025

Uh oh!

bnowak commented Mar 14, 2025

Uh oh!

ondrejmirtes commented May 5, 2025

Uh oh!

bnowak commented Jul 28, 2025

Uh oh!

bnowak commented Aug 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bnowak commented Dec 16, 2025

Uh oh!

Uh oh!

Uh oh!

bnowak commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

VincentLanglet commented Feb 17, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bnowak commented Feb 18, 2026

Uh oh!

VincentLanglet commented Feb 18, 2026

Uh oh!

bnowak commented Feb 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

bnowak commented Feb 17, 2026 •

edited

Loading