ragflow/internal/admin/user_detail_test.go

//
//  Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
//

package admin

import (
	"encoding/json"
	"fmt"
	"math"
	"net/http"
	"net/http/httptest"
	"testing"
	"time"

	"ragflow/internal/common"
	"ragflow/internal/dao"
	"ragflow/internal/entity"
	"ragflow/internal/ingestion/testutil"

	"github.com/gin-gonic/gin"
)

type adminTestResponse struct {
	Code  int             `json:"code"`
	Data  json.RawMessage `json:"data"`
	Total *int64          `json:"total"`
}

var adminUserDetailTestModels = []any{&entity.User{}}

func TestListUsersReturnsTotalForEachPage(t *testing.T) {
	handler := setupAdminUserDetailTest(t)
	for i := 0; i < 11; i++ {
		user := entity.User{ID: fmt.Sprintf("user-%02d", i), Email: fmt.Sprintf("user-%02d@example.com", i), Nickname: "User", IsActive: "1"}
		if err := dao.DB.Create(&user).Error; err != nil {
			t.Fatal(err)
		}
	}
	for _, tt := range []struct {
		query string
		want  int
	}{
		{"", 12},
		{"?page=1&page_size=10", 10},
		{"?page=2&page_size=10", 2},
		{"?page=3&page_size=10", 0},
	} {
		t.Run(tt.query, func(t *testing.T) {
			recorder := httptest.NewRecorder()
			ctx, _ := gin.CreateTestContext(recorder)
			ctx.Request = httptest.NewRequest(http.MethodGet, "/api/v1/admin/users"+tt.query, nil)
			handler.ListUsers(ctx)
			var response adminTestResponse
			if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
				t.Fatal(err)
			}
			var users []map[string]interface{}
			if err := json.Unmarshal(response.Data, &users); err != nil {
				t.Fatal(err)
			}
			if recorder.Code != http.StatusOK || response.Code != int(common.CodeSuccess) || response.Total == nil || *response.Total != 12 || len(users) != tt.want {
				t.Fatalf("unexpected response: %s", recorder.Body.String())
			}
		})
	}
	if err := dao.DB.Where("id <> ?", "").Delete(&entity.User{}).Error; err != nil {
		t.Fatal(err)
	}
	recorder := httptest.NewRecorder()
	ctx, _ := gin.CreateTestContext(recorder)
	ctx.Request = httptest.NewRequest(http.MethodGet, "/api/v1/admin/users", nil)
	handler.ListUsers(ctx)
	var response adminTestResponse
	if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
		t.Fatal(err)
	}
	if response.Total == nil || *response.Total != 0 {
		t.Fatalf("empty list missing total: %s", recorder.Body.String())
	}
}

func TestListUsersQueryParameters(t *testing.T) {
	handler := setupAdminUserDetailTest(t)
	type queryTest struct {
		query string
		code  common.ErrorCode
		total int64
	}
	tests := []queryTest{
		{"?keyword=USER&status=active&order=create_time&sort=asc", common.CodeSuccess, 1},
		{"?keyword=missing", common.CodeSuccess, 0},
		{"?status=unknown", common.CodeBadRequest, 0},
		{"?order=password", common.CodeBadRequest, 0},
		{"?order=email", common.CodeBadRequest, 0},
		{"?order=nickname", common.CodeBadRequest, 0},
		{"?order=is_active", common.CodeBadRequest, 0},
		{"?order=is_superuser", common.CodeBadRequest, 0},
		{"?order=id", common.CodeBadRequest, 0},
		{"?order=create_date", common.CodeBadRequest, 0},
		{"?sort=unknown", common.CodeBadRequest, 0},
		{"?top=5&page=1", common.CodeBadRequest, 0},
		{"?top=5&page_size=10", common.CodeBadRequest, 0},
		{"?top=5&page=", common.CodeBadRequest, 0},
		{"?top=0", common.CodeBadRequest, 0},
		{"?page=0", common.CodeBadRequest, 0},
		{"?page_size=0", common.CodeBadRequest, 0},
		{fmt.Sprintf("?page=%d&page_size=10", math.MaxInt), common.CodeBadRequest, 0},
		{fmt.Sprintf("?page=%d&page_size=4", math.MaxInt/2+2), common.CodeBadRequest, 0},
		{fmt.Sprintf("?page=%d&page_size=4", math.MaxInt/2+3), common.CodeBadRequest, 0},
	}
	if common.GetRAGFlowType() == common.OpenSourceVersion {
		tests = append(tests, queryTest{"?status=inactive", common.CodeSuccess, 0})
	}
	for _, tt := range tests {
		t.Run(tt.query, func(t *testing.T) {
			recorder := httptest.NewRecorder()
			ctx, _ := gin.CreateTestContext(recorder)
			ctx.Request = httptest.NewRequest(http.MethodGet, "/api/v1/admin/users"+tt.query, nil)
			handler.ListUsers(ctx)
			var response adminTestResponse
			if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
				t.Fatal(err)
			}
			if response.Code != int(tt.code) || (tt.code == common.CodeSuccess && (response.Total == nil || *response.Total != tt.total)) {
				t.Fatalf("unexpected response: %s", recorder.Body.String())
			}
		})
	}
}

func TestListUsersAcceptsSharedClientParameters(t *testing.T) {
	if common.GetRAGFlowType() != common.OpenSourceVersion {
		t.Skip("enterprise filters are exercised by enterprise user-list tests")
	}
	handler := setupAdminUserDetailTest(t)
	for _, user := range []entity.User{
		{ID: "shared-active", Email: "second@example.com", Nickname: "User Two", IsActive: "1"},
		{ID: "shared-inactive", Email: "other@example.com", Nickname: "Other", IsActive: "0"},
	} {
		if err := dao.DB.Create(&user).Error; err != nil {
			t.Fatal(err)
		}
	}
	for _, tt := range []struct {
		query string
		total int64
		count int
	}{
		{"?keyword=User&status=active&role=Reader&plan=Pro&quota=0&days=30&order=create_time&sort=asc&page=1&page_size=1", 2, 1},
		{"?keyword=User&status=active&role=Reader&plan=Pro&quota=80&days=30&order=create_time&sort=asc", 2, 2},
		{"?keyword=missing&role=Reader&plan=Pro&quota=0", 0, 0},
		{"?status=inactive&plan=Pro&days=30", 1, 1},
	} {
		t.Run(tt.query, func(t *testing.T) {
			recorder := httptest.NewRecorder()
			ctx, _ := gin.CreateTestContext(recorder)
			ctx.Request = httptest.NewRequest(http.MethodGet, "/api/v1/admin/users"+tt.query, nil)
			handler.ListUsers(ctx)
			var response adminTestResponse
			if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
				t.Fatal(err)
			}
			var users []map[string]interface{}
			if err := json.Unmarshal(response.Data, &users); err != nil {
				t.Fatalf("invalid user data: %s, error: %v", recorder.Body.String(), err)
			}
			if response.Code != int(common.CodeSuccess) || response.Total == nil || *response.Total != tt.total || len(users) != tt.count {
				t.Fatalf("unexpected response: %s", recorder.Body.String())
			}
		})
	}
}

// The admin UI requests the user list without page/page_size and slices it
// client-side, so an omitted page_size must keep returning every user.
func TestListUsersWithoutPaginationReturnsEveryUser(t *testing.T) {
	handler := setupAdminUserDetailTest(t)
	for i := 0; i < 11; i++ {
		user := entity.User{
			ID:       fmt.Sprintf("user-%02d", i),
			Email:    fmt.Sprintf("user-%02d@example.com", i),
			Nickname: "User",
			IsActive: "1",
		}
		if err := dao.DB.Create(&user).Error; err != nil {
			t.Fatal(err)
		}
	}

	recorder := httptest.NewRecorder()
	ctx, _ := gin.CreateTestContext(recorder)
	ctx.Request = httptest.NewRequest(http.MethodGet, "/api/v1/admin/users", nil)
	handler.ListUsers(ctx)

	var response adminTestResponse
	if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
		t.Fatal(err)
	}
	var users []map[string]interface{}
	if err := json.Unmarshal(response.Data, &users); err != nil {
		t.Fatal(err)
	}
	if response.Total == nil || *response.Total != 12 || len(users) != 12 {
		t.Fatalf("unpaged list returned %d users (total %v), want 12; body = %s", len(users), response.Total, recorder.Body.String())
	}
}

// When an explicit page is requested without page_size, pagination must be
// preserved using the standard default page size (common.DefaultPageSize).
func TestListUsersWithPageOnlyPreservesPagination(t *testing.T) {
	handler := setupAdminUserDetailTest(t)
	for i := 0; i < 31; i++ {
		user := entity.User{
			ID:       fmt.Sprintf("user-%02d", i),
			Email:    fmt.Sprintf("user-%02d@example.com", i),
			Nickname: "User",
			IsActive: "1",
		}
		if err := dao.DB.Create(&user).Error; err != nil {
			t.Fatal(err)
		}
	}

	recorder := httptest.NewRecorder()
	ctx, _ := gin.CreateTestContext(recorder)
	ctx.Request = httptest.NewRequest(http.MethodGet, "/api/v1/admin/users?page=2", nil)
	handler.ListUsers(ctx)

	var response adminTestResponse
	if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
		t.Fatal(err)
	}
	var users []map[string]interface{}
	if err := json.Unmarshal(response.Data, &users); err != nil {
		t.Fatal(err)
	}
	if response.Total == nil || *response.Total != 32 || len(users) != 2 {
		t.Fatalf("page=2 without page_size returned %d users (total %v), want 2; body = %s", len(users), response.Total, recorder.Body.String())
	}
}

// When explicit page and page_size are supplied, pagination must be preserved.
func TestListUsersWithExplicitPagination(t *testing.T) {
	handler := setupAdminUserDetailTest(t)
	for i := 0; i < 11; i++ {
		user := entity.User{
			ID:       fmt.Sprintf("user-%02d", i),
			Email:    fmt.Sprintf("user-%02d@example.com", i),
			Nickname: "User",
			IsActive: "1",
		}
		if err := dao.DB.Create(&user).Error; err != nil {
			t.Fatal(err)
		}
	}

	recorder := httptest.NewRecorder()
	ctx, _ := gin.CreateTestContext(recorder)
	ctx.Request = httptest.NewRequest(http.MethodGet, "/api/v1/admin/users?page=2&page_size=10", nil)
	handler.ListUsers(ctx)

	var response adminTestResponse
	if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
		t.Fatal(err)
	}
	var users []map[string]interface{}
	if err := json.Unmarshal(response.Data, &users); err != nil {
		t.Fatal(err)
	}
	if response.Total == nil || *response.Total != 12 || len(users) != 2 {
		t.Fatalf("page=2&page_size=10 returned %d users (total %v), want 2; body = %s", len(users), response.Total, recorder.Body.String())
	}
}

func setupAdminUserDetailTest(t *testing.T) *Handler {
	t.Helper()
	db := testutil.SetupTestDB(t, adminUserDetailTestModels...)
	t.Cleanup(testutil.ReplaceDBForTest(t, db))

	now := time.Date(2026, time.September, 16, 12, 0, 0, 0, time.UTC)
	createdAt := now.UnixMilli()
	isSuperuser := false
	statusValid := string(entity.StatusValid)
	language := "English"
	loginChannel := "password"
	user := entity.User{
		ID:              "user-1",
		Nickname:        "User One",
		Email:           "user@example.com",
		Language:        &language,
		IsAuthenticated: "1",
		IsActive:        "1",
		IsAnonymous:     "0",
		LoginChannel:    &loginChannel,
		Status:          &statusValid,
		IsSuperuser:     &isSuperuser,
		BaseModel:       entity.BaseModel{CreateTime: &createdAt, CreateDate: &now, UpdateDate: &now},
	}
	if err := db.Create(&user).Error; err != nil {
		t.Fatalf("create user: %v", err)
	}

	return NewHandler(NewService())
}

func callAdminUserHandler(t *testing.T, handler func(*gin.Context)) adminTestResponse {
	t.Helper()
	recorder := httptest.NewRecorder()
	ctx, _ := gin.CreateTestContext(recorder)
	ctx.Params = gin.Params{{Key: "username", Value: "user@example.com"}}
	ctx.Request = httptest.NewRequest(http.MethodGet, "/", nil)
	handler(ctx)

	var response adminTestResponse
	if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
		t.Fatalf("decode response: %v", err)
	}
	if response.Code != int(common.CodeSuccess) {
		t.Fatalf("response code = %d, want %d; body = %s", response.Code, common.CodeSuccess, recorder.Body.String())
	}
	return response
}

func TestGetUserReturnsDetailList(t *testing.T) {
	gin.SetMode(gin.TestMode)
	handler := setupAdminUserDetailTest(t)
	response := callAdminUserHandler(t, handler.GetUser)

	var details []struct {
		Email       string `json:"email"`
		IsActive    string `json:"is_active"`
		CreateDate  string `json:"create_date"`
		IsAnonymous string `json:"is_anonymous"`
	}
	if err := json.Unmarshal(response.Data, &details); err != nil {
		t.Fatalf("decode user details: %v", err)
	}
	if len(details) != 1 {
		t.Fatalf("user details length = %d, want 1", len(details))
	}
	if details[0].Email != "user@example.com" || details[0].IsActive != "1" || details[0].CreateDate == "" || details[0].IsAnonymous != "0" {
		t.Fatalf("unexpected user details: %+v", details[0])
	}
}