mirror of
1
Fork 0
forgejo/templates/repo
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
..
actions Merge pull request '[UI] Actions: Link to Workflow in View' (#1866) from n0toose/forgejo:forgejo-add-workflow-link into forgejo 2024-02-28 17:28:16 +00:00
branch templates: remove superfluous SanitizeHTML 2024-03-11 23:36:58 +07:00
cite Update JS and PY dependencies (#27501) 2023-10-08 00:16:20 +00:00
code Remove incorrect and unnecessary Escape from templates (#29394) 2024-02-26 22:30:27 +01:00
diff templates: remove superfluous SanitizeHTML 2024-03-11 23:36:58 +07:00
editor Remove jQuery AJAX from the repo editor (#29636) 2024-03-11 23:36:59 +07:00
find Always use `ctx.Locale.Tr` inside templates (#27231) 2023-09-25 08:56:50 +00:00
graph Rework markup link rendering (#26745) 2024-01-15 08:49:24 +00:00
issue templates: remove superfluous SanitizeHTML 2024-03-11 23:36:58 +07:00
migrate templates: remove superfluous SanitizeHTML 2024-03-11 23:36:58 +07:00
projects Use full width for project boards (#28225) 2023-11-27 17:43:52 +00:00
pulls Remove unnecessary "Safe" modifier from templates (#29318) 2024-02-26 22:30:26 +01:00
release templates: remove superfluous SanitizeHTML 2024-03-11 23:36:58 +07:00
settings Store webhook event in database (#29145) 2024-03-11 23:36:59 +07:00
tag Fix more "locale" usages (#27259) 2023-09-25 20:42:40 +08:00
wiki Replace some `gt-` classes with `tw-` (#29570) 2024-03-11 23:36:57 +07:00
activity.tmpl Implement recent commits graph (#29210) 2024-02-26 22:30:26 +01:00
admin_flags.tmpl [FEAT] Repository flags 2024-02-05 16:09:42 +01:00
blame.tmpl templates: remove superfluous SanitizeHTML 2024-03-11 23:36:58 +07:00
branch_dropdown.tmpl [gitea] Rework spellchecking, add `lint-spell` (#29106) 2024-02-10 10:53:43 +01:00
clone_buttons.tmpl Fix more "locale" usages (#27259) 2023-09-25 20:42:40 +08:00
clone_script.tmpl Fix URL calculation in clone input box (#29470) 2024-03-06 12:10:44 +08:00
code_frequency.tmpl Implement code frequency graph (#29191) 2024-02-26 22:30:26 +01:00
commit_load_branches_and_tags.tmpl Wrap contained tags and branches again (#29021) 2024-02-02 04:51:09 +00:00
commit_page.tmpl Replace more `gt-` with `tw-`, update frontend docs (#29595) 2024-03-11 23:36:58 +07:00
commit_status.tmpl Restore warning commit status (#27504) 2023-10-08 22:16:06 +00:00
commit_statuses.tmpl Show commit status for releases (#29149) 2024-02-19 22:58:33 +01:00
commits.tmpl [GITEA] Detect file rename and show in history 2024-02-05 16:09:40 +01:00
commits_list.tmpl Show `View at this point in history` for every commit (#29122) 2024-02-14 21:44:24 +01:00
commits_list_small.tmpl Replace some `gt-` classes with `tw-` (#29570) 2024-03-11 23:36:57 +07:00
commits_table.tmpl Replace some `gt-` classes with `tw-` (#29570) 2024-03-11 23:36:57 +07:00
contributors.tmpl Deduplicate translations for contributors graph (#29256) 2024-02-19 22:58:33 +01:00
create.tmpl templates: remove superfluous SanitizeHTML 2024-03-11 23:36:58 +07:00
create_helper.tmpl Remove incorrect and unnecessary Escape from templates (#29394) 2024-02-26 22:30:27 +01:00
empty.tmpl templates: remove superfluous SanitizeHTML 2024-03-11 23:36:58 +07:00
file_info.tmpl Show in Web UI if file is vendored and generated (#28620) 2024-01-24 13:51:37 +08:00
flags.tmpl [FEAT] Repository flags 2024-02-05 16:09:42 +01:00
forks.tmpl Always use `ctx.Locale.Tr` inside templates (#27231) 2023-09-25 08:56:50 +00:00
graph.tmpl Fix more "locale" usages (#27259) 2023-09-25 20:42:40 +08:00
header.tmpl Make settings tab not active when on repository units tab 2024-02-28 21:17:53 -06:00
header_fork.tmpl Replace some `gt-` classes with `tw-` (#29570) 2024-03-11 23:36:57 +07:00
home.tmpl Replace some `gt-` classes with `tw-` (#29570) 2024-03-11 23:36:57 +07:00
icon.tmpl Tweak repo header (#29134) 2024-02-17 23:24:30 +01:00
latest_commit.tmpl Show latest commit for file (#28067) 2024-01-15 17:42:15 +01:00
navbar.tmpl Implement recent commits graph (#29210) 2024-02-26 22:30:26 +01:00
packages.tmpl Fix inconsistent user profile layout across tabs (#25625) 2023-07-06 18:59:24 +00:00
pulse.tmpl Remove unnecessary "Safe" modifier from templates (#29318) 2024-02-26 22:30:26 +01:00
recent_commits.tmpl Implement recent commits graph (#29210) 2024-02-26 22:30:26 +01:00
release_tag_header.tmpl Apply compact padding to small buttons with svg icons (#29471) 2024-03-06 12:10:44 +08:00
search.tmpl [PORT] Fix wrong line number in code search result (gitea#29260) (#2619) 2024-03-10 15:35:30 +00:00
search_name.tmpl Clean template/helper.go (#23922) 2023-04-07 03:31:41 -04:00
shabox_badge.tmpl cleanup locale function usage (#27227) 2023-09-24 20:31:58 +00:00
star_unstar.tmpl Don't do a full page load when clicking `Watch` or `Star` (#29001) 2024-02-05 09:56:20 +00:00
sub_menu.tmpl Enable followCursor for language stats bar (#27713) 2023-10-22 13:06:04 +00:00
unicode_escape_prompt.tmpl templates: remove superfluous SanitizeHTML 2024-03-11 23:36:58 +07:00
upload.tmpl Always use `ctx.Locale.Tr` inside templates (#27231) 2023-09-25 08:56:50 +00:00
user_cards.tmpl Remove unnecessary "Safe" modifier from templates (#29318) 2024-02-26 22:30:26 +01:00
view_file.tmpl Replace some `gt-` classes with `tw-` (#29570) 2024-03-11 23:36:57 +07:00
view_list.tmpl Fix elipsis button not working if the last commit loading is deferred (#29544) 2024-03-06 12:10:46 +08:00
watch_unwatch.tmpl Don't do a full page load when clicking `Watch` or `Star` (#29001) 2024-02-05 09:56:20 +00:00
watchers.tmpl Fix user-cards format (#24428) 2023-04-29 15:43:01 -04:00