feat: sort users by username

coder · mtojek · Jun 6, 2023 · Jun 5, 2023 · Jun 5, 2023 · Jun 5, 2023
commit 1358d816b19271b90858d7a19eabed95e649e31e
diff --git a/coderd/database/dbfake/databasefake.go b/coderd/database/dbfake/databasefake.go
@@ -931,14 +931,9 @@ func (q *fakeQuerier) GetUsers(_ context.Context, params database.GetUsersParams
 	users := make([]database.User, len(q.users))
 	copy(users, q.users)
 
-	// Database orders by created_at
+	// Database orders by username
 	slices.SortFunc(users, func(a, b database.User) bool {
-		if a.CreatedAt.Equal(b.CreatedAt) {
-			// Technically the postgres database also orders by uuid. So match
-			// that behavior
-			return a.ID.String() < b.ID.String()
-		}
-		return a.CreatedAt.Before(b.CreatedAt)
+		return sort.StringsAreSorted([]string{a.Username, b.Username})
 	})
 
 	// Filter out deleted since they should never be returned..

diff --git a/coderd/database/dbfake/databasefake_test.go b/coderd/database/dbfake/databasefake_test.go
@@ -5,6 +5,7 @@ import (
 	"database/sql"
 	"fmt"
 	"reflect"
+	"sort"
 	"testing"
 	"time"
 
@@ -106,26 +107,25 @@ func TestExactMethods(t *testing.T) {
 	}
 }
 
-// TestUserOrder ensures that the fake database returns users in the order they
-// were created.
+// TestUserOrder ensures that the fake database returns users sorted by username.
 func TestUserOrder(t *testing.T) {
 	t.Parallel()
 
 	db := dbfake.New()
 	now := database.Now()
-	count := 10
-	for i := 0; i < count; i++ {
-		dbgen.User(t, db, database.User{
-			Username:  fmt.Sprintf("user%d", i),
-			CreatedAt: now,
-		})
+
+	usernames := []string{"b-user", "d-user", "a-user", "c-user", "e-user"}
+	for _, username := range usernames {
+		dbgen.User(t, db, database.User{Username: username, CreatedAt: now})
 	}
 
 	users, err := db.GetUsers(context.Background(), database.GetUsersParams{})
 	require.NoError(t, err)
-	require.Lenf(t, users, count, "expected %d users", count)
+	require.Lenf(t, users, len(usernames), "expected %d users", len(usernames))
+
+	sort.Strings(usernames)
 	for i, user := range users {
-		require.Equal(t, fmt.Sprintf("user%d", i), user.Username)
+		require.Equal(t, usernames[i], user.Username)
 	}
 }
 

diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/users.sql b/coderd/database/queries/users.sql
@@ -183,9 +183,8 @@ WHERE
 	END
 	-- End of filters
 ORDER BY
-	-- Deterministic and consistent ordering of all users, even if they share
-	-- a timestamp. This is to ensure consistent pagination.
-	(created_at, id) ASC OFFSET @offset_opt
+	-- Deterministic and consistent ordering of all users. This is to ensure consistent pagination.
+	username ASC OFFSET @offset_opt
 LIMIT
 	-- A null limit means "no limit", so 0 means return all
 	NULLIF(@limit_opt :: int, 0);