Mar 6, 2023 · Nov 24, 2022 · Nov 25, 2022 · Nov 25, 2022 · Nov 25, 2022 · Feb 1, 2023
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbfake/databasefake.go b/coderd/database/dbfake/databasefake.go
 TroubleshootingURL:       arg.TroubleshootingURL,
 MOTDFile:                 arg.MOTDFile,
 LifecycleState:           database.WorkspaceAgentLifecycleStateCreated,
 ShutdownScript:           arg.ShutdownScript,
 }

 q.workspaceAgents = append(q.workspaceAgents, agent)
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000097_add_shutdown_script_to_coder_agents.down.sql b/coderd/database/migrations/000097_add_shutdown_script_to_coder_agents.down.sql
 ALTER TABLE workspace_agents DROP COLUMN shutdown_script;
diff --git a/coderd/database/migrations/000097_add_shutdown_script_to_coder_agents.up.sql b/coderd/database/migrations/000097_add_shutdown_script_to_coder_agents.up.sql
 ALTER TABLE workspace_agents ADD COLUMN shutdown_script varchar(65534);

 COMMENT ON COLUMN workspace_agents.shutdown_script IS 'Script that is executed before the agent is stopped.';
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/workspaceagents.sql b/coderd/database/queries/workspaceagents.sql
 troubleshooting_url,
 motd_file,
 login_before_ready,
 startup_script_timeout_seconds
 startup_script_timeout_seconds,
 shutdown_script
 )
 VALUES
 ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19) RETURNING *;
 ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19, $20) RETURNING *;

 -- name: UpdateWorkspaceAgentConnectionByID :exec
 UPDATE
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
 MOTDFile:                    prAgent.GetMotdFile(),
 LoginBeforeReady:            prAgent.GetLoginBeforeReady(),
 StartupScriptTimeoutSeconds: prAgent.GetStartupScriptTimeoutSeconds(),
 ShutdownScript: sql.NullString{
 String: prAgent.ShutdownScript,
 Valid:  prAgent.ShutdownScript != "",
 },
 })
 if err != nil {
 return xerrors.Errorf("insert agent: %w", err)
diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
 VSCodePortProxyURI:   vscodeProxyURI,
 MOTDFile:             workspaceAgent.MOTDFile,
 StartupScriptTimeout: time.Duration(apiAgent.StartupScriptTimeoutSeconds) * time.Second,
 ShutdownScript:       apiAgent.ShutdownScript,
 })
 }

diff --git a/codersdk/agentsdk/agentsdk.go b/codersdk/agentsdk/agentsdk.go
 StartupScriptTimeout time.Duration           `json:"startup_script_timeout"`
 Directory            string                  `json:"directory"`
 MOTDFile             string                  `json:"motd_file"`
 ShutdownScript       string                  `json:"shutdown_script"`
 }

 // Metadata fetches metadata for the currently authenticated workspace agent.
diff --git a/codersdk/workspaceagents.go b/codersdk/workspaceagents.go
 // LoginBeforeReady if true, the agent will delay logins until it is ready (e.g. executing startup script has ended).
 LoginBeforeReady bool `db:"login_before_ready" json:"login_before_ready"`
 // StartupScriptTimeoutSeconds is the number of seconds to wait for the startup script to complete. If the script does not complete within this time, the agent lifecycle will be marked as start_timeout.
 StartupScriptTimeoutSeconds int32 `db:"startup_script_timeout_seconds" json:"startup_script_timeout_seconds"`
 StartupScriptTimeoutSeconds int32  `db:"startup_script_timeout_seconds" json:"startup_script_timeout_seconds"`
 ShutdownScript              string `json:"shutdown_script,omitempty"`
 }

 type DERPRegion struct {
diff --git a/docs/api/agents.md b/docs/api/agents.md
  },
  "git_auth_configs": 0,
  "motd_file": "string",
  "shutdown_script": "string",
  "startup_script": "string",
  "startup_script_timeout": 0,
  "vscode_port_proxy_uri": "string"
  "name": "string",
  "operating_system": "string",
  "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
  "shutdown_script": "string",
  "startup_script": "string",
  "startup_script_timeout_seconds": 0,
  "status": "connecting",
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2856,6 +2856,7 @@ func (q *fakeQuerier) InsertWorkspaceAgent(_ context.Context, arg database.Inser
		TroubleshootingURL: arg.TroubleshootingURL,
		MOTDFile: arg.MOTDFile,
		LifecycleState: database.WorkspaceAgentLifecycleStateCreated,
		ShutdownScript: arg.ShutdownScript,
		}

		q.workspaceAgents = append(q.workspaceAgents, agent)
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE workspace_agents DROP COLUMN shutdown_script;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		ALTER TABLE workspace_agents ADD COLUMN shutdown_script varchar(65534);

		COMMENT ON COLUMN workspace_agents.shutdown_script IS 'Script that is executed before the agent is stopped.';
Original file line number	Diff line number	Diff line change
Expand Up		@@ -58,10 +58,11 @@ INSERT INTO
		troubleshooting_url,
		motd_file,
		login_before_ready,
		startup_script_timeout_seconds
		startup_script_timeout_seconds,
		shutdown_script
		)
		VALUES
		($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19) RETURNING *;
		($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19, $20) RETURNING *;

		-- name: UpdateWorkspaceAgentConnectionByID :exec
		UPDATE
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1144,6 +1144,10 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
		MOTDFile: prAgent.GetMotdFile(),
		LoginBeforeReady: prAgent.GetLoginBeforeReady(),
		StartupScriptTimeoutSeconds: prAgent.GetStartupScriptTimeoutSeconds(),
		ShutdownScript: sql.NullString{
		String: prAgent.ShutdownScript,
		Valid: prAgent.ShutdownScript != "",
		},
		})
		if err != nil {
		return xerrors.Errorf("insert agent: %w", err)
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -153,6 +153,7 @@ func (api API) workspaceAgentMetadata(rw http.ResponseWriter, r http.Request)
		VSCodePortProxyURI: vscodeProxyURI,
		MOTDFile: workspaceAgent.MOTDFile,
		StartupScriptTimeout: time.Duration(apiAgent.StartupScriptTimeoutSeconds) * time.Second,
		ShutdownScript: apiAgent.ShutdownScript,
		})
		}

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -78,6 +78,7 @@ type Metadata struct {
		StartupScriptTimeout time.Duration `json:"startup_script_timeout"`
		Directory string `json:"directory"`
		MOTDFile string `json:"motd_file"`
		ShutdownScript string `json:"shutdown_script"`
		}

		// Metadata fetches metadata for the currently authenticated workspace agent.
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -78,7 +78,8 @@ type WorkspaceAgent struct {
		// LoginBeforeReady if true, the agent will delay logins until it is ready (e.g. executing startup script has ended).
		LoginBeforeReady bool `db:"login_before_ready" json:"login_before_ready"`
		// StartupScriptTimeoutSeconds is the number of seconds to wait for the startup script to complete. If the script does not complete within this time, the agent lifecycle will be marked as start_timeout.
		StartupScriptTimeoutSeconds int32 `db:"startup_script_timeout_seconds" json:"startup_script_timeout_seconds"`
		StartupScriptTimeoutSeconds int32 `db:"startup_script_timeout_seconds" json:"startup_script_timeout_seconds"`
		ShutdownScript string `json:"shutdown_script,omitempty"`
		}

		type DERPRegion struct {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -369,6 +369,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/metadata \
		},
		"git_auth_configs": 0,
		"motd_file": "string",
		"shutdown_script": "string",
		"startup_script": "string",
		"startup_script_timeout": 0,
		"vscode_port_proxy_uri": "string"
Expand DownExpand Up		@@ -515,6 +516,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent} \
		"name": "string",
		"operating_system": "string",
		"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
		"shutdown_script": "string",
		"startup_script": "string",
		"startup_script_timeout_seconds": 0,
		"status": "connecting",
Expand Down