mirrors/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2025-08-25 19:53:49 +00:00
Code Issues Projects Releases Packages Wiki Activity

feat: add sort parameter for users/search api endpoint (#8594)

Browse source 
Introduces a new sort parameter to the `/users/search` API endpoint, similar to the one that already exists for the `/admin/users` endpoint.

Resolves #8499

Co-authored-by: DebuggerAndrzej <redpandaworkstation@gmail.com>
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8594
Reviewed-by: Lucas <sclu1034@noreply.codeberg.org>
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: DebuggerAndrzej <debuggerandrzej@noreply.codeberg.org>
Co-committed-by: DebuggerAndrzej <debuggerandrzej@noreply.codeberg.org>
This commit is contained in:
DebuggerAndrzej 2025-07-24 22:40:27 +02:00 • committed by Gusted
commit f4894b0edd
5 changed files with 114 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

65
tests/integration/api_user_search_test.go
View file

@ -4,18 +4,25 @@
package integration
import (
"context"
"fmt"
"net/http"
"strconv"
"testing"
"time"
auth_model "forgejo.org/models/auth"
"forgejo.org/models/db"
"forgejo.org/models/unittest"
user_model "forgejo.org/models/user"
"forgejo.org/modules/setting"
api "forgejo.org/modules/structs"
"forgejo.org/modules/test"
"forgejo.org/modules/timeutil"
"forgejo.org/tests"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
type SearchResults struct {
@ -179,3 +186,61 @@ func TestAPIUserSearchByEmail(t *testing.T) {
assert.Len(t, results.Data, 1)
assert.Equal(t, query, results.Data[0].Email)
}
func TestUsersSearchSorted(t *testing.T) {
defer tests.PrepareTestEnv(t)()
createTimestamp := time.Now().Unix() - 1000
updateTimestamp := time.Now().Unix() - 500
sess := db.GetEngine(context.Background())
for i := int64(1); i <= 10; i++ {
name := "sorttest" + strconv.Itoa(int(i))
user := &user_model.User{
Name: name,
LowerName: name,
LoginName: name,
Email: name + "@example.com",
Passwd: name + ".password",
Avatar: "xyz",
Type: user_model.UserTypeIndividual,
LoginType: auth_model.OAuth2,
CreatedUnix: timeutil.TimeStamp(createTimestamp - i),
UpdatedUnix: timeutil.TimeStamp(updateTimestamp - i),
}
_, err := sess.NoAutoTime().Insert(user)
require.NoError(t, err)
}
session := loginUser(t, "user1")
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadUser)
testCases := []struct {
sortType string
expectedUsers []string
}{
{"alphabetically", []string{"sorttest1", "sorttest10", "sorttest2", "sorttest3"}},
{"reversealphabetically", []string{"sorttest9", "sorttest8", "sorttest7", "sorttest6"}},
{"newest", []string{"sorttest1", "sorttest2", "sorttest3", "sorttest4"}},
{"oldest", []string{"sorttest10", "sorttest9", "sorttest8", "sorttest7"}},
{"recentupdate", []string{"sorttest1", "sorttest2", "sorttest3", "sorttest4"}},
{"leastupdate", []string{"sorttest10", "sorttest9", "sorttest8", "sorttest7"}},
}
for _, testCase := range testCases {
req := NewRequest(
t,
"GET",
fmt.Sprintf("/api/v1/users/search?q=sorttest&sort=%s&limit=4",
testCase.sortType,
),
).AddTokenAuth(token)
resp := session.MakeRequest(t, req, http.StatusOK)
var results SearchResults
DecodeJSON(t, resp, &results)
assert.Len(t, results.Data, 4)
for i, searchData := range results.Data {
assert.Equalf(t, testCase.expectedUsers[i], searchData.UserName, "Sort type: %s, index %d", testCase.sortType, i)
}
}
}