add webhook payload optimization API support

Author: kerwin612

modules/structs/hook.go

@@ -25,6 +25,9 @@ type Hook struct {
 	Events              []string          `json:"events"`
 	AuthorizationHeader string            `json:"authorization_header"`
 	Active              bool              `json:"active"`
+	// Payload size optimization options
+	ExcludeFilesLimit   int `json:"exclude_files_limit"`   // -1: trim all (none kept), 0: do not trim, >0: keep N file changes
+	ExcludeCommitsLimit int `json:"exclude_commits_limit"` // -1: trim all (none kept), 0: do not trim, >0: keep N commits
 	// swagger:strfmt date-time
 	Updated time.Time `json:"updated_at"`
 	// swagger:strfmt date-time
@@ -48,6 +51,9 @@ type CreateHookOption struct {
 	Events              []string               `json:"events"`
 	BranchFilter        string                 `json:"branch_filter" binding:"GlobPattern"`
 	AuthorizationHeader string                 `json:"authorization_header"`
+	// Payload size optimization options
+	ExcludeFilesLimit   int `json:"exclude_files_limit"`   // -1: trim all (none kept), 0: do not trim, >0: keep N file changes
+	ExcludeCommitsLimit int `json:"exclude_commits_limit"` // -1: trim all (none kept), 0: do not trim, >0: keep N commits
 	// default: false
 	Active bool `json:"active"`
 }
@@ -58,7 +64,10 @@ type EditHookOption struct {
 	Events              []string          `json:"events"`
 	BranchFilter        string            `json:"branch_filter" binding:"GlobPattern"`
 	AuthorizationHeader string            `json:"authorization_header"`
-	Active              *bool             `json:"active"`
+	// Payload size optimization options
+	ExcludeFilesLimit   *int  `json:"exclude_files_limit"`   // -1: trim all (none kept), 0: do not trim, >0: keep N file changes
+	ExcludeCommitsLimit *int  `json:"exclude_commits_limit"` // -1: trim all (none kept), 0: do not trim, >0: keep N commits
+	Active              *bool `json:"active"`
 }
 
 // Payloader payload is some part of one hook

routers/api/v1/utils/hook.go

@@ -224,8 +224,10 @@ func addHook(ctx *context.APIContext, form *api.CreateHookOption, ownerID, repoI
 			HookEvents:   updateHookEvents(form.Events),
 			BranchFilter: form.BranchFilter,
 		},
-		IsActive: form.Active,
-		Type:     form.Type,
+		IsActive:            form.Active,
+		Type:                form.Type,
+		ExcludeFilesLimit:   form.ExcludeFilesLimit,
+		ExcludeCommitsLimit: form.ExcludeCommitsLimit,
 	}
 	err := w.SetHeaderAuthorization(form.AuthorizationHeader)
 	if err != nil {
@@ -391,6 +393,14 @@ func editHook(ctx *context.APIContext, form *api.EditHookOption, w *webhook.Webh
 		w.IsActive = *form.Active
 	}
 
+	if form.ExcludeFilesLimit != nil {
+		w.ExcludeFilesLimit = *form.ExcludeFilesLimit
+	}
+
+	if form.ExcludeCommitsLimit != nil {
+		w.ExcludeCommitsLimit = *form.ExcludeCommitsLimit
+	}
+
 	if err := webhook.UpdateWebhook(ctx, w); err != nil {
 		ctx.APIErrorInternal(err)
 		return false

services/webhook/general.go

@@ -417,6 +417,8 @@ func ToHook(repoLink string, w *webhook_model.Webhook) (*api.Hook, error) {
 		Config:              config,
 		Events:              w.EventsArray(),
 		AuthorizationHeader: authorizationHeader,
+		ExcludeFilesLimit:   w.ExcludeFilesLimit,
+		ExcludeCommitsLimit: w.ExcludeCommitsLimit,
 		Updated:             w.UpdatedUnix.AsTime(),
 		Created:             w.CreatedUnix.AsTime(),
 		BranchFilter:        w.BranchFilter,

tests/integration/repo_webhook_test.go

@@ -1222,3 +1222,59 @@ jobs:
 		assert.Equal(t, "user2/repo1", webhookData.payloads[i].Repo.FullName)
 	}
 }
+
+func Test_WebhookPayloadOptimizationAPI(t *testing.T) {
+	onGiteaRun(t, func(t *testing.T, giteaURL *url.URL) {
+		session := loginUser(t, "user2")
+
+		// Test creating webhook with payload optimization options via API
+		createHookOption := map[string]any{
+			"type": "gitea",
+			"config": map[string]string{
+				"url":          "http://example.com/webhook",
+				"content_type": "json",
+			},
+			"events":                []string{"push"},
+			"exclude_files_limit":   5,
+			"exclude_commits_limit": 10,
+			"active":                true,
+		}
+
+		req := NewRequestWithJSON(t, "POST", "/api/v1/repos/user2/repo1/hooks", createHookOption)
+		resp := session.MakeRequest(t, req, http.StatusCreated)
+
+		var hook api.Hook
+		DecodeJSON(t, resp, &hook)
+
+		// Verify the webhook was created with correct payload optimization settings
+		assert.Equal(t, 5, hook.ExcludeFilesLimit)
+		assert.Equal(t, 10, hook.ExcludeCommitsLimit)
+
+		// Test updating webhook with different payload optimization options
+		editHookOption := map[string]any{
+			"exclude_files_limit":   -1,
+			"exclude_commits_limit": 0,
+		}
+
+		req = NewRequestWithJSON(t, "PATCH", fmt.Sprintf("/api/v1/repos/user2/repo1/hooks/%d", hook.ID), editHookOption)
+		resp = session.MakeRequest(t, req, http.StatusOK)
+
+		var updatedHook api.Hook
+		DecodeJSON(t, resp, &updatedHook)
+
+		// Verify the webhook was updated with correct payload optimization settings
+		assert.Equal(t, -1, updatedHook.ExcludeFilesLimit)
+		assert.Equal(t, 0, updatedHook.ExcludeCommitsLimit)
+
+		// Test getting webhook to verify the settings are persisted
+		req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/user2/repo1/hooks/%d", hook.ID))
+		resp = session.MakeRequest(t, req, http.StatusOK)
+
+		var retrievedHook api.Hook
+		DecodeJSON(t, resp, &retrievedHook)
+
+		// Verify the webhook settings are correctly retrieved
+		assert.Equal(t, -1, retrievedHook.ExcludeFilesLimit)
+		assert.Equal(t, 0, retrievedHook.ExcludeCommitsLimit)
+	})
+}