Struct agent

agent/agent.go:250–343

}

type agent struct {
	clock                 quartz.Clock
	logger                slog.Logger
	client                Client
	tailnetListenPort     uint16
	filesystem            afero.Fs
	logDir                string
	tempDir               string
	scriptDataDir         string
	listeningPortsHandler listeningPortsHandler
	subsystems            []codersdk.AgentSubsystem

	reconnectingPTYTimeout time.Duration
	reconnectingPTYServer  *reconnectingpty.Server

	// we track 2 contexts and associated cancel functions: "graceful" which is Done when it is time
	// to start gracefully shutting down and "hard" which is Done when it is time to close
	// everything down (regardless of whether graceful shutdown completed).
	gracefulCtx    context.Context
	gracefulCancel context.CancelFunc
	hardCtx        context.Context
	hardCancel     context.CancelFunc

	// closeMutex protects the following:
	closeMutex        sync.Mutex
	closeWaitGroup    sync.WaitGroup
	coordDisconnected chan struct{}
	closing           bool
	// note that once the network is set to non-nil, it is never modified, as with the statsReporter. So, routines
	// that run after createOrUpdateNetwork and check the networkOK checkpoint do not need to hold the lock to use them.
	network       *tailnet.Conn
	statsReporter *statsReporter
	// end fields protected by closeMutex

	environmentVariables map[string]string

	manifest atomic.Pointer[agentsdk.Manifest] // manifest is atomic because values can change after reconnection.
	// secrets are held separately from the manifest so that code paths that
	// only need manifest data cannot accidentally access or leak secret
	// values. Callers that need secrets must explicitly load this.
	secrets                            atomic.Pointer[[]agentsdk.WorkspaceSecret]
	reportMetadataInterval             time.Duration
	scriptRunner                       *agentscripts.Runner
	announcementBanners                atomic.Pointer[[]codersdk.BannerConfig] // announcementBanners is atomic because it is periodically updated.
	announcementBannersRefreshInterval time.Duration
	sshServer                          *agentssh.Server
	sshMaxTimeout                      time.Duration
	blockFileTransfer                  bool
	blockReversePortForwarding         bool
	blockLocalPortForwarding           bool

	lifecycleUpdate            chan struct{}
	lifecycleReported          chan codersdk.WorkspaceAgentLifecycle
	lifecycleMu                sync.RWMutex // Protects following.
	lifecycleStates            []agentsdk.PostLifecycleRequest
	lifecycleLastReportedIndex int // Keeps track of the last lifecycle state we successfully reported.

	reportConnectionsUpdate chan struct{}