fix(cli): ensure cliui.Agent doesn't fetch infinitely
#8446
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johnstcn
reviewed
Jul 12, 2023
Comment on lines
+352
to
+383
| t.Run("NotInfinite", func(t *testing.T) { | ||
| t.Parallel() | ||
| var fetchCalled uint64 | ||
|
|
||
| cmd := &clibase.Cmd{ | ||
| Handler: func(inv *clibase.Invocation) error { | ||
| buf := bytes.Buffer{} | ||
| err := cliui.Agent(inv.Context(), &buf, uuid.Nil, cliui.AgentOptions{ | ||
| FetchInterval: 10 * time.Millisecond, | ||
| Fetch: func(ctx context.Context, agentID uuid.UUID) (codersdk.WorkspaceAgent, error) { | ||
| atomic.AddUint64(&fetchCalled, 1) | ||
|
|
||
| return codersdk.WorkspaceAgent{ | ||
| Status: codersdk.WorkspaceAgentConnected, | ||
| LifecycleState: codersdk.WorkspaceAgentLifecycleReady, | ||
| }, nil | ||
| }, | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| require.Never(t, func() bool { | ||
| called := atomic.LoadUint64(&fetchCalled) | ||
| return called > 5 || called == 0 | ||
| }, time.Second, 100*time.Millisecond) | ||
|
|
||
| return nil | ||
| }, | ||
| } | ||
| require.NoError(t, cmd.Invoke().Run()) | ||
| }) |
johnstcn
approved these changes
Jul 12, 2023
mafredri
approved these changes
Jul 12, 2023
| @@ -15,13 +15,16 @@ var errAgentShuttingDown = xerrors.New("agent is shutting down") | |||
|
|
|||
| type AgentOptions struct { | |||
| FetchInterval time.Duration | |||
| Fetch func(context.Context) (codersdk.WorkspaceAgent, error) | |||
| Fetch func(ctx context.Context, agentID uuid.UUID) (codersdk.WorkspaceAgent, error) | |||
There was a problem hiding this comment.
I'm glad you made this change too (to pass agent ID)!
|
Can confirm that starting lots of parallel |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #8426