fix: property type for uuid and ulid primary keys

Co-authored-by: Alex Wulf <alex.f.wulf@gmail.com>

Author: calebdw

extension.neon

@@ -271,8 +271,8 @@ services:
         class: Larastan\Larastan\ReturnTypes\Helpers\ValidatorExtension
         tags:
             - phpstan.broker.dynamicFunctionReturnTypeExtension
-    
-    -        
+
+    -
         class: Larastan\Larastan\ReturnTypes\Helpers\LiteralExtension
         tags:
             - phpstan.broker.dynamicFunctionReturnTypeExtension
@@ -408,13 +408,15 @@ services:
         arguments:
             active: %checkModelProperties%
 
+    -
+        class: Larastan\Larastan\Support\ModelHelper
+
     -
         class: Larastan\Larastan\Properties\MigrationHelper
         arguments:
             databaseMigrationPath: %databaseMigrationsPath%
             disableMigrationScan: %disableMigrationScan%
             parser: @currentPhpVersionSimpleDirectParser
-            reflectionProvider: @reflectionProvider
 
     -
         class: Larastan\Larastan\Properties\SquashedMigrationHelper

src/Properties/MigrationHelper.php

@@ -4,10 +4,10 @@
 
 namespace Larastan\Larastan\Properties;
 
+use Larastan\Larastan\Support\ModelHelper;
 use PHPStan\File\FileHelper;
 use PHPStan\Parser\Parser;
 use PHPStan\Parser\ParserErrorsException;
-use PHPStan\Reflection\ReflectionProvider;
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
 use RegexIterator;
@@ -27,7 +27,7 @@ public function __construct(
         private array $databaseMigrationPath,
         private FileHelper $fileHelper,
         private bool $disableMigrationScan,
-        private ReflectionProvider $reflectionProvider,
+        private ModelHelper $modelHelper,
     ) {
     }
 
@@ -46,7 +46,7 @@ public function initializeTables(array $tables = []): array
             $this->databaseMigrationPath = [database_path('migrations')];
         }
 
-        $schemaAggregator = new SchemaAggregator($this->reflectionProvider, $tables);
+        $schemaAggregator = new SchemaAggregator($this->modelHelper, $tables);
         $filesArray       = $this->getMigrationFiles();
 
         if (empty($filesArray)) {

src/Properties/ModelCastHelper.php

@@ -15,12 +15,12 @@
 use Illuminate\Database\Eloquent\Casts\AsEncryptedArrayObject;
 use Illuminate\Database\Eloquent\Casts\AsEncryptedCollection;
 use Illuminate\Database\Eloquent\Casts\AsStringable;
-use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Carbon as IlluminateCarbon;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Date;
 use Illuminate\Support\Stringable as IlluminateStringable;
+use Larastan\Larastan\Support\ModelHelper;
 use PHPStan\Analyser\OutOfClassScope;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\MissingMethodFromReflectionException;
@@ -40,7 +40,6 @@
 use PHPStan\Type\StringType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
-use ReflectionException;
 use stdClass;
 use Stringable;
 
@@ -59,6 +58,7 @@ class ModelCastHelper
 
     public function __construct(
         protected ReflectionProvider $reflectionProvider,
+        protected ModelHelper $modelHelper,
     ) {
     }
 
@@ -237,14 +237,8 @@ public function getCastForProperty(ClassReflection $modelClassReflection, string
      */
     private function getModelCasts(ClassReflection $modelClassReflection): array
     {
-        try {
-            /** @var Model $modelInstance */
-            $modelInstance = $modelClassReflection->getNativeReflection()->newInstanceWithoutConstructor();
-        } catch (ReflectionException) {
-            throw new ShouldNotHappenException();
-        }
-
-        $modelCasts = $modelInstance->getCasts();
+        $modelInstance = $this->modelHelper->getModelInstance($modelClassReflection);
+        $modelCasts    = $modelInstance->getCasts();
 
         $castsMethodReturnType = $modelClassReflection->getMethod(
             'casts',

src/Properties/ModelPropertyHelper.php

@@ -8,16 +8,15 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Str;
 use Larastan\Larastan\Reflection\ReflectionHelper;
+use Larastan\Larastan\Support\ModelHelper;
 use PHPStan\PhpDoc\TypeStringResolver;
 use PHPStan\Reflection\ClassReflection;
-use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\Constant\ConstantStringType;
 use PHPStan\Type\Generic\GenericObjectType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\StringType;
 use PHPStan\Type\TypeCombinator;
-use ReflectionException;
 
 use function array_key_exists;
 use function array_map;
@@ -36,6 +35,7 @@ public function __construct(
         private MigrationHelper $migrationHelper,
         private SquashedMigrationHelper $squashedMigrationHelper,
         private ModelCastHelper $modelCastHelper,
+        private ModelHelper $modelHelper,
     ) {
     }
 
@@ -68,12 +68,7 @@ public function hasDatabaseProperty(ClassReflection|string $classReflectionOrTab
             return false;
         }
 
-        try {
-            /** @var Model $modelInstance */
-            $modelInstance = $classReflectionOrTable->getNativeReflection()->newInstanceWithoutConstructor();
-        } catch (ReflectionException) {
-            return false;
-        }
+        $modelInstance = $this->modelHelper->getModelInstance($classReflectionOrTable);
 
         if ($propertyName === $modelInstance->getKeyName()) {
             return true;
@@ -90,12 +85,7 @@ public function hasDatabaseProperty(ClassReflection|string $classReflectionOrTab
 
     public function getDatabaseProperty(ClassReflection $classReflection, string $propertyName): ModelProperty
     {
-        try {
-            /** @var Model $modelInstance */
-            $modelInstance = $classReflection->getNativeReflection()->newInstanceWithoutConstructor();
-        } catch (ReflectionException) {
-            throw new ShouldNotHappenException();
-        }
+        $modelInstance = $this->modelHelper->getModelInstance($classReflection);
 
         $tableName = $modelInstance->getTable();
 

src/Properties/SchemaAggregator.php

@@ -7,16 +7,17 @@
 use Exception;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Str;
+use Larastan\Larastan\Support\ModelHelper;
 use PhpParser;
 use PhpParser\NodeFinder;
-use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Type\ObjectType;
-use ReflectionException;
 
 use function array_key_exists;
 use function array_merge;
+use function assert;
 use function class_basename;
 use function count;
+use function is_a;
 use function is_string;
 use function property_exists;
 use function strtolower;
@@ -25,7 +26,7 @@
 final class SchemaAggregator
 {
     /** @param array<string, SchemaTable> $tables */
-    public function __construct(private ReflectionProvider $reflectionProvider, public array $tables = [])
+    public function __construct(private ModelHelper $modelHelper, public array $tables = [])
     {
     }
 
@@ -128,7 +129,8 @@ private function alterTable(PhpParser\Node\Expr\StaticCall|PhpParser\Node\Expr\M
             ! isset($call->args[1])
             || ! $call->getArgs()[1]->value instanceof PhpParser\Node\Expr\Closure
             || count($call->getArgs()[1]->value->params) < 1
-            || ($call->getArgs()[1]->value->params[0]->type instanceof PhpParser\Node\Name
+            || (
+                $call->getArgs()[1]->value->params[0]->type instanceof PhpParser\Node\Name
                 && ! (new ObjectType('Illuminate\Database\Schema\Blueprint'))->isSuperTypeOf(new ObjectType($call->getArgs()[1]->value->params[0]->type->toCodeString()))->yes()
             )
         ) {
@@ -213,6 +215,8 @@ private function processColumnUpdates(string $tableName, string $argName, array
                     continue;
                 }
 
+                assert(is_a($modelClass, Model::class, true));
+
                 $columnName = Str::snake(class_basename($modelClass)) . '_id';
                 if ($secondArg instanceof PhpParser\Node\Scalar\String_) {
                     $columnName = $secondArg->value;
@@ -381,17 +385,11 @@ private function renameTable(string $oldTableName, string $newTableName): void
         $this->tables[$newTableName] = $table;
     }
 
+    /** @param class-string<Model> $modelClass */
     private function getModelReferenceType(string $modelClass): string|null
     {
-        $classReflection = $this->reflectionProvider->getClass($modelClass);
-        try {
-            /** @var Model $modelInstance */
-            $modelInstance = $classReflection->getNativeReflection()->newInstanceWithoutConstructor();
-        } catch (ReflectionException) {
-            return null;
-        }
-
-        $tableName = $modelInstance->getTable();
+        $modelInstance = $this->modelHelper->getModelInstance($modelClass);
+        $tableName     = $modelInstance->getTable();
 
         if (! array_key_exists($tableName, $this->tables)) {
             return null;

src/Support/ModelHelper.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Larastan\Larastan\Support;
+
+use Illuminate\Database\Eloquent\Model;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\ReflectionProvider;
+use Throwable;
+
+use function is_string;
+
+/** @internal */
+final class ModelHelper
+{
+    public function __construct(private ReflectionProvider $reflectionProvider)
+    {
+    }
+
+    /** @param ClassReflection|class-string<Model> $model */
+    public function getModelInstance(ClassReflection|string $model): Model
+    {
+        if (is_string($model)) {
+            $model = $this->reflectionProvider->getClass($model);
+        }
+
+        try {
+            /** @var Model $modelInstance */
+            $modelInstance = $model->getNativeReflection()->newInstance();
+        } catch (Throwable) {
+            /** @var Model $modelInstance */
+            $modelInstance = $model->getNativeReflection()->newInstanceWithoutConstructor();
+        }
+
+        return $modelInstance;
+    }
+}

tests/Type/GeneralTypeTest.php

@@ -27,6 +27,7 @@ public static function dataFileAsserts(): iterable
         yield from self::gatherAssertTypes(__DIR__ . '/data/bug-1985.php');
         yield from self::gatherAssertTypes(__DIR__ . '/data/bug-2073.php');
         yield from self::gatherAssertTypes(__DIR__ . '/data/bug-2111.php');
+        yield from self::gatherAssertTypes(__DIR__ . '/data/bug-2188.php');
         yield from self::gatherAssertTypes(__DIR__ . '/data/conditionable.php');
         yield from self::gatherAssertTypes(__DIR__ . '/data/container-array-access.php');
         yield from self::gatherAssertTypes(__DIR__ . '/data/container-make.php');

tests/Type/data/bug-2188.php

@@ -0,0 +1,12 @@
+<?php
+
+use App\UlidModel;
+use App\UuidModel;
+
+use function PHPStan\Testing\assertType;
+
+function test(UlidModel $ulid, UuidModel $uuid): void
+{
+    assertType('string', $ulid->id);
+    assertType('string', $uuid->id);
+}