feat: list users order by

Author: mabdh

Makefile

@@ -2,7 +2,7 @@ GOVERSION := $(shell go version | cut -d ' ' -f 3 | cut -d '.' -f 2)
 
 .PHONY: build check fmt lint test test-race vet test-cover-html help install proto
 .DEFAULT_GOAL := build
-PROTON_COMMIT := "7e380e055d82cd8378989354785f6434d8615d70"
+PROTON_COMMIT := "0a8041a647ed5e6e0a88ad2f576430b5d6ffb38f"
 
 install:
 	@echo "Clean up imports..."

core/user/filter.go

@@ -4,4 +4,6 @@ type Filter struct {
 	Limit   int32
 	Page    int32
 	Keyword string
+	SortBy  string
+	OrderBy string
 }

internal/api/v1beta1/user.go

@@ -43,6 +43,8 @@ func (h Handler) ListUsers(ctx context.Context, request *shieldv1beta1.ListUsers
 		Limit:   request.GetPageSize(),
 		Page:    request.GetPageNum(),
 		Keyword: request.GetKeyword(),
+		SortBy:  request.GetSort(),
+		OrderBy: request.GetOrder(),
 	})
 	if err != nil {
 		logger.Error(err.Error())

internal/store/postgres/user_repository.go

@@ -7,10 +7,12 @@ import (
 	"errors"
 	"fmt"
 	"regexp"
+	"slices"
 	"strings"
 	"time"
 
 	"github.com/doug-martin/goqu/v9"
+	"github.com/doug-martin/goqu/v9/exp"
 	"github.com/jmoiron/sqlx"
 	newrelic "github.com/newrelic/go-agent"
 
@@ -19,6 +21,10 @@ import (
 	"github.com/goto/shield/pkg/uuid"
 )
 
+var (
+	allowedListUsersSortByColumns = []string{"created_at", "updated_at", "email", "name"}
+)
+
 type UserRepository struct {
 	dbc *db.Client
 }
@@ -276,24 +282,51 @@ func (r UserRepository) List(ctx context.Context, flt user.Filter) ([]user.User,
 		flt.Page = defaultPage
 	}
 
+	var (
+		orderExpr     exp.OrderedExpression
+		orderedColumn = goqu.C("id")
+	)
+
+	if slices.Contains(allowedListUsersSortByColumns, flt.SortBy) {
+		orderedColumn = goqu.C(flt.SortBy)
+	}
+
+	if flt.OrderBy == "desc" {
+		orderExpr = orderedColumn.Desc()
+	} else {
+		orderExpr = orderedColumn.Asc()
+	}
+
 	offset := (flt.Page - 1) * flt.Limit
 
 	query, params, err := dialect.From(TABLE_USERS).LeftOuterJoin(
 		goqu.T(TABLE_METADATA),
-		goqu.On(goqu.Ex{"users.id": goqu.I("metadata.user_id")})).Select("users.id", "name", "email", "key", "value", "users.created_at", "users.updated_at").Where(
-		goqu.I("users.email").In(
-			goqu.From("users").
-				Select(goqu.DISTINCT("email")).
-				Where(
-					goqu.Or(
-						goqu.C("name").ILike(fmt.Sprintf("%%%s%%", flt.Keyword)),
-						goqu.C("email").ILike(fmt.Sprintf("%%%s%%", flt.Keyword)),
-					),
-				).
-				Limit(uint(flt.Limit)).
-				Offset(uint(offset)),
-		),
-	).ToSQL()
+		goqu.On(goqu.Ex{"users.id": goqu.I("metadata.user_id")})).
+		Select(
+			goqu.L("users.id").As("id"),
+			"name",
+			"email",
+			"key",
+			"value",
+			goqu.L("users.created_at").As("created_at"),
+			goqu.L("users.updated_at").As("updated_at"),
+		).
+		Where(
+			goqu.I("users.email").In(
+				goqu.From("users").
+					Select(goqu.DISTINCT("email")).
+					Where(
+						goqu.Or(
+							goqu.C("name").ILike(fmt.Sprintf("%%%s%%", flt.Keyword)),
+							goqu.C("email").ILike(fmt.Sprintf("%%%s%%", flt.Keyword)),
+						),
+					).
+					Limit(uint(flt.Limit)).
+					Offset(uint(offset)),
+			),
+		).
+		Order(orderExpr).
+		ToSQL()
 	if err != nil {
 		return []user.User{}, fmt.Errorf("%w: %s", queryErr, err)
 	}

proto/shield.swagger.yaml

@@ -841,6 +841,14 @@ paths:
           in: query
           required: false
           type: string
+        - name: sort
+          in: query
+          required: false
+          type: string
+        - name: order
+          in: query
+          required: false
+          type: string
       tags:
         - User
     post: