From 4452f378198a44139044989da6e66fe8923e28bd Mon Sep 17 00:00:00 2001 From: JP Ungaretti Date: Thu, 14 Apr 2022 17:10:11 -0500 Subject: [PATCH] Clarify session helper --- pkg/cmd/codespace/common.go | 3 ++- pkg/cmd/codespace/jupyter.go | 4 ++-- pkg/cmd/codespace/logs.go | 4 ++-- pkg/cmd/codespace/ports.go | 4 ++-- pkg/cmd/codespace/ssh.go | 4 ++-- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/pkg/cmd/codespace/common.go b/pkg/cmd/codespace/common.go index 01023d924..74043e946 100644 --- a/pkg/cmd/codespace/common.go +++ b/pkg/cmd/codespace/common.go @@ -61,7 +61,8 @@ func (a *App) StopProgressIndicator() { a.io.StopProgressIndicator() } -func startSession(ctx context.Context, codespace *api.Codespace, a *App, debug bool, debugFile string) (*liveshare.Session, func(*error), error) { +// Connects to a codespace using Live Share and returns that session along with a function to end it +func startLiveShareSession(ctx context.Context, codespace *api.Codespace, a *App, debug bool, debugFile string) (*liveshare.Session, func(*error), error) { // While connecting, ensure in the background that the user has keys installed. // That lets us report a more useful error message if they don't. authkeys := make(chan error, 1) diff --git a/pkg/cmd/codespace/jupyter.go b/pkg/cmd/codespace/jupyter.go index a044bd229..c86c19568 100644 --- a/pkg/cmd/codespace/jupyter.go +++ b/pkg/cmd/codespace/jupyter.go @@ -37,11 +37,11 @@ func (a *App) Jupyter(ctx context.Context, codespaceName string) error { return err } - session, closeSession, err := startSession(ctx, codespace, a, false, "") + session, endSession, err := startLiveShareSession(ctx, codespace, a, false, "") if err != nil { return err } - defer closeSession(&err) + defer endSession(&err) a.StartProgressIndicatorWithLabel("Starting JupyterLab on codespace") serverPort, serverUrl, err := session.StartJupyterServer(ctx) diff --git a/pkg/cmd/codespace/logs.go b/pkg/cmd/codespace/logs.go index 71c289e3c..4a4152717 100644 --- a/pkg/cmd/codespace/logs.go +++ b/pkg/cmd/codespace/logs.go @@ -41,11 +41,11 @@ func (a *App) Logs(ctx context.Context, codespaceName string, follow bool) (err return err } - session, closeSession, err := startSession(ctx, codespace, a, false, "") + session, endSession, err := startLiveShareSession(ctx, codespace, a, false, "") if err != nil { return err } - defer closeSession(&err) + defer endSession(&err) // Ensure local port is listening before client (getPostCreateOutput) connects. listen, err := net.Listen("tcp", "127.0.0.1:0") // arbitrary port diff --git a/pkg/cmd/codespace/ports.go b/pkg/cmd/codespace/ports.go index eba7731fd..e70b66921 100644 --- a/pkg/cmd/codespace/ports.go +++ b/pkg/cmd/codespace/ports.go @@ -55,11 +55,11 @@ func (a *App) ListPorts(ctx context.Context, codespaceName string, exporter cmdu devContainerCh := getDevContainer(ctx, a.apiClient, codespace) - session, closeSession, err := startSession(ctx, codespace, a, false, "") + session, endSession, err := startLiveShareSession(ctx, codespace, a, false, "") if err != nil { return err } - defer closeSession(&err) + defer endSession(&err) a.StartProgressIndicatorWithLabel("Fetching ports") ports, err := session.GetSharedServers(ctx) diff --git a/pkg/cmd/codespace/ssh.go b/pkg/cmd/codespace/ssh.go index 6b060acb9..4aad28974 100644 --- a/pkg/cmd/codespace/ssh.go +++ b/pkg/cmd/codespace/ssh.go @@ -121,11 +121,11 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e return err } - session, closeSession, err := startSession(ctx, codespace, a, opts.debug, opts.debugFile) + session, endSession, err := startLiveShareSession(ctx, codespace, a, opts.debug, opts.debugFile) if err != nil { return err } - defer closeSession(&err) + defer endSession(&err) a.StartProgressIndicatorWithLabel("Fetching SSH Details") remoteSSHServerPort, sshUser, err := session.StartSSHServer(ctx)