Do not merge `BenevolentUnionType` with `UnionType` #2058

herndlm · 2022-12-06T20:49:04Z

This was inspired by phpstan/phpstan#8458 (comment)

Closes phpstan/phpstan#7049
Closes phpstan/phpstan#7279
Closes phpstan/phpstan#7423
Closes phpstan/phpstan#8268

Regarding the performance impact (#2058 (comment))

before:

Benchmark 1: make phpstan
  Time (mean ± σ):     56.978 s ± 10.578 s    [User: 338.941 s, System: 26.704 s]
  Range (min … max):   49.723 s … 82.109 s    10 runs

after:

Benchmark 1: make phpstan
  Time (mean ± σ):     51.790 s ±  5.459 s    [User: 330.922 s, System: 25.508 s]
  Range (min … max):   48.548 s … 66.973 s    10 runs

not sure if that is enough, the system is a bit trashy I guess. but looks like things don't really change perf.-wise. I'm pretty sure things also don't get faster, the variance is just too big on my system, I think we can go with 49s before and after.

Regarding the 3 failures

PocketMine: Cannot access offset (float|int<1, max>) on mixed. https://github.com/pmmp/PocketMine-MP/blob/e0b07ff3087b652407439a29c941f3b66ca92c86/src/pocketmine/CrashDump.php#L314 / https://github.com/pmmp/PocketMine-MP/blob/e0b07ff3087b652407439a29c941f3b66ca92c86/src/pocketmine/CrashDump.php#L111
Prestashop: modification of a ArrayObject<*NEVER*, *NEVER*> https://github.com/PrestaShop/PrestaShop/blob/ca9d81aae0bb17f3e767bb5d835348ed144a3ab5/src/Adapter/Presenter/AbstractLazyArray.php#L98
PHPUnit: modification of a ArrayObject<*NEVER*, *NEVER*>, e.g. https://github.com/sebastianbergmann/phpunit/blob/93d4bf4c37aec6384bb9e5d390d9049a463a7256/tests/unit/Framework/AssertTest.php#L153

all of those are expected IMO, but I can create PRs for Prestashop and PHPUnit to add PHPDoc types to the collection if wanted

herndlm · 2022-12-06T22:04:40Z

OK close, better than I thought. I guess I deleted too much and am loosing the benevolent template object..

staabm · 2022-12-07T07:15:42Z

You should measure whether these changes have a perf impact

VincentLanglet · 2022-12-07T17:01:12Z

Since A|(B|C) would be now a possible type, does it require a test to check that a benevolent union
(A|(B|C)|D) is simplified to (A|B|C|D) ?

herndlm · 2022-12-07T17:36:57Z

Good question, I'm not sure if it should be tbh. If we explicitly want a union, shouldn't it be non-benevolent? 🤔 I guess what I'm saying is, are we expecting this to be simplified if we call TypeCombinator::union()?
UPDATE: ah sorry, got your point now. Those should be simplified I suppose, yeah

tests/PHPStan/Analyser/data/bug-7279.php

herndlm · 2022-12-12T10:52:50Z

tests/PHPStan/Analyser/data/bug-7279.php

+	assertType('int|null', findKey($unknownList, $callback));
+	assertType('string|null', findKey($unknownMap, $callback));
+
+	assertType('int|null', findKey($nonEmptyList, $callback));
+	assertType('string|null', findKey($nonEmptyMap, $callback));


both L83 and L86 are different to the snippet where 'id'|'name'|null was asserted/expected. but this is either not supported or something different than the main problem that was fixed here IMO

phpstan-bot · 2022-12-12T12:09:59Z

This pull request has been marked as ready for review.

ondrejmirtes · 2023-01-08T13:42:28Z

I'm struggling a bit with this one. What is your thinking behind this PR? I see that it fixes a bunch of issues, but to me it looks like it's just a matter of luck, not an intention (please take no offense :)).

What's a typical situation that this PR improves/fixes?

Also, I think we need some more tests around this. Let's say for example we have (int|string) and we want to add some types into it by calling TypeCombinator::union. What's the expected result?

When we add a ConstantStringType like '1'.
When we add a StringType.
When we add ConstantBooleanType like true.

herndlm · 2023-01-08T14:12:04Z

The main intention behind this is that I believe, and I think the linked issues confirm it, that union with a benevolent union should not suddenly get rid of the benevolence. E.g. https://phpstan.org/r/498cd1d0-4568-4cbf-8b0b-11ed722552e8

Calling TypeCombinator::union() will always add a real union and not get rid of or extend the benevolence. More tests make sense for sure :) some already existed though I believe, and I just adapted their result. Your mentioned cases are good ones that worry me that the edges are still rough here hehe

But it's basically what you suggested at phpstan/phpstan#8268 (comment) (which I just found later via issue bot).

herndlm · 2023-01-08T20:42:28Z

Added the test cases for union with (int|string) you requested, we get the following

When we add a ConstantStringType like '1'.

(int|string)

When we add a StringType.

(int|string)

When we add ConstantBooleanType like true.

(int|string)|true

that looks OK to me 😊

ondrejmirtes · 2023-01-08T20:56:14Z

I'd argue that TypeCombinator::union of (int|string) and string should result in non-benevolent union type.

Another idea for a test - if we have (1|2) and string, it should result in string (which it probably will).

Also we can test what happens with (1|2|3) and int<2, 3>.

Also (InvalidArgumentException|LengthException|stdClass) and LogicException.

herndlm · 2023-01-08T21:05:52Z

Ok, added your mentioned cases again, the result is a bit different, I got

(1|2)|string UPDATE: but ('1'|'2')|string does result in string, not sure if I misunderstood that or not, anyway, also added it as a test
(1|2|3)
(InvalidArgumentException|LengthException|stdClass)|LogicException

so most likely there's still work needed / it can be improved? I pushed them in this state, but need to think about this another time. Such benevolent cases are still hard for me to think through properly

VincentLanglet · 2023-01-09T23:35:12Z

What's a typical situation that this PR improves/fixes?

https://phpstan.org/r/9be20c04-429f-4dc0-b245-9d23628ae2db

Both $key and $bool are accepted by the method, but the union of both type is not accepted.
The current behavior doesn't feel natural.

I'd argue that TypeCombinator::union of (int|string) and string should result in non-benevolent union type.

Technically, it should be (int)|string which is not really a possible type currently.

Because if it's transformed into int|string

		$key = current(array_keys($array));
		$this->acceptString($key); // valid
		$this->acceptString($string); // valid
		
		$keyOrString = rand(0,1) ? $key : $string;
		$this->acceptString($keyOrString); // won't be but should still be valid

drupol · 2023-01-13T15:11:02Z

Hello @herndlm,

I don't think this is closing #742, the output is different for sure, but it's not fixed actually.

herndlm · 2023-01-13T16:02:46Z

@drupol are you referring to the bot message you got in your issue (which is unrelated to this PR) or https://github.com/phpstan/phpstan-src/actions/runs/3910108845? :)

drupol · 2023-01-13T16:05:52Z

@drupol are you referring to the bot message you got in your issue (which is unrelated to this PR) or https://github.com/phpstan/phpstan-src/actions/runs/3910108845? :)

Sorry, here's the proper link: phpstan/phpstan#7423 I also fixed it in my previous message.

herndlm · 2023-01-13T16:08:45Z

Sorry, here's the proper link: phpstan/phpstan#7423 I also fixed it in my previous message.

yeah and why do you mean this PR does not fix it? the bot message there is unrelated. but in https://github.com/phpstan/phpstan-src/actions/runs/3910108845 I can see no errors for PHP 8+ because the type should be correct now? and that is also checked via regression test here.

drupol · 2023-01-13T16:09:33Z

Oh if it's unrelated, please ignore my message then.

Sorry for the noise.

herndlm · 2023-01-24T17:21:17Z

Did we come to a conclusion about this one? :) I rebased it on 1.10.x in the meantime. Thought the behavior change might be better there. In case it gets merged. So far it still makes sense to me

herndlm · 2023-05-23T14:54:33Z

Going to rebase this one tomorrow morning. Is there anything else I can do here? This still makes sense to me :)

ondrejmirtes · 2023-05-23T15:04:35Z

@herndlm I have some issues with it. For example I've seen a type (X)|Y mentioned somewhere and I don't think that one-item union type makes sense... So I'm not sure how you're handling it. Last time I looked at this PR it felt a bit undertested.

For example if you compare int|stdClass|string and (int|string)|stdClass - when is the first one going to be accepted and the second one won't?

herndlm force-pushed the do-not-merge-benevolent-union-with-union branch 2 times, most recently from 175fd36 to 7c3ff7b Compare December 6, 2022 21:52

rajyan mentioned this pull request Dec 7, 2022

Fix issue 8467 intersect resolved conditional types #2059

Merged

herndlm force-pushed the do-not-merge-benevolent-union-with-union branch from 7c3ff7b to ff51d9f Compare December 12, 2022 09:52

staabm reviewed Dec 12, 2022

View reviewed changes

tests/PHPStan/Analyser/data/bug-7279.php Outdated Show resolved Hide resolved

herndlm force-pushed the do-not-merge-benevolent-union-with-union branch 3 times, most recently from c2c716e to 8c77918 Compare December 12, 2022 10:49

herndlm commented Dec 12, 2022

View reviewed changes

herndlm marked this pull request as ready for review December 12, 2022 12:09

herndlm force-pushed the do-not-merge-benevolent-union-with-union branch 2 times, most recently from 3515799 to 3e7fff1 Compare December 13, 2022 10:49

herndlm force-pushed the do-not-merge-benevolent-union-with-union branch 2 times, most recently from ecb2fc4 to 23bee84 Compare January 3, 2023 01:49

ondrejmirtes force-pushed the 1.9.x branch from a5d90c1 to a69c7f0 Compare January 5, 2023 14:23

herndlm force-pushed the do-not-merge-benevolent-union-with-union branch from 23bee84 to 322a89a Compare January 8, 2023 20:41

herndlm force-pushed the do-not-merge-benevolent-union-with-union branch from c99a035 to 6e10519 Compare January 8, 2023 21:09

herndlm force-pushed the do-not-merge-benevolent-union-with-union branch 2 times, most recently from c9865e5 to 3251d3d Compare January 13, 2023 09:36

herndlm changed the base branch from 1.9.x to 1.10.x January 20, 2023 16:53

herndlm force-pushed the do-not-merge-benevolent-union-with-union branch 2 times, most recently from f6fb159 to aad632d Compare January 22, 2023 09:15

herndlm force-pushed the do-not-merge-benevolent-union-with-union branch 3 times, most recently from 70d77ae to 9d76dfa Compare March 3, 2023 17:10

herndlm added 6 commits April 8, 2023 20:05

Do not merge BenevolentUnionType with UnionType

f159381

Add regression tests

8e6260e

Add test cases requested in review

bc950ea

Add another complex theoretical union test

f59a388

Add more edge cases

fde388d

One more..

a5de12b

herndlm force-pushed the do-not-merge-benevolent-union-with-union branch from 9d76dfa to a5de12b Compare April 8, 2023 18:05

herndlm mentioned this pull request Apr 30, 2023

Integer overflow results in float value phpstan/phpstan#9257

Closed

herndlm marked this pull request as draft June 11, 2023 18:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Do not merge `BenevolentUnionType` with `UnionType` #2058

Do not merge `BenevolentUnionType` with `UnionType` #2058

herndlm commented Dec 6, 2022 •

edited

herndlm commented Dec 6, 2022

staabm commented Dec 7, 2022

VincentLanglet commented Dec 7, 2022

herndlm commented Dec 7, 2022 •

edited

herndlm Dec 12, 2022 •

edited

phpstan-bot commented Dec 12, 2022

ondrejmirtes commented Jan 8, 2023

herndlm commented Jan 8, 2023 •

edited

herndlm commented Jan 8, 2023

ondrejmirtes commented Jan 8, 2023

herndlm commented Jan 8, 2023 •

edited

VincentLanglet commented Jan 9, 2023

drupol commented Jan 13, 2023 •

edited

herndlm commented Jan 13, 2023

drupol commented Jan 13, 2023

herndlm commented Jan 13, 2023 •

edited

drupol commented Jan 13, 2023

herndlm commented Jan 24, 2023

herndlm commented May 23, 2023

ondrejmirtes commented May 23, 2023

Do not merge BenevolentUnionType with UnionType #2058

Are you sure you want to change the base?

Do not merge BenevolentUnionType with UnionType #2058

Conversation

herndlm commented Dec 6, 2022 • edited

Regarding the performance impact (#2058 (comment))

Regarding the 3 failures

herndlm commented Dec 6, 2022

staabm commented Dec 7, 2022

VincentLanglet commented Dec 7, 2022

herndlm commented Dec 7, 2022 • edited

herndlm Dec 12, 2022 • edited

Choose a reason for hiding this comment

phpstan-bot commented Dec 12, 2022

ondrejmirtes commented Jan 8, 2023

herndlm commented Jan 8, 2023 • edited

herndlm commented Jan 8, 2023

ondrejmirtes commented Jan 8, 2023

herndlm commented Jan 8, 2023 • edited

VincentLanglet commented Jan 9, 2023

drupol commented Jan 13, 2023 • edited

herndlm commented Jan 13, 2023

drupol commented Jan 13, 2023

herndlm commented Jan 13, 2023 • edited

drupol commented Jan 13, 2023

herndlm commented Jan 24, 2023

herndlm commented May 23, 2023

ondrejmirtes commented May 23, 2023

Do not merge `BenevolentUnionType` with `UnionType` #2058

Do not merge `BenevolentUnionType` with `UnionType` #2058

herndlm commented Dec 6, 2022 •

edited

herndlm commented Dec 7, 2022 •

edited

herndlm Dec 12, 2022 •

edited

herndlm commented Jan 8, 2023 •

edited

herndlm commented Jan 8, 2023 •

edited

drupol commented Jan 13, 2023 •

edited

herndlm commented Jan 13, 2023 •

edited