subscription

type CacheByTagPolicy string

type MockSubscriber struct {
	ApplySubscriptionDefaultsFn func(
		ctx context.Context,
		sub *kargoapi.RepoSubscription,
	) error
	ValidateSubscriptionFn func(
		ctx context.Context,
		f *field.Path,
		sub kargoapi.RepoSubscription,
	) field.ErrorList
	DiscoverArtifactsFn func(
		ctx context.Context,
		project string,
		sub kargoapi.RepoSubscription,
		last any,
	) (any, error)
}

type Subscriber interface {
	// ApplySubscriptionDefaults applies default values to the provided
	// kargoapi.RepoSubscription.
	ApplySubscriptionDefaults(
		ctx context.Context,
		sub *kargoapi.RepoSubscription,
	) error
	// ValidateSubscription validates the provided kargoapi.RepoSubscription.
	ValidateSubscription(
		ctx context.Context,
		f *field.Path,
		sub kargoapi.RepoSubscription,
	) field.ErrorList
	// DiscoverArtifacts discovers artifacts according to the parameters of the
	// provided kargoapi.RepoSubscription. Implementations may return a value of
	// any type, but in practice, callers can only make sense of:
	// - kargoapi.ChartDiscoveryResult
	// - kargoapi.GitDiscoveryResult
	// - kargoapi.ImageDiscoveryResult
	// - kargoapi.DiscoveryResult
	//
	// last is the result this same subscription produced at the previous
	// successful discovery (of the same concrete type), or nil if there is none.
	// Implementations may use it to short-circuit expensive work when a cheap
	// check shows nothing relevant has changed; those that cannot simply ignore
	// it and return a freshly discovered result.
	DiscoverArtifacts(
		ctx context.Context,
		project string,
		sub kargoapi.RepoSubscription,
		last any,
	) (any, error)
}

type SubscriberFactory = func(
	context.Context,
	credentials.Database,
) (Subscriber, error)

type SubscriberPredicate = func(
	context.Context,
	kargoapi.RepoSubscription,
) (bool, error)

type SubscriberRegistration = component.PredicateBasedRegistration[
	kargoapi.RepoSubscription,
	SubscriberPredicate,
	SubscriberFactory,
	struct{},
]

type SubscriberRegistry = component.PredicateBasedRegistry[
	kargoapi.RepoSubscription,
	SubscriberPredicate,
	SubscriberFactory,
	struct{},
]