hedwig

type AWSSessionsCache struct {
	// contains filtered or unexported fields
}

type CallbackFunction func(context.Context, *Message) error

type CallbackKey struct {
	// Message type
	MessageType string
	// Message major version
	MessageMajorVersion int
}

type CallbackRegistry struct {
	// contains filtered or unexported fields
}

type GetLoggerFunc func(ctx context.Context) Logger

type ILambdaConsumer interface {
	// HandleLambdaInput processes hedwig messages for the provided message types for Lambda apps
	HandleLambdaEvent(ctx context.Context, snsEvent events.SNSEvent) error
}

type IMessageValidator interface {
	SchemaRoot() string
	Validate(message *Message) error
}

type IPublisher interface {
	Publish(ctx context.Context, message *Message) error
}

type IQueueConsumer interface {
	// ListenForMessages starts a hedwig listener for the provided message types
	//
	// This function never returns by default. Possible shutdown methods:
	// 1. Cancel the context - returns immediately.
	// 2. Set a deadline on the context of less than 10 seconds - returns after processing current messages.
	// 3. Run for limited number of loops by setting LoopCount on the request - returns after running loop a finite
	// number of times
	ListenForMessages(ctx context.Context, request *ListenRequest) error
}

type JSONTime time.Time

type LambdaHandler struct {
	// contains filtered or unexported fields
}

type LambdaRequest struct {
	// Context for request
	Context context.Context
	// SNS record for this request
	EventRecord *events.SNSEventRecord
}

type ListenRequest struct {
	NumMessages        uint32 // default 1
	VisibilityTimeoutS uint32 // defaults to queue configuration
	LoopCount          uint32 // defaults to infinite loops
}

type Logger interface {
	// Error logs an error with a message. `fields` can be used as additional metadata for structured logging.
	// You can generally expect one of these fields to be available: message_sqs_id, message_sns_id.
	// By default fields are logged as a map using fmt.Sprintf
	Error(err error, message string, fields LoggingFields)

	// Warn logs a warn level log with a message. `fields` param works the same as `Error`.
	Warn(err error, message string, fields LoggingFields)

	// Info logs a debug level log with a message. `fields` param works the same as `Error`.
	Info(message string, fields LoggingFields)

	// Debug logs a debug level log with a message. `fields` param works the same as `Error`.
	Debug(message string, fields LoggingFields)
}

type LoggingFields map[string]interface{}

type Message struct {
	Data          interface{} `json:"data"`
	FormatVersion string      `json:"format_version"`
	ID            string      `json:"id"`
	Metadata      *metadata   `json:"metadata"`
	Schema        string      `json:"schema"`

	DataSchemaVersion *semver.Version `json:"-"`
	// contains filtered or unexported fields
}

type MessageDefaultHeadersHook func(ctx context.Context, message *Message) map[string]string

type MessageRouteKey struct {
	// Message type
	MessageType string
	// Message major version
	MessageMajorVersion int
}

type NewData func() interface{}

type PreDeserializeHook func(ctx *context.Context, messageData *string) error

type PreProcessHookLambda func(r *LambdaRequest) error

type PreProcessHookSQS func(r *SQSRequest) error

type PreSerializeHook func(ctx *context.Context, messageData *string) error

type Publisher struct {
	// contains filtered or unexported fields
}

type SQSRequest struct {
	// Context for request
	Context context.Context
	// SQS message for this request
	QueueMessage *sqs.Message
}

type Settings struct {
	// AWS Region
	AWSRegion string
	// AWS account id
	AWSAccountID string
	// AWS access key
	AWSAccessKey string
	// AWS secret key
	AWSSecretKey string
	// AWS session tokenthat represents temporary credentials (i.e. for Lambda app)
	AWSSessionToken string

	// AWS read timeout for publisher
	AWSReadTimeoutS time.Duration // optional; default: 2 seconds

	// AWS debug request error logs toggle
	AWSDebugRequestLogEnabled bool

	// CallbackRegistry contains callbacks and message data factories by message type and message version
	CallbackRegistry *CallbackRegistry

	// GetLogger is a function that takes the context object and returns a logger. This may be used to plug in
	// your desired logger library. Defaults to using std library.
	// Convenience structs are provided for popular libraries: LogrusGetLoggerFunc
	GetLogger GetLoggerFunc

	// Returns default headers for a message before a message is published. This will apply to ALL messages.
	// Can be used to inject custom headers (i.e. request id).
	MessageDefaultHeadersHook MessageDefaultHeadersHook

	// Maps message type and major version to topic names
	//   <message type>, <message version> => topic name
	// An entry is required for every message type that the app wants to consumer or publish. It is
	// recommended that major versions of a message be published on separate topics.
	MessageRouting map[MessageRouteKey]string

	// Hedwig pre process hook called before any processing is done on message
	PreProcessHookLambda PreProcessHookLambda // optional
	PreProcessHookSQS    PreProcessHookSQS    // optional

	// Hedwig hook called before a message is serialized to JSON
	PreSerializeHook PreSerializeHook // optional

	// Hedwig hook called before a message has been deserialized into a Message struct
	PreDeserializeHook PreDeserializeHook // optional

	// Publisher name
	Publisher string

	// Hedwig queue name. Exclude the `HEDWIG-` prefix
	QueueName string

	// ShutdownTimeout is the time the app has to shut down before being brutally killed
	ShutdownTimeout time.Duration // optional; defaults to 10s

	// Message validator using JSON schema for validation. Additional JSON schema formats may be added.
	// Please see github.com/santhosh-tekuri/jsonschema for more details.
	Validator IMessageValidator
}