Struct Builder

coderd/wsbuilder/wsbuilder.go:52–97

Builder encapsulates the business logic of inserting a new workspace build into the database. Builder follows the so-called "Builder" pattern where options that customize the kind of build you get return a new instance of the Builder with the option applied. Example: b = wsbuilder.New(workspace,

// b = wsbuilder.New(workspace, transition).VersionID(vID).Initiator(me)
// build, job, err := b.Build(...)
type Builder struct {
	// settings that control the kind of build you get
	workspace        database.Workspace
	trans            database.WorkspaceTransition
	version          versionTarget
	state            stateTarget
	logLevel         string
	deploymentValues *codersdk.DeploymentValues
	experiments      codersdk.Experiments
	usageChecker     UsageChecker

	richParameterValues     []codersdk.WorkspaceBuildParameter
	initiator               uuid.UUID
	reason                  database.BuildReason
	templateVersionPresetID uuid.UUID

	// used during build, makes function arguments less verbose
	ctx       context.Context
	store     database.Store
	fileCache *files.CacheCloser

	// cache of objects, so we only fetch once
	template                             *database.Template
	templateVersion                      *database.TemplateVersion
	templateVersionJob                   *database.ProvisionerJob
	terraformValues                      *database.TemplateVersionTerraformValue
	templateVersionParameters            *[]previewtypes.Parameter
	templateVersionVariables             *[]database.TemplateVersionVariable
	templateVersionWorkspaceTags         *[]database.TemplateVersionWorkspaceTag
	lastBuild                            *database.WorkspaceBuild
	lastBuildErr                         *error
	lastBuildParameters                  *[]database.WorkspaceBuildParameter
	lastBuildJob                         *database.ProvisionerJob
	parameterNames                       *[]string
	parameterValues                      *[]string
	templateVersionPresetParameterValues *[]database.TemplateVersionPresetParameter
	parameterRender                      dynamicparameters.Renderer
	workspaceTags                        *map[string]string
	task                                 *database.Task
	hasTask                              *bool // A workspace without a task will have a nil `task` and false `hasTask`.

	prebuiltWorkspaceBuildStage  sdkproto.PrebuiltWorkspaceBuildStage
	verifyNoLegacyParametersOnce bool

	buildMetrics *Metrics
}

type UsageChecker interface {
	CheckBuildUsage(ctx context.Context, store database.Store, templateVersion *database.TemplateVersion, task *database.Task, transition database.WorkspaceTransition) (UsageCheckResponse, error)