refactor: validate that variadic functions have only the expected count of arguments (#274)

martin-georgiev · web-flow · commit 019f84d23df6 · 2025-03-13T11:56:34.000Z
diff --git a/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/BaseVariadicFunction.php b/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/BaseVariadicFunction.php
@@ -38,6 +38,8 @@ public function feedParserWithNodes(Parser $parser): void
             }
             $aheadType = $lexer->lookahead->type;
         }
+
+        $this->validateArguments($this->nodes);
     }
 
     public function getSql(SqlWalker $sqlWalker): string
@@ -49,4 +51,11 @@ public function getSql(SqlWalker $sqlWalker): string
 
         return \sprintf($this->functionPrototype, \implode(', ', $dispatched));
     }
+
+    /**
+     * Validates the arguments passed to the function.
+     *
+     * @param mixed[] $arguments The array of arguments to validate
+     */
+    abstract protected function validateArguments(array $arguments): void;
 }
diff --git a/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Exception/InvalidArgumentForVariadicFunctionException.php b/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Exception/InvalidArgumentForVariadicFunctionException.php
@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception;
+
+class InvalidArgumentForVariadicFunctionException extends \InvalidArgumentException
+{
+    public static function exactCount(string $functionName, int $expected): self
+    {
+        return new self(\sprintf(
+            '%s() requires exactly %d argument%s',
+            $functionName,
+            $expected,
+            $expected === 1 ? '' : 's'
+        ));
+    }
+
+    public static function atLeast(string $functionName, int $min): self
+    {
+        return new self(\sprintf(
+            '%s() requires at least %d argument%s',
+            $functionName,
+            $min,
+            $min === 1 ? '' : 's'
+        ));
+    }
+
+    public static function between(string $functionName, int $min, int $max): self
+    {
+        return new self(\sprintf(
+            '%s() requires between %d and %d arguments',
+            $functionName,
+            $min,
+            $max
+        ));
+    }
+
+    public static function evenNumber(string $functionName): self
+    {
+        return new self(\sprintf(
+            '%s() requires an even number of arguments',
+            $functionName
+        ));
+    }
+}
diff --git a/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Greatest.php b/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Greatest.php
@@ -4,6 +4,8 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
+
 /**
  * Implementation of PostgreSQL GREATEST().
  *
@@ -18,4 +20,12 @@ protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('greatest(%s)');
     }
+
+    protected function validateArguments(array $arguments): void
+    {
+        $argumentCount = \count($arguments);
+        if ($argumentCount < 2) {
+            throw InvalidArgumentForVariadicFunctionException::atLeast('greatest', 2);
+        }
+    }
 }
diff --git a/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonBuildObject.php b/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonBuildObject.php
@@ -4,16 +4,28 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
+
 /**
  * Implementation of PostgreSQL JSON_BUILD_OBJECT().
  *
  * @see https://www.postgresql.org/docs/17/functions-json.html
- * @since 2.9.0
+ * @since 2.9
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
  */
 class JsonBuildObject extends BaseVariadicFunction
 {
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('json_build_object(%s)');
     }
+
+    protected function validateArguments(array $arguments): void
+    {
+        $argumentCount = \count($arguments);
+        if ($argumentCount === 0 || $argumentCount % 2 !== 0) {
+            throw InvalidArgumentForVariadicFunctionException::evenNumber('json_build_object');
+        }
+    }
 }
diff --git a/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonbBuildObject.php b/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonbBuildObject.php
@@ -4,16 +4,28 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
+
 /**
  * Implementation of PostgreSQL JSONB_BUILD_OBJECT().
  *
  * @see https://www.postgresql.org/docs/17/functions-json.html
- * @since 2.9.0
+ * @since 2.9
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
  */
 class JsonbBuildObject extends BaseVariadicFunction
 {
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('jsonb_build_object(%s)');
     }
+
+    protected function validateArguments(array $arguments): void
+    {
+        $argumentCount = \count($arguments);
+        if ($argumentCount === 0 || $argumentCount % 2 !== 0) {
+            throw InvalidArgumentForVariadicFunctionException::evenNumber('jsonb_build_object');
+        }
+    }
 }
diff --git a/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Least.php b/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Least.php
@@ -4,6 +4,8 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
+
 /**
  * Implementation of PostgreSQL LEAST().
  *
@@ -18,4 +20,12 @@ protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('least(%s)');
     }
+
+    protected function validateArguments(array $arguments): void
+    {
+        $argumentCount = \count($arguments);
+        if ($argumentCount < 2) {
+            throw InvalidArgumentForVariadicFunctionException::atLeast('least', 2);
+        }
+    }
 }
diff --git a/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Row.php b/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Row.php
@@ -4,6 +4,8 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
+
 /**
  * Implementation of PostgreSQL Row Constructor expression.
  *
@@ -17,4 +19,12 @@ protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('ROW(%s)');
     }
+
+    protected function validateArguments(array $arguments): void
+    {
+        $argumentCount = \count($arguments);
+        if ($argumentCount === 0) {
+            throw InvalidArgumentForVariadicFunctionException::atLeast('ROW', 1);
+        }
+    }
 }
diff --git a/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ToTsquery.php b/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ToTsquery.php
@@ -4,6 +4,8 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
+
 /**
  * Implementation of PostgreSQL TO_TSQUERY().
  *
@@ -18,4 +20,12 @@ protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('to_tsquery(%s)');
     }
+
+    protected function validateArguments(array $arguments): void
+    {
+        $argumentCount = \count($arguments);
+        if ($argumentCount < 1 || $argumentCount > 2) {
+            throw InvalidArgumentForVariadicFunctionException::between('to_tsquery', 1, 2);
+        }
+    }
 }
diff --git a/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ToTsvector.php b/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ToTsvector.php
@@ -4,6 +4,8 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
+
 /**
  * Implementation of PostgreSQL TO_TSVECTOR().
  *
@@ -20,4 +22,12 @@ protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('to_tsvector(%s)');
     }
+
+    protected function validateArguments(array $arguments): void
+    {
+        $argumentCount = \count($arguments);
+        if ($argumentCount < 1 || $argumentCount > 2) {
+            throw InvalidArgumentForVariadicFunctionException::between('to_tsvector', 1, 2);
+        }
+    }
 }
diff --git a/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Unaccent.php b/src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Unaccent.php
@@ -4,6 +4,8 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
+
 /**
  * Implementation of PostgreSQL UNACCENT.
  *
@@ -19,4 +21,12 @@ protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('unaccent(%s)');
     }
+
+    protected function validateArguments(array $arguments): void
+    {
+        $argumentCount = \count($arguments);
+        if ($argumentCount < 1 || $argumentCount > 2) {
+            throw InvalidArgumentForVariadicFunctionException::between('unaccent', 1, 2);
+        }
+    }
 }
diff --git a/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/GreatestTest.php b/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/GreatestTest.php
@@ -6,6 +6,7 @@
 
 use Fixtures\MartinGeorgiev\Doctrine\Entity\ContainsIntegers;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\BaseComparisonFunction;
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Greatest;
 
 class GreatestTest extends BaseComparisonFunctionTestCase
@@ -35,4 +36,15 @@ protected function getDqlStatements(): array
             \sprintf('SELECT GREATEST(e.integer1, e.integer2, e.integer3) FROM %s e', ContainsIntegers::class),
         ];
     }
+
+    /**
+     * @test
+     */
+    public function throws_exception_when_single_argument_given(): void
+    {
+        $this->expectException(InvalidArgumentForVariadicFunctionException::class);
+
+        $dql = \sprintf('SELECT GREATEST(e.integer1) FROM %s e', ContainsIntegers::class);
+        $this->assertSqlFromDql('', $dql);
+    }
 }
diff --git a/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonBuildObjectTest.php b/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonBuildObjectTest.php
@@ -5,6 +5,7 @@
 namespace Tests\MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
 use Fixtures\MartinGeorgiev\Doctrine\Entity\ContainsJsons;
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\JsonBuildObject;
 
 class JsonBuildObjectTest extends TestCase
@@ -33,4 +34,15 @@ protected function getDqlStatements(): array
             \sprintf("SELECT JSON_BUILD_OBJECT('key1', e.object1, 'key2', e.object2) FROM %s e", ContainsJsons::class),
         ];
     }
+
+    /**
+     * @test
+     */
+    public function throws_exception_when_odd_number_of_arguments_given(): void
+    {
+        $this->expectException(InvalidArgumentForVariadicFunctionException::class);
+
+        $dql = \sprintf('SELECT JSON_BUILD_OBJECT(\'key1\', e.value1, \'key2\') FROM %s e', ContainsJsons::class);
+        $this->assertSqlFromDql('', $dql);
+    }
 }
diff --git a/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonbBuildObjectTest.php b/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonbBuildObjectTest.php
@@ -5,6 +5,7 @@
 namespace Tests\MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
 use Fixtures\MartinGeorgiev\Doctrine\Entity\ContainsJsons;
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\JsonbBuildObject;
 
 class JsonbBuildObjectTest extends TestCase
@@ -33,4 +34,15 @@ protected function getDqlStatements(): array
             \sprintf("SELECT JSONB_BUILD_OBJECT('key1', e.object1, 'key2', e.object2) FROM %s e", ContainsJsons::class),
         ];
     }
+
+    /**
+     * @test
+     */
+    public function throws_exception_when_odd_number_of_arguments_given(): void
+    {
+        $this->expectException(InvalidArgumentForVariadicFunctionException::class);
+
+        $dql = \sprintf('SELECT JSONB_BUILD_OBJECT(\'key1\', e.object1, \'key2\') FROM %s e', ContainsJsons::class);
+        $this->assertSqlFromDql('', $dql);
+    }
 }
diff --git a/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/LeastTest.php b/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/LeastTest.php
@@ -6,6 +6,7 @@
 
 use Fixtures\MartinGeorgiev\Doctrine\Entity\ContainsIntegers;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\BaseComparisonFunction;
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Least;
 
 class LeastTest extends BaseComparisonFunctionTestCase
@@ -35,4 +36,15 @@ protected function getDqlStatements(): array
             \sprintf('SELECT LEAST(e.integer1, e.integer2, e.integer3) FROM %s e', ContainsIntegers::class),
         ];
     }
+
+    /**
+     * @test
+     */
+    public function throws_exception_when_single_argument_given(): void
+    {
+        $this->expectException(InvalidArgumentForVariadicFunctionException::class);
+
+        $dql = \sprintf('SELECT LEAST(e.integer1) FROM %s e', ContainsIntegers::class);
+        $this->assertSqlFromDql('', $dql);
+    }
 }
diff --git a/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/TestCase.php b/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/TestCase.php
@@ -100,7 +100,7 @@ public function dql_is_transformed_to_valid_sql(): void
         }
     }
 
-    private function assertSqlFromDql(string $expectedSql, string $dql, string $message = ''): void
+    protected function assertSqlFromDql(string $expectedSql, string $dql, string $message = ''): void
     {
         $query = $this->buildEntityManager()->createQuery($dql);
         $this->assertEquals($expectedSql, $query->getSQL(), $message);
diff --git a/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ToTsqueryTest.php b/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ToTsqueryTest.php
@@ -5,6 +5,7 @@
 namespace Tests\MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
 use Fixtures\MartinGeorgiev\Doctrine\Entity\ContainsTexts;
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\ToTsquery;
 
 class ToTsqueryTest extends TestCase
@@ -33,4 +34,15 @@ protected function getDqlStatements(): array
             \sprintf('SELECT TO_TSQUERY(\'english\', e.text1) FROM %s e', ContainsTexts::class),
         ];
     }
+
+    /**
+     * @test
+     */
+    public function throws_exception_when_too_many_arguments_given(): void
+    {
+        $this->expectException(InvalidArgumentForVariadicFunctionException::class);
+
+        $dql = \sprintf('SELECT TO_TSQUERY(\'english\', e.text1, \'extra\') FROM %s e', ContainsTexts::class);
+        $this->assertSqlFromDql('', $dql);
+    }
 }
diff --git a/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ToTsvectorTest.php b/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ToTsvectorTest.php
diff --git a/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/UnaccentTest.php b/tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/UnaccentTest.php

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,8 @@ public function feedParserWithNodes(Parser $parser): void`
`38`	`38`	`}`
`39`	`39`	`$aheadType = $lexer->lookahead->type;`
`40`	`40`	`}`
	`41`	`+`
	`42`	`+ $this->validateArguments($this->nodes);`
`41`	`43`	`}`
`42`	`44`
`43`	`45`	`public function getSql(SqlWalker $sqlWalker): string`
`@@ -49,4 +51,11 @@ public function getSql(SqlWalker $sqlWalker): string`
`49`	`51`
`50`	`52`	`return \sprintf($this->functionPrototype, \implode(', ', $dispatched));`
`51`	`53`	`}`
	`54`	`+`
	`55`	`+ /**`
	`56`	`+ * Validates the arguments passed to the function.`
	`57`	`+ *`
	`58`	`+ * @param mixed[] $arguments The array of arguments to validate`
	`59`	`+ */`
	`60`	`+ abstract protected function validateArguments(array $arguments): void;`
`52`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`
`5`	`5`	`namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;`
`6`	`6`
	`7`	`+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;`
	`8`	`+`
`7`	`9`	`/**`
`8`	`10`	`* Implementation of PostgreSQL GREATEST().`
`9`	`11`	`*`
`@@ -18,4 +20,12 @@ protected function customizeFunction(): void`
`18`	`20`	`{`
`19`	`21`	`$this->setFunctionPrototype('greatest(%s)');`
`20`	`22`	`}`
	`23`	`+`
	`24`	`+ protected function validateArguments(array $arguments): void`
	`25`	`+ {`
	`26`	`+ $argumentCount = \count($arguments);`
	`27`	`+ if ($argumentCount < 2) {`
	`28`	`+ throw InvalidArgumentForVariadicFunctionException::atLeast('greatest', 2);`
	`29`	`+ }`
	`30`	`+ }`
`21`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,16 +4,28 @@`
`4`	`4`
`5`	`5`	`namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;`
`6`	`6`
	`7`	`+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;`
	`8`	`+`
`7`	`9`	`/**`
`8`	`10`	`* Implementation of PostgreSQL JSON_BUILD_OBJECT().`
`9`	`11`	`*`
`10`	`12`	`* @see https://www.postgresql.org/docs/17/functions-json.html`
`11`		`- * @since 2.9.0`
	`13`	`+ * @since 2.9`
	`14`	`+ *`
	`15`	`+ * @author Martin Georgiev <martin.georgiev@gmail.com>`
`12`	`16`	`*/`
`13`	`17`	`class JsonBuildObject extends BaseVariadicFunction`
`14`	`18`	`{`
`15`	`19`	`protected function customizeFunction(): void`
`16`	`20`	`{`
`17`	`21`	`$this->setFunctionPrototype('json_build_object(%s)');`
`18`	`22`	`}`
	`23`	`+`
	`24`	`+ protected function validateArguments(array $arguments): void`
	`25`	`+ {`
	`26`	`+ $argumentCount = \count($arguments);`
	`27`	`+ if ($argumentCount === 0 \|\| $argumentCount % 2 !== 0) {`
	`28`	`+ throw InvalidArgumentForVariadicFunctionException::evenNumber('json_build_object');`
	`29`	`+ }`
	`30`	`+ }`
`19`	`31`	`}`