webhook

README

WebHook

Documentation

Index

• Constants
• type DescribeWebHookRequest
  • func NewDescribeWebHookRequest(id string) *DescribeWebHookRequest
• type QueryWebHookRequest
  • func NewQueryWebHookRequest() *QueryWebHookRequest
  • func (r *QueryWebHookRequest) SetRefTaskId(taskId string) *QueryWebHookRequest
• type STATUS
• type Service
  • func GetService() Service
• type WebHook
  • func NewWebHook(spec WebHookSpec) *WebHook
  • func (w *WebHook) Failed(err error) *WebHook
  • func (e *WebHook) LoadFromEvent(event *bus.Event) error
  • func (h *WebHook) Run(ctx context.Context)
  • func (h *WebHook) SetDefault()
  • func (w *WebHook) Success() *WebHook
  • func (h *WebHook) TableName() string
  • func (e *WebHook) ToBusEvent(topic string) *bus.Event
• type WebHookSpec
  • func NewWebHookSpec() *WebHookSpec
  • func (s *WebHookSpec) AddCondtion(conditions ...string)
  • func (s *WebHookSpec) IsCondtionOk(condition string) bool
• type WebHookStatus
  • func NewWebHookStatus() *WebHookStatus
  • func (w *WebHookStatus) SetUpdateAt(v time.Time) *WebHookStatus
  • func (w WebHookStatus) String() string
  • func (w WebHookStatus) TableName() string

Constants

const (
	APP_NAME = "webhooks"
)

Types

type DescribeWebHookRequest

type DescribeWebHookRequest struct {
	Id string
}

func NewDescribeWebHookRequest

func NewDescribeWebHookRequest(id string) *DescribeWebHookRequest

type QueryWebHookRequest

type QueryWebHookRequest struct {
	// 关联Task
	RefTaskId string `json:"ref_task_id"`
}

func NewQueryWebHookRequest

func NewQueryWebHookRequest() *QueryWebHookRequest

func (*QueryWebHookRequest) SetRefTaskId

func (r *QueryWebHookRequest) SetRefTaskId(taskId string) *QueryWebHookRequest

type STATUS

type STATUS int

const (
	// 任务处于挂起
	STATUS_PENDING STATUS = iota
	// 任务正在运行
	STATUS_RUNNING
	// 任务已完成
	STATUS_SUCCESS
	// 任务失败
	STATUS_FAILED
	// 任务已取消
	STATUS_CANCELED
)

type Service

type Service interface {
	// 执行WebHook, 触发执行, 执行状态通过HookId查询
	Run(context.Context, *WebHookSpec) (*WebHook, error)
	// 查询WebHook具体执行状态
	DescribeWebHook(context.Context, *DescribeWebHookRequest) (*WebHook, error)
	// 查询WebHook执行记录列表
	QueryWebHook(context.Context, *QueryWebHookRequest) (*types.Set[*WebHook], error)
}

func GetService

func GetService() Service

type WebHook

type WebHook struct {
	// WebHook 的唯一标识
	Id string `json:"id"`
	// 创建时间
	CreatedAt time.Time `` /* 126-byte string literal not displayed */
	// WebHook定义
	WebHookSpec
	// 状态与统计
	WebHookStatus
}

任务回调

func NewWebHook

func NewWebHook(spec WebHookSpec) *WebHook

func (*WebHook) Failed

func (w *WebHook) Failed(err error) *WebHook

func (*WebHook) LoadFromEvent

func (e *WebHook) LoadFromEvent(event *bus.Event) error

func (*WebHook) Run

func (h *WebHook) Run(ctx context.Context)

func (*WebHook) SetDefault

func (h *WebHook) SetDefault()

func (*WebHook) Success

func (w *WebHook) Success() *WebHook

func (*WebHook) TableName

func (h *WebHook) TableName() string

func (*WebHook) ToBusEvent

func (e *WebHook) ToBusEvent(topic string) *bus.Event

type WebHookSpec

type WebHookSpec struct {
	// WebHook 名称
	Name string `json:"name"`
	// 描述
	Description string `json:"description"`

	// 关联Task
	RefTaskId string `json:"ref_task_id"`

	// 目标配置
	// 接收 HTTP 请求的 URL
	TargetURL string `json:"target_url"`
	// HTTP 方法，如 POST、GET 等
	Method string `json:"method"`
	// 自定义请求头
	Headers map[string]string `json:"headers" gorm:"column:headers;type:json;serializer:json;"`

	// 安全验证
	// 用于签名验证的密钥（HMAC）
	Secret string `json:"secret"`
	// 签名头的名称，如 "X-Hub-Signature"
	SignatureHeader string `json:"signature_header"`

	// 哪些条件下触发
	Conditions []string `json:"conditions" gorm:"column:conditions;type:json;serializer:json;"`

	// 请求内容配置
	// 请求体类型，如 "application/json"
	ContentType string `json:"content_type"`
	// 自定义请求体模板（可选）
	Payload string `json:"payload"`

	// 重试与超时
	// 失败重试次数
	RetryCount int `json:"retry_count"`
	// 请求超时时间（毫秒）
	Timeout int `json:"timeout"`
}

func NewWebHookSpec

func NewWebHookSpec() *WebHookSpec

func (*WebHookSpec) AddCondtion

func (s *WebHookSpec) AddCondtion(conditions ...string)

func (*WebHookSpec) IsCondtionOk

func (s *WebHookSpec) IsCondtionOk(condition string) bool

type WebHookStatus

type WebHookStatus struct {
	// 更新时间
	UpdateAt *time.Time `json:"update_at" gorm:"column:update_at;type:timestamp;default:current_timestamp;not null;index;" description:"更新时间"`
	// 状态与统计
	Status STATUS `json:"status" gorm:"column:status;type:varchar(32);not null;" description:"状态"`
	// 失败信息
	Message string `json:"message" gorm:"column:message;type:text;" description:"失败信息"`
}

func NewWebHookStatus

func NewWebHookStatus() *WebHookStatus

func (*WebHookStatus) SetUpdateAt

func (w *WebHookStatus) SetUpdateAt(v time.Time) *WebHookStatus

func (WebHookStatus) String

func (w WebHookStatus) String() string

func (WebHookStatus) TableName

func (w WebHookStatus) TableName() string