app

Documentation

Overview

Package app contains types to run the app.

Index

• Constants
• Variables
• type App
  • func New(opts ...Opt) *App
  • func (a *App) Start(ctx context.Context) error
• type Opt
  • func OptCacheDirectory(dir string) Opt
  • func OptEnableApolloTracing(enable bool) Opt
  • func OptEnableSignalHandling(enable bool) Opt
  • func OptGitSourcesDirectory(dir string) Opt
  • func OptGracefulShutdownTimeout(timeout time.Duration) Opt
  • func OptJobConcurrency(concurrency int) Opt
  • func OptKeysFile(filename string) Opt
  • func OptListenAddress(address string) Opt
  • func OptLogCap(cap int) Opt
  • func OptLogLevel(level models.LogLevel) Opt
  • func OptOpenBrowser(open bool) Opt
  • func OptPeriodicJobsInterval(interval time.Duration) Opt
  • func OptPubSubHistoryCap(cap int) Opt
  • func OptSourcesFile(filename string) Opt
  • func OptUI(fs http.FileSystem) Opt
  • func OptWorkspacesDirectory(dir string) Opt

Constants

const (
	// DefaultListenAddress is the default listen address.
	DefaultListenAddress = ":3333"

	// DefaultJobConcurrency is the default concurrency of the job manager.
	DefaultJobConcurrency = 2

	// DefaultLogLevel is the default log level.
	DefaultLogLevel = models.LogLevelInfo

	// DefaultLogCap is the default capacity of the logger.
	DefaultLogCap = 10000

	// DefaultPubSubHistoryCap is the default capacity of the PubSub history.
	DefaultPubSubHistoryCap = 1000

	// DefaultPeriodicJobsInterval is the default periodic jobs interval.
	DefaultPeriodicJobsInterval = time.Minute

	// DefaultGracefulShutdownTimeout is the default graceful shutdown timeout.
	DefaultGracefulShutdownTimeout = 20 * time.Second

	// DefaultOpenBrowser is whether to open the user interface in a browser by default.
	DefaultOpenBrowser = true

	// DefaultEnableApolloTracing is whether to enable Apollo tracing by default.
	DefaultEnableApolloTracing = false

	// DefaultEnableSignalHandling is whether to enable signal handling by default.
	DefaultEnableSignalHandling = true
)

Variables

var (
	// DefaultSettingsFile is the default settings file.
	DefaultSettingsFile = "settings.yml"

	// DefaultSourcesFile is the default sources file.
	DefaultSourcesFile = "sources.yml"

	// DefaultKeysFile is the default keys file.
	DefaultKeysFile = "keys.yml"

	// DefaultGitSourcesDirectory is the default Git sources directory.
	DefaultGitSourcesDirectory = "git-sources"

	// DefaultWorkspacesDirectory is the default workspace directory.
	DefaultWorkspacesDirectory = "workspaces"

	// DefaultCacheDirectory is the default cache directory.
	DefaultCacheDirectory = "cache"
)

Types

type App

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

App contains data about the app.

func New

func New(opts ...Opt) *App

New creates a new App.

func (*App) Start

func (a *App) Start(ctx context.Context) error

Start starts the app. It blocks until an error occurs or the app exits.

type Opt

type Opt func(*App)

Opt represents an app option.

func OptCacheDirectory

func OptCacheDirectory(dir string) Opt

OptCacheDirectory sets the directory for the cache.

func OptEnableApolloTracing

func OptEnableApolloTracing(enable bool) Opt

OptEnableApolloTracing tells the app whether to enable the Apollo tracing middleware.

func OptEnableSignalHandling

func OptEnableSignalHandling(enable bool) Opt

OptEnableSignalHandling tells the app whether to handle exit signals.

func OptGitSourcesDirectory

func OptGitSourcesDirectory(dir string) Opt

OptGitSourcesDirectory sets the directory for Git sources.

func OptGracefulShutdownTimeout

func OptGracefulShutdownTimeout(timeout time.Duration) Opt

OptGracefulShutdownTimeout sets the maximum duration for a graceful shutdown.

func OptJobConcurrency

func OptJobConcurrency(concurrency int) Opt

OptJobConcurrency sets the concurrency of the job manager.

func OptKeysFile

func OptKeysFile(filename string) Opt

OptKeysFile sets the keys file.

func OptListenAddress

func OptListenAddress(address string) Opt

OptListenAddress sets the listen address.

func OptLogCap

func OptLogCap(cap int) Opt

OptLogCap sets the capacity of the logger.

func OptLogLevel

func OptLogLevel(level models.LogLevel) Opt

OptLogLevel sets the minimum level for log messages.

func OptOpenBrowser

func OptOpenBrowser(open bool) Opt

OptOpenBrowser tells the app whether to open the user interface in a browser.

func OptPeriodicJobsInterval

func OptPeriodicJobsInterval(interval time.Duration) Opt

OptPeriodicJobsInterval sets the time to wait between periodic jobs.

func OptPubSubHistoryCap

func OptPubSubHistoryCap(cap int) Opt

OptPubSubHistoryCap sets the capacity of the PubSub history cap.

func OptSourcesFile

func OptSourcesFile(filename string) Opt

OptSourcesFile sets the sources file.

func OptUI

func OptUI(fs http.FileSystem) Opt

OptUI sets the file system for the UI.

func OptWorkspacesDirectory

func OptWorkspacesDirectory(dir string) Opt

OptWorkspacesDirectory sets the directory for workspaces.