Merge branch '4.x' into 4.next

ADmad · ADmad · commit 4c87a4a3f2c2 · 2022-09-04T09:44:25.000+05:30
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -220,16 +220,6 @@ parameters:
 			count: 2
 			path: src/Datasource/ConnectionManager.php
 
-		-
-			message: "#^Cannot unset offset 'args' on array\\{path\\: string, reference\\: mixed\\}\\.$#"
-			count: 1
-			path: src/Error/Debugger.php
-
-		-
-			message: "#^Cannot unset offset 'object' on array\\{path\\: string, reference\\: mixed\\}\\.$#"
-			count: 1
-			path: src/Error/Debugger.php
-
 		-
 			message: "#^Constructor of class Cake\\\\Error\\\\Renderer\\\\ConsoleExceptionRenderer has an unused parameter \\$request\\.$#"
 			count: 1
diff --git a/src/Database/Connection.php b/src/Database/Connection.php
@@ -428,7 +428,7 @@ public function getSchemaCollection(): SchemaCollectionInterface
      *
      * @param string $table the table to insert values in
      * @param array $values values to be inserted
-     * @param array<string, string> $types list of associative array containing the types to be used for casting
+     * @param array<int|string, string> $types Array containing the types to be used for casting
      * @return \Cake\Database\StatementInterface
      */
     public function insert(string $table, array $values, array $types = []): StatementInterface
@@ -449,7 +449,7 @@ public function insert(string $table, array $values, array $types = []): Stateme
      * @param string $table the table to update rows from
      * @param array $values values to be updated
      * @param array $conditions conditions to be set for update statement
-     * @param array $types list of associative array containing the types to be used for casting
+     * @param array<string> $types list of associative array containing the types to be used for casting
      * @return \Cake\Database\StatementInterface
      */
     public function update(string $table, array $values, array $conditions = [], array $types = []): StatementInterface
@@ -467,7 +467,7 @@ public function update(string $table, array $values, array $conditions = [], arr
      *
      * @param string $table the table to delete rows from
      * @param array $conditions conditions to be set for delete statement
-     * @param array $types list of associative array containing the types to be used for casting
+     * @param array<string> $types list of associative array containing the types to be used for casting
      * @return \Cake\Database\StatementInterface
      */
     public function delete(string $table, array $conditions = [], array $types = []): StatementInterface
diff --git a/src/Database/Expression/QueryExpression.php b/src/Database/Expression/QueryExpression.php
@@ -111,7 +111,7 @@ public function getConjunction(): string
      * be added. When using an array and the key is 'OR' or 'AND' a new expression
      * object will be created with that conjunction and internal array value passed
      * as conditions.
-     * @param array<string, string> $types Associative array of fields pointing to the type of the
+     * @param array<int|string, string> $types Associative array of fields pointing to the type of the
      * values that are being passed. Used for correctly binding values to statements.
      * @see \Cake\Database\Query::where() for examples on conditions
      * @return $this
@@ -702,7 +702,7 @@ public function hasNestedExpression(): bool
      * representation is wrapped around an adequate instance or of this class.
      *
      * @param array $conditions list of conditions to be stored in this object
-     * @param array<string, string> $types list of types associated on fields referenced in $conditions
+     * @param array<int|string, string> $types list of types associated on fields referenced in $conditions
      * @return void
      */
     protected function _addConditions(array $conditions, array $types): void
diff --git a/src/Database/Query.php b/src/Database/Query.php
@@ -1646,7 +1646,7 @@ public function unionAll($query, $overwrite = false)
      * with Query::values().
      *
      * @param array $columns The columns to insert into.
-     * @param array<string, string> $types A map between columns & their datatypes.
+     * @param array<int|string, string> $types A map between columns & their datatypes.
      * @return $this
      * @throws \RuntimeException When there are 0 columns.
      */
diff --git a/src/Database/TypeMap.php b/src/Database/TypeMap.php
@@ -22,29 +22,29 @@
 class TypeMap
 {
     /**
-     * Associative array with the default fields and the related types this query might contain.
+     * Array with the default fields and the related types this query might contain.
      *
      * Used to avoid repetition when calling multiple functions inside this class that
      * may require a custom type for a specific field.
      *
-     * @var array<string, string>
+     * @var array<int|string, string>
      */
     protected $_defaults = [];
 
     /**
-     * Associative array with the fields and the related types that override defaults this query might contain
+     * Array with the fields and the related types that override defaults this query might contain
      *
      * Used to avoid repetition when calling multiple functions inside this class that
      * may require a custom type for a specific field.
      *
-     * @var array<string, string>
+     * @var array<int|string, string>
      */
     protected $_types = [];
 
     /**
      * Creates an instance with the given defaults
      *
-     * @param array<string, string> $defaults The defaults to use.
+     * @param array<int|string, string> $defaults The defaults to use.
      */
     public function __construct(array $defaults = [])
     {
@@ -69,7 +69,7 @@ public function __construct(array $defaults = [])
      * This method will replace all the existing default mappings with the ones provided.
      * To add into the mappings use `addDefaults()`.
      *
-     * @param array<string, string> $defaults Associative array where keys are field names and values
+     * @param array<int|string, string> $defaults Array where keys are field names / positions and values
      * are the correspondent type.
      * @return $this
      */
@@ -83,7 +83,7 @@ public function setDefaults(array $defaults)
     /**
      * Returns the currently configured types.
      *
-     * @return array<string, string>
+     * @return array<int|string, string>
      */
     public function getDefaults(): array
     {
@@ -95,7 +95,7 @@ public function getDefaults(): array
      *
      * If a key already exists it will not be overwritten.
      *
-     * @param array<string, string> $types The additional types to add.
+     * @param array<int|string, string> $types The additional types to add.
      * @return void
      */
     public function addDefaults(array $types): void
@@ -114,7 +114,7 @@ public function addDefaults(array $types): void
      *
      * This method will replace all the existing type maps with the ones provided.
      *
-     * @param array<string, string> $types Associative array where keys are field names and values
+     * @param array<int|string, string> $types Array where keys are field names / positions and values
      * are the correspondent type.
      * @return $this
      */
@@ -128,7 +128,7 @@ public function setTypes(array $types)
     /**
      * Gets a map of fields and their associated types for single-use.
      *
-     * @return array<string, string>
+     * @return array<int|string, string>
      */
     public function getTypes(): array
     {
@@ -151,7 +151,7 @@ public function type($column): ?string
     /**
      * Returns an array of all types mapped types
      *
-     * @return array<string, string>
+     * @return array<int|string, string>
      */
     public function toArray(): array
     {
diff --git a/src/Database/TypeMapTrait.php b/src/Database/TypeMapTrait.php
@@ -66,7 +66,7 @@ public function getTypeMap(): TypeMap
      * To add a default without overwriting existing ones
      * use `getTypeMap()->addDefaults()`
      *
-     * @param array<string, string> $types The array of types to set.
+     * @param array<int|string, string> $types The array of types to set.
      * @return $this
      * @see \Cake\Database\TypeMap::setDefaults()
      */
@@ -80,7 +80,7 @@ public function setDefaultTypes(array $types)
     /**
      * Gets default types of current type map.
      *
-     * @return array<string, string>
+     * @return array<int|string, string>
      */
     public function getDefaultTypes(): array
     {
diff --git a/src/Error/Debugger.php b/src/Error/Debugger.php
@@ -484,7 +484,10 @@ public static function formatTrace($backtrace, array $options = [])
             return $back;
         }
 
-        /** @psalm-suppress InvalidArgument */
+        /**
+         * @psalm-suppress InvalidArgument
+         * @phpstan-ignore-next-line
+         */
         return implode("\n", $back);
     }
 
diff --git a/src/ORM/Query.php b/src/ORM/Query.php
@@ -1306,7 +1306,7 @@ public function delete(?string $table = null)
      * Can be combined with the where() method to create delete queries.
      *
      * @param array $columns The columns to insert into.
-     * @param array<string, string> $types A map between columns & their datatypes.
+     * @param array<string> $types A map between columns & their datatypes.
      * @return $this
      */
     public function insert(array $columns, array $types = [])
diff --git a/src/TestSuite/IntegrationTestTrait.php b/src/TestSuite/IntegrationTestTrait.php
@@ -1357,10 +1357,26 @@ protected function extractVerboseMessage(string $message): string
      */
     protected function extractExceptionMessage(Exception $exception): string
     {
-        return PHP_EOL .
-            sprintf('Possibly related to %s: "%s" ', get_class($exception), $exception->getMessage()) .
-            PHP_EOL .
-            $exception->getTraceAsString();
+        $exceptions = [$exception];
+        $previous = $exception->getPrevious();
+        while ($previous != null) {
+            $exceptions[] = $previous;
+            $previous = $previous->getPrevious();
+        }
+        $message = PHP_EOL;
+        foreach ($exceptions as $i => $error) {
+            if ($i == 0) {
+                $message .= sprintf('Possibly related to %s: "%s"', get_class($error), $error->getMessage());
+                $message .= PHP_EOL;
+            } else {
+                $message .= sprintf('Caused by %s: "%s"', get_class($error), $error->getMessage());
+                $message .= PHP_EOL;
+            }
+            $message .= $error->getTraceAsString();
+            $message .= PHP_EOL;
+        }
+
+        return $message;
     }
 
     /**
diff --git a/tests/TestCase/Database/ConnectionTest.php b/tests/TestCase/Database/ConnectionTest.php
@@ -643,7 +643,8 @@ public function testVirtualNestedTransaction3(): void
      */
     public function testSavePoints(): void
     {
-        $this->skipIf(!$this->connection->enableSavePoints(true));
+        $this->connection->enableSavePoints(true);
+        $this->skipIf(!$this->connection->isSavePointsEnabled(), 'Database driver doesn\'t support save points');
 
         $this->connection->begin();
         $this->connection->delete('things', ['id' => 1]);
@@ -671,7 +672,9 @@ public function testSavePoints(): void
 
     public function testSavePoints2(): void
     {
-        $this->skipIf(!$this->connection->enableSavePoints(true));
+        $this->connection->enableSavePoints(true);
+        $this->skipIf(!$this->connection->isSavePointsEnabled(), 'Database driver doesn\'t support save points');
+
         $this->connection->begin();
         $this->connection->delete('things', ['id' => 1]);
 
@@ -726,7 +729,10 @@ public function testInTransactionWithSavePoints(): void
             $this->connection->getDriver() instanceof Sqlserver,
             'SQLServer fails when this test is included.'
         );
-        $this->skipIf(!$this->connection->enableSavePoints(true));
+
+        $this->connection->enableSavePoints(true);
+        $this->skipIf(!$this->connection->isSavePointsEnabled(), 'Database driver doesn\'t support save points');
+
         $this->connection->begin();
         $this->assertTrue($this->connection->inTransaction());
 
diff --git a/tests/TestCase/TestSuite/IntegrationTestTraitTest.php b/tests/TestCase/TestSuite/IntegrationTestTraitTest.php
@@ -1491,6 +1491,20 @@ public function testAssertionFailureMessages($assertion, $message, $url, ...$res
         call_user_func_array([$this, $assertion], $rest);
     }
 
+    /**
+     * Test for assertion message generation for previous.
+     *
+     * @return void
+     */
+    public function testAssertMessagePrevious()
+    {
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('Caused by RuntimeException');
+
+        $this->get('/posts/throw_chained');
+        $this->assertContentType('test');
+    }
+
     /**
      * data provider for assertion failure messages
      *
diff --git a/tests/test_app/TestApp/Controller/PostsController.php b/tests/test_app/TestApp/Controller/PostsController.php
@@ -19,6 +19,7 @@
 use Cake\Event\EventInterface;
 use Cake\Http\Cookie\Cookie;
 use OutOfBoundsException;
+use RuntimeException;
 
 /**
  * PostsController class
@@ -209,4 +210,13 @@ public function throw_exception()
         $this->Flash->error('Error 1');
         throw new OutOfBoundsException('oh no!');
     }
+
+    /**
+     * @return \Cake\Http\Response
+     */
+    public function throw_chained()
+    {
+        $inner = new RuntimeException('inner badness');
+        throw new OutOfBoundsException('oh no!', 1, $inner);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1646,7 +1646,7 @@ public function unionAll($query, $overwrite = false)`
`1646`	`1646`	`* with Query::values().`
`1647`	`1647`	`*`
`1648`	`1648`	`* @param array $columns The columns to insert into.`
`1649`		`- * @param array<string, string> $types A map between columns & their datatypes.`
	`1649`	`+ * @param array<int\|string, string> $types A map between columns & their datatypes.`
`1650`	`1650`	`* @return $this`
`1651`	`1651`	`* @throws \RuntimeException When there are 0 columns.`
`1652`	`1652`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -22,29 +22,29 @@`
`22`	`22`	`class TypeMap`
`23`	`23`	`{`
`24`	`24`	`/**`
`25`		`- * Associative array with the default fields and the related types this query might contain.`
	`25`	`+ * Array with the default fields and the related types this query might contain.`
`26`	`26`	`*`
`27`	`27`	`* Used to avoid repetition when calling multiple functions inside this class that`
`28`	`28`	`* may require a custom type for a specific field.`
`29`	`29`	`*`
`30`		`- * @var array<string, string>`
	`30`	`+ * @var array<int\|string, string>`
`31`	`31`	`*/`
`32`	`32`	`protected $_defaults = [];`
`33`	`33`
`34`	`34`	`/**`
`35`		`- * Associative array with the fields and the related types that override defaults this query might contain`
	`35`	`+ * Array with the fields and the related types that override defaults this query might contain`
`36`	`36`	`*`
`37`	`37`	`* Used to avoid repetition when calling multiple functions inside this class that`
`38`	`38`	`* may require a custom type for a specific field.`
`39`	`39`	`*`
`40`		`- * @var array<string, string>`
	`40`	`+ * @var array<int\|string, string>`
`41`	`41`	`*/`
`42`	`42`	`protected $_types = [];`
`43`	`43`
`44`	`44`	`/**`
`45`	`45`	`* Creates an instance with the given defaults`
`46`	`46`	`*`
`47`		`- * @param array<string, string> $defaults The defaults to use.`
	`47`	`+ * @param array<int\|string, string> $defaults The defaults to use.`
`48`	`48`	`*/`
`49`	`49`	`public function __construct(array $defaults = [])`
`50`	`50`	`{`
`@@ -69,7 +69,7 @@ public function __construct(array $defaults = [])`
`69`	`69`	`* This method will replace all the existing default mappings with the ones provided.`
`70`	`70`	* To add into the mappings use `addDefaults()`.
`71`	`71`	`*`
`72`		`- * @param array<string, string> $defaults Associative array where keys are field names and values`
	`72`	`+ * @param array<int\|string, string> $defaults Array where keys are field names / positions and values`
`73`	`73`	`* are the correspondent type.`
`74`	`74`	`* @return $this`
`75`	`75`	`*/`
`@@ -83,7 +83,7 @@ public function setDefaults(array $defaults)`
`83`	`83`	`/**`
`84`	`84`	`* Returns the currently configured types.`
`85`	`85`	`*`
`86`		`- * @return array<string, string>`
	`86`	`+ * @return array<int\|string, string>`
`87`	`87`	`*/`
`88`	`88`	`public function getDefaults(): array`
`89`	`89`	`{`
`@@ -95,7 +95,7 @@ public function getDefaults(): array`
`95`	`95`	`*`
`96`	`96`	`* If a key already exists it will not be overwritten.`
`97`	`97`	`*`
`98`		`- * @param array<string, string> $types The additional types to add.`
	`98`	`+ * @param array<int\|string, string> $types The additional types to add.`
`99`	`99`	`* @return void`
`100`	`100`	`*/`
`101`	`101`	`public function addDefaults(array $types): void`
`@@ -114,7 +114,7 @@ public function addDefaults(array $types): void`
`114`	`114`	`*`
`115`	`115`	`* This method will replace all the existing type maps with the ones provided.`
`116`	`116`	`*`
`117`		`- * @param array<string, string> $types Associative array where keys are field names and values`
	`117`	`+ * @param array<int\|string, string> $types Array where keys are field names / positions and values`
`118`	`118`	`* are the correspondent type.`
`119`	`119`	`* @return $this`
`120`	`120`	`*/`
`@@ -128,7 +128,7 @@ public function setTypes(array $types)`
`128`	`128`	`/**`
`129`	`129`	`* Gets a map of fields and their associated types for single-use.`
`130`	`130`	`*`
`131`		`- * @return array<string, string>`
	`131`	`+ * @return array<int\|string, string>`
`132`	`132`	`*/`
`133`	`133`	`public function getTypes(): array`
`134`	`134`	`{`
`@@ -151,7 +151,7 @@ public function type($column): ?string`
`151`	`151`	`/**`
`152`	`152`	`* Returns an array of all types mapped types`
`153`	`153`	`*`
`154`		`- * @return array<string, string>`
	`154`	`+ * @return array<int\|string, string>`
`155`	`155`	`*/`
`156`	`156`	`public function toArray(): array`
`157`	`157`	`{`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public function getTypeMap(): TypeMap`
`66`	`66`	`* To add a default without overwriting existing ones`
`67`	`67`	* use `getTypeMap()->addDefaults()`
`68`	`68`	`*`
`69`		`- * @param array<string, string> $types The array of types to set.`
	`69`	`+ * @param array<int\|string, string> $types The array of types to set.`
`70`	`70`	`* @return $this`
`71`	`71`	`* @see \Cake\Database\TypeMap::setDefaults()`
`72`	`72`	`*/`
`@@ -80,7 +80,7 @@ public function setDefaultTypes(array $types)`
`80`	`80`	`/**`
`81`	`81`	`* Gets default types of current type map.`
`82`	`82`	`*`
`83`		`- * @return array<string, string>`
	`83`	`+ * @return array<int\|string, string>`
`84`	`84`	`*/`
`85`	`85`	`public function getDefaultTypes(): array`
`86`	`86`	`{`
Original file line number	Diff line number	Diff line change
`@@ -484,7 +484,10 @@ public static function formatTrace($backtrace, array $options = [])`
`484`	`484`	`return $back;`
`485`	`485`	`}`
`486`	`486`
`487`		`- /** @psalm-suppress InvalidArgument */`
	`487`	`+ /**`
	`488`	`+ * @psalm-suppress InvalidArgument`
	`489`	`+ * @phpstan-ignore-next-line`
	`490`	`+ */`
`488`	`491`	`return implode("\n", $back);`
`489`	`492`	`}`
`490`	`493`
Original file line number	Diff line number	Diff line change
`@@ -1306,7 +1306,7 @@ public function delete(?string $table = null)`
`1306`	`1306`	`* Can be combined with the where() method to create delete queries.`
`1307`	`1307`	`*`
`1308`	`1308`	`* @param array $columns The columns to insert into.`
`1309`		`- * @param array<string, string> $types A map between columns & their datatypes.`
	`1309`	`+ * @param array<string> $types A map between columns & their datatypes.`
`1310`	`1310`	`* @return $this`
`1311`	`1311`	`*/`
`1312`	`1312`	`public function insert(array $columns, array $types = [])`