gitlab.nvim/cmd/app/server.go

package app

import (
	"errors"
	"fmt"
	"net"
	"net/http"
	"os"
	"time"

	"github.com/harrisoncramer/gitlab.nvim/cmd/app/git"
	"github.com/xanzy/go-gitlab"
)

/*
startSever starts the server and runs concurrent goroutines
to handle potential shutdown requests and incoming HTTP requests.
*/
func StartServer(client *Client, projectInfo *ProjectInfo, GitInfo git.GitData) {

	s := shutdownService{
		sigCh: make(chan os.Signal, 1),
	}

	fr := attachmentReader{}
	r := CreateRouter(
		client,
		projectInfo,
		&s,
		func(a *data) error { a.projectInfo = projectInfo; return nil },
		func(a *data) error { a.gitInfo = &GitInfo; return nil },
		func(a *data) error { err := attachEmojis(a, fr); return err },
	)
	l := createListener()

	server := &http.Server{Handler: r}

	/* Starts the Go server */
	go func() {
		err := server.Serve(l)
		if err != nil {
			if !errors.Is(err, http.ErrServerClosed) {
				fmt.Fprintf(os.Stderr, "Server crashed: %s\n", err)
				os.Exit(1)
			}
		}
	}()

	port := l.Addr().(*net.TCPAddr).Port
	err := checkServer(port)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Server did not respond: %s\n", err)
		os.Exit(1)
	}

	/* This print is detected by the Lua code */
	fmt.Println("Server started on port: ", port)

	/* Handles shutdown requests */
	s.WatchForShutdown(server)
}

/*
CreateRouterAndApi wires up the router and attaches all handlers to their respective routes. It also
iterates over all option functions to configure API fields such as the project information and default
file reader functionality
*/

type data struct {
	projectInfo *ProjectInfo
	gitInfo     *git.GitData
	emojiMap    EmojiMap
}

type optFunc func(a *data) error

func CreateRouter(gitlabClient *Client, projectInfo *ProjectInfo, s *shutdownService, optFuncs ...optFunc) http.Handler {
	m := http.NewServeMux()

	d := data{
		projectInfo: &ProjectInfo{},
		gitInfo:     &git.GitData{},
	}

	/* Mutates the API struct as necessary with configuration functions */
	for _, optFunc := range optFuncs {
		err := optFunc(&d)
		if err != nil {
			panic(err)
		}
	}

	m.HandleFunc("/mr/approve", middleware(
		mergeRequestApproverService{d, gitlabClient}, // These functions are called from bottom to top...
		withMr(d, gitlabClient),
		withMethodCheck(http.MethodPost),
	))
	m.HandleFunc("/mr/comment", middleware(
		commentService{d, gitlabClient},
		withMr(d, gitlabClient),
		withPayloadValidation(methodToPayload{
			http.MethodPost:   &PostCommentRequest{},
			http.MethodDelete: &DeleteCommentRequest{},
			http.MethodPatch:  &EditCommentRequest{},
		}),
		withMethodCheck(http.MethodPost, http.MethodDelete, http.MethodPatch),
	))
	m.HandleFunc("/mr/merge", middleware(
		mergeRequestAccepterService{d, gitlabClient},
		withMr(d, gitlabClient),
		withPayloadValidation(methodToPayload{http.MethodPost: &AcceptMergeRequestRequest{}}),
		withMethodCheck(http.MethodPost),
	))
	m.HandleFunc("/mr/discussions/list", middleware(
		discussionsListerService{d, gitlabClient},
		withMr(d, gitlabClient),
		withPayloadValidation(methodToPayload{http.MethodPost: &DiscussionsRequest{}}),
		withMethodCheck(http.MethodPost),
	))
	m.HandleFunc("/mr/discussions/resolve", middleware(
		discussionsResolutionService{d, gitlabClient},
		withMr(d, gitlabClient),
		withPayloadValidation(methodToPayload{http.MethodPut: &DiscussionResolveRequest{}}),
		withMethodCheck(http.MethodPut),
	))
	m.HandleFunc("/mr/info", middleware(
		infoService{d, gitlabClient},
		withMr(d, gitlabClient),
		withMethodCheck(http.MethodGet),
	))
	m.HandleFunc("/mr/assignee", middleware(
		assigneesService{d, gitlabClient},
		withMr(d, gitlabClient),
		withPayloadValidation(methodToPayload{http.MethodPut: &AssigneeUpdateRequest{}}),
		withMethodCheck(http.MethodPut),
	))
	m.HandleFunc("/mr/summary", middleware(
		summaryService{d, gitlabClient},
		withMr(d, gitlabClient),
		withPayloadValidation(methodToPayload{http.MethodPut: &SummaryUpdateRequest{}}),
		withMethodCheck(http.MethodPut),
	))
	m.HandleFunc("/mr/reviewer", middleware(
		reviewerService{d, gitlabClient},
		withMr(d, gitlabClient),
		withPayloadValidation(methodToPayload{http.MethodPut: &ReviewerUpdateRequest{}}),
		withMethodCheck(http.MethodPut),
	))
	m.HandleFunc("/mr/revisions", middleware(
		revisionsService{d, gitlabClient},
		withMr(d, gitlabClient),
		withMethodCheck(http.MethodGet),
	))
	m.HandleFunc("/mr/reply", middleware(
		replyService{d, gitlabClient},
		withMr(d, gitlabClient),
		withPayloadValidation(methodToPayload{http.MethodPost: &ReplyRequest{}}),
		withMethodCheck(http.MethodPost),
	))
	m.HandleFunc("/mr/label", middleware(
		labelService{d, gitlabClient},
		withMr(d, gitlabClient),
	))
	m.HandleFunc("/mr/revoke", middleware(
		mergeRequestRevokerService{d, gitlabClient},
		withMethodCheck(http.MethodPost),
		withMr(d, gitlabClient),
	))
	m.HandleFunc("/mr/awardable/note/", middleware(
		emojiService{d, gitlabClient},
		withMethodCheck(http.MethodPost, http.MethodDelete),
		withMr(d, gitlabClient),
	))
	m.HandleFunc("/mr/draft_notes/", middleware(
		draftNoteService{d, gitlabClient},
		withMr(d, gitlabClient),
		withPayloadValidation(methodToPayload{
			http.MethodPost:  &PostDraftNoteRequest{},
			http.MethodPatch: &UpdateDraftNoteRequest{},
		}),
		withMethodCheck(http.MethodGet, http.MethodPost, http.MethodPatch, http.MethodDelete),
	))
	m.HandleFunc("/mr/draft_notes/publish", middleware(
		draftNotePublisherService{d, gitlabClient},
		withMr(d, gitlabClient),
		withPayloadValidation(methodToPayload{http.MethodPost: &DraftNotePublishRequest{}}),
		withMethodCheck(http.MethodPost),
	))
	m.HandleFunc("/pipeline", middleware(
		pipelineService{d, gitlabClient, git.Git{}},
		withMethodCheck(http.MethodGet),
	))
	m.HandleFunc("/pipeline/trigger/", middleware(
		pipelineService{d, gitlabClient, git.Git{}},
		withMethodCheck(http.MethodPost),
	))
	m.HandleFunc("/users/me", middleware(
		meService{d, gitlabClient},
		withMethodCheck(http.MethodGet),
	))
	m.HandleFunc("/attachment", middleware(
		attachmentService{data: d, client: gitlabClient, fileReader: attachmentReader{}},
		withPayloadValidation(methodToPayload{http.MethodPost: &AttachmentRequest{}}),
		withMethodCheck(http.MethodPost),
	))
	m.HandleFunc("/create_mr", middleware(
		mergeRequestCreatorService{d, gitlabClient},
		withPayloadValidation(methodToPayload{http.MethodPost: &CreateMrRequest{}}),
		withMethodCheck(http.MethodPost),
	))
	m.HandleFunc("/job", middleware(
		traceFileService{d, gitlabClient},
		withPayloadValidation(methodToPayload{http.MethodGet: &JobTraceRequest{}}),
		withMethodCheck(http.MethodGet),
	))
	m.HandleFunc("/project/members", middleware(
		projectMemberService{d, gitlabClient},
		withMethodCheck(http.MethodGet),
	))
	m.HandleFunc("/merge_requests", middleware(
		mergeRequestListerService{d, gitlabClient},
		withPayloadValidation(methodToPayload{http.MethodPost: &gitlab.ListProjectMergeRequestsOptions{}}), // TODO: How to validate external object
		withMethodCheck(http.MethodPost),
	))
	m.HandleFunc("/merge_requests_by_username", middleware(
		mergeRequestListerByUsernameService{d, gitlabClient},
		withPayloadValidation(methodToPayload{http.MethodPost: &MergeRequestByUsernameRequest{}}),
		withMethodCheck(http.MethodPost),
	))
	m.HandleFunc("/shutdown", middleware(
		*s,
		withPayloadValidation(methodToPayload{http.MethodPost: &ShutdownRequest{}}),
		withMethodCheck(http.MethodPost),
	))

	m.Handle("/ping", http.HandlerFunc(pingHandler))

	return LoggingServer{handler: m}
}

/* Used to check whether the server has started yet */
func pingHandler(w http.ResponseWriter, _ *http.Request) {
	w.WriteHeader(http.StatusOK)
	fmt.Fprintln(w, "pong")
}

/* checkServer pings the server repeatedly for 1 full second after startup in order to notify the plugin that the server is ready */
func checkServer(port int) error {
	for i := 0; i < 10; i++ {
		resp, err := http.Get("http://localhost:" + fmt.Sprintf("%d", port) + "/ping")
		if resp.StatusCode == 200 && err == nil {
			return nil
		}
		time.Sleep(100 * time.Microsecond)
	}

	return errors.New("Could not start server!")
}

/* Creates a TCP listener on the port specified by the user or a random port */
func createListener() (l net.Listener) {
	addr := fmt.Sprintf("localhost:%d", pluginOptions.Port)
	l, err := net.Listen("tcp", addr)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error starting server: %s\n", err)
		os.Exit(1)
	}

	return l
}