You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gitea/templates/repo/settings/webhook
oliverpool 26653b196b
Store webhook event in database (#29145)
Refactor the webhook logic, to have the type-dependent processing happen
only in one place.

---

## Current webhook flow

1. An event happens
2. It is pre-processed (depending on the webhook type) and its body is
added to a task queue
3. When the task is processed, some more logic (depending on the webhook
type as well) is applied to make an HTTP request

This means that webhook-type dependant logic is needed in step 2 and 3.
This is cumbersome and brittle to maintain.

Updated webhook flow with this PR:
1. An event happens
2. It is stored as-is and added to a task queue
3. When the task is processed, the event is processed (depending on the
webhook type) to make an HTTP request

So the only webhook-type dependent logic happens in one place (step 3)
which should be much more robust.

## Consequences of the refactor

- the raw event must be stored in the hooktask (until now, the
pre-processed body was stored)
- to ensure that previous hooktasks are correctly sent, a
`payload_version` is added (version 1: the body has already been
pre-process / version 2: the body is the raw event)

So future webhook additions will only have to deal with creating an
http.Request based on the raw event (no need to adjust the code in
multiple places, like currently).

Moreover since this processing happens when fetching from the task
queue, it ensures that the queuing of new events (upon a `git push` for
instance) does not get slowed down by a slow webhook.

As a concrete example, the PR #19307 for custom webhooks, should be
substantially smaller:
- no need to change `services/webhook/deliver.go` 
- minimal change in `services/webhook/webhook.go` (add the new webhook
to the map)
- no need to change all the individual webhook files (since with this
refactor the `*webhook_model.Webhook` is provided as argument)
11 months ago
..
base.tmpl Change to vertical navbar layout for secondary navbar for repo/user/admin settings (#24246) 2 years ago
base_list.tmpl Remove unnecessary SanitizeHTML from code (#29575) 11 months ago
delete_modal.tmpl Always use `ctx.Locale.Tr` inside templates (#27231) 1 year ago
dingtalk.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 12 months ago
discord.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 12 months ago
feishu.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 12 months ago
gitea.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 12 months ago
gogs.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 12 months ago
history.tmpl Store webhook event in database (#29145) 11 months ago
link_menu.tmpl Change webhook-type in create-view (#29114) 12 months ago
list.tmpl Change to vertical navbar layout for secondary navbar for repo/user/admin settings (#24246) 2 years ago
matrix.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 12 months ago
msteams.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 12 months ago
new.tmpl Always use `ctx.Locale.Tr` inside templates (#27231) 1 year ago
packagist.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 12 months ago
settings.tmpl Refactor Safe modifier (#29392) 12 months ago
slack.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 12 months ago
telegram.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 12 months ago
wechatwork.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 12 months ago