buildengine

Documentation

Overview

Package buildengine provides a framework for building FTL modules.

Index

• Variables
• func Build(ctx context.Context, module Module) error
• func BuildOrder(modules []Module) ([][]Module, error)
• func DiscoverModules(dirs ...string) ([]moduleconfig.ModuleConfig, error)
• func SetPOMProperties(ctx context.Context, baseDir string) error
• func WalkDir(dir string, fn func(path string, d fs.DirEntry) error) error
• func Watch(ctx context.Context, period time.Duration, dirs ...string) *pubsub.Topic[WatchEvent]
• type FileChangeType
  • func CompareFileHashes(oldFiles, newFiles FileHashes) (FileChangeType, string, bool)
  • func (f FileChangeType) GoString() string
  • func (f FileChangeType) String() string
• type FileHashes
  • func ComputeFileHashes(config moduleconfig.ModuleConfig) (FileHashes, error)
• type Module
  • func LoadModule(dir string) (Module, error)
  • func UpdateAllDependencies(modules []moduleconfig.ModuleConfig) ([]Module, error)
  • func UpdateDependencies(config moduleconfig.ModuleConfig) (Module, error)
• type WatchEvent
• type WatchEventModuleAdded
• type WatchEventModuleChanged
• type WatchEventModuleRemoved

Variables

var ErrSkip = errors.New("skip directory")

ErrSkip can be returned by the WalkDir callback to skip a file or directory.

Functions

func Build

func Build(ctx context.Context, module Module) error

Build a module in the given directory given the schema and module config.

func BuildOrder

func BuildOrder(modules []Module) ([][]Module, error)

BuildOrder returns groups of modules in topological order that can be built in parallel.

func DiscoverModules

func DiscoverModules(dirs ...string) ([]moduleconfig.ModuleConfig, error)

DiscoverModules recursively loads all modules under the given directories.

If no directories are provided, the current working directory is used.

func SetPOMProperties

func SetPOMProperties(ctx context.Context, baseDir string) error

SetPOMProperties updates the ftl.version and ftlEndpoint properties in the pom.xml file in the given base directory.

func WalkDir

func WalkDir(dir string, fn func(path string, d fs.DirEntry) error) error

WalkDir performs a depth-first walk of the file tree rooted at dir, calling fn for each file or directory in the tree, including dir.

It will adhere to .gitignore files. The callback "fn" can return ErrSkip to skip recursion.

func Watch

func Watch(ctx context.Context, period time.Duration, dirs ...string) *pubsub.Topic[WatchEvent]

Watch the given directories for new modules, deleted modules, and changes to existing modules, publishing a change event for each.

Types

type FileChangeType

type FileChangeType rune

const (
	FileAdded   FileChangeType = '+'
	FileRemoved FileChangeType = '-'
	FileChanged FileChangeType = '*'
)

func CompareFileHashes

func CompareFileHashes(oldFiles, newFiles FileHashes) (FileChangeType, string, bool)

CompareFileHashes compares the hashes of the files in the oldFiles and newFiles maps.

Returns true if the hashes are equal, false otherwise.

If false, the returned string will be a file that caused the difference and the returned FileChangeType will be the type of change that occurred.

func (FileChangeType) GoString

func (f FileChangeType) GoString() string

func (FileChangeType) String

func (f FileChangeType) String() string

type FileHashes

type FileHashes map[string][]byte

func ComputeFileHashes

func ComputeFileHashes(config moduleconfig.ModuleConfig) (FileHashes, error)

ComputeFileHashes computes the SHA256 hash of all (non-git-ignored) files in the given directory.

type Module

type Module struct {
	moduleconfig.ModuleConfig
	Dependencies []string
}

A Module is a ModuleConfig with its dependencies populated.

func LoadModule

func LoadModule(dir string) (Module, error)

LoadModule loads a module from the given directory.

A Module includes the module configuration as well as its dependencies extracted from source code.

func UpdateAllDependencies

func UpdateAllDependencies(modules []moduleconfig.ModuleConfig) ([]Module, error)

UpdateAllDependencies calls UpdateDependencies on each module in the list.

func UpdateDependencies

func UpdateDependencies(config moduleconfig.ModuleConfig) (Module, error)

UpdateDependencies finds the dependencies for an FTL module and returns a Module with those dependencies populated.

type WatchEvent

type WatchEvent interface {
	// contains filtered or unexported methods
}

A WatchEvent is an event that occurs when a module is added, removed, or changed.

type WatchEventModuleAdded

type WatchEventModuleAdded struct{ Module Module }

type WatchEventModuleChanged

type WatchEventModuleChanged struct {
	Module Module
	Change FileChangeType
	Path   string
}

type WatchEventModuleRemoved

type WatchEventModuleRemoved struct{ Module Module }