gitea/models
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
..
actions remove util.OptionalBool and related functions (#29513) 2024-03-02 16:42:31 +01:00
activities Avoid issue info panic (#29625) 2024-03-06 13:12:44 +00:00
admin Next round of `db.DefaultContext` refactor (#27089) 2023-09-16 14:39:12 +00:00
asymkey Move some asymkey functions to service layer (#28894) 2024-03-04 08:57:39 +00:00
auth remove util.OptionalBool and related functions (#29513) 2024-03-02 16:42:31 +01:00
avatars Refactor some legacy code and remove unused code (#28622) 2023-12-28 09:38:59 +00:00
db Add slow SQL query warning (#27545) 2024-02-23 00:57:24 +00:00
dbfs make writing main test easier (#27270) 2023-09-28 01:38:53 +00:00
fixtures Store webhook event in database (#29145) 2024-03-07 23:18:38 +01:00
git Sync branches to DB immediately when handle git hook calling (#29493) 2024-03-06 16:47:52 +08:00
issues Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
migrations Store webhook event in database (#29145) 2024-03-07 23:18:38 +01:00
organization Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
packages Fix incorrect relative/absolute URL usages (#29531) 2024-03-02 17:38:38 +00:00
perm Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
project remove util.OptionalBool and related functions (#29513) 2024-03-02 16:42:31 +01:00
pull Add support for sha256 repositories (#23894) 2024-01-19 17:05:02 +01:00
repo Make wiki default branch name changable (#29603) 2024-03-06 14:26:32 +08:00
secret Use db.Find instead of writing methods for every object (#28084) 2023-11-24 03:49:41 +00:00
shared/types Refactor locale&string&template related code (#29165) 2024-02-14 21:48:45 +00:00
system Refactor deletion (#28610) 2023-12-25 21:25:29 +01:00
unit Make actions default enabled for newly created repository if global configuraion enabled (#27482) 2023-10-10 14:45:31 +00:00
unittest Workaround to clean up old reviews on creating a new one (#28554) 2024-02-19 14:42:18 +01:00
user Skip email domain check when admins edit user emails (#29609) 2024-03-05 16:51:56 +00:00
webhook Store webhook event in database (#29145) 2024-03-07 23:18:38 +01:00
error.go Add merge style `fast-forward-only` (#28954) 2024-02-12 23:37:23 +01:00
fixture_generation.go Replace more db.DefaultContext (#27628) 2023-10-15 17:46:06 +02:00
fixture_test.go Replace more db.DefaultContext (#27628) 2023-10-15 17:46:06 +02:00
main_test.go make writing main test easier (#27270) 2023-09-28 01:38:53 +00:00
org.go Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
org_team.go Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
org_team_test.go Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
org_test.go Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
repo.go Refactor deletion (#28610) 2023-12-25 21:25:29 +01:00
repo_test.go Penultimate round of `db.DefaultContext` refactor (#27414) 2023-10-11 04:24:07 +00:00
repo_transfer.go Add user blocking (#29028) 2024-03-04 08:16:03 +00:00