Support Redis 6.0 explicitly #4778

ref DEV-2129

docker-compose.yaml

@@ -15,8 +15,8 @@ services:
       - "5432:5432"
 
   redis:
-    # redis:6.0 crashed randomly when I run k6 load test.
-    image: redis:6.2.6
+    # Azure cache for Redis supports 6.0 only
+    image: redis:6.0.20
     volumes:
       - redis_data:/data
     ports:

pkg/auth/webapp/error_service.go

@@ -7,10 +7,9 @@ import (
 	"net/http"
 	"net/url"
 
-	goredis "github.com/go-redis/redis/v8"
-
 	"github.com/authgear/authgear-server/pkg/api/apierrors"
 	"github.com/authgear/authgear-server/pkg/lib/config"
+	"github.com/authgear/authgear-server/pkg/lib/infra/redis"
 	"github.com/authgear/authgear-server/pkg/lib/infra/redis/appredis"
 	"github.com/authgear/authgear-server/pkg/util/crypto"
 	"github.com/authgear/authgear-server/pkg/util/duration"
@@ -76,7 +75,7 @@ func (c *ErrorService) GetRecoverableError(r *http.Request) (*ErrorState, bool)
 
 	var redisValue string
 	var err error
-	err = c.RedisHandle.WithConnContext(r.Context(), func(conn *goredis.Conn) error {
+	err = c.RedisHandle.WithConnContext(r.Context(), func(conn redis.Redis_6_0_Cmdable) error {
 		redisValue, err = conn.Get(r.Context(), redisKey).Result()
 		return err
 	})
@@ -109,9 +108,18 @@ func (c *ErrorService) GetDelRecoverableError(w http.ResponseWriter, r *http.Req
 
 	var redisValue string
 	var err error
-	err = c.RedisHandle.WithConnContext(r.Context(), func(conn *goredis.Conn) error {
-		redisValue, err = conn.GetDel(r.Context(), redisKey).Result()
-		return err
+	err = c.RedisHandle.WithConnContext(r.Context(), func(conn redis.Redis_6_0_Cmdable) error {
+		redisValue, err = conn.Get(r.Context(), redisKey).Result()
+		if err != nil {
+			return err
+		}
+
+		_, err = conn.Del(r.Context(), redisKey).Result()
+		if err != nil {
+			return err
+		}
+
+		return nil
 	})
 	if err != nil {
 		return nil, false
@@ -165,7 +173,7 @@ func (c *ErrorService) SetRecoverableError(r *http.Request, value *apierrors.API
 	}
 
 	redisValue := string(dataBytes)
-	err = c.RedisHandle.WithConnContext(r.Context(), func(conn *goredis.Conn) error {
+	err = c.RedisHandle.WithConnContext(r.Context(), func(conn redis.Redis_6_0_Cmdable) error {
 		_, err := conn.Set(r.Context(), redisKey, redisValue, duration.WebError).Result()
 		return err
 	})

pkg/auth/webapp/session_store.go

@@ -9,6 +9,7 @@ import (
 	goredis "github.com/go-redis/redis/v8"
 
 	"github.com/authgear/authgear-server/pkg/lib/config"
+	"github.com/authgear/authgear-server/pkg/lib/infra/redis"
 	"github.com/authgear/authgear-server/pkg/lib/infra/redis/appredis"
 	"github.com/authgear/authgear-server/pkg/lib/interaction"
 )
@@ -28,7 +29,7 @@ func (s *SessionStoreRedis) Create(session *Session) (err error) {
 		return
 	}
 
-	err = s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err = s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		ttl := SessionExpiryDuration
 		_, err = conn.SetNX(ctx, key, bytes, ttl).Result()
 		if errors.Is(err, goredis.Nil) {
@@ -50,7 +51,7 @@ func (s *SessionStoreRedis) Update(session *Session) (err error) {
 		return
 	}
 
-	err = s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err = s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		ttl := SessionExpiryDuration
 		_, err = conn.SetXX(ctx, key, bytes, ttl).Result()
 		if errors.Is(err, goredis.Nil) {
@@ -67,7 +68,7 @@ func (s *SessionStoreRedis) Update(session *Session) (err error) {
 func (s *SessionStoreRedis) Get(id string) (session *Session, err error) {
 	ctx := context.Background()
 	key := sessionKey(string(s.AppID), id)
-	err = s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err = s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		data, err := conn.Get(ctx, key).Bytes()
 		if errors.Is(err, goredis.Nil) {
 			err = ErrInvalidSession
@@ -90,7 +91,7 @@ func (s *SessionStoreRedis) Get(id string) (session *Session, err error) {
 func (s *SessionStoreRedis) Delete(id string) error {
 	ctx := context.Background()
 	key := sessionKey(string(s.AppID), id)
-	err := s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err := s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		_, err := conn.Del(ctx, key).Result()
 		return err
 	})

pkg/lib/accountmanagement/redis_store.go

@@ -9,6 +9,7 @@ import (
 	goredis "github.com/go-redis/redis/v8"
 
 	"github.com/authgear/authgear-server/pkg/lib/config"
+	"github.com/authgear/authgear-server/pkg/lib/infra/redis"
 	"github.com/authgear/authgear-server/pkg/lib/infra/redis/appredis"
 	"github.com/authgear/authgear-server/pkg/util/clock"
 	"github.com/authgear/authgear-server/pkg/util/duration"
@@ -54,7 +55,7 @@ func (s *RedisStore) GenerateToken(options GenerateTokenOptions) (string, error)
 
 	tokenKey := tokenKey(token.AppID, token.TokenHash)
 
-	err = s.Redis.WithConnContext(s.Context, func(conn *goredis.Conn) error {
+	err = s.Redis.WithConnContext(s.Context, func(conn redis.Redis_6_0_Cmdable) error {
 		_, err = conn.SetNX(s.Context, tokenKey, tokenBytes, ttl).Result()
 		if errors.Is(err, goredis.Nil) {
 			return errors.New("account management token collision")
@@ -76,15 +77,21 @@ func (s *RedisStore) ConsumeToken(tokenStr string) (*Token, error) {
 	tokenKey := tokenKey(string(s.AppID), tokenHash)
 
 	var tokenBytes []byte
-	err := s.Redis.WithConnContext(s.Context, func(conn *goredis.Conn) error {
+	err := s.Redis.WithConnContext(s.Context, func(conn redis.Redis_6_0_Cmdable) error {
 		var err error
-		tokenBytes, err = conn.GetDel(s.Context, tokenKey).Bytes()
+		tokenBytes, err = conn.Get(s.Context, tokenKey).Bytes()
 		if errors.Is(err, goredis.Nil) {
 			// Token Invalid
 			return ErrOAuthTokenInvalid
 		} else if err != nil {
 			return err
 		}
+
+		_, err = conn.Del(s.Context, tokenKey).Result()
+		if err != nil {
+			return err
+		}
+
 		return nil
 	})
 	if err != nil {

pkg/lib/authenticationflow/store.go

@@ -9,6 +9,7 @@ import (
 	goredis "github.com/go-redis/redis/v8"
 
 	"github.com/authgear/authgear-server/pkg/lib/config"
+	"github.com/authgear/authgear-server/pkg/lib/infra/redis"
 	"github.com/authgear/authgear-server/pkg/lib/infra/redis/appredis"
 	"github.com/authgear/authgear-server/pkg/util/duration"
 )
@@ -27,7 +28,7 @@ func (s *StoreImpl) CreateFlow(flow *Flow) error {
 		return err
 	}
 
-	return s.Redis.WithConn(func(conn *goredis.Conn) error {
+	return s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		flowKey := redisFlowKey(s.AppID, flow.FlowID)
 		stateKey := redisFlowStateKey(s.AppID, flow.StateToken)
 		ttl := Lifetime
@@ -49,7 +50,7 @@ func (s *StoreImpl) CreateFlow(flow *Flow) error {
 func (s *StoreImpl) GetFlowByStateToken(stateToken string) (*Flow, error) {
 	stateKey := redisFlowStateKey(s.AppID, stateToken)
 	var flow Flow
-	err := s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err := s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		bytes, err := conn.Get(s.Context, stateKey).Bytes()
 		if errors.Is(err, goredis.Nil) {
 			return ErrFlowNotFound
@@ -80,7 +81,7 @@ func (s *StoreImpl) GetFlowByStateToken(stateToken string) (*Flow, error) {
 func (s *StoreImpl) DeleteFlow(flow *Flow) error {
 	// We do not delete the states because there are many of them.
 	// Deleting the flowID is enough to make GetFlowByStateToken to return ErrFlowNotFound.
-	return s.Redis.WithConn(func(conn *goredis.Conn) error {
+	return s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		flowKey := redisFlowKey(s.AppID, flow.FlowID)
 
 		_, err := conn.Del(s.Context, flowKey).Result()
@@ -98,7 +99,7 @@ func (s *StoreImpl) CreateSession(session *Session) error {
 		return err
 	}
 
-	return s.Redis.WithConn(func(conn *goredis.Conn) error {
+	return s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		sessionKey := redisFlowSessionKey(s.AppID, session.FlowID)
 		ttl := Lifetime
 
@@ -114,7 +115,7 @@ func (s *StoreImpl) CreateSession(session *Session) error {
 func (s *StoreImpl) GetSession(flowID string) (*Session, error) {
 	sessionKey := redisFlowSessionKey(s.AppID, flowID)
 	var session Session
-	err := s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err := s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		bytes, err := conn.Get(s.Context, sessionKey).Bytes()
 		if errors.Is(err, goredis.Nil) {
 			return ErrFlowNotFound
@@ -139,7 +140,7 @@ func (s *StoreImpl) UpdateSession(session *Session) error {
 		return err
 	}
 
-	return s.Redis.WithConn(func(conn *goredis.Conn) error {
+	return s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		sessionKey := redisFlowSessionKey(s.AppID, session.FlowID)
 
 		ttl := Lifetime
@@ -153,7 +154,7 @@ func (s *StoreImpl) UpdateSession(session *Session) error {
 }
 
 func (s *StoreImpl) DeleteSession(session *Session) error {
-	return s.Redis.WithConn(func(conn *goredis.Conn) error {
+	return s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		sessionKey := redisFlowSessionKey(s.AppID, session.FlowID)
 
 		_, err := conn.Del(s.Context, sessionKey).Result()

pkg/lib/authn/authenticationinfo/store_redis.go

@@ -9,6 +9,7 @@ import (
 	goredis "github.com/go-redis/redis/v8"
 
 	"github.com/authgear/authgear-server/pkg/lib/config"
+	"github.com/authgear/authgear-server/pkg/lib/infra/redis"
 	"github.com/authgear/authgear-server/pkg/lib/infra/redis/appredis"
 	"github.com/authgear/authgear-server/pkg/util/duration"
 )
@@ -29,7 +30,7 @@ func (s *StoreRedis) Save(entry *Entry) (err error) {
 
 	key := authenticationInfoEntryKey(s.AppID, entry.ID)
 
-	err = s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err = s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		_, err := conn.Set(s.Context, key, jsonBytes, ttl).Result()
 		return err
 	})
@@ -42,7 +43,7 @@ func (s *StoreRedis) Save(entry *Entry) (err error) {
 
 func (s *StoreRedis) Get(entryID string) (entry *Entry, err error) {
 	key := authenticationInfoEntryKey(s.AppID, entryID)
-	err = s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err = s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		data, err := conn.Get(s.Context, key).Bytes()
 		if errors.Is(err, goredis.Nil) {
 			return ErrNotFound
@@ -62,7 +63,7 @@ func (s *StoreRedis) Get(entryID string) (entry *Entry, err error) {
 
 func (s *StoreRedis) Delete(entryID string) (err error) {
 	key := authenticationInfoEntryKey(s.AppID, entryID)
-	return s.Redis.WithConn(func(conn *goredis.Conn) error {
+	return s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		_, err := conn.Del(s.Context, key).Result()
 		if err != nil {
 			return err

pkg/lib/authn/challenge/provider.go

@@ -9,6 +9,7 @@ import (
 	goredis "github.com/go-redis/redis/v8"
 
 	"github.com/authgear/authgear-server/pkg/lib/config"
+	"github.com/authgear/authgear-server/pkg/lib/infra/redis"
 	"github.com/authgear/authgear-server/pkg/lib/infra/redis/appredis"
 	"github.com/authgear/authgear-server/pkg/util/clock"
 )
@@ -36,7 +37,7 @@ func (p *Provider) Create(purpose Purpose) (*Challenge, error) {
 		return nil, err
 	}
 
-	err = p.Redis.WithConn(func(conn *goredis.Conn) error {
+	err = p.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		_, err = conn.SetNX(ctx, key, data, ttl).Result()
 		if errors.Is(err, goredis.Nil) {
 			return errors.New("fail to create new challenge")
@@ -59,7 +60,7 @@ func (p *Provider) Get(token string) (*Challenge, error) {
 
 	c := &Challenge{}
 
-	err := p.Redis.WithConn(func(conn *goredis.Conn) error {
+	err := p.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		data, err := conn.Get(ctx, key).Bytes()
 		if errors.Is(err, goredis.Nil) {
 			return ErrInvalidChallenge
@@ -87,7 +88,7 @@ func (p *Provider) Consume(token string) (*Purpose, error) {
 
 	c := &Challenge{}
 
-	err := p.Redis.WithConn(func(conn *goredis.Conn) error {
+	err := p.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		data, err := conn.Get(ctx, key).Bytes()
 		if errors.Is(err, goredis.Nil) {
 			return ErrInvalidChallenge

pkg/lib/authn/identity/anonymous/store_redis.go

@@ -10,6 +10,7 @@ import (
 	goredis "github.com/go-redis/redis/v8"
 
 	"github.com/authgear/authgear-server/pkg/lib/config"
+	"github.com/authgear/authgear-server/pkg/lib/infra/redis"
 	"github.com/authgear/authgear-server/pkg/lib/infra/redis/appredis"
 	"github.com/authgear/authgear-server/pkg/util/clock"
 )
@@ -25,7 +26,7 @@ type StoreRedis struct {
 
 func (s *StoreRedis) GetPromotionCode(codeHash string) (*PromotionCode, error) {
 	c := &PromotionCode{}
-	err := s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err := s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		data, err := s.get(conn, promotionCodeKey(string(s.AppID), codeHash))
 		if err != nil {
 			return err
@@ -43,18 +44,18 @@ func (s *StoreRedis) GetPromotionCode(codeHash string) (*PromotionCode, error) {
 }
 
 func (s *StoreRedis) CreatePromotionCode(code *PromotionCode) error {
-	return s.Redis.WithConn(func(conn *goredis.Conn) error {
+	return s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		return s.save(conn, promotionCodeKey(code.AppID, code.CodeHash), code, code.ExpireAt)
 	})
 }
 
 func (s *StoreRedis) DeletePromotionCode(code *PromotionCode) error {
-	return s.Redis.WithConn(func(conn *goredis.Conn) error {
+	return s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		return s.del(conn, promotionCodeKey(code.AppID, code.CodeHash))
 	})
 }
 
-func (s *StoreRedis) get(conn *goredis.Conn, key string) ([]byte, error) {
+func (s *StoreRedis) get(conn redis.Redis_6_0_Cmdable, key string) ([]byte, error) {
 	ctx := context.Background()
 	data, err := conn.Get(ctx, key).Bytes()
 	if errors.Is(err, goredis.Nil) {
@@ -65,7 +66,7 @@ func (s *StoreRedis) get(conn *goredis.Conn, key string) ([]byte, error) {
 	return data, nil
 }
 
-func (s *StoreRedis) save(conn *goredis.Conn, key string, value interface{}, expireAt time.Time) error {
+func (s *StoreRedis) save(conn redis.Redis_6_0_Cmdable, key string, value interface{}, expireAt time.Time) error {
 	ctx := context.Background()
 	data, err := json.Marshal(value)
 	if err != nil {
@@ -82,7 +83,7 @@ func (s *StoreRedis) save(conn *goredis.Conn, key string, value interface{}, exp
 	return nil
 }
 
-func (s *StoreRedis) del(conn *goredis.Conn, key string) error {
+func (s *StoreRedis) del(conn redis.Redis_6_0_Cmdable, key string) error {
 	ctx := context.Background()
 	_, err := conn.Del(ctx, key).Result()
 	return err

pkg/lib/authn/mfa/store_device_token_redis.go

@@ -10,6 +10,7 @@ import (
 	goredis "github.com/go-redis/redis/v8"
 
 	"github.com/authgear/authgear-server/pkg/lib/config"
+	"github.com/authgear/authgear-server/pkg/lib/infra/redis"
 	"github.com/authgear/authgear-server/pkg/lib/infra/redis/appredis"
 	"github.com/authgear/authgear-server/pkg/util/clock"
 )
@@ -22,7 +23,7 @@ type StoreDeviceTokenRedis struct {
 
 func (s *StoreDeviceTokenRedis) Get(userID string, token string) (*DeviceToken, error) {
 	var deviceToken *DeviceToken
-	err := s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err := s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		ctx := context.Background()
 		key := redisDeviceTokensKey(s.AppID, userID)
 
@@ -63,7 +64,7 @@ func (s *StoreDeviceTokenRedis) Get(userID string, token string) (*DeviceToken,
 }
 
 func (s *StoreDeviceTokenRedis) Create(token *DeviceToken) error {
-	err := s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err := s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		ctx := context.Background()
 		key := redisDeviceTokensKey(s.AppID, token.UserID)
 
@@ -96,7 +97,7 @@ func (s *StoreDeviceTokenRedis) Create(token *DeviceToken) error {
 }
 
 func (s *StoreDeviceTokenRedis) DeleteAll(userID string) error {
-	err := s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err := s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		key := redisDeviceTokensKey(s.AppID, userID)
 		ctx := context.Background()
 		_, err := conn.Del(ctx, key).Result()
@@ -109,7 +110,7 @@ func (s *StoreDeviceTokenRedis) DeleteAll(userID string) error {
 func (s *StoreDeviceTokenRedis) HasTokens(userID string) (bool, error) {
 	hasTokens := false
 
-	err := s.Redis.WithConn(func(conn *goredis.Conn) error {
+	err := s.Redis.WithConn(func(conn redis.Redis_6_0_Cmdable) error {
 		ctx := context.Background()
 		key := redisDeviceTokensKey(s.AppID, userID)
 		_, err := conn.Get(ctx, key).Bytes()
@@ -127,7 +128,7 @@ func (s *StoreDeviceTokenRedis) HasTokens(userID string) (bool, error) {
 	return hasTokens, err
 }
 
-func (s *StoreDeviceTokenRedis) saveTokens(conn *goredis.Conn, key string, tokens map[string]*DeviceToken, ttl time.Duration) error {
+func (s *StoreDeviceTokenRedis) saveTokens(conn redis.Redis_6_0_Cmdable, key string, tokens map[string]*DeviceToken, ttl time.Duration) error {
 	ctx := context.Background()
 
 	if len(tokens) > 0 {