Merge pull request cli#4511 from cli/jg/keepalive-fix

josebalius · web-flow · commit d5c9630faed7 · 2021-10-13T14:44:10.000-04:00
codespace ssh: fix for nil logger on non-debugging scenarios
diff --git a/pkg/cmd/codespace/ssh.go b/pkg/cmd/codespace/ssh.go
@@ -62,17 +62,19 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e
 		return fmt.Errorf("get or choose codespace: %w", err)
 	}
 
-	var debugLogger *fileLogger
+	liveshareLogger := noopLogger()
 	if opts.debug {
-		debugLogger, err = newFileLogger(opts.debugFile)
+		debugLogger, err := newFileLogger(opts.debugFile)
 		if err != nil {
 			return fmt.Errorf("error creating debug logger: %w", err)
 		}
 		defer safeClose(debugLogger, &err)
+
+		liveshareLogger = debugLogger.Logger
 		a.logger.Println("Debug file located at: " + debugLogger.Name())
 	}
 
-	session, err := codespaces.ConnectToLiveshare(ctx, a.logger, debugLogger, a.apiClient, codespace)
+	session, err := codespaces.ConnectToLiveshare(ctx, a.logger, liveshareLogger, a.apiClient, codespace)
 	if err != nil {
 		return fmt.Errorf("error connecting to Live Share: %w", err)
 	}
diff --git a/pkg/liveshare/client.go b/pkg/liveshare/client.go
@@ -75,10 +75,6 @@ func Connect(ctx context.Context, opts Options) (*Session, error) {
 		return nil, err
 	}
 
-	if opts.Logger == nil {
-		return nil, errors.New("Logger is required")
-	}
-
 	sock := newSocket(uri, opts.TLSConfig)
 	if err := sock.connect(ctx); err != nil {
 		return nil, fmt.Errorf("error connecting websocket: %w", err)

Original file line number	Diff line number	Diff line change
`@@ -62,17 +62,19 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e`
`62`	`62`	`return fmt.Errorf("get or choose codespace: %w", err)`
`63`	`63`	`}`
`64`	`64`
`65`		`- var debugLogger *fileLogger`
	`65`	`+ liveshareLogger := noopLogger()`
`66`	`66`	`if opts.debug {`
`67`		`- debugLogger, err = newFileLogger(opts.debugFile)`
	`67`	`+ debugLogger, err := newFileLogger(opts.debugFile)`
`68`	`68`	`if err != nil {`
`69`	`69`	`return fmt.Errorf("error creating debug logger: %w", err)`
`70`	`70`	`}`
`71`	`71`	`defer safeClose(debugLogger, &err)`
	`72`	`+`
	`73`	`+ liveshareLogger = debugLogger.Logger`
`72`	`74`	`a.logger.Println("Debug file located at: " + debugLogger.Name())`
`73`	`75`	`}`
`74`	`76`
`75`		`- session, err := codespaces.ConnectToLiveshare(ctx, a.logger, debugLogger, a.apiClient, codespace)`
	`77`	`+ session, err := codespaces.ConnectToLiveshare(ctx, a.logger, liveshareLogger, a.apiClient, codespace)`
`76`	`78`	`if err != nil {`
`77`	`79`	`return fmt.Errorf("error connecting to Live Share: %w", err)`
`78`	`80`	`}`