fix(sagemaker): Improve SSH configuration error handling for SageMaker remote connections

Author: bhavya2109sharma

packages/core/src/awsService/sagemaker/commands.ts

@@ -227,11 +227,9 @@ export async function openRemoteConnect(
             return await handleRunningSpaceWithEnabledAccess(node, ctx, spaceName)
         }
     } catch (err: any) {
-        // Suppress errors that were already shown to user
-        if (shouldSuppressError(err)) {
+        if (isUserCancelledError(err)) {
             return
         }
-        throw err
     }
 }
 
@@ -355,8 +353,7 @@ async function handleRunningSpaceWithDisabledAccess(
                 )
                 await tryRemoteConnection(node, ctx, progress)
             } catch (err: any) {
-                // Suppress errors that were already shown to user
-                if (shouldSuppressError(err)) {
+                if (isUserCancelledError(err)) {
                     return
                 }
                 throw new ToolkitError(`Remote connection failed: ${err.message}`, {
@@ -402,8 +399,7 @@ async function handleStoppedSpace(
             }
         )
     } catch (err: any) {
-        // Suppress errors that were already shown to user
-        if (shouldSuppressError(err)) {
+        if (isUserCancelledError(err)) {
             return
         }
         throw new ToolkitError(`Remote connection failed: ${(err as Error).message}`, {
@@ -436,8 +432,14 @@ async function handleRunningSpaceWithEnabledAccess(
 }
 
 /**
- * Helper function to determine if an error should be suppressed (already shown to user)
+ * Checks if an error represents a user cancellation or an error that was already shown to the user.
+ *
+ * These error codes indicate that an error dialog was already displayed, so we should
+ * not re-throw or show additional error messages.
+ *
+ * @param err - The error to check
+ * @returns true if the error was already shown to the user via a dialog or notification
  */
-function shouldSuppressError(err: any): boolean {
+function isUserCancelledError(err: any): boolean {
     return err.code === SshConfigError || err.code === InstanceTypeError
 }

packages/core/src/awsService/sagemaker/constants.ts

@@ -47,8 +47,8 @@ export const InstanceTypeNotSelectedMessage = (spaceName: string) => {
 export const RemoteAccessRequiredMessage =
     'This space requires remote access to be enabled.\nWould you like to restart the space and connect?\nAny unsaved work will be lost.'
 
-export const SshConfigErrorMessage = (sshConfigPath: string) => {
-    return `Unable to connect. ${sshConfigPath} contains SSH configuration syntax errors. Fix the errors to continue.`
+export const SshConfigErrorMessage = () => {
+    return `Unable to connect. ~/.ssh/config contains invalid SSH configuration. Fix the errors to continue.`
 }
 
 export const SmusDeeplinkSessionExpiredError = {

packages/core/src/awsService/sagemaker/model.ts

@@ -6,7 +6,7 @@
 // Disabled: detached server files cannot import vscode.
 /* eslint-disable no-restricted-imports */
 import * as vscode from 'vscode'
-import { sshAgentSocketVariable, startSshAgent, startVscodeRemote } from '../../shared/extensions/ssh'
+import { getSshConfigPath, sshAgentSocketVariable, startSshAgent, startVscodeRemote } from '../../shared/extensions/ssh'
 import { createBoundProcess, ensureDependencies } from '../../shared/remoteSession'
 import { SshConfig } from '../../shared/sshConfig'
 import * as path from 'path'
@@ -99,14 +99,12 @@ export async function prepareDevEnvConnection(
         logger.error(`sagemaker: failed to add ssh config section: ${err.message}`)
 
         if (err instanceof ToolkitError && err.code === 'SshCheckFailed') {
-            const sshConfigPath = path.join(os.homedir(), '.ssh', 'config')
+            const sshConfigPath = getSshConfigPath()
 
+            // Extracting line number from SSH error message is the best-effort.
+            // SSH error formats are not standardized and may vary across implementations.
             await vscode.window
-                .showErrorMessage(
-                    SshConfigErrorMessage(sshConfigPath),
-                    { modal: true, detail: err.message },
-                    'Open SSH Config'
-                )
+                .showErrorMessage(SshConfigErrorMessage(), { modal: true, detail: err.message }, 'Open SSH Config')
                 .then((resp) => {
                     if (resp === 'Open SSH Config') {
                         void vscode.window.showTextDocument(vscode.Uri.file(sshConfigPath))

packages/core/src/shared/sshConfig.ts

@@ -85,9 +85,11 @@ export class SshConfig {
     protected async matchSshSection() {
         const result = await this.checkSshOnHost()
         if (result.exitCode !== 0) {
-            // Format stderr error message
+            // Format stderr error message for display to user
             let errorMessage = result.stderr?.trim() || `ssh check against host failed: ${result.exitCode}`
             const sshConfigPath = getSshConfigPath()
+            // Remove the SSH config file path prefix from error messages to make them more readable
+            // SSH errors often include the full path like "/Users/name/.ssh/config: line 5: Bad configuration option"
             errorMessage = errorMessage.replace(new RegExp(`${sshConfigPath}:\\s*`, 'g'), '').trim()
 
             if (result.error) {

packages/toolkit/.changes/next-release/Bug Fix-3550c6a1-d356-45cc-a404-c87e2d2ee393.json

@@ -0,0 +1,4 @@
+{
+	"type": "Bug Fix",
+	"description": "SageMaker: SSH configuration errors now display line numbers and include an \"Open SSH Config\" button"
+}