-
Notifications
You must be signed in to change notification settings - Fork 27
/
count_collector.go
419 lines (371 loc) · 10.4 KB
/
count_collector.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
package analytic
import (
"encoding/json"
"fmt"
"log"
"time"
"github.com/authgear/authgear-server/pkg/api/event"
"github.com/authgear/authgear-server/pkg/api/event/nonblocking"
"github.com/authgear/authgear-server/pkg/api/model"
"github.com/authgear/authgear-server/pkg/lib/audit"
"github.com/authgear/authgear-server/pkg/lib/authn/identity"
"github.com/authgear/authgear-server/pkg/lib/config"
"github.com/authgear/authgear-server/pkg/lib/infra/db"
"github.com/authgear/authgear-server/pkg/lib/infra/db/appdb"
"github.com/authgear/authgear-server/pkg/lib/infra/db/auditdb"
"github.com/authgear/authgear-server/pkg/lib/infra/db/globaldb"
"github.com/authgear/authgear-server/pkg/util/duration"
"github.com/authgear/authgear-server/pkg/util/graphqlutil"
"github.com/authgear/authgear-server/pkg/util/timeutil"
)
type MeterAuditDBReadStore interface {
GetCountByActivityType(appID string, activityType string, rangeFrom *time.Time, rangeTo *time.Time) (int, error)
QueryPage(appID string, opts audit.QueryPageOptions, pageArgs graphqlutil.PageArgs) ([]*audit.Log, uint64, error)
}
type SignupCountResult struct {
TotalCount int
CountByLoginID map[string]int
CountByOAuthProvider map[string]int
AnonymousCount int
}
type CountCollector struct {
GlobalHandle *globaldb.Handle
GlobalDBStore *GlobalDBStore
AppDBHandle *appdb.Handle
AppDBStore *AppDBStore
AuditDBReadHandle *auditdb.ReadHandle
AuditDBReadStore *AuditDBReadStore
AuditDBWriteHandle *auditdb.WriteHandle
MeterAuditDBStore MeterAuditDBReadStore
AuditDBWriteStore *AuditDBWriteStore
AnalyticService *Service
}
func (c *CountCollector) CollectDaily(date *time.Time) (updatedCount int, err error) {
utc := date.UTC()
rangeFrom := timeutil.TruncateToDate(utc)
rangeTo := rangeFrom.AddDate(0, 0, 1)
appIDs, err := c.getAppIDs()
if err != nil {
return
}
var counts []*Count
var redisKeys []string
for _, appID := range appIDs {
appCounts, keys, e := c.CollectDailyCountForApp(appID, rangeFrom, rangeTo)
if e != nil {
err = e
return
}
counts = append(counts, appCounts...)
redisKeys = append(redisKeys, keys...)
}
updatedCount, err = c.saveCounts(counts)
if err != nil {
return
}
err = c.setRedisKeyExpiry(redisKeys)
return
}
func (c *CountCollector) CollectWeekly(date *time.Time) (updatedCount int, err error) {
appIDs, err := c.getAppIDs()
if err != nil {
return
}
var counts []*Count
var redisKeys []string
for _, appID := range appIDs {
appCounts, keys, e := c.CollectWeeklyForApp(appID, date)
if e != nil {
err = e
return
}
counts = append(counts, appCounts...)
redisKeys = append(redisKeys, keys...)
}
updatedCount, err = c.saveCounts(counts)
if err != nil {
return
}
err = c.setRedisKeyExpiry(redisKeys)
return
}
func (c *CountCollector) CollectMonthly(date *time.Time) (updatedCount int, err error) {
appIDs, err := c.getAppIDs()
if err != nil {
return
}
var counts []*Count
var redisKeys []string
for _, appID := range appIDs {
appCounts, keys, e := c.CollectMonthlyForApp(appID, date)
if e != nil {
err = e
return
}
counts = append(counts, appCounts...)
redisKeys = append(redisKeys, keys...)
}
updatedCount, err = c.saveCounts(counts)
if err != nil {
return
}
err = c.setRedisKeyExpiry(redisKeys)
return
}
func (c *CountCollector) CollectDailyCountForApp(appID string, date time.Time, nextDay time.Time) (counts []*Count, redisKey []string, err error) {
// Cumulative number of user count
err = c.AppDBHandle.WithTx(func() error {
userCount, err := c.AppDBStore.GetUserCountBeforeTime(appID, &nextDay)
if err != nil {
return err
}
if userCount == 0 {
// no user in the app, skip the cumulative number of user count
return nil
}
counts = append(counts, NewCount(
appID,
userCount,
date,
CumulativeUserCountType,
))
return nil
})
if err != nil {
err = fmt.Errorf("failed to calculate cumulative number of user: %w", err)
return
}
// Signup count
err = c.AuditDBReadHandle.ReadOnly(func() error {
signupCountResult, err := c.querySignupCount(appID, &date, &nextDay)
if err != nil {
err = fmt.Errorf("failed to calculate signup count: %w", err)
return err
}
if signupCountResult.TotalCount == 0 {
// no new signup for the app, skip the signup count
return nil
}
counts = append(counts, NewCount(
appID,
signupCountResult.TotalCount,
date,
DailySignupCountType,
))
for loginIDType, count := range signupCountResult.CountByLoginID {
counts = append(counts, NewDailySignupWithLoginID(
appID,
count,
date,
loginIDType,
))
}
for provider, count := range signupCountResult.CountByOAuthProvider {
counts = append(counts, NewDailySignupWithOAuth(
appID,
count,
date,
provider,
))
}
if signupCountResult.AnonymousCount != 0 {
counts = append(counts, NewCount(
appID,
signupCountResult.AnonymousCount,
date,
DailySignupAnonymouslyCountType,
))
}
return nil
})
if err != nil {
return
}
// Collect counts from redis
dailyCount, err := c.AnalyticService.GetDailyCountResult(config.AppID(appID), &date)
if err != nil {
return
}
if dailyCount.ActiveUser != 0 {
counts = append(counts, NewCount(
appID,
dailyCount.ActiveUser,
date,
DailyActiveUserCountType,
))
}
if dailyCount.LoginPageView != 0 {
counts = append(counts, NewCount(
appID,
dailyCount.LoginPageView,
date,
DailyLoginPageViewCountType,
))
}
if dailyCount.LoginUniquePageView != 0 {
counts = append(counts, NewCount(
appID,
dailyCount.LoginUniquePageView,
date,
DailyLoginUniquePageViewCountType,
))
}
if dailyCount.SignupPageView != 0 {
counts = append(counts, NewCount(
appID,
dailyCount.SignupPageView,
date,
DailySignupPageViewCountType,
))
}
if dailyCount.SignupUniquePageView != 0 {
counts = append(counts, NewCount(
appID,
dailyCount.SignupUniquePageView,
date,
DailySignupUniquePageViewCountType,
))
}
redisKey = dailyCount.RedisKeys
return
}
func (c *CountCollector) CollectWeeklyForApp(appID string, date *time.Time) (counts []*Count, redisKeys []string, err error) {
utc := date.UTC()
year, week := utc.ISOWeek()
monday, err := timeutil.FirstDayOfISOWeek(year, week, time.UTC)
if err != nil {
return
}
weeklyCount, err := c.AnalyticService.GetWeeklyCountResult(config.AppID(appID), year, week)
if err != nil {
return
}
if weeklyCount.ActiveUser != 0 {
counts = append(counts, NewCount(appID, weeklyCount.ActiveUser, *monday, WeeklyActiveUserCountType))
}
return counts, weeklyCount.RedisKeys, nil
}
func (c *CountCollector) CollectMonthlyForApp(appID string, date *time.Time) (counts []*Count, redisKeys []string, err error) {
utc := date.UTC()
firstDayOfTheMonth := timeutil.FirstDayOfTheMonth(utc)
monthlyCount, err := c.AnalyticService.GetMonthlyCountResult(config.AppID(appID), firstDayOfTheMonth.Year(), int(firstDayOfTheMonth.Month()))
if err != nil {
return
}
if monthlyCount.ActiveUser != 0 {
counts = append(counts, NewCount(appID, monthlyCount.ActiveUser, firstDayOfTheMonth, MonthlyActiveUserCountType))
}
return counts, monthlyCount.RedisKeys, nil
}
func (c *CountCollector) querySignupCount(appID string, rangeFrom *time.Time, rangeTo *time.Time) (*SignupCountResult, error) {
var first uint64 = 100
var after model.PageCursor = ""
result := &SignupCountResult{
CountByLoginID: map[string]int{},
CountByOAuthProvider: map[string]int{},
}
for {
events, lastCursor, err := c.queryUserCreatedEvents(appID, rangeFrom, rangeTo, first, after)
if err != nil {
return nil, err
}
// Termination condition
if len(events) == 0 {
return result, nil
}
after = lastCursor
for _, e := range events {
result.TotalCount++
payload := e.Payload.(*nonblocking.UserCreatedEventPayload)
if len(payload.Identities) < 1 {
log.Fatal("missing user identities")
}
iden := payload.Identities[0]
switch model.IdentityType(iden.Type) {
case model.IdentityTypeLoginID:
loginIDType := iden.Claims[string(identity.IdentityClaimLoginIDType)].(string)
if loginIDType == "" {
log.Fatal("missing type in login id identity claims")
}
result.CountByLoginID[loginIDType]++
case model.IdentityTypeOAuth:
provider := iden.Claims[string(identity.IdentityClaimOAuthProviderType)].(string)
if provider == "" {
log.Fatal("missing provider in oauth identity claims")
}
result.CountByOAuthProvider[provider]++
case model.IdentityTypeAnonymous:
result.AnonymousCount++
}
}
}
}
func (c *CountCollector) queryUserCreatedEvents(appID string, rangeFrom *time.Time, rangeTo *time.Time, first uint64, after model.PageCursor) (events []*event.Event, lastCursor model.PageCursor, err error) {
options := audit.QueryPageOptions{
RangeFrom: rangeFrom,
RangeTo: rangeTo,
ActivityTypes: []string{string(nonblocking.UserCreated)},
}
logs, offset, err := c.MeterAuditDBStore.QueryPage(appID, options, graphqlutil.PageArgs{
First: &first,
After: graphqlutil.Cursor(after),
})
if err != nil {
return
}
events = make([]*event.Event, len(logs))
for i, log := range logs {
b, e := json.Marshal(log.Data)
if e != nil {
err = e
return
}
eventObj := event.Event{
Payload: &nonblocking.UserCreatedEventPayload{},
}
e = json.Unmarshal(b, &eventObj)
if e != nil {
err = e
return
}
events[i] = &eventObj
}
pageKey := db.PageKey{Offset: offset + uint64(len(logs)) - 1}
cursor, err := pageKey.ToPageCursor()
if err != nil {
return
}
after = cursor
return events, after, nil
}
func (c *CountCollector) getAppIDs() (appIDs []string, err error) {
err = c.GlobalHandle.WithTx(func() error {
appIDs, err = c.GlobalDBStore.GetAppIDs()
if err != nil {
return fmt.Errorf("failed to fetch app ids: %w", err)
}
return nil
})
return
}
func (c *CountCollector) saveCounts(counts []*Count) (updatedCount int, err error) {
if len(counts) > 0 {
err = c.AuditDBWriteHandle.WithTx(func() error {
// Store the counts to audit db
err = c.AuditDBWriteStore.UpsertCounts(counts)
if err != nil {
return err
}
return nil
})
if err != nil {
err = fmt.Errorf("failed to store count: %w", err)
return
}
updatedCount = len(counts)
}
return
}
func (c *CountCollector) setRedisKeyExpiry(redisKeys []string) error {
return c.AnalyticService.SetKeysExpire(redisKeys, duration.AnalyticRedisKeyExpiration)
}