gitlab.nvim/cmd/app/list_discussions.go

package app

import (
	"net/http"
	"slices"
	"sort"
	"sync"
	"time"

	"encoding/json"

	gitlab "gitlab.com/gitlab-org/api/client-go"
)

func Contains[T comparable](elems []T, v T) bool {
	for _, s := range elems {
		if v == s {
			return true
		}
	}
	return false
}

type SortBy string

const (
	SortByLatestReply     SortBy = "latest_reply"
	SortByOriginalComment SortBy = "original_comment"
)

type DiscussionsRequest struct {
	Blacklist []string `json:"blacklist" validate:"required"`
	SortBy    SortBy   `json:"sort_by"`
}

type DiscussionsResponse struct {
	SuccessResponse
	Discussions         []*gitlab.Discussion           `json:"discussions"`
	UnlinkedDiscussions []*gitlab.Discussion           `json:"unlinked_discussions"`
	Emojis              map[int64][]*gitlab.AwardEmoji `json:"emojis"`
}

type SortableDiscussions struct {
	Discussions []*gitlab.Discussion
	SortBy      SortBy
}

func (d SortableDiscussions) Len() int {
	return len(d.Discussions)
}

func (d SortableDiscussions) Less(i, j int) bool {
	var iTime, jTime *time.Time
	if d.SortBy == SortByOriginalComment {
		iTime = d.Discussions[i].Notes[0].CreatedAt
		jTime = d.Discussions[j].Notes[0].CreatedAt
		return iTime.Before(*jTime)
	} else { // SortByLatestReply
		iTime = d.Discussions[i].Notes[len(d.Discussions[i].Notes)-1].CreatedAt
		jTime = d.Discussions[j].Notes[len(d.Discussions[j].Notes)-1].CreatedAt
		return iTime.After(*jTime)
	}
}

func (d SortableDiscussions) Swap(i, j int) {
	d.Discussions[i], d.Discussions[j] = d.Discussions[j], d.Discussions[i]
}

type DiscussionsLister interface {
	ListMergeRequestDiscussions(pid interface{}, mergeRequest int64, opt *gitlab.ListMergeRequestDiscussionsOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.Discussion, *gitlab.Response, error)
	ListMergeRequestAwardEmojiOnNote(pid any, mergeRequestIID int64, noteID int64, opt *gitlab.ListAwardEmojiOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.AwardEmoji, *gitlab.Response, error)
}

type discussionsListerService struct {
	data
	client DiscussionsLister
}

/*
listDiscussionsHandler lists all discusions for a given merge request, both those linked and unlinked to particular points in the code.
The responses are sorted by date created, and blacklisted users are not included
*/
func (a discussionsListerService) ServeHTTP(w http.ResponseWriter, r *http.Request) {

	request := r.Context().Value(payload(payload("payload"))).(*DiscussionsRequest)

	mergeRequestDiscussionOptions := gitlab.ListMergeRequestDiscussionsOptions{
		ListOptions: gitlab.ListOptions{
			Page:    1,
			PerPage: 250,
		},
	}

	it, hasErr := gitlab.Scan(func(p gitlab.PaginationOptionFunc) ([]*gitlab.Discussion, *gitlab.Response, error) {
		return a.client.ListMergeRequestDiscussions(a.projectInfo.ProjectId, a.projectInfo.MergeId, &mergeRequestDiscussionOptions, p)
	})
	discussions := slices.Collect(it)

	if err := hasErr(); err != nil {
		handleError(w, err, "Could not list discussions", http.StatusInternalServerError)
		return
	}

	/* Filter out any discussions started by a blacklisted user
	and system discussions, then return them sorted by created date */
	var unlinkedDiscussions []*gitlab.Discussion
	var linkedDiscussions []*gitlab.Discussion

	for _, discussion := range discussions {
		if len(discussion.Notes) == 0 || Contains(request.Blacklist, discussion.Notes[0].Author.Username) {
			continue
		}
		for _, note := range discussion.Notes {
			if note.Type == gitlab.NoteTypeValue("DiffNote") {
				linkedDiscussions = append(linkedDiscussions, discussion)
				break
			} else if !note.System && note.Position == nil {
				unlinkedDiscussions = append(unlinkedDiscussions, discussion)
				break
			}
		}
	}

	/* Collect IDs in order to fetch emojis */
	var noteIds []int64
	for _, discussion := range slices.Concat(linkedDiscussions, unlinkedDiscussions) {
		for _, note := range discussion.Notes {
			noteIds = append(noteIds, note.ID)
		}
	}

	emojis, err := a.fetchEmojisForNotesAndComments(noteIds)
	if err != nil {
		handleError(w, err, "Could not fetch emojis", http.StatusInternalServerError)
		return
	}

	sortedLinkedDiscussions := SortableDiscussions{
		Discussions: linkedDiscussions,
		SortBy:      request.SortBy,
	}
	sortedUnlinkedDiscussions := SortableDiscussions{
		Discussions: unlinkedDiscussions,
		SortBy:      request.SortBy,
	}

	sort.Sort(sortedLinkedDiscussions)
	sort.Sort(sortedUnlinkedDiscussions)

	w.WriteHeader(http.StatusOK)
	response := DiscussionsResponse{
		SuccessResponse:     SuccessResponse{Message: "Discussions retrieved"},
		Discussions:         linkedDiscussions,
		UnlinkedDiscussions: unlinkedDiscussions,
		Emojis:              emojis,
	}

	err = json.NewEncoder(w).Encode(response)
	if err != nil {
		handleError(w, err, "Could not encode response", http.StatusInternalServerError)
	}
}

/*
Fetches emojis for a set of notes and comments in parallel and returns a map of note IDs to their emojis.
Gitlab's API does not allow for fetching notes for an entire discussion thread so we have to do it per-note.
*/
func (a discussionsListerService) fetchEmojisForNotesAndComments(noteIDs []int64) (map[int64][]*gitlab.AwardEmoji, error) {
	var wg sync.WaitGroup

	emojis := make(map[int64][]*gitlab.AwardEmoji)
	mu := &sync.Mutex{}
	errs := make(chan error, len(noteIDs))
	emojiChan := make(chan struct {
		noteID int64
		emojis []*gitlab.AwardEmoji
	}, len(noteIDs))

	for _, noteID := range noteIDs {
		wg.Add(1)
		go func(noteID int64) {
			defer wg.Done()
			emojis, _, err := a.client.ListMergeRequestAwardEmojiOnNote(a.projectInfo.ProjectId, a.projectInfo.MergeId, noteID, &gitlab.ListAwardEmojiOptions{})
			if err != nil {
				errs <- err
				return
			}
			emojiChan <- struct {
				noteID int64
				emojis []*gitlab.AwardEmoji
			}{noteID, emojis}
		}(noteID)
	}

	/* Close the channels when all goroutines finish */
	go func() {
		wg.Wait()
		close(errs)
		close(emojiChan)
	}()

	/* Collect emojis */
	for e := range emojiChan {
		mu.Lock()
		emojis[e.noteID] = e.emojis
		mu.Unlock()
	}

	/* Check if any errors occurred */
	if len(errs) > 0 {
		for err := range errs {
			if err != nil {
				return nil, err
			}
		}
	}

	return emojis, nil
}