Add webhook payload size optimization options

Author: kerwin612

models/migrations/migrations.go

@@ -382,6 +382,7 @@ func prepareMigrationTasks() []*migration {
 newMigration(318, "Add anonymous_access_mode for repo_unit", v1_24.AddRepoUnitAnonymousAccessMode),
 newMigration(319, "Add ExclusiveOrder to Label table", v1_24.AddExclusiveOrderColumnToLabelTable),
 newMigration(320, "Migrate two_factor_policy to login_source table", v1_24.MigrateSkipTwoFactor),
+newMigration(321, "Add webhook payload optimization columns", v1_24.AddWebhookPayloadOptimizationColumns),
 }
 return preparedMigrations
 }

models/migrations/v1_24/v321.go

@@ -0,0 +1,23 @@
+// Copyright 2025 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package v1_24
+
+import (
+"xorm.io/xorm"
+)
+
+func AddWebhookPayloadOptimizationColumns(x *xorm.Engine) error {
+type Webhook struct {
+ExcludeFiles bool `xorm:"exclude_files NOT NULL DEFAULT false"`
+ExcludeCommits bool `xorm:"exclude_commits NOT NULL DEFAULT false"`
+}
+_, err := x.SyncWithOptions(
+xorm.SyncOptions{
+IgnoreConstrains: true,
+IgnoreIndices: true,
+},
+new(Webhook),
+)
+return err
+}

models/webhook/webhook.go

@@ -139,6 +139,10 @@ type Webhook struct {
 // HeaderAuthorizationEncrypted should be accessed using HeaderAuthorization() and SetHeaderAuthorization()
 HeaderAuthorizationEncrypted string `xorm:"TEXT"`
 
+// Payload size optimization options
+ExcludeFiles bool `xorm:"exclude_files"` // Exclude file changes from commit payloads
+ExcludeCommits bool `xorm:"exclude_commits"` // Exclude commits and head_commit from push payloads
+
 CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
 UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
 }

models/webhook/webhook_test.go

@@ -330,3 +330,45 @@ func TestCleanupHookTaskTable_OlderThan_LeavesTaskEarlierThanAgeToDelete(t *test
 assert.NoError(t, CleanupHookTaskTable(t.Context(), OlderThan, 168*time.Hour, 0))
 unittest.AssertExistsAndLoadBean(t, hookTask)
 }
+
+func TestWebhookPayloadOptimization(t *testing.T) {
+assert.NoError(t, unittest.PrepareTestDatabase())
+
+webhook := &Webhook{
+RepoID: 1,
+URL: "http://example.com/webhook",
+HTTPMethod: "POST",
+ContentType: ContentTypeJSON,
+Secret: "secret",
+IsActive: true,
+Type: webhook_module.GITEA,
+ExcludeFiles: true,
+ExcludeCommits: false,
+HookEvent: &webhook_module.HookEvent{
+PushOnly: true,
+},
+}
+
+// Test creating webhook with payload optimization options
+err := CreateWebhook(db.DefaultContext, webhook)
+assert.NoError(t, err)
+assert.NotZero(t, webhook.ID)
+
+// Test retrieving webhook and checking payload optimization options
+retrievedWebhook, err := GetWebhookByID(db.DefaultContext, webhook.ID)
+assert.NoError(t, err)
+assert.True(t, retrievedWebhook.ExcludeFiles)
+assert.False(t, retrievedWebhook.ExcludeCommits)
+
+// Test updating webhook with different payload optimization options
+retrievedWebhook.ExcludeFiles = false
+retrievedWebhook.ExcludeCommits = true
+err = UpdateWebhook(db.DefaultContext, retrievedWebhook)
+assert.NoError(t, err)
+
+// Verify the update
+updatedWebhook, err := GetWebhookByID(db.DefaultContext, webhook.ID)
+assert.NoError(t, err)
+assert.False(t, updatedWebhook.ExcludeFiles)
+assert.True(t, updatedWebhook.ExcludeCommits)
+}

options/locale/locale_en-US.ini

@@ -2424,6 +2424,11 @@ settings.event_package = Package
 settings.event_package_desc = Package created or deleted in a repository.
 settings.branch_filter = Branch filter
 settings.branch_filter_desc = Branch whitelist for push, branch creation and branch deletion events, specified as glob pattern. If empty or <code>*</code>, events for all branches are reported. See <a href="%[1]s">%[2]s</a> documentation for syntax. Examples: <code>master</code>, <code>{master,release*}</code>.
+settings.payload_optimization = Payload Size Optimization
+settings.exclude_files = Exclude file changes
+settings.exclude_files_desc = Remove file information (added, removed, modified files) from commit payloads to reduce webhook size.
+settings.exclude_commits = Exclude commits
+settings.exclude_commits_desc = Remove commits and head_commit from push payloads, keeping only before, after and total_commits fields.
 settings.authorization_header = Authorization Header
 settings.authorization_header_desc = Will be included as authorization header for requests when present. Examples: %s.
 settings.active = Active

routers/web/repo/setting/webhook.go

@@ -243,6 +243,8 @@ func createWebhook(ctx *context.Context, params webhookParams) {
 Meta: string(meta),
 OwnerID: orCtx.OwnerID,
 IsSystemWebhook: orCtx.IsSystemWebhook,
+ExcludeFiles: params.WebhookForm.ExcludeFiles,
+ExcludeCommits: params.WebhookForm.ExcludeCommits,
 }
 err = w.SetHeaderAuthorization(params.WebhookForm.AuthorizationHeader)
 if err != nil {
@@ -294,6 +296,8 @@ func editWebhook(ctx *context.Context, params webhookParams) {
 w.IsActive = params.WebhookForm.Active
 w.HTTPMethod = params.HTTPMethod
 w.Meta = string(meta)
+w.ExcludeFiles = params.WebhookForm.ExcludeFiles
+w.ExcludeCommits = params.WebhookForm.ExcludeCommits
 
 err = w.SetHeaderAuthorization(params.WebhookForm.AuthorizationHeader)
 if err != nil {

services/forms/repo_form.go

@@ -239,6 +239,9 @@ type WebhookForm struct {
 BranchFilter string `binding:"GlobPattern"`
 AuthorizationHeader string
 Secret string
+// Payload size optimization options
+ExcludeFiles bool // Exclude file changes from commit payloads
+ExcludeCommits bool // Exclude commits and head_commit from push payloads
 }
 
 // PushOnly if the hook will be triggered when push

services/webhook/notifier.go

@@ -7,6 +7,7 @@ import (
 "context"
 
 actions_model "code.gitea.io/gitea/models/actions"
+"code.gitea.io/gitea/models/db"
 git_model "code.gitea.io/gitea/models/git"
 issues_model "code.gitea.io/gitea/models/issues"
 "code.gitea.io/gitea/models/organization"
@@ -15,10 +16,12 @@ import (
 access_model "code.gitea.io/gitea/models/perm/access"
 repo_model "code.gitea.io/gitea/models/repo"
 user_model "code.gitea.io/gitea/models/user"
+webhook_model "code.gitea.io/gitea/models/webhook"
 "code.gitea.io/gitea/modules/git"
 "code.gitea.io/gitea/modules/gitrepo"
 "code.gitea.io/gitea/modules/httplib"
 "code.gitea.io/gitea/modules/log"
+"code.gitea.io/gitea/modules/optional"
 "code.gitea.io/gitea/modules/repository"
 "code.gitea.io/gitea/modules/setting"
 api "code.gitea.io/gitea/modules/structs"
@@ -640,6 +643,57 @@ func (m *webhookNotifier) IssueChangeMilestone(ctx context.Context, doer *user_m
 }
 }
 
+// applyWebhookPayloadOptimizations applies payload size optimizations based on webhook configurations
+func (m *webhookNotifier) applyWebhookPayloadOptimizations(ctx context.Context, repo *repo_model.Repository, apiCommits []*api.PayloadCommit, apiHeadCommit *api.PayloadCommit) ([]*api.PayloadCommit, *api.PayloadCommit) {
+// Get webhooks for this repository to check their configuration
+webhooks, err := db.Find[webhook_model.Webhook](ctx, webhook_model.ListWebhookOptions{
+RepoID: repo.ID,
+IsActive: optional.Some(true),
+})
+if err != nil {
+log.Error("Failed to get webhooks for repository %d: %v", repo.ID, err)
+// Continue with default behavior if we can't get webhooks
+return apiCommits, apiHeadCommit
+}
+
+// Check if any webhook has payload optimization options enabled
+hasExcludeFiles := false
+hasExcludeCommits := false
+for _, webhook := range webhooks {
+if webhook.HasEvent(webhook_module.HookEventPush) {
+if webhook.ExcludeFiles {
+hasExcludeFiles = true
+}
+if webhook.ExcludeCommits {
+hasExcludeCommits = true
+}
+}
+}
+
+// Apply payload optimizations based on webhook configurations
+if hasExcludeFiles {
+// Remove file information from commits
+for _, commit := range apiCommits {
+commit.Added = nil
+commit.Removed = nil
+commit.Modified = nil
+}
+if apiHeadCommit != nil {
+apiHeadCommit.Added = nil
+apiHeadCommit.Removed = nil
+apiHeadCommit.Modified = nil
+}
+}
+
+if hasExcludeCommits {
+// Exclude commits and head_commit from payload
+apiCommits = nil
+apiHeadCommit = nil
+}
+
+return apiCommits, apiHeadCommit
+}
+
 func (m *webhookNotifier) PushCommits(ctx context.Context, pusher *user_model.User, repo *repo_model.Repository, opts *repository.PushUpdateOptions, commits *repository.PushCommits) {
 apiPusher := convert.ToUser(ctx, pusher, nil)
 apiCommits, apiHeadCommit, err := commits.ToAPIPayloadCommits(ctx, repo)
@@ -648,6 +702,9 @@ func (m *webhookNotifier) PushCommits(ctx context.Context, pusher *user_model.Us
 return
 }
 
+// Apply payload optimizations
+apiCommits, apiHeadCommit = m.applyWebhookPayloadOptimizations(ctx, repo, apiCommits, apiHeadCommit)
+
 if err := PrepareWebhooks(ctx, EventSource{Repository: repo}, webhook_module.HookEventPush, &api.PushPayload{
 Ref: opts.RefFullName.String(),
 Before: opts.OldCommitID,
@@ -887,6 +944,9 @@ func (m *webhookNotifier) SyncPushCommits(ctx context.Context, pusher *user_mode
 return
 }
 
+// Apply payload optimizations
+apiCommits, apiHeadCommit = m.applyWebhookPayloadOptimizations(ctx, repo, apiCommits, apiHeadCommit)
+
 if err := PrepareWebhooks(ctx, EventSource{Repository: repo}, webhook_module.HookEventPush, &api.PushPayload{
 Ref: opts.RefFullName.String(),
 Before: opts.OldCommitID,

services/webhook/webhook_test.go

@@ -91,3 +91,82 @@ func TestWebhookUserMail(t *testing.T) {
 assert.Equal(t, user.GetPlaceholderEmail(), convert.ToUser(db.DefaultContext, user, nil).Email)
 assert.Equal(t, user.Email, convert.ToUser(db.DefaultContext, user, user).Email)
 }
+
+func TestWebhookPayloadOptimization(t *testing.T) {
+assert.NoError(t, unittest.PrepareTestDatabase())
+
+// Create a test repository
+repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
+
+// Create a webhook with payload optimization enabled
+webhook := &webhook_model.Webhook{
+RepoID: repo.ID,
+URL: "http://example.com/webhook",
+HTTPMethod: "POST",
+ContentType: webhook_model.ContentTypeJSON,
+Secret: "secret",
+IsActive: true,
+Type: webhook_module.GITEA,
+ExcludeFiles: true,
+ExcludeCommits: false,
+HookEvent: &webhook_module.HookEvent{
+PushOnly: true,
+},
+}
+
+err := webhook_model.CreateWebhook(db.DefaultContext, webhook)
+assert.NoError(t, err)
+
+// Create test commits with file information
+apiCommits := []*api.PayloadCommit{
+{
+ID: "abc123",
+Message: "Test commit",
+Added: []string{"file1.txt", "file2.txt"},
+Removed: []string{"oldfile.txt"},
+Modified: []string{"modified.txt"},
+},
+{
+ID: "def456",
+Message: "Another commit",
+Added: []string{"file3.txt"},
+Removed: []string{},
+Modified: []string{"file1.txt"},
+},
+}
+
+apiHeadCommit := &api.PayloadCommit{
+ID: "def456",
+Message: "Another commit",
+Added: []string{"file3.txt"},
+Removed: []string{},
+Modified: []string{"file1.txt"},
+}
+
+// Test payload optimization
+notifier := &webhookNotifier{}
+optimizedCommits, optimizedHeadCommit := notifier.applyWebhookPayloadOptimizations(db.DefaultContext, repo, apiCommits, apiHeadCommit)
+
+// Verify that file information was removed when ExcludeFiles is true
+assert.Nil(t, optimizedCommits[0].Added)
+assert.Nil(t, optimizedCommits[0].Removed)
+assert.Nil(t, optimizedCommits[0].Modified)
+assert.Nil(t, optimizedCommits[1].Added)
+assert.Nil(t, optimizedCommits[1].Removed)
+assert.Nil(t, optimizedCommits[1].Modified)
+assert.Nil(t, optimizedHeadCommit.Added)
+assert.Nil(t, optimizedHeadCommit.Removed)
+assert.Nil(t, optimizedHeadCommit.Modified)
+
+// Test with ExcludeCommits enabled
+webhook.ExcludeFiles = false
+webhook.ExcludeCommits = true
+err = webhook_model.UpdateWebhook(db.DefaultContext, webhook)
+assert.NoError(t, err)
+
+optimizedCommits, optimizedHeadCommit = notifier.applyWebhookPayloadOptimizations(db.DefaultContext, repo, apiCommits, apiHeadCommit)
+
+// Verify that commits and head_commit were excluded
+assert.Nil(t, optimizedCommits)
+assert.Nil(t, optimizedHeadCommit)
+}

templates/repo/settings/webhook/settings.tmpl

@@ -47,6 +47,25 @@
 <span class="help">{{ctx.Locale.Tr "repo.settings.branch_filter_desc" "https://pkg.go.dev/github.com/gobwas/glob#Compile" "github.com/gobwas/glob"}}</span>
 </div>
 
+<!-- Payload size optimization options -->
+<div class="field">
+<h4>{{ctx.Locale.Tr "repo.settings.payload_optimization"}}</h4>
+<div class="field">
+<div class="ui checkbox">
+<input name="exclude_files" type="checkbox" {{if .Webhook.ExcludeFiles}}checked{{end}}>
+<label>{{ctx.Locale.Tr "repo.settings.exclude_files"}}</label>
+<span class="help">{{ctx.Locale.Tr "repo.settings.exclude_files_desc"}}</span>
+</div>
+</div>
+<div class="field">
+<div class="ui checkbox">
+<input name="exclude_commits" type="checkbox" {{if .Webhook.ExcludeCommits}}checked{{end}}>
+<label>{{ctx.Locale.Tr "repo.settings.exclude_commits"}}</label>
+<span class="help">{{ctx.Locale.Tr "repo.settings.exclude_commits_desc"}}</span>
+</div>
+</div>
+</div>
+
 <div class="field">
 <h4>{{ctx.Locale.Tr "repo.settings.event_desc"}}</h4>
 <div class="grouped event type fields">