Release 2.5.1 (#271)
* feat: Support for custom authentication provider functions (#270) * feat: Support for adding "draft" notes to the review, and publishing them, either individually or all at once. Addresses feature request #223. * feat: Lets users select + checkout a merge request directly within Neovim, without exiting to the terminal * fix: Checks that the remote feature branch exists and is up-to-date before creating a MR, starting a review, or opening the MR summary (#278) * docs: We require some state from Diffview, this shows how to load that state prior to installing w/ Packer. Fixes #94. This is a #MINOR release. --------- Co-authored-by: Jakub F. Bortlík <jakub.bortlik@proton.me> Co-authored-by: sunfuze <sunfuze.1989@gmail.com> Co-authored-by: Patrick Pichler <mail@patrickpichler.dev>
This commit is contained in:
Harrison (Harry) Cramer
committed by
GitHub
GitHub
parent
f10c4ebb8f
commit
cf6ccddce3
306
cmd/draft_notes.go
Normal file
306
cmd/draft_notes.go
Normal file
@@ -0,0 +1,306 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/xanzy/go-gitlab"
|
||||
)
|
||||
|
||||
/* The data coming from the client when creating a draft note is the same,
|
||||
as when they are creating a normal comment, but the Gitlab
|
||||
endpoints + resources we handle are different */
|
||||
|
||||
type PostDraftNoteRequest struct {
|
||||
Comment string `json:"comment"`
|
||||
PositionData
|
||||
}
|
||||
|
||||
type UpdateDraftNoteRequest struct {
|
||||
Note string `json:"note"`
|
||||
Position gitlab.PositionOptions
|
||||
}
|
||||
|
||||
type DraftNotePublishRequest struct {
|
||||
Note int `json:"note,omitempty"`
|
||||
PublishAll bool `json:"publish_all"`
|
||||
}
|
||||
|
||||
type DraftNoteResponse struct {
|
||||
SuccessResponse
|
||||
DraftNote *gitlab.DraftNote `json:"draft_note"`
|
||||
}
|
||||
|
||||
type ListDraftNotesResponse struct {
|
||||
SuccessResponse
|
||||
DraftNotes []*gitlab.DraftNote `json:"draft_notes"`
|
||||
}
|
||||
|
||||
/* DraftNoteWithPosition is a draft comment with an (optional) position data value embedded in it. The position data will be non-nil for range-based draft comments. */
|
||||
type DraftNoteWithPosition struct {
|
||||
PositionData PositionData
|
||||
}
|
||||
|
||||
func (draftNote DraftNoteWithPosition) GetPositionData() PositionData {
|
||||
return draftNote.PositionData
|
||||
}
|
||||
|
||||
/* draftNoteHandler creates, edits, and deletes draft notes */
|
||||
func (a *api) draftNoteHandler(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
switch r.Method {
|
||||
case http.MethodGet:
|
||||
a.listDraftNotes(w, r)
|
||||
case http.MethodPost:
|
||||
a.postDraftNote(w, r)
|
||||
case http.MethodPatch:
|
||||
a.updateDraftNote(w, r)
|
||||
case http.MethodDelete:
|
||||
a.deleteDraftNote(w, r)
|
||||
default:
|
||||
w.Header().Set("Access-Control-Allow-Methods", fmt.Sprintf("%s, %s, %s, %s", http.MethodDelete, http.MethodPost, http.MethodPatch, http.MethodGet))
|
||||
handleError(w, InvalidRequestError{}, "Expected DELETE, GET, POST or PATCH", http.StatusMethodNotAllowed)
|
||||
}
|
||||
}
|
||||
|
||||
func (a *api) draftNotePublisher(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
if r.Method != http.MethodPost {
|
||||
w.Header().Set("Access-Control-Allow-Methods", http.MethodPost)
|
||||
handleError(w, InvalidRequestError{}, "Expected POST", http.StatusMethodNotAllowed)
|
||||
return
|
||||
}
|
||||
|
||||
body, err := io.ReadAll(r.Body)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not read request body", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
defer r.Body.Close()
|
||||
var draftNotePublishRequest DraftNotePublishRequest
|
||||
err = json.Unmarshal(body, &draftNotePublishRequest)
|
||||
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not read JSON from request", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
var res *gitlab.Response
|
||||
if draftNotePublishRequest.PublishAll {
|
||||
res, err = a.client.PublishAllDraftNotes(a.projectInfo.ProjectId, a.projectInfo.MergeId)
|
||||
} else {
|
||||
if draftNotePublishRequest.Note == 0 {
|
||||
handleError(w, errors.New("No ID provided"), "Must provide Note ID", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
res, err = a.client.PublishDraftNote(a.projectInfo.ProjectId, a.projectInfo.MergeId, draftNotePublishRequest.Note)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not publish draft note(s)", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
if res.StatusCode >= 300 {
|
||||
handleError(w, GenericError{endpoint: "/mr/draft_notes/publish"}, "Could not publish dfaft note", res.StatusCode)
|
||||
return
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
response := SuccessResponse{
|
||||
Message: "Draft note(s) published",
|
||||
Status: http.StatusOK,
|
||||
}
|
||||
|
||||
err = json.NewEncoder(w).Encode(response)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not encode response", http.StatusInternalServerError)
|
||||
}
|
||||
}
|
||||
|
||||
/* postDraftNote creates a draft note */
|
||||
func (a *api) postDraftNote(w http.ResponseWriter, r *http.Request) {
|
||||
body, err := io.ReadAll(r.Body)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not read request body", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
defer r.Body.Close()
|
||||
|
||||
var postDraftNoteRequest PostDraftNoteRequest
|
||||
err = json.Unmarshal(body, &postDraftNoteRequest)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not unmarshal data from request body", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
opt := gitlab.CreateDraftNoteOptions{
|
||||
Note: &postDraftNoteRequest.Comment,
|
||||
// TODO: Support posting replies as drafts and rendering draft replies in the discussion tree
|
||||
// instead of the notes tree
|
||||
// InReplyToDiscussionID *string `url:"in_reply_to_discussion_id,omitempty" json:"in_reply_to_discussion_id,omitempty"`
|
||||
}
|
||||
|
||||
if postDraftNoteRequest.FileName != "" {
|
||||
draftNoteWithPosition := DraftNoteWithPosition{postDraftNoteRequest.PositionData}
|
||||
opt.Position = buildCommentPosition(draftNoteWithPosition)
|
||||
}
|
||||
|
||||
draftNote, res, err := a.client.CreateDraftNote(a.projectInfo.ProjectId, a.projectInfo.MergeId, &opt)
|
||||
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not create draft note", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
if res.StatusCode >= 300 {
|
||||
handleError(w, GenericError{endpoint: "/mr/draft_notes/"}, "Could not create draft note", res.StatusCode)
|
||||
return
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
response := DraftNoteResponse{
|
||||
SuccessResponse: SuccessResponse{
|
||||
Message: "Draft note created successfully",
|
||||
Status: http.StatusOK,
|
||||
},
|
||||
DraftNote: draftNote,
|
||||
}
|
||||
|
||||
err = json.NewEncoder(w).Encode(response)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not encode response", http.StatusInternalServerError)
|
||||
}
|
||||
}
|
||||
|
||||
/* deleteDraftNote deletes a draft note */
|
||||
func (a *api) deleteDraftNote(w http.ResponseWriter, r *http.Request) {
|
||||
suffix := strings.TrimPrefix(r.URL.Path, "/mr/draft_notes/")
|
||||
id, err := strconv.Atoi(suffix)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not parse draft note ID", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
res, err := a.client.DeleteDraftNote(a.projectInfo.ProjectId, a.projectInfo.MergeId, id)
|
||||
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not delete draft note", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
if res.StatusCode >= 300 {
|
||||
handleError(w, GenericError{endpoint: "/mr/draft_notes/"}, "Could not delete draft note", res.StatusCode)
|
||||
return
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
response := SuccessResponse{
|
||||
Message: "Draft note deleted",
|
||||
Status: http.StatusOK,
|
||||
}
|
||||
|
||||
err = json.NewEncoder(w).Encode(response)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not encode response", http.StatusInternalServerError)
|
||||
}
|
||||
}
|
||||
|
||||
/* updateDraftNote edits the text of a draft comment */
|
||||
func (a *api) updateDraftNote(w http.ResponseWriter, r *http.Request) {
|
||||
suffix := strings.TrimPrefix(r.URL.Path, "/mr/draft_notes/")
|
||||
id, err := strconv.Atoi(suffix)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not parse draft note ID", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
body, err := io.ReadAll(r.Body)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not read request body", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
defer r.Body.Close()
|
||||
|
||||
var updateDraftNoteRequest UpdateDraftNoteRequest
|
||||
err = json.Unmarshal(body, &updateDraftNoteRequest)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not unmarshal data from request body", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
if updateDraftNoteRequest.Note == "" {
|
||||
handleError(w, errors.New("Draft note text missing"), "Must provide draft note text", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
opt := gitlab.UpdateDraftNoteOptions{
|
||||
Note: &updateDraftNoteRequest.Note,
|
||||
Position: &updateDraftNoteRequest.Position,
|
||||
}
|
||||
|
||||
draftNote, res, err := a.client.UpdateDraftNote(a.projectInfo.ProjectId, a.projectInfo.MergeId, id, &opt)
|
||||
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not update draft note", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
if res.StatusCode >= 300 {
|
||||
handleError(w, GenericError{endpoint: "/mr/draft_notes/"}, "Could not update draft note", res.StatusCode)
|
||||
return
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
response := DraftNoteResponse{
|
||||
SuccessResponse: SuccessResponse{
|
||||
Message: "Draft note updated",
|
||||
Status: http.StatusOK,
|
||||
},
|
||||
DraftNote: draftNote,
|
||||
}
|
||||
|
||||
err = json.NewEncoder(w).Encode(response)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not encode response", http.StatusInternalServerError)
|
||||
}
|
||||
}
|
||||
|
||||
/* listDraftNotes lists all draft notes for the currently authenticated user */
|
||||
func (a *api) listDraftNotes(w http.ResponseWriter, r *http.Request) {
|
||||
|
||||
opt := gitlab.ListDraftNotesOptions{}
|
||||
draftNotes, res, err := a.client.ListDraftNotes(a.projectInfo.ProjectId, a.projectInfo.MergeId, &opt)
|
||||
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not get draft notes", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
if res.StatusCode >= 300 {
|
||||
handleError(w, GenericError{endpoint: "/mr/draft/comment"}, "Could not get draft notes", res.StatusCode)
|
||||
return
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
response := ListDraftNotesResponse{
|
||||
SuccessResponse: SuccessResponse{
|
||||
Message: "Draft notes fetched successfully",
|
||||
Status: http.StatusOK,
|
||||
},
|
||||
DraftNotes: draftNotes,
|
||||
}
|
||||
|
||||
err = json.NewEncoder(w).Encode(response)
|
||||
if err != nil {
|
||||
handleError(w, err, "Could not encode response", http.StatusInternalServerError)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user