feat(users): add users error message

Author: LinkinStars

i18n/en_US.yaml

@@ -251,6 +251,10 @@ backend:
         other: Access denied
       page_access_denied:
         other: You do not have access to this page.
+      add_bulk_users_format_error:
+        other: "Error {{.Field}} format near '{{.Content}}' at line {{.Line}}. {{.ExtraMessage}}"
+      add_bulk_users_amount_error:
+        other: "The number of users you add at once should be in the range of 1-{{.MaxAmount}}."
     config:
       read_config_failed:
         other: Read config failed

internal/base/constant/constant.go

@@ -2,6 +2,7 @@ package constant
 
 const (
 	DefaultPageSize = 20 // Default number of pages
+	DefaultBulkUser = 5000
 )
 
 var (

internal/base/reason/reason.go

@@ -76,6 +76,9 @@ const (
 	AdminCannotModifySelfStatus      = "error.admin.cannot_modify_self_status"
 	UserAccessDenied                 = "error.user.access_denied"
 	UserPageAccessDenied             = "error.user.page_access_denied"
+
+	AddBulkUsersFormatError = "error.user.add_bulk_users_format_error"
+	AddBulkUsersAmountError = "error.user.add_bulk_users_amount_error"
 )
 
 // user external login reasons

internal/controller_admin/user_backyard_controller.go

@@ -107,8 +107,8 @@ func (uc *UserAdminController) AddUsers(ctx *gin.Context) {
 		return
 	}
 
-	err := uc.userService.AddUsers(ctx, req)
-	handler.HandleResponse(ctx, err, nil)
+	resp, err := uc.userService.AddUsers(ctx, req)
+	handler.HandleResponse(ctx, err, resp)
 }
 
 // UpdateUserPassword update user password

internal/schema/backyard_user_schema.go

@@ -2,8 +2,12 @@ package schema
 
 import (
 	"context"
-	"fmt"
 	"github.com/answerdev/answer/internal/base/constant"
+	"github.com/answerdev/answer/internal/base/handler"
+	"github.com/answerdev/answer/internal/base/reason"
+	"github.com/answerdev/answer/internal/base/translator"
+	"github.com/answerdev/answer/internal/base/validator"
+	"github.com/segmentfault/pacman/errors"
 	"strings"
 )
 
@@ -99,22 +103,60 @@ type AddUsersReq struct {
 	Users    []*AddUserReq `json:"-"`
 }
 
-func (req *AddUsersReq) ParseUsers(ctx context.Context) error {
+type AddUsersErrorData struct {
+	// optional. error field name.
+	Field string `json:"field"`
+	// must. error line number.
+	Line int `json:"line"`
+	// must. error content.
+	Content string `json:"content"`
+	// optional. error message.
+	ExtraMessage string `json:"extra_message"`
+}
+
+func (e *AddUsersErrorData) SetErrField(errFields []*validator.FormErrorField) {
+	if len(errFields) > 0 {
+		e.Field = errFields[0].ErrorField
+		e.ExtraMessage = errFields[0].ErrorMsg
+	}
+}
+
+func (req *AddUsersReq) ParseUsers(ctx context.Context) (errFields []*validator.FormErrorField, err error) {
 	req.UsersStr = strings.TrimSpace(req.UsersStr)
 	lines := strings.Split(req.UsersStr, "\n")
 	req.Users = make([]*AddUserReq, 0)
 	for i, line := range lines {
 		arr := strings.Split(line, ",")
 		if len(arr) != 3 {
-			return fmt.Errorf("error format at line %d", i)
+			errFields = append([]*validator.FormErrorField{}, &validator.FormErrorField{
+				ErrorField: "users",
+				ErrorMsg: translator.TrWithData(handler.GetLangByCtx(ctx), reason.AddBulkUsersFormatError,
+					&AddUsersErrorData{
+						Line:    i + 1,
+						Content: line,
+					}),
+			})
+			return errFields, errors.BadRequest(reason.RequestFormatError)
 		}
 		req.Users = append(req.Users, &AddUserReq{
-			DisplayName: arr[0],
-			Email:       arr[1],
-			Password:    arr[2],
+			DisplayName: strings.TrimSpace(arr[0]),
+			Email:       strings.TrimSpace(arr[1]),
+			Password:    strings.TrimSpace(arr[2]),
+		})
+	}
+
+	// check users amount
+	if len(req.Users) <= 0 || len(req.Users) > constant.DefaultBulkUser {
+		errFields = append([]*validator.FormErrorField{}, &validator.FormErrorField{
+			ErrorField: "users",
+			ErrorMsg: translator.TrWithData(handler.GetLangByCtx(ctx), reason.AddBulkUsersAmountError,
+				map[string]int{
+					"MaxAmount": constant.DefaultBulkUser,
+				}),
 		})
+		return errFields, errors.BadRequest(reason.RequestFormatError)
 	}
-	return nil
+	return nil, nil
 }
 
 // UpdateUserPasswordReq update user password request

internal/service/user_admin/user_backyard.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"github.com/answerdev/answer/internal/base/constant"
 	"github.com/answerdev/answer/internal/base/handler"
+	"github.com/answerdev/answer/internal/base/translator"
 	"github.com/answerdev/answer/internal/base/validator"
 	"github.com/answerdev/answer/internal/service/export"
 	"github.com/google/uuid"
@@ -169,40 +170,44 @@ func (us *UserAdminService) AddUser(ctx context.Context, req *schema.AddUserReq)
 }
 
 // AddUsers add users
-func (us *UserAdminService) AddUsers(ctx context.Context, req *schema.AddUsersReq) (err error) {
-	err = req.ParseUsers(ctx)
+func (us *UserAdminService) AddUsers(ctx context.Context, req *schema.AddUsersReq) (
+	resp []*validator.FormErrorField, err error) {
+	resp, err = req.ParseUsers(ctx)
 	if err != nil {
-		return errors.BadRequest(reason.RequestFormatError).WithMsg(err.Error())
+		return resp, err
 	}
-	if len(req.Users) == 0 {
-		return errors.BadRequest(reason.RequestFormatError).WithMsg("not found any user")
-	}
-	if len(req.Users) > 5000 {
-		return errors.BadRequest(reason.RequestFormatError).WithMsg("Add up to 5000 users at one time")
-	}
-	users, err := us.formatBulkAddUsers(ctx, req)
+
+	users, resp, err := us.formatBulkAddUsers(ctx, req)
 	if err != nil {
-		return err
+		return resp, err
 	}
-	return us.userRepo.AddUsers(ctx, users)
+	err = us.userRepo.AddUsers(ctx, users)
+	return nil, err
 }
 
 func (us *UserAdminService) formatBulkAddUsers(ctx context.Context, req *schema.AddUsersReq) (
-	users []*entity.User, err error) {
-
-	val := validator.GetValidatorByLang(handler.GetLangByCtx(ctx))
-	for _, user := range req.Users {
-		_, err = val.Check(user)
-		if err != nil {
-			return nil, err
+	users []*entity.User, errFields []*validator.FormErrorField, err error) {
+	lang := handler.GetLangByCtx(ctx)
+	val := validator.GetValidatorByLang(lang)
+	errorData := &schema.AddUsersErrorData{Line: -1}
+	for line, user := range req.Users {
+		if fields, e := val.Check(user); e != nil {
+			errorData.SetErrField(fields)
+			errorData.Line = line + 1
+			errorData.Content = fmt.Sprintf("%s, %s", user.DisplayName, user.Email)
+			break
 		}
 
-		_, has, err := us.userRepo.GetUserInfoByEmail(ctx, user.Email)
-		if err != nil {
-			return nil, err
+		_, has, e := us.userRepo.GetUserInfoByEmail(ctx, user.Email)
+		if e != nil {
+			return nil, nil, e
 		}
 		if has {
-			return nil, errors.BadRequest(reason.EmailDuplicate)
+			errorData.Field = "email"
+			errorData.Line = line + 1
+			errorData.Content = user.Email
+			errorData.ExtraMessage = translator.Tr(lang, reason.EmailDuplicate)
+			break
 		}
 
 		userInfo := &entity.User{}
@@ -212,14 +217,26 @@ func (us *UserAdminService) formatBulkAddUsers(ctx context.Context, req *schema.
 		userInfo.Pass = string(hashPwd)
 		userInfo.Username, err = us.userCommonService.MakeUsername(ctx, userInfo.DisplayName)
 		if err != nil {
-			return nil, err
+			errorData.Field = "display_name"
+			errorData.Line = line + 1
+			errorData.Content = user.DisplayName
+			errorData.ExtraMessage = translator.Tr(lang, reason.UsernameInvalid)
+			break
 		}
 		userInfo.MailStatus = entity.EmailStatusAvailable
 		userInfo.Status = entity.UserStatusAvailable
 		userInfo.Rank = 1
 		users = append(users, userInfo)
 	}
-	return users, nil
+
+	if errorData.Line != -1 {
+		errFields = append([]*validator.FormErrorField{}, &validator.FormErrorField{
+			ErrorField: "users",
+			ErrorMsg:   translator.TrWithData(handler.GetLangByCtx(ctx), reason.AddBulkUsersFormatError, errorData),
+		})
+		return nil, errFields, errors.BadRequest(reason.RequestFormatError)
+	}
+	return users, nil, nil
 }
 
 // UpdateUserPassword update user password