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/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)
1 year ago
..
actions remove util.OptionalBool and related functions (#29513) 1 year ago
activities Avoid issue info panic (#29625) 1 year ago
admin
asymkey Move some asymkey functions to service layer (#28894) 1 year ago
auth remove util.OptionalBool and related functions (#29513) 1 year ago
avatars Refactor some legacy code and remove unused code (#28622) 1 year ago
db Add slow SQL query warning (#27545) 1 year ago
dbfs
fixtures Store webhook event in database (#29145) 1 year ago
git Sync branches to DB immediately when handle git hook calling (#29493) 1 year ago
issues Add user blocking (#29028) 1 year ago
migrations Store webhook event in database (#29145) 1 year ago
organization Add user blocking (#29028) 1 year ago
packages Fix incorrect relative/absolute URL usages (#29531) 1 year ago
perm Add user blocking (#29028) 1 year ago
project remove util.OptionalBool and related functions (#29513) 1 year ago
pull Add support for sha256 repositories (#23894) 1 year ago
repo Make wiki default branch name changable (#29603) 1 year ago
secret
shared/types Refactor locale&string&template related code (#29165) 1 year ago
system
unit
unittest Workaround to clean up old reviews on creating a new one (#28554) 1 year ago
user Skip email domain check when admins edit user emails (#29609) 1 year ago
webhook Store webhook event in database (#29145) 1 year ago
error.go Add merge style `fast-forward-only` (#28954) 1 year ago
fixture_generation.go
fixture_test.go
main_test.go
org.go Add user blocking (#29028) 1 year ago
org_team.go Add user blocking (#29028) 1 year ago
org_team_test.go Add user blocking (#29028) 1 year ago
org_test.go Add user blocking (#29028) 1 year ago
repo.go
repo_test.go
repo_transfer.go Add user blocking (#29028) 1 year ago