bufsync

type ErrorHandler interface {
	// InvalidModuleConfig is invoked by Syncer upon encountering a module
	// with an invalid module config.
	InvalidModuleConfig(
		module string,
		commit git.Commit,
		err error,
	) error
	// BuildFailure is invoked by Syncer upon encountering a module that fails
	// build.
	BuildFailure(
		module string,
		moduleIdentity bufmoduleref.ModuleIdentity,
		commit git.Commit,
		err error,
	) error
}

type Module interface {
	// Dir is the path to the module relative to the repository root.
	Dir() string
	// IdentityOverride is an optional module identity override. If empty,
	// the identity specified in the module config file will be used.
	//
	// Unnamed modules will not have their identity overridden, as they are
	// not pushable.
	IdentityOverride() bufmoduleref.ModuleIdentity
}

type ModuleCommit interface {
	// Identity is the identity of the module, accounting for any configured override.
	Identity() bufmoduleref.ModuleIdentity
	// Bucket is the bucket for the module.
	Bucket() storage.ReadBucket
	// Commit is the commit that the module is sourced from.
	Commit() git.Commit
	// Branch is the git branch that this module is sourced from.
	Branch() string
	// Tags are the git tags associated with Commit.
	Tags() []string
}

type SyncFunc func(ctx context.Context, commit ModuleCommit) error

type Syncer interface {
	// Sync syncs the repository using the provided SyncFunc. It processes
	// commits in reverse topological order, loads any configured named
	// modules, extracts any Git metadata for that commit, and invokes
	// SyncFunc with a ModuleCommit.
	//
	// Only commits/branches belonging to the remote named 'origin' are
	// processed. All tags are processed.
	Sync(context.Context, SyncFunc) error
}

type SyncerOption func(*syncer) error