-
-
Notifications
You must be signed in to change notification settings - Fork 6k
Add webhook payload size optimization options #35129
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kerwin612
wants to merge
14
commits into
go-gitea:main
Choose a base branch
from
kerwin612:feature/webhook-payload-optimization
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
1915361
Add webhook payload size optimization options
kerwin612 5472d66
refactor webhook payload optimization: switch from bool to limit number
kerwin612 39718b2
Merge branch 'main' into feature/webhook-payload-optimization
kerwin612 9682610
fix
kerwin612 544e445
refactor: swap webhook payload optimization logic (-1/0 values)
kerwin612 42a880f
Merge branch 'main' into feature/webhook-payload-optimization
kerwin612 6e07c6f
add webhook payload optimization API support
kerwin612 11cdba1
Merge branch 'main' into feature/webhook-payload-optimization
kerwin612 b718c54
refactor: replace webhook payload optimization with JSON-based config…
kerwin612 9767573
Merge branch 'main' into feature/webhook-payload-optimization
kerwin612 655bfcd
clean code
kerwin612 6b635dc
Merge branch 'main' into feature/webhook-payload-optimization
kerwin612 6d932c8
clean code
kerwin612 eec07ee
clean code
kerwin612 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
// Copyright 2025 The Gitea Authors. All rights reserved. | ||
// SPDX-License-Identifier: MIT | ||
|
||
package v1_25 | ||
|
||
import ( | ||
"xorm.io/xorm" | ||
) | ||
|
||
func AddWebhookPayloadOptimizationColumns(x *xorm.Engine) error { | ||
type Webhook struct { | ||
MetaSettings string `xorm:"meta_settings TEXT"` | ||
} | ||
_, err := x.SyncWithOptions( | ||
xorm.SyncOptions{ | ||
IgnoreConstrains: true, | ||
IgnoreIndices: true, | ||
}, | ||
new(Webhook), | ||
) | ||
return err | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,6 +22,38 @@ import ( | |
"xorm.io/builder" | ||
) | ||
|
||
// MetaSettings represents the metadata settings for webhook | ||
type MetaSettings struct { | ||
PayloadOptimization *PayloadOptimizationConfig `json:"payload_optimization,omitempty"` // Payload optimization configuration | ||
} | ||
|
||
// 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 { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Here it is likely just a "config" system. |
||
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) | ||
} | ||
|
||
// DefaultMetaSettings returns the default webhook meta settings | ||
func DefaultMetaSettings() *MetaSettings { | ||
return &MetaSettings{ | ||
PayloadOptimization: DefaultPayloadOptimizationConfig(), | ||
} | ||
} | ||
|
||
// 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 | ||
|
@@ -139,6 +171,9 @@ type Webhook struct { | |
// HeaderAuthorizationEncrypted should be accessed using HeaderAuthorization() and SetHeaderAuthorization() | ||
HeaderAuthorizationEncrypted string `xorm:"TEXT"` | ||
|
||
// Webhook metadata settings (JSON format) | ||
MetaSettings string `xorm:"meta_settings TEXT"` // JSON: webhook metadata configuration | ||
|
||
CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"` | ||
UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"` | ||
} | ||
|
@@ -346,3 +381,95 @@ func DeleteWebhookByOwnerID(ctx context.Context, ownerID, id int64) error { | |
} | ||
return DeleteWebhookByID(ctx, id) | ||
} | ||
|
||
// GetMetaSettings returns the webhook meta settings | ||
func (w *Webhook) GetMetaSettings() *MetaSettings { | ||
if w.MetaSettings == "" { | ||
return DefaultMetaSettings() | ||
} | ||
|
||
var settings MetaSettings | ||
if err := json.Unmarshal([]byte(w.MetaSettings), &settings); err != nil { | ||
log.Error("Failed to unmarshal webhook meta settings: %v", err) | ||
return DefaultMetaSettings() | ||
} | ||
|
||
// Ensure payload optimization config is initialized | ||
if settings.PayloadOptimization == nil { | ||
settings.PayloadOptimization = DefaultPayloadOptimizationConfig() | ||
} | ||
|
||
return &settings | ||
} | ||
|
||
// GetPayloadOptimizationConfig returns the payload optimization configuration | ||
func (w *Webhook) GetPayloadOptimizationConfig() *PayloadOptimizationConfig { | ||
return w.GetMetaSettings().PayloadOptimization | ||
} | ||
|
||
// SetMetaSettings sets the webhook meta settings | ||
func (w *Webhook) SetMetaSettings(settings *MetaSettings) error { | ||
if settings == nil { | ||
settings = DefaultMetaSettings() | ||
} | ||
|
||
data, err := json.Marshal(settings) | ||
if err != nil { | ||
return fmt.Errorf("failed to marshal webhook meta settings: %w", err) | ||
} | ||
|
||
w.MetaSettings = string(data) | ||
return nil | ||
} | ||
|
||
// SetPayloadOptimizationConfig sets the payload optimization configuration | ||
func (w *Webhook) SetPayloadOptimizationConfig(config *PayloadOptimizationConfig) error { | ||
settings := w.GetMetaSettings() | ||
if config == nil { | ||
config = DefaultPayloadOptimizationConfig() | ||
} | ||
settings.PayloadOptimization = config | ||
return w.SetMetaSettings(settings) | ||
} | ||
|
||
// 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 | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All pointers can be replaced by the struct, then no need to do any nil check.
And, JSON default values work this way: