mock

Documentation

Index

• Constants
• Variables
• func CleanupHandlers()
• func NewWrappedJob() *wingman.InternalJob
• func RegisterHandler(name string, h HandlerSig)
• func ResetLog()
• type Backend
  • func NewBackend() *Backend
  • func (b *Backend) ClearJob(jobID string) error
  • func (b *Backend) Close() error
  • func (b *Backend) FailJob(job *wingman.InternalJob) error
  • func (b *Backend) FailedJobs() uint64
  • func (b *Backend) HasProcessingJob(processorID string) bool
  • func (b *Backend) IncFailedJobs()
  • func (b *Backend) IncSuccessfulJobs()
  • func (b *Backend) LockJob(job *wingman.InternalJob) (wingman.LockID, error)
  • func (b *Backend) Peek(queue string) (*wingman.InternalJob, error)
  • func (b *Backend) PopJob(ctx context.Context, queue string) (*wingman.InternalJob, error)
  • func (b *Backend) ProcessJob(job *wingman.InternalJob) error
  • func (b *Backend) PushInternalJob(job *wingman.InternalJob) error
  • func (b *Backend) PushJob(job wingman.Job) error
  • func (b *Backend) ReleaseJob(job *wingman.InternalJob) error
  • func (b *Backend) Size(queue string) uint64
  • func (b *Backend) SuccessfulJobs() uint64
• type Event
  • func (e Event) HasErr(err error) bool
  • func (e Event) HasField(key string) bool
  • func (e Event) HasStr(key, value string) bool
  • func (e Event) HasTime(key string, t time.Time, within time.Duration) bool
• type HandlerSig
• type Job
  • func NewJob() *Job
  • func (j Job) Concurrency() int
  • func (j *Job) Handle(ctx context.Context) error
  • func (j *Job) InternalJob(queue string) *wingman.InternalJob
  • func (j Job) LockKey() string
  • func (j Job) Queue() string
  • func (j Job) TypeName() string
• type TestLogger
  • func (l *TestLogger) AddEvent(event Event)
  • func (l *TestLogger) Count() int
  • func (l *TestLogger) EventAtIndex(i int) Event
  • func (l *TestLogger) EventByMessage(msg string) (Event, bool)
  • func (l *TestLogger) Fatal() *zerolog.Event
  • func (l *TestLogger) Write(p []byte) (n int, err error)

Constants

const DefaultJobType = "important job"

const DefaultQueue = "queue"

Variables

var NoQueueError = errors.New("Job must specify a queue")

Functions

func CleanupHandlers

func CleanupHandlers()

func NewWrappedJob

func NewWrappedJob() *wingman.InternalJob

func RegisterHandler

func RegisterHandler(name string, h HandlerSig)

func ResetLog

func ResetLog()

Types

type Backend

type Backend struct {
	LastAddedID        string
	NextJobCanceledErr error
	// contains filtered or unexported fields
}

func NewBackend

func NewBackend() *Backend

func (*Backend) ClearJob

func (b *Backend) ClearJob(jobID string) error

func (*Backend) Close

func (b *Backend) Close() error

func (*Backend) FailJob

func (b *Backend) FailJob(job *wingman.InternalJob) error

func (*Backend) FailedJobs

func (b *Backend) FailedJobs() uint64

func (*Backend) HasProcessingJob

func (b *Backend) HasProcessingJob(processorID string) bool

func (*Backend) IncFailedJobs

func (b *Backend) IncFailedJobs()

func (*Backend) IncSuccessfulJobs

func (b *Backend) IncSuccessfulJobs()

func (*Backend) LockJob

func (b *Backend) LockJob(job *wingman.InternalJob) (wingman.LockID, error)

func (*Backend) Peek

func (b *Backend) Peek(queue string) (*wingman.InternalJob, error)

func (*Backend) PopJob

func (b *Backend) PopJob(ctx context.Context, queue string) (*wingman.InternalJob, error)

PopJob assumes that only one goroutine is waiting on the notifier

func (*Backend) ProcessJob

func (b *Backend) ProcessJob(job *wingman.InternalJob) error

func (*Backend) PushInternalJob

func (b *Backend) PushInternalJob(job *wingman.InternalJob) error

func (*Backend) PushJob

func (b *Backend) PushJob(job wingman.Job) error

func (*Backend) ReleaseJob

func (b *Backend) ReleaseJob(job *wingman.InternalJob) error

func (*Backend) Size

func (b *Backend) Size(queue string) uint64

func (*Backend) SuccessfulJobs

func (b *Backend) SuccessfulJobs() uint64

type Event

type Event map[string]any

func (Event) HasErr

func (e Event) HasErr(err error) bool

func (Event) HasField

func (e Event) HasField(key string) bool

func (Event) HasStr

func (e Event) HasStr(key, value string) bool

func (Event) HasTime

func (e Event) HasTime(key string, t time.Time, within time.Duration) bool

type HandlerSig

type HandlerSig func(context.Context, wingman.Job) error

type Job

type Job struct {
	Data                string
	HandlerOverride     string
	QueueOverride       string
	LockKeyOverride     string
	ConcurrencyOverride int
	Processed           bool
}

func NewJob

func NewJob() *Job

func (Job) Concurrency

func (j Job) Concurrency() int

func (*Job) Handle

func (j *Job) Handle(ctx context.Context) error

func (*Job) InternalJob

func (j *Job) InternalJob(queue string) *wingman.InternalJob

func (Job) LockKey

func (j Job) LockKey() string

func (Job) Queue

func (j Job) Queue() string

func (Job) TypeName

func (j Job) TypeName() string

type TestLogger

type TestLogger struct {
	zerolog.Logger
	// contains filtered or unexported fields
}

var TestLog *TestLogger

func (*TestLogger) AddEvent

func (l *TestLogger) AddEvent(event Event)

func (*TestLogger) Count

func (l *TestLogger) Count() int

func (*TestLogger) EventAtIndex

func (l *TestLogger) EventAtIndex(i int) Event

func (*TestLogger) EventByMessage

func (l *TestLogger) EventByMessage(msg string) (Event, bool)

func (*TestLogger) Fatal

func (l *TestLogger) Fatal() *zerolog.Event

func (*TestLogger) Write

func (l *TestLogger) Write(p []byte) (n int, err error)