turbostate

Documentation

Overview

Package turbostate holds all of the state given from the Rust CLI that is necessary to execute turbo. We transfer this state from Rust to Go via a JSON payload.

Index

• type APIClientConfig
• type Command
• type Config
• type DaemonPayload
• type ExecutionState
• type ParsedArgsFromRust
• type PrunePayload
• type RunPayload
• type TaskHashTracker

Types

type APIClientConfig

type APIClientConfig struct {
	Token        string `json:"token"`
	TeamID       string `json:"team_id"`
	TeamSlug     string `json:"team_slug"`
	APIURL       string `json:"api_url"`
	UsePreflight bool   `json:"use_preflight"`
	Timeout      uint64 `json:"timeout"`
}

APIClientConfig holds the authentication and endpoint details for the API client

type Command

type Command struct {
	Daemon *DaemonPayload `json:"daemon"`
	Prune  *PrunePayload  `json:"prune"`
	Run    *RunPayload    `json:"run"`
}

Command consists of the data necessary to run a command. Only one of these fields should be initialized at a time.

type Config

type Config struct {
	APIURL    string `json:"apiUrl"`
	LoginURL  string `json:"loginUrl"`
	TeamSlug  string `json:"teamSlug"`
	TeamID    string `json:"teamId"`
	Token     string `json:"token"`
	Signature bool   `json:"signature"`
	Preflight bool   `json:"preflight"`
	Timeout   uint64 `json:"timeout"`
	Enabled   *bool  `json:"enabled"`
}

Config holds the resolved configuration from the combination of all sources.

type DaemonPayload

type DaemonPayload struct {
	IdleTimeout string `json:"idle_time"`
	JSON        bool   `json:"json"`
}

DaemonPayload is the extra flags and command that are passed for the `daemon` subcommand

type ExecutionState

type ExecutionState struct {
	Config                Config             `json:"config"`
	APIClientConfig       APIClientConfig    `json:"api_client_config"`
	SpacesAPIClientConfig APIClientConfig    `json:"spaces_api_client_config"`
	PackageManager        string             `json:"package_manager"`
	CLIArgs               ParsedArgsFromRust `json:"cli_args"`
}

ExecutionState is the entire state of a turbo execution that is passed from the Rust shim.

type ParsedArgsFromRust

type ParsedArgsFromRust struct {
	API                string  `json:"api"`
	Color              bool    `json:"color"`
	CPUProfile         string  `json:"cpu_profile"`
	CWD                string  `json:"cwd"`
	Heap               string  `json:"heap"`
	Login              string  `json:"login"`
	NoColor            bool    `json:"no_color"`
	Preflight          bool    `json:"preflight"`
	RemoteCacheTimeout uint64  `json:"remote_cache_timeout"`
	Team               string  `json:"team"`
	Token              string  `json:"token"`
	Trace              string  `json:"trace"`
	Verbosity          int     `json:"verbosity"`
	TestRun            bool    `json:"test_run"`
	Command            Command `json:"command"`
}

ParsedArgsFromRust are the parsed command line arguments passed from the Rust shim

type PrunePayload

type PrunePayload struct {
	Scope     []string `json:"scope"`
	Docker    bool     `json:"docker"`
	OutputDir string   `json:"output_dir"`
}

PrunePayload is the extra flags passed for the `prune` subcommand

type RunPayload

type RunPayload struct {
	CacheDir           string       `json:"cache_dir"`
	CacheWorkers       int          `json:"cache_workers"`
	Concurrency        string       `json:"concurrency"`
	ContinueExecution  bool         `json:"continue_execution"`
	DryRun             string       `json:"dry_run"`
	Filter             []string     `json:"filter"`
	Force              bool         `json:"force"`
	FrameworkInference bool         `json:"framework_inference"`
	GlobalDeps         []string     `json:"global_deps"`
	EnvMode            util.EnvMode `json:"env_mode"`
	// NOTE: Graph has three effective states that is modeled using a *string:
	//   nil -> no flag passed
	//   ""  -> flag passed but no file name attached: print to stdout
	//   "foo" -> flag passed and file name attached: emit to file
	// The mirror for this in Rust is `Option<String>` with the default value
	// for the flag being `Some("")`.
	Graph                    *string  `json:"graph"`
	Ignore                   []string `json:"ignore"`
	IncludeDependencies      bool     `json:"include_dependencies"`
	NoCache                  bool     `json:"no_cache"`
	Daemon                   bool     `json:"daemon"`
	NoDaemon                 bool     `json:"no_daemon"`
	NoDeps                   bool     `json:"no_deps"`
	Only                     bool     `json:"only"`
	OutputLogs               string   `json:"output_logs"`
	LogOrder                 string   `json:"log_order"`
	PassThroughArgs          []string `json:"pass_through_args"`
	Parallel                 bool     `json:"parallel"`
	Profile                  string   `json:"profile"`
	RemoteOnly               bool     `json:"remote_only"`
	Scope                    []string `json:"scope"`
	Since                    string   `json:"since"`
	SinglePackage            bool     `json:"single_package"`
	Summarize                bool     `json:"summarize"`
	Tasks                    []string `json:"tasks"`
	PkgInferenceRoot         string   `json:"pkg_inference_root"`
	LogPrefix                string   `json:"log_prefix"`
	ExperimentalSpaceID      string   `json:"experimental_space_id"`
	ExperimentalRustCodepath bool     `json:"experimental_rust_codepath"`
}

RunPayload is the extra flags passed for the `run` subcommand

type TaskHashTracker

type TaskHashTracker struct {
	PackageTaskHashes map[string]string `json:"package_task_hashes"`
}

TaskHashTracker stores the hashes calculated in Rust