Add new *ParameterClosureTypeExtension #3089

canvural · 2024-05-23T08:13:30Z

Hello 👋🏽

This PR adds new ClosureTypeChangingExtension extension that enables changing the closure type on the receiving side when necessary.

There are couple of issues I want solve before merging it though so I'm making a draft first:

Naming 😄 Not sure any of the names I picked. Also I see Dynamic prefix in other extensions, not sure if we should use it here too.
The extension finding loop stops as soon as it finds a matching extension. That made sense to me. But we can also gather every type and then union them at the end.
I think I tested it enough, but not sure if there is any edge case that I should test also.

ondrejmirtes

Let's solve the names as the last thing, now is time to solve the fundamentals :)

ondrejmirtes · 2024-05-23T15:08:55Z

src/Type/FunctionClosureTypeChangingExtension.php

+
+	public function isFunctionSupported(FunctionReflection $functionReflection): bool;
+
+	public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): ?Type;


I feel like this method signature is not sufficient because the parameter where the closure is passed to is also significat, right? So we also need to know ParameterReflection here. Also probably add it to the *Supported method too.

I feel like this method signature is not sufficient because the parameter where the closure is passed to is also significat, right?

hmm, not sure about that. We want to overwrite that parameter by supplying our own. And for my use case I did not need it. The test case I wrote here is basically the use case I needed.

Let's say you have a method call with three parameters. Each parameter is a callable. You want this extension to override each callable parameter with its own type.

Your current design only works for methods with a single callable parameter, not multiple. Right?

ooh yeah, now I understood. We want to be able to select which parameter we want to modify, right? By checking the parameter name or something.

Done ea44946

ondrejmirtes · 2024-05-23T15:09:19Z

src/Analyser/NodeScopeResolver.php

@@ -3928,6 +3930,49 @@ private function processClosureNode(
 		?Type $passedToType,
 	): ProcessClosureResult
 	{
+		if ($stmt instanceof Node\Stmt\Expression && $stmt->expr instanceof Expr\CallLike) {


This needs to work for nested expressions to so to eliminate everything that isn't Node\Stmt\Expression is not ideal.

We also need to do the same thing for processArrowFunctionNode.

This needs to work for nested expressions to so to eliminate everything that isn't Node\Stmt\Expression is not ideal.

How to do that?

I think my other suggestion (to move to processArgs) will take care of this too.

ondrejmirtes · 2024-05-23T15:13:13Z

src/Analyser/NodeScopeResolver.php

@@ -3928,6 +3930,49 @@ private function processClosureNode(
 		?Type $passedToType,
 	): ProcessClosureResult
 	{
+		if ($stmt instanceof Node\Stmt\Expression && $stmt->expr instanceof Expr\CallLike) {
+			if ($stmt->expr instanceof FuncCall && $stmt->expr->name instanceof Name && $this->reflectionProvider->hasFunction($stmt->expr->name, $scope)) {


We could get rid of these if statements if this logic was implemented in processArgs (where processClosureNode is called) it could be simplified a lot. You wouldn't have to look for the right reflection again, because it's available there as $calleeReflection.

Sure. I can try that.

ea44946

Yeah it simplified a lot. But the test case with calling static method on a class string doesn't work. And maybe it doesn't need to work 🤷🏽

Yeah, I'm not surprised by that. $calleeReflecrion is probably null for that case now.

Removed it for now.

Also I forgot to mention, there was no easy way to access the expression in processArgs, so had to refactor a bit so it accepts the expression (CallLike) now and extracts the args inside.

ondrejmirtes

This is fine by me 👍

Let's think about the name:

I think we can omit "changing". All extensions "change" something.
I think the extension names should include "parameter".

So something like this:

(Function|Method|StaticMethod)ParameterClosureTypeExtension (it communicates that it's about a function parameter and its type when you pass in closure)

Maybe we can also prefix the name with "Dynamic" but it might not be necessary.

Let me know your ideas :)

canvural · 2024-05-24T14:05:05Z

I can't find anything better than (Function|Method|StaticMethod)ParameterClosureTypeExtension actually. Dynamic also feels unnecessary cause every extension is dynamic 😄 But we can put it for consistency if you want. So I'll make the change 👍🏽

The extension finding loop stops as soon as it finds a matching extension. That made sense to me. But we can also gather every type and then union them at the end.

Do you have any thoughts for this one also?

ondrejmirtes · 2024-05-24T14:10:00Z

Yeah, "dynamic" is not necessary.

I'm fine with the current logic, if someone is going to need adjusting, we can change it in the future.

I'm going to merge it after the rename, thanks :)

ondrejmirtes · 2024-05-24T14:26:03Z

I'm on my phone and remembered one more thing - make sure the extension interfaces are marked with @api and also have a description like other interfaces, with a way to register them in .neon. Thanks!

ondrejmirtes · 2024-05-24T15:41:45Z

Thank you!

You can now require phpstan/phpstan:^1.11.3 in Larastan. Right now it's going to download a dev version that already contains this PR. Try to create the extensions you have in mind, and if it works for you, I can release PHPStan 1.11.3 and you can release a new Larastan version :)

canvural · 2024-05-24T16:05:58Z

Yeah I already tried it with downloading the PHAR file from the PR 😄 And tweeted the results. Everything looks good so far. I'll do more testing.

Thanks for the idea and your help! 😊

ondrejmirtes · 2024-05-24T16:09:07Z

Alright 😊 Since there already has been a release today, I'm going to release 1.11.3 at some point next week (while in Berlin at IPC).

canvural · 2024-05-24T16:10:38Z

Sure. No rush from my side.

add new ClosureTypeChangingExtension

187e074

canvural force-pushed the closure-type-changing-extension branch from b53f40c to 187e074 Compare May 23, 2024 08:15

ondrejmirtes requested changes May 23, 2024

View reviewed changes

canvural added 2 commits May 24, 2024 12:23

move logic to processArgs

ea44946

fix tests for < PHP 7.4

3b37e60

canvural force-pushed the closure-type-changing-extension branch from 134fb44 to 3b37e60 Compare May 24, 2024 10:45

ondrejmirtes requested changes May 24, 2024

View reviewed changes

use the correct naming

6626921

canvural requested a review from ondrejmirtes May 24, 2024 14:48

canvural changed the title ~~Add new ClosureTypeChangingExtension~~ Add new *ParameterClosureTypeExtension May 24, 2024

ondrejmirtes merged commit a57efdf into phpstan:1.11.x May 24, 2024
442 of 445 checks passed

canvural deleted the closure-type-changing-extension branch May 24, 2024 16:06

lentex mentioned this pull request Jun 1, 2024

Incompatibility with phpstan/phpstan v1.11.3 pestphp/pest-plugin-type-coverage#29

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new *ParameterClosureTypeExtension #3089

Add new *ParameterClosureTypeExtension #3089

canvural commented May 23, 2024

ondrejmirtes left a comment

ondrejmirtes May 23, 2024

canvural May 23, 2024

ondrejmirtes May 23, 2024

canvural May 23, 2024

ondrejmirtes May 24, 2024

canvural May 24, 2024

ondrejmirtes May 23, 2024

ondrejmirtes May 23, 2024

canvural May 23, 2024

ondrejmirtes May 23, 2024

ondrejmirtes May 23, 2024

canvural May 23, 2024

canvural May 24, 2024

ondrejmirtes May 24, 2024

canvural May 24, 2024

ondrejmirtes left a comment

canvural commented May 24, 2024

ondrejmirtes commented May 24, 2024

ondrejmirtes commented May 24, 2024

ondrejmirtes commented May 24, 2024

canvural commented May 24, 2024 •

edited

Loading

ondrejmirtes commented May 24, 2024

canvural commented May 24, 2024


		public function isFunctionSupported(FunctionReflection $functionReflection): bool;

		public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): ?Type;

Add new *ParameterClosureTypeExtension #3089

Add new *ParameterClosureTypeExtension #3089

Conversation

canvural commented May 23, 2024

ondrejmirtes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ondrejmirtes left a comment

Choose a reason for hiding this comment

canvural commented May 24, 2024

ondrejmirtes commented May 24, 2024

ondrejmirtes commented May 24, 2024

ondrejmirtes commented May 24, 2024

canvural commented May 24, 2024 • edited Loading

ondrejmirtes commented May 24, 2024

canvural commented May 24, 2024

canvural commented May 24, 2024 •

edited

Loading