Merge branch '3.6.x' into 4.0.x

* 3.6.x: Formally allow `url` in `DriverManager::getConnection()` Use narrower return types for convertTo*Value methods Reuse the Params type alias for getConnection() Test the return type of DriverManager::getAvailableDrivers() Use a more specific return type for DriverManager::getAvailableDrivers() Remove database URLs from tests Allow to explicitly set the wrapper class to the default one
derrabus · Jan 9, 2023 · 5634ab4 · 5634ab4
2 parents 851e42d + d432414
commit 5634ab4
Show file tree

Hide file tree

Showing 25 changed files with 259 additions and 39 deletions.
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -3,6 +3,7 @@ parameters:
     phpVersion: 80200
     paths:
         - src
+        - static-analysis
         - tests
     treatPhpDocTypesAsCertain: false
     reportUnmatchedIgnoredErrors: false
@@ -70,11 +71,14 @@ parameters:
             message: '~array{driver: ''invalid_driver''} given\.$~'
             path: tests/DriverManagerTest.php
         -
-            message: '~array{url: ''sqlite::memory:'', wrapperClass: ''stdClass''} given\.$~'
+            message: '~array{driver: ''pdo_sqlite'', memory: true, wrapperClass: ''stdClass''} given\.$~'
             path: tests/DriverManagerTest.php
         -
             message: '~array{driverClass: ''stdClass''} given\.$~'
             path: tests/DriverManagerTest.php
+        -
+            message: '~^Call to static method PHPUnit\\Framework\\Assert\:\:assert(?:NotNull|Null|InstanceOf|IsFloat|IsInt)\(\) with .* will always evaluate to true\.$~'
+            path: tests/Types/
 
         # DriverManagerTest::testDatabaseUrl() should be refactored as it's too dynamic.
         -

diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -166,6 +166,14 @@
                 -->
                 <file name="src/Platforms/AbstractMySQLPlatform.php"/>
                 <file name="tests/Functional/Driver/AbstractDriverTest.php"/>
+
+                <!-- We're testing invalid input. -->
+                <file name="tests/Types/DateImmutableTypeTest.php"/>
+                <file name="tests/Types/DateTimeImmutableTypeTest.php"/>
+                <file name="tests/Types/TimeImmutableTypeTest.php"/>
+
+                <!-- False positive: "mixed is never string" -->
+                <file name="src/Platforms/PostgreSQLPlatform.php" />
             </errorLevel>
         </RedundantConditionGivenDocblockType>
         <RedundantPropertyInitializationCheck>

diff --git a/src/DriverManager.php b/src/DriverManager.php
@@ -18,7 +18,7 @@
 use function array_keys;
 use function class_implements;
 use function in_array;
-use function is_subclass_of;
+use function is_a;
 
 /**
  * Factory for creating {@see Connection} instances.
@@ -123,30 +123,9 @@ private function __construct()
      * The driver class to use.
      *
      * @param Configuration|null $config The configuration to use.
-     * @psalm-param array{
-     *     charset?: string,
-     *     dbname?: string,
-     *     driver?: key-of<self::DRIVER_MAP>,
-     *     driverClass?: class-string<Driver>,
-     *     driverOptions?: array<mixed>,
-     *     host?: string,
-     *     keepSlave?: bool,
-     *     keepReplica?: bool,
-     *     master?: OverrideParams,
-     *     memory?: bool,
-     *     password?: string,
-     *     path?: string,
-     *     pdo?: \PDO,
-     *     port?: int,
-     *     primary?: OverrideParams,
-     *     replica?: array<OverrideParams>,
-     *     sharding?: array<string,mixed>,
-     *     slaves?: array<OverrideParams>,
-     *     user?: string,
-     *     wrapperClass?: class-string<T>,
-     * } $params
+     * @psalm-param Params $params
      *
-     * @psalm-return ($params is array{wrapperClass:mixed} ? T : Connection)
+     * @psalm-return ($params is array{wrapperClass: class-string<T>} ? T : Connection)
      *
      * @template T of Connection
      */
@@ -159,14 +138,10 @@ public static function getConnection(array $params, ?Configuration $config = nul
             $driver = $middleware->wrap($driver);
         }
 
-        $wrapperClass = Connection::class;
-        if (isset($params['wrapperClass'])) {
-            if (! is_subclass_of($params['wrapperClass'], $wrapperClass)) {
-                throw InvalidWrapperClass::new($params['wrapperClass']);
-            }
-
-            /** @var class-string<Connection> $wrapperClass */
-            $wrapperClass = $params['wrapperClass'];
+        /** @var class-string<Connection> $wrapperClass */
+        $wrapperClass = $params['wrapperClass'] ?? Connection::class;
+        if (! is_a($wrapperClass, Connection::class, true)) {
+            throw InvalidWrapperClass::new($wrapperClass);
         }
 
         return new $wrapperClass($params, $driver, $config);
@@ -176,6 +151,7 @@ public static function getConnection(array $params, ?Configuration $config = nul
      * Returns the list of supported drivers.
      *
      * @return string[]
+     * @psalm-return list<key-of<self::DRIVER_MAP>>
      */
     public static function getAvailableDrivers(): array
     {

diff --git a/src/Platforms/AbstractPlatform.php b/src/Platforms/AbstractPlatform.php
@@ -1736,6 +1736,12 @@ public function convertBooleans(mixed $item): mixed
      * Some platforms have boolean literals that needs to be correctly converted
      *
      * The default conversion tries to convert value into bool "(bool)$item"
+     *
+     * @param T $item
+     *
+     * @return (T is null ? null : bool)
+     *
+     * @template T
      */
     public function convertFromBoolean(mixed $item): ?bool
     {

diff --git a/src/Platforms/PostgreSQLPlatform.php b/src/Platforms/PostgreSQLPlatform.php
@@ -531,6 +531,13 @@ static function ($value): ?int {
         );
     }
 
+    /**
+     * @param T $item
+     *
+     * @return (T is null ? null : bool)
+     *
+     * @template T
+     */
     public function convertFromBoolean(mixed $item): ?bool
     {
         if (in_array($item, $this->booleanLiterals['false'], true)) {

diff --git a/src/Types/BigIntType.php b/src/Types/BigIntType.php
@@ -25,6 +25,13 @@ public function getBindingType(): ParameterType
         return ParameterType::STRING;
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : string)
+     *
+     * @template T
+     */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?string
     {
         return $value === null ? null : (string) $value;

diff --git a/src/Types/BooleanType.php b/src/Types/BooleanType.php
@@ -25,6 +25,13 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
         return $platform->convertBooleansToDatabaseValue($value);
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : bool)
+     *
+     * @template T
+     */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?bool
     {
         return $platform->convertFromBoolean($value);

diff --git a/src/Types/DateImmutableType.php b/src/Types/DateImmutableType.php
@@ -14,6 +14,13 @@
  */
 class DateImmutableType extends DateType
 {
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : string)
+     *
+     * @template T
+     */
     public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?string
     {
         if ($value === null) {
@@ -31,6 +38,13 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
         );
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : DateTimeImmutable)
+     *
+     * @template T
+     */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?DateTimeImmutable
     {
         if ($value === null || $value instanceof DateTimeImmutable) {

diff --git a/src/Types/DateIntervalType.php b/src/Types/DateIntervalType.php
@@ -29,6 +29,13 @@ public function getSQLDeclaration(array $column, AbstractPlatform $platform): st
         return $platform->getStringTypeDeclarationSQL($column);
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : string)
+     *
+     * @template T
+     */
     public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?string
     {
         if ($value === null) {
@@ -42,6 +49,13 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
         throw InvalidType::new($value, static::class, ['null', 'DateInterval']);
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : DateInterval)
+     *
+     * @template T
+     */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?DateInterval
     {
         if ($value === null || $value instanceof DateInterval) {

diff --git a/src/Types/DateTimeImmutableType.php b/src/Types/DateTimeImmutableType.php
@@ -16,6 +16,13 @@
  */
 class DateTimeImmutableType extends DateTimeType
 {
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : string)
+     *
+     * @template T
+     */
     public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?string
     {
         if ($value === null) {
@@ -33,6 +40,13 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
         );
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : DateTimeImmutable)
+     *
+     * @template T
+     */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?DateTimeImmutable
     {
         if ($value === null || $value instanceof DateTimeImmutable) {

diff --git a/src/Types/DateTimeType.php b/src/Types/DateTimeType.php
@@ -25,6 +25,13 @@ public function getSQLDeclaration(array $column, AbstractPlatform $platform): st
         return $platform->getDateTimeTypeDeclarationSQL($column);
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : string)
+     *
+     * @template T
+     */
     public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?string
     {
         if ($value === null) {
@@ -38,6 +45,13 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
         throw InvalidType::new($value, static::class, ['null', 'DateTime']);
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : DateTimeInterface)
+     *
+     * @template T
+     */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?DateTimeInterface
     {
         if ($value === null || $value instanceof DateTimeInterface) {

diff --git a/src/Types/DateTimeTzImmutableType.php b/src/Types/DateTimeTzImmutableType.php
@@ -14,6 +14,13 @@
  */
 class DateTimeTzImmutableType extends DateTimeTzType
 {
+    /**
+     * @psalm-param T $value
+     *
+     * @return (T is null ? null : string)
+     *
+     * @template T
+     */
     public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?string
     {
         if ($value === null) {
@@ -31,6 +38,13 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
         );
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : DateTimeImmutable)
+     *
+     * @template T
+     */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?DateTimeImmutable
     {
         if ($value === null || $value instanceof DateTimeImmutable) {

diff --git a/src/Types/DateTimeTzType.php b/src/Types/DateTimeTzType.php
@@ -36,6 +36,13 @@ public function getSQLDeclaration(array $column, AbstractPlatform $platform): st
         return $platform->getDateTimeTzTypeDeclarationSQL($column);
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : string)
+     *
+     * @template T
+     */
     public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?string
     {
         if ($value === null) {
@@ -53,6 +60,13 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
         );
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : DateTimeInterface)
+     *
+     * @template T
+     */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?DateTimeInterface
     {
         if ($value === null || $value instanceof DateTimeInterface) {

diff --git a/src/Types/DateType.php b/src/Types/DateType.php
@@ -23,6 +23,13 @@ public function getSQLDeclaration(array $column, AbstractPlatform $platform): st
         return $platform->getDateTypeDeclarationSQL($column);
     }
 
+    /**
+     * @psalm-param T $value
+     *
+     * @return (T is null ? null : string)
+     *
+     * @template T
+     */
     public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): mixed
     {
         if ($value === null) {
@@ -36,6 +43,13 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
         throw InvalidType::new($value, static::class, ['null', 'DateTime']);
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : DateTimeInterface)
+     *
+     * @template T
+     */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?DateTimeInterface
     {
         if ($value === null || $value instanceof DateTimeInterface) {

diff --git a/src/Types/FloatType.php b/src/Types/FloatType.php
@@ -16,6 +16,13 @@ public function getSQLDeclaration(array $column, AbstractPlatform $platform): st
         return $platform->getFloatDeclarationSQL($column);
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : float)
+     *
+     * @template T
+     */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?float
     {
         return $value === null ? null : (float) $value;

diff --git a/src/Types/IntegerType.php b/src/Types/IntegerType.php
@@ -20,6 +20,13 @@ public function getSQLDeclaration(array $column, AbstractPlatform $platform): st
         return $platform->getIntegerTypeDeclarationSQL($column);
     }
 
+    /**
+     * @param T $value
+     *
+     * @return (T is null ? null : int)
+     *
+     * @template T
+     */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?int
     {
         return $value === null ? null : (int) $value;