-
-
Notifications
You must be signed in to change notification settings - Fork 176
/
memstore.go
395 lines (335 loc) · 8.92 KB
/
memstore.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
// Copyright © Martin Tournoij – This file is part of GoatCounter and published
// under the terms of a slightly modified EUPL v1.2 license, which can be found
// in the LICENSE file or at https://license.goatcounter.com
package goatcounter
import (
"context"
"errors"
"fmt"
"net/url"
"slices"
"strings"
"sync"
"time"
"zgo.at/json"
"zgo.at/zdb"
"zgo.at/zlog"
"zgo.at/zstd/zbool"
"zgo.at/zstd/zint"
"zgo.at/zstd/ztime"
"zgo.at/zstd/ztype"
"zgo.at/zvalidate"
)
var (
// Valid UUID for testing: 00112233-4455-6677-8899-aabbccddeeff
TestSession = zint.Uint128{0x11223344556677, 0x8899aabbccddeeff}
TestSeqSession = zint.Uint128{TestSession[0], TestSession[1] + 1}
)
type sessionKey string
type ms struct {
hitMu sync.RWMutex
hits []Hit
sessionMu sync.RWMutex
sessions map[sessionKey]zint.Uint128 // sessionKey → sessionID
sessionHashes map[zint.Uint128]sessionKey // sessionID → sessionKey
sessionPaths map[zint.Uint128]map[int64]struct{} // SessionID → path_id
sessionSeen map[zint.Uint128]int64 // SessionID → lastseen
testHook bool
}
var Memstore ms
type storedSession struct {
Sessions map[sessionKey]zint.Uint128 `json:"sessions"`
Hashes map[zint.Uint128]sessionKey `json:"hashes"`
Paths map[zint.Uint128]map[int64]struct{} `json:"paths"`
Seen map[zint.Uint128]int64 `json:"seen"`
}
func (m *ms) Reset() {
m.sessionMu.Lock()
defer m.sessionMu.Unlock()
m.sessions = make(map[sessionKey]zint.Uint128)
m.sessionHashes = make(map[zint.Uint128]sessionKey)
m.sessionPaths = make(map[zint.Uint128]map[int64]struct{})
m.sessionSeen = make(map[zint.Uint128]int64)
TestSeqSession = zint.Uint128{TestSession[0], TestSession[1] + 1}
}
// TestInit is like Init(), but enables the test hook to return sequential UUIDs
// instead of random ones.
func (m *ms) TestInit(db zdb.DB) error {
m.testHook = true
return m.Init(db)
}
func (m *ms) Init(db zdb.DB) error {
m.hitMu.Lock()
defer m.hitMu.Unlock()
m.Reset()
m.sessionMu.Lock()
defer m.sessionMu.Unlock()
defer func() {
err := db.Exec(context.Background(), `delete from store where key='session'`)
if err != nil {
zlog.Errorf("Memstore.Init: delete DB store: %w", err)
}
}()
var s []byte
err := db.Get(context.Background(), &s, `select value from store where key='session'`)
if err != nil {
if zdb.ErrNoRows(err) {
return nil
}
zlog.Errorf("Memstore.Init: load from DB store: %w", err)
return nil
}
var stored storedSession
err = json.Unmarshal(s, &stored)
if err != nil {
zlog.Errorf("Memstore.Init: %w", err)
return nil
}
if stored.Sessions != nil {
m.sessions = stored.Sessions
}
if stored.Hashes != nil {
m.sessionHashes = stored.Hashes
}
if stored.Paths != nil {
m.sessionPaths = stored.Paths
}
if stored.Seen != nil {
m.sessionSeen = stored.Seen
}
return nil
}
func (m *ms) StoreSessions(db zdb.DB) {
m.sessionMu.Lock()
defer m.sessionMu.Unlock()
d, err := json.Marshal(storedSession{
Sessions: m.sessions,
Paths: m.sessionPaths,
Seen: m.sessionSeen,
Hashes: m.sessionHashes,
})
if err != nil {
zlog.Error(err)
return
}
err = db.Exec(context.Background(),
`insert into store (key, value) values ('session', $1)`, d)
if err != nil {
zlog.Error(err)
}
}
func (m *ms) Append(hits ...Hit) {
m.hitMu.Lock()
m.hits = append(m.hits, hits...)
m.hitMu.Unlock()
}
func (m *ms) SessionsLen() int {
m.sessionMu.Lock()
defer m.sessionMu.Unlock()
return len(m.sessions)
}
func (m *ms) Len() int {
m.hitMu.Lock()
defer m.hitMu.Unlock()
return len(m.hits)
}
var (
refspamSubdomains []string
refspamOnce sync.Once
)
func isRefspam(host string) bool {
if _, ok := refspam[host]; ok {
return true
}
refspamOnce.Do(func() {
refspamSubdomains = make([]string, 0, len(refspam))
for v := range refspam {
refspamSubdomains = append(refspamSubdomains, "."+v)
}
})
for _, v := range refspamSubdomains {
if strings.HasSuffix(host, v) {
return true
}
}
return false
}
func (m *ms) Persist(ctx context.Context) ([]Hit, error) {
if m.Len() == 0 {
return nil, nil
}
m.hitMu.Lock()
hits := make([]Hit, len(m.hits))
copy(hits, m.hits)
m.hits = make([]Hit, 0, 16)
m.hitMu.Unlock()
newHits := make([]Hit, 0, len(hits))
ins := zdb.NewBulkInsert(ctx, "hits", []string{"site_id", "path_id", "ref_id",
"browser_id", "system_id", "size_id", "location", "language", "created_at", "bot",
"session", "first_visit"})
for _, h := range hits {
if m.processHit(ctx, &h) {
// Don't return hits that failed validation; otherwise cron will try to
// insert them.
newHits = append(newHits, h)
if !h.NoStore {
ins.Values(h.Site, h.PathID, h.RefID, h.BrowserID, h.SystemID, h.SizeID,
h.Location, h.Language, h.CreatedAt.Round(time.Second), h.Bot, h.Session, h.FirstVisit)
}
}
}
return newHits, ins.Finish()
}
func (m *ms) processHit(ctx context.Context, h *Hit) bool {
defer zlog.Recover(func(l zlog.Log) zlog.Log { return l.Field("hit", fmt.Sprintf("%#v", h)) })
l := zlog.Module("memstore")
if h.noProcess {
return true
}
// Ignore spammers.
h.RefURL, _ = url.Parse(h.Ref)
if h.RefURL != nil {
if isRefspam(h.RefURL.Host) {
l.Debugf("refspam ignored: %q", h.RefURL.Host)
return false
}
}
var site Site
err := site.ByID(ctx, h.Site)
if err != nil {
l.Field("hit", fmt.Sprintf("%#v", h)).Error(err)
return false
}
ctx = WithSite(ctx, &site)
if !site.Settings.Collect.Has(CollectHits) && h.Bot == 0 {
h.NoStore = true
}
if !site.Settings.Collect.Has(CollectReferrer) {
h.Query = ""
h.Ref = ""
h.RefScheme = nil
h.RefURL = nil
}
err = h.Defaults(ctx, false)
if err != nil {
if errors.As(err, ztype.Ptr(&zvalidate.Validator{})) {
l.Field("hit", fmt.Sprintf("%#v", h)).Debug(err)
} else {
l.Field("hit", fmt.Sprintf("%#v", h)).Error(err)
}
return false
}
if h.Session.IsZero() && site.Settings.Collect.Has(CollectSession) {
h.Session, h.FirstVisit = m.session(ctx, site.ID, h.PathID, h.UserSessionID, h.UserAgentHeader, h.RemoteAddr)
}
if !site.Settings.Collect.Has(CollectSession) {
h.Session = zint.Uint128{}
h.FirstVisit = true
}
if !site.Settings.Collect.Has(CollectScreenSize) {
h.Size = nil
}
if !site.Settings.Collect.Has(CollectUserAgent) {
h.UserAgentHeader = ""
h.BrowserID = 0
h.SystemID = 0
}
if !site.Settings.Collect.Has(CollectLanguage) {
h.Language = nil
}
if !site.Settings.Collect.Has(CollectLocation) {
h.Location = ""
}
if strings.ContainsRune(h.Location, '-') {
trim := !site.Settings.Collect.Has(CollectLocationRegion)
if !trim && len(site.Settings.CollectRegions) > 0 {
trim = !slices.Contains(site.Settings.CollectRegions, h.Location[:2])
}
if trim {
var l Location
err := l.ByCode(ctx, h.Location[:2])
if err != nil {
zlog.Errorf("lookup %q: %w", h.Location[:2], err)
}
h.Location = l.ISO3166_2
}
}
if h.Ignore() {
return false
}
err = h.Validate(ctx, false)
if err != nil {
l.Field("hit", fmt.Sprintf("%#v", h)).Error(err)
return false
}
return true
}
// SessionTime is the maximum length of sessions; exported here for tests.
var SessionTime = 8 * time.Hour
// For 10k sessions this takes about 5ms on my laptop; that's a small enough
// delay to not overly worry about (there are rarely more than a few hundred
// sessions at a time).
func (m *ms) EvictSessions() {
m.sessionMu.Lock()
defer m.sessionMu.Unlock()
ev := ztime.Now().Add(-SessionTime).Unix()
for id, seen := range m.sessionSeen {
if seen > ev {
continue
}
sk := m.sessionHashes[id]
sessLog.Fields(zlog.F{
"session-id": id,
"last-seen": seen,
"session-key": sk,
}).Debug("evicting session")
delete(m.sessions, sk)
delete(m.sessionPaths, id)
delete(m.sessionSeen, id)
delete(m.sessionHashes, id)
}
}
// SessionID gets a new UUID4 session ID.
func (m *ms) SessionID() zint.Uint128 {
if m.testHook {
TestSeqSession[1]++
return TestSeqSession
}
return UUID()
}
var sessLog = zlog.Module("session")
func (m *ms) session(ctx context.Context, siteID, pathID int64, userSessionID, ua, remoteAddr string) (zint.Uint128, zbool.Bool) {
sk := sessionKey(userSessionID)
if userSessionID == "" {
sk = sessionKey(fmt.Sprintf("%s-%s-%d", ua, remoteAddr, siteID))
}
m.sessionMu.Lock()
defer m.sessionMu.Unlock()
id, ok := m.sessions[sk]
if ok { // Existing session
m.sessionSeen[id] = ztime.Now().Unix()
_, seenPath := m.sessionPaths[id][pathID]
if !seenPath {
m.sessionPaths[id][pathID] = struct{}{}
}
sessLog.Fields(zlog.F{
"session-key": sk,
"session-id": id,
"path": pathID,
"seen-path": seenPath,
}).Debug("HIT")
return id, zbool.Bool(!seenPath)
}
// New session
id = m.SessionID()
m.sessions[sk] = id
m.sessionPaths[id] = map[int64]struct{}{pathID: struct{}{}}
m.sessionSeen[id] = ztime.Now().Unix()
m.sessionHashes[id] = sk
sessLog.Fields(zlog.F{
"session-key": sk,
"session-id": id,
"path": pathID,
}).Debug("MISS: created new")
return id, true
}