Merge pull request #5049 from hirasawayuki/add-more-author-infomation

Add author information in `pr list` JSON output

api/export_pr.go

@@ -11,6 +11,18 @@ func (issue *Issue) ExportData(fields []string) map[string]interface{} {
 
 	for _, f := range fields {
 		switch f {
+		case "author":
+			author := map[string]interface{}{
+				"is_bot": issue.Author.IsBot(),
+			}
+			if issue.Author.IsBot() {
+				author["login"] = "app/" + issue.Author.Login
+			} else {
+				author["login"] = issue.Author.Login
+				author["name"] = issue.Author.Name
+				author["id"] = issue.Author.ID
+			}
+			data[f] = author
 		case "comments":
 			data[f] = issue.Comments.Nodes
 		case "assignees":
@@ -34,6 +46,18 @@ func (pr *PullRequest) ExportData(fields []string) map[string]interface{} {
 
 	for _, f := range fields {
 		switch f {
+		case "author":
+			author := map[string]interface{}{
+				"is_bot": pr.Author.IsBot(),
+			}
+			if pr.Author.IsBot() {
+				author["login"] = "app/" + pr.Author.Login
+			} else {
+				author["login"] = pr.Author.Login
+				author["name"] = pr.Author.Name
+				author["id"] = pr.Author.ID
+			}
+			data[f] = author
 		case "headRepository":
 			data[f] = pr.HeadRepository
 		case "statusCheckRollup":

api/queries_issue.go

@@ -112,12 +112,15 @@ type Owner struct {
 }
 
 type Author struct {
-	// adding these breaks generated GraphQL requests
-	//ID    string `json:"id,omitempty"`
-	//Name  string `json:"name,omitempty"`
+	ID    string `json:"id,omitempty"`
+	Name  string `json:"name,omitempty"`
 	Login string `json:"login"`
 }
 
+func (author *Author) IsBot() bool {
+	return author.ID == ""
+}
+
 // IssueCreate creates an issue in a GitHub repository
 func IssueCreate(client *Client, repo *Repository, params map[string]interface{}) (*Issue, error) {
 	query := `

api/query_builder.go

@@ -261,7 +261,7 @@ func IssueGraphQL(fields []string) string {
 	for _, field := range fields {
 		switch field {
 		case "author":
-			q = append(q, `author{login}`)
+			q = append(q, `author{login,...on User{id,name}}`)
 		case "mergedBy":
 			q = append(q, `mergedBy{login}`)
 		case "headRepositoryOwner":

api/query_builder_test.go

@@ -21,7 +21,7 @@ func TestPullRequestGraphQL(t *testing.T) {
 		{
 			name:   "fields with nested structures",
 			fields: []string{"author", "assignees"},
-			want:   "author{login},assignees(first:100){nodes{id,login,name},totalCount}",
+			want:   "author{login,...on User{id,name}},assignees(first:100){nodes{id,login,name},totalCount}",
 		},
 		{
 			name:   "compressed query",
@@ -62,7 +62,7 @@ func TestIssueGraphQL(t *testing.T) {
 		{
 			name:   "fields with nested structures",
 			fields: []string{"author", "assignees"},
-			want:   "author{login},assignees(first:100){nodes{id,login,name},totalCount}",
+			want:   "author{login,...on User{id,name}},assignees(first:100){nodes{id,login,name},totalCount}",
 		},
 		{
 			name:   "compressed query",

pkg/search/result.go

@@ -116,6 +116,13 @@ type User struct {
 	URL        string `json:"html_url"`
 }
 
+func (u *User) IsBot() bool {
+	// copied from api/queries_issue.go
+	// would ideally be shared, but it would require coordinating a "user"
+	// abstraction in a bunch of places.
+	return u.ID == ""
+}
+
 type Issue struct {
 	Assignees         []User      `json:"assignees"`
 	Author            User        `json:"user"`
@@ -200,18 +207,30 @@ func (issue Issue) ExportData(fields []string) map[string]interface{} {
 		case "assignees":
 			assignees := make([]interface{}, 0, len(issue.Assignees))
 			for _, assignee := range issue.Assignees {
+				isBot := assignee.IsBot()
+				login := assignee.Login
+				if isBot {
+					login = "app/" + login
+				}
 				assignees = append(assignees, map[string]interface{}{
-					"id":    assignee.ID,
-					"login": assignee.Login,
-					"type":  assignee.Type,
+					"id":     assignee.ID,
+					"login":  login,
+					"type":   assignee.Type,
+					"is_bot": isBot,
 				})
 			}
 			data[f] = assignees
 		case "author":
+			isBot := issue.Author.IsBot()
+			login := issue.Author.Login
+			if isBot {
+				login = "app/" + login
+			}
 			data[f] = map[string]interface{}{
-				"id":    issue.Author.ID,
-				"login": issue.Author.Login,
-				"type":  issue.Author.Type,
+				"id":     issue.Author.ID,
+				"login":  login,
+				"type":   issue.Author.Type,
+				"is_bot": isBot,
 			}
 		case "isPullRequest":
 			data[f] = issue.IsPullRequest()

pkg/search/result_test.go

@@ -57,7 +57,7 @@ func TestIssueExportData(t *testing.T) {
 			name:   "exports requested fields",
 			fields: []string{"assignees", "body", "commentsCount", "labels", "isLocked", "repository", "title", "updatedAt"},
 			issue: Issue{
-				Assignees:     []User{{Login: "test"}},
+				Assignees:     []User{{Login: "test", ID: "123"}, {Login: "foo"}},
 				Body:          "body",
 				CommentsCount: 1,
 				Labels:        []Label{{Name: "label1"}, {Name: "label2"}},
@@ -66,7 +66,7 @@ func TestIssueExportData(t *testing.T) {
 				Title:         "title",
 				UpdatedAt:     updatedAt,
 			},
-			output: `{"assignees":[{"id":"","login":"test","type":""}],"body":"body","commentsCount":1,"isLocked":true,"labels":[{"color":"","description":"","id":"","name":"label1"},{"color":"","description":"","id":"","name":"label2"}],"repository":{"name":"repo","nameWithOwner":"owner/repo"},"title":"title","updatedAt":"2021-02-28T12:30:00Z"}`,
+			output: `{"assignees":[{"id":"123","is_bot":false,"login":"test","type":""},{"id":"","is_bot":true,"login":"app/foo","type":""}],"body":"body","commentsCount":1,"isLocked":true,"labels":[{"color":"","description":"","id":"","name":"label1"},{"color":"","description":"","id":"","name":"label2"}],"repository":{"name":"repo","nameWithOwner":"owner/repo"},"title":"title","updatedAt":"2021-02-28T12:30:00Z"}`,
 		},
 		{
 			name:   "state when issue",