Merge pull request #51445 from nextcloud/backport/51442/stable31

[stable31] fix(RichObjectStrings): Make exception messages for invalid parameters more useful for debugging

Author: sorbaugh

lib/private/Activity/Event.php

@@ -34,7 +34,7 @@ class Event implements IEvent {
 	protected $subjectParsed = '';
 	/** @var string */
 	protected $subjectRich = '';
-	/** @var array */
+	/** @var array<string, array<string, string>> */
 	protected $subjectRichParameters = [];
 	/** @var string */
 	protected $message = '';
@@ -44,7 +44,7 @@ class Event implements IEvent {
 	protected $messageParsed = '';
 	/** @var string */
 	protected $messageRich = '';
-	/** @var array */
+	/** @var array<string, array<string, string>> */
 	protected $messageRichParameters = [];
 	/** @var string */
 	protected $objectType = '';

lib/private/RichObjectStrings/Validator.php

@@ -56,15 +56,15 @@ public function validate(string $subject, array $parameters): void {
 				throw new InvalidObjectExeption('Parameter is malformed');
 			}
 
-			$this->validateParameter($parameter);
+			$this->validateParameter($placeholder, $parameter);
 		}
 	}
 
 	/**
 	 * @param array $parameter
 	 * @throws InvalidObjectExeption
 	 */
-	protected function validateParameter(array $parameter): void {
+	protected function validateParameter(string $placeholder, array $parameter): void {
 		if (!isset($parameter['type'])) {
 			throw new InvalidObjectExeption('Object type is undefined');
 		}
@@ -74,15 +74,15 @@ protected function validateParameter(array $parameter): void {
 
 		$missingKeys = array_diff($requiredParameters, array_keys($parameter));
 		if (!empty($missingKeys)) {
-			throw new InvalidObjectExeption('Object is invalid, missing keys:' . json_encode($missingKeys));
+			throw new InvalidObjectExeption('Object for placeholder ' . $placeholder . ' is invalid, missing keys:' . json_encode($missingKeys));
 		}
 
 		foreach ($parameter as $key => $value) {
 			if (!is_string($key)) {
-				throw new InvalidObjectExeption('Object is invalid, key ' . $key . ' is not a string');
+				throw new InvalidObjectExeption('Object for placeholder ' . $placeholder . ' is invalid, key ' . $key . ' is not a string');
 			}
 			if (!is_string($value)) {
-				throw new InvalidObjectExeption('Object is invalid, value ' . $value . ' is not a string');
+				throw new InvalidObjectExeption('Object for placeholder ' . $placeholder . ' is invalid, value ' . $value . ' for key ' . $key . ' is not a string');
 			}
 		}
 	}

tests/lib/RichObjectStrings/ValidatorTest.php

@@ -39,7 +39,7 @@ public function testValidate(): void {
 
 		$this->expectException(InvalidObjectExeption::class);
 
-		$this->expectExceptionMessage('Object is invalid, value 123 is not a string');
+		$this->expectExceptionMessage('Object for placeholder string1 is invalid, value 123 for key key is not a string');
 		$v->validate('test {string1} test.', [
 			'string1' => [
 				'type' => 'user',
@@ -49,7 +49,7 @@ public function testValidate(): void {
 			],
 		]);
 
-		$this->expectExceptionMessage('Object is invalid, key 456 is not a string');
+		$this->expectExceptionMessage('Object for placeholder string1 is invalid, key 456 is not a string');
 		$v->validate('test {string1} test.', [
 			'string1' => [
 				'type' => 'user',