Preserve Relation field query order (#2890)

Author: chielteuben

resources/js/controllers/relation_controller.js

@@ -68,18 +68,10 @@ export default class extends ApplicationController {
             searchColumns,
             chunk,
         })
-            .then((response) => {
-                const options = [];
-
-                Object.entries(response.data).forEach((entry) => {
-                    const [value, label] = entry;
-
-                    options.push({ label, value });
-                });
-
-                this.choices.clearOptions();
-                callback(options);
-            });
+        .then((response) => {
+            this.choices.clearOptions();
+            callback(response.data);
+        });
     }
 
     /**

src/Platform/Http/Controllers/RelationController.php

@@ -72,7 +72,12 @@ private function buildersItems(
         }
 
         if (is_a($model, BaseCollection::class)) {
-            return $model->take($chunk)->pluck($append ?? $name, $key);
+            return $model->take($chunk)->map(function ($item) use ($append, $key, $name) {
+                return [
+                    'value' => $item->$key,
+                    'label' => $item->$append ?? $item->$name,
+                ];
+            });
         }
 
         $model = $model->where(function ($query) use ($name, $search, $searchColumns) {
@@ -87,19 +92,22 @@ private function buildersItems(
         return $model
             ->limit($chunk)
             ->get()
-            ->mapWithKeys(function ($item) use ($append, $key, $name) {
+            ->map(function ($item) use ($append, $key, $name) {
                 $resultKey = $item->$key;
 
-                $value = $item->$append ?? $item->$name;
+                $resultLabel = $item->$append ?? $item->$name;
 
                 if ($resultKey instanceof \UnitEnum) {
                     $resultKey = $resultKey->value;
                 }
-                if ($value instanceof \UnitEnum) {
-                    $value = $value->value;
+                if ($resultLabel instanceof \UnitEnum) {
+                    $resultLabel = $resultLabel->value;
                 }
 
-                return [$resultKey => $value];
+                return [
+                    'value' => $resultKey,
+                    'label' => $resultLabel,
+                ];
             });
     }
 }

tests/Feature/Platform/RelationsTest.php

@@ -43,7 +43,13 @@ public static function scopeList(): array
     public function testScopeModel(array $scope): void
     {
         $response = $this->getScope($scope);
-        $json = $this->users->pluck('email', 'id')->toArray();
+
+        $json = $this->users->map(function ($user) {
+            return [
+                'value' => $user->id,
+                'label' => $user->email,
+            ];
+        })->toArray();
 
         $response->assertJson($json);
     }
@@ -56,14 +62,13 @@ public function testScopeModel(array $scope): void
     public function testAppendModel(array $scope): void
     {
         $response = $this->getScope($scope, 'full');
-
-        $users = collect();
-
-        $this->users->each(function (User $user) use ($users) {
-            $users->put($user->id, $user->name.' ('.$user->email.')');
-        });
-
-        $json = $users->toArray();
+        
+        $json = $this->users->map(function ($user) {
+            return [
+                'value' => $user->id,
+                'label' => $user->name . ' (' . $user->email . ')',
+            ];
+        })->toArray();
 
         $response->assertJson($json);
     }
@@ -81,7 +86,7 @@ public function testParamsForScopeModel(): void
         ]);
 
         $response->assertJson([
-            $user->id => $user->email,
+            ['value' => $user->id, 'label' => $user->email],
         ]);
     }
 
@@ -124,7 +129,7 @@ public function testSearchColumns()
             ->post(route('platform.systems.relation'), $params);
 
         $response->assertJson([
-            $user->id => $user->name.' ('.$user->email.')',
+            ['value' => $user->id, 'label' => $user->name . ' (' . $user->email . ')'],
         ]);
     }
 
@@ -154,7 +159,7 @@ public function testSearchColumnsWithScopes()
         $latest_query = array_pop($queryLog);
 
         $response->assertJson([
-            $user->id => $user->name.' ('.$user->email.')',
+            ['value' => $user->id, 'label' => $user->name . ' (' . $user->email . ')'],
         ]);
 
         $this->assertContains('select * from "users" where "name" = ? and ("email" like ? or "id" like ?) limit 10', $latest_query);