scheduled

Documentation

Index

• Variables
• type Action
  • func ParseAction(s string) (Action, error)
  • func (i Action) IsExpireDonorIdentity() bool
  • func (i Action) MarshalText() ([]byte, error)
  • func (i Action) String() string
  • func (i *Action) UnmarshalText(text []byte) error
• type ActionFunc
• type ActionOptions
• type Bundle
• type CertificateProviderStore
• type DonorStore
• type DynamoClient
• type Event
• type EventClient
• type Logger
• type LpaStoreClient
• type MetricsClient
• type NotifyClient
• type Runner
  • func NewRunner(logger Logger, store ScheduledStore, donorStore DonorStore, ...) *Runner
  • func (r *Runner) Errored(ctx context.Context, row *Event, err error)
  • func (r *Runner) Ignored(ctx context.Context, row *Event)
  • func (r *Runner) Metrics(processingTime time.Duration) cloudwatch.PutMetricDataInput
  • func (r *Runner) Processed(ctx context.Context, row *Event)
  • func (r *Runner) Run(ctx context.Context) error
• type ScheduledStore
• type Store
  • func NewStore(dynamoClient DynamoClient) *Store
  • func (s *Store) Create(ctx context.Context, rows ...Event) error
  • func (s *Store) DeleteAllByUID(ctx context.Context, uid string) error
  • func (s *Store) Pop(ctx context.Context, day time.Time) (*Event, error)
• type Waiter

Variables

var ActionValues = ActionOptions{
	ExpireDonorIdentity: ActionExpireDonorIdentity,
}

Types

type Action

type Action uint8

const (
	// ActionExpireDonorIdentity will check that the target donor has not signed
	// their LPA, and if so remove their identity data and notify them of the
	// change.
	ActionExpireDonorIdentity Action = iota + 1

	// ActionRemindCertificateProviderToComplete will check that the target
	// certificate provider has neither provided the certificate nor opted-out,
	// and if so send them a reminder email or letter, plus another to the donor
	// (or correspondent, if set).
	ActionRemindCertificateProviderToComplete

	// ActionRemindCertificateProviderToConfirmIdentity will check that the target
	// certificate provider has not confirmed their identity, and if so send them
	// a reminder email or letter, plus another to the donor (or correspondent, if
	// set).
	ActionRemindCertificateProviderToConfirmIdentity
)

func ParseAction

func ParseAction(s string) (Action, error)

func (Action) IsExpireDonorIdentity

func (i Action) IsExpireDonorIdentity() bool

func (Action) MarshalText

func (i Action) MarshalText() ([]byte, error)

func (Action) String

func (i Action) String() string

func (*Action) UnmarshalText

func (i *Action) UnmarshalText(text []byte) error

type ActionFunc

type ActionFunc func(ctx context.Context, row *Event) error

type ActionOptions

type ActionOptions struct {
	ExpireDonorIdentity Action
}

type Bundle

type Bundle interface {
	For(lang localize.Lang) *localize.Localizer
}

type CertificateProviderStore

type CertificateProviderStore interface {
	One(ctx context.Context, pk dynamo.LpaKeyType) (*certificateproviderdata.Provided, error)
}

type DonorStore

type DonorStore interface {
	One(ctx context.Context, pk dynamo.LpaKeyType, sk dynamo.SK) (*donordata.Provided, error)
	Put(ctx context.Context, provided *donordata.Provided) error
}

type DynamoClient

type DynamoClient interface {
	AllByLpaUIDAndPartialSK(ctx context.Context, uid string, partialSK dynamo.SK, v interface{}) error
	AnyByPK(ctx context.Context, pk dynamo.PK, v interface{}) error
	Move(ctx context.Context, oldKeys dynamo.Keys, value any) error
	DeleteKeys(ctx context.Context, keys []dynamo.Keys) error
	WriteTransaction(ctx context.Context, transaction *dynamo.Transaction) error
}

type Event

type Event struct {
	PK dynamo.ScheduledDayKeyType
	SK dynamo.ScheduledKeyType
	// CreatedAt is when the event was created
	CreatedAt time.Time
	// At is when the action should be done
	At time.Time
	// Action is what to do when run
	Action Action
	// TargetLpaKey is used to specify the target of the action
	TargetLpaKey dynamo.LpaKeyType
	// TargetLpaOwnerKey is used to specify the target of the action
	TargetLpaOwnerKey dynamo.LpaOwnerKeyType
	// LpaUID is the LPA UID the action target relates to
	LpaUID string
}

A Event specifies an action to take in the future.

type EventClient

type EventClient interface {
	SendLetterRequested(ctx context.Context, event event.LetterRequested) error
}

type Logger

type Logger interface {
	InfoContext(ctx context.Context, msg string, args ...any)
	ErrorContext(ctx context.Context, msg string, args ...any)
}

type LpaStoreClient

type LpaStoreClient interface {
	Lpa(ctx context.Context, lpaUID string) (*lpadata.Lpa, error)
}

type MetricsClient

type MetricsClient interface {
	PutMetrics(ctx context.Context, input *cloudwatch.PutMetricDataInput) error
}

type NotifyClient

type NotifyClient interface {
	SendActorEmail(ctx context.Context, to notify.ToEmail, lpaUID string, email notify.Email) error
}

type Runner

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

func NewRunner

func NewRunner(logger Logger, store ScheduledStore, donorStore DonorStore, certificateProviderStore CertificateProviderStore, notifyClient NotifyClient, bundle Bundle, metricsClient MetricsClient, metricsEnabled bool) *Runner

func (*Runner) Errored

func (r *Runner) Errored(ctx context.Context, row *Event, err error)

func (*Runner) Ignored

func (r *Runner) Ignored(ctx context.Context, row *Event)

func (*Runner) Metrics

func (r *Runner) Metrics(processingTime time.Duration) cloudwatch.PutMetricDataInput

func (*Runner) Processed

func (r *Runner) Processed(ctx context.Context, row *Event)

func (*Runner) Run

func (r *Runner) Run(ctx context.Context) error

type ScheduledStore

type ScheduledStore interface {
	Pop(ctx context.Context, at time.Time) (*Event, error)
}

type Store

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

func NewStore

func NewStore(dynamoClient DynamoClient) *Store

func (*Store) Create

func (s *Store) Create(ctx context.Context, rows ...Event) error

func (*Store) DeleteAllByUID

func (s *Store) DeleteAllByUID(ctx context.Context, uid string) error

func (*Store) Pop

func (s *Store) Pop(ctx context.Context, day time.Time) (*Event, error)

type Waiter

type Waiter interface {
	Reset()
	Wait() error
}