Make createAgentClient use token file and errors

code-asher · code-asher · commit 20b60a315650 · 2025-06-11T02:38:03.000-08:00
For now, the old function has been renamed to tryCreateAgentClient
because it is not clear to me if it is safe to error in these cases or
if it was intentional to create a client even if there was no valid URL
or token.
diff --git a/cli/externalauth.go b/cli/externalauth.go
@@ -75,7 +75,7 @@ fi
 				return xerrors.Errorf("agent token not found")
 			}
 
-			client, err := r.createAgentClient()
+			client, err := r.tryCreateAgentClient()
 			if err != nil {
 				return xerrors.Errorf("create agent client: %w", err)
 			}
diff --git a/cli/gitaskpass.go b/cli/gitaskpass.go
@@ -33,7 +33,7 @@ func (r *RootCmd) gitAskpass() *serpent.Command {
 				return xerrors.Errorf("parse host: %w", err)
 			}
 
-			client, err := r.createAgentClient()
+			client, err := r.tryCreateAgentClient()
 			if err != nil {
 				return xerrors.Errorf("create agent client: %w", err)
 			}
diff --git a/cli/gitssh.go b/cli/gitssh.go
@@ -38,7 +38,7 @@ func (r *RootCmd) gitssh() *serpent.Command {
 				return err
 			}
 
-			client, err := r.createAgentClient()
+			client, err := r.tryCreateAgentClient()
 			if err != nil {
 				return xerrors.Errorf("create agent client: %w", err)
 			}
diff --git a/cli/root.go b/cli/root.go
@@ -81,6 +81,7 @@ const (
 	envAgentToken = "CODER_AGENT_TOKEN"
 	//nolint:gosec
 	envAgentTokenFile = "CODER_AGENT_TOKEN_FILE"
+	envAgentURL       = "CODER_AGENT_URL"
 	envURL            = "CODER_URL"
 )
 
@@ -398,7 +399,7 @@ func (r *RootCmd) Command(subcommands []*serpent.Command) (*serpent.Command, err
 		},
 		{
 			Flag:        varAgentURL,
-			Env:         "CODER_AGENT_URL",
+			Env:         envAgentURL,
 			Description: "URL for an agent to access your deployment.",
 			Value:       serpent.URLOf(r.agentURL),
 			Hidden:      true,
@@ -668,9 +669,35 @@ func (r *RootCmd) createUnauthenticatedClient(ctx context.Context, serverURL *ur
 	return &client, err
 }
 
-// createAgentClient returns a new client from the command context.
-// It works just like CreateClient, but uses the agent token and URL instead.
+// createAgentClient returns a new client from the command context.  It works
+// just like InitClient, but uses the agent token and URL instead.
 func (r *RootCmd) createAgentClient() (*agentsdk.Client, error) {
+	agentURL := r.agentURL
+	if agentURL == nil || agentURL.String() == "" {
+		return nil, xerrors.Errorf("%s must be set", envAgentURL)
+	}
+	token := r.agentToken
+	if token == "" {
+		if r.agentTokenFile == "" {
+			return nil, xerrors.Errorf("Either %s or %s must be set", envAgentToken, envAgentTokenFile)
+		}
+		tokenBytes, err := os.ReadFile(r.agentTokenFile)
+		if err != nil {
+			return nil, xerrors.Errorf("read token file %q: %w", r.agentTokenFile, err)
+		}
+		token = strings.TrimSpace(string(tokenBytes))
+	}
+	client := agentsdk.New(agentURL)
+	client.SetSessionToken(token)
+	return client, nil
+}
+
+// tryCreateAgentClient returns a new client from the command context.  It works
+// just like tryCreateAgentClient, but does not error.
+func (r *RootCmd) tryCreateAgentClient() (*agentsdk.Client, error) {
+	// TODO: Why does this not actually return any errors despite the function
+	// signature?  Could we just use createAgentClient instead, or is it expected
+	// that we return a client in some cases even without a valid URL or token?
 	client := agentsdk.New(r.agentURL)
 	client.SetSessionToken(r.agentToken)
 	return client, nil

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ fi`
`75`	`75`	`return xerrors.Errorf("agent token not found")`
`76`	`76`	`}`
`77`	`77`
`78`		`- client, err := r.createAgentClient()`
	`78`	`+ client, err := r.tryCreateAgentClient()`
`79`	`79`	`if err != nil {`
`80`	`80`	`return xerrors.Errorf("create agent client: %w", err)`
`81`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ func (r RootCmd) gitAskpass() serpent.Command {`
`33`	`33`	`return xerrors.Errorf("parse host: %w", err)`
`34`	`34`	`}`
`35`	`35`
`36`		`- client, err := r.createAgentClient()`
	`36`	`+ client, err := r.tryCreateAgentClient()`
`37`	`37`	`if err != nil {`
`38`	`38`	`return xerrors.Errorf("create agent client: %w", err)`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ func (r RootCmd) gitssh() serpent.Command {`
`38`	`38`	`return err`
`39`	`39`	`}`
`40`	`40`
`41`		`- client, err := r.createAgentClient()`
	`41`	`+ client, err := r.tryCreateAgentClient()`
`42`	`42`	`if err != nil {`
`43`	`43`	`return xerrors.Errorf("create agent client: %w", err)`
`44`	`44`	`}`