599c7c900f
Since the API already disallows this, this pretty much just cleans up the error reporting to the user. Example of old error: ``` $ gh cs logs -c cwndrws-redacted Starting codespace ⣽connecting to codespace: error starting codespace: HTTP 422: your codespace has an operation pending: updating to a sku with a different amount of storage; please wait until this operation is complete (https://api.github.com/user/codespaces/cwndrws-redacted/start) exit status 1 ``` Example of new error: ``` $ gh cs logs -c cwndrws-redacted codespace is disabled while it has a pending operation: Changing machine types... exit status 1 ```
115 lines
2.8 KiB
Go
115 lines
2.8 KiB
Go
package codespace
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net"
|
|
|
|
"github.com/cli/cli/v2/internal/codespaces"
|
|
"github.com/cli/cli/v2/pkg/liveshare"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func newLogsCmd(app *App) *cobra.Command {
|
|
var (
|
|
codespace string
|
|
follow bool
|
|
)
|
|
|
|
logsCmd := &cobra.Command{
|
|
Use: "logs",
|
|
Short: "Access codespace logs",
|
|
Args: noArgsConstraint,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
return app.Logs(cmd.Context(), codespace, follow)
|
|
},
|
|
}
|
|
|
|
logsCmd.Flags().StringVarP(&codespace, "codespace", "c", "", "Name of the codespace")
|
|
logsCmd.Flags().BoolVarP(&follow, "follow", "f", false, "Tail and follow the logs")
|
|
|
|
return logsCmd
|
|
}
|
|
|
|
func (a *App) Logs(ctx context.Context, codespaceName string, follow bool) (err error) {
|
|
// Ensure all child tasks (port forwarding, remote exec) terminate before return.
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
defer cancel()
|
|
|
|
codespace, err := getOrChooseCodespace(ctx, a.apiClient, codespaceName)
|
|
if err != nil {
|
|
return fmt.Errorf("get or choose codespace: %w", err)
|
|
}
|
|
|
|
if codespace.PendingOperation {
|
|
return fmt.Errorf(
|
|
"codespace is disabled while it has a pending operation: %s",
|
|
codespace.PendingOperationDisabledReason,
|
|
)
|
|
}
|
|
|
|
authkeys := make(chan error, 1)
|
|
go func() {
|
|
authkeys <- checkAuthorizedKeys(ctx, a.apiClient)
|
|
}()
|
|
|
|
session, err := codespaces.ConnectToLiveshare(ctx, a, noopLogger(), a.apiClient, codespace)
|
|
if err != nil {
|
|
return fmt.Errorf("connecting to codespace: %w", err)
|
|
}
|
|
defer safeClose(session, &err)
|
|
|
|
if err := <-authkeys; err != nil {
|
|
return err
|
|
}
|
|
|
|
// Ensure local port is listening before client (getPostCreateOutput) connects.
|
|
listen, err := net.Listen("tcp", "127.0.0.1:0") // arbitrary port
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer listen.Close()
|
|
localPort := listen.Addr().(*net.TCPAddr).Port
|
|
|
|
a.StartProgressIndicatorWithLabel("Fetching SSH Details")
|
|
remoteSSHServerPort, sshUser, err := session.StartSSHServer(ctx)
|
|
a.StopProgressIndicator()
|
|
if err != nil {
|
|
return fmt.Errorf("error getting ssh server details: %w", err)
|
|
}
|
|
|
|
cmdType := "cat"
|
|
if follow {
|
|
cmdType = "tail -f"
|
|
}
|
|
|
|
dst := fmt.Sprintf("%s@localhost", sshUser)
|
|
cmd, err := codespaces.NewRemoteCommand(
|
|
ctx, localPort, dst, fmt.Sprintf("%s /workspaces/.codespaces/.persistedshare/creation.log", cmdType),
|
|
)
|
|
if err != nil {
|
|
return fmt.Errorf("remote command: %w", err)
|
|
}
|
|
|
|
tunnelClosed := make(chan error, 1)
|
|
go func() {
|
|
fwd := liveshare.NewPortForwarder(session, "sshd", remoteSSHServerPort, false)
|
|
tunnelClosed <- fwd.ForwardToListener(ctx, listen) // error is non-nil
|
|
}()
|
|
|
|
cmdDone := make(chan error, 1)
|
|
go func() {
|
|
cmdDone <- cmd.Run()
|
|
}()
|
|
|
|
select {
|
|
case err := <-tunnelClosed:
|
|
return fmt.Errorf("connection closed: %w", err)
|
|
case err := <-cmdDone:
|
|
if err != nil {
|
|
return fmt.Errorf("error retrieving logs: %w", err)
|
|
}
|
|
|
|
return nil // success
|
|
}
|
|
}
|