boltstore

README

boltstore

A Bolt based session store for SCS.

Setup

You should follow the instructions to open a Bolt database, and pass the database to boltstore.New() to establish the session store.

Example

package main

import (
	"io"
	"log"
	"net/http"
	"time"

	"github.com/alexedwards/scs/v2"
	"github.com/alexedwards/scs/boltstore"
	"go.etcd.io/bbolt"
)

var sessionManager *scs.SessionManager

func main() {
    // Open a Bolt database.
	db, err := bbolt.Open("/tmp/bolt.db", 0600, nil)
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close()

	// Initialize a new session manager and configure it to use boltstore as the session store.
	sessionManager = scs.New()
	sessionManager.Store = boltstore.NewWithCleanupInterval(db, 20*time.Second)
	sessionManager.Lifetime = time.Minute

	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

This package provides a background 'cleanup' goroutine to delete expired session data. This stops the database table from holding on to invalid sessions indefinitely and growing unnecessarily large. By default the cleanup runs every 1 minute. You can change this by using the NewWithCleanupInterval() function to initialize your session store. For example:

// Run a cleanup every 5 minutes.
boltstore.NewWithCleanupInterval(db, 5*time.Minute)

// Disable the cleanup goroutine by setting the cleanup interval to zero.
boltstore.NewWithCleanupInterval(db, 0)

Terminating the Cleanup Goroutine

It's rare that the cleanup goroutine needs to be terminated --- it is generally intended to be long-lived and run for the lifetime of your application.

However, there may be occasions when your use of a session store instance is transient. A common example would be using it in a short-lived test function. In this scenario, the cleanup goroutine (which will run forever) will prevent the session store instance from being garbage collected even after the test function has finished. You can prevent this by either disabling the cleanup goroutine altogether (as described above) or by stopping it using the StopCleanup() method. For example:

func TestExample(t *testing.T) {
	db, err := bbolt.Open("/tmp/testing.db", 0600, nil)
	if err != nil {
		t.Fatal(err)
	}
	defer db.Close()

	store := boltstore.New(db)
	defer store.StopCleanup()

	sessionManager = scs.New()
	sessionManager.Store = store

	// Run test...
}

Documentation

Index

• type BoltStore
  • func New(db *bbolt.DB) *BoltStore
  • func NewWithCleanupInterval(db *bbolt.DB, cleanupInterval time.Duration) *BoltStore
  • func (bs *BoltStore) All() (map[string][]byte, error)
  • func (bs *BoltStore) Commit(token string, b []byte, expiry time.Time) error
  • func (bs *BoltStore) Delete(token string) error
  • func (bs *BoltStore) Find(token string) (b []byte, exists bool, err error)
  • func (bs *BoltStore) StopCleanup()

Types

type BoltStore

type BoltStore struct {
	// contains filtered or unexported fields
}

BoltStore represents the session store.

func New

func New(db *bbolt.DB) *BoltStore

New returns a new Boltstore instance, with a background cleanup goroutine that runs every 1 minute to remove expired session data.

func NewWithCleanupInterval

func NewWithCleanupInterval(db *bbolt.DB, cleanupInterval time.Duration) *BoltStore

NewWithCleanupInterval returns a new Boltstore 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 (*BoltStore) All

func (bs *BoltStore) All() (map[string][]byte, error)

All returns a map containing the token and data for all active (i.e. not expired) sessions in the BoltStore instance.

func (*BoltStore) Commit

func (bs *BoltStore) Commit(token string, b []byte, expiry time.Time) error

Commit adds a session token and data to the BoltStore instance with the given expiry time. If the session token already exists, then the data and expiry time are updated.

func (*BoltStore) Delete

func (bs *BoltStore) Delete(token string) error

Delete removes a session token and corresponding data from the BoltStore instance.

func (*BoltStore) Find

func (bs *BoltStore) Find(token string) (b []byte, exists bool, err error)

Find returns the data for a given session token from the BoltStore instance. If the session token is not found or is expired, the returned exists flag will be set to false.

func (*BoltStore) StopCleanup

func (bs *BoltStore) StopCleanup()

StopCleanup terminates the background cleanup goroutine for the BoltStore instance. It's rare to terminate this; generally BoltStore 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 BoltStore is transient. An example is creating a new BoltStore instance in a test function. In this scenario, the cleanup goroutine (which will run forever) will prevent the BoltStore object from being garbage collected even after the test function has finished. You can prevent this by manually calling StopCleanup.