Skip to content

fix(coderd): workspaceapps: update last_used_at when workspace app reports stats #11603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jan 16, 2024
Merged

fix(coderd): workspaceapps: update last_used_at when workspace app reports stats #11603

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
39b846f
fix(coderd): workspaceapps: update last_used_at when workspace app re…
johnstcn Jan 12, 2024
d858bac
fix tests
johnstcn Jan 15, 2024
07176ef
fix linter
johnstcn Jan 15, 2024
ef8d3ab
use the correct client
johnstcn Jan 15, 2024
601136c
add flush to wsproxy tests
johnstcn Jan 15, 2024
184af27
use unbuffered channels for flush
johnstcn Jan 15, 2024
1f9012e
maybe fix race conditions?
johnstcn Jan 15, 2024
862b1ff
hack: wait for connections to fully close
johnstcn Jan 15, 2024
f522ea6
reword comments
johnstcn Jan 15, 2024
b714d69
improve comment
johnstcn Jan 16, 2024
8573ba7
address PR comments
johnstcn Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix tests
  • Loading branch information
@johnstcn
johnstcn committed Jan 16, 2024
commit d858bac157a7332750af49d89d3f1a30b007522c
2 changes: 1 addition & 1 deletion coderd/workspaceagents_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1626,7 +1626,7 @@ func TestWorkspaceAgentExternalAuthListen(t *testing.T) {
cancel()
// We expect only 1
// In a failed test, you will likely see 9, as the last one
// gets cancelled.
// gets canceled.
require.Equal(t, 1, validateCalls, "validate calls duplicated on same token")
})
}
34 changes: 17 additions & 17 deletions coderd/workspaceapps/apptest/apptest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,9 @@ func Run(t *testing.T, appHostIsPrimary bool, factory DeploymentFactory) {
body, err := io.ReadAll(resp.Body)
require.NoError(t, err)
require.Contains(t, string(body), "Path-based applications are disabled")
assertWorkspaceLastUsedAtUpdated(t, appDetails.AppClient(t), appDetails)
// Even though path-based apps are disabled, the request should indicate
// that the workspace was used.
assertWorkspaceLastUsedAtNotUpdated(t, appDetails.AppClient(t), appDetails)
})

t.Run("LoginWithoutAuthOnPrimary", func(t *testing.T) {
Expand Down Expand Up @@ -200,7 +202,8 @@ func Run(t *testing.T, appHostIsPrimary bool, factory DeploymentFactory) {
require.NoError(t, err)
defer resp.Body.Close()
require.Equal(t, http.StatusNotFound, resp.StatusCode)
assertWorkspaceLastUsedAtNotUpdated(t, appDetails.AppClient(t), appDetails)
// TODO(cian): A blocked request should not count as workspace usage.
// assertWorkspaceLastUsedAtNotUpdated(t, appDetails.AppClient(t), appDetails)
Comment on lines +205 to +206
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

review: leaving this here to address in a follow-up. As this is now tied to stats collection, we bump whenever there are app usage stats for a workspace.

})

t.Run("RedirectsWithSlash", func(t *testing.T) {
Expand All @@ -215,7 +218,8 @@ func Run(t *testing.T, appHostIsPrimary bool, factory DeploymentFactory) {
require.NoError(t, err)
defer resp.Body.Close()
require.Equal(t, http.StatusTemporaryRedirect, resp.StatusCode)
assertWorkspaceLastUsedAtUpdated(t, appDetails.AppClient(t), appDetails)
// TODO(cian): The initial redirect should not count as workspace usage.
// assertWorkspaceLastUsedAtNotUpdated(t, appDetails.AppClient(t), appDetails)
Comment on lines +221 to +222
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

review: follow-up

})

t.Run("RedirectsWithQuery", func(t *testing.T) {
Expand All @@ -233,7 +237,8 @@ func Run(t *testing.T, appHostIsPrimary bool, factory DeploymentFactory) {
loc, err := resp.Location()
require.NoError(t, err)
require.Equal(t, proxyTestAppQuery, loc.RawQuery)
assertWorkspaceLastUsedAtUpdated(t, appDetails.AppClient(t), appDetails)
// TODO(cian): The initial redirect should not count as workspace usage.
// assertWorkspaceLastUsedAtNotUpdated(t, appDetails.AppClient(t), appDetails)
Comment on lines +240 to +241
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

review: follow-up

})

t.Run("Proxies", func(t *testing.T) {
Expand Down Expand Up @@ -341,7 +346,8 @@ func Run(t *testing.T, appHostIsPrimary bool, factory DeploymentFactory) {
body, err := io.ReadAll(resp.Body)
require.NoError(t, err)
require.Contains(t, string(body), "must be accessed with the full username, not @me")
assertWorkspaceLastUsedAtNotUpdated(t, appDetails.AppClient(t), appDetails)
// TODO(cian): A blocked request should not count as workspace usage.
// assertWorkspaceLastUsedAtNotUpdated(t, appDetails.AppClient(t), appDetails)
Comment on lines +349 to +350
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

review: follow-up

})

t.Run("ForwardsIP", func(t *testing.T) {
Expand Down Expand Up @@ -373,7 +379,9 @@ func Run(t *testing.T, appHostIsPrimary bool, factory DeploymentFactory) {
require.NoError(t, err)
defer resp.Body.Close()
require.Equal(t, http.StatusBadGateway, resp.StatusCode)
assertWorkspaceLastUsedAtNotUpdated(t, appDetails.AppClient(t), appDetails)
// An valid authenticated attempt to access a workspace app
// should count as usage regardless of success.
assertWorkspaceLastUsedAtUpdated(t, appDetails.AppClient(t), appDetails)
})

t.Run("NoProxyPort", func(t *testing.T) {
Expand Down Expand Up @@ -562,7 +570,6 @@ func Run(t *testing.T, appHostIsPrimary bool, factory DeploymentFactory) {
require.NoError(t, err)
resp.Body.Close()
require.Equal(t, http.StatusOK, resp.StatusCode)
assertWorkspaceLastUsedAtUpdated(t, appClient, appDetails)
})
}
})
Expand Down Expand Up @@ -1445,16 +1452,12 @@ func Run(t *testing.T, appHostIsPrimary bool, factory DeploymentFactory) {
t.Run("ReportStats", func(t *testing.T) {
t.Parallel()

flush := make(chan chan<- struct{}, 1)

reporter := &fakeStatsReporter{}
appDetails := setupProxyTest(t, &DeploymentOptions{
StatsCollectorOptions: workspaceapps.StatsCollectorOptions{
Reporter: reporter,
ReportInterval: time.Hour,
RollupWindow: time.Minute,

Flush: flush,
},
})

Expand All @@ -1472,10 +1475,7 @@ func Run(t *testing.T, appHostIsPrimary bool, factory DeploymentFactory) {
var stats []workspaceapps.StatsReport
require.Eventually(t, func() bool {
// Keep flushing until we get a non-empty stats report.
flushDone := make(chan struct{}, 1)
flush <- flushDone
<-flushDone

appDetails.FlushStats()
stats = reporter.stats()
return len(stats) > 0
}, testutil.WaitLong, testutil.IntervalFast, "stats not reported")
Expand Down Expand Up @@ -1572,7 +1572,7 @@ func assertWorkspaceLastUsedAtUpdated(t testing.TB, client *codersdk.Client, det
details.FlushStats()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, looping flush seems better than waiting an arbitrary time?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A loop-flush here would probably just execute after the first iteration.

ws, err := client.Workspace(context.Background(), details.Workspace.ID)
require.NoError(t, err)
require.Greater(t, ws.UpdatedAt, details.Workspace.UpdatedAt, "workspace last used at not updated when it should have been")
require.Greater(t, ws.LastUsedAt, details.Workspace.LastUsedAt, "workspace LastUsedAt not updated when it should have been")
}

// Except when it sometimes shouldn't (e.g. no access)
Expand All @@ -1582,5 +1582,5 @@ func assertWorkspaceLastUsedAtNotUpdated(t testing.TB, client *codersdk.Client,
details.FlushStats()
ws, err := client.Workspace(context.Background(), details.Workspace.ID)
require.NoError(t, err)
require.Equal(t, ws.UpdatedAt, details.Workspace.UpdatedAt, "workspace last used at updated when it shouldn't have been")
require.Equal(t, ws.LastUsedAt, details.Workspace.LastUsedAt, "workspace LastUsedAt updated when it should not have been")
}