Collections ->sortBy() multiple attributes that contain Enum return wrong order

[tommy66374]

Laravel Version

11.40.0

PHP Version

8.3.1

Database Driver & Version

No response

Description

Collections ->sortBy() multiple attributes that contain Enum return wrong order

sort by single attribute
✅ String
✅ Int
✅ Carbon
✅ Enum

sort by multiple attributes
✅ String
✅ Int
✅ Carbon
❌ Enum

Steps To Reproduce

Enum

<?php

namespace App\Enums;

enum Role: int
{
    case Administrator = 1;
    case Moderator = 2;
    case SuperMember = 3;
    case Member = 4;
}

Test in route

<?php

use App\Enums\Role;
use Illuminate\Support\Facades\Route;

Route::get('/test', function () {
    $users = collect([
        ['id' => 1, 'role_id' => Role::Administrator],
        ['id' => 2, 'role_id' => Role::Moderator],
        ['id' => 3, 'role_id' => Role::SuperMember],
        ['id' => 4, 'role_id' => Role::Member],
        ['id' => 5, 'role_id' => Role::Administrator],
        ['id' => 6, 'role_id' => Role::Moderator],
        ['id' => 7, 'role_id' => Role::SuperMember],
        ['id' => 8, 'role_id' => Role::Member],
    ]);

    $noSorting = $users
        ->pluck('role_id')
        ->toJson();

    dd($noSorting); // "[1,2,3,4,1,2,3,4]"

    $asc = $users
        ->sortBy([
            ['role_id', 'asc'],
            ['id', 'asc'],
        ])
        ->pluck('role_id')
        ->toJson();

    $desc = $users
        ->sortByDesc([
            ['role_id', 'desc'],
            ['id', 'desc'],
        ])
        ->pluck('role_id')
        ->toJson();

    dd(
        'asc' => $asc,   // "[4,4,3,3,2,2,1,1]" expecting 1,1,2,2,3,3,4,4
        'desc' => $desc, // "[4,2,3,1,4,3,2,1]" expecting 4,4,3,3,2,2,1,1
    );
});

[liamduckett]

Hey, I think this goes quite deep:

I'm using PHP 8.4.4 on Laravel Sail v1.41.0

enum Role: int
{
    case Administrator = 1;
    case Moderator = 2;
    case SuperMember = 3;
    case Member = 4;
}

Route::get('/test2', function () {
    $array = [
        Role::Administrator,
        Role::Moderator,
        Role::SuperMember,
        Role::Member,
    ];

    asort($array);

    var_dump($array);

    // array(4) { 
    //  [2]=> enum(Role::SuperMember) 
    //  [3]=> enum(Role::Member) 
    //  [0]=> enum(Role::Administrator) 
    //  [1]=> enum(Role::Moderator) 
    // } 
});

Interestingly this doesn't happen on a few PHP Playgrounds I tried (https://www.tehplayground.com and https://php-play.dev). They dump the expected result:

// array(4) { 
//   [0]=> enum(Role::Administrator) 
//   [1]=> enum(Role::Moderator) 
//   [2]=> enum(Role::SuperMember) 
//   [3]=> enum(Role::Member) 
// }

[liamduckett]

As a minimally intrusive workaround in the meantime:

    $asc = $users
        ->sortBy([
            [fn(array $a, array $b) => $a['role_id']->value <=> $b['role_id']->value],
            ['id', 'asc'],
        ])
        ->pluck('role_id')
        ->toJson();

    $desc = $users
        ->sortBy([
            [fn(array $a, array $b) => $b['role_id']->value <=> $a['role_id']->value], // note the swapping of $a and $b
            ['id', 'desc'],
        ])
        ->pluck('role_id')
        ->toJson();

    dd(
        $asc,  // [1,1,2,2,3,3,4,4]
        $desc, // [4,4,3,3,2,2,1,1]
    );
});

It's rather messy - didn't spend too much time on it, there is likely a better way.

[tommy66374]

Hey, I think this goes quite deep:

I'm using PHP 8.4.4 on Laravel Sail v1.41.0

enum Role: int
{
case Administrator = 1;
case Moderator = 2;
case SuperMember = 3;
case Member = 4;
}

Route::get('/test2', function () {
$array = [
Role::Administrator,
Role::Moderator,
Role::SuperMember,
Role::Member,
];

asort($array);

var_dump($array);

// array(4) { 
//  [2]=> enum(Role::SuperMember) 
//  [3]=> enum(Role::Member) 
//  [0]=> enum(Role::Administrator) 
//  [1]=> enum(Role::Moderator) 
// } 

});

I tested your code, if sort by single attribute, it return correct order, but if sort by multiple attributes, it return wrong order

array(4) { 
    [0]=> enum(Role::Administrator) 
    [1]=> enum(Role::Moderator) 
    [2]=> enum(Role::SuperMember) 
    [3]=> enum(Role::Member) 
}

[github-actions]

Thank you for reporting this issue!

As Laravel is an open source project, we rely on the community to help us diagnose and fix issues as it is not possible to research and fix every issue reported to us via GitHub.

If possible, please make a pull request fixing the issue you have described, along with corresponding tests. All pull requests are promptly reviewed by the Laravel team.

Thank you!

[tommy66374]

If i reading the ->sortBy() source code is correctly, with this syntax passing array

        ->sortBy([
            ['role_id', 'asc'],
            ['id', 'asc'],
        ]);

First call

framework/src/Illuminate/Collections/Collection.php

Line 1516 in 17786ca

return $this->sortByMany($callback, $options);

and then

framework/src/Illuminate/Collections/Collection.php

Line 1584 in 17786ca

default => $values[0] <=> $values[1],

OK, now the problem is Enum is not comparable!!! (php/php-src#12410)

open Tinker, always return 1

Role::Administrator <=> Role::Moderator // 1
Role::Moderator <=> Role::SuperMember   // 1
Role::SuperMember <=> Role::Member      // 1
Role::Member <=> Role::Administrator    // 1


// append ->value
Role::Administrator->value <=> Role::Member->value // -1
// swap
Role::Member->value <=> Role::Administrator->value // 1

[liamduckett]

Sorry, I should have been more detailed. I got to the conclusion of Enum comparisons being meaningless - but didn't find that PHP src PR - thanks!

I'm still surprised the order doesn't seem to be entirely consistent (I guess I'm still expecting it to be meaninglessly consistent if that makes sense).

I guess the framework could handle this, by converting any BackedEnum's to their scalar equivalents?

$values = [data_get($a, $prop), data_get($b, $prop)];

// Add this
// Untested...
$values = array_map(
  fn(mixed $value) => $value instanceof BackedEnum ? $value->value : $value,
  $values,
);

But to be honest I'm not a fan. The fact that PHP src has explicitly said this is "not planned" makes me think it should not be corrected - for better or for worse. It would lead to inconsistencies in "Laravel sorting" and "PHP sorting".

[tommy66374]

Problem solved

based on this line

framework/src/Illuminate/Collections/Collection.php

Line 1566 in 17786ca

$values = [data_get($a, $prop), data_get($b, $prop)];

use

        ->sortBy([
-           ['role_id', 'asc'],
+           ['role_id.value', 'asc'],
            ['id', 'asc'],
        ]);