vault/plugins/event/event_subscription_plugin.go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

package event

import (
	"context"
	"time"

	"github.com/hashicorp/vault/sdk/helper/backoff"
)

type Factory func(context.Context) (SubscriptionPlugin, error)

// SubscriptionPlugin is the interface implemented by plugins that can subscribe to and receive events.
type SubscriptionPlugin interface {
	// Subscribe is used to set up a new connection.
	Subscribe(context.Context, *SubscribeRequest) error
	// Send is used to send events to a connection.
	Send(context.Context, *SendRequest) error
	// Unsubscribe is used to teardown a connection.
	Unsubscribe(context.Context, *UnsubscribeRequest) error
	// PluginMetadata returns the name and version for the particular event subscription plugin.
	// The name is usually set as a constant the backend, e.g., "sqs" for the
	// AWS SQS backend.
	PluginMetadata() *PluginMetadata
	// Close closes all connections.
	Close(ctx context.Context) error
}

type Request struct {
	Subscribe   *SubscribeRequest
	Unsubscribe *UnsubscribeRequest
	Event       *SendRequest
}

type SubscribeRequest struct {
	SubscriptionID   string
	Config           map[string]interface{}
	VerifyConnection bool
}

type UnsubscribeRequest struct {
	SubscriptionID string
}

type SendRequest struct {
	SubscriptionID string
	EventJSON      string
}

type PluginMetadata struct {
	Name    string
	Version string
}

// SubscribeConfigDefaults defines configuration map keys for common default options.
// Embed this in your own config struct to pick up these default options.
type SubscribeConfigDefaults struct {
	Retries         *int           `mapstructure:"retries"`
	RetryMinBackoff *time.Duration `mapstructure:"retry_min_backoff"`
	RetryMaxBackoff *time.Duration `mapstructure:"retry_max_backoff"`
}

// default values for common configuration keys
const (
	DefaultRetries         = 3
	DefaultRetryMinBackoff = 100 * time.Millisecond
	DefaultRetryMaxBackoff = 5 * time.Second
)

func (c *SubscribeConfigDefaults) GetRetries() int {
	if c.Retries == nil {
		return DefaultRetries
	}
	return *c.Retries
}

func (c *SubscribeConfigDefaults) GetRetryMinBackoff() time.Duration {
	if c.RetryMinBackoff == nil {
		return DefaultRetryMinBackoff
	}
	return *c.RetryMinBackoff
}

func (c *SubscribeConfigDefaults) GetRetryMaxBackoff() time.Duration {
	if c.RetryMaxBackoff == nil {
		return DefaultRetryMaxBackoff
	}
	return *c.RetryMaxBackoff
}

func (c *SubscribeConfigDefaults) NewRetryBackoff() *backoff.Backoff {
	return backoff.NewBackoff(c.GetRetries(), c.GetRetryMinBackoff(), c.GetRetryMaxBackoff())
}