Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitaa7a9f5

Browse files
authored
feat: use v2 API for agent lifecycle updates (#12278)
Agent uses the v2 API to post lifecycle updates.Part of#10534
1 parentee7828a commitaa7a9f5

File tree

5 files changed

+99
-56
lines changed

5 files changed

+99
-56
lines changed

‎agent/agent.go

Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ type Options struct {
9090

9191
typeClientinterface {
9292
ConnectRPC(ctx context.Context) (drpc.Conn,error)
93-
PostLifecycle(ctx context.Context,state agentsdk.PostLifecycleRequest)error
9493
PostMetadata(ctx context.Context,req agentsdk.PostMetadataRequest)error
9594
RewriteDERPMap(derpMap*tailcfg.DERPMap)
9695
}
@@ -299,7 +298,6 @@ func (a *agent) init() {
299298
// may be happening, but regardless after the intermittent
300299
// failure, you'll want the agent to reconnect.
301300
func (a*agent)runLoop() {
302-
goa.reportLifecycleUntilClose()
303301
goa.reportMetadataUntilGracefulShutdown()
304302
goa.manageProcessPriorityUntilGracefulShutdown()
305303

@@ -618,21 +616,19 @@ func (a *agent) reportMetadataUntilGracefulShutdown() {
618616
}
619617
}
620618

621-
//reportLifecycleUntilClose reports the current lifecycle state once. All state
619+
//reportLifecycle reports the current lifecycle state once. All state
622620
// changes are reported in order.
623-
func (a*agent)reportLifecycleUntilClose() {
624-
// part of graceful shut down is reporting the final lifecycle states, e.g "ShuttingDown" so the
625-
// lifecycle reporting has to be via the "hard" context.
626-
ctx:=a.hardCtx
621+
func (a*agent)reportLifecycle(ctx context.Context,conn drpc.Conn)error {
622+
aAPI:=proto.NewDRPCAgentClient(conn)
627623
lastReportedIndex:=0// Start off with the created state without reporting it.
628624
for {
629625
select {
630626
case<-a.lifecycleUpdate:
631627
case<-ctx.Done():
632-
return
628+
returnctx.Err()
633629
}
634630

635-
forr:=retry.New(time.Second,15*time.Second);r.Wait(ctx);{
631+
for {
636632
a.lifecycleMu.RLock()
637633
lastIndex:=len(a.lifecycleStates)-1
638634
report:=a.lifecycleStates[lastReportedIndex]
@@ -644,33 +640,36 @@ func (a *agent) reportLifecycleUntilClose() {
644640
iflastIndex==lastReportedIndex {
645641
break
646642
}
643+
l,err:=agentsdk.ProtoFromLifecycle(report)
644+
iferr!=nil {
645+
a.logger.Critical(ctx,"failed to convert lifecycle state",slog.F("report",report))
646+
// Skip this report; there is no point retrying. Maybe we can successfully convert the next one?
647+
lastReportedIndex++
648+
continue
649+
}
650+
payload:=&proto.UpdateLifecycleRequest{Lifecycle:l}
651+
logger:=a.logger.With(slog.F("payload",payload))
652+
logger.Debug(ctx,"reporting lifecycle state")
647653

648-
a.logger.Debug(ctx,"reporting lifecycle state",slog.F("payload",report))
654+
_,err=aAPI.UpdateLifecycle(ctx,payload)
655+
iferr!=nil {
656+
returnxerrors.Errorf("failed to update lifecycle: %w",err)
657+
}
649658

650-
err:=a.client.PostLifecycle(ctx,report)
651-
iferr==nil {
652-
a.logger.Debug(ctx,"successfully reported lifecycle state",slog.F("payload",report))
653-
r.Reset()// don't back off when we are successful
654-
lastReportedIndex++
655-
select {
656-
casea.lifecycleReported<-report.State:
657-
case<-a.lifecycleReported:
658-
a.lifecycleReported<-report.State
659-
}
660-
iflastReportedIndex<lastIndex {
661-
// Keep reporting until we've sent all messages, we can't
662-
// rely on the channel triggering us before the backlog is
663-
// consumed.
664-
continue
665-
}
666-
break
659+
logger.Debug(ctx,"successfully reported lifecycle state")
660+
lastReportedIndex++
661+
select {
662+
casea.lifecycleReported<-report.State:
663+
case<-a.lifecycleReported:
664+
a.lifecycleReported<-report.State
667665
}
668-
ifxerrors.Is(err,context.Canceled)||xerrors.Is(err,context.DeadlineExceeded) {
669-
a.logger.Debug(ctx,"canceled reporting lifecycle state",slog.F("payload",report))
670-
return
666+
iflastReportedIndex<lastIndex {
667+
// Keep reporting until we've sent all messages, we can't
668+
// rely on the channel triggering us before the backlog is
669+
// consumed.
670+
continue
671671
}
672-
// If we fail to report the state we probably shouldn't exit, log only.
673-
a.logger.Error(ctx,"agent failed to report the lifecycle state",slog.Error(err))
672+
break
674673
}
675674
}
676675
}
@@ -780,6 +779,10 @@ func (a *agent) run() (retErr error) {
780779
returnerr
781780
})
782781

782+
// part of graceful shut down is reporting the final lifecycle states, e.g "ShuttingDown" so the
783+
// lifecycle reporting has to be via gracefulShutdownBehaviorRemain
784+
connMan.start("report lifecycle",gracefulShutdownBehaviorRemain,a.reportLifecycle)
785+
783786
// channels to sync goroutines below
784787
// handle manifest
785788
// |

‎agent/agenttest/client.go

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ import (
99
"time"
1010

1111
"github.com/google/uuid"
12+
"github.com/stretchr/testify/assert"
1213
"github.com/stretchr/testify/require"
1314
"golang.org/x/exp/maps"
15+
"golang.org/x/exp/slices"
1416
"golang.org/x/xerrors"
1517
"google.golang.org/protobuf/types/known/durationpb"
1618
"storj.io/drpc"
@@ -86,11 +88,10 @@ type Client struct {
8688
fakeAgentAPI*FakeAgentAPI
8789
LastWorkspaceAgentfunc()
8890

89-
mu sync.Mutex// Protects following.
90-
lifecycleStates []codersdk.WorkspaceAgentLifecycle
91-
logs []agentsdk.Log
92-
derpMapUpdateschan*tailcfg.DERPMap
93-
derpMapOnce sync.Once
91+
mu sync.Mutex// Protects following.
92+
logs []agentsdk.Log
93+
derpMapUpdateschan*tailcfg.DERPMap
94+
derpMapOnce sync.Once
9495
}
9596

9697
func (*Client)RewriteDERPMap(*tailcfg.DERPMap) {}
@@ -122,17 +123,7 @@ func (c *Client) ConnectRPC(ctx context.Context) (drpc.Conn, error) {
122123
}
123124

124125
func (c*Client)GetLifecycleStates() []codersdk.WorkspaceAgentLifecycle {
125-
c.mu.Lock()
126-
deferc.mu.Unlock()
127-
returnc.lifecycleStates
128-
}
129-
130-
func (c*Client)PostLifecycle(ctx context.Context,req agentsdk.PostLifecycleRequest)error {
131-
c.mu.Lock()
132-
deferc.mu.Unlock()
133-
c.lifecycleStates=append(c.lifecycleStates,req.State)
134-
c.logger.Debug(ctx,"post lifecycle",slog.F("req",req))
135-
returnnil
126+
returnc.fakeAgentAPI.GetLifecycleStates()
136127
}
137128

138129
func (c*Client)GetStartup()<-chan*agentproto.Startup {
@@ -189,11 +180,12 @@ type FakeAgentAPI struct {
189180
t testing.TB
190181
logger slog.Logger
191182

192-
manifest*agentproto.Manifest
193-
startupChchan*agentproto.Startup
194-
statsChchan*agentproto.Stats
195-
appHealthChchan*agentproto.BatchUpdateAppHealthRequest
196-
logsChchan<-*agentproto.BatchCreateLogsRequest
183+
manifest*agentproto.Manifest
184+
startupChchan*agentproto.Startup
185+
statsChchan*agentproto.Stats
186+
appHealthChchan*agentproto.BatchUpdateAppHealthRequest
187+
logsChchan<-*agentproto.BatchCreateLogsRequest
188+
lifecycleStates []codersdk.WorkspaceAgentLifecycle
197189

198190
getServiceBannerFuncfunc() (codersdk.ServiceBannerConfig,error)
199191
}
@@ -231,9 +223,20 @@ func (f *FakeAgentAPI) UpdateStats(ctx context.Context, req *agentproto.UpdateSt
231223
return&agentproto.UpdateStatsResponse{ReportInterval:durationpb.New(statsInterval)},nil
232224
}
233225

234-
func (*FakeAgentAPI)UpdateLifecycle(context.Context,*agentproto.UpdateLifecycleRequest) (*agentproto.Lifecycle,error) {
235-
// TODO implement me
236-
panic("implement me")
226+
func (f*FakeAgentAPI)GetLifecycleStates() []codersdk.WorkspaceAgentLifecycle {
227+
f.Lock()
228+
deferf.Unlock()
229+
returnslices.Clone(f.lifecycleStates)
230+
}
231+
232+
func (f*FakeAgentAPI)UpdateLifecycle(_ context.Context,req*agentproto.UpdateLifecycleRequest) (*agentproto.Lifecycle,error) {
233+
f.Lock()
234+
deferf.Unlock()
235+
s,err:=agentsdk.LifecycleStateFromProto(req.GetLifecycle().GetState())
236+
ifassert.NoError(f.t,err) {
237+
f.lifecycleStates=append(f.lifecycleStates,s)
238+
}
239+
returnreq.GetLifecycle(),nil
237240
}
238241

239242
func (f*FakeAgentAPI)BatchUpdateAppHealths(ctx context.Context,req*agentproto.BatchUpdateAppHealthRequest) (*agentproto.BatchUpdateAppHealthResponse,error) {

‎codersdk/agentsdk/agentsdk.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -485,6 +485,9 @@ type PostLifecycleRequest struct {
485485
ChangedAt time.Time`json:"changed_at"`
486486
}
487487

488+
// PostLifecycle posts the agent's lifecycle to the Coder server.
489+
//
490+
// Deprecated: Use UpdateLifecycle on the dRPC API instead
488491
func (c*Client)PostLifecycle(ctx context.Context,reqPostLifecycleRequest)error {
489492
res,err:=c.SDK.Request(ctx,http.MethodPost,"/api/v2/workspaceagents/me/report-lifecycle",req)
490493
iferr!=nil {

‎codersdk/agentsdk/convert.go

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,3 +311,22 @@ func ProtoFromLog(log Log) (*proto.Log, error) {
311311
Level:proto.Log_Level(lvl),
312312
},nil
313313
}
314+
315+
funcProtoFromLifecycle(reqPostLifecycleRequest) (*proto.Lifecycle,error) {
316+
s,ok:=proto.Lifecycle_State_value[strings.ToUpper(string(req.State))]
317+
if!ok {
318+
returnnil,xerrors.Errorf("unknown lifecycle state: %s",req.State)
319+
}
320+
return&proto.Lifecycle{
321+
State:proto.Lifecycle_State(s),
322+
ChangedAt:timestamppb.New(req.ChangedAt),
323+
},nil
324+
}
325+
326+
funcLifecycleStateFromProto(s proto.Lifecycle_State) (codersdk.WorkspaceAgentLifecycle,error) {
327+
caps,ok:=proto.Lifecycle_State_name[int32(s)]
328+
if!ok {
329+
return"",xerrors.Errorf("unknown lifecycle state: %d",s)
330+
}
331+
returncodersdk.WorkspaceAgentLifecycle(strings.ToLower(caps)),nil
332+
}

‎codersdk/agentsdk/convert_test.go

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import (
99
"tailscale.com/tailcfg"
1010

1111
"github.com/coder/coder/v2/agent/proto"
12+
"github.com/coder/coder/v2/coderd/database/dbtime"
1213
"github.com/coder/coder/v2/codersdk"
1314
"github.com/coder/coder/v2/codersdk/agentsdk"
1415
"github.com/coder/coder/v2/tailnet"
@@ -161,3 +162,17 @@ func TestSubsystems(t *testing.T) {
161162
proto.Startup_EXECTRACE,
162163
})
163164
}
165+
166+
funcTestProtoFromLifecycle(t*testing.T) {
167+
t.Parallel()
168+
now:=dbtime.Now()
169+
for_,s:=rangecodersdk.WorkspaceAgentLifecycleOrder {
170+
sr:= agentsdk.PostLifecycleRequest{State:s,ChangedAt:now}
171+
pr,err:=agentsdk.ProtoFromLifecycle(sr)
172+
require.NoError(t,err)
173+
require.Equal(t,now,pr.ChangedAt.AsTime())
174+
state,err:=agentsdk.LifecycleStateFromProto(pr.State)
175+
require.NoError(t,err)
176+
require.Equal(t,s,state)
177+
}
178+
}

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp