feat: Integrate workspace agent into coderd #398

kylecarbs · 2022-03-03T16:43:46Z

A lot of this code is kinda crummy. I'd like to refactor some of the API handler names for resources, but that can come in a later PR.

bryphe-coder · 2022-03-03T16:46:20Z

cli/workspaceagent.go

+		// This command isn't useful for users, and seems
+		// more likely to confuse.
+		Hidden: true,


Makes sense to me 👍

codecov · 2022-03-03T16:47:49Z

Codecov Report

Merging #398 (9895965) into main (73cb452) will decrease coverage by 1.76%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #398      +/-   ##
==========================================
- Coverage   67.87%   66.10%   -1.77%     
==========================================
  Files         150       71      -79     
  Lines        8482      773    -7709     
  Branches       72       72              
==========================================
- Hits         5757      511    -5246     
+ Misses       2148      248    -1900     
+ Partials      577       14     -563

Flag	Coverage Δ
unittest-go-macos-latest	`?`
unittest-go-ubuntu-latest	`?`
unittest-go-windows-2022	`?`
unittest-js	`66.10% <ø> (ø)`

Impacted Files	Coverage Δ
agent/agent.go
cli/projectcreate.go
cli/root.go
cli/workspaces.go
coderd/cmd/root.go
coderd/coderd.go
coderd/coderdtest/coderdtest.go
coderd/projectimport.go
coderd/provisionerdaemons.go
coderd/provisionerjobs.go
... and 69 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 73cb452...9895965. Read the comment docs.

bryphe-coder · 2022-03-04T03:34:01Z

cli/workspaceagent.go

+
+func workspaceAgent() *cobra.Command {
+	return &cobra.Command{
+		Use: "agent",


Having the coder agent command is a huge step!

bryphe-coder · 2022-03-04T03:38:50Z

coderd/workspaceagent.go

+	api.websocketWaitGroup.Add(1)
+	defer api.websocketWaitGroup.Done()


Glad we have this to hook into now to ensure that the websockets get cleaned up properly

bryphe-coder · 2022-03-04T03:40:52Z

coderd/workspaceagentauth_test.go

+	return r(req)
+}
+
+// Create's a new Google metadata client to authenticate.


Suggested change

// Create's a new Google metadata client to authenticate.

// Creates a new Google metadata client to authenticate.

Just noticed this extra apostrophe!

bryphe-coder · 2022-03-04T03:41:01Z

coderd/workspaceagentauth_test.go

+	})
+}
+
+// Create's a signed JWT with a randomly generated private key.


Suggested change

// Create's a signed JWT with a randomly generated private key.

// Creates a signed JWT with a randomly generated private key.

bryphe-coder · 2022-03-04T03:41:16Z

coderd/workspaceagentauth_test.go

+	return signedKey, keyID, privateKey
+}
+
+// Create's a validator that verifies against the provided private key.


Suggested change

// Create's a validator that verifies against the provided private key.

// Creates a validator that verifies against the provided private key.

bryphe-coder · 2022-03-04T03:43:22Z

httpmw/workspaceresourceparam.go

+
+type workspaceResourceParamContextKey struct{}
+
+// ProvisionerJobParam returns the project from the ExtractProjectParam handler.


Suggested change

// ProvisionerJobParam returns the project from the ExtractProjectParam handler.

// WorkspaceResourceParam returns the provisioner job resource from the handler.

bryphe-coder · 2022-03-04T03:45:01Z

coderd/workspaceagent_test.go

 		job := coderdtest.CreateProjectImportJob(t, client, user.Organization, &echo.Responses{
-			Parse: echo.ParseComplete,
+			Parse:           echo.ParseComplete,
+			ProvisionDryRun: echo.ProvisionComplete,


bryphe-coder · 2022-03-04T03:56:46Z

agent/agent_test.go

@@ -94,11 +94,9 @@ func TestAgent(t *testing.T) {

 func setup(t *testing.T) proto.DRPCPeerBrokerClient {
 	client, server := provisionersdk.TransportPipe()
-	closer := agent.New(func(ctx context.Context) (*peerbroker.Listener, error) {
-		return peerbroker.Listen(server, &peer.ConnOptions{
-			Logger: slogtest.Make(t, nil),


If I understand correctly, it seems like the log level for this has changed - I wonder if that could be related to the test failure here: https://github.com/coder/coder/runs/5416391323?check_suite_focus=true#step:7:168

(thinking maybe this change increases the verbosity of logs, and one of those more-verbose logs is what gets emitted after the test is complete).

bryphe-coder · 2022-03-04T03:59:26Z

Unfortunately I saw this error in the CI run:

==================
panic: Log in goroutine after TestAgent/SessionTTY has completed: 2022-03-04 01:41:53.577 [DEBUG]	<conn.go:557>	closing conn with error ...
"error": recv:
             github.com/coder/coder/peerbroker.(*peerBrokerService).NegotiateConnection
                 /home/runner/work/coder/coder/peerbroker/listen.go:158
           - context canceled

https://github.com/coder/coder/runs/5416391323?check_suite_focus=true#step:7:168

I was thinking maybe one of two possibilities:

A change in loglevel in agent_test.go introduces logs that weren't emitted before, but now are after the test has finished
It might be an intermittent issue - it seems like the session might need to be closed as well?

We currently wait for the session, ie:

err = session.Wait()
require.NoError(t, err)

But wondering if it needs to be closed too as part of cleanup:

err = session.Wait()
require.NoError(t, err)
err = session.Close()
require.NoError(t, err)

bryphe-coder

Looks good to me - just some minor nits on the comments, and was thinking around the test failure I observed in the latest commit.

Congrats on getting the agent integrated into coderd 🍾

kylecarbs · 2022-03-07T01:36:15Z

Superseded by #401

kylecarbs added 2 commits March 3, 2022 16:02

Add client for agent

051edda

Cleanup code

1aec36d

kylecarbs requested a review from bryphe-coder March 3, 2022 16:43

kylecarbs self-assigned this Mar 3, 2022

bryphe-coder reviewed Mar 3, 2022

View reviewed changes

kylecarbs marked this pull request as ready for review March 4, 2022 01:35

Fix linting error

74f0328

kylecarbs force-pushed the agentlink branch from 7180233 to 74f0328 Compare March 4, 2022 01:40

Remove DownloadURL

6c2a3e2

bryphe-coder reviewed Mar 4, 2022

View reviewed changes

bryphe-coder approved these changes Mar 4, 2022

View reviewed changes

Fix listening

9895965

kylecarbs closed this Mar 7, 2022

kylecarbs deleted the agentlink branch March 7, 2022 01:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Integrate workspace agent into coderd #398

feat: Integrate workspace agent into coderd #398

kylecarbs commented Mar 3, 2022 •

edited

Loading

bryphe-coder Mar 3, 2022

codecov bot commented Mar 3, 2022 •

edited

Loading

bryphe-coder Mar 4, 2022

bryphe-coder Mar 4, 2022

bryphe-coder Mar 4, 2022

bryphe-coder Mar 4, 2022

bryphe-coder Mar 4, 2022

bryphe-coder Mar 4, 2022

bryphe-coder Mar 4, 2022 •

edited

Loading

bryphe-coder Mar 4, 2022

bryphe-coder Mar 4, 2022

bryphe-coder commented Mar 4, 2022

bryphe-coder left a comment

kylecarbs commented Mar 7, 2022

		api.websocketWaitGroup.Add(1)
		defer api.websocketWaitGroup.Done()

	// Create's a new Google metadata client to authenticate.
	// Creates a new Google metadata client to authenticate.

	// Create's a signed JWT with a randomly generated private key.
	// Creates a signed JWT with a randomly generated private key.

	// Create's a validator that verifies against the provided private key.
	// Creates a validator that verifies against the provided private key.


		type workspaceResourceParamContextKey struct{}

		// ProvisionerJobParam returns the project from the ExtractProjectParam handler.

	// ProvisionerJobParam returns the project from the ExtractProjectParam handler.
	// WorkspaceResourceParam returns the provisioner job resource from the handler.

feat: Integrate workspace agent into coderd #398

feat: Integrate workspace agent into coderd #398

Conversation

kylecarbs commented Mar 3, 2022 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Mar 3, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bryphe-coder Mar 4, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bryphe-coder commented Mar 4, 2022

bryphe-coder left a comment

Choose a reason for hiding this comment

kylecarbs commented Mar 7, 2022

kylecarbs commented Mar 3, 2022 •

edited

Loading

codecov bot commented Mar 3, 2022 •

edited

Loading

bryphe-coder Mar 4, 2022 •

edited

Loading