buildengine

type AdminClient ¶ added in v0.448.0

type AdminClient interface {
	ApplyChangeset(ctx context.Context, req *connect.Request[adminpb.ApplyChangesetRequest]) (*connect.ServerStreamForClient[adminpb.ApplyChangesetResponse], error)
	ClusterInfo(ctx context.Context, req *connect.Request[adminpb.ClusterInfoRequest]) (*connect.Response[adminpb.ClusterInfoResponse], error)
	GetArtefactDiffs(ctx context.Context, req *connect.Request[adminpb.GetArtefactDiffsRequest]) (*connect.Response[adminpb.GetArtefactDiffsResponse], error)
	UploadArtefact(ctx context.Context) *connect.ClientStreamForClient[adminpb.UploadArtefactRequest, adminpb.UploadArtefactResponse]
	StreamLogs(ctx context.Context, req *connect.Request[adminpb.StreamLogsRequest]) (*connect.ServerStreamForClient[adminpb.StreamLogsResponse], error)
	Ping(ctx context.Context, req *connect.Request[ftlv1.PingRequest]) (*connect.Response[ftlv1.PingResponse], error)
}

type Config ¶ added in v0.434.0

type Config struct {
	EventCacheRetention *time.Duration `help:"Delete cached events after this time period. 0 to disable" env:"FTL_EVENT_CACHE_RETENTION" default:"24h"`
}

type DependencyCycleError ¶ added in v0.460.0

type DependencyCycleError struct {
	Modules []string
}

func (e DependencyCycleError) Error() string

type DependencyGrapher ¶ added in v0.462.0

type DependencyGrapher interface {
	Graph(moduleNames ...string) (map[string][]string, error)
}

type DependencyMode ¶

type DependencyMode string

DependencyMode is an enum for dependency modes

const (
	Raw                  DependencyMode = "Raw"
	AlwaysIncludeBuiltin DependencyMode = "AlwaysIncludingBuiltin"
)

type DeployCoordinator ¶ added in v0.462.0

type DeployCoordinator struct {
	SchemaUpdates chan SchemaUpdatedEvent
	// contains filtered or unexported fields
}

DeployCoordinator manages the deployment of modules through changesets. It ensures that changesets are deployed in the correct order and that changesets are not deployed if they are superseded by a newer changeset.

The DeployCoordinator also maintains a schema based on active changesets and queued modules. This allows the build engine to build modules against where the schema is moving to. For example if module A is dependant on module B and module B builds with a breaking schema change deploy coordinator will put deployment of A into a pending state, but publish it as part of the its schema. This allows the build engine to react and build module A against the new schema for module B. The DeployCoordinator will then create a changeset of A and B together.

func NewDeployCoordinator(
	ctx context.Context,
	adminClient AdminClient,
	schemaSource *schemaeventsource.EventSource,
	dependencyGrapher DependencyGrapher,
	engineUpdates chan *buildenginepb.EngineEvent,
	logChanges bool,
) *DeployCoordinator

type Engine ¶

type Engine struct {

	// topic to subscribe to engine events
	EngineUpdates *pubsub.Topic[*buildenginepb.EngineEvent]
	// contains filtered or unexported fields
}

Engine for building a set of modules.

func New(
	ctx context.Context,
	adminClient AdminClient,
	schemaSource *schemaeventsource.EventSource,
	projectConfig projectconfig.Config,
	moduleDirs []string,
	updatesEndpoint *url.URL,
	logChanges bool,
	options ...Option,
) (*Engine, error)

func (e *Engine) Build(ctx context.Context) error

func (e *Engine) BuildAndDeploy(ctx context.Context, replicas optional.Option[int32], waitForDeployOnline bool, singleChangeset bool, moduleNames ...string) (err error)

func (e *Engine) Close() error

func (e *Engine) Dev(ctx context.Context, period time.Duration) error

func (e *Engine) Each(fn func(Module) error) (err error)

func (e *Engine) GetModuleSchema(moduleName string) (*schema.Module, bool)

func (e *Engine) Graph(moduleNames ...string) (map[string][]string, error)

func (e *Engine) Import(ctx context.Context, moduleSch *schema.Module)

func (e *Engine) Modules() []string

type Module ¶

type Module struct {
	Config moduleconfig.ModuleConfig
	// paths to deploy, relative to ModuleConfig.DeployDir
	Deploy []string
	// contains filtered or unexported fields
}

Module represents an FTL module in the build engine

func (m Module) CopyWithDependencies(dependencies []string) Module

func (m Module) CopyWithDeploy(files []string) Module

func (m Module) Dependencies(mode DependencyMode) []string

type Option ¶

type Option func(o *Engine)

func BuildEnv(env []string) Option

func Parallelism(n int) Option

func WithDevMode(updates chan dev.LocalEndpoint) Option

func WithStartTime(startTime time.Time) Option

type SchemaUpdatedEvent ¶ added in v0.462.0

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