Enhance gh issue view to conditionally handle v1 projects being available #9530
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| package view | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "slices" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/cli/cli/v2/api" | ||
| prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared" | ||
| "github.com/cli/cli/v2/pkg/iostreams" | ||
| ) | ||
|
|
||
| type PresentationIssue struct { | ||
| Title string | ||
| Number int | ||
| CreatedAt time.Time | ||
| Comments api.Comments | ||
| Author string | ||
| State string | ||
| StateReason string | ||
| Reactions string | ||
| AssigneesList string | ||
| LabelsList string | ||
| ProjectsList string | ||
| MilestoneTitle string | ||
| Body string | ||
| URL string | ||
| } | ||
|
|
||
| // Creates a new PresentationIssue from an api.Issue. | ||
| // The PresentationIssue is what the issue printers need to display an | ||
| // issue to the user. | ||
| func MapApiIssueToPresentationIssue(issue *api.Issue, colorScheme *iostreams.ColorScheme) (PresentationIssue, error) { | ||
| presentationIssue := PresentationIssue{ | ||
| Title: issue.Title, | ||
| Number: issue.Number, | ||
| CreatedAt: issue.CreatedAt, | ||
| Comments: issue.Comments, | ||
| Author: issue.Author.Login, | ||
| State: issue.State, | ||
| StateReason: issue.StateReason, | ||
| Reactions: prShared.ReactionGroupList(issue.ReactionGroups), | ||
| AssigneesList: stringifyAssignees(issue.Assignees), | ||
| LabelsList: stringifyAndColorizeLabels(sortAlphabeticallyIgnoreCase(issue.Labels), colorScheme), | ||
| ProjectsList: stringifyProjects(issue.ProjectCards, issue.ProjectItems), | ||
| Body: issue.Body, | ||
| URL: issue.URL, | ||
| } | ||
|
|
||
| if issue.Milestone != nil { | ||
| presentationIssue.MilestoneTitle = issue.Milestone.Title | ||
| } | ||
|
|
||
| return presentationIssue, nil | ||
| } | ||
|
|
||
| func stringifyProjects(projectCards api.ProjectCards, projectItems api.ProjectItems) string { | ||
| if len(projectCards.Nodes) == 0 && len(projectItems.Nodes) == 0 { | ||
| return "" | ||
| } | ||
|
|
||
| projectNames := make([]string, len(projectCards.Nodes)+len(projectItems.Nodes)) | ||
| for i, project := range projectCards.Nodes { | ||
| colName := project.Column.Name | ||
| if colName == "" { | ||
| colName = "Awaiting triage" | ||
| } | ||
| projectNames[i] = fmt.Sprintf("%s (%s)", project.Project.Name, colName) | ||
| } | ||
|
|
||
| for i, project := range projectItems.Nodes { | ||
| statusName := project.Status.Name | ||
| if statusName == "" { | ||
| statusName = "Backlog" | ||
| } | ||
| projectNames[i+len(projectCards.Nodes)] = fmt.Sprintf("%s (%s)", project.Project.Title, statusName) | ||
| } | ||
|
|
||
| list := strings.Join(projectNames, ", ") | ||
| if projectCards.TotalCount > len(projectCards.Nodes) { | ||
| list += ", …" | ||
| } | ||
| return list | ||
| } | ||
|
|
||
| func stringifyAssignees(issueAssignees api.Assignees) string { | ||
| if len(issueAssignees.Nodes) == 0 { | ||
| return "" | ||
| } | ||
|
|
||
| AssigneeNames := make([]string, 0, len(issueAssignees.Nodes)) | ||
| for _, assignee := range issueAssignees.Nodes { | ||
| AssigneeNames = append(AssigneeNames, assignee.Login) | ||
| } | ||
|
|
||
| list := strings.Join(AssigneeNames, ", ") | ||
| if issueAssignees.TotalCount > len(issueAssignees.Nodes) { | ||
| list += ", …" | ||
| } | ||
| return list | ||
| } | ||
|
|
||
| func stringifyAndColorizeLabels(issueLabels api.Labels, colorScheme *iostreams.ColorScheme) string { | ||
| labelNames := make([]string, len(issueLabels.Nodes)) | ||
| for j, label := range issueLabels.Nodes { | ||
| if colorScheme == nil { | ||
| labelNames[j] = label.Name | ||
| } else { | ||
| labelNames[j] = colorScheme.HexToRGB(label.Color, label.Name) | ||
| } | ||
| } | ||
|
|
||
| return strings.Join(labelNames, ", ") | ||
| } | ||
|
|
||
| func sortAlphabeticallyIgnoreCase(l api.Labels) api.Labels { | ||
|
Member
There was a problem hiding this comment. I think this function signature is a bit confusing given the implementation. This indicates that I give it a labels and it gives me back sorted labels. This is true but it's kind of hiding the fact that the slice of Nodes is being mutated in place. This is also surprising in the way we use it because it's mutating the original api.Issue as well. |
||
| slices.SortStableFunc(l.Nodes, func(a, b api.IssueLabel) int { | ||
| return strings.Compare(strings.ToLower(a.Name), strings.ToLower(b.Name)) | ||
| }) | ||
| return l | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's a bit leaky that we've gone to all this work the separate our
PresentationIssuefrom ourapidomain and we're holding on toapi.Commentsin here. I'd need to take some time to investigate a bit more before offering any kind of suggestion though.