refactor: replace webhook payload optimization with JSON-based configuration

Author: kerwin612

models/migrations/migrations.go

@@ -385,7 +385,7 @@ func prepareMigrationTasks() []*migration {
 		newMigration(320, "Migrate two_factor_policy to login_source table", v1_24.MigrateSkipTwoFactor),
 		// Gitea 1.24.0 ends at database version 321
 		newMigration(321, "Use LONGTEXT for some columns and fix review_state.updated_files column", v1_25.UseLongTextInSomeColumnsAndFixBugs),
-		newMigration(322, "Add webhook payload optimization columns", v1_25.AddWebhookPayloadOptimizationColumns),
+		newMigration(322, "Add webhook payload optimization JSON field", v1_25.AddWebhookPayloadOptimizationColumns),
 	}
 	return preparedMigrations
 }

models/migrations/v1_25/v322.go

@@ -9,8 +9,7 @@ import (
 
 func AddWebhookPayloadOptimizationColumns(x *xorm.Engine) error {
 	type Webhook struct {
-		ExcludeFilesLimit   int `xorm:"exclude_files_limit NOT NULL DEFAULT 0"`
-		ExcludeCommitsLimit int `xorm:"exclude_commits_limit NOT NULL DEFAULT 0"`
+		PayloadOptimization string `xorm:"payload_optimization TEXT"`
 	}
 	_, err := x.SyncWithOptions(
 		xorm.SyncOptions{

models/webhook/webhook.go

@@ -22,6 +22,26 @@ import (
 	"xorm.io/builder"
 )
 
+// PayloadOptimizationConfig represents the configuration for webhook payload optimization
+type PayloadOptimizationConfig struct {
+	Files   *PayloadOptimizationItem `json:"files,omitempty"`   // Files optimization config
+	Commits *PayloadOptimizationItem `json:"commits,omitempty"` // Commits optimization config
+}
+
+// PayloadOptimizationItem represents a single optimization item configuration
+type PayloadOptimizationItem struct {
+	Enable bool `json:"enable"` // Whether to enable optimization for this item
+	Limit  int  `json:"limit"`  // 0: trim all (none kept), >0: keep N items (forward order), <0: keep N items (reverse order)
+}
+
+// DefaultPayloadOptimizationConfig returns the default payload optimization configuration
+func DefaultPayloadOptimizationConfig() *PayloadOptimizationConfig {
+	return &PayloadOptimizationConfig{
+		Files:   &PayloadOptimizationItem{Enable: false, Limit: 0},
+		Commits: &PayloadOptimizationItem{Enable: false, Limit: 0},
+	}
+}
+
 // ErrWebhookNotExist represents a "WebhookNotExist" kind of error.
 type ErrWebhookNotExist struct {
 	ID int64
@@ -140,8 +160,7 @@ type Webhook struct {
 	HeaderAuthorizationEncrypted string `xorm:"TEXT"`
 
 	// Payload size optimization options
-	ExcludeFilesLimit   int `xorm:"exclude_files_limit"`   // -1: trim all (none kept), 0: do not trim, >0: keep N file changes in commit payloads
-	ExcludeCommitsLimit int `xorm:"exclude_commits_limit"` // -1: trim all (none kept), 0: do not trim, >0: keep N commits in push payloads
+	PayloadOptimization string `xorm:"payload_optimization TEXT"` // JSON: {"enable": bool, "limit": int}
 
 	CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
 	UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
@@ -350,3 +369,75 @@ func DeleteWebhookByOwnerID(ctx context.Context, ownerID, id int64) error {
 	}
 	return DeleteWebhookByID(ctx, id)
 }
+
+// GetPayloadOptimizationConfig returns the payload optimization configuration
+func (w *Webhook) GetPayloadOptimizationConfig() *PayloadOptimizationConfig {
+	if w.PayloadOptimization == "" {
+		return DefaultPayloadOptimizationConfig()
+	}
+
+	var config PayloadOptimizationConfig
+	if err := json.Unmarshal([]byte(w.PayloadOptimization), &config); err != nil {
+		log.Error("Failed to unmarshal payload optimization config: %v", err)
+		return DefaultPayloadOptimizationConfig()
+	}
+
+	return &config
+}
+
+// SetPayloadOptimizationConfig sets the payload optimization configuration
+func (w *Webhook) SetPayloadOptimizationConfig(config *PayloadOptimizationConfig) error {
+	if config == nil {
+		config = DefaultPayloadOptimizationConfig()
+	}
+
+	data, err := json.Marshal(config)
+	if err != nil {
+		return fmt.Errorf("failed to marshal payload optimization config: %w", err)
+	}
+
+	w.PayloadOptimization = string(data)
+	return nil
+}
+
+// IsPayloadOptimizationEnabled returns whether payload optimization is enabled
+func (w *Webhook) IsPayloadOptimizationEnabled() bool {
+	config := w.GetPayloadOptimizationConfig()
+	return config.Files.Enable || config.Commits.Enable
+}
+
+// GetPayloadOptimizationLimit returns the payload optimization limit
+func (w *Webhook) GetPayloadOptimizationLimit() int {
+	config := w.GetPayloadOptimizationConfig()
+	if config.Files.Enable {
+		return config.Files.Limit
+	}
+	if config.Commits.Enable {
+		return config.Commits.Limit
+	}
+	return 0
+}
+
+// IsFilesOptimizationEnabled returns whether files optimization is enabled
+func (w *Webhook) IsFilesOptimizationEnabled() bool {
+	config := w.GetPayloadOptimizationConfig()
+	return config.Files.Enable
+}
+
+// GetFilesOptimizationLimit returns the files optimization limit
+func (w *Webhook) GetFilesOptimizationLimit() int {
+	config := w.GetPayloadOptimizationConfig()
+	return config.Files.Limit
+}
+
+// IsCommitsOptimizationEnabled returns whether commits optimization is enabled
+func (w *Webhook) IsCommitsOptimizationEnabled() bool {
+	config := w.GetPayloadOptimizationConfig()
+	return config.Commits.Enable
+}
+
+// GetCommitsOptimizationLimit returns the commits optimization limit
+func (w *Webhook) GetCommitsOptimizationLimit() int {
+	config := w.GetPayloadOptimizationConfig()
+	return config.Commits.Limit
+}

models/webhook/webhook_test.go

@@ -332,43 +332,39 @@ func TestCleanupHookTaskTable_OlderThan_LeavesTaskEarlierThanAgeToDelete(t *test
 }
 
 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,
-		ExcludeFilesLimit:   1,
-		ExcludeCommitsLimit: 0,
-		HookEvent: &webhook_module.HookEvent{
-			PushOnly: true,
+	webhook := &Webhook{}
+
+	// Test default configuration
+	config := webhook.GetPayloadOptimizationConfig()
+	assert.False(t, config.Files.Enable)
+	assert.Equal(t, 0, config.Files.Limit)
+	assert.False(t, config.Commits.Enable)
+	assert.Equal(t, 0, config.Commits.Limit)
+
+	// Test setting configuration
+	newConfig := &PayloadOptimizationConfig{
+		Files: &PayloadOptimizationItem{
+			Enable: true,
+			Limit:  5,
+		},
+		Commits: &PayloadOptimizationItem{
+			Enable: true,
+			Limit:  -3,
 		},
 	}
-
-	// 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.Equal(t, 1, retrievedWebhook.ExcludeFilesLimit)
-	assert.Equal(t, 0, retrievedWebhook.ExcludeCommitsLimit)
-
-	// Test updating webhook with different payload optimization options
-	retrievedWebhook.ExcludeFilesLimit = 0
-	retrievedWebhook.ExcludeCommitsLimit = 2
-	err = UpdateWebhook(db.DefaultContext, retrievedWebhook)
-	assert.NoError(t, err)
-
-	// Verify the update
-	updatedWebhook, err := GetWebhookByID(db.DefaultContext, webhook.ID)
-	assert.NoError(t, err)
-	assert.Equal(t, 0, updatedWebhook.ExcludeFilesLimit)
-	assert.Equal(t, 2, updatedWebhook.ExcludeCommitsLimit)
+	webhook.SetPayloadOptimizationConfig(newConfig)
+
+	// Test getting configuration
+	config = webhook.GetPayloadOptimizationConfig()
+	assert.True(t, config.Files.Enable)
+	assert.Equal(t, 5, config.Files.Limit)
+	assert.True(t, config.Commits.Enable)
+	assert.Equal(t, -3, config.Commits.Limit)
+
+	// Test individual methods
+	assert.True(t, webhook.IsFilesOptimizationEnabled())
+	assert.Equal(t, 5, webhook.GetFilesOptimizationLimit())
+	assert.True(t, webhook.IsCommitsOptimizationEnabled())
+	assert.Equal(t, -3, webhook.GetCommitsOptimizationLimit())
+	assert.True(t, webhook.IsPayloadOptimizationEnabled())
 }

modules/structs/hook.go

@@ -25,9 +25,8 @@ 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
+	// PayloadOptimization configuration for webhook payload optimization
+	PayloadOptimization map[string]interface{} `json:"payload_optimization"`
 	// swagger:strfmt date-time
 	Updated time.Time `json:"updated_at"`
 	// swagger:strfmt date-time
@@ -52,8 +51,7 @@ type CreateHookOption struct {
 	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
+	PayloadOptimization map[string]interface{} `json:"payload_optimization"` // {"enable": bool, "limit": int}
 	// default: false
 	Active bool `json:"active"`
 }
@@ -65,9 +63,8 @@ type EditHookOption struct {
 	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
-	Active              *bool `json:"active"`
+	PayloadOptimization *map[string]interface{} `json:"payload_optimization"` // {"enable": bool, "limit": int}
+	Active              *bool                   `json:"active"`
 }
 
 // Payloader payload is some part of one hook

options/locale/locale_en-US.ini

@@ -2425,10 +2425,12 @@ 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_limit = Limit file changes
-settings.exclude_files_limit_desc = -1: trim all (none kept), 0: do not trim, >0: keep N file changes
-settings.exclude_commits_limit = Limit commits
-settings.exclude_commits_limit_desc = -1: trim all (none kept), 0: do not trim, >0: keep N commits
+settings.payload_optimization_files = Files
+settings.payload_optimization_commits = Commits
+settings.payload_optimization_enable = Enable optimization
+settings.payload_optimization_enable_desc = Enable payload size optimization for this item
+settings.payload_optimization_limit = Limit
+settings.payload_optimization_limit_desc = 0: trim all (none kept), >0: keep N items (forward order), <0: keep N items (reverse order)
 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/api/v1/utils/hook.go

@@ -21,6 +21,33 @@ import (
 	webhook_service "code.gitea.io/gitea/services/webhook"
 )
 
+// getBoolFromMap extracts a boolean value from a map with a default fallback
+func getBoolFromMap(m map[string]interface{}, defaultValue bool) bool { //nolint:unparam
+	if val, ok := m["enable"]; ok {
+		if boolVal, ok := val.(bool); ok {
+			return boolVal
+		}
+	}
+	return defaultValue
+}
+
+// getIntFromMap extracts an integer value from a map with a default fallback
+func getIntFromMap(m map[string]interface{}, defaultValue int) int { //nolint:unparam
+	if val, ok := m["limit"]; ok {
+		switch v := val.(type) {
+		case int:
+			return v
+		case float64:
+			return int(v)
+		case string:
+			if intVal, err := strconv.Atoi(v); err == nil {
+				return intVal
+			}
+		}
+	}
+	return defaultValue
+}
+
 // ListOwnerHooks lists the webhooks of the provided owner
 func ListOwnerHooks(ctx *context.APIContext, owner *user_model.User) {
 	opts := &webhook.ListWebhookOptions{
@@ -224,11 +251,40 @@ func addHook(ctx *context.APIContext, form *api.CreateHookOption, ownerID, repoI
 			HookEvents:   updateHookEvents(form.Events),
 			BranchFilter: form.BranchFilter,
 		},
-		IsActive:            form.Active,
-		Type:                form.Type,
-		ExcludeFilesLimit:   form.ExcludeFilesLimit,
-		ExcludeCommitsLimit: form.ExcludeCommitsLimit,
+		IsActive: form.Active,
+		Type:     form.Type,
+	}
+
+	// Set payload optimization config
+	if form.PayloadOptimization != nil {
+		payloadOptConfig := &webhook.PayloadOptimizationConfig{}
+
+		// Parse files config
+		if filesConfig, ok := form.PayloadOptimization["files"].(map[string]interface{}); ok {
+			payloadOptConfig.Files = &webhook.PayloadOptimizationItem{
+				Enable: getBoolFromMap(filesConfig, false),
+				Limit:  getIntFromMap(filesConfig, 0),
+			}
+		} else {
+			payloadOptConfig.Files = &webhook.PayloadOptimizationItem{Enable: false, Limit: 0}
+		}
+
+		// Parse commits config
+		if commitsConfig, ok := form.PayloadOptimization["commits"].(map[string]interface{}); ok {
+			payloadOptConfig.Commits = &webhook.PayloadOptimizationItem{
+				Enable: getBoolFromMap(commitsConfig, false),
+				Limit:  getIntFromMap(commitsConfig, 0),
+			}
+		} else {
+			payloadOptConfig.Commits = &webhook.PayloadOptimizationItem{Enable: false, Limit: 0}
+		}
+
+		if err := w.SetPayloadOptimizationConfig(payloadOptConfig); err != nil {
+			ctx.APIErrorInternal(err)
+			return nil, false
+		}
 	}
+
 	err := w.SetHeaderAuthorization(form.AuthorizationHeader)
 	if err != nil {
 		ctx.APIErrorInternal(err)
@@ -393,12 +449,34 @@ func editHook(ctx *context.APIContext, form *api.EditHookOption, w *webhook.Webh
 		w.IsActive = *form.Active
 	}
 
-	if form.ExcludeFilesLimit != nil {
-		w.ExcludeFilesLimit = *form.ExcludeFilesLimit
-	}
+	// Update payload optimization config
+	if form.PayloadOptimization != nil {
+		payloadOptConfig := &webhook.PayloadOptimizationConfig{}
+
+		// Parse files config
+		if filesConfig, ok := (*form.PayloadOptimization)["files"].(map[string]interface{}); ok {
+			payloadOptConfig.Files = &webhook.PayloadOptimizationItem{
+				Enable: getBoolFromMap(filesConfig, false),
+				Limit:  getIntFromMap(filesConfig, 0),
+			}
+		} else {
+			payloadOptConfig.Files = &webhook.PayloadOptimizationItem{Enable: false, Limit: 0}
+		}
 
-	if form.ExcludeCommitsLimit != nil {
-		w.ExcludeCommitsLimit = *form.ExcludeCommitsLimit
+		// Parse commits config
+		if commitsConfig, ok := (*form.PayloadOptimization)["commits"].(map[string]interface{}); ok {
+			payloadOptConfig.Commits = &webhook.PayloadOptimizationItem{
+				Enable: getBoolFromMap(commitsConfig, false),
+				Limit:  getIntFromMap(commitsConfig, 0),
+			}
+		} else {
+			payloadOptConfig.Commits = &webhook.PayloadOptimizationItem{Enable: false, Limit: 0}
+		}
+
+		if err := w.SetPayloadOptimizationConfig(payloadOptConfig); err != nil {
+			ctx.APIErrorInternal(err)
+			return false
+		}
 	}
 
 	if err := webhook.UpdateWebhook(ctx, w); err != nil {