Skip to content

Commit 1aa117b

Browse files
spikecurtisspikecurtis
authored
chore: rename client Listen to ConnectRPC (#11916)
ConnectRPC seems more appropriate for this function
1 parent 1031ccb commit 1aa117b

File tree

6 files changed

+16
-17
lines changed

6 files changed

+16
-17
lines changed

‎agent/agent.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ type Options struct {
8888
}
8989

9090
type Client interface {
91-
Listen(ctx context.Context) (drpc.Conn, error)
91+
ConnectRPC(ctx context.Context) (drpc.Conn, error)
9292
ReportStats(ctx context.Context, log slog.Logger, statsChan <-chan *agentsdk.Stats, setInterval func(time.Duration)) (io.Closer, error)
9393
PostLifecycle(ctx context.Context, state agentsdk.PostLifecycleRequest) error
9494
PostMetadata(ctx context.Context, req agentsdk.PostMetadataRequest) error
@@ -691,8 +691,8 @@ func (a *agent) run(ctx context.Context) error {
691691
}
692692
a.sessionToken.Store(&sessionToken)
693693

694-
// Listen returns the dRPC connection we use for the Agent v2+ API
695-
conn, err := a.client.Listen(ctx)
694+
// ConnectRPC returns the dRPC connection we use for the Agent and Tailnet v2+ APIs
695+
conn, err := a.client.ConnectRPC(ctx)
696696
if err != nil {
697697
return err
698698
}

‎agent/agenttest/client.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ func (c *Client) Close() {
9999
c.derpMapOnce.Do(func() { close(c.derpMapUpdates) })
100100
}
101101

102-
func (c *Client) Listen(ctx context.Context) (drpc.Conn, error) {
102+
func (c *Client) ConnectRPC(ctx context.Context) (drpc.Conn, error) {
103103
conn, lis := drpcsdk.MemTransportPipe()
104104
c.LastWorkspaceAgent = func() {
105105
_ = conn.Close()

‎coderd/workspaceagents_test.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ func TestWorkspaceAgentLogs(t *testing.T) {
319319
})
320320
}
321321

322-
func TestWorkspaceAgentListen(t *testing.T) {
322+
func TestWorkspaceAgentConnectRPC(t *testing.T) {
323323
t.Parallel()
324324

325325
t.Run("Connect", func(t *testing.T) {
@@ -400,7 +400,7 @@ func TestWorkspaceAgentListen(t *testing.T) {
400400
agentClient := agentsdk.New(client.URL)
401401
agentClient.SetSessionToken(authToken)
402402

403-
_, err = agentClient.Listen(ctx)
403+
_, err = agentClient.ConnectRPC(ctx)
404404
require.Error(t, err)
405405
var sdkErr *codersdk.Error
406406
require.ErrorAs(t, err, &sdkErr)
@@ -500,7 +500,7 @@ func TestWorkspaceAgentTailnetDirectDisabled(t *testing.T) {
500500
// Verify that the manifest has DisableDirectConnections set to true.
501501
agentClient := agentsdk.New(client.URL)
502502
agentClient.SetSessionToken(r.AgentToken)
503-
rpc, err := agentClient.Listen(ctx)
503+
rpc, err := agentClient.ConnectRPC(ctx)
504504
require.NoError(t, err)
505505
defer func() {
506506
cErr := rpc.Close()
@@ -830,7 +830,7 @@ func TestWorkspaceAgentAppHealth(t *testing.T) {
830830

831831
agentClient := agentsdk.New(client.URL)
832832
agentClient.SetSessionToken(r.AgentToken)
833-
conn, err := agentClient.Listen(ctx)
833+
conn, err := agentClient.ConnectRPC(ctx)
834834
require.NoError(t, err)
835835
defer func() {
836836
cErr := conn.Close()
@@ -1129,7 +1129,7 @@ func TestWorkspaceAgent_Metadata(t *testing.T) {
11291129
agentClient.SetSessionToken(r.AgentToken)
11301130

11311131
ctx := testutil.Context(t, testutil.WaitMedium)
1132-
conn, err := agentClient.Listen(ctx)
1132+
conn, err := agentClient.ConnectRPC(ctx)
11331133
require.NoError(t, err)
11341134
defer func() {
11351135
cErr := conn.Close()
@@ -1307,7 +1307,7 @@ func TestWorkspaceAgent_Metadata_CatchMemoryLeak(t *testing.T) {
13071307
agentClient.SetSessionToken(r.AgentToken)
13081308

13091309
ctx, cancel := context.WithCancel(testutil.Context(t, testutil.WaitSuperLong))
1310-
conn, err := agentClient.Listen(ctx)
1310+
conn, err := agentClient.ConnectRPC(ctx)
13111311
require.NoError(t, err)
13121312
defer func() {
13131313
cErr := conn.Close()
@@ -1669,7 +1669,7 @@ func requireGetManifest(ctx context.Context, t testing.TB, aAPI agentproto.DRPCA
16691669
}
16701670

16711671
func postStartup(ctx context.Context, t testing.TB, client agent.Client, startup *agentproto.Startup) error {
1672-
conn, err := client.Listen(ctx)
1672+
conn, err := client.ConnectRPC(ctx)
16731673
require.NoError(t, err)
16741674
defer func() {
16751675
cErr := conn.Close()

‎coderd/workspaceapps/apptest/setup.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ func createWorkspaceWithApps(t *testing.T, client *codersdk.Client, orgID uuid.U
398398
primaryAppHost, err := client.AppHost(appHostCtx)
399399
require.NoError(t, err)
400400
if primaryAppHost.Host != "" {
401-
rpcConn, err := agentClient.Listen(appHostCtx)
401+
rpcConn, err := agentClient.ConnectRPC(appHostCtx)
402402
require.NoError(t, err)
403403
aAPI := agentproto.NewDRPCAgentClient(rpcConn)
404404
manifest, err := aAPI.GetManifest(appHostCtx, &agentproto.GetManifestRequest{})

‎codersdk/agentsdk/agentsdk.go

+3-4
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,8 @@ func (c *Client) RewriteDERPMap(derpMap *tailcfg.DERPMap) {
171171
}
172172
}
173173

174-
// Listen connects to the workspace agent API WebSocket
175-
// that handles connection negotiation.
176-
func (c *Client) Listen(ctx context.Context) (drpc.Conn, error) {
174+
// ConnectRPC connects to the workspace agent API and tailnet API
175+
func (c *Client) ConnectRPC(ctx context.Context) (drpc.Conn, error) {
177176
rpcURL, err := c.SDK.URL.Parse("/api/v2/workspaceagents/me/rpc")
178177
if err != nil {
179178
return nil, xerrors.Errorf("parse url: %w", err)
@@ -210,7 +209,7 @@ func (c *Client) Listen(ctx context.Context) (drpc.Conn, error) {
210209
netConn := &closeNetConn{
211210
Conn: wsNetConn,
212211
closeFunc: func() {
213-
_ = conn.Close(websocket.StatusGoingAway, "Listen closed")
212+
_ = conn.Close(websocket.StatusGoingAway, "ConnectRPC closed")
214213
},
215214
}
216215
config := yamux.DefaultConfig()

‎enterprise/coderd/appearance_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ func TestServiceBanners(t *testing.T) {
176176
}
177177

178178
func requireGetServiceBanner(ctx context.Context, t *testing.T, client *agentsdk.Client) codersdk.ServiceBannerConfig {
179-
cc, err := client.Listen(ctx)
179+
cc, err := client.ConnectRPC(ctx)
180180
require.NoError(t, err)
181181
defer func() {
182182
_ = cc.Close()

0 commit comments

Comments
 (0)