Skip to content

feat(coderd/database): track user status changes over time #16019

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.

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 32 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
cd953a3
add user_status_changes table
SasSwart Dec 14, 2024
ec16728
add GetUserStatusCountsByDay
SasSwart Dec 14, 2024
0d97e82
rename unused variable
SasSwart Dec 14, 2024
eb6e249
Test GetUserStatusCountsByDay
SasSwart Dec 17, 2024
7b2c259
make gen
SasSwart Dec 17, 2024
89177b2
fix dbauthz tests
SasSwart Dec 17, 2024
877517f
do the plumbing to get sql, api and frontend talking to one another
SasSwart Dec 23, 2024
0b3e0e6
rename migration
SasSwart Dec 23, 2024
6462cc2
move aggregation logic for GetUserStatusChanges into the SQL
SasSwart Dec 24, 2024
ccd0cdf
use window functions for efficiency
SasSwart Dec 24, 2024
12a274f
ensure we use the same time zone as the start_time param
SasSwart Dec 24, 2024
fcfd76e
ensure we use the same time zone as the start_time param
SasSwart Dec 24, 2024
7c0cade
make gen
SasSwart Dec 24, 2024
ecffc8b
update field names and fix tests
SasSwart Dec 24, 2024
f3a2ce3
exclude deleted users from the user status graph
SasSwart Dec 27, 2024
5067a63
GetUserStatusChanges now passes all querier tests
SasSwart Jan 2, 2025
254d436
renumber migrations
SasSwart Jan 2, 2025
3e86522
add partial fixture for CI
SasSwart Jan 3, 2025
2e49e4c
fix migration numbers
SasSwart Jan 3, 2025
ff59729
rename and document sql function
SasSwart Jan 3, 2025
b1ad074
make gen
SasSwart Jan 3, 2025
de4081f
Remove unwanted comments from the generated interface
SasSwart Jan 9, 2025
4de334f
review notes
SasSwart Jan 9, 2025
8fca0c5
make gen
SasSwart Jan 9, 2025
b06179c
remove frontend changes
SasSwart Jan 9, 2025
213b288
rename GetUserStatusCountsOverTime to GetUserStatusCounts
SasSwart Jan 9, 2025
9457ac8
fix tests
SasSwart Jan 9, 2025
63128a3
Update coderd/database/queries/insights.sql
SasSwart Jan 10, 2025
89f0a11
Provide basic durability against multiple deletions
SasSwart Jan 13, 2025
89ebab2
Provide basic durability against multiple deletions
SasSwart Jan 13, 2025
012f14c
populate the user_deleted_table
SasSwart Jan 13, 2025
c2efd97
formatting
SasSwart Jan 13, 2025
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
rename GetUserStatusCountsOverTime to GetUserStatusCounts
  • Loading branch information
SasSwart committed Jan 9, 2025
commit 213b288d0e9c41202e7342e2ecc9e30453caa07a
8 changes: 4 additions & 4 deletions coderd/apidoc/docs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions coderd/apidoc/swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion coderd/coderd.go
Original file line number Diff line number Diff line change
Expand Up @@ -1281,7 +1281,7 @@ func New(options *Options) *API {
r.Use(apiKeyMiddleware)
r.Get("/daus", api.deploymentDAUs)
r.Get("/user-activity", api.insightsUserActivity)
r.Get("/user-status-counts-over-time", api.insightsUserStatusCountsOverTime)
r.Get("/user-status-counts", api.insightsUserStatusCounts)
r.Get("/user-latency", api.insightsUserLatency)
r.Get("/templates", api.insightsTemplates)
})
Expand Down
4 changes: 2 additions & 2 deletions coderd/database/dbauthz/dbauthz.go
Original file line number Diff line number Diff line change
Expand Up @@ -2421,11 +2421,11 @@ func (q *querier) GetUserNotificationPreferences(ctx context.Context, userID uui
return q.db.GetUserNotificationPreferences(ctx, userID)
}

func (q *querier) GetUserStatusCountsOverTime(ctx context.Context, arg database.GetUserStatusCountsOverTimeParams) ([]database.GetUserStatusCountsOverTimeRow, error) {
func (q *querier) GetUserStatusCounts(ctx context.Context, arg database.GetUserStatusCountsParams) ([]database.GetUserStatusCountsRow, error) {
if err := q.authorizeContext(ctx, policy.ActionRead, rbac.ResourceUser); err != nil {
return nil, err
}
return q.db.GetUserStatusCountsOverTime(ctx, arg)
return q.db.GetUserStatusCounts(ctx, arg)
}

func (q *querier) GetUserWorkspaceBuildParameters(ctx context.Context, params database.GetUserWorkspaceBuildParametersParams) ([]database.GetUserWorkspaceBuildParametersRow, error) {
Expand Down
4 changes: 2 additions & 2 deletions coderd/database/dbauthz/dbauthz_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1708,8 +1708,8 @@ func (s *MethodTestSuite) TestUser() {
rbac.ResourceTemplate.InOrg(orgID), policy.ActionRead,
)
}))
s.Run("GetUserStatusCountsOverTime", s.Subtest(func(db database.Store, check *expects) {
check.Args(database.GetUserStatusCountsOverTimeParams{
s.Run("GetUserStatusCounts", s.Subtest(func(db database.Store, check *expects) {
check.Args(database.GetUserStatusCountsParams{
StartTime: time.Now().Add(-time.Hour * 24 * 30),
EndTime: time.Now(),
}).Asserts(rbac.ResourceUser, policy.ActionRead)
Expand Down
8 changes: 4 additions & 4 deletions coderd/database/dbmem/dbmem.go
Original file line number Diff line number Diff line change
Expand Up @@ -5671,7 +5671,7 @@ func (q *FakeQuerier) GetUserNotificationPreferences(_ context.Context, userID u
return out, nil
}

func (q *FakeQuerier) GetUserStatusCountsOverTime(_ context.Context, arg database.GetUserStatusCountsOverTimeParams) ([]database.GetUserStatusCountsOverTimeRow, error) {
func (q *FakeQuerier) GetUserStatusCounts(_ context.Context, arg database.GetUserStatusCountsParams) ([]database.GetUserStatusCountsRow, error) {
q.mutex.RLock()
defer q.mutex.RUnlock()

Expand All @@ -5680,16 +5680,16 @@ func (q *FakeQuerier) GetUserStatusCountsOverTime(_ context.Context, arg databas
return nil, err
}

result := make([]database.GetUserStatusCountsOverTimeRow, 0)
result := make([]database.GetUserStatusCountsRow, 0)
for _, change := range q.userStatusChanges {
if change.ChangedAt.Before(arg.StartTime) || change.ChangedAt.After(arg.EndTime) {
continue
}
date := time.Date(change.ChangedAt.Year(), change.ChangedAt.Month(), change.ChangedAt.Day(), 0, 0, 0, 0, time.UTC)
if !slices.ContainsFunc(result, func(r database.GetUserStatusCountsOverTimeRow) bool {
if !slices.ContainsFunc(result, func(r database.GetUserStatusCountsRow) bool {
return r.Status == change.NewStatus && r.Date.Equal(date)
}) {
result = append(result, database.GetUserStatusCountsOverTimeRow{
result = append(result, database.GetUserStatusCountsRow{
Status: change.NewStatus,
Date: date,
Count: 1,
Expand Down
6 changes: 3 additions & 3 deletions coderd/database/dbmetrics/querymetrics.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions coderd/database/dbmock/dbmock.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions coderd/database/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions coderd/database/querier_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2256,7 +2256,7 @@ func TestGroupRemovalTrigger(t *testing.T) {
}, db2sdk.List(extraUserGroups, onlyGroupIDs))
}

func TestGetUserStatusCountsOverTime(t *testing.T) {
func TestGetUserStatusCounts(t *testing.T) {
t.Parallel()

if !dbtestutil.WillUsePostgres() {
Expand Down Expand Up @@ -2294,7 +2294,7 @@ func TestGetUserStatusCountsOverTime(t *testing.T) {
end := dbtime.Now()
start := end.Add(-30 * 24 * time.Hour)

counts, err := db.GetUserStatusCountsOverTime(ctx, database.GetUserStatusCountsOverTimeParams{
counts, err := db.GetUserStatusCounts(ctx, database.GetUserStatusCountsParams{
StartTime: start,
EndTime: end,
})
Expand Down Expand Up @@ -2338,7 +2338,7 @@ func TestGetUserStatusCountsOverTime(t *testing.T) {
})

// Query for the last 30 days
userStatusChanges, err := db.GetUserStatusCountsOverTime(ctx, database.GetUserStatusCountsOverTimeParams{
userStatusChanges, err := db.GetUserStatusCounts(ctx, database.GetUserStatusCountsParams{
StartTime: createdAt,
EndTime: today,
})
Expand Down Expand Up @@ -2506,7 +2506,7 @@ func TestGetUserStatusCountsOverTime(t *testing.T) {
require.NoError(t, err)

// Query for the last 5 days
userStatusChanges, err := db.GetUserStatusCountsOverTime(ctx, database.GetUserStatusCountsOverTimeParams{
userStatusChanges, err := db.GetUserStatusCounts(ctx, database.GetUserStatusCountsParams{
StartTime: createdAt,
EndTime: today,
})
Expand Down Expand Up @@ -2635,7 +2635,7 @@ func TestGetUserStatusCountsOverTime(t *testing.T) {
})
require.NoError(t, err)

userStatusChanges, err := db.GetUserStatusCountsOverTime(ctx, database.GetUserStatusCountsOverTimeParams{
userStatusChanges, err := db.GetUserStatusCounts(ctx, database.GetUserStatusCountsParams{
StartTime: createdAt,
EndTime: today,
})
Expand Down Expand Up @@ -2711,7 +2711,7 @@ func TestGetUserStatusCountsOverTime(t *testing.T) {
UpdatedAt: createdAt,
})

userStatusChanges, err := db.GetUserStatusCountsOverTime(ctx, database.GetUserStatusCountsOverTimeParams{
userStatusChanges, err := db.GetUserStatusCounts(ctx, database.GetUserStatusCountsParams{
StartTime: createdAt.Add(time.Hour * 24),
EndTime: today,
})
Expand All @@ -2738,7 +2738,7 @@ func TestGetUserStatusCountsOverTime(t *testing.T) {
err = db.UpdateUserDeletedByID(ctx, user.ID)
require.NoError(t, err)

userStatusChanges, err := db.GetUserStatusCountsOverTime(ctx, database.GetUserStatusCountsOverTimeParams{
userStatusChanges, err := db.GetUserStatusCounts(ctx, database.GetUserStatusCountsParams{
StartTime: today.Add(time.Hour * 24),
EndTime: today.Add(time.Hour * 48),
})
Expand All @@ -2760,7 +2760,7 @@ func TestGetUserStatusCountsOverTime(t *testing.T) {
err := db.UpdateUserDeletedByID(ctx, user.ID)
require.NoError(t, err)

userStatusChanges, err := db.GetUserStatusCountsOverTime(ctx, database.GetUserStatusCountsOverTimeParams{
userStatusChanges, err := db.GetUserStatusCounts(ctx, database.GetUserStatusCountsParams{
StartTime: createdAt,
EndTime: today.Add(time.Hour * 24),
})
Expand Down
16 changes: 8 additions & 8 deletions coderd/database/queries.sql.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions coderd/database/queries/insights.sql
Original file line number Diff line number Diff line change
Expand Up @@ -772,8 +772,8 @@ FROM unique_template_params utp
JOIN workspace_build_parameters wbp ON (utp.workspace_build_ids @> ARRAY[wbp.workspace_build_id] AND utp.name = wbp.name)
GROUP BY utp.num, utp.template_ids, utp.name, utp.type, utp.display_name, utp.description, utp.options, wbp.value;

-- name: GetUserStatusCountsOverTime :many
-- GetUserStatusCountsOverTime returns the count of users in each status over time.
-- name: GetUserStatusCounts :many
-- GetUserStatusCounts returns the count of users in each status over time.
-- The time range is inclusively defined by the start_time and end_time parameters.
--
-- Bucketing:
Expand Down
12 changes: 6 additions & 6 deletions coderd/insights.go
Original file line number Diff line number Diff line change
Expand Up @@ -293,14 +293,14 @@ func (api *API) insightsUserLatency(rw http.ResponseWriter, r *http.Request) {
}

// @Summary Get insights about user status counts over time
// @ID get-insights-about-user-status-counts-over-time
// @ID get-insights-about-user-status-counts
// @Security CoderSessionToken
// @Produce json
// @Tags Insights
// @Param tz_offset query int true "Time-zone offset (e.g. -2)"
// @Success 200 {object} codersdk.GetUserStatusCountsOverTimeResponse
// @Router /insights/user-status-counts-over-time [get]
func (api *API) insightsUserStatusCountsOverTime(rw http.ResponseWriter, r *http.Request) {
// @Success 200 {object} codersdk.GetUserStatusCountsResponse
// @Router /insights/user-status-counts [get]
func (api *API) insightsUserStatusCounts(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()

p := httpapi.NewQueryParamParser()
Expand All @@ -324,7 +324,7 @@ func (api *API) insightsUserStatusCountsOverTime(rw http.ResponseWriter, r *http
// Always return 60 days of data (2 months).
sixtyDaysAgo := nextHourInLoc.In(loc).Truncate(24*time.Hour).AddDate(0, 0, -60)

rows, err := api.Database.GetUserStatusCountsOverTime(ctx, database.GetUserStatusCountsOverTimeParams{
rows, err := api.Database.GetUserStatusCounts(ctx, database.GetUserStatusCountsParams{
StartTime: sixtyDaysAgo,
EndTime: nextHourInLoc,
})
Expand All @@ -340,7 +340,7 @@ func (api *API) insightsUserStatusCountsOverTime(rw http.ResponseWriter, r *http
return
}

resp := codersdk.GetUserStatusCountsOverTimeResponse{
resp := codersdk.GetUserStatusCountsResponse{
StatusCounts: make(map[codersdk.UserStatus][]codersdk.UserStatusChangeCount),
}

Expand Down
Loading
Loading