push

Documentation

Index

• Variables
• type Config
• type Event
  • func NewMessageEnqueuedEvent() *Event
  • func NewWebhooksUpdatedEvent() *Event
• type Mode
• type Params
• type Service
  • func New(params Params) *Service
  • func (s *Service) Enqueue(token string, event *Event) error
  • func (s *Service) Run(ctx context.Context)

Variables

var Module = fx.Module(
	"push",
	fx.Decorate(func(log *zap.Logger) *zap.Logger {
		return log.Named("push")
	}),
	fx.Provide(
		func(cfg Config, lc fx.Lifecycle) (c client, err error) {
			if cfg.Mode == ModeFCM {
				c, err = fcm.New(cfg.ClientOptions)
			} else if cfg.Mode == ModeUpstream {
				c, err = upstream.New(cfg.ClientOptions)
			} else {
				return nil, errors.New("invalid push mode")
			}

			if err != nil {
				return nil, err
			}

			lc.Append(fx.Hook{
				OnStart: func(ctx context.Context) error {
					return c.Open(ctx)
				},
				OnStop: func(ctx context.Context) error {
					return c.Close(ctx)
				},
			})

			return c, nil
		},
	),
	fx.Provide(
		New,
	),
)

Types

type Config

type Config struct {
	Mode Mode

	ClientOptions map[string]string

	Debounce time.Duration
	Timeout  time.Duration
}

type Event

type Event = domain.Event

func NewMessageEnqueuedEvent

func NewMessageEnqueuedEvent() *Event

func NewWebhooksUpdatedEvent

func NewWebhooksUpdatedEvent() *Event

type Mode

type Mode string

const (
	ModeFCM      Mode = "fcm"
	ModeUpstream Mode = "upstream"
)

type Params

type Params struct {
	fx.In

	Config Config

	Client client

	Logger *zap.Logger
}

type Service

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

func New

func New(params Params) *Service

func (*Service) Enqueue

func (s *Service) Enqueue(token string, event *Event) error

Enqueue adds the data to the cache and immediately sends all messages if the debounce is 0.

func (*Service) Run

func (s *Service) Run(ctx context.Context)

Run runs the service with the provided context if a debounce is set.