forked from alexedwards/scs
/
firestore.go
167 lines (152 loc) · 4.44 KB
/
firestore.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
package firestore
import (
"context"
"log"
"time"
"cloud.google.com/go/firestore"
"google.golang.org/api/iterator"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)
// FireStore represents the session store.
type FireStore struct {
*firestore.Client
Sessions *firestore.CollectionRef
stopCleanup chan bool
}
type sessionDoc struct {
Data []byte
Expiry time.Time
}
// New returns a new FireStore instance, with a background cleanup goroutine
// that runs every 5 minutes to remove expired session data.
func New(client *firestore.Client) *FireStore {
return NewWithCleanupInterval(client, 5*time.Minute)
}
// NewWithCleanupInterval returns a new FireStore instance. The cleanupInterval
// parameter controls how frequently expired session data is removed by the
// background cleanup goroutine. Setting it to 0 prevents the cleanup goroutine
// from running (i.e. expired sessions will not be removed).
func NewWithCleanupInterval(client *firestore.Client, cleanupInterval time.Duration) *FireStore {
m := &FireStore{
Client: client,
Sessions: client.Collection("Sessions"),
}
if cleanupInterval > 0 {
go m.startCleanup(cleanupInterval)
}
return m
}
// Find returns the data for a given session token from the FireStore instance.
// If the session token is not found or is expired, the returned exists flag will
// be set to false.
func (m *FireStore) Find(ctx context.Context, token string) ([]byte, bool, error) {
ds, err := m.Sessions.Doc(token).Get(ctx)
if err != nil {
if status.Code(err) == codes.NotFound {
return nil, false, nil
}
return nil, false, err
}
var sd sessionDoc
err = ds.DataTo(&sd)
if err != nil {
return nil, false, err
}
if time.Now().After(sd.Expiry) {
return nil, false, nil
}
return sd.Data, true, nil
}
// Commit adds a session token and data to the FireStore instance with the given
// expiry time. If the session token already exists, then the data and expiry
// time are updated.
func (m *FireStore) Commit(ctx context.Context, token string, b []byte, expiry time.Time) error {
sd := sessionDoc{Data: b, Expiry: expiry}
_, err := m.Sessions.Doc(token).Set(ctx, &sd)
if err != nil {
return err
}
return nil
}
// Delete removes a session token and corresponding data from the FireStore
// instance.
func (m *FireStore) Delete(ctx context.Context, token string) error {
_, err := m.Sessions.Doc(token).Delete(ctx)
return err
}
// All returns a map containing the token and data for all active (i.e.
// not expired) sessions in the firestore instance.
func (m *FireStore) All(ctx context.Context) (map[string][]byte, error) {
iter := m.Sessions.Where("Expiry", ">=", time.Now()).Documents(ctx)
defer iter.Stop()
sessions := make(map[string][]byte)
for {
snap, err := iter.Next()
if err == iterator.Done {
break
}
if err != nil {
return nil, err
}
var sd sessionDoc
err = snap.DataTo(&sd)
if err != nil {
return nil, err
}
sessions[snap.Ref.ID] = sd.Data
}
return sessions, nil
}
func (m *FireStore) startCleanup(interval time.Duration) {
m.stopCleanup = make(chan bool)
ticker := time.NewTicker(interval)
for {
select {
case <-ticker.C:
err := m.deleteExpired()
if err != nil {
log.Println(err)
}
case <-m.stopCleanup:
ticker.Stop()
return
}
}
}
// StopCleanup terminates the background cleanup goroutine for the FireStore
// instance. It's rare to terminate this; generally FireStore instances and
// their cleanup goroutines are intended to be long-lived and run for the lifetime
// of your application.
//
// There may be occasions though when your use of the FireStore is transient.
// An example is creating a new FireStore instance in a test function. In this
// scenario, the cleanup goroutine (which will run forever) will prevent the
// MySQLStore object from being garbage collected even after the test function
// has finished. You can prevent this by manually calling StopCleanup.
func (m *FireStore) StopCleanup() {
if m.stopCleanup != nil {
m.stopCleanup <- true
}
}
func (m *FireStore) deleteExpired() error {
ctx := context.Background()
iter := m.Sessions.Where("Expiry", "<", time.Now()).Documents(ctx)
for {
snap, err := iter.Next()
if err == iterator.Done {
break
}
if err != nil {
log.Printf("Failed to iterate: %v", err)
break
}
_, err = snap.Ref.Delete(ctx, firestore.LastUpdateTime(snap.UpdateTime))
if err != nil {
log.Printf("Failed to delete: %v", err)
continue
}
}
iter.Stop()
return nil
}