Write Non-Duplicated Comments (#39)

* add circle service load config and logger

* implement circle get diff

* implemented circleci write comments

* fix typo

* populate pr details in load config

* add logger tests

* lowercase errors

* lower case error message

* pr updates

* wip

* implement repo and pr service write comments

* log finding message if can't post to github

* uncomment and add additional env vars to list

* use helpers in loadconfig

* change logger debugs to info

* wip

* add tests for filtering out existing comments

* allocate slice capacity for filteredComments

Author: alan20854

internal/clients/diffreviewer/circleci/circleci_service.go

@@ -199,8 +199,19 @@ func (s *Service) WriteComments(comments []*diffreviewer.Comment) error {
 		return nil
 	}
 	if s.PrDetails.PrNumber != nil {
+		existingComments, _, err := s.GithubClient.PullRequestsService().ListComments(
+			context.Background(),
+			s.PrDetails.Owner,
+			s.PrDetails.Repo,
+			*s.PrDetails.PrNumber,
+			&github.PullRequestListCommentsOptions{},
+		)
+		if err != nil {
+			s.Logger.Error(fmt.Sprintf("Error listing existing pull request comments: %s", err.Error()))
+		}
 		githubComments := s.createGithubPullRequestComments(comments)
-		for _, c := range githubComments {
+		filteredGithubComments := filterExistingComments(githubComments, existingComments)
+		for _, c := range filteredGithubComments {
 			_, _, err := s.GithubClient.PullRequestsService().CreateComment(
 				context.Background(),
 				s.PrDetails.Owner,
@@ -210,7 +221,7 @@ func (s *Service) WriteComments(comments []*diffreviewer.Comment) error {
 			)
 			if err != nil {
 				s.Logger.Error(fmt.Sprintf("Error writing comment to pull request: %s", err.Error()))
-				s.Logger.Error(*c.Body)
+				s.Logger.Error(*c.Body) // log comment that was not written to circle ui
 			}
 		}
 	} else {
@@ -259,3 +270,33 @@ func (s *Service) createGithubRepositoryComments(comments []*diffreviewer.Commen
 	}
 	return githubComments
 }
+
+type prComment struct {
+	Body string
+	Path string
+	Line int
+}
+
+func filterExistingComments(comments []*github.PullRequestComment, existingComments []*github.PullRequestComment) []*github.PullRequestComment {
+	existingCommentsMap := make(map[prComment]bool, len(existingComments))
+	for _, ec := range existingComments {
+		comment := prComment{
+			Body: *ec.Body,
+			Path: *ec.Path,
+			Line: *ec.Line,
+		}
+		existingCommentsMap[comment] = true
+	}
+	filteredComments := make([]*github.PullRequestComment, 0, len(comments))
+	for _, c := range comments {
+		comment := prComment{
+			Body: *c.Body,
+			Path: *c.Path,
+			Line: *c.Line,
+		}
+		if _, ok := existingCommentsMap[comment]; !ok {
+			filteredComments = append(filteredComments, c)
+		}
+	}
+	return filteredComments
+}

internal/clients/diffreviewer/circleci/circleci_service_test.go

@@ -273,6 +273,14 @@ func (c *circleCiTestSuite) TestWritePullRequestComments() {
 	}
 
 	for _, tt := range tests {
+		mockClient.EXPECT().PullRequestsService().Return(mockPullRequests)
+		mockPullRequests.EXPECT().ListComments(
+			context.Background(),
+			testCircleService.PrDetails.Owner,
+			testCircleService.PrDetails.Repo,
+			*testCircleService.PrDetails.PrNumber,
+			&github.PullRequestListCommentsOptions{},
+		)
 		for _, gc := range tt.giveGithubComments {
 			mockClient.EXPECT().PullRequestsService().Return(mockPullRequests)
 			mockPullRequests.EXPECT().CreateComment(
@@ -416,6 +424,52 @@ func makeTestGithubRepositoryComments(
 	return comments, githubComments
 }
 
+func (c *circleCiTestSuite) TestFilterExistingComments() {
+	bodyStrs := []string{"a", "b", "c"}
+	pathStrs := []string{"a.txt", "b.txt", "c.txt"}
+	lineNums := []int{1, 2, 3, 6}
+	existingComments := []*github.PullRequestComment{
+		{
+			Body: &bodyStrs[0],
+			Path: &pathStrs[0],
+			Line: &lineNums[0],
+		},
+		{
+			Body: &bodyStrs[1],
+			Path: &pathStrs[1],
+			Line: &lineNums[1],
+		},
+		{
+			Body: &bodyStrs[2],
+			Path: &pathStrs[2],
+			Line: &lineNums[2],
+		},
+	}
+	newComment1 := &github.PullRequestComment{
+		Body: &bodyStrs[0],
+		Path: &pathStrs[0],
+		Line: &lineNums[3],
+	}
+	newComment2 := &github.PullRequestComment{
+		Body: &bodyStrs[1],
+		Path: &pathStrs[1],
+		Line: &lineNums[2],
+	}
+	comments := []*github.PullRequestComment{
+		existingComments[0],
+		existingComments[1],
+		existingComments[2],
+		newComment1,
+		newComment2,
+	}
+	expectedFilteredComments := []*github.PullRequestComment{
+		newComment1,
+		newComment2,
+	}
+	filteredComments := filterExistingComments(comments, existingComments)
+	c.Equal(expectedFilteredComments, filteredComments, "invalid filtered comments value")
+}
+
 func TestCircleCiClient(t *testing.T) {
 	suite.Run(t, new(circleCiTestSuite))
 }

internal/interfaces/githubintf/github_pullrequests.go

@@ -10,4 +10,5 @@ import (
 
 type GithubPullRequests interface {
 	CreateComment(ctx context.Context, owner string, repo string, number int, comment *github.PullRequestComment) (*github.PullRequestComment, *github.Response, error)
+	ListComments(ctx context.Context, owner string, repo string, number int, opts *github.PullRequestListCommentsOptions) ([]*github.PullRequestComment, *github.Response, error)
 }