Intersection type support

[lukinovec]

Hey! We're trying to run Doctum in the https://github.com/archtechx/tenancy repository (using php doctum.phar update doctum.php --output-format=github --force --ignore-parse-errors --no-ansi --no-progress -v), but the run keeps failing until we delete intersection types from our code. Could this be because Doctum\Parser\NodeVisitor's typeToString() method doesn't handle intersection types? I think those could be handled similarly to union types – using '&' instead of '|'.

Our config file:

use Doctum\Doctum;
use Symfony\Component\Finder\Finder;

$iterator = Finder::create()
    ->files()
    ->name('*.php')
    ->in('src/');

return new Doctum($iterator, [
    'title' => 'Tenancy for Laravel API Documentation',
    'base_url' => 'https://api.tenancyforlaravel.com/',
    'favicon' => 'https://tenancyforlaravel.com/favicon.ico',
]);

The stack trace:

Fatal error: Uncaught Error: Call to undefined method PhpParser\Node\IntersectionType::__toString() in phar:///Users/lukas/Projects/tenancy/doctum.phar/src/Parser/NodeVisitor.php:196
Stack trace:
#0 phar:///Users/lukas/Projects/tenancy/doctum.phar/src/Parser/NodeVisitor.php(329): Doctum\Parser\NodeVisitor->typeToString(Object(PhpParser\Node\IntersectionType))
#1 phar:///Users/lukas/Projects/tenancy/doctum.phar/src/Parser/NodeVisitor.php(73): Doctum\Parser\NodeVisitor->addMethod(Object(PhpParser\Node\Stmt\ClassMethod))
#2 phar:///Users/lukas/Projects/tenancy/doctum.phar/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(200): Doctum\Parser\NodeVisitor->enterNode(Object(PhpParser\Node\Stmt\ClassMethod))
#3 phar:///Users/lukas/Projects/tenancy/doctum.phar/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(114): PhpParser\NodeTraverser->traverseArray(Array)
#4 phar:///Users/lukas/Projects/tenancy/doctum.phar/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(223): PhpParser\NodeTraverser->traverseNode(Object(PhpParser\Node\Stmt\Class_))
#5 phar:///Users/lukas/Projects/tenancy/doctum.phar/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(114): PhpParser\NodeTraverser->traverseArray(Array)
#6 phar:///Users/lukas/Projects/tenancy/doctum.phar/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(223): PhpParser\NodeTraverser->traverseNode(Object(PhpParser\Node\Stmt\Namespace_))
#7 phar:///Users/lukas/Projects/tenancy/doctum.phar/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(91): PhpParser\NodeTraverser->traverseArray(Array)
#8 phar:///Users/lukas/Projects/tenancy/doctum.phar/src/Parser/CodeParser.php(48): PhpParser\NodeTraverser->traverse(Array)
#9 phar:///Users/lukas/Projects/tenancy/doctum.phar/src/Parser/Parser.php(66): Doctum\Parser\CodeParser->parse('<?php\n\ndeclare(...')
#10 phar:///Users/lukas/Projects/tenancy/doctum.phar/src/Project.php(725): Doctum\Parser\Parser->parse(Object(Doctum\Project), Array)
#11 phar:///Users/lukas/Projects/tenancy/doctum.phar/src/Project.php(137): Doctum\Project->parseVersion(Object(Doctum\Version\Version), NULL, Array, false)
#12 phar:///Users/lukas/Projects/tenancy/doctum.phar/src/Console/Command/Command.php(193): Doctum\Project->update(Array, false)
#13 phar:///Users/lukas/Projects/tenancy/doctum.phar/src/Console/Command/UpdateCommand.php(58): Doctum\Console\Command\Command->update(Object(Doctum\Project))
#14 phar:///Users/lukas/Projects/tenancy/doctum.phar/vendor/symfony/console/Command/Command.php(298): Doctum\Console\Command\UpdateCommand->execute(Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput))
#15 phar:///Users/lukas/Projects/tenancy/doctum.phar/vendor/symfony/console/Application.php(1040): Symfony\Component\Console\Command\Command->run(Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput))
#16 phar:///Users/lukas/Projects/tenancy/doctum.phar/vendor/symfony/console/Application.php(301): Symfony\Component\Console\Application->doRunCommand(Object(Doctum\Console\Command\UpdateCommand), Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput))
#17 phar:///Users/lukas/Projects/tenancy/doctum.phar/vendor/symfony/console/Application.php(171): Symfony\Component\Console\Application->doRun(Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput))
#18 phar:///Users/lukas/Projects/tenancy/doctum.phar/bin/doctum-binary.php(26): Symfony\Component\Console\Application->run()
#19 /Users/lukas/Projects/tenancy/doctum.phar(16): include('phar:///Users/l...')
#20 {main}
  thrown in phar:///Users/lukas/Projects/tenancy/doctum.phar/src/Parser/NodeVisitor.php on line 196

[williamdes]

Hi @lukinovec
Thank you for reporting this !
Can you give me one example file I can copy into my tests ?

[stancl]

Hi @williamdes, something like this should be able to reproduce the issue:

class Foo {}
interface Bar {}

class Baz
{
    public function __construct(
        public Foo&Bar $baz,
    ) {}
}

Basically just a class property/method parameter that uses intersection types.

[williamdes]

Nice, is there other more complicated examples I should test ?

[stancl]

Might be worth adding:

• class properties
• method parameters
• return types

separately in case the parser handles them differently.

So something like:

class FooAndBar extends Foo implements Bar {}

class Baz
{
    public Foo&Bar $fooAndBar;

    public function baz(Foo&Bar $baz)
    {
        return;
    }

    public function returnFooAndBar(): Foo&Bar
    {
        return new FooAndBar;
    }
}

[williamdes]

I pushed 0e7fb35 on QA 5.5

[stancl]

You can probably get rid of tests/phar/data/src/Intersection.php since it doesn't really test anything more than what tests/phar/data/src/RoundaboutIntersection.php tests. And then move the

class Foo {}
interface Bar {}

to tests/phar/data/src/RoundaboutIntersection.php. That will put it all in one file without re-defining Baz or using dependencies from other files.

[williamdes]

Well, one of the two has a namespace
But thanks for the hint
the goal is to have as much test files as possible
so most of the code is hit

[williamdes]

The 5.5.3-dev and 5.5-dev phars are out for testing, please let me know if they solve the issue for you
NB: The intersection type is not displayed the right way on html files, I am investigating

See: https://github.com/code-lts/doctum#installation

[stancl]

5.5.3-dev ran without failing now 👍🏻

As for rendering the types, here's one class we have:

class DatabaseConfig
{
    /** The tenant whose database we're dealing with. */
    public Tenant&Model $tenant;

    /** Database username generator (can be set by the developer.) */
    public static Closure|null $usernameGenerator = null;

    /** Database password generator (can be set by the developer.) */
    public static Closure|null $passwordGenerator = null;

    /** Database name generator (can be set by the developer.) */
    public static Closure|null $databaseNameGenerator = null;

   // ...
}

And it renders like this:

The type for $tenant is empty. For the other properties, it shows static. I'm not sure if it should also show the type (Closure|null or ?Closure).

[stancl]

Also I managed to set up the doctum dependency via composer (similar setup as https://github.com/laravel/laravel.com/tree/master/build/doctum), so if you need me to test any changes I can do so without you having to publish phars 👍🏻

[williamdes]

Also I managed to set up the doctum dependency via composer (similar setup as https://github.com/laravel/laravel.com/tree/master/build/doctum), so if you need me to test any changes I can do so without you having to publish phars 👍🏻

very cool, in fact I will always publish phars. it costs nothing for me :)
Just a bunch of Yubikey clicks :p

Do you want to make a PR on this project ?