[refactor] Unify the export of user data via API (#15144)

* [refactor] unify how user data is exported via API

* test time via unix timestamp

Author: 6543

integrations/api_issue_reaction_test.go

@@ -61,7 +61,7 @@ func TestAPIIssuesReactions(t *testing.T) {
 	DecodeJSON(t, resp, &apiReactions)
 	expectResponse := make(map[int]api.Reaction)
 	expectResponse[0] = api.Reaction{
-		User:     convert.ToUser(user2, true, true),
+		User:     convert.ToUser(user2, user2),
 		Reaction: "eyes",
 		Created:  time.Unix(1573248003, 0),
 	}
@@ -121,12 +121,12 @@ func TestAPICommentReactions(t *testing.T) {
 	DecodeJSON(t, resp, &apiReactions)
 	expectResponse := make(map[int]api.Reaction)
 	expectResponse[0] = api.Reaction{
-		User:     convert.ToUser(user2, true, true),
+		User:     convert.ToUser(user2, user2),
 		Reaction: "laugh",
 		Created:  time.Unix(1573248004, 0),
 	}
 	expectResponse[1] = api.Reaction{
-		User:     convert.ToUser(user1, true, true),
+		User:     convert.ToUser(user1, user1),
 		Reaction: "laugh",
 		Created:  time.Unix(1573248005, 0),
 	}

integrations/api_team_user_test.go

@@ -31,5 +31,13 @@ func TestAPITeamUser(t *testing.T) {
 	user2.Created = user2.Created.In(time.Local)
 	user := models.AssertExistsAndLoadBean(t, &models.User{Name: "user2"}).(*models.User)
 
-	assert.Equal(t, convert.ToUser(user, true, false), user2)
+	expectedUser := convert.ToUser(user, user)
+
+	// test time via unix timestamp
+	assert.EqualValues(t, expectedUser.LastLogin.Unix(), user2.LastLogin.Unix())
+	assert.EqualValues(t, expectedUser.Created.Unix(), user2.Created.Unix())
+	expectedUser.LastLogin = user2.LastLogin
+	expectedUser.Created = user2.Created
+
+	assert.Equal(t, expectedUser, user2)
 }

modules/convert/git_commit.go

@@ -86,13 +86,13 @@ func ToCommit(repo *models.Repository, commit *git.Commit, userCache map[string]
 	}
 
 	if ok {
-		apiAuthor = ToUser(cacheAuthor, false, false)
+		apiAuthor = ToUser(cacheAuthor, nil)
 	} else {
 		author, err := models.GetUserByEmail(commit.Author.Email)
 		if err != nil && !models.IsErrUserNotExist(err) {
 			return nil, err
 		} else if err == nil {
-			apiAuthor = ToUser(author, false, false)
+			apiAuthor = ToUser(author, nil)
 			if userCache != nil {
 				userCache[commit.Author.Email] = author
 			}
@@ -108,13 +108,13 @@ func ToCommit(repo *models.Repository, commit *git.Commit, userCache map[string]
 	}
 
 	if ok {
-		apiCommitter = ToUser(cacheCommitter, false, false)
+		apiCommitter = ToUser(cacheCommitter, nil)
 	} else {
 		committer, err := models.GetUserByEmail(commit.Committer.Email)
 		if err != nil && !models.IsErrUserNotExist(err) {
 			return nil, err
 		} else if err == nil {
-			apiCommitter = ToUser(committer, false, false)
+			apiCommitter = ToUser(committer, nil)
 			if userCache != nil {
 				userCache[commit.Committer.Email] = committer
 			}

modules/convert/issue.go

@@ -31,7 +31,7 @@ func ToAPIIssue(issue *models.Issue) *api.Issue {
 		URL:      issue.APIURL(),
 		HTMLURL:  issue.HTMLURL(),
 		Index:    issue.Index,
-		Poster:   ToUser(issue.Poster, false, false),
+		Poster:   ToUser(issue.Poster, nil),
 		Title:    issue.Title,
 		Body:     issue.Content,
 		Ref:      issue.Ref,
@@ -66,9 +66,9 @@ func ToAPIIssue(issue *models.Issue) *api.Issue {
 	}
 	if len(issue.Assignees) > 0 {
 		for _, assignee := range issue.Assignees {
-			apiIssue.Assignees = append(apiIssue.Assignees, ToUser(assignee, false, false))
+			apiIssue.Assignees = append(apiIssue.Assignees, ToUser(assignee, nil))
 		}
-		apiIssue.Assignee = ToUser(issue.Assignees[0], false, false) // For compatibility, we're keeping the first assignee as `apiIssue.Assignee`
+		apiIssue.Assignee = ToUser(issue.Assignees[0], nil) // For compatibility, we're keeping the first assignee as `apiIssue.Assignee`
 	}
 	if issue.IsPull {
 		if err := issue.LoadPullRequest(); err != nil {

modules/convert/issue_comment.go

@@ -13,7 +13,7 @@ import (
 func ToComment(c *models.Comment) *api.Comment {
 	return &api.Comment{
 		ID:       c.ID,
-		Poster:   ToUser(c.Poster, false, false),
+		Poster:   ToUser(c.Poster, nil),
 		HTMLURL:  c.HTMLURL(),
 		IssueURL: c.IssueURL(),
 		PRURL:    c.PRURL(),

modules/convert/pull.go

@@ -159,7 +159,7 @@ func ToAPIPullRequest(pr *models.PullRequest) *api.PullRequest {
 	if pr.HasMerged {
 		apiPullRequest.Merged = pr.MergedUnix.AsTimePtr()
 		apiPullRequest.MergedCommitID = &pr.MergedCommitID
-		apiPullRequest.MergedBy = ToUser(pr.Merger, false, false)
+		apiPullRequest.MergedBy = ToUser(pr.Merger, nil)
 	}
 
 	return apiPullRequest

modules/convert/pull_review.go

@@ -20,14 +20,9 @@ func ToPullReview(r *models.Review, doer *models.User) (*api.PullReview, error)
 		r.Reviewer = models.NewGhostUser()
 	}
 
-	auth := false
-	if doer != nil {
-		auth = doer.IsAdmin || doer.ID == r.ReviewerID
-	}
-
 	result := &api.PullReview{
 		ID:                r.ID,
-		Reviewer:          ToUser(r.Reviewer, doer != nil, auth),
+		Reviewer:          ToUser(r.Reviewer, doer),
 		ReviewerTeam:      ToTeam(r.ReviewerTeam),
 		State:             api.ReviewStateUnknown,
 		Body:              r.Content,
@@ -88,14 +83,10 @@ func ToPullReviewCommentList(review *models.Review, doer *models.User) ([]*api.P
 	for _, lines := range review.CodeComments {
 		for _, comments := range lines {
 			for _, comment := range comments {
-				auth := false
-				if doer != nil {
-					auth = doer.IsAdmin || doer.ID == comment.Poster.ID
-				}
 				apiComment := &api.PullReviewComment{
 					ID:           comment.ID,
 					Body:         comment.Content,
-					Reviewer:     ToUser(comment.Poster, doer != nil, auth),
+					Reviewer:     ToUser(comment.Poster, doer),
 					ReviewID:     review.ID,
 					Created:      comment.CreatedUnix.AsTime(),
 					Updated:      comment.UpdatedUnix.AsTime(),

modules/convert/release.go

@@ -29,7 +29,7 @@ func ToRelease(r *models.Release) *api.Release {
 		IsPrerelease: r.IsPrerelease,
 		CreatedAt:    r.CreatedUnix.AsTime(),
 		PublishedAt:  r.CreatedUnix.AsTime(),
-		Publisher:    ToUser(r.Publisher, false, false),
+		Publisher:    ToUser(r.Publisher, nil),
 		Attachments:  assets,
 	}
 }

modules/convert/repository.go

@@ -102,7 +102,7 @@ func innerToRepo(repo *models.Repository, mode models.AccessMode, isParent bool)
 
 	return &api.Repository{
 		ID:                        repo.ID,
-		Owner:                     ToUser(repo.Owner, mode != models.AccessModeNone, mode >= models.AccessModeAdmin),
+		Owner:                     ToUserWithAccessMode(repo.Owner, mode),
 		Name:                      repo.Name,
 		FullName:                  repo.FullName(),
 		Description:               repo.Description,

modules/convert/status.go

@@ -24,7 +24,7 @@ func ToCommitStatus(status *models.CommitStatus) *api.CommitStatus {
 
 	if status.CreatorID != 0 {
 		creator, _ := models.GetUserByID(status.CreatorID)
-		apiStatus.Creator = ToUser(creator, false, false)
+		apiStatus.Creator = ToUser(creator, nil)
 	}
 
 	return apiStatus

modules/convert/user.go

@@ -11,11 +11,32 @@ import (
 )
 
 // ToUser convert models.User to api.User
-// signed shall only be set if requester is logged in. authed shall only be set if user is site admin or user himself
-func ToUser(user *models.User, signed, authed bool) *api.User {
+// if doer is set, private information is added if the doer has the permission to see it
+func ToUser(user, doer *models.User) *api.User {
+	if user == nil {
+		return nil
+	}
+	authed := false
+	signed := false
+	if doer != nil {
+		signed = true
+		authed = doer.ID == user.ID || doer.IsAdmin
+	}
+	return toUser(user, signed, authed)
+}
+
+// ToUserWithAccessMode convert models.User to api.User
+// AccessMode is not none show add some more information
+func ToUserWithAccessMode(user *models.User, accessMode models.AccessMode) *api.User {
 	if user == nil {
 		return nil
 	}
+	return toUser(user, accessMode != models.AccessModeNone, false)
+}
+
+// toUser convert models.User to api.User
+// signed shall only be set if requester is logged in. authed shall only be set if user is site admin or user himself
+func toUser(user *models.User, signed, authed bool) *api.User {
 	result := &api.User{
 		ID:         user.ID,
 		UserName:   user.Name,

modules/convert/user_test.go

@@ -15,14 +15,14 @@ func TestUser_ToUser(t *testing.T) {
 
 	user1 := models.AssertExistsAndLoadBean(t, &models.User{ID: 1, IsAdmin: true}).(*models.User)
 
-	apiUser := ToUser(user1, true, true)
+	apiUser := toUser(user1, true, true)
 	assert.True(t, apiUser.IsAdmin)
 
 	user2 := models.AssertExistsAndLoadBean(t, &models.User{ID: 2, IsAdmin: false}).(*models.User)
 
-	apiUser = ToUser(user2, true, true)
+	apiUser = toUser(user2, true, true)
 	assert.False(t, apiUser.IsAdmin)
 
-	apiUser = ToUser(user1, false, false)
+	apiUser = toUser(user1, false, false)
 	assert.False(t, apiUser.IsAdmin)
 }