mirror of
https://github.com/go-gitea/gitea
synced 2024-11-16 07:04:25 +00:00
26653b196b
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)
125 lines
3.6 KiB
Go
125 lines
3.6 KiB
Go
// Copyright 2022 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package webhook
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
|
|
webhook_model "code.gitea.io/gitea/models/webhook"
|
|
"code.gitea.io/gitea/modules/json"
|
|
"code.gitea.io/gitea/modules/log"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
webhook_module "code.gitea.io/gitea/modules/webhook"
|
|
)
|
|
|
|
type (
|
|
// PackagistPayload represents
|
|
PackagistPayload struct {
|
|
PackagistRepository struct {
|
|
URL string `json:"url"`
|
|
} `json:"repository"`
|
|
}
|
|
|
|
// PackagistMeta contains the metadata for the webhook
|
|
PackagistMeta struct {
|
|
Username string `json:"username"`
|
|
APIToken string `json:"api_token"`
|
|
PackageURL string `json:"package_url"`
|
|
}
|
|
)
|
|
|
|
// GetPackagistHook returns packagist metadata
|
|
func GetPackagistHook(w *webhook_model.Webhook) *PackagistMeta {
|
|
s := &PackagistMeta{}
|
|
if err := json.Unmarshal([]byte(w.Meta), s); err != nil {
|
|
log.Error("webhook.GetPackagistHook(%d): %v", w.ID, err)
|
|
}
|
|
return s
|
|
}
|
|
|
|
// Create implements PayloadConvertor Create method
|
|
func (pc packagistConvertor) Create(_ *api.CreatePayload) (PackagistPayload, error) {
|
|
return PackagistPayload{}, nil
|
|
}
|
|
|
|
// Delete implements PayloadConvertor Delete method
|
|
func (pc packagistConvertor) Delete(_ *api.DeletePayload) (PackagistPayload, error) {
|
|
return PackagistPayload{}, nil
|
|
}
|
|
|
|
// Fork implements PayloadConvertor Fork method
|
|
func (pc packagistConvertor) Fork(_ *api.ForkPayload) (PackagistPayload, error) {
|
|
return PackagistPayload{}, nil
|
|
}
|
|
|
|
// Push implements PayloadConvertor Push method
|
|
// https://packagist.org/about
|
|
func (pc packagistConvertor) Push(_ *api.PushPayload) (PackagistPayload, error) {
|
|
return PackagistPayload{
|
|
PackagistRepository: struct {
|
|
URL string `json:"url"`
|
|
}{
|
|
URL: pc.PackageURL,
|
|
},
|
|
}, nil
|
|
}
|
|
|
|
// Issue implements PayloadConvertor Issue method
|
|
func (pc packagistConvertor) Issue(_ *api.IssuePayload) (PackagistPayload, error) {
|
|
return PackagistPayload{}, nil
|
|
}
|
|
|
|
// IssueComment implements PayloadConvertor IssueComment method
|
|
func (pc packagistConvertor) IssueComment(_ *api.IssueCommentPayload) (PackagistPayload, error) {
|
|
return PackagistPayload{}, nil
|
|
}
|
|
|
|
// PullRequest implements PayloadConvertor PullRequest method
|
|
func (pc packagistConvertor) PullRequest(_ *api.PullRequestPayload) (PackagistPayload, error) {
|
|
return PackagistPayload{}, nil
|
|
}
|
|
|
|
// Review implements PayloadConvertor Review method
|
|
func (pc packagistConvertor) Review(_ *api.PullRequestPayload, _ webhook_module.HookEventType) (PackagistPayload, error) {
|
|
return PackagistPayload{}, nil
|
|
}
|
|
|
|
// Repository implements PayloadConvertor Repository method
|
|
func (pc packagistConvertor) Repository(_ *api.RepositoryPayload) (PackagistPayload, error) {
|
|
return PackagistPayload{}, nil
|
|
}
|
|
|
|
// Wiki implements PayloadConvertor Wiki method
|
|
func (pc packagistConvertor) Wiki(_ *api.WikiPayload) (PackagistPayload, error) {
|
|
return PackagistPayload{}, nil
|
|
}
|
|
|
|
// Release implements PayloadConvertor Release method
|
|
func (pc packagistConvertor) Release(_ *api.ReleasePayload) (PackagistPayload, error) {
|
|
return PackagistPayload{}, nil
|
|
}
|
|
|
|
func (pc packagistConvertor) Package(_ *api.PackagePayload) (PackagistPayload, error) {
|
|
return PackagistPayload{}, nil
|
|
}
|
|
|
|
type packagistConvertor struct {
|
|
PackageURL string
|
|
}
|
|
|
|
var _ payloadConvertor[PackagistPayload] = packagistConvertor{}
|
|
|
|
func newPackagistRequest(ctx context.Context, w *webhook_model.Webhook, t *webhook_model.HookTask) (*http.Request, []byte, error) {
|
|
meta := &PackagistMeta{}
|
|
if err := json.Unmarshal([]byte(w.Meta), meta); err != nil {
|
|
return nil, nil, fmt.Errorf("newpackagistRequest meta json: %w", err)
|
|
}
|
|
pc := packagistConvertor{
|
|
PackageURL: meta.PackageURL,
|
|
}
|
|
return newJSONRequest(pc, w, t, true)
|
|
}
|