feat(coderd): return agent script timings #14923

BrunoQuaresma · 2024-10-01T19:04:02Z

Add the agent script timings into the /workspacebuilds/:workspacebuild/timings response.

Add the agent script timings into the `/workspaces/:workspaceId/timings` response.

dannykopping

Good start, but I think this needs some hardening.

dannykopping · 2024-10-01T19:06:52Z

coderd/database/dbmem/dbmem.go

+		if slices.Contains(scriptIDs, t.ScriptID) {
+			var script database.WorkspaceAgentScript
+			for _, s := range scripts {
+				if s.ID == t.ScriptID {
+					script = s
+					break
+				}
+			}
+
+			rows = append(rows, database.GetWorkspaceAgentScriptTimingsByWorkspaceIDRow{
+				ScriptID:    t.ScriptID,
+				StartedAt:   t.StartedAt,
+				EndedAt:     t.EndedAt,
+				ExitCode:    t.ExitCode,
+				Stage:       t.Stage,
+				Status:      t.Status,
+				DisplayName: script.DisplayName,
+			})
+		}


Nit: reduce nesting by keeping the happy path unindented.

i.e. continue if the slice does not contain what you're looking for.

coderd/workspaces.go

coderd/workspaces_test.go

coderd/database/queries/workspaceagents.sql

…ent-timings

BrunoQuaresma · 2024-10-03T17:10:39Z

@dannykopping I'm not sure if I addressed all your comments, but since I made a bunch of changes, I feel it is time for a second review round.

dannykopping

Great work @BrunoQuaresma!

dannykopping · 2024-10-04T13:09:31Z

coderd/coderd.go

@@ -1150,7 +1150,6 @@ func New(options *Options) *API {
 					r.Post("/", api.postWorkspaceAgentPortShare)
 					r.Delete("/", api.deleteWorkspaceAgentPortShare)
 				})
-				r.Get("/timings", api.workspaceTimings)


We should check if this endpoint got included in a release. If it has, we'll have to keep it.

@BrunoQuaresma In theory this is a breaking change... is there any frontend component using it?

Even if there isn't a frontend using it, customers might have already started integrating with it.

dannykopping · 2024-10-04T13:10:50Z

coderd/database/dbmem/dbmem.go

+
+	build, err := q.GetWorkspaceBuildByID(ctx, id)
+	if err != nil {
+		return nil, err


Please wrap these errors.

What do you mean by " wrap these errors"?

Suggested change

return nil, err

return nil, xerrors.Errorf("failed to retrieve workspace build: %w", err)

This adds context for what might be a fairly generic error.

dannykopping · 2024-10-04T13:28:24Z

coderd/workspacebuilds_test.go

+
+		// When: fetching an inexistent build
+		buildID := uuid.New()
+		_, err := client.WorkspaceBuildTimings(context.Background(), buildID)


Instead of using context.Background, use a context which has a timeout.

coderd/workspacebuilds_test.go

mtojek

I marked some Danny's comments as important. I think the rest can be pushed in the follow-up or next iteration 👍

mtojek · 2024-10-04T13:35:26Z

coderd/workspacebuilds_test.go

+
+		// When: fetching an inexistent build
+		buildID := uuid.New()
+		_, err := client.WorkspaceBuildTimings(context.Background(), buildID)


mtojek · 2024-10-04T13:36:54Z

coderd/database/dbmem/dbmem.go

+
+	build, err := q.GetWorkspaceBuildByID(ctx, id)
+	if err != nil {
+		return nil, err


mtojek · 2024-10-04T13:38:05Z

coderd/coderd.go

@@ -1150,7 +1150,6 @@ func New(options *Options) *API {
 					r.Post("/", api.postWorkspaceAgentPortShare)
 					r.Delete("/", api.deleteWorkspaceAgentPortShare)
 				})
-				r.Get("/timings", api.workspaceTimings)


@BrunoQuaresma In theory this is a breaking change... is there any frontend component using it?

BrunoQuaresma · 2024-10-04T13:41:03Z

In theory this is a breaking change... is there any frontend component using it?

@mtojek there is not

mtojek · 2024-10-04T13:46:15Z

In theory this is a breaking change... is there any frontend component using it?

then I think we can remove it

dannykopping · 2024-10-04T15:14:23Z

In theory this is a breaking change... is there any frontend component using it?

then I think we can remove it

We have to keep in mind that users can also use the API, so let's check if it made it into a release yet - and if so we have to keep it.

dannykopping

Great work @BrunoQuaresma!
I think we can land this

dannykopping · 2024-10-08T13:08:02Z

coderd/workspacebuilds_test.go

+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		t.Cleanup(cancel)


You can use testutil.Context to handle this in future, btw.

dannykopping · 2024-10-08T13:12:39Z

coderd/workspaces.go

@@ -1763,30 +1763,16 @@ func (api *API) workspaceTimings(rw http.ResponseWriter, r *http.Request) {
 		return
 	}

-	provisionerTimings, err := api.Database.GetProvisionerJobTimingsByJobID(ctx, build.JobID)
-	if err != nil && !errors.Is(err, sql.ErrNoRows) {
+	timings, err := api.buildTimings(ctx, build)


feat(coderd): return agent script timings

1b62a39

Add the agent script timings into the `/workspaces/:workspaceId/timings` response.

BrunoQuaresma requested review from dannykopping and DanielleMaywood October 1, 2024 19:04

BrunoQuaresma self-assigned this Oct 1, 2024

dannykopping reviewed Oct 1, 2024

View reviewed changes

BrunoQuaresma added 3 commits October 2, 2024 17:20

Apply initial suggestions and improvements

3daab59

Merge branch 'main' of https://github.com/coder/coder into bq/feat-ag…

1c6671e

…ent-timings

Move timings to build and improve tests

15ca638

BrunoQuaresma requested a review from dannykopping October 3, 2024 17:09

BrunoQuaresma added 10 commits October 3, 2024 18:33

Fix lint and gen

ddde7a3

Fix @router notation

5abc511

Improve tests intention

bcd8b04

Fix date-time format

f4c3331

Add dbauthz test

2852164

Fix dbauthz test

b70628a

Fix policy

9e09c64

Fix test again

7786166

Fix asserts

ed4cbd0

Fix order

920e41d

dannykopping approved these changes Oct 4, 2024

View reviewed changes

mtojek reviewed Oct 4, 2024

View reviewed changes

BrunoQuaresma added 3 commits October 4, 2024 15:18

Wrap errors and set timeout for tests

65aeeea

Add back the workspace timings endpoint

c7ae412

Fix unique build number

aaedd1c

BrunoQuaresma requested review from mtojek and dannykopping October 4, 2024 17:54

Wait long

a846eb7

dannykopping approved these changes Oct 8, 2024

View reviewed changes

BrunoQuaresma merged commit 9c8ecb8 into main Oct 14, 2024
30 checks passed

BrunoQuaresma deleted the bq/feat-agent-timings branch October 14, 2024 12:31

github-actions bot locked and limited conversation to collaborators Oct 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(coderd): return agent script timings #14923

feat(coderd): return agent script timings #14923

BrunoQuaresma commented Oct 1, 2024 •

edited

Loading

dannykopping left a comment

dannykopping Oct 1, 2024

BrunoQuaresma commented Oct 3, 2024

dannykopping left a comment

dannykopping Oct 4, 2024

mtojek Oct 4, 2024

dannykopping Oct 4, 2024

dannykopping Oct 4, 2024

mtojek Oct 4, 2024

BrunoQuaresma Oct 4, 2024

dannykopping Oct 4, 2024

dannykopping Oct 4, 2024

mtojek Oct 4, 2024

mtojek left a comment

mtojek Oct 4, 2024

mtojek Oct 4, 2024

mtojek Oct 4, 2024

BrunoQuaresma commented Oct 4, 2024

mtojek commented Oct 4, 2024

dannykopping commented Oct 4, 2024

dannykopping left a comment

dannykopping Oct 8, 2024

dannykopping Oct 8, 2024

	return nil, err
	return nil, xerrors.Errorf("failed to retrieve workspace build: %w", err)

		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
		t.Cleanup(cancel)

feat(coderd): return agent script timings #14923

feat(coderd): return agent script timings #14923

Conversation

BrunoQuaresma commented Oct 1, 2024 • edited Loading

dannykopping left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BrunoQuaresma commented Oct 3, 2024

dannykopping left a 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

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

mtojek left a 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

BrunoQuaresma commented Oct 4, 2024

mtojek commented Oct 4, 2024

dannykopping commented Oct 4, 2024

dannykopping left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BrunoQuaresma commented Oct 1, 2024 •

edited

Loading