drone/pkg/api/controller/pullreq/comment_status.go

134 lines
3.8 KiB
Go

// Copyright 2023 Harness, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package pullreq
import (
"context"
"fmt"
"time"
"github.com/harness/gitness/pkg/api/controller"
"github.com/harness/gitness/pkg/api/usererror"
"github.com/harness/gitness/pkg/auth"
"github.com/harness/gitness/types"
"github.com/harness/gitness/types/enum"
"github.com/rs/zerolog/log"
)
type CommentStatusInput struct {
Status enum.PullReqCommentStatus `json:"status"`
}
func (in *CommentStatusInput) Validate() error {
_, ok := in.Status.Sanitize()
if !ok {
return usererror.BadRequest("Invalid value provided for comment status")
}
return nil
}
func (in *CommentStatusInput) hasChanges(act *types.PullReqActivity, userID int64) bool {
// clearing resolved
if in.Status == enum.PullReqCommentStatusActive {
return act.Resolved != nil
}
// setting resolved
return act.Resolved == nil || act.ResolvedBy == nil || *act.ResolvedBy != userID
}
// CommentStatus updates a pull request comment status.
func (c *Controller) CommentStatus(
ctx context.Context,
session *auth.Session,
repoRef string,
prNum int64,
commentID int64,
in *CommentStatusInput,
) (*types.PullReqActivity, error) {
repo, err := c.getRepoCheckAccess(ctx, session, repoRef, enum.PermissionRepoView)
if err != nil {
return nil, fmt.Errorf("failed to acquire access to repo: %w", err)
}
var pr *types.PullReq
var act *types.PullReqActivity
err = controller.TxOptLock(ctx, c.db, func(ctx context.Context) error {
pr, err = c.pullreqStore.FindByNumber(ctx, repo.ID, prNum)
if err != nil {
return fmt.Errorf("failed to find pull request by number: %w", err)
}
if errValidate := in.Validate(); errValidate != nil {
return errValidate
}
act, err = c.getCommentCheckChangeStatusAccess(ctx, pr, commentID)
if err != nil {
return fmt.Errorf("failed to get comment: %w", err)
}
if !in.hasChanges(act, session.Principal.ID) {
return nil
}
act.Resolved = nil
act.ResolvedBy = nil
now := time.Now().UnixMilli()
if in.Status != enum.PullReqCommentStatusActive {
// In the future if we add more comment resolved statuses
// we'll add the ResolvedReason field and put the reason there.
// For now, the nullable timestamp field/db-column "Resolved" tells the status (active/resolved).
act.Resolved = &now
act.ResolvedBy = &session.Principal.ID
}
err = c.activityStore.Update(ctx, act)
if err != nil {
return fmt.Errorf("failed to update status of pull request activity: %w", err)
}
// Here we deliberately use the transaction and counting the unresolved comments,
// rather than optimistic locking and incrementing/decrementing the counter.
// The idea is that if the counter ever goes out of sync, this would be the place where we get it back in sync.
unresolvedCount, err := c.activityStore.CountUnresolved(ctx, pr.ID)
if err != nil {
return fmt.Errorf("failed to count unresolved comments: %w", err)
}
pr.UnresolvedCount = unresolvedCount
err = c.pullreqStore.Update(ctx, pr)
if err != nil {
return fmt.Errorf("failed to update pull request's unresolved comment count: %w", err)
}
return nil
})
if err != nil {
return nil, err
}
if err = c.sseStreamer.Publish(ctx, repo.ParentID, enum.SSETypePullrequesUpdated, pr); err != nil {
log.Ctx(ctx).Warn().Msg("failed to publish PR changed event")
}
return act, nil
}