feat: add support for ORDER BY clause for array_agg() (#267)

Author: martin-georgiev

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ArrayAgg.php

@@ -4,19 +4,36 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use Doctrine\ORM\Query\Parser;
+use Doctrine\ORM\Query\SqlWalker;
+
 /**
  * Implementation of PostgreSql ARRAY_AGG().
  *
- * @see https://www.postgresql.org/docs/9.5/functions-aggregate.html
+ * @see https://www.postgresql.org/docs/17/functions-aggregate.html
  * @since 1.4
  *
  * @author Martin Georgiev <martin.georgiev@gmail.com>
  */
-class ArrayAgg extends BaseFunction
+class ArrayAgg extends BaseOrderableFunction
 {
     protected function customiseFunction(): void
     {
-        $this->setFunctionPrototype('array_agg(%s)');
-        $this->addNodeMapping('StringPrimary');
+        $this->setFunctionPrototype('array_agg(%s%s)');
+    }
+
+    protected function parseFunction(Parser $parser): void
+    {
+        $this->expression = $parser->StringPrimary();
+    }
+
+    public function getSql(SqlWalker $sqlWalker): string
+    {
+        $dispatched = [
+            $this->expression->dispatch($sqlWalker),
+            $this->getOptionalOrderByClause($sqlWalker),
+        ];
+
+        return \vsprintf($this->functionPrototype, $dispatched);
     }
 }

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/BaseOrderableFunction.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
+
+use Doctrine\ORM\Query\AST\Node;
+use Doctrine\ORM\Query\AST\OrderByClause;
+use Doctrine\ORM\Query\Lexer;
+use Doctrine\ORM\Query\Parser;
+use Doctrine\ORM\Query\SqlWalker;
+use Doctrine\ORM\Query\TokenType;
+use MartinGeorgiev\Utils\DoctrineOrm;
+
+abstract class BaseOrderableFunction extends BaseFunction
+{
+    protected Node $expression;
+    protected ?OrderByClause $orderByClause = null;
+
+    public function parse(Parser $parser): void
+    {
+        $shouldUseLexer = DoctrineOrm::isPre219();
+
+        $this->customiseFunction();
+
+        $parser->match($shouldUseLexer ? Lexer::T_IDENTIFIER : TokenType::T_IDENTIFIER);
+        $parser->match($shouldUseLexer ? Lexer::T_OPEN_PARENTHESIS : TokenType::T_OPEN_PARENTHESIS);
+
+        $this->parseFunction($parser);
+
+        $lexer = $parser->getLexer();
+        if ($lexer->isNextToken($shouldUseLexer ? Lexer::T_ORDER : TokenType::T_ORDER)) {
+            $this->orderByClause = $parser->OrderByClause();
+        }
+
+        $parser->match($shouldUseLexer ? Lexer::T_CLOSE_PARENTHESIS : TokenType::T_CLOSE_PARENTHESIS);
+    }
+
+    abstract protected function parseFunction(Parser $parser): void;
+
+    protected function getOptionalOrderByClause(SqlWalker $sqlWalker): string
+    {
+        return $this->orderByClause instanceof OrderByClause ? $this->orderByClause->dispatch($sqlWalker) : '';
+    }
+}

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/StringAgg.php

@@ -5,7 +5,6 @@
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
 use Doctrine\ORM\Query\AST\Node;
-use Doctrine\ORM\Query\AST\OrderByClause;
 use Doctrine\ORM\Query\Lexer;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
@@ -20,54 +19,40 @@
  *
  * @author Martin Georgiev <martin.georgiev@gmail.com>
  */
-class StringAgg extends BaseFunction
+class StringAgg extends BaseOrderableFunction
 {
     private bool $isDistinct = false;
-
-    private Node $expression;
-
     private Node $delimiter;
 
-    private OrderByClause $orderByClause;
-
     protected function customiseFunction(): void
     {
         $this->setFunctionPrototype('string_agg(%s%s, %s%s)');
     }
 
-    public function parse(Parser $parser): void
+    protected function parseFunction(Parser $parser): void
     {
         $shouldUseLexer = DoctrineOrm::isPre219();
-
-        $this->customiseFunction();
-
-        $parser->match($shouldUseLexer ? Lexer::T_IDENTIFIER : TokenType::T_IDENTIFIER);
-        $parser->match($shouldUseLexer ? Lexer::T_OPEN_PARENTHESIS : TokenType::T_OPEN_PARENTHESIS);
-
         $lexer = $parser->getLexer();
+
         if ($lexer->isNextToken($shouldUseLexer ? Lexer::T_DISTINCT : TokenType::T_DISTINCT)) {
             $parser->match($shouldUseLexer ? Lexer::T_DISTINCT : TokenType::T_DISTINCT);
             $this->isDistinct = true;
         }
 
         $this->expression = $parser->StringPrimary();
-        $parser->match($shouldUseLexer ? Lexer::T_COMMA : TokenType::T_COMMA);
-        $this->delimiter = $parser->StringPrimary();
 
-        if ($lexer->isNextToken($shouldUseLexer ? Lexer::T_ORDER : TokenType::T_ORDER)) {
-            $this->orderByClause = $parser->OrderByClause();
-        }
+        $parser->match($shouldUseLexer ? Lexer::T_COMMA : TokenType::T_COMMA);
 
-        $parser->match($shouldUseLexer ? Lexer::T_CLOSE_PARENTHESIS : TokenType::T_CLOSE_PARENTHESIS);
+        $this->delimiter = $parser->StringPrimary();
     }
 
     public function getSql(SqlWalker $sqlWalker): string
     {
         $dispatched = [
-            $this->isDistinct ? 'distinct ' : '',
+            $this->isDistinct ? 'DISTINCT ' : '',
             $this->expression->dispatch($sqlWalker),
             $this->delimiter->dispatch($sqlWalker),
-            isset($this->orderByClause) ? $this->orderByClause->dispatch($sqlWalker) : '',
+            $this->getOptionalOrderByClause($sqlWalker),
         ];
 
         return \vsprintf($this->functionPrototype, $dispatched);

tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ArrayAggTest.php

@@ -19,14 +19,29 @@ protected function getStringFunctions(): array
     protected function getExpectedSqlStatements(): array
     {
         return [
+            // Basic usage
+            'SELECT array_agg(c0_.text1) AS sclr_0 FROM ContainsTexts c0_',
+            // With concatenation
             'SELECT array_agg(c0_.text1 || c0_.text2) AS sclr_0 FROM ContainsTexts c0_',
+            // With ORDER BY
+            'SELECT array_agg(c0_.text1 ORDER BY c0_.text1 ASC) AS sclr_0 FROM ContainsTexts c0_',
+            'SELECT array_agg(c0_.text1 ORDER BY c0_.text1 DESC) AS sclr_0 FROM ContainsTexts c0_',
+            // With concatenation and ORDER BY
+            'SELECT array_agg(c0_.text1 || c0_.text2 ORDER BY c0_.text1 ASC) AS sclr_0 FROM ContainsTexts c0_',
+            // With multiple ORDER BY columns
+            'SELECT array_agg(c0_.text1 ORDER BY c0_.text1 ASC, c0_.text2 DESC) AS sclr_0 FROM ContainsTexts c0_',
         ];
     }
 
     protected function getDqlStatements(): array
     {
         return [
+            \sprintf('SELECT ARRAY_AGG(e.text1) FROM %s e', ContainsTexts::class),
             \sprintf('SELECT ARRAY_AGG(CONCAT(e.text1, e.text2)) FROM %s e', ContainsTexts::class),
+            \sprintf('SELECT ARRAY_AGG(e.text1 ORDER BY e.text1) FROM %s e', ContainsTexts::class),
+            \sprintf('SELECT ARRAY_AGG(e.text1 ORDER BY e.text1 DESC) FROM %s e', ContainsTexts::class),
+            \sprintf('SELECT ARRAY_AGG(CONCAT(e.text1, e.text2) ORDER BY e.text1) FROM %s e', ContainsTexts::class),
+            \sprintf('SELECT ARRAY_AGG(e.text1 ORDER BY e.text1 ASC, e.text2 DESC) FROM %s e', ContainsTexts::class),
         ];
     }
 }

tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/StringAggTest.php

@@ -19,14 +19,41 @@ protected function getStringFunctions(): array
     protected function getExpectedSqlStatements(): array
     {
         return [
+            // Basic usage
+            "SELECT string_agg(c0_.text1, ',') AS sclr_0 FROM ContainsTexts c0_",
+            // With concatenation
             "SELECT string_agg(c0_.text1 || c0_.text2, ',') AS sclr_0 FROM ContainsTexts c0_",
+            // With DISTINCT
+            "SELECT string_agg(DISTINCT c0_.text1, ',') AS sclr_0 FROM ContainsTexts c0_",
+            // With DISTINCT and concatenation
+            "SELECT string_agg(DISTINCT c0_.text1 || c0_.text2, ',') AS sclr_0 FROM ContainsTexts c0_",
+            // With ORDER BY
+            "SELECT string_agg(c0_.text1, ',' ORDER BY c0_.text1 ASC) AS sclr_0 FROM ContainsTexts c0_",
+            "SELECT string_agg(c0_.text1, ',' ORDER BY c0_.text1 DESC) AS sclr_0 FROM ContainsTexts c0_",
+            // With DISTINCT and ORDER BY
+            "SELECT string_agg(DISTINCT c0_.text1, ',' ORDER BY c0_.text1 ASC) AS sclr_0 FROM ContainsTexts c0_",
+            // With concatenation, DISTINCT and ORDER BY
+            "SELECT string_agg(DISTINCT c0_.text1 || c0_.text2, ',' ORDER BY c0_.text1 ASC) AS sclr_0 FROM ContainsTexts c0_",
+            // With multiple ORDER BY columns
+            "SELECT string_agg(c0_.text1, ',' ORDER BY c0_.text1 ASC, c0_.text2 DESC) AS sclr_0 FROM ContainsTexts c0_",
+            // With different delimiter
+            "SELECT string_agg(c0_.text1, ' | ') AS sclr_0 FROM ContainsTexts c0_",
         ];
     }
 
     protected function getDqlStatements(): array
     {
         return [
+            \sprintf("SELECT STRING_AGG(e.text1, ',') FROM %s e", ContainsTexts::class),
             \sprintf("SELECT STRING_AGG(CONCAT(e.text1, e.text2), ',') FROM %s e", ContainsTexts::class),
+            \sprintf("SELECT STRING_AGG(DISTINCT e.text1, ',') FROM %s e", ContainsTexts::class),
+            \sprintf("SELECT STRING_AGG(DISTINCT CONCAT(e.text1, e.text2), ',') FROM %s e", ContainsTexts::class),
+            \sprintf("SELECT STRING_AGG(e.text1, ',' ORDER BY e.text1) FROM %s e", ContainsTexts::class),
+            \sprintf("SELECT STRING_AGG(e.text1, ',' ORDER BY e.text1 DESC) FROM %s e", ContainsTexts::class),
+            \sprintf("SELECT STRING_AGG(DISTINCT e.text1, ',' ORDER BY e.text1) FROM %s e", ContainsTexts::class),
+            \sprintf("SELECT STRING_AGG(DISTINCT CONCAT(e.text1, e.text2), ',' ORDER BY e.text1) FROM %s e", ContainsTexts::class),
+            \sprintf("SELECT STRING_AGG(e.text1, ',' ORDER BY e.text1 ASC, e.text2 DESC) FROM %s e", ContainsTexts::class),
+            \sprintf("SELECT STRING_AGG(e.text1, ' | ') FROM %s e", ContainsTexts::class),
         ];
     }
 }