forked from gitea/gitea
1
0
Fork 0
gitea/models/fixtures
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
..
access.yml Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
access_token.yml Fix more yaml lint errors (#27284) 2023-09-26 12:56:42 -04:00
action.yml Support "." char as user name for User/Orgs in RSS/ATOM/GPG/KEYS path ... (#23874) 2023-04-07 18:08:36 +08:00
action_run.yml Actions Artifacts v4 backend (#28965) 2024-03-02 09:12:17 +00:00
action_run_job.yml Actions Artifacts v4 backend (#28965) 2024-03-02 09:12:17 +00:00
action_runner_token.yml Add unit tests for action runner token (#27670) 2023-10-19 07:24:24 +00:00
action_task.yml Actions Artifacts v4 backend (#28965) 2024-03-02 09:12:17 +00:00
attachment.yml Allow get release download files and lfs files with oauth2 token format (#26430) 2023-10-01 10:41:52 +00:00
branch.yml Sync branches into databases (#22743) 2023-06-29 10:03:20 +00:00
collaboration.yml Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
comment.yml Fix comment permissions (#28213) 2023-11-25 17:21:21 +00:00
commit_status.yml Status-API (#1332) 2017-04-21 19:32:31 +08:00
commit_status_index.yml Fix more yaml lint errors (#27284) 2023-09-26 12:56:42 -04:00
deploy_key.yml Writable deploy keys (closes #671) (#3225) 2018-01-07 00:55:53 +02:00
email_address.yml Allow non-admin users to delete review requests (#29057) 2024-02-24 12:38:43 +00:00
external_login_user.yml add test coverage for original author conversion during migrations (#18506) 2022-02-01 13:20:28 -05:00
follow.yml Fix user visible check (#21210) 2022-09-20 15:59:20 +08:00
gpg_key.yml Fix verifyCommits error when push a new branch (#26664) 2023-08-30 02:27:53 +00:00
gpg_key_import.yml add .gpg url (match github behaviour) (#6610) 2019-04-14 12:43:56 -04:00
hook_task.yml Store webhook event in database (#29145) 2024-03-07 23:18:38 +01:00
issue.yml Allow non-admin users to delete review requests (#29057) 2024-02-24 12:38:43 +00:00
issue_assignees.yml Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
issue_index.yml Fix issue overview for teams (#19652) 2022-05-16 17:49:17 +08:00
issue_label.yml Add Organization Wide Labels (#10814) 2020-04-01 01:14:46 -03:00
issue_user.yml [API] ListIssues add more filters (#16174) 2021-06-16 18:33:37 -04:00
issue_watch.yml Refactor Issues Subscription (#8738) 2019-11-20 22:50:54 +08:00
label.yml Allow to archive labels (#26478) 2023-08-14 11:56:14 +02:00
lfs_meta_object.yml Test views of LFS files (#22196) 2022-12-23 07:41:56 +08:00
login_source.yml Add LDAP integration tests (#3897) 2018-05-11 15:55:32 +08:00
milestone.yml Add some api integration tests (#18872) 2022-10-18 00:23:27 +08:00
mirror.yml Fix bug of branches API with tests (#25578) 2023-07-01 10:52:52 +08:00
notice.yml Unit tests for models/admin 2017-01-09 21:49:51 +01:00
notification.yml [API] Add notification endpoint (#9488) 2020-01-09 11:56:32 +00:00
oauth2_application.yml Record OAuth client type at registration (#21316) 2022-10-24 15:59:24 +08:00
oauth2_authorization_code.yml Record OAuth client type at registration (#21316) 2022-10-24 15:59:24 +08:00
oauth2_grant.yml Record OAuth client type at registration (#21316) 2022-10-24 15:59:24 +08:00
org_user.yml Allow non-admin users to delete review requests (#29057) 2024-02-24 12:38:43 +00:00
project.yml Fix incorrect oldest sort in project list (#25806) 2023-07-11 20:47:50 +02:00
project_board.yml Support org/user level projects (#22235) 2023-01-20 19:42:33 +08:00
project_issue.yml Kanban board (#8346) 2020-08-16 23:07:38 -04:00
protected_branch.yml Don't recreate database in integration tests (#1697) 2017-05-11 23:32:43 +08:00
public_key.yml Fix more yaml lint errors (#27284) 2023-09-26 12:56:42 -04:00
pull_request.yml Allow non-admin users to delete review requests (#29057) 2024-02-24 12:38:43 +00:00
reaction.yml Fix more yaml lint errors (#27284) 2023-09-26 12:56:42 -04:00
release.yml Allow get release download files and lfs files with oauth2 token format (#26430) 2023-10-01 10:41:52 +00:00
renamed_branch.yml Add a simple way to rename branch like gh (#15870) 2021-10-08 19:03:04 +02:00
repo_archiver.yml Rework repository archive (#14723) 2021-06-23 17:12:38 -04:00
repo_indexer_status.yml Code/repo search (#2582) 2017-10-27 09:10:54 +03:00
repo_redirect.yml Unit tests for repo redirects (#961) 2017-02-17 08:55:33 +08:00
repo_topic.yml Add API endpoint for accessing repo topics (#7963) 2019-09-03 23:46:24 +08:00
repo_transfer.yml Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
repo_unit.yml Fix projects mode bugs (#29593) 2024-03-04 20:49:21 +00:00
repository.yml Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
review.yml Fix more yaml lint errors (#27284) 2023-09-26 12:56:42 -04:00
star.yml Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
stopwatch.yml [API] extend StopWatch (#9196) 2019-12-11 23:23:05 -05:00
system_setting.yml Fix context cache bug & enable context cache for dashabord commits' authors (#26991) 2023-09-11 10:14:01 +00:00
team.yml Allow non-admin users to delete review requests (#29057) 2024-02-24 12:38:43 +00:00
team_repo.yml Allow non-admin users to delete review requests (#29057) 2024-02-24 12:38:43 +00:00
team_unit.yml Allow non-admin users to delete review requests (#29057) 2024-02-24 12:38:43 +00:00
team_user.yml Allow non-admin users to delete review requests (#29057) 2024-02-24 12:38:43 +00:00
topic.yml Add some api integration tests (#18872) 2022-10-18 00:23:27 +08:00
tracked_time.yml [API] Extend times API (#9200) 2019-12-27 20:30:58 +00:00
two_factor.yml org/members: display 2FA members states + optimize sql requests (#7621) 2019-08-02 12:06:27 -04:00
user.yml Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
user_blocking.yml Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
user_open_id.yml Show user OpenID URIs in their profile (#1314) 2017-03-20 09:31:08 +01:00
user_redirect.yml Redirect on changed user and org name (#11649) 2021-01-24 16:23:05 +01:00
watch.yml Add user blocking (#29028) 2024-03-04 08:16:03 +00:00
webauthn_credential.yml Add some api integration tests (#18872) 2022-10-18 00:23:27 +08:00
webhook.yml Add user webhooks (#21563) 2023-03-10 08:28:32 -06:00