lease

Documentation

Index

• type Document
• type Manager
  • func NewManager(ctx context.Context, logger *logging.Logger, guaranteedUntil time.Time, ...) *Manager
  • func (m *Manager) SlogLogger() *slog.Logger
  • func (m *Manager) StderrWriter() io.Writer
  • func (m *Manager) StdoutWriter() io.Writer
  • func (m *Manager) Write(p []byte) (n int, err error)

Types

type Document

type Document struct {
	ExpireAt time.Time
	User     string
	Reason   string
}

Document represents a Firestore document representing a lease.

type Manager

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

Manager handles a lease document and manages the lease state.

func NewManager

func NewManager(ctx context.Context, logger *logging.Logger, guaranteedUntil time.Time, docRef *firestore.DocumentRef) *Manager

NewManager creates a new lease watcher.

• guaranteedUntil is the time until which the lease is guaranteed to be active
• if guaranteedUntil is in the past, the lease is disabled immediately
• if guaranteedUntil is in the future, the lease is enabled until that time
• to handle changes to the lease, WatchLease must be called
• start the lease manager in a goroutine to watch the lease until the context is canceled

func (*Manager) SlogLogger

func (m *Manager) SlogLogger() *slog.Logger

SlogLogger returns a slog.Logger that writes to both stdout and the logger.

• always logs to stdout
• logs to the logger only when the lease is enabled or the initial lease time has not yet expired

func (*Manager) StderrWriter

func (m *Manager) StderrWriter() io.Writer

StderrWriter returns an io.Writer that writes to both stderr and the logger.

• it always writes all messages to stderr and the logger, regardless of the lease state
• logs are all written as ERROR level

func (*Manager) StdoutWriter

func (m *Manager) StdoutWriter() io.Writer

StdoutWriter returns an io.Writer that writes to both stdout and the logger.

• it writes to stdout only when the lease is enabled or the initial lease time has not yet expired
• logs are all written as INFO level

func (*Manager) Write

func (m *Manager) Write(p []byte) (n int, err error)

Write writes a log message directly to the logger if the lease is active

• if the lease is not active, the message is discarded