Skip to content

feat(coderd): support weekly aggregated insights #9684

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 16 commits into from
Sep 19, 2023
Merged

feat(coderd): support weekly aggregated insights #9684

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
f9e2cbe
codersdk week
mtojek Sep 14, 2023
18b718c
make gen
mtojek Sep 14, 2023
871dd31
Merge branch 'main' into 9495-support-interval-week
mtojek Sep 15, 2023
45bb69c
fix parsing request
mtojek Sep 15, 2023
cee514d
test: BadRequest
mtojek Sep 15, 2023
16ec5ad
Delete stats after 6 months
mtojek Sep 15, 2023
01afb9b
golden files
mtojek Sep 15, 2023
60e8db3
At least 6 days
mtojek Sep 15, 2023
ff38fe4
internal tests
mtojek Sep 15, 2023
8e776ae
Merge branch 'main' into 9495-support-interval-week
mtojek Sep 18, 2023
873ddcd
Remove want
mtojek Sep 18, 2023
fa1ad62
Sydney location
mtojek Sep 18, 2023
ecd27f4
more activity
mtojek Sep 18, 2023
01a1ad8
fix six days
mtojek Sep 18, 2023
81a0399
Merge branch 'main' into 9495-support-interval-week
mtojek Sep 19, 2023
7e14a1f
test: dst vs. 6 days
mtojek Sep 19, 2023
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 parsing request
  • Loading branch information
@mtojek
mtojek committed Sep 15, 2023
commit 45bb69c465ce9112786a286ff1b567d131148f03
26 changes: 21 additions & 5 deletions coderd/insights.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ import (
// Duplicated in codersdk.
const insightsTimeLayout = time.RFC3339

// Day duration in nanoseconds
var dayNanoseconds = 24 * time.Hour.Nanoseconds()

// @Summary Get deployment DAUs
// @ID get-deployment-daus
// @Security CoderSessionToken
Expand Down Expand Up @@ -184,7 +187,7 @@ func (api *API) insightsTemplates(rw http.ResponseWriter, r *http.Request) {
if !ok {
return
}
interval, ok := verifyInsightsInterval(ctx, rw, intervalString)
interval, ok := parseInsightsInterval(ctx, rw, intervalString, startTime, endTime)
if !ok {
return
}
Expand All @@ -198,7 +201,7 @@ func (api *API) insightsTemplates(rw http.ResponseWriter, r *http.Request) {
eg.SetLimit(4)

// The following insights data queries have a theoretical chance to be
// inconsistent between eachother when looking at "today", however, the
// inconsistent between each other when looking at "today", however, the
// overhead from a transaction is not worth it.
eg.Go(func() error {
var err error
Expand All @@ -207,7 +210,7 @@ func (api *API) insightsTemplates(rw http.ResponseWriter, r *http.Request) {
StartTime: startTime,
EndTime: endTime,
TemplateIDs: templateIDs,
IntervalDays: 1,
IntervalDays: interval.Days(),
})
if err != nil {
return xerrors.Errorf("get template daily insights: %w", err)
Expand Down Expand Up @@ -531,9 +534,18 @@ func parseInsightsStartAndEndTime(ctx context.Context, rw http.ResponseWriter, s
return startTime, endTime, true
}

func verifyInsightsInterval(ctx context.Context, rw http.ResponseWriter, intervalString string) (codersdk.InsightsReportInterval, bool) {
func parseInsightsInterval(ctx context.Context, rw http.ResponseWriter, intervalString string, startTime, endTime time.Time) (codersdk.InsightsReportInterval, bool) {
switch v := codersdk.InsightsReportInterval(intervalString); v {
case codersdk.InsightsReportIntervalDay, codersdk.InsightsReportIntervalWeek, "":
case codersdk.InsightsReportIntervalDay, "":
return v, true
case codersdk.InsightsReportIntervalWeek:
if !isMultipleOfDay(startTime, endTime) {
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
Message: "Query parameter has invalid value.",
Detail: "Duration between start_time and end_time must multiple of 1 day.",
})
return "", false
}
return v, true
default:
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
Expand All @@ -548,3 +560,7 @@ func verifyInsightsInterval(ctx context.Context, rw http.ResponseWriter, interva
return "", false
}
}

func isMultipleOfDay(startTime, endTime time.Time) bool {
return endTime.Sub(startTime).Nanoseconds()%dayNanoseconds == 0
}
12 changes: 12 additions & 0 deletions codersdk/insights.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,18 @@ const insightsTimeLayout = time.RFC3339
// smaller insights report within a time range.
type InsightsReportInterval string

// Days returns the duration of the interval in days.
func (interval InsightsReportInterval) Days() int32 {
switch interval {
case InsightsReportIntervalDay:
return 1
case InsightsReportIntervalWeek:
return 7
default:
panic("developer error: unsupported report interval")
}
}

// InsightsReportInterval enums.
const (
InsightsReportIntervalDay InsightsReportInterval = "day"
Expand Down