Intersection types #637

Nek- · 2025-04-17T10:10:31Z

Note about the design: I created a new sub-api for type management because the current one is not compatible with intersections but needs to exist to keep backward compatibility.

What still needs to be done:

Fix existing bugs/tests with this implementation (god it's hard to fix)
Add deprecation about the old API (some comments already existing in the code will help!)
Refactor to remove deprecated calls
Implement code generation with intersection
Add tests regarding intersection
Implement intersection support & dnf for methods args

Please have a look and tell me if this kind of implementation would be ok for you. Thanks!

Stands as replacement for #569 and should fix #535 and #558

Update: the PR is ready and waiting to be merged :)

src/Prophecy/Doubler/Generator/ClassMirror.php

stof · 2025-04-17T10:25:36Z

src/Prophecy/Doubler/Generator/ClassMirror.php

+    {
+        if ($type instanceof ReflectionIntersectionType) {
+            foreach ($type->getTypes() as $innerReflectionType) {
+                $innerTypes[] = new SimpleType($innerReflectionType->getName());


isn't this missing the resolution of the type name ?

maybe this should use createTypeFromReflection for the inner type as well.

src/Prophecy/Doubler/Generator/Node/ReturnTypeNode.php

stof · 2025-04-17T10:29:26Z

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

+    /**
+     * @param string|TypeInterface ...$types
+     */
+    public function __construct(string|TypeInterface ...$types)


shouldn't the new API allows null as well ?

Yep the new API will be null|string|TypeInterface $type = null, you're absolutely right

Then this needs to be updated to support passing null

My bad it should be new BuiltinType('null') in the new API.

I'm not talking about the case where of using null as return type, but of the case of not having a return type at all.

new ReturnTypeNode() will work for this (just like it was before). Do you want the new API to support new ReturnTypeNode(null) ? (I though it was a good idea, not sure about it now)

yes, new ReturnTypeNode(null) should work. Otherwise, we won't be able to remove the BC layer in the next version anyway (where we don't want to have a variadic argument anymore)

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

stof · 2025-04-17T10:34:38Z

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

            }
        }
-
-        if (\PHP_VERSION_ID >= 80000 && isset($this->types['mixed']) && count($this->types) !== 1) {


why removing this ?

Question is more like why is this method guardIsValidType still here. I will remove it on cleanup. The UnionType checks this mixed-thing already.

stof · 2025-04-17T10:34:42Z

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

    }

    /**
+     * @todo: put this in SimpleType


This cannot really go in SimpleType, as some of those are about the full type, not each simple type used in a union

I guess each type will have its own exceptions, this still needs to be done.

stof · 2025-04-17T10:35:13Z

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

+     * @todo: put this in SimpleType
     * @return void
     */
    protected function guardIsValidType()


Be careful. ReturnTypeNode extends this class to override this method, but you still use $this->types in it.

After cleanup this method should not even exist anymore here.

src/Prophecy/Doubler/Generator/Node/Type/SimpleType.php

Nek- · 2025-04-26T10:31:36Z

Thank you for your review @stof . And good news! I fixed the bugs in my previous implementation. (some you noticed in your review!) Keeping backward compatibility has been a real pain! But it WORKS. (test suite green 100%)

It's currently a fully working PR for intersection type.... But only for return types!

Some work needs to be done for cleaning... But it also needs php to be bumped to 8.1+ (which would probably be better in another PR), and a lot of cleaning.

But for now, since it's a lot of work and personal investment, I'd like you to tell me if the implementation is ok before working on it again.

src/Prophecy/Doubler/Generator/Node/Type/SimpleType.php

stof · 2025-04-30T07:48:23Z

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

 {
-    /** @var array<string, string> */
-    protected $types = [];
+    protected TypeInterface|null $type;


I suggest making the new property private (if child classes need to read it, there is a public getter they can use)

stof · 2025-04-30T07:48:52Z

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

+    /**
+     * @param string|TypeInterface ...$types
+     */
+    public function __construct(string|TypeInterface ...$types)


Then this needs to be updated to support passing null

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

stof · 2025-04-30T07:56:25Z

src/Prophecy/Doubler/Generator/ClassCodeGenerator.php

+
+        if ($type instanceof UnionType) {
+            return join('|', array_map(
+                fn (TypeInterface $type) => $this->generateSubType($type),


this logic does not support DNF types. Parenthesis are required around the intersection types used in a union type.

Right, and fixed!

src/Prophecy/Doubler/Generator/ClassMirror.php

src/Prophecy/Doubler/Generator/Node/Type/UnionType.php

src/Prophecy/Doubler/Generator/Node/Type/SimpleType.php

spec/Prophecy/Doubler/Generator/ClassCodeGeneratorSpec.php

Nek- · 2025-06-10T09:49:59Z

@stof I updated the PR following your insights, thank you for the detailed review. ⭐

I still need to track deprecated calls and add deprecation triggers, and I will do it promptly as soon as you validate that new implementation.

stof

The general approach looks good. I still recommend changing the way we manage the source code representation of a given type.
Please start working on the deprecation layer as well.

spec/Prophecy/Doubler/Generator/Node/ReturnTypeNodeSpec.php

src/Prophecy/Doubler/Generator/ClassMirror.php

stof · 2025-06-10T13:38:59Z

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

-            $this->types[$type] = $type;
-        }
+        $deprecation = 'Only 1 type will be supported in the future, strings are no longer supported as type.';
+        if (count($types) === 1 && $types[0] instanceof TypeInterface) {


we should accept count($types) === 1 && $types[0] === null as well, to assign null in the property

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

src/Prophecy/Doubler/Generator/Node/Type/BuiltinType.php

stof · 2025-06-10T13:52:55Z

src/Prophecy/Doubler/Generator/Node/Type/ObjectType.php

+
+    private function prefixWithNsSeparator(string $type): string
+    {
+        // Avoid double-prefixing if already prefixed


I think the new API should not deal with that, expecting the unprefixed class name to be passed instead (which might be guarded to avoid issues). The BC layer in TypeNodeAbstract would have to handle the BC layer.

I'm unmarking this as resolved, because you kept this logic (without any answer about why my comment got ignored)

This is done! This method is only for the __toString() method.

If the ObjectType is implemented as expecting class-string, we won't care about a type starting with \, as that won't happen. So __toString should just be return '\\'.$this->type;

And that's also solving the case of equals which currently treat new ObjectType('stdClass') and new ObjectType('\stdClass') as not equal.

src/Prophecy/Doubler/Generator/Node/Type/ObjectType.php

src/Prophecy/Doubler/Generator/ClassCodeGenerator.php

Nek- · 2025-06-10T14:31:44Z

I still recommend changing the way we manage the source code representation of a given type.

Please explain what you mean because I refactored precisely with your recommandation here (the "ObjectType" vs "BuiltinType" thing in particular)

stof · 2025-06-10T14:38:11Z

@Nek- that's what I detailed more in #637 (comment) and #637 (comment)

stof · 2025-06-10T14:44:36Z

tests/Doubler/Generator/ClassMirrorTest.php

-    public function it_can_not_double_intersection_return_types(): void
+    public function it_can_double_intersection_return_types(): void
    {
        if (PHP_VERSION_ID < 80100) {


looks like those version checks were not properly cleaned when bumping the min PHP version.

Maybe to be done in a separated work?

This follow discussion on PR phpspec#637

Nek- · 2025-07-16T22:53:50Z

@stof I'm still working on this!

Removing deprecated usages is a new mini challenge and made me discover some features I forgot on the way, I will add according tests as well.

But I have an issue with triggering deprecation notice. It does makes the phpspec test suite fail, I can't make it pass with the trigger working. (I guess I'm not the first one hitting this issue since other deprecated methods do not throw deprecation error)
Is it ok to you if I push those deprecations commented?

stof · 2025-07-22T08:51:40Z

Indeed, phpspec does not have a good handling of deprecations. I opened phpspec/phpspec#1494 about it.

reading the code of phpspec, I think the pattern used in symfony/deprecation-contracts (triggering a silenced deprecation) would work in phpspec (phpspec itself won't report it, but it will benefit people using phpunit with a config reporting them)

Nek- · 2025-07-22T08:57:35Z

reading the code of phpspec, I think the pattern used in symfony/deprecation-contracts (triggering a silenced deprecation) would work in phpspec (phpspec itself won't report it, but it will benefit people using phpunit with a config reporting them)

Awesome. I will use this. Thanks!

Nek- · 2025-07-23T23:23:53Z

@stof finally something mergeable 😅

Thank you so much for your critical reviews. (I secretly expect to get some more again haha)

src/Prophecy/Doubler/Generator/ClassCodeGenerator.php

src/Prophecy/Doubler/Generator/ClassMirror.php

src/Prophecy/Doubler/Generator/Node/Type/BuiltinType.php

src/Prophecy/Doubler/Generator/Node/Type/UnionType.php

src/Prophecy/Doubler/Generator/Node/Type/SimpleType.php

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

Nek- · 2025-09-08T11:54:51Z

@stof I updated the PR it's waiting for your review. 🙏

src/Prophecy/Doubler/Generator/Node/Type/BuiltinType.php

composer.json

spec/Prophecy/Argument/Token/ArrayEntryTokenSpec.php

stof · 2025-09-08T12:42:06Z

src/Prophecy/Doubler/Generator/Node/Type/ObjectType.php

+
+    private function prefixWithNsSeparator(string $type): string
+    {
+        // Avoid double-prefixing if already prefixed


I'm unmarking this as resolved, because you kept this logic (without any answer about why my comment got ignored)

src/Prophecy/Doubler/Generator/Node/Type/SimpleType.php

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

This follow discussion on PR phpspec#637

src/Prophecy/Doubler/Generator/ClassMirror.php

src/Prophecy/Doubler/Generator/Node/Type/ObjectType.php

src/Prophecy/Doubler/Generator/Node/Type/UnionType.php

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php

Nek- · 2025-09-11T15:53:17Z

@stof I think I did all your review. Do you want me to squash and detail a bit inside the commit what happen here?

stof · 2025-09-26T18:43:52Z

Do you want me to squash and detail a bit inside the commit what happen here?

yes, that would be great

Nek- · 2025-09-29T12:33:06Z

@stof done!

- Adds a new layer for Types inside the generator (with keeping the old one for BC reasons!) - Introduce a way of triggering deprecation without making phpspec failing by adding symfony/deprecation-contracts to the project - Update all internal usages to make prophecy use its own new API

stof · 2025-09-29T13:32:34Z

It took time, but this is finally merged. Thanks a lot @Nek- !

julienbornstein · 2025-09-29T22:48:30Z

Thanks @Nek- (nice to see you again)

Shivoham · 2026-01-14T15:50:07Z

Thanks @Nek- !

stof reviewed Apr 17, 2025

View reviewed changes

Nek- force-pushed the intersection-types branch from 5250a7c to ebb7746 Compare April 25, 2025 23:51

Nek- force-pushed the intersection-types branch from e0672c9 to facea20 Compare April 26, 2025 12:50

Nek- changed the title ~~Implement intersection types~~ Intersection types Apr 26, 2025

stof reviewed Apr 30, 2025

View reviewed changes

src/Prophecy/Doubler/Generator/Node/Type/UnionType.php Outdated Show resolved Hide resolved

Nek- mentioned this pull request May 7, 2025

Upgrade PHP minimum version to 8.2 #644

Merged

Nek- force-pushed the intersection-types branch from facea20 to 55a06b0 Compare May 14, 2025 18:47

stof requested changes May 15, 2025

View reviewed changes

src/Prophecy/Doubler/Generator/Node/Type/SimpleType.php Outdated Show resolved Hide resolved

stof reviewed May 15, 2025

View reviewed changes

spec/Prophecy/Doubler/Generator/ClassCodeGeneratorSpec.php Outdated Show resolved Hide resolved

stof reviewed May 15, 2025

View reviewed changes

spec/Prophecy/Doubler/Generator/ClassCodeGeneratorSpec.php Outdated Show resolved Hide resolved

alexander-schranz mentioned this pull request May 23, 2025

Add support for doctrine/orm 3 sulu/sulu#7509

Merged

8 tasks

Nek- force-pushed the intersection-types branch from 0e986a3 to 0e42341 Compare June 10, 2025 09:46

stof reviewed Jun 10, 2025

View reviewed changes

Nek- added a commit to Nek-/prophecy that referenced this pull request Jul 14, 2025

Improve logic of new type management architecture

0f4c0b4

This follow discussion on PR phpspec#637

Nek- force-pushed the intersection-types branch from 9e5062b to 3cef15d Compare July 23, 2025 23:18

Nek- marked this pull request as ready for review August 11, 2025 13:17

stof reviewed Aug 29, 2025

View reviewed changes

stof mentioned this pull request Aug 29, 2025

Initial idea for Intersection/Union types #569

Closed

stof requested changes Sep 8, 2025

View reviewed changes

Nek- added a commit to Nek-/prophecy that referenced this pull request Sep 10, 2025

Improve logic of new type management architecture

dae7323

This follow discussion on PR phpspec#637

Nek- force-pushed the intersection-types branch from 0d5c75e to 1a5f210 Compare September 10, 2025 10:30

stof reviewed Sep 10, 2025

View reviewed changes

src/Prophecy/Doubler/Generator/ClassMirror.php Show resolved Hide resolved

src/Prophecy/Doubler/Generator/Node/Type/ObjectType.php Outdated Show resolved Hide resolved

src/Prophecy/Doubler/Generator/Node/Type/UnionType.php Outdated Show resolved Hide resolved

stof reviewed Sep 10, 2025

View reviewed changes

src/Prophecy/Doubler/Generator/Node/TypeNodeAbstract.php Outdated Show resolved Hide resolved

Nek- force-pushed the intersection-types branch 2 times, most recently from d7098f6 to 876f8ee Compare September 10, 2025 16:04

stof approved these changes Sep 26, 2025

View reviewed changes

Nek- force-pushed the intersection-types branch from 876f8ee to d044dbb Compare September 29, 2025 12:32

stof force-pushed the intersection-types branch from d044dbb to d6d9103 Compare September 29, 2025 13:23

stof merged commit 222e40d into phpspec:master Sep 29, 2025
8 checks passed

stof mentioned this pull request Sep 29, 2025

Support for Disjunctive Normal Form Types #558

Closed

Nek- deleted the intersection-types branch September 29, 2025 14:48

This was referenced Oct 6, 2025

Add Readonly support #623

Open

Add missing docblocks #653

Open

Intersection types #637

Intersection types #637

Uh oh!

Conversation

Nek- commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Nek- Apr 17, 2025 • 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!

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!

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!

Uh oh!

Uh oh!

Nek- commented Apr 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Nek- commented Jun 10, 2025

Uh oh!

stof left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Nek- commented Apr 17, 2025 •

edited

Loading

Nek- Apr 17, 2025 •

edited

Loading

Nek- commented Apr 26, 2025 •

edited

Loading