refactor: improved TokenValidator interface and implementations

Author: ralvarezdev

cache/logger.go

@@ -39,42 +39,34 @@ func (l *Logger) SetTokenToCacheFailed(err error) {
 	)
 }
 
-// GetTokenFromCache logs the get token from cache event
-func (l *Logger) GetTokenFromCache(token gojwttoken.Token, id int64) {
+// RevokeTokenFromCache logs the revoke token from cache event
+func (l *Logger) RevokeTokenFromCache(token gojwttoken.Token, id int64) {
 	l.logger.Debug(
-		"get token from cache",
+		"revoke token from cache",
 		fmt.Sprintf("token: %s, id: %d", token, id),
 	)
 }
 
-// GetTokenFromCacheFailed logs the get token from cache failed event
-func (l *Logger) GetTokenFromCacheFailed(err error) {
+// RevokeTokenFromCacheFailed logs the revoke token from cache failed event
+func (l *Logger) RevokeTokenFromCacheFailed(err error) {
 	l.logger.Error(
-		"get token from cache failed",
+		"revoke token from cache failed",
 		err,
 	)
 }
 
-// HasTokenInCacheFailed logs the has token in cache failed event
-func (l *Logger) HasTokenInCacheFailed(err error) {
-	l.logger.Error(
-		"has token in cache failed",
-		err,
-	)
-}
-
-// DeleteTokenFromCache logs the delete token from cache event
-func (l *Logger) DeleteTokenFromCache(token gojwttoken.Token, id int64) {
+// GetTokenFromCache logs the get token from cache event
+func (l *Logger) GetTokenFromCache(token gojwttoken.Token, id int64) {
 	l.logger.Debug(
-		"delete token from cache",
+		"get token from cache",
 		fmt.Sprintf("token: %s, id: %d", token, id),
 	)
 }
 
-// DeleteTokenFromCacheFailed logs the delete token from cache failed event
-func (l *Logger) DeleteTokenFromCacheFailed(err error) {
+// GetTokenFromCacheFailed logs the get token from cache failed event
+func (l *Logger) GetTokenFromCacheFailed(err error) {
 	l.logger.Error(
-		"delete token from cache failed",
+		"get token from cache failed",
 		err,
 	)
 }

cache/redis/validator.go

@@ -8,6 +8,7 @@ import (
 	gojwttoken "github.com/ralvarezdev/go-jwt/token"
 	gostringsadd "github.com/ralvarezdev/go-strings/add"
 	gostringsseparator "github.com/ralvarezdev/go-strings/separator"
+	"strconv"
 	"time"
 )
 
@@ -54,24 +55,17 @@ func (d *TokenValidatorService) GetKey(
 	), nil
 }
 
-// Set sets the token with the value and period
-func (d *TokenValidatorService) Set(
-	token gojwttoken.Token,
-	id string,
-	value interface{},
+// setWithFormattedKey sets the token with the value and expiration
+func (d *TokenValidatorService) setWithFormattedKey(
+	key string,
+	isValid bool,
 	expiresAt time.Time,
 ) error {
-	// Get the key
-	key, err := d.GetKey(token, id)
-	if err != nil {
-		return err
-	}
-
 	// Set the initial value
-	if err = d.redisClient.Set(
+	if err := d.redisClient.Set(
 		context.Background(),
 		key,
-		value,
+		isValid,
 		0,
 	).Err(); err != nil {
 		// Log the error
@@ -82,7 +76,7 @@ func (d *TokenValidatorService) Set(
 	}
 
 	// Set expiration time for the key as a UNIX timestamp
-	err = d.redisClient.ExpireAt(context.Background(), key, expiresAt).Err()
+	err := d.redisClient.ExpireAt(context.Background(), key, expiresAt).Err()
 	if err != nil {
 		// Log the error
 		if d.logger != nil {
@@ -92,76 +86,71 @@ func (d *TokenValidatorService) Set(
 	return err
 }
 
-// Has checks if the token is valid
-func (d *TokenValidatorService) Has(
+// Set sets the token with the value and expiration
+func (d *TokenValidatorService) Set(
 	token gojwttoken.Token,
 	id string,
-) (bool, error) {
+	isValid bool,
+	expiresAt time.Time,
+) error {
 	// Get the key
 	key, err := d.GetKey(token, id)
 	if err != nil {
-		return false, err
+		return err
 	}
 
-	// Check the JWT Identifier
-	_, err = d.redisClient.Get(context.Background(), key).Result()
-	if err != nil {
-		// Log the error
-		if d.logger != nil {
-			d.logger.HasTokenInCacheFailed(err)
-		}
-		return false, err
-	}
-	return true, nil
+	return d.setWithFormattedKey(key, isValid, expiresAt)
 }
 
-// Get gets the token
-func (d *TokenValidatorService) Get(
+// Revoke revokes the token
+func (d *TokenValidatorService) Revoke(
 	token gojwttoken.Token,
 	id string,
-) (interface{}, error) {
+) error {
 	// Get the key
 	key, err := d.GetKey(token, id)
 	if err != nil {
-		return nil, err
+		return err
 	}
 
-	// Get the value
-	value, err := d.redisClient.Get(
-		context.Background(),
-		key,
-	).Result()
+	// Get the current TTL of the key
+	ttl, err := d.redisClient.TTL(context.Background(), key).Result()
 	if err != nil {
-		// Log the error
-		if d.logger != nil {
-			d.logger.GetTokenFromCacheFailed(err)
-		}
-		return nil, err
+		return err
 	}
-	return value, err
+
+	// Update the value maintaining the TTL
+	return d.setWithFormattedKey(key, false, time.Now().Add(ttl))
 }
 
-// Delete deletes the token
-func (d *TokenValidatorService) Delete(
+// IsValid checks if the token is valid
+func (d *TokenValidatorService) IsValid(
 	token gojwttoken.Token,
 	id string,
-) error {
+) (bool, error) {
 	// Get the key
 	key, err := d.GetKey(token, id)
 	if err != nil {
-		return err
+		return false, err
 	}
 
-	// Delete the key
-	err = d.redisClient.Del(
+	// Get the value
+	isValid, err := d.redisClient.Get(
 		context.Background(),
 		key,
-	).Err()
+	).Result()
 	if err != nil {
 		// Log the error
 		if d.logger != nil {
-			d.logger.DeleteTokenFromCacheFailed(err)
+			d.logger.GetTokenFromCacheFailed(err)
 		}
+		return false, err
 	}
-	return err
+
+	// Parse the value
+	parsedIsValue, err := strconv.ParseBool(isValid)
+	if err != nil {
+		return false, err
+	}
+	return parsedIsValue, nil
 }

cache/validator.go

@@ -1,6 +1,7 @@
 package cache
 
 import (
+	gocache "github.com/ralvarezdev/go-cache"
 	gocachetimed "github.com/ralvarezdev/go-cache/timed"
 	gojwttoken "github.com/ralvarezdev/go-jwt/token"
 	gostringsadd "github.com/ralvarezdev/go-strings/add"
@@ -14,25 +15,24 @@ type (
 		Set(
 			token gojwttoken.Token,
 			id string,
-			value interface{},
+			isValid bool,
 			expiresAt time.Time,
 		) error
-		Has(token gojwttoken.Token, id string) (bool, error)
-		Get(token gojwttoken.Token, id string) (interface{}, bool)
-		Delete(token gojwttoken.Token, id string) error
+		Revoke(token gojwttoken.Token, id string) error
+		IsValid(token gojwttoken.Token, id string) (bool, error)
 	}
 
 	// TokenValidatorService struct
 	TokenValidatorService struct {
 		logger *Logger
-		gocachetimed.Cache
+		cache  gocachetimed.Cache
 	}
 )
 
 // NewTokenValidatorService creates a new token validator service
 func NewTokenValidatorService(logger *Logger) *TokenValidatorService {
 	return &TokenValidatorService{
-		Cache:  gocachetimed.Cache{},
+		cache:  gocachetimed.Cache{},
 		logger: logger,
 	}
 }
@@ -55,7 +55,7 @@ func (t *TokenValidatorService) GetKey(
 func (t *TokenValidatorService) Set(
 	token gojwttoken.Token,
 	id string,
-	value interface{},
+	isValid bool,
 	expiresAt time.Time,
 ) error {
 	// Get the key
@@ -65,7 +65,7 @@ func (t *TokenValidatorService) Set(
 	}
 
 	// Set the token in the cache
-	err = t.Cache.Set(key, gocachetimed.NewItem(value, expiresAt))
+	err = t.cache.Set(key, gocachetimed.NewItem(isValid, expiresAt))
 	if err != nil {
 		// Log the error
 		if t.logger != nil {
@@ -75,48 +75,43 @@ func (t *TokenValidatorService) Set(
 	return err
 }
 
-// Has checks if a token exists in the cache
-func (t *TokenValidatorService) Has(
+// Revoke revokes a token in the cache
+func (t *TokenValidatorService) Revoke(
 	token gojwttoken.Token,
 	id string,
-) (bool, error) {
+) error {
 	// Get the key
 	key, err := t.GetKey(token, id)
 	if err != nil {
-		return false, err
+		return err
 	}
 
-	// Check if the token exists in the cache
-	return t.Cache.Has(key), nil
-}
-
-// Get gets a token from the cache
-func (t *TokenValidatorService) Get(
-	token gojwttoken.Token,
-	id string,
-) (interface{}, bool) {
-	// Get the key
-	key, err := t.GetKey(token, id)
+	// Revoke the token in the cache
+	err = t.cache.UpdateValue(key, false)
 	if err != nil {
-		return nil, false
+		// Log the error
+		if t.logger != nil {
+			t.logger.RevokeTokenFromCacheFailed(err)
+		}
 	}
-
-	// Get the token from the cache
-	return t.Cache.Get(key)
+	return err
 }
 
-// Delete deletes a token from the cache
-func (t *TokenValidatorService) Delete(
+// IsValid checks if a token is valid in the cache
+func (t *TokenValidatorService) IsValid(
 	token gojwttoken.Token,
 	id string,
-) error {
+) (bool, error) {
 	// Get the key
 	key, err := t.GetKey(token, id)
 	if err != nil {
-		return err
+		return false, err
 	}
 
-	// Delete the token from the cache
-	t.Cache.Delete(key)
-	return nil
+	// Get the token from the cache
+	isValid, found := t.cache.Get(key)
+	if !found {
+		return false, gocache.ErrItemNotFound
+	}
+	return isValid.(bool), nil
 }

go.mod

@@ -6,7 +6,7 @@ require (
 	github.com/gin-gonic/gin v1.10.0
 	github.com/go-redis/redis/v8 v8.11.5
 	github.com/golang-jwt/jwt/v5 v5.2.1
-	github.com/ralvarezdev/go-cache v0.1.0
+	github.com/ralvarezdev/go-cache v0.1.1
 	github.com/ralvarezdev/go-databases v0.4.13
 	github.com/ralvarezdev/go-flags v0.3.1
 	github.com/ralvarezdev/go-logger v0.4.5

go.sum

@@ -63,8 +63,8 @@ github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6
 github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/ralvarezdev/go-cache v0.1.0 h1:yZeWQ8BKsHIU0tkhgOrnaIa+Ayt63cLn0l7ha3uBPZs=
-github.com/ralvarezdev/go-cache v0.1.0/go.mod h1:uxdoDOgKOj0tQReWRA7rc1RtiFPhg8tfzVK6nJJ7QKo=
+github.com/ralvarezdev/go-cache v0.1.1 h1:Gd+F6ghWEDNUG/EYtVOiYPnw6rV3aXenpnkEXBvZTUA=
+github.com/ralvarezdev/go-cache v0.1.1/go.mod h1:uxdoDOgKOj0tQReWRA7rc1RtiFPhg8tfzVK6nJJ7QKo=
 github.com/ralvarezdev/go-databases v0.4.13 h1:thB7s0XwOTfAumUFDbelABH77NesyMOJI1VX3If1dw4=
 github.com/ralvarezdev/go-databases v0.4.13/go.mod h1:JOUqccAyW1lAriqYEkUmvAtMeraAsAeT71gw0xj0vhc=
 github.com/ralvarezdev/go-flags v0.3.1 h1:YxGYUonmr0dwJL+9oDY/4GqCl1CYwYDJExpGXXMc9rU=