Add webhook payload size optimization options #35129

kerwin612 · 2025-07-19T14:13:21Z

This PR adds webhook payload size optimization options to help reduce payload size for large commits or pushes with many commits. This feature is particularly useful for target URLs that restrict payload size or have performance problems handling large JSON parsing.

wxiaoguang · 2025-07-19T14:25:00Z

It should be more flexible to use "limit number" instead of "bool"

kerwin612 · 2025-07-23T08:56:26Z

It should be more flexible to use "limit number" instead of "bool"

Is this OK?

Signed-off-by: Kerwin Bryant <[email protected]>

wxiaoguang · 2025-07-30T11:16:42Z

IIRC all other places use "-1" for "no-limit" when "0" is used for "limit to zero".
- For example: the limit of the repo number
Maybe we need a JSON column but not many new separate columns.
There are some issues asking about "commit order", so some users want the first N commits, while some other users want the last N commits
- Use forward order for commits in webhook notifications #21313
- Don't reverse order of commits in webhooks #21252

kerwin612 · 2025-08-04T06:33:50Z

wxiaoguang · 2025-08-28T03:34:29Z

models/migrations/v1_25/v322.go

+
+func AddWebhookPayloadOptimizationColumns(x *xorm.Engine) error {
+	type Webhook struct {
+		MetaSettings string `xorm:"meta_settings TEXT"`


XORM natively supports JSON type IIRC

models/webhook/webhook.go

wxiaoguang · 2025-08-28T03:36:26Z

routers/api/v1/utils/hook.go

+}
+
+// getPayloadConfigLimit extracts the "limit" integer value from a payload config map
+func getPayloadConfigLimit(m map[string]any) int {


It seems fragile, I don't think we need these tricks to parse form input

wxiaoguang · 2025-08-28T03:37:55Z

tests/integration/repo_webhook_test.go

+					"files": map[string]any{
+						"enable": true,
+						"limit":  2,
+					},


What does "enable" mean?

If "enable=false", then "no files" or "no commits"? Or "enable=false" means "disable the limit"?

Co-authored-by: wxiaoguang <[email protected]> Signed-off-by: Kerwin Bryant <[email protected]>

…win612/gitea into kerwin612-feature/webhook-payload-optimization

silverwind

JS changes look reasonable

wxiaoguang · 2025-10-15T15:07:27Z

JS changes look reasonable

Actually no, there are other webhook pages like page-content admin settings new webhook, the JS code won't work.

The code is still fragile and needs to be improved (not only JS, but also the problems I commented above)

silverwind · 2025-10-15T16:10:04Z

But it's matching on .page-content.repository.settings.webhook which is unique, right?

wxiaoguang · 2025-10-15T16:11:55Z

But it's matching on .page-content.repository.settings.webhook which is unique, right?

All webhook pages use the same template. All pages need the JS. unique is wrong.

silverwind · 2025-10-16T04:42:58Z

Hmm, we should probably split the webhook settings template into two files with distinct classes, possibly sharing parts via subtemplates.

silverwind · 2025-10-16T04:44:50Z

BTW instead of these class queries, checking the URL would be more accurate and not have issues when templates are re-used.

wxiaoguang · 2025-10-16T05:50:14Z

Hmm, we should probably split the webhook settings template into two files with distinct classes, possibly sharing parts via subtemplates.

They already used shared templates. The page-content admin settings new webhook is the page container's class, and it is abused, that why I said it is wrong.

BTW instead of these class queries, checking the URL would be more accurate and not have issues when templates are re-used.

I believe "checking the URL" is more fragile and infeasible.

Actually our data-global-init framework should already be able to handle this case properly.

<input data-global-init="checked-switch-display" data-checked-true-target=".some-elements" data-checked-false-target=".some-other-elements">

And it also helps #35129 (comment) to make code more maintainable and readable.

<input data-global-init="checked-switch-enabled" data-checked-true-target=".some-elements" data-checked-false-target=".some-other-elements">

Add webhook payload size optimization options

1915361

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jul 19, 2025

github-actions bot added modifies/translation modifies/go Pull requests that update Go code modifies/templates This PR modifies the template files modifies/migrations labels Jul 19, 2025

kerwin612 force-pushed the feature/webhook-payload-optimization branch 6 times, most recently from f249f67 to 47c395d Compare July 23, 2025 08:09

refactor webhook payload optimization: switch from bool to limit number

5472d66

kerwin612 force-pushed the feature/webhook-payload-optimization branch from 47c395d to 5472d66 Compare July 23, 2025 08:37

kerwin612 added 3 commits July 24, 2025 19:48

Merge branch 'main' into feature/webhook-payload-optimization

39718b2

Signed-off-by: Kerwin Bryant <[email protected]>

fix

9682610

refactor: swap webhook payload optimization logic (-1/0 values)

544e445

kerwin612 requested a review from lunny July 30, 2025 04:39

Merge branch 'main' into feature/webhook-payload-optimization

42a880f

lunny approved these changes Jul 30, 2025

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jul 30, 2025

add webhook payload optimization API support

6e07c6f

github-actions bot added the modifies/api This PR adds API routes or modifies them label Jul 30, 2025

Merge branch 'main' into feature/webhook-payload-optimization

11cdba1

kerwin612 force-pushed the feature/webhook-payload-optimization branch from 5e828e9 to 258d8ee Compare August 4, 2025 07:07

kerwin612 added 3 commits August 24, 2025 20:58

clean code

f4ea1a1

clean code

98d4da1

clean code

94225ed

kerwin612 requested a review from wxiaoguang August 24, 2025 14:02

hiifong approved these changes Aug 28, 2025

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Aug 28, 2025

wxiaoguang reviewed Aug 28, 2025

View reviewed changes

models/webhook/webhook.go Outdated Show resolved Hide resolved

wxiaoguang reviewed Aug 28, 2025

View reviewed changes

wxiaoguang marked this pull request as draft August 28, 2025 03:39

Update models/webhook/webhook.go

46c0824

Co-authored-by: wxiaoguang <[email protected]> Signed-off-by: Kerwin Bryant <[email protected]>

lunny modified the milestones: 1.25.0, 1.26.0 Sep 18, 2025

lunny added 2 commits September 17, 2025 17:59

Merge branch 'feature/webhook-payload-optimization' of github.com:ker…

7f9debb

…win612/gitea into kerwin612-feature/webhook-payload-optimization

revert unnecessary change

ef6aeda

wxiaoguang mentioned this pull request Oct 8, 2025

Telegram WebHook shows all but one commit on multiple commit push #35598

Open

Merge branch 'feature/webhook-payload-optimization' of github.com:ker…

e59bbd0

…win612/gitea into kerwin612-feature/webhook-payload-optimization

github-actions bot added modifies/cli PR changes something on the CLI, i.e. gitea doctor or gitea admin modifies/internal modifies/dependencies labels Oct 15, 2025

silverwind approved these changes Oct 15, 2025

View reviewed changes

silverwind self-requested a review October 16, 2025 04:43

Uh oh!

Add webhook payload size optimization options #35129

Are you sure you want to change the base?

Add webhook payload size optimization options #35129

Uh oh!

Conversation

kerwin612 commented Jul 19, 2025

Uh oh!

wxiaoguang commented Jul 19, 2025

Uh oh!

kerwin612 commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wxiaoguang commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kerwin612 commented Aug 4, 2025

Uh oh!

wxiaoguang Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wxiaoguang Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

wxiaoguang Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silverwind left a comment

Choose a reason for hiding this comment

Uh oh!

wxiaoguang commented Oct 15, 2025

Uh oh!

silverwind commented Oct 15, 2025

Uh oh!

wxiaoguang commented Oct 15, 2025

Uh oh!

silverwind commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

silverwind commented Oct 16, 2025

Uh oh!

wxiaoguang commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kerwin612 commented Jul 23, 2025 •

edited

Loading

wxiaoguang commented Jul 30, 2025 •

edited

Loading

wxiaoguang Aug 28, 2025 •

edited

Loading

silverwind commented Oct 16, 2025 •

edited

Loading

wxiaoguang commented Oct 16, 2025 •

edited

Loading