File size: 7,859 Bytes
d6f631f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 | package webhook
import (
"context"
"errors"
"fmt"
"time"
"github.com/openmeterio/openmeter/openmeter/notification"
"github.com/openmeterio/openmeter/openmeter/notification/webhook/secret"
"github.com/openmeterio/openmeter/pkg/models"
)
type Webhook struct {
Namespace string
ID string
URL string
Secret string
CustomHeaders map[string]string
Disabled bool
RateLimit *uint16
Description string
EventTypes []string
Channels []string
CreatedAt time.Time
UpdatedAt time.Time
}
var _ models.Validator = (*ListWebhooksInput)(nil)
type ListWebhooksInput struct {
Namespace string
IDs []string
EventTypes []string
Channels []string
}
func (i ListWebhooksInput) Validate() error {
var errs []error
if i.Namespace == "" {
errs = append(errs, errors.New("namespace is required"))
}
return NewValidationError(errors.Join(errs...))
}
var _ models.Validator = (*CreateWebhookInput)(nil)
type CreateWebhookInput struct {
Namespace string
ID *string
URL string
CustomHeaders map[string]string
Disabled bool
Secret *string
RateLimit *uint16
Description *string
EventTypes []string
Channels []string
Metadata map[string]string
}
func (i CreateWebhookInput) Validate() error {
var errs []error
if i.Namespace == "" {
errs = append(errs, errors.New("namespace is required"))
}
if i.URL == "" {
errs = append(errs, errors.New("url is required"))
}
if i.Secret != nil && *i.Secret != "" {
if err := secret.ValidateSigningSecret(*i.Secret); err != nil {
errs = append(errs, fmt.Errorf("invalid secret: %w", err))
}
}
return NewValidationError(errors.Join(errs...))
}
var _ models.Validator = (*UpdateWebhookInput)(nil)
type UpdateWebhookInput struct {
Namespace string
ID string
URL string
CustomHeaders map[string]string
Disabled bool
Secret *string
RateLimit *uint16
Description *string
EventTypes []string
Channels []string
Metadata map[string]string
}
func (i UpdateWebhookInput) Validate() error {
var errs []error
if i.Namespace == "" {
errs = append(errs, errors.New("namespace is required"))
}
if i.ID == "" {
errs = append(errs, errors.New("id is required"))
}
if i.URL == "" {
errs = append(errs, errors.New("url is required"))
}
if i.Secret == nil {
errs = append(errs, errors.New("secret is required"))
} else {
if err := secret.ValidateSigningSecret(*i.Secret); err != nil {
errs = append(errs, fmt.Errorf("invalid secret: %w", err))
}
}
return NewValidationError(errors.Join(errs...))
}
var _ models.Validator = (*UpdateWebhookChannelsInput)(nil)
type UpdateWebhookChannelsInput struct {
Namespace string
ID string
AddChannels []string
RemoveChannels []string
}
func (i UpdateWebhookChannelsInput) Validate() error {
var errs []error
if i.Namespace == "" {
errs = append(errs, errors.New("namespace is required"))
}
if i.ID == "" {
errs = append(errs, errors.New("id is required"))
}
return NewValidationError(errors.Join(errs...))
}
var _ models.Validator = (*GetWebhookInput)(nil)
type GetWebhookInput struct {
Namespace string
ID string
}
func (i GetWebhookInput) Validate() error {
var errs []error
if i.Namespace == "" {
errs = append(errs, errors.New("namespace is required"))
}
if i.ID == "" {
errs = append(errs, errors.New("id is required"))
}
return NewValidationError(errors.Join(errs...))
}
type DeleteWebhookInput = GetWebhookInput
type Payload = map[string]any
type MessageDeliveryStatus struct {
NextAttempt *time.Time `json:"nextAttempt"`
State notification.EventDeliveryStatusState `json:"state"`
ChannelID string `json:"channel_id"`
Attempts []notification.EventDeliveryAttempt `json:"attempts"`
}
type Message struct {
Namespace string
ID string
EventID string
EventType string
Channels []string
Annotations models.Annotations
// Expanded attributes
// Payload stores the message payload if it was requested.
Payload *Payload
// DeliveryStatuses stores the message delivery status if it was requested.
DeliveryStatuses *[]MessageDeliveryStatus
// Timestamp when the message was created.
Timestamp time.Time
}
var _ models.Validator = (*SendMessageInput)(nil)
type SendMessageInput struct {
Namespace string
EventID string
EventType string
Channels []string
Payload Payload
}
func (i SendMessageInput) Validate() error {
var errs []error
if i.Namespace == "" {
errs = append(errs, errors.New("namespace is required"))
}
if i.EventID == "" {
errs = append(errs, errors.New("event ID is required"))
}
if i.EventType == "" {
errs = append(errs, errors.New("event type is required"))
}
if len(i.Payload) == 0 {
errs = append(errs, errors.New("payload must not be empty"))
}
return NewValidationError(errors.Join(errs...))
}
type ExpandParams struct {
// Payload stores whether the message payload for the webhook message should be included in the response or not.
Payload bool
// DeliveryStatusByChannelID defines whether the delivery status for the webhook message and channel should be included in the response or not.
DeliveryStatusByChannelID string
}
var _ models.Validator = (*GetMessageInput)(nil)
type GetMessageInput struct {
Namespace string
ID string
EventID string
Expand ExpandParams
}
func (i GetMessageInput) Validate() error {
var errs []error
if i.Namespace == "" {
errs = append(errs, errors.New("namespace is required"))
}
if i.ID == "" && i.EventID == "" {
errs = append(errs, errors.New("message ID or event ID must be provided"))
}
return NewValidationError(errors.Join(errs...))
}
var _ models.Validator = (*ResendMessageInput)(nil)
type ResendMessageInput struct {
Namespace string
ID string
EventID string
ChannelID string
}
func (i ResendMessageInput) Validate() error {
var errs []error
if i.Namespace == "" {
errs = append(errs, errors.New("namespace is required"))
}
if i.ID == "" && i.EventID == "" {
errs = append(errs, errors.New("message ID or event ID must be provided"))
}
if i.ChannelID == "" {
errs = append(errs, errors.New("channel ID must be provided"))
}
return NewValidationError(errors.Join(errs...))
}
type RegisterEventTypesInputs struct {
EventTypes []EventType
AllowUpdate bool
}
type (
EvenTypeSchemaVersion = string
EventTypeSchema = interface{}
)
type EventType struct {
Name string
Description string
GroupName string
// Schemas defines the list of schemas for each event type version
Schemas map[EvenTypeSchemaVersion]EventTypeSchema
Deprecated bool
}
type EventTypeHandler interface {
RegisterEventTypes(ctx context.Context, params RegisterEventTypesInputs) error
}
type WebhookHandler interface {
ListWebhooks(ctx context.Context, params ListWebhooksInput) ([]Webhook, error)
CreateWebhook(ctx context.Context, params CreateWebhookInput) (*Webhook, error)
UpdateWebhook(ctx context.Context, params UpdateWebhookInput) (*Webhook, error)
UpdateWebhookChannels(ctx context.Context, params UpdateWebhookChannelsInput) (*Webhook, error)
GetWebhook(ctx context.Context, params GetWebhookInput) (*Webhook, error)
DeleteWebhook(ctx context.Context, params DeleteWebhookInput) error
}
type MessageHandler interface {
SendMessage(ctx context.Context, params SendMessageInput) (*Message, error)
GetMessage(ctx context.Context, params GetMessageInput) (*Message, error)
ResendMessage(ctx context.Context, params ResendMessageInput) error
}
type Handler interface {
WebhookHandler
MessageHandler
EventTypeHandler
}
const (
DefaultRegistrationTimeout = 30 * time.Second
MaxChannelsPerWebhook = 10
)
|