c60cc7ca75
Some checks failed
CI / Run tests and lints (push) Failing after 29s
CI / Build CLI docs (push) Has been skipped
CI / Run Playwright end-to-end tests (mysql) (push) Failing after 3s
CI / Run Playwright end-to-end tests (postgres) (push) Failing after 2s
CI / Run Playwright end-to-end tests (sqlite) (push) Failing after 3s
CodeQL / Analyze (go) (push) Failing after 4s
CodeQL / Analyze (javascript) (push) Failing after 3s
Docker Image Scanners / scanners (push) Failing after 4s
Synchronize Issue Labels / Synchronize Issue Labels (push) Has been skipped
CI / Run end-to-end tests (postgres) (push) Failing after 19s
CI / Run end-to-end tests (sqlite) (push) Failing after 2s
CI / Run Playwright end-to-end tests (cockroach) (push) Failing after 2s
CI / Draft newsletter (push) Has been skipped
CI / Generate release (push) Has been skipped
CI / Pending approval Slack notification (push) Has been skipped
CI / Send newsletter (push) Has been skipped
44 lines
1.3 KiB
Go
44 lines
1.3 KiB
Go
// Copyright © 2023 Ory Corp
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package courier
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/gofrs/uuid"
|
|
"github.com/pkg/errors"
|
|
|
|
keysetpagination "github.com/ory/x/pagination/keysetpagination_v2"
|
|
)
|
|
|
|
var ErrQueueEmpty = errors.New("queue is empty")
|
|
|
|
type (
|
|
Persister interface {
|
|
AddMessage(context.Context, *Message) error
|
|
|
|
NextMessages(context.Context, uint8) ([]Message, error)
|
|
|
|
SetMessageStatus(context.Context, uuid.UUID, MessageStatus) error
|
|
|
|
LatestQueuedMessage(ctx context.Context) (*Message, error)
|
|
|
|
IncrementMessageSendCount(context.Context, uuid.UUID) error
|
|
|
|
// ListMessages lists all messages in the store given the page, itemsPerPage, status and recipient.
|
|
// Returns list of messages, total count of messages satisfied by given filter, and error if any
|
|
ListMessages(context.Context, ListCourierMessagesParameters, []keysetpagination.Option) ([]Message, *keysetpagination.Paginator, error)
|
|
|
|
// FetchMessage returns a message with the id or nil and an error if not found
|
|
FetchMessage(context.Context, uuid.UUID) (*Message, error)
|
|
|
|
// Records an attempt of sending out a courier message
|
|
// Returns an error if it fails
|
|
RecordDispatch(ctx context.Context, msgID uuid.UUID, status CourierMessageDispatchStatus, err error) error
|
|
}
|
|
PersistenceProvider interface {
|
|
CourierPersister() Persister
|
|
}
|
|
)
|