opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: use active users instead of total users in Template views (#3900)

Browse Source
This commit is contained in:
Ammar Bandukwala
2022-09-09 19:30:31 +00:00
committed by GitHub
parent 346583f13e
commit f6aa025a01
20 changed files with 251 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files
coderd/metricscache/metricscache.go
+85 -35
View File
@@ -5,6 +5,8 @@ import (
"sync/atomic"
"time"
"golang.org/x/exp/maps"
"golang.org/x/exp/slices"
"golang.org/x/xerrors"
"github.com/google/uuid"
@@ -24,9 +26,10 @@ type Cache struct {
database database.Store
log slog.Logger
templateDAUResponses atomic.Pointer[map[string]codersdk.TemplateDAUsResponse]
templateDAUResponses atomic.Pointer[map[uuid.UUID]codersdk.TemplateDAUsResponse]
templateUniqueUsers atomic.Pointer[map[uuid.UUID]int]
doneCh chan struct{}
done chan struct{}
cancel func()
interval time.Duration
@@ -41,7 +44,7 @@ func New(db database.Store, log slog.Logger, interval time.Duration) *Cache {
c := &Cache{
database: db,
log: log,
doneCh: make(chan struct{}),
done: make(chan struct{}),
cancel: cancel,
interval: interval,
}
@@ -49,34 +52,68 @@ func New(db database.Store, log slog.Logger, interval time.Duration) *Cache {
return c
}
func fillEmptyDays(rows []database.GetTemplateDAUsRow) []database.GetTemplateDAUsRow {
var newRows []database.GetTemplateDAUsRow
func fillEmptyDays(sortedDates []time.Time) []time.Time {
var newDates []time.Time
for i, row := range rows {
for i, ti := range sortedDates {
if i == 0 {
newRows = append(newRows, row)
newDates = append(newDates, ti)
continue
}
last := rows[i-1]
last := sortedDates[i-1]
const day = time.Hour * 24
diff := row.Date.Sub(last.Date)
diff := ti.Sub(last)
for diff > day {
if diff <= day {
break
}
last.Date = last.Date.Add(day)
last.Amount = 0
newRows = append(newRows, last)
last = last.Add(day)
newDates = append(newDates, last)
diff -= day
}
newRows = append(newRows, row)
newDates = append(newDates, ti)
continue
}
return newRows
return newDates
}
func convertDAUResponse(rows []database.GetTemplateDAUsRow) codersdk.TemplateDAUsResponse {
respMap := make(map[time.Time][]uuid.UUID)
for _, row := range rows {
uuids := respMap[row.Date]
if uuids == nil {
uuids = make([]uuid.UUID, 0, 8)
}
uuids = append(uuids, row.UserID)
respMap[row.Date] = uuids
}
dates := maps.Keys(respMap)
slices.SortFunc(dates, func(a, b time.Time) bool {
return a.Before(b)
})
var resp codersdk.TemplateDAUsResponse
for _, date := range fillEmptyDays(dates) {
resp.Entries = append(resp.Entries, codersdk.DAUEntry{
Date: date,
Amount: len(respMap[date]),
})
}
return resp
}
func countUniqueUsers(rows []database.GetTemplateDAUsRow) int {
seen := make(map[uuid.UUID]struct{}, len(rows))
for _, row := range rows {
seen[row.UserID] = struct{}{}
}
return len(seen)
}
func (c *Cache) refresh(ctx context.Context) error {
@@ -90,30 +127,26 @@ func (c *Cache) refresh(ctx context.Context) error {
return err
}
templateDAUs := make(map[string]codersdk.TemplateDAUsResponse, len(templates))
var (
templateDAUs = make(map[uuid.UUID]codersdk.TemplateDAUsResponse, len(templates))
templateUniqueUsers = make(map[uuid.UUID]int)
)
for _, template := range templates {
daus, err := c.database.GetTemplateDAUs(ctx, template.ID)
rows, err := c.database.GetTemplateDAUs(ctx, template.ID)
if err != nil {
return err
}
var resp codersdk.TemplateDAUsResponse
for _, ent := range fillEmptyDays(daus) {
resp.Entries = append(resp.Entries, codersdk.DAUEntry{
Date: ent.Date,
Amount: int(ent.Amount),
})
}
templateDAUs[template.ID.String()] = resp
templateDAUs[template.ID] = convertDAUResponse(rows)
templateUniqueUsers[template.ID] = countUniqueUsers(rows)
}
c.templateDAUResponses.Store(&templateDAUs)
c.templateUniqueUsers.Store(&templateUniqueUsers)
return nil
}
func (c *Cache) run(ctx context.Context) {
defer close(c.doneCh)
defer close(c.done)
ticker := time.NewTicker(c.interval)
defer ticker.Stop()
@@ -140,7 +173,7 @@ func (c *Cache) run(ctx context.Context) {
select {
case <-ticker.C:
case <-c.doneCh:
case <-c.done:
return
case <-ctx.Done():
return
@@ -150,23 +183,40 @@ func (c *Cache) run(ctx context.Context) {
func (c *Cache) Close() error {
c.cancel()
<-c.doneCh
<-c.done
return nil
}
// TemplateDAUs returns an empty response if the template doesn't have users
// or is loading for the first time.
func (c *Cache) TemplateDAUs(id uuid.UUID) codersdk.TemplateDAUsResponse {
func (c *Cache) TemplateDAUs(id uuid.UUID) (*codersdk.TemplateDAUsResponse, bool) {
m := c.templateDAUResponses.Load()
if m == nil {
// Data loading.
return codersdk.TemplateDAUsResponse{}
return nil, false
}
resp, ok := (*m)[id.String()]
resp, ok := (*m)[id]
if !ok {
// Probably no data.
return codersdk.TemplateDAUsResponse{}
return nil, false
}
return resp
return &resp, true
}
// TemplateUniqueUsers returns the number of unique Template users
// from all Cache data.
func (c *Cache) TemplateUniqueUsers(id uuid.UUID) (int, bool) {
m := c.templateUniqueUsers.Load()
if m == nil {
// Data loading.
return -1, false
}
resp, ok := (*m)[id]
if !ok {
// Probably no data.
return -1, false
}
return resp, true
}
coderd/metricscache/metricscache_test.go
+32 -18
View File
@@ -2,7 +2,6 @@ package metricscache_test
import (
"context"
"reflect"
"testing"
"time"
@@ -25,19 +24,23 @@ func TestCache(t *testing.T) {
t.Parallel()
var (
zebra = uuid.New()
tiger = uuid.New()
zebra = uuid.UUID{1}
tiger = uuid.UUID{2}
)
type args struct {
rows []database.InsertAgentStatParams
}
type want struct {
entries []codersdk.DAUEntry
uniqueUsers int
}
tests := []struct {
name string
args args
want []codersdk.DAUEntry
want want
}{
{"empty", args{}, nil},
{"empty", args{}, want{nil, 0}},
{"one hole", args{
rows: []database.InsertAgentStatParams{
{
@@ -49,7 +52,7 @@ func TestCache(t *testing.T) {
UserID: zebra,
},
},
}, []codersdk.DAUEntry{
}, want{[]codersdk.DAUEntry{
{
Date: date(2022, 8, 27),
Amount: 1,
@@ -66,7 +69,8 @@ func TestCache(t *testing.T) {
Date: date(2022, 8, 30),
Amount: 1,
},
}},
}, 1},
},
{"no holes", args{
rows: []database.InsertAgentStatParams{
{
@@ -82,7 +86,7 @@ func TestCache(t *testing.T) {
UserID: zebra,
},
},
}, []codersdk.DAUEntry{
}, want{[]codersdk.DAUEntry{
{
Date: date(2022, 8, 27),
Amount: 1,
@@ -95,7 +99,7 @@ func TestCache(t *testing.T) {
Date: date(2022, 8, 29),
Amount: 1,
},
}},
}, 1}},
{"holes", args{
rows: []database.InsertAgentStatParams{
{
@@ -119,7 +123,7 @@ func TestCache(t *testing.T) {
UserID: tiger,
},
},
}, []codersdk.DAUEntry{
}, want{[]codersdk.DAUEntry{
{
Date: date(2022, 1, 1),
Amount: 2,
@@ -148,7 +152,7 @@ func TestCache(t *testing.T) {
Date: date(2022, 1, 7),
Amount: 2,
},
}},
}, 2}},
}
for _, tt := range tests {
@@ -157,7 +161,7 @@ func TestCache(t *testing.T) {
t.Parallel()
var (
db = databasefake.New()
cache = metricscache.New(db, slogtest.Make(t, nil), time.Millisecond*100)
cache = metricscache.New(db, slogtest.Make(t, nil), testutil.IntervalFast)
)
defer cache.Close()
@@ -167,19 +171,29 @@ func TestCache(t *testing.T) {
ID: templateID,
})
gotUniqueUsers, ok := cache.TemplateUniqueUsers(templateID)
require.False(t, ok, "template shouldn't have loaded yet")
require.EqualValues(t, -1, gotUniqueUsers)
for _, row := range tt.args.rows {
row.TemplateID = templateID
db.InsertAgentStat(context.Background(), row)
}
var got codersdk.TemplateDAUsResponse
require.Eventuallyf(t, func() bool {
got = cache.TemplateDAUs(templateID)
return reflect.DeepEqual(got.Entries, tt.want)
}, testutil.WaitShort, testutil.IntervalFast,
"GetDAUs() = %v, want %v", got, tt.want,
_, ok := cache.TemplateDAUs(templateID)
return ok
}, testutil.WaitShort, testutil.IntervalMedium,
"TemplateDAUs never populated",
)
gotUniqueUsers, ok = cache.TemplateUniqueUsers(templateID)
require.True(t, ok)
gotEntries, ok := cache.TemplateDAUs(templateID)
require.True(t, ok)
require.Equal(t, tt.want.entries, gotEntries.Entries)
require.Equal(t, tt.want.uniqueUsers, gotUniqueUsers)
})
}
}