1
0
Fork 0
forgejo/models/fixtures
oliverpool 53f6f62ad4
Store webhook event in database (#29145)
Refactor the webhook logic, to have the type-dependent processing happen
only in one place.

---

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.

- 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)

(cherry picked from commit 26653b196bd1d15c532af41f60351596dd4330bd)

Conflicts:
	services/webhook/deliver_test.go
	trivial context conflict
2024-03-11 23:36:59 +07:00
..
TestParseCommitWithSSHSignature [GITEA] Add noreply email address as verified for SSH signed Git commits 2024-02-05 16:09:40 +01:00
access.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
access_token.yml Fix more yaml lint errors (#27284) 2023-09-26 12:56:42 -04:00
action.yml
action_run.yml Actions Artifacts v4 backend (#28965) 2024-03-06 12:10:45 +08:00
action_run_job.yml Actions Artifacts v4 backend (#28965) 2024-03-06 12:10:45 +08: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-06 12:10:45 +08: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
collaboration.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
comment.yml Fix comment permissions (#28213) 2023-11-25 17:21:21 +00:00
commit_status.yml
commit_status_index.yml Fix more yaml lint errors (#27284) 2023-09-26 12:56:42 -04:00
deploy_key.yml
email_address.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
external_login_user.yml
follow.yml
forgejo_blocked_user.yml [MODERATION] User blocking 2024-02-05 15:56:45 +01:00
gpg_key.yml
gpg_key_import.yml
hook_task.yml Store webhook event in database (#29145) 2024-03-11 23:36:59 +07:00
issue.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
issue_assignees.yml
issue_index.yml [MODERATION] User blocking 2024-02-05 15:56:45 +01:00
issue_label.yml
issue_user.yml
issue_watch.yml
label.yml
lfs_meta_object.yml
login_source.yml
milestone.yml
mirror.yml
notice.yml
notification.yml
oauth2_application.yml
oauth2_authorization_code.yml
oauth2_grant.yml
org_user.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
project.yml
project_board.yml
project_issue.yml
protected_branch.yml
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-26 22:30:27 +01:00
reaction.yml Fix more yaml lint errors (#27284) 2023-09-26 12:56:42 -04:00
release.yml [GITEA] Improve HTML title on repositories 2024-02-05 16:05:50 +01:00
renamed_branch.yml
repo_archiver.yml
repo_indexer_status.yml
repo_redirect.yml
repo_topic.yml
repo_transfer.yml
repo_unit.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
repository.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
review.yml Fix more yaml lint errors (#27284) 2023-09-26 12:56:42 -04:00
star.yml
stopwatch.yml
system_setting.yml
team.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
team_repo.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
team_unit.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
team_user.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
topic.yml
tracked_time.yml
two_factor.yml
user.yml Allow non-admin users to delete review requests (#29057) 2024-02-26 22:30:27 +01:00
user_open_id.yml
user_redirect.yml
watch.yml [MODERATION] User blocking 2024-02-05 15:56:45 +01:00
webauthn_credential.yml
webhook.yml