From 3322ffb3f0fb3e4bc314573c680f6199fb0a7cb6 Mon Sep 17 00:00:00 2001
From: Matthew Brown <github@muglug.com>
Date: Tue, 29 Dec 2020 16:36:54 +0000
Subject: [PATCH] Fix #4912 - detect mismatching property type

---
 config.xsd                                    |  1 +
 .../issues/MismatchingDocblockPropertyType.md | 11 ++++++++
 src/Psalm/Internal/Analyzer/ClassAnalyzer.php | 27 +++++++++++++++++++
 .../Issue/MismatchingDocblockPropertyType.php |  8 ++++++
 tests/PropertyTypeTest.php                    |  8 ++++++
 5 files changed, 55 insertions(+)
 create mode 100644 docs/running_psalm/issues/MismatchingDocblockPropertyType.md
 create mode 100644 src/Psalm/Issue/MismatchingDocblockPropertyType.php

diff --git a/config.xsd b/config.xsd
index 0f21145cc..05e12b323 100644
--- a/config.xsd
+++ b/config.xsd
@@ -275,6 +275,7 @@
             <xs:element name="MethodSignatureMismatch" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="MethodSignatureMustOmitReturnType" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="MismatchingDocblockParamType" type="IssueHandlerType" minOccurs="0" />
+            <xs:element name="MismatchingDocblockPropertyType" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="MismatchingDocblockReturnType" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="MissingClosureParamType" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="MissingClosureReturnType" type="IssueHandlerType" minOccurs="0" />
diff --git a/docs/running_psalm/issues/MismatchingDocblockPropertyType.md b/docs/running_psalm/issues/MismatchingDocblockPropertyType.md
new file mode 100644
index 000000000..b9b82ba79
--- /dev/null
+++ b/docs/running_psalm/issues/MismatchingDocblockPropertyType.md
@@ -0,0 +1,11 @@
+# MismatchingDocblockPropertyType
+
+Emitted when an `@var` entry in a property’s docblock does not match the property's type.
+
+```php
+<?php
+class A {
+    /** @var array */
+    public string $s = [];
+}
+```
diff --git a/src/Psalm/Internal/Analyzer/ClassAnalyzer.php b/src/Psalm/Internal/Analyzer/ClassAnalyzer.php
index 85f196d58..e5ff45c46 100644
--- a/src/Psalm/Internal/Analyzer/ClassAnalyzer.php
+++ b/src/Psalm/Internal/Analyzer/ClassAnalyzer.php
@@ -23,6 +23,7 @@ use Psalm\Issue\InternalClass;
 use Psalm\Issue\InvalidExtendClass;
 use Psalm\Issue\InvalidTemplateParam;
 use Psalm\Issue\MethodSignatureMismatch;
+use Psalm\Issue\MismatchingDocblockPropertyType;
 use Psalm\Issue\MissingConstructor;
 use Psalm\Issue\MissingImmutableAnnotation;
 use Psalm\Issue\MissingPropertyType;
@@ -1137,6 +1138,32 @@ class ClassAnalyzer extends ClassLikeAnalyzer
                     [],
                     false
                 );
+
+                if ($property_storage->signature_type) {
+                    $union_comparison_result = new \Psalm\Internal\Type\Comparator\TypeComparisonResult();
+
+                    if (!UnionTypeComparator::isContainedBy(
+                        $codebase,
+                        $fleshed_out_type,
+                        $property_storage->signature_type,
+                        false,
+                        false,
+                        $union_comparison_result
+                    ) && !$union_comparison_result->type_coerced_from_mixed
+                    ) {
+                        if (IssueBuffer::accepts(
+                            new MismatchingDocblockPropertyType(
+                                'Parameter '
+                                    . $property_class_name . '::$' . $property_name
+                                    . ' has wrong type \'' . $fleshed_out_type .
+                                    '\', should be \'' . $property_storage->signature_type . '\'',
+                                $property_type_location
+                            )
+                        )) {
+                            // do nothing
+                        }
+                    }
+                }
             }
 
             if ($property_storage->is_static) {
diff --git a/src/Psalm/Issue/MismatchingDocblockPropertyType.php b/src/Psalm/Issue/MismatchingDocblockPropertyType.php
new file mode 100644
index 000000000..6955bfd27
--- /dev/null
+++ b/src/Psalm/Issue/MismatchingDocblockPropertyType.php
@@ -0,0 +1,8 @@
+<?php
+namespace Psalm\Issue;
+
+class MismatchingDocblockPropertyType extends CodeIssue
+{
+    public const ERROR_LEVEL = 2;
+    public const SHORTCODE = 264;
+}
diff --git a/tests/PropertyTypeTest.php b/tests/PropertyTypeTest.php
index e45b8da02..cdf5a1369 100644
--- a/tests/PropertyTypeTest.php
+++ b/tests/PropertyTypeTest.php
@@ -3534,6 +3534,14 @@ class PropertyTypeTest extends TestCase
                     echo (new A)->foo;',
                 'error_message' => 'InaccessibleProperty',
             ],
+            'overwritePropertyType' => [
+                '<?php
+                    class A {
+                        /** @var array */
+                        public string $s = [];
+                    }',
+                'error_message' => 'MismatchingDocblockPropertyType',
+            ],
         ];
     }
 }