mirror of
https://github.com/alexedwards/scs.git
synced 2025-07-17 01:12:21 +02:00
Add BadgerDB session store
This commit is contained in:
Andreas Linnert
79
badgerstore/README.md
Normal file
79
badgerstore/README.md
Normal file
@ -0,0 +1,79 @@
|
||||
# badger
|
||||
|
||||
A [Badger](https://github.com/dgraph-io/badger)-based session store for [SCS](https://github.com/alexedwards/scs).
|
||||
|
||||
## Example
|
||||
|
||||
You should follow the instructions to [install and open a database](https://github.com/dgraph-io/badger#installing), and pass the database to `badgerstore.New()` to establish the session store.
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"io"
|
||||
"net/http"
|
||||
|
||||
"github.com/alexedwards/scs/v2"
|
||||
"github.com/alexedwards/scs/badgerstore"
|
||||
"github.com/dgraph-io/badger"
|
||||
)
|
||||
|
||||
var sessionManager *scs.SessionManager
|
||||
|
||||
func main() {
|
||||
// Create a Badger database.
|
||||
db, err := badger.Open(badger.DefaultOptions("tmp/badger"))
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
defer db.Close()
|
||||
|
||||
// Initialize a new session manager and configure it to use badgerstore as
|
||||
// the session store.
|
||||
sessionManager = scs.New()
|
||||
sessionManager.Store = badgerstore.New(db)
|
||||
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/put", putHandler)
|
||||
mux.HandleFunc("/get", getHandler)
|
||||
|
||||
http.ListenAndServe(":4000", sessionManager.LoadAndSave(mux))
|
||||
}
|
||||
|
||||
func putHandler(w http.ResponseWriter, r *http.Request) {
|
||||
sessionManager.Put(r.Context(), "message", "Hello from a session!")
|
||||
}
|
||||
|
||||
func getHandler(w http.ResponseWriter, r *http.Request) {
|
||||
msg := sessionManager.GetString(r.Context(), "message")
|
||||
io.WriteString(w, msg)
|
||||
}
|
||||
```
|
||||
|
||||
## Expired Session Cleanup
|
||||
|
||||
Badger will [automatically remove](https://github.com/dgraph-io/badger#setting-time-to-livettl-and-user-metadata-on-keys) expired session keys.
|
||||
|
||||
## Key Collisions
|
||||
|
||||
By default keys are in the form `scs:session:<token>`. For example:
|
||||
|
||||
```
|
||||
"scs:session:ZnirGwi2FiLwXeVlP5nD77IpfJZMVr6un9oZu2qtJrg"
|
||||
```
|
||||
|
||||
Because the token is highly unique, key collisions are not a concern. But if you're configuring *multiple session managers*, both of which use `badgerstore`, then you may want the keys to have a different prefix depending on which session manager wrote them. You can do this by using the `NewWithPrefix()` method like so:
|
||||
|
||||
```go
|
||||
db, err := badger.Open(badger.DefaultOptions("tmp/badger"))
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
defer db.Close()
|
||||
|
||||
sessionManagerOne = scs.New()
|
||||
sessionManagerOne.Store = badgerstore.NewWithPrefix(db, "scs:session:1:")
|
||||
|
||||
sessionManagerTwo = scs.New()
|
||||
sessionManagerTwo.Store = badgerstore.NewWithPrefix(db, "scs:session:2:")
|
||||
```
|
||||
86
badgerstore/badgerstore.go
Normal file
86
badgerstore/badgerstore.go
Normal file
@ -0,0 +1,86 @@
|
||||
package badgerstore
|
||||
|
||||
import (
|
||||
"time"
|
||||
|
||||
"github.com/dgraph-io/badger"
|
||||
)
|
||||
|
||||
// BadgerStore represents the session store.
|
||||
type BadgerStore struct {
|
||||
db *badger.DB
|
||||
prefix string
|
||||
}
|
||||
|
||||
// New returns a new BadgerStore instance.
|
||||
// The db parameter should be a pointer to a badger store instance.
|
||||
func New(db *badger.DB) *BadgerStore {
|
||||
return NewWithPrefix(db, "scs:session:")
|
||||
}
|
||||
|
||||
// NewWithPrefix returns a new BadgerStore instance.
|
||||
// The db parameter should be a pointer to a badger store instance.
|
||||
// The prefix parameter controls the Badger key prefix,
|
||||
// which can be used to avoid naming clashes if necessary.
|
||||
func NewWithPrefix(db *badger.DB, prefix string) *BadgerStore {
|
||||
return &BadgerStore{
|
||||
db: db,
|
||||
prefix: prefix,
|
||||
}
|
||||
}
|
||||
|
||||
// Find returns the data for a given session token from the BadgerStore
|
||||
// instance. If the session token is not found or is expired,
|
||||
// the returned exists flag will be set to false.
|
||||
func (bs *BadgerStore) Find(token string) ([]byte, bool, error) {
|
||||
key := []byte(bs.prefix + token)
|
||||
txn := bs.db.NewTransaction(false)
|
||||
defer txn.Discard()
|
||||
|
||||
item, err := txn.Get(key)
|
||||
if err != nil {
|
||||
return nil, false, nil
|
||||
}
|
||||
|
||||
data, err := item.ValueCopy(nil)
|
||||
if err != nil {
|
||||
return nil, false, err
|
||||
}
|
||||
|
||||
return data, true, nil
|
||||
}
|
||||
|
||||
// Commit adds a session token and data to the BadgerStore instance with the
|
||||
// given expiry time. If the session token already exists then the data and
|
||||
// expiry time are updated.
|
||||
func (bs *BadgerStore) Commit(token string, data []byte, expiry time.Time) error {
|
||||
txn := bs.db.NewTransaction(true)
|
||||
defer txn.Discard()
|
||||
|
||||
key := []byte(bs.prefix + token)
|
||||
entry := badger.NewEntry(key, data).WithTTL(time.Until(expiry))
|
||||
err := txn.SetEntry(entry)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := txn.Commit(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Delete removes a session token and corresponding data from the BadgerStore instance.
|
||||
func (bs *BadgerStore) Delete(token string) error {
|
||||
txn := bs.db.NewTransaction(true)
|
||||
defer txn.Discard()
|
||||
|
||||
txn.Delete([]byte(bs.prefix + token))
|
||||
|
||||
if err := txn.Commit(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
215
badgerstore/badgerstore_test.go
Normal file
215
badgerstore/badgerstore_test.go
Normal file
@ -0,0 +1,215 @@
|
||||
package badgerstore
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"log"
|
||||
"os"
|
||||
"reflect"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/dgraph-io/badger"
|
||||
)
|
||||
|
||||
var (
|
||||
db *badger.DB
|
||||
)
|
||||
|
||||
func TestMain(m *testing.M) {
|
||||
var (
|
||||
result int
|
||||
err error
|
||||
)
|
||||
|
||||
db, err = badger.Open(badger.DefaultOptions("test.db"))
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
result = 1
|
||||
}
|
||||
|
||||
if err == nil {
|
||||
result = m.Run()
|
||||
}
|
||||
|
||||
db.Close()
|
||||
err = os.RemoveAll("test.db")
|
||||
if err != nil {
|
||||
log.Println("Could not delete test store folder \"test.db\".")
|
||||
log.Println("You can delete it manually instead.")
|
||||
}
|
||||
os.Exit(result)
|
||||
}
|
||||
|
||||
func TestFind(t *testing.T) {
|
||||
store := New(db)
|
||||
|
||||
err := db.Update(func(txn *badger.Txn) error {
|
||||
err := txn.Set([]byte(store.prefix+"session_token"), []byte("encoded_data"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
data, found, err := store.Find("session_token")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if found != true {
|
||||
t.Fatalf("got %v: expected %v", found, true)
|
||||
}
|
||||
|
||||
if bytes.Equal(data, []byte("encoded_data")) == false {
|
||||
t.Fatalf("got %v: expected %v", data, []byte("encoded_data"))
|
||||
}
|
||||
}
|
||||
|
||||
func TestSaveNew(t *testing.T) {
|
||||
store := New(db)
|
||||
|
||||
err := store.Commit("session_token", []byte("encoded_data"), time.Now().Add(time.Minute))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = db.View(func(txn *badger.Txn) error {
|
||||
item, err := txn.Get([]byte(store.prefix + "session_token"))
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
data, err := item.ValueCopy(nil)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if reflect.DeepEqual(data, []byte("encoded_data")) == false {
|
||||
t.Fatalf("got %v: expected %v", data, []byte("encoded_data"))
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestFindMissing(t *testing.T) {
|
||||
store := New(db)
|
||||
|
||||
_, found, err := store.Find("missing_session_token")
|
||||
if err != nil {
|
||||
t.Fatalf("got %v: expected %v", err, nil)
|
||||
}
|
||||
if found != false {
|
||||
t.Fatalf("got %v: expected %v", found, false)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSaveUpdated(t *testing.T) {
|
||||
store := New(db)
|
||||
|
||||
err := db.Update(func(txn *badger.Txn) error {
|
||||
err := txn.Set([]byte(store.prefix+"session_token"), []byte("encoded_data"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = store.Commit("session_token", []byte("new_encoded_data"), time.Now().Add(time.Minute))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
var data []byte
|
||||
|
||||
err = db.View(func(txn *badger.Txn) error {
|
||||
item, err := txn.Get([]byte(store.prefix + "session_token"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
data, err = item.ValueCopy(nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if reflect.DeepEqual(data, []byte("new_encoded_data")) == false {
|
||||
t.Fatalf("got %v: expected %v", data, []byte("new_encoded_data"))
|
||||
}
|
||||
}
|
||||
|
||||
func TestExpiry(t *testing.T) {
|
||||
store := New(db)
|
||||
expiry := time.Now().Add(time.Second)
|
||||
|
||||
err := store.Commit("session_token", []byte("encoded_data"), expiry)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
_, found, err := store.Find("session_token")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if found != true {
|
||||
t.Fatalf("got %v: expected %v", found, true)
|
||||
}
|
||||
|
||||
time.Sleep(2 * time.Second)
|
||||
|
||||
_, found, err = store.Find("session_token")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if found != false {
|
||||
t.Fatalf("got %v: expected %v", found, false)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDelete(t *testing.T) {
|
||||
store := New(db)
|
||||
|
||||
err := db.Update(func(txn *badger.Txn) error {
|
||||
err := txn.Set([]byte(store.prefix+"session_token"), []byte("encoded_data"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = store.Delete("session_token")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = db.View(func(txn *badger.Txn) error {
|
||||
item, err := txn.Get([]byte(store.prefix + "session_token"))
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
t.Fatalf("got %v: expected %v", item, nil)
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
5
badgerstore/go.mod
Normal file
5
badgerstore/go.mod
Normal file
@ -0,0 +1,5 @@
|
||||
module github.com/alexedwards/scs/badgerstore
|
||||
|
||||
go 1.12
|
||||
|
||||
require github.com/dgraph-io/badger v1.6.0
|
||||
50
badgerstore/go.sum
Normal file
50
badgerstore/go.sum
Normal file
@ -0,0 +1,50 @@
|
||||
github.com/AndreasBriese/bbloom v0.0.0-20190306092124-e2d15f34fcf9 h1:HD8gA2tkByhMAwYaFAX9w2l7vxvBQ5NMoxDrkhqhtn4=
|
||||
github.com/AndreasBriese/bbloom v0.0.0-20190306092124-e2d15f34fcf9/go.mod h1:bOvUY6CB00SOBii9/FifXqc0awNKxLFCL/+pkDPuyl8=
|
||||
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
|
||||
github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
|
||||
github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=
|
||||
github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk=
|
||||
github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
|
||||
github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/dgraph-io/badger v1.6.0 h1:DshxFxZWXUcO0xX476VJC07Xsr6ZCBVRHKZ93Oh7Evo=
|
||||
github.com/dgraph-io/badger v1.6.0/go.mod h1:zwt7syl517jmP8s94KqSxTlM6IMsdhYy6psNgSztDR4=
|
||||
github.com/dgryski/go-farm v0.0.0-20190423205320-6a90982ecee2 h1:tdlZCpZ/P9DhczCTSixgIKmwPv6+wP5DGjqLYw5SUiA=
|
||||
github.com/dgryski/go-farm v0.0.0-20190423205320-6a90982ecee2/go.mod h1:SqUrOPUnsFjfmXRMNPybcSiG0BgUW2AuFH8PAnS2iTw=
|
||||
github.com/dustin/go-humanize v1.0.0 h1:VSnTsYCnlFHaM2/igO1h6X3HA71jcobQuxemgkq4zYo=
|
||||
github.com/dustin/go-humanize v1.0.0/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk=
|
||||
github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
|
||||
github.com/golang/protobuf v1.3.1 h1:YF8+flBXS5eO826T4nzqPrxfhQThhXl0YzfuUPu4SBg=
|
||||
github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
|
||||
github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
|
||||
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
|
||||
github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
|
||||
github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
|
||||
github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
|
||||
github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
|
||||
github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
|
||||
github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
|
||||
github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
|
||||
github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
|
||||
github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU=
|
||||
github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo=
|
||||
github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
|
||||
github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DMA2s=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
||||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
||||
github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0=
|
||||
github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q=
|
||||
golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
|
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859 h1:R/3boaszxrf1GEUWTVDzSKVwLmSJpwZ1yqXm8j0v2QI=
|
||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190626221950-04f50cda93cb/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
Reference in New Issue
Block a user