redisqueue

Documentation

Index

• Variables
• func RedisKeyForQueue(queueName string) string
• func RedisKeyForTask(appID string, taskID string) string
• type Producer
  • func (p *Producer) EnqueueTask(ctx context.Context, task *Task) error
  • func (p *Producer) GetTask(ctx context.Context, item *QueueItem) (*Task, error)
  • func (p *Producer) NewTask(appID string, input json.RawMessage, taskIDPrefix string) *Task
• type QueueItem
  • func (i *QueueItem) RedisKey() string
• type Task
  • func (t *Task) RedisKey() string
  • func (t *Task) ToQueueItem() *QueueItem
• type TaskStatus
• type UserExportProducer
  • func NewUserExportProducer(redis *appredis.Handle, clock clock.Clock) *UserExportProducer
• type UserImportProducer
  • func NewUserImportProducer(redis *appredis.Handle, clock clock.Clock) *UserImportProducer
• type UserReindexProducer
  • func NewUserReindexProducer(redis *appredis.Handle, clock clock.Clock) *UserReindexProducer

Variables

var ErrTaskNotFound = apierrors.NotFound.WithReason("TaskNotFound").New("task not found")

var ProducerDependencySet = wire.NewSet(
	NewUserImportProducer,
	NewUserExportProducer,
	NewUserReindexProducer,
)

var QueueUserExport = "user-export"

var QueueUserImport = "user-import"

var QueueUserReindex = "user-reindex"

var TTL = 24 * time.Hour

Functions

func RedisKeyForQueue

func RedisKeyForQueue(queueName string) string

func RedisKeyForTask

func RedisKeyForTask(appID string, taskID string) string

Types

type Producer

type Producer struct {
	QueueName string
	Redis     *appredis.Handle
	Clock     clock.Clock
}

func (*Producer) EnqueueTask

func (p *Producer) EnqueueTask(ctx context.Context, task *Task) error

func (*Producer) GetTask

func (p *Producer) GetTask(ctx context.Context, item *QueueItem) (*Task, error)

func (*Producer) NewTask

func (p *Producer) NewTask(appID string, input json.RawMessage, taskIDPrefix string) *Task

type QueueItem

type QueueItem struct {
	AppID  string `json:"app_id,omitempty"`
	TaskID string `json:"task_id,omitempty"`
}

func (*QueueItem) RedisKey

func (i *QueueItem) RedisKey() string

type Task

type Task struct {
	ID          string              `json:"id,omitempty"`
	AppID       string              `json:"app_id,omitempty"`
	CreatedAt   *time.Time          `json:"created_at,omitempty"`
	CompletedAt *time.Time          `json:"completed_at,omitempty"`
	Status      TaskStatus          `json:"status,omitempty"`
	Input       json.RawMessage     `json:"input,omitempty"`
	Output      json.RawMessage     `json:"output,omitempty"`
	Error       *apierrors.APIError `json:"error,omitempty"`
}

func (*Task) RedisKey

func (t *Task) RedisKey() string

func (*Task) ToQueueItem

func (t *Task) ToQueueItem() *QueueItem

type TaskStatus

type TaskStatus string

const (
	TaskStatusPending   TaskStatus = "pending"
	TaskStatusCompleted TaskStatus = "completed"
)

type UserExportProducer

type UserExportProducer struct {
	*Producer
}

func NewUserExportProducer

func NewUserExportProducer(redis *appredis.Handle, clock clock.Clock) *UserExportProducer

type UserImportProducer

type UserImportProducer struct {
	*Producer
}

func NewUserImportProducer

func NewUserImportProducer(redis *appredis.Handle, clock clock.Clock) *UserImportProducer

type UserReindexProducer

type UserReindexProducer struct {
	*Producer
}

func NewUserReindexProducer

func NewUserReindexProducer(redis *appredis.Handle, clock clock.Clock) *UserReindexProducer