feat: add files to compare (#6461)

Add the changed files between two commits to the response of the compare API, part of forgejo/forgejo#6460

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/6461
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Angel Nunez Mencias <git@angelnu.com>
Co-committed-by: Angel Nunez Mencias <git@angelnu.com>

modules/structs/repo_compare.go

@@ -5,6 +5,7 @@ package structs
 
 // Compare represents a comparison between two commits.
 type Compare struct {
-	TotalCommits int       `json:"total_commits"` // Total number of commits in the comparison.
+	TotalCommits int                    `json:"total_commits"` // Total number of commits in the comparison.
-	Commits      []*Commit `json:"commits"`       // List of commits in the comparison.
+	Commits      []*Commit              `json:"commits"`       // List of commits in the comparison.
+	Files        []*CommitAffectedFiles `json:"files"`         // Total files modified in this comparison.
 }

routers/api/v1/repo/compare.go

@@ -77,6 +77,7 @@ func CompareDiff(ctx *context.APIContext) {
 	files := ctx.FormString("files") == "" || ctx.FormBool("files")
 
 	apiCommits := make([]*api.Commit, 0, len(ci.Commits))
+	apiFiles := []*api.CommitAffectedFiles{}
 	userCache := make(map[string]*user_model.User)
 	for i := 0; i < len(ci.Commits); i++ {
 		apiCommit, err := convert.ToCommit(ctx, ctx.Repo.Repository, ctx.Repo.GitRepo, ci.Commits[i], userCache,
@@ -90,10 +91,12 @@ func CompareDiff(ctx *context.APIContext) {
 			return
 		}
 		apiCommits = append(apiCommits, apiCommit)
+		apiFiles = append(apiFiles, apiCommit.Files...)
 	}
 
 	ctx.JSON(http.StatusOK, &api.Compare{
 		TotalCommits: len(ci.Commits),
 		Commits:      apiCommits,
+		Files:        apiFiles,
 	})
 }

templates/swagger/v1_json.tmpl

@@ -21379,6 +21379,13 @@
           },
           "x-go-name": "Commits"
         },
+        "files": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CommitAffectedFiles"
+          },
+          "x-go-name": "Files"
+        },
         "total_commits": {
           "type": "integer",
           "format": "int64",

tests/integration/api_repo_compare_test.go

@@ -35,6 +35,7 @@ func TestAPICompareBranches(t *testing.T) {
 
 	assert.Equal(t, 2, apiResp.TotalCommits)
 	assert.Len(t, apiResp.Commits, 2)
+	assert.Len(t, apiResp.Files, 3)
 }
 
 func TestAPICompareCommits(t *testing.T) {
@@ -54,4 +55,5 @@ func TestAPICompareCommits(t *testing.T) {
 
 	assert.Equal(t, 2, apiResp.TotalCommits)
 	assert.Len(t, apiResp.Commits, 2)
+	assert.Len(t, apiResp.Files, 3)
 }