Fix Unique::getPaginatedQuery to call to addSelect instead of select during the pre-paginated query

Author: alexweissman

CHANGELOG.md

@@ -5,6 +5,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## v4.1.19
+- Fix `Unique::getPaginatedQuery` to call to `addSelect` instead of `select` during the pre-paginated query
+
 ## v4.1.18
 - Bakery setup wizard for SMTP config + separate SMTP setup in it's own command (https://github.com/userfrosting/UserFrosting/issues/874)
 - Update Italian translations (https://github.com/userfrosting/UserFrosting/pull/875)

app/defines.php

@@ -3,7 +3,7 @@
 namespace UserFrosting;
 
 // Some standard defines
-define('UserFrosting\VERSION', '4.1.18');
+define('UserFrosting\VERSION', '4.1.19');
 define('UserFrosting\DS', '/');
 define('UserFrosting\PHP_MIN_VERSION', '5.6');
 define('UserFrosting\DEBUG_CONFIG', false);

app/sprinkles/core/src/Database/Relations/Concerns/Unique.php

@@ -277,7 +277,7 @@ public function getPaginatedQuery(Builder $query, $limit = null, $offset = null)
 
         // Apply an additional scope to override any selected columns in other global scopes
         $uniqueIdScope = function ($subQuery) use ($relatedKeyName) {
-            $subQuery->select($relatedKeyName)
+            $subQuery->addSelect($relatedKeyName)
                      ->groupBy($relatedKeyName);
         };
 

app/sprinkles/core/tests/Integration/DatabaseTests.php

@@ -119,6 +119,7 @@ public function tearDown()
         $this->schema($this->schemaName)->drop('tasks');
         $this->schema($this->schemaName)->drop('locations');
         $this->schema($this->schemaName)->drop('assignments');
+        $this->schema($this->schemaName)->drop('jobs');
 
         Relation::morphMap([], false);
     }
@@ -658,6 +659,35 @@ public function testBelongsToManyThroughPaginated()
         $this->assertEquals(2, $paginatedPermissions->count());
     }
 
+    /**
+     * Test the ability of a BelongsToManyThrough relationship to retrieve and count paginated queries,
+     * when we need to reference a virtual/computed column (for example in a sort).
+     */
+    public function testBelongsToManyThroughPaginatedWithOrderByAggregateColumn()
+    {
+        $this->generateRolesWithPermissions();
+
+        $user = EloquentTestUser::create(['name' => 'David']);
+        $user->roles()->attach([1,2]);
+
+        // If the paginated query is being ordered correctly by including the `roles_count` computed column,
+        // Then `uri_spit_acid` should appear first. If not, then the results will not be ordered and the `uri_harvest`
+        // result will be returned, in accordance with the default database order.
+        $paginatedPermissions = $user->permissions()->withCount('roles')->orderBy('roles_count', 'desc')->take(1)->offset(0);
+
+        $this->assertEquals([
+            [
+                'id' => 2,
+                'slug' => 'uri_spit_acid',
+                'roles_count' => 3,
+                'pivot' => [
+                    'user_id' => 1,
+                    'permission_id' => 2
+                ]
+            ]
+        ], $paginatedPermissions->get()->toArray());
+    }
+
     /**
      * Test the ability of a BelongsToManyThrough relationship to retrieve structured data on a single model or set of models,
      * eager loading the "via" models at the same time.