Issue #2942569 by seanB, idebr, amateescu, kristiaanvandeneynde: Sort…

…ing nested properties of config entity queries does not work (cherry picked from commit a07a4ba0515c82b9f2e4f6039c2f80848a07549a)
drupal · Jul 15, 2020 · 4f5fd9b · 4f5fd9b
1 parent 6394611
commit 4f5fd9b
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 29 deletions.
diff --git a/lib/Drupal/Core/Config/Entity/Query/Query.php b/lib/Drupal/Core/Config/Entity/Query/Query.php
@@ -89,7 +89,14 @@ public function execute() {
       $direction = $sort['direction'] == 'ASC' ? -1 : 1;
       $field = $sort['field'];
       uasort($result, function ($a, $b) use ($field, $direction) {
-        return ($a[$field] <= $b[$field]) ? $direction : -$direction;
+        $properties = explode('.', $field);
+        foreach ($properties as $property) {
+          if (isset($a[$property]) || isset($b[$property])) {
+            $a = isset($a[$property]) ? $a[$property] : NULL;
+            $b = isset($b[$property]) ? $b[$property] : NULL;
+          }
+        }
+        return ($a <= $b) ? $direction : -$direction;
       });
     }
 

diff --git a/tests/Drupal/KernelTests/Core/Entity/ConfigEntityQueryTest.php b/tests/Drupal/KernelTests/Core/Entity/ConfigEntityQueryTest.php
@@ -114,6 +114,27 @@ protected function setUp() {
     $this->entities[] = $entity;
     $entity->enforceIsNew();
     $entity->save();
+
+    $array['level1'] = [];
+    $entity = ConfigQueryTest::create([
+      'label' => $this->randomMachineName(),
+      'id' => '6',
+      'array' => $array,
+    ]);
+    $this->entities[] = $entity;
+    $entity->enforceIsNew();
+    $entity->save();
+
+    $array['level1']['level2'] = 4;
+    $entity = ConfigQueryTest::create([
+      'label' => $this->randomMachineName(),
+      'id' => '7',
+      'number' => 70,
+      'array' => $array,
+    ]);
+    $this->entities[] = $entity;
+    $entity->enforceIsNew();
+    $entity->save();
   }
 
   /**
@@ -123,11 +144,11 @@ public function testConfigEntityQuery() {
     // Run a test without any condition.
     $this->queryResults = $this->entityStorage->getQuery()
       ->execute();
-    $this->assertResults(['1', '2', '3', '4', '5']);
+    $this->assertResults(['1', '2', '3', '4', '5', '6', '7']);
     // No conditions, OR.
     $this->queryResults = $this->entityStorage->getQuery('OR')
       ->execute();
-    $this->assertResults(['1', '2', '3', '4', '5']);
+    $this->assertResults(['1', '2', '3', '4', '5', '6', '7']);
 
     // Filter by ID with equality.
     $this->queryResults = $this->entityStorage->getQuery()
@@ -169,19 +190,19 @@ public function testConfigEntityQuery() {
     $this->queryResults = $this->entityStorage->getQuery()
       ->condition('id', '3', '>')
       ->execute();
-    $this->assertResults(['4', '5']);
+    $this->assertResults(['4', '5', '6', '7']);
 
     // Filter by ID with the >= operator.
     $this->queryResults = $this->entityStorage->getQuery()
       ->condition('id', '3', '>=')
       ->execute();
-    $this->assertResults(['3', '4', '5']);
+    $this->assertResults(['3', '4', '5', '6', '7']);
 
     // Filter by ID with the <> operator.
     $this->queryResults = $this->entityStorage->getQuery()
       ->condition('id', '3', '<>')
       ->execute();
-    $this->assertResults(['1', '2', '4', '5']);
+    $this->assertResults(['1', '2', '4', '5', '6', '7']);
 
     // Filter by ID with the < operator.
     $this->queryResults = $this->entityStorage->getQuery()
@@ -226,7 +247,7 @@ public function testConfigEntityQuery() {
       ->condition('number', 10, '>=')
       ->condition('number', 50, '>=')
       ->execute();
-    $this->assertResults(['3', '5']);
+    $this->assertResults(['3', '5', '7']);
 
     // Filter with an OR condition group.
     $this->queryResults = $this->entityStorage->getQuery('OR')
@@ -249,7 +270,7 @@ public function testConfigEntityQuery() {
     $this->queryResults = $this->entityStorage->getQuery()
       ->condition('id', ['1', '2'], 'NOT IN')
       ->execute();
-    $this->assertResults(['3', '4', '5']);
+    $this->assertResults(['3', '4', '5', '6', '7']);
 
     // Filter with an OR condition group on different fields.
     $this->queryResults = $this->entityStorage->getQuery('OR')
@@ -328,7 +349,7 @@ public function testConfigEntityQuery() {
     $this->queryResults = $this->entityStorage->getQuery()
       ->exists('id')
       ->execute();
-    $this->assertResults(['1', '2', '3', '4', '5']);
+    $this->assertResults(['1', '2', '3', '4', '5', '6', '7']);
 
     $this->queryResults = $this->entityStorage->getQuery()
       ->exists('non-existent')
@@ -343,7 +364,7 @@ public function testConfigEntityQuery() {
     $this->queryResults = $this->entityStorage->getQuery()
       ->notExists('non-existent')
       ->execute();
-    $this->assertResults(['1', '2', '3', '4', '5']);
+    $this->assertResults(['1', '2', '3', '4', '5', '6', '7']);
   }
 
   /**
@@ -436,38 +457,38 @@ public function testSortRange() {
     $this->queryResults = $this->entityStorage->getQuery()
       ->sort('number', 'DESC')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['3', '5', '2', '1', '4']);
+    $this->assertIdentical(array_values($this->queryResults), ['7', '3', '5', '2', '1', '4', '6']);
 
     $this->queryResults = $this->entityStorage->getQuery()
       ->sort('number', 'ASC')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['4', '1', '2', '5', '3']);
+    $this->assertIdentical(array_values($this->queryResults), ['6', '4', '1', '2', '5', '3', '7']);
 
     // Apply some filters and sort.
     $this->queryResults = $this->entityStorage->getQuery()
       ->condition('id', '3', '>')
       ->sort('number', 'DESC')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['5', '4']);
+    $this->assertIdentical(array_values($this->queryResults), ['7', '5', '4', '6']);
 
     $this->queryResults = $this->entityStorage->getQuery()
       ->condition('id', '3', '>')
       ->sort('number', 'ASC')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['4', '5']);
+    $this->assertIdentical(array_values($this->queryResults), ['6', '4', '5', '7']);
 
     // Apply a pager and sort.
     $this->queryResults = $this->entityStorage->getQuery()
       ->sort('number', 'DESC')
       ->range('2', '2')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['2', '1']);
+    $this->assertIdentical(array_values($this->queryResults), ['5', '2']);
 
     $this->queryResults = $this->entityStorage->getQuery()
       ->sort('number', 'ASC')
       ->range('2', '2')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['2', '5']);
+    $this->assertIdentical(array_values($this->queryResults), ['1', '2']);
 
     // Add a range to a query without a start parameter.
     $this->queryResults = $this->entityStorage->getQuery()
@@ -499,57 +520,57 @@ public function testTableSort() {
       ->tableSort($header)
       ->sort('id', 'DESC')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['5', '4', '3', '2', '1']);
+    $this->assertIdentical(array_values($this->queryResults), ['7', '6', '5', '4', '3', '2', '1']);
 
     // Sorting with 'ASC' upper case
     $this->queryResults = $this->entityStorage->getQuery()
       ->tableSort($header)
       ->sort('id', 'ASC')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['1', '2', '3', '4', '5']);
+    $this->assertIdentical(array_values($this->queryResults), ['1', '2', '3', '4', '5', '6', '7']);
 
     // Sorting with 'desc' lower case
     $this->queryResults = $this->entityStorage->getQuery()
       ->tableSort($header)
       ->sort('id', 'desc')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['5', '4', '3', '2', '1']);
+    $this->assertIdentical(array_values($this->queryResults), ['7', '6', '5', '4', '3', '2', '1']);
 
     // Sorting with 'asc' lower case
     $this->queryResults = $this->entityStorage->getQuery()
       ->tableSort($header)
       ->sort('id', 'asc')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['1', '2', '3', '4', '5']);
+    $this->assertIdentical(array_values($this->queryResults), ['1', '2', '3', '4', '5', '6', '7']);
 
     // Sort key: number
     // Sorting with 'DeSc' mixed upper and lower case
     $this->queryResults = $this->entityStorage->getQuery()
       ->tableSort($header)
       ->sort('number', 'DeSc')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['3', '5', '2', '1', '4']);
+    $this->assertIdentical(array_values($this->queryResults), ['7', '3', '5', '2', '1', '4', '6']);
 
     // Sorting with 'AsC' mixed upper and lower case
     $this->queryResults = $this->entityStorage->getQuery()
       ->tableSort($header)
       ->sort('number', 'AsC')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['4', '1', '2', '5', '3']);
+    $this->assertIdentical(array_values($this->queryResults), ['6', '4', '1', '2', '5', '3', '7']);
 
     // Sorting with 'dEsC' mixed upper and lower case
     $this->queryResults = $this->entityStorage->getQuery()
       ->tableSort($header)
       ->sort('number', 'dEsC')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['3', '5', '2', '1', '4']);
+    $this->assertIdentical(array_values($this->queryResults), ['7', '3', '5', '2', '1', '4', '6']);
 
     // Sorting with 'aSc' mixed upper and lower case
     $this->queryResults = $this->entityStorage->getQuery()
       ->tableSort($header)
       ->sort('number', 'aSc')
       ->execute();
-    $this->assertIdentical(array_values($this->queryResults), ['4', '1', '2', '5', '3']);
+    $this->assertIdentical(array_values($this->queryResults), ['6', '4', '1', '2', '5', '3', '7']);
   }
 
   /**
@@ -572,6 +593,15 @@ public function testDotted() {
       ->condition('array.level1.level2', 3)
       ->execute();
     $this->assertResults(['5']);
+    // Test dotted sorting.
+    $this->queryResults = $this->entityStorage->getQuery()
+      ->sort('array.level1.level2')
+      ->execute();
+    $this->assertResults(['6', '1', '3', '2', '4', '5', '7']);
+    $this->queryResults = $this->entityStorage->getQuery()
+      ->sort('array.level1.level2', 'DESC')
+      ->execute();
+    $this->assertResults(['7', '5', '2', '4', '1', '3', '6']);
     // Make sure that values on the wildcard level do not match if there are
     // sub-keys defined. This must not find anything even if entity 2 has a
     // top-level key number with value 41.
@@ -581,23 +611,22 @@ public function testDotted() {
     $this->assertResults([]);
     // Make sure that "IS NULL" and "IS NOT NULL" work correctly with
     // array-valued fields/keys.
-    $all = ['1', '2', '3', '4', '5'];
     $this->queryResults = $this->entityStorage->getQuery()
       ->exists('array.level1.level2')
       ->execute();
-    $this->assertResults($all);
+    $this->assertResults(['1', '2', '3', '4', '5', '7']);
     $this->queryResults = $this->entityStorage->getQuery()
       ->exists('array.level1')
       ->execute();
-    $this->assertResults($all);
+    $this->assertResults(['1', '2', '3', '4', '5', '6', '7']);
     $this->queryResults = $this->entityStorage->getQuery()
       ->exists('array')
       ->execute();
-    $this->assertResults($all);
+    $this->assertResults(['1', '2', '3', '4', '5', '6', '7']);
     $this->queryResults = $this->entityStorage->getQuery()
       ->notExists('array.level1.level2')
       ->execute();
-    $this->assertResults([]);
+    $this->assertResults(['6']);
     $this->queryResults = $this->entityStorage->getQuery()
       ->notExists('array.level1')
       ->execute();