Merge pull request #1792 from reviewdog/metadata-comment

Introduce comment metadata and fingerprint for identifying existing posted comments

.github/workflows/rdformat.yml

@@ -1,4 +1,4 @@
-name: RDFormat
+name: Proto
 on: [push,pull_request]
 jobs:
   build:
@@ -7,7 +7,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Build
-      working-directory: proto/rdf/
+      working-directory: proto/
       run: ./update.sh
     - name: Check diff
       run: git diff --exit-code

CHANGELOG.md

@@ -12,7 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - ...
 
 ### :bug: Fixes
-- ...
+- [#1792](https://github.com/reviewdog/reviewdog/pull/1792) Introduce `__reviewdog__` HTML comment metadata and fingerprint for identifying existing posted comments for `github-pr-review` reporter. This resolve duplicated comments issue with related location feature.
 
 ### :rotating_light: Breaking changes
 - ...

proto/entrypoint.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+protoc --proto_path=./rdf --go_out=./rdf --go_opt=paths=source_relative --jsonschema_out=./rdf/jsonschema ./rdf/reviewdog.proto
+protoc --proto_path=./metacomment --go_out=./metacomment --go_opt=paths=source_relative ./metacomment/metacomment.proto

proto/metacomment/metacomment.proto

@@ -0,0 +1,21 @@
+syntax = "proto3";
+package reviewdog.rdf;
+
+option go_package = "github.com/reviewdog/reviewdog/proto/metacomment";
+
+// Represents a metadata of a diagnostic result.
+// It's expected to be base64 encoded and included into reporter comments such
+// as GitHub Pull Request Review comment.
+//
+// This metadata allow reviewdog to identify the same existing comment and
+// avoid posting duplicated comments. It can also be used for resolving or
+// deleting existing comments.
+message MetaComment {
+  // An unique identity, or "fingerprint", of the diagnostic result.
+  string fingerprint = 1;
+
+  // Source (tool) name of the diagnostic result.
+  // It's important to have source name so that reviewdog can handle existing
+  // comments with the same source properly.
+  string source_name = 2;
+}

scripts/decode-metacomment/main.go

@@ -0,0 +1,20 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/reviewdog/reviewdog/service/github"
+)
+
+func main() {
+	if len(os.Args) == 1 {
+		log.Fatal("require one argument")
+	}
+	meta, err := github.DecodeMetaComment(os.Args[1])
+	if err != nil {
+		log.Fatalf("failed to decode meta comment: %v", err)
+	}
+	fmt.Printf("%v\n", meta)
+}

service/commentutil/commentutil.go

@@ -9,13 +9,13 @@ import (
 	"github.com/reviewdog/reviewdog/proto/rdf"
 )
 
-// `path` to `position`(Lnum for new file) to comment `body`s
+// `path` to `position`(Lnum for new file) to comment `body` or `finterprint`
 type PostedComments map[string]map[int][]string
 
 // IsPosted returns true if a given comment has been posted in code review service already,
 // otherwise returns false. It sees comments with same path, same position,
 // and same body as same comments.
-func (p PostedComments) IsPosted(c *reviewdog.Comment, lineNum int, body string) bool {
+func (p PostedComments) IsPosted(c *reviewdog.Comment, lineNum int, bodyOrFingerprint string) bool {
 	path := c.Result.Diagnostic.GetLocation().GetPath()
 	if _, ok := p[path]; !ok {
 		return false
@@ -25,22 +25,22 @@ func (p PostedComments) IsPosted(c *reviewdog.Comment, lineNum int, body string)
 		return false
 	}
 	for _, b := range bodies {
-		if b == body {
+		if b == bodyOrFingerprint {
 			return true
 		}
 	}
 	return false
 }
 
 // AddPostedComment adds a posted comment.
-func (p PostedComments) AddPostedComment(path string, lineNum int, body string) {
+func (p PostedComments) AddPostedComment(path string, lineNum int, bodyOrFingerprint string) {
 	if _, ok := p[path]; !ok {
 		p[path] = make(map[int][]string)
 	}
 	if _, ok := p[path][lineNum]; !ok {
 		p[path][lineNum] = make([]string, 0)
 	}
-	p[path][lineNum] = append(p[path][lineNum], body)
+	p[path][lineNum] = append(p[path][lineNum], bodyOrFingerprint)
 }
 
 // DebugLog outputs posted comments as log for debugging.