Thanks to visit codestin.com
Credit goes to github.com

Skip to content

refactor: normalize workspace agent session metadata #28124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EhabY merged 4 commits into from
Aug 20, 2026
Merged

refactor: normalize workspace agent session metadata #28124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
341e227
refactor: normalize workspace agent session metadata
EhabY Aug 13, 2026
211489d
refactor: move session app name vocabulary into codersdk
EhabY Aug 20, 2026
f4134b4
refactor: name session app names as app names, not magic types
EhabY Aug 20, 2026
51db48a
refactor(agent): rename MagicSessionTypeEnvironmentVariable to AppNam…
EhabY Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions agent/agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,19 +424,18 @@ func (a *agent) init() {
BlockFileTransfer: a.blockFileTransfer,
BlockReversePortForwarding: a.blockReversePortForwarding,
BlockLocalPortForwarding: a.blockLocalPortForwarding,
ReportConnection: func(id uuid.UUID, magicType agentssh.MagicSessionType, ip string) func(code int, reason string) {
ReportConnection: func(id uuid.UUID, appName string, ip string) func(code int, reason string) {
var connectionType proto.Connection_Type
switch magicType {
case agentssh.MagicSessionTypeSSH:
// Connection_Type is a fixed enum, stored as a database enum in
// the connection log, so it can only hold a family.
switch codersdk.AppNameFamily(appName) {
case codersdk.AppFamilySSH:
connectionType = proto.Connection_SSH
case agentssh.MagicSessionTypeVSCode:
case codersdk.AppFamilyVSCode:
connectionType = proto.Connection_VSCODE
case agentssh.MagicSessionTypeJetBrains:
case codersdk.AppFamilyJetBrains:
connectionType = proto.Connection_JETBRAINS
case agentssh.MagicSessionTypeUnknown:
connectionType = proto.Connection_TYPE_UNSPECIFIED
default:
a.logger.Error(a.hardCtx, "unhandled magic session type when reporting connection", slog.F("magic_type", magicType))
connectionType = proto.Connection_TYPE_UNSPECIFIED
}

Expand Down Expand Up @@ -2162,11 +2161,11 @@ func (a *agent) Collect(ctx context.Context, networkStats map[netlogtype.Connect
stats.TxPackets += int64(counts.TxPackets)
}

// The count of active sessions.
sshStats := a.sshServer.ConnStats()
stats.SessionCountSsh = sshStats.Sessions
stats.SessionCountVscode = sshStats.VSCode
stats.SessionCountJetbrains = sshStats.JetBrains
// The count of active sessions; types without a protocol field are dropped.
sessionCounts := a.sshServer.SessionCounts()
stats.SessionCountSsh = sessionCounts[string(codersdk.AppFamilySSH)]
stats.SessionCountVscode = sessionCounts[string(codersdk.AppFamilyVSCode)]
stats.SessionCountJetbrains = sessionCounts[string(codersdk.AppFamilyJetBrains)]

stats.SessionCountReconnectingPty = a.reconnectingPTYServer.ConnCount()

Expand Down
8 changes: 4 additions & 4 deletions agent/agent_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,13 +310,13 @@ func TestAgent_Stats_Magic(t *testing.T) {
defer sshClient.Close()
session, err := sshClient.NewSession()
require.NoError(t, err)
session.Setenv(agentssh.MagicSessionTypeEnvironmentVariable, string(agentssh.MagicSessionTypeVSCode))
session.Setenv(agentssh.AppNameEnvironmentVariable, string(codersdk.AppFamilyVSCode))
defer session.Close()

command := "sh -c 'echo $" + agentssh.MagicSessionTypeEnvironmentVariable + "'"
command := "sh -c 'echo $" + agentssh.AppNameEnvironmentVariable + "'"
expected := ""
if runtime.GOOS == "windows" {
expected = "%" + agentssh.MagicSessionTypeEnvironmentVariable + "%"
expected = "%" + agentssh.AppNameEnvironmentVariable + "%"
command = "cmd.exe /c echo " + expected
}
output, err := session.Output(command)
Expand All @@ -338,7 +338,7 @@ func TestAgent_Stats_Magic(t *testing.T) {
defer sshClient.Close()
session, err := sshClient.NewSession()
require.NoError(t, err)
session.Setenv(agentssh.MagicSessionTypeEnvironmentVariable, string(agentssh.MagicSessionTypeVSCode))
session.Setenv(agentssh.AppNameEnvironmentVariable, string(codersdk.AppFamilyVSCode))
defer session.Close()
stdin, err := session.StdinPipe()
require.NoError(t, err)
Expand Down
Loading
Loading