publicwebhook

type Config struct {
	// Credentials returns the server's Dagu Cloud credentials, and false
	// while it is not connected.
	Credentials func() (license.CloudCredentials, bool)
	Webhooks    Webhooks
	Store       Store
	Runs        Runs
	// HTTPClient reaches Dagu Cloud; nil means a client with a 30-second
	// timeout.
	HTTPClient *http.Client
	Hello      cloudrelay.Hello
	// MaxPayloadSize bounds a body that starts a run, as for local webhook
	// requests; zero leaves it to the relay.
	MaxPayloadSize int
}

type Delivery struct {
	ID       string    `json:"id"`
	Received time.Time `json:"received"`
	Size     int       `json:"size"`
	// Event names what the request is about, as its sender labels it.
	Event   string `json:"event,omitempty"`
	Outcome string `json:"outcome"`
	// RunID names the run a started delivery started.
	RunID string `json:"runId,omitempty"`
	// Error says why a delivery was rejected, skipped, or failed.
	Error string `json:"error,omitempty"`
}

type Log struct {
	Deliveries []Delivery `json:"deliveries,omitempty"`
	Missed     Missed     `json:"missed"`
}

type Missed struct {
	Expired int       `json:"expired"`
	Refused int       `json:"refused"`
	Since   time.Time `json:"since,omitzero"`
}

type Runs interface {
	// DAG loads the DAG a webhook starts.
	DAG(ctx context.Context, dagName string) (*ir.DAG, error)
	// Queued counts the runs waiting on the DAG's queue.
	Queued(ctx context.Context, dag *ir.DAG) (int, error)
	// Enqueue queues a run of the DAG named runID with params. A run by that
	// ID that already exists counts as queued. An error wrapping
	// ErrInvalidRun means waiting cannot make the run start.
	Enqueue(ctx context.Context, dagName string, dag *ir.DAG, runID, params string) error
}

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

type Status struct {
	// Connected is set while the connection is open.
	Connected bool `json:"connected"`
	// URL is what this server's public webhook URLs start with, once the
	// relay has said.
	URL string `json:"url,omitempty"`
	// MaxHooks is the most public URLs the plan allows, from the latest
	// ticket.
	MaxHooks int `json:"maxHooks,omitempty"`
	// LeftOut names the DAGs whose public URLs exceed MaxHooks and are not
	// held at the relay.
	LeftOut []string `json:"leftOut,omitempty"`
	// Holding is set while the relay holds URLs this server sent, so a URL
	// turned off while the server was away is dropped when it returns.
	Holding bool `json:"holding,omitempty"`
	// Error says why the server is not connected.
	Error     string    `json:"error,omitempty"`
	UpdatedAt time.Time `json:"updatedAt"`
}

type Store interface {
	// Log returns a webhook's log; an empty one when it has none.
	Log(ctx context.Context, webhookID string) (Log, error)
	// AddDelivery puts d first in a webhook's log, replacing an entry for the
	// same delivery, and keeps the latest LogSize.
	AddDelivery(ctx context.Context, webhookID string, d Delivery) error
	// AddMissed adds to a webhook's missed counts.
	AddMissed(ctx context.Context, webhookID string, expired, refused int, at time.Time) error
	// ClearMissed dismisses a webhook's missed counts.
	ClearMissed(ctx context.Context, webhookID string) error
	// DeleteLog removes a webhook's log, as when its public URL is turned off.
	DeleteLog(ctx context.Context, webhookID string) error
	// Status returns the relay's status; the zero Status before any.
	Status(ctx context.Context) (Status, error)
	// SetStatus replaces the relay's status.
	SetStatus(ctx context.Context, status Status) error
}

type Webhooks interface {
	// ListComplete returns every webhook, or an error when any cannot be
	// read.
	ListComplete(ctx context.Context) ([]*auth.Webhook, error)
	GetByID(ctx context.Context, id string) (*auth.Webhook, error)
}