refactor(agent/agentssh): move parsing of magic session and create type #16630
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johnstcn
approved these changes
Feb 19, 2025
Comment on lines
+272
to
+298
| func extractMagicSessionType(env []string) (magicType MagicSessionType, rawType string, filteredEnv []string) { | ||
| for _, kv := range env { | ||
| if !strings.HasPrefix(kv, MagicSessionTypeEnvironmentVariable) { | ||
| continue | ||
| } | ||
|
|
||
| rawType = strings.TrimPrefix(kv, MagicSessionTypeEnvironmentVariable+"=") | ||
| // Keep going, we'll use the last instance of the env. | ||
| } | ||
|
|
||
| // Always force lowercase checking to be case-insensitive. | ||
| switch MagicSessionType(strings.ToLower(rawType)) { | ||
| case MagicSessionTypeVSCode: | ||
| magicType = MagicSessionTypeVSCode | ||
| case MagicSessionTypeJetBrains: | ||
| magicType = MagicSessionTypeJetBrains | ||
| case "", MagicSessionTypeSSH: | ||
| magicType = MagicSessionTypeSSH | ||
| default: | ||
| magicType = MagicSessionTypeUnknown | ||
| } | ||
|
|
||
| return magicType, rawType, slices.DeleteFunc(env, func(kv string) bool { | ||
| return strings.HasPrefix(kv, MagicSessionTypeEnvironmentVariable+"=") | ||
| }) | ||
| } | ||
|
|
There was a problem hiding this comment.
suggestion: extractMagicSessionType(env []string) (MagicSessionType, filteredEnv, error) and return error in case of unknown magic session type?
There was a problem hiding this comment.
I kind of like the suggestion, but I don't like returning valid data from a function that returns an error. Essentially we'd still want to filter the env in the case of an error parsing the magic session type. (We only warn log currently if it's invalid.)
| @@ -612,15 +646,15 @@ func (s *Server) startPTYSession(logger slog.Logger, session ptySession, magicTy | |||
| return nil | |||
| } | |||
|
|
|||
| func (s *Server) handleSignal(logger slog.Logger, ssig ssh.Signal, signaler interface{ Signal(os.Signal) error }, magicTypeLabel string) { | |||
| func handleSignal(logger slog.Logger, ssig ssh.Signal, signaler interface{ Signal(os.Signal) error }, metrics *sshServerMetrics, magicTypeLabel string) { | |||
Comment on lines
-78
to
-79
| case "": | ||
| magicType = "ssh" |
There was a problem hiding this comment.
This smells like some cutover compatibility logic here.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change refactors the parsing of MagicSessionEnvs in the agentssh package and moves the logic to an earlier stage. Also intoduces enums for MagicSessionType.
In preparation of further changes for #15139.
I'm relying on current tests to verify this behavior, will add more test coverage in later PRs.