source

Documentation

Overview

Package source defines the contracts and helpers used to implement ibdm data sources. Sources expose event streams, sync processes, webhooks setup and optional shutdown semantics through shared interfaces.

Index

• type ClosableSource
• type Data
  • func (d *Data) Timestamp() string
• type DataOperation
  • func (i DataOperation) String() string
• type EventSource
• type Extra
• type SyncableSource
• type Webhook
• type WebhookHandler
• type WebhookSource

Types

type ClosableSource

type ClosableSource interface {
	// Close releases resources, respecting the provided timeout.
	Close(ctx context.Context, timeout time.Duration) (err error)
}

ClosableSource supports graceful shutdown.

type Data

type Data struct {
	// Type describes the kind of entity (e.g., "repository", "issue").
	Type string
	// Operation indicates whether the entity must be upserted or deleted.
	Operation DataOperation
	// Values holds the raw payload. For delete operations, it must contain enough data to reconstruct the identifier.
	Values map[string]any
	// Time indicates the timestamp of the event that generated this data.
	Time time.Time
}

Data groups the type, operation, and values emitted by a source.

func (*Data) Timestamp

func (d *Data) Timestamp() string

type DataOperation

type DataOperation int

const (
	// DataOperationUpsert represents an upsert (insert or update) operation.
	DataOperationUpsert DataOperation = iota
	// DataOperationDelete represents a delete operation.
	DataOperationDelete
)

func (DataOperation) String

func (i DataOperation) String() string

type EventSource

type EventSource interface {
	// StartEventStream begins streaming updates, writing to results or returning an error.
	// typesToStream lists the expected data types.
	StartEventStream(ctx context.Context, typesToStream map[string]Extra, results chan<- Data) (err error)
}

EventSource streams data updates as they arrive.

type Extra

type Extra map[string]any

Extra represents additional configuration for a source data type.

type SyncableSource

type SyncableSource interface {
	// StartSyncProcess kicks off a sync run, pushing data into results or returning an error.
	// typesToSync lists the data types to fetch.
	StartSyncProcess(ctx context.Context, typesToSync map[string]Extra, results chan<- Data) (err error)
}

SyncableSource exposes a pull-based synchronization flow.

type Webhook

type Webhook struct {
	Method  string
	Path    string
	Handler WebhookHandler
}

type WebhookHandler

type WebhookHandler func(ctx context.Context, headers http.Header, body []byte) error

type WebhookSource

type WebhookSource interface {
	// GetWebhook sets up webhooks for the specified data types, sending updates to results or returning an error.
	// typesToStream lists the expected data types.
	GetWebhook(ctx context.Context, typesToStream map[string]Extra, results chan<- Data) (webhook Webhook, err error)
}