From 28e6b3b92450b0ca0e9c1342d400f8810e4d5e5a Mon Sep 17 00:00:00 2001
From: Phillip Stagnet
Date: Mon, 3 Aug 2020 13:31:49 +0200
Subject: [PATCH] Add error to SessionExist interface
Implement changed interface for all default providers as well and change
tests accordingly
---
session/couchbase/sess_couchbase.go | 6 +-
session/ledis/ledis_session.go | 4 +-
session/memcache/sess_memcache.go | 8 +--
session/mysql/sess_mysql.go | 10 ++-
session/postgres/sess_postgresql.go | 10 ++-
session/redis/sess_redis.go | 6 +-
session/redis_cluster/redis_cluster.go | 6 +-
session/redis_sentinel/sess_redis_sentinel.go | 6 +-
session/sess_cookie.go | 4 +-
session/sess_file.go | 9 ++-
session/sess_file_test.go | 62 +++++++++++++++----
session/sess_mem.go | 6 +-
session/session.go | 12 +++-
session/ssdb/sess_ssdb.go | 8 +--
14 files changed, 109 insertions(+), 48 deletions(-)
diff --git a/session/couchbase/sess_couchbase.go b/session/couchbase/sess_couchbase.go
index 707d042c..46ab07ab 100644
--- a/session/couchbase/sess_couchbase.go
+++ b/session/couchbase/sess_couchbase.go
@@ -179,16 +179,16 @@ func (cp *Provider) SessionRead(sid string) (session.Store, error) {
// SessionExist Check couchbase session exist.
// it checkes sid exist or not.
-func (cp *Provider) SessionExist(sid string) bool {
+func (cp *Provider) SessionExist(sid string) (bool, error) {
cp.b = cp.getBucket()
defer cp.b.Close()
var doc []byte
if err := cp.b.Get(sid, &doc); err != nil || doc == nil {
- return false
+ return false, err
}
- return true
+ return true, nil
}
// SessionRegenerate remove oldsid and use sid to generate new session
diff --git a/session/ledis/ledis_session.go b/session/ledis/ledis_session.go
index ee81df67..4f578eac 100644
--- a/session/ledis/ledis_session.go
+++ b/session/ledis/ledis_session.go
@@ -132,9 +132,9 @@ func (lp *Provider) SessionRead(sid string) (session.Store, error) {
}
// SessionExist check ledis session exist by sid
-func (lp *Provider) SessionExist(sid string) bool {
+func (lp *Provider) SessionExist(sid string) (bool, error) {
count, _ := c.Exists([]byte(sid))
- return count != 0
+ return count != 0, nil
}
// SessionRegenerate generate new sid for ledis session
diff --git a/session/memcache/sess_memcache.go b/session/memcache/sess_memcache.go
index 85a2d815..e76eb8a5 100644
--- a/session/memcache/sess_memcache.go
+++ b/session/memcache/sess_memcache.go
@@ -149,16 +149,16 @@ func (rp *MemProvider) SessionRead(sid string) (session.Store, error) {
}
// SessionExist check memcache session exist by sid
-func (rp *MemProvider) SessionExist(sid string) bool {
+func (rp *MemProvider) SessionExist(sid string) (bool, error) {
if client == nil {
if err := rp.connectInit(); err != nil {
- return false
+ return false, err
}
}
if item, err := client.Get(sid); err != nil || len(item.Value) == 0 {
- return false
+ return false, err
}
- return true
+ return true, nil
}
// SessionRegenerate generate new sid for memcache session
diff --git a/session/mysql/sess_mysql.go b/session/mysql/sess_mysql.go
index 301353ab..9f9547a7 100644
--- a/session/mysql/sess_mysql.go
+++ b/session/mysql/sess_mysql.go
@@ -164,13 +164,19 @@ func (mp *Provider) SessionRead(sid string) (session.Store, error) {
}
// SessionExist check mysql session exist
-func (mp *Provider) SessionExist(sid string) bool {
+func (mp *Provider) SessionExist(sid string) (bool, error) {
c := mp.connectInit()
defer c.Close()
row := c.QueryRow("select session_data from "+TableName+" where session_key=?", sid)
var sessiondata []byte
err := row.Scan(&sessiondata)
- return err != sql.ErrNoRows
+ if err != nil {
+ if err == sql.ErrNoRows {
+ return false, nil
+ }
+ return false, err
+ }
+ return true, nil
}
// SessionRegenerate generate new sid for mysql session
diff --git a/session/postgres/sess_postgresql.go b/session/postgres/sess_postgresql.go
index 0b8b9645..d8a1e6de 100644
--- a/session/postgres/sess_postgresql.go
+++ b/session/postgres/sess_postgresql.go
@@ -178,13 +178,19 @@ func (mp *Provider) SessionRead(sid string) (session.Store, error) {
}
// SessionExist check postgresql session exist
-func (mp *Provider) SessionExist(sid string) bool {
+func (mp *Provider) SessionExist(sid string) (bool, error) {
c := mp.connectInit()
defer c.Close()
row := c.QueryRow("select session_data from session where session_key=$1", sid)
var sessiondata []byte
err := row.Scan(&sessiondata)
- return err != sql.ErrNoRows
+ if err != nil {
+ if err == sql.ErrNoRows {
+ return false, nil
+ }
+ return false, err
+ }
+ return true, nil
}
// SessionRegenerate generate new sid for postgresql session
diff --git a/session/redis/sess_redis.go b/session/redis/sess_redis.go
index 5c382d61..439b14cb 100644
--- a/session/redis/sess_redis.go
+++ b/session/redis/sess_redis.go
@@ -211,14 +211,14 @@ func (rp *Provider) SessionRead(sid string) (session.Store, error) {
}
// SessionExist check redis session exist by sid
-func (rp *Provider) SessionExist(sid string) bool {
+func (rp *Provider) SessionExist(sid string) (bool, error) {
c := rp.poollist.Get()
defer c.Close()
if existed, err := redis.Int(c.Do("EXISTS", sid)); err != nil || existed == 0 {
- return false
+ return false, err
}
- return true
+ return true, nil
}
// SessionRegenerate generate new sid for redis session
diff --git a/session/redis_cluster/redis_cluster.go b/session/redis_cluster/redis_cluster.go
index 262fa2e3..d4e28327 100644
--- a/session/redis_cluster/redis_cluster.go
+++ b/session/redis_cluster/redis_cluster.go
@@ -176,12 +176,12 @@ func (rp *Provider) SessionRead(sid string) (session.Store, error) {
}
// SessionExist check redis_cluster session exist by sid
-func (rp *Provider) SessionExist(sid string) bool {
+func (rp *Provider) SessionExist(sid string) (bool, error) {
c := rp.poollist
if existed, err := c.Exists(sid).Result(); err != nil || existed == 0 {
- return false
+ return false, err
}
- return true
+ return true, nil
}
// SessionRegenerate generate new sid for redis_cluster session
diff --git a/session/redis_sentinel/sess_redis_sentinel.go b/session/redis_sentinel/sess_redis_sentinel.go
index 6ecb2977..eead7a74 100644
--- a/session/redis_sentinel/sess_redis_sentinel.go
+++ b/session/redis_sentinel/sess_redis_sentinel.go
@@ -189,12 +189,12 @@ func (rp *Provider) SessionRead(sid string) (session.Store, error) {
}
// SessionExist check redis_sentinel session exist by sid
-func (rp *Provider) SessionExist(sid string) bool {
+func (rp *Provider) SessionExist(sid string) (bool, error) {
c := rp.poollist
if existed, err := c.Exists(sid).Result(); err != nil || existed == 0 {
- return false
+ return false, err
}
- return true
+ return true, nil
}
// SessionRegenerate generate new sid for redis_sentinel session
diff --git a/session/sess_cookie.go b/session/sess_cookie.go
index 6ad5debc..30a7032e 100644
--- a/session/sess_cookie.go
+++ b/session/sess_cookie.go
@@ -147,8 +147,8 @@ func (pder *CookieProvider) SessionRead(sid string) (Store, error) {
}
// SessionExist Cookie session is always existed
-func (pder *CookieProvider) SessionExist(sid string) bool {
- return true
+func (pder *CookieProvider) SessionExist(sid string) (bool, error) {
+ return true, nil
}
// SessionRegenerate Implement method, no used.
diff --git a/session/sess_file.go b/session/sess_file.go
index 47ad54a7..3345d5d0 100644
--- a/session/sess_file.go
+++ b/session/sess_file.go
@@ -176,17 +176,20 @@ func (fp *FileProvider) SessionRead(sid string) (Store, error) {
// SessionExist Check file session exist.
// it checks the file named from sid exist or not.
-func (fp *FileProvider) SessionExist(sid string) bool {
+func (fp *FileProvider) SessionExist(sid string) (bool, error) {
filepder.lock.Lock()
defer filepder.lock.Unlock()
if len(sid) < 2 {
SLogger.Println("min length of session id is 2", sid)
- return false
+ return false, nil
}
_, err := os.Stat(path.Join(fp.savePath, string(sid[0]), string(sid[1]), sid))
- return err == nil
+ if err != nil {
+ return false, nil
+ }
+ return true, nil
}
// SessionDestroy Remove all files in this save path
diff --git a/session/sess_file_test.go b/session/sess_file_test.go
index 021c43fc..1e155f91 100644
--- a/session/sess_file_test.go
+++ b/session/sess_file_test.go
@@ -56,16 +56,24 @@ func TestFileProvider_SessionExist(t *testing.T) {
_ = fp.SessionInit(180, sessionPath)
- if fp.SessionExist(sid) {
+ exists, err := fp.SessionExist(sid)
+ if err != nil{
+ t.Error(err)
+ }
+ if exists {
t.Error()
}
- _, err := fp.SessionRead(sid)
+ _, err = fp.SessionRead(sid)
if err != nil {
t.Error(err)
}
- if !fp.SessionExist(sid) {
+ exists, err = fp.SessionExist(sid)
+ if err != nil {
+ t.Error(err)
+ }
+ if !exists {
t.Error()
}
}
@@ -79,15 +87,27 @@ func TestFileProvider_SessionExist2(t *testing.T) {
_ = fp.SessionInit(180, sessionPath)
- if fp.SessionExist(sid) {
+ exists, err := fp.SessionExist(sid)
+ if err != nil {
+ t.Error(err)
+ }
+ if exists {
t.Error()
}
- if fp.SessionExist("") {
+ exists, err = fp.SessionExist("")
+ if err != nil {
+ t.Error(err)
+ }
+ if exists {
t.Error()
}
- if fp.SessionExist("1") {
+ exists, err = fp.SessionExist("1")
+ if err != nil {
+ t.Error(err)
+ }
+ if exists {
t.Error()
}
}
@@ -171,7 +191,11 @@ func TestFileProvider_SessionRegenerate(t *testing.T) {
t.Error(err)
}
- if !fp.SessionExist(sid) {
+ exists, err := fp.SessionExist(sid)
+ if err != nil {
+ t.Error(err)
+ }
+ if !exists {
t.Error()
}
@@ -180,11 +204,19 @@ func TestFileProvider_SessionRegenerate(t *testing.T) {
t.Error(err)
}
- if fp.SessionExist(sid) {
+ exists, err = fp.SessionExist(sid)
+ if err != nil {
+ t.Error(err)
+ }
+ if exists {
t.Error()
}
- if !fp.SessionExist(sidNew) {
+ exists, err = fp.SessionExist(sidNew)
+ if err != nil {
+ t.Error(err)
+ }
+ if !exists {
t.Error()
}
}
@@ -203,7 +235,11 @@ func TestFileProvider_SessionDestroy(t *testing.T) {
t.Error(err)
}
- if !fp.SessionExist(sid) {
+ exists, err := fp.SessionExist(sid)
+ if err != nil {
+ t.Error(err)
+ }
+ if !exists {
t.Error()
}
@@ -212,7 +248,11 @@ func TestFileProvider_SessionDestroy(t *testing.T) {
t.Error(err)
}
- if fp.SessionExist(sid) {
+ exists, err = fp.SessionExist(sid)
+ if err != nil {
+ t.Error(err)
+ }
+ if exists {
t.Error()
}
}
diff --git a/session/sess_mem.go b/session/sess_mem.go
index 64d8b056..bd69ff80 100644
--- a/session/sess_mem.go
+++ b/session/sess_mem.go
@@ -109,13 +109,13 @@ func (pder *MemProvider) SessionRead(sid string) (Store, error) {
}
// SessionExist check session store exist in memory session by sid
-func (pder *MemProvider) SessionExist(sid string) bool {
+func (pder *MemProvider) SessionExist(sid string) (bool, error) {
pder.lock.RLock()
defer pder.lock.RUnlock()
if _, ok := pder.sessions[sid]; ok {
- return true
+ return true, nil
}
- return false
+ return false, nil
}
// SessionRegenerate generate new sid for session store in memory session
diff --git a/session/session.go b/session/session.go
index eb85360a..92e35de4 100644
--- a/session/session.go
+++ b/session/session.go
@@ -56,7 +56,7 @@ type Store interface {
type Provider interface {
SessionInit(gclifetime int64, config string) error
SessionRead(sid string) (Store, error)
- SessionExist(sid string) bool
+ SessionExist(sid string) (bool, error)
SessionRegenerate(oldsid, sid string) (Store, error)
SessionDestroy(sid string) error
SessionAll() int //get all active session
@@ -211,8 +211,14 @@ func (manager *Manager) SessionStart(w http.ResponseWriter, r *http.Request) (se
return nil, errs
}
- if sid != "" && manager.provider.SessionExist(sid) {
- return manager.provider.SessionRead(sid)
+ if sid != "" {
+ exists, err := manager.provider.SessionExist(sid)
+ if err != nil {
+ return nil, err
+ }
+ if exists {
+ return manager.provider.SessionRead(sid)
+ }
}
// Generate a new session
diff --git a/session/ssdb/sess_ssdb.go b/session/ssdb/sess_ssdb.go
index de0c6360..9b9eee94 100644
--- a/session/ssdb/sess_ssdb.go
+++ b/session/ssdb/sess_ssdb.go
@@ -68,7 +68,7 @@ func (p *Provider) SessionRead(sid string) (session.Store, error) {
}
// SessionExist judged whether sid is exist in session
-func (p *Provider) SessionExist(sid string) bool {
+func (p *Provider) SessionExist(sid string) (bool, error) {
if p.client == nil {
if err := p.connectInit(); err != nil {
panic(err)
@@ -76,12 +76,12 @@ func (p *Provider) SessionExist(sid string) bool {
}
value, err := p.client.Get(sid)
if err != nil {
- panic(err)
+ return false, err
}
if value == nil || len(value.(string)) == 0 {
- return false
+ return false, nil
}
- return true
+ return true, nil
}
// SessionRegenerate regenerate session with new sid and delete oldsid