DriverManager::getConnection with wrapperClass static analysis problem

[DavideBicego]

After updating to doctrine/orm 2.8.4 from 2.8.1 I have a static analysis issue with the function DriverManager::getConnection().

The specific Psalm error is:

ERROR: MixedInferredReturnType - ... - Could not verify return type 'KanbanBOX\Core\Infrastructure\DataAccess\DatabaseConnection\ServiceDatabaseConnection' for ... :-:closure (see https://psalm.dev/047)
ServiceDatabaseConnection::class => static function (): ServiceDatabaseConnection {

ServiceDatabaseConnection extends Connection so the function call is:

DriverManager::getConnection(
    [
        'driver' => ...
        'wrapperClass' => ServiceDatabaseConnection::class,
    ]
);

Any suggestion?

[Ocramius]

This is an issue for doctrine/dbal, not doctrine/orm.

The change is from doctrine/dbal:2.12.1 to doctrine/dbal:2.13.1: 2.12.1...2.13.1

Relevant diff:

     *
-     * @param array{wrapperClass?: class-string<T>} $params
-     * @param Configuration|null                    $config       The configuration to use.
-     * @param EventManager|null                     $eventManager The event manager to use.
+     * @param array<string,mixed> $params
+     * @param Configuration|null  $config       The configuration to use.
+     * @param EventManager|null   $eventManager The event manager to use.
     *
     * @throws Exception
     *
+     * @phpstan-param array<string,mixed> $params
+     * @psalm-param Params $params
     * @psalm-return ($params is array{wrapperClass:mixed} ? T : Connection)
     * @template T of Connection
     */
    public static function getConnection(
        array $params,
        ?Configuration $config = null,
        ?EventManager $eventManager = null
    ): Connection {

[Ocramius]

Minimal reproducer: https://psalm.dev/r/62a0a5854d

<?php

class Connection {}
class MyConnection extends Connection{}

/**
 * @psalm-type Params = array{
 *     charset?: string,
 *     wrapperClass?: class-string<Connection>,
 * }
 */
final class DriverManager
{
    /**
     * @param array<string,mixed> $params
     * @param Configuration|null  $config       The configuration to use.
     * @param EventManager|null   $eventManager The event manager to use.
     *
     * @phpstan-param array<string,mixed> $params
     * @psalm-param Params $params
     * @psalm-return ($params is array{wrapperClass:mixed} ? T : Connection)
     * @template T of Connection
     */
    public static function getConnection(
        array $params
    ): Connection {
        throw new \Exception('irrelevant');
    }
}

function mkConnection(): MyConnection {
    return DriverManager::getConnection(['wrapperClass' => MyConnection::class]);
}

Which produces:

Psalm output (using commit aa854ae): 

INFO: MixedInferredReturnType - 31:26 - Could not verify return type 'MyConnection' for mkConnection

The issue is that the Param alias type is not templated: this is potentially a psalm limitation, but also an understandable one, since there is no syntax to specify template arguments for an imported type (AFAIK).

Here is a potential fix:

https://psalm.dev/r/8ef9909bb9

<?php

class Connection {}
class MyConnection extends Connection{}

/**
 * @psalm-type Params = array{
 *     charset?: string,
 *     wrapperClass?: class-string<Connection>,
 * }
 */
final class DriverManager
{
    /**
     * @psalm-param array{
     *     charset?: string,
     *     wrapperClass?: class-string<T>,
     * } $params
     * @psalm-return ($params is array{wrapperClass: mixed} ? T : Connection)
     * @template T of Connection
     */
    public static function getConnection(
        array $params
    ): Connection {
        throw new \Exception('irrelevant');
    }
}

function mkConnection(): MyConnection {
    return DriverManager::getConnection(['wrapperClass' => MyConnection::class]);
}

It's a bit ugly, but the idea is that we replace Params with the concrete definition again, but this time including T, so that the type inference can correctly fill the type variable with the given input:

Psalm output (using commit aa854ae): 

No issues!

I'll send a patch with a fix for this.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.