Auto update IDE settings for serverless ssh mode#4559
Open
Conversation
In serverless ssh mode (ssh connect command without cluster flag and with the ide flag set), we need to set up the desired server ports (or socket connection mode) for the connection to go through (as the majority of the localhost ports on the remote side are blocked by iptable rules). Plus the platform (always linux), and extensions (python and jupyter), to make the initial experience smoother. This is done by checking the IDE settings file and updating it if necessary, prompting the user for confirmation before doing so. If the settings file is not found (fresh IDE install), we create one with the recommended configuration. If there are any other issues during the update process, we log the error and print the manual instructions for the user, proceeding with the connection anyway.
ilia-db
requested review from
andrewnester,
anton-107,
denik,
pietern and
shreyas-goenka
as code owners
ilia-db
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
Collaborator
|
Commit: d513f64
15 interesting tests: 7 KNOWN, 7 SKIP, 1 RECOVERED
Top 27 slowest tests (at least 2 minutes):
|
ilia-db
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
anton-107
requested changes
Feb 20, 2026
| } | ||
|
|
||
| func saveSettings(path string, settings map[string]any) error { | ||
| data, err := json.MarshalIndent(settings, "", " ") |
Contributor
There was a problem hiding this comment.
this is quite destructive to the user settings file:
- all user comments in their settings are stripped
- the order of the fields is not preserved
2 suggestions to already existing mitigation of creating a backup file:
- be explicit about the settings file might lose comments and current formatting / ordering
- show a preview to the user of which settings need to be added - so that they have a chance to paste those settings themselves
| } | ||
|
|
||
| if missing.listenOnSocket { | ||
| settings[listenOnSocketKey] = true |
Contributor
There was a problem hiding this comment.
is there any way to limit the scope of this setting to the current connection? if not, we might want to be explicit about that this setting is global and might break other connections the user might be using
| return fmt.Errorf("failed to prompt user: %w", err) | ||
| } | ||
| if !shouldUpdate { | ||
| log.Infof(ctx, "Skipping IDE settings update") |
Contributor
There was a problem hiding this comment.
if the settings update is skipped i suggest we should still show to the user what settings we are suggesting. otherwise this could lead to a silently broken workflow.
| return nil | ||
| } | ||
|
|
||
| backupPath := path + ".bak" |
Contributor
There was a problem hiding this comment.
two consequent runs of ssh connect might leave user with no good backup of their settings, we can improve here by ensuring that at least one backup is stored on user's disk keeping the settings as they were before user started using this command.
| return fmt.Errorf("failed to marshal settings: %w", err) | ||
| } | ||
|
|
||
| if err := os.WriteFile(path, data, 0o600); err != nil { |
Contributor
There was a problem hiding this comment.
we should acquire the file lock before writing here to prevent data loss on concurrent writes
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Changes
In serverless ssh mode (ssh connect command without cluster flag and with the ide flag set), we need to set up the desired server ports (or socket connection mode) for the connection to go through (as the majority of the localhost ports on the remote side are blocked by iptable rules). Plus the platform (always linux), and extensions (python and jupyter), to make the initial experience smoother.
This is done by checking the IDE settings file and updating it if necessary, prompting the user for confirmation before doing so.
If the settings file is not found (fresh IDE install), we create one with the recommended configuration. If there are any other issues during the update process, we log the error and print the manual instructions for the user, proceeding with the connection anyway.
Tests
New unit tests, plus manual tests on all platforms (WIP)