Help us shape the future of Go! Take the 2026 Go Developer Survey

server

package
v0.8.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 16, 2026 License: MIT Imports: 68 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ErrClassAuth              = "auth"
	ErrClassQuota             = "quota"
	ErrClassCapacity          = "capacity"
	ErrClassUnsupportedFlavor = "unsupported_flavor"
	ErrClassTransient         = "transient"
	ErrClassUnknown           = "unknown"
)

Job error classes surfaced on the job queue and used by the UI banner / CLI. See migrations/000028_job_error_class.up.sql for the schema and 2026-05-05 incident for the motivating story.

View Source 
const (
	UpgradeStatusUpToDate        = "up_to_date"
	UpgradeStatusNeedsUpgrade    = "needs_upgrade"
	UpgradeStatusUnsupportedArch = "unsupported_arch"
	UpgradeStatusUnknown         = "unknown"
)
View Source 
const DefaultAssignTrigger int32 = 500 // 5 sec
View Source 
const SupportedUpgradeArch = "linux/amd64"

SupportedUpgradeArch is the only arch Phase II auto-apply will target. Phase I (visibility) reports status for every arch but distinguishes `unsupported_arch` from `needs_upgrade` so the UI/CLI can hide the "redeploy this one" call-to-action where redeployment is gated on multi-arch binary distribution we haven't built yet.

Variables

This section is empty.

Functions

func CheckPassword 

func CheckPassword(plaintext, hashed string) bool

func FetchWorkersForWatchdog 

func FetchWorkersForWatchdog(ctx context.Context, db *sql.DB) ([]watchdog.WorkerInfo, error)

FetchWorkersForWatchdog reads workers and builds WorkerInfo list

func GateExit added in v0.8.1 

func GateExit() func(int)

GateExit returns the current exit hook used by the SIGUSR1 graceful drain. Tests use this to swap in a recorder, then restore on cleanup.

func GateStdout added in v0.8.1 

func GateStdout() io.Writer

GateStdout / SetGateStdout: same pattern for the stdout writer the gate uses to emit its drained-line JSON. Tests substitute a buffer.

func HttpServer 

func HttpServer(cfg config.Config) (tls.Certificate, string, http.Handler, error)

func IsAdmin 

func IsAdmin(ctx context.Context) bool

func LoadEmbeddedCertificates 

func LoadEmbeddedCertificates() (tls.Certificate, string, error)

func LogoutHandler 

func LogoutHandler(w http.ResponseWriter, r *http.Request)

LogoutHandler clears the session_token cookie to log out the user.

func NewLogin 

func NewLogin(s *taskQueueServer) http.HandlerFunc

NewLogin returns an HTTP handler function to process login requests.

func Serve 

func Serve(cfg config.Config, ctx context.Context, cancel context.CancelFunc) error

func SetGateExit added in v0.8.1 

func SetGateExit(f func(int))

SetGateExit replaces the SIGUSR1 graceful-drain exit hook. Default is `os.Exit`. Tests must restore the previous value via t.Cleanup().

func SetGateStdout added in v0.8.1 

func SetGateStdout(w io.Writer)

func TriggerStuckDeleteCleanup added in v0.8.1 

func TriggerStuckDeleteCleanup() error

TriggerStuckDeleteCleanup runs one synchronous tick of the stuck-delete janitor. The janitor's regular schedule (~5 min) is too slow for tests; this seam lets the integration test fire it on demand. Returns nil if the server hasn't started its janitor yet (the trigger is only armed inside startStuckDeleteCleanup).

func WorkerUpgradeStatus added in v0.8.1 

func WorkerUpgradeStatus(workerArch, workerCommit, serverCommit string) string

WorkerUpgradeStatus computes the derived upgrade status from the worker's reported build identity and the server's own commit. Inputs:

  • workerArch: GOOS/GOARCH the worker reported, e.g. "linux/amd64". Empty string = pre-Phase-I worker (didn't report).
  • workerCommit: the worker's git SHA (full or short — compared as-is). Empty = pre-Phase-I worker.
  • serverCommit: the server's own git SHA. If empty (e.g. a `dev` build that lost its VCS stamp), every worker reports `unknown` — we can't make a comparison either side.

Returns one of the UpgradeStatus* constants.

Types

type Accumulator 

type Accumulator struct {
	Count int32
	Sum   float64
	Min   float64
	Max   float64
}

In-memory aggregation types for step/workflow stats Accumulator holds aggregation stats for durations/counts.

type AuthenticatedUser 

type AuthenticatedUser struct {
	UserID   int
	Username string
	IsAdmin  bool
}

func GetUserFromContext 

func GetUserFromContext(ctx context.Context) *AuthenticatedUser

type Job 

type Job struct {
	JobID         int32
	WorkerID      int32
	WorkerName    string
	ProviderID    int32
	ProviderName  string
	Region        string
	Flavor        string
	Action        rune // "C", "D", "R"
	Retry         int
	Timeout       time.Duration
	FromRecruiter bool
}

Job represents a task to be executed.

type ObjectiveDefinition added in v0.7.5 

type ObjectiveDefinition struct {
	Formula   string `json:"formula"`
	Direction string `json:"direction"` // "maximize" or "minimize"
}

ObjectiveDefinition defines one objective in a multi-objective quality definition.

type ParamSpec 

type ParamSpec struct {
	Name     string   `json:"name"`
	Type     string   `json:"type"`
	Required bool     `json:"required"`
	Default  string   `json:"default"`
	Help     string   `json:"help"` // Or `json:"description"` if your field is named so
	Choices  []string `json:"choices,omitempty"`
}

type QualityDefinition added in v0.7.2 

type QualityDefinition struct {
	Variables  map[string]string     `json:"variables"`            // name -> regex pattern (one capture group)
	Formula    string                `json:"formula,omitempty"`    // single-objective formula (backward compat)
	Objectives []ObjectiveDefinition `json:"objectives,omitempty"` // multi-objective: list of {formula, direction}
}

QualityDefinition is the JSON structure stored in step.quality_definition.

func ParseQualityDefinition added in v0.7.2 

func ParseQualityDefinition(jsonStr string) (*QualityDefinition, error)

ParseQualityDefinition parses a JSON quality definition string.

type QualityResult added in v0.7.2 

type QualityResult struct {
	Vars   map[string]float64 `json:"vars"`
	Score  float64            `json:"score"`            // primary score (first objective, or single formula)
	Scores []float64          `json:"scores,omitempty"` // all objective scores (multi-objective only)
}

QualityResult holds extracted variables and computed scores.

func ExtractQuality added in v0.7.2 

func ExtractQuality(def *QualityDefinition, stdout, stderr string) (*QualityResult, error)

ExtractQuality runs quality variable regexes against log text and evaluates the formula. Each regex captures the LAST match (for iterative programs that output metrics repeatedly).

type StepAgg 

type StepAgg struct {
	// Task status counters
	Waiting      int32
	Pending      int32
	Accepted     int32
	Running      int32
	Uploading    int32
	Succeeded    int32
	Failed       int32
	ReallyFailed int32          // tasks that have exhausted all retries and are failed
	Retrying     int32          // tasks currently being retried
	RetryingSet  map[int32]bool // set of task IDs currently retrying
	Total        int32

	// Accumulators for durations
	Download   Accumulator
	Upload     Accumulator
	SuccessRun Accumulator
	FailRun    Accumulator

	// RunningTasks maps taskID to start time
	RunningTasks map[int32]time.Time

	// Time bounds (epoch seconds)
	StartTime *int64
	EndTime   *int64
}

StepAgg aggregates statistics for a step within a workflow.

func NewStepAgg 

func NewStepAgg() *StepAgg

NewStepAgg creates a new StepAgg with sensible defaults.

type StepStatsAgg 

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

StepStatsAgg holds in-memory aggregated statistics for steps in workflows.

func NewStepStatsAgg 

func NewStepStatsAgg(db *sql.DB) (*StepStatsAgg, error)

NewStepStatsAgg creates a new StepStatsAgg with initialized internal maps.

func (*StepStatsAgg) Adjust added in v0.7.5 

func (a *StepStatsAgg) Adjust(workflowID, stepID int32, fn func(*StepAgg))

Adjust runs fn with the StepAgg for (workflowID, stepID) while holding the aggregator mutex. It lazily creates any missing map entries so call sites don't need to care about initialisation order. This is the canonical way to mutate counters from anywhere outside UpdateTaskStatus; using it eliminates the two classes of drift caused by unlocked direct map access:

  • races with concurrent writers (int32 increments are not atomic)
  • updates to a StepAgg that Reconcile has just orphaned by swapping data

func (*StepStatsAgg) EnsureStep 

func (a *StepStatsAgg) EnsureStep(workflowID, stepID int32)

EnsureStep guarantees an entry exists for (workflowID, stepID).

func (*StepStatsAgg) Reconcile added in v0.7.2 

func (a *StepStatsAgg) Reconcile(db *sql.DB)

Reconcile rebuilds the in-memory stats from the database, fixing any drift between cached counters and actual task states.

func (*StepStatsAgg) RemoveStep 

func (a *StepStatsAgg) RemoveStep(stepID int32) int32

RemoveStep deletes a step entry by its stepID, scanning all workflows to locate it.

func (*StepStatsAgg) RemoveWorkflow 

func (a *StepStatsAgg) RemoveWorkflow(workflowID int32)

type TaskUpdateBroadcast 

type TaskUpdateBroadcast struct {
	TaskId   int32
	Status   string
	WorkerId int32
}

Source Files

View all Source files

Directories

Path Synopsis
azure
fake
openstack
azure
openstack
run

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.