Merge pull request #525 from kamil-tekiela/types-in-exceptions

Add native property types in Exceptions
phpmyadmin · Jan 16, 2024 · a79095e · a79095e
2 parents 72699fb + bdf7b67
commit a79095e
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 25 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -370,11 +370,6 @@ parameters:
 			count: 1
 			path: src/Context.php
 
-		-
-			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Exceptions\\\\ParserException\\:\\:\\$token \\(PhpMyAdmin\\\\SqlParser\\\\Token\\) does not accept PhpMyAdmin\\\\SqlParser\\\\Token\\|null\\.$#"
-			count: 1
-			path: src/Exceptions/ParserException.php
-
 		-
 			message: "#^Cannot access property \\$type on PhpMyAdmin\\\\SqlParser\\\\Token\\|null\\.$#"
 			count: 2
@@ -700,6 +695,16 @@ parameters:
 			count: 2
 			path: src/Utils/CLI.php
 
+		-
+			message: "#^Cannot access property \\$position on PhpMyAdmin\\\\SqlParser\\\\Token\\|null\\.$#"
+			count: 1
+			path: src/Utils/Error.php
+
+		-
+			message: "#^Cannot access property \\$token on PhpMyAdmin\\\\SqlParser\\\\Token\\|null\\.$#"
+			count: 1
+			path: src/Utils/Error.php
+
 		-
 			message: "#^Argument of an invalid type array\\<int, array\\<string, int\\|string\\>\\>\\|bool\\|string supplied for foreach, only iterables are supported\\.$#"
 			count: 1

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -556,11 +556,6 @@
       <code>ContextMySql80100</code>
     </UnusedClass>
   </file>
-  <file src="src/Exceptions/ParserException.php">
-    <PossiblyNullPropertyAssignmentValue>
-      <code>$token</code>
-    </PossiblyNullPropertyAssignmentValue>
-  </file>
   <file src="src/Lexer.php">
     <LoopInvalidation>
       <code><![CDATA[$this->last]]></code>
@@ -1029,6 +1024,10 @@
       <code>$err[1]</code>
       <code>$err[3]</code>
     </PossiblyNullArgument>
+    <PossiblyNullPropertyFetch>
+      <code><![CDATA[$err->token->position]]></code>
+      <code><![CDATA[$err->token->token]]></code>
+    </PossiblyNullPropertyFetch>
     <RedundantConditionGivenDocblockType>
       <code>$obj instanceof Parser</code>
     </RedundantConditionGivenDocblockType>

diff --git a/src/Exceptions/LexerException.php b/src/Exceptions/LexerException.php
@@ -13,17 +13,13 @@ class LexerException extends Exception
 {
     /**
      * The character that produced this error.
-     *
-     * @var string
      */
-    public $ch;
+    public string $ch;
 
     /**
      * The index of the character that produced this error.
-     *
-     * @var int
      */
-    public $pos;
+    public int $pos;
 
     /**
      * @param string $msg  the message of this exception

diff --git a/src/Exceptions/ParserException.php b/src/Exceptions/ParserException.php
@@ -14,17 +14,15 @@ class ParserException extends Exception
 {
     /**
      * The token that produced this error.
-     *
-     * @var Token
      */
-    public $token;
+    public Token|null $token;
 
     /**
-     * @param string $msg   the message of this exception
-     * @param Token  $token the token that produced this exception
-     * @param int    $code  the code of this error
+     * @param string     $msg   the message of this exception
+     * @param Token|null $token the token that produced this exception
+     * @param int        $code  the code of this error
      */
-    public function __construct(string $msg = '', Token|null $token = null, int $code = 0)
+    public function __construct(string $msg, Token|null $token, int $code = 0)
     {
         parent::__construct($msg, $code);
 

diff --git a/src/Tools/TestGenerator.php b/src/Tools/TestGenerator.php
@@ -46,7 +46,7 @@ class TestGenerator
      * @param string $query the query to be analyzed
      * @param string $type  test's type (may be `lexer` or `parser`)
      *
-     * @return array<string, string|Lexer|Parser|array<string, array<int, array<int, int|string|Token>>>|null>
+     * @return array<string, string|Lexer|Parser|array<string, array<int, array<int, int|string|Token|null>>>|null>
      */
     public static function generate(string $query, string $type = 'parser'): array
     {

diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -56,7 +56,7 @@ public function getTokensList(string $query): TokensList
      * @psalm-return (
      *     $obj is Lexer
      *     ? list<array{string, string, int, int}>
-     *     : list<array{string, Token, int}>
+     *     : list<array{string, Token|null, int}>
      * )
      */
     public function getErrorsAsArray($obj): array