1
0
mirror of https://github.com/go-gitea/gitea.git synced 2024-12-22 17:34:03 +03:00
gitea/templates
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)
2024-03-07 23:18:38 +01:00
..
admin Replace more gt- with tw-, update frontend docs (#29595) 2024-03-05 05:29:32 +00:00
api/packages/pypi Remove incorrect HTML self close tag (#23748) 2023-03-27 18:05:51 +02:00
base Replace more gt- with tw-, update frontend docs (#29595) 2024-03-05 05:29:32 +00:00
code Fix wrong line number in code search result (#29260) 2024-03-06 07:24:43 +00:00
custom Add footer extra links template (#9576) 2020-01-03 20:41:56 +02:00
devtest Use tailwind instead of gt-[wh]- helper classes (#29423) 2024-02-27 14:31:41 +00:00
explore Filter Repositories by type (#29231) 2024-03-03 10:18:34 +00:00
mail Remove unnecessary SanitizeHTML from code (#29575) 2024-03-04 12:02:45 +00:00
org Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
package Fix incorrect package link method calls in templates (#29580) 2024-03-04 10:57:30 +00:00
projects Replace some gt- classes with tw- (#29570) 2024-03-04 03:33:20 +00:00
repo Store webhook event in database (#29145) 2024-03-07 23:18:38 +01:00
shared Fix wrong line number in code search result (#29260) 2024-03-06 07:24:43 +00:00
status Replace more gt- with tw-, update frontend docs (#29595) 2024-03-05 05:29:32 +00:00
swagger Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
user Move all login and account creation page labels to be above inputs (#29432) 2024-03-06 14:20:26 +00:00
webhook Change webhook-type in create-view (#29114) 2024-02-15 14:59:48 +01:00
home.tmpl Remove unnecessary "Str2html" modifier from templates (#29319) 2024-02-22 18:05:47 +00:00
install.tmpl Remove unnecessary "Safe" modifier from templates (#29318) 2024-02-22 17:02:33 +00:00
post-install.tmpl Always use ctx.Locale.Tr inside templates (#27231) 2023-09-25 08:56:50 +00:00