@rivascva/dt-idl 1.1.180 → 1.1.182

package/go/redis/baserdb.go

@@ -7,6 +7,8 @@ import (
 	"reflect"
 	"time"
 
+	"github.com/RivasCVA/dt-idl/go/log"
+
 	goredis "github.com/redis/go-redis/v9"
 )
 
@@ -29,30 +31,41 @@ type RDB interface {
 	Delete(ctx context.Context, key string) error
 	// Close closes the redis connection.
 	Close() error
+	// SetVerboseLog sets the verbose log.
+	// It is used to log the operations performed on the redis database.
+	// This is useful for debugging and monitoring.
+	SetVerboseLog(verboseLog log.Logger)
 }
 
 type BaseRDB struct {
-	client   *goredis.Client
-	database string
+	client     *goredis.Client
+	database   string
+	verboseLog log.Logger
 }
 
-func NewBaseRDB(address string, username string, password string, service string) RDB {
+func NewBaseRDB(url string, service string) (RDB, error) {
+	// parse the connection url
+	opts, err := goredis.ParseURL(url)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse the url: %w", err)
+	}
+
+	// create the redis client
+	client := goredis.NewClient(opts)
+
 	//exhaustruct:ignore - other fields are optional
-	client := goredis.NewClient(&goredis.Options{
-		Addr:     address,
-		Username: username,
-		Password: password,
-	})
 	return &BaseRDB{
-		client:   client,
-		database: service,
-	}
+		client:     client,
+		database:   service,
+		verboseLog: nil,
+	}, nil
 }
 
 func (r *BaseRDB) NewRDB(database string) RDB {
 	return &BaseRDB{
-		client:   r.client,
-		database: fmt.Sprintf("%s:%s", r.database, database),
+		client:     r.client,
+		database:   fmt.Sprintf("%s:%s", r.database, database),
+		verboseLog: r.verboseLog,
 	}
 }
 
@@ -69,6 +82,14 @@ func (r *BaseRDB) Set(ctx context.Context, key string, value any, expiration tim
 		return fmt.Errorf("failed to set the value in the redis client: %w", err)
 	}
 
+	// log the operation if the verbose log is not nil
+	if r.verboseLog != nil {
+		r.verboseLog.With(
+			"key", FormatKey(r.database, key),
+			"size_mb", float64(len(bytes))/1024/1024,
+		).Info(ctx, "method SET called")
+	}
+
 	return nil
 }
 
@@ -81,11 +102,13 @@ func (r *BaseRDB) MSet(ctx context.Context, entries map[string]any, expiration t
 	// build a flat list of arguments for the lua script: [k1, v1, k2, v2, ..., expire_sec]
 	// the last element is the TTL in seconds. Zero or negative expire means no TTL.
 	scriptArgs := make([]any, 0, (len(entries)*2)+1)
+	totalBytes := 0
 	for key, value := range entries {
 		bytes, err := json.Marshal(value)
 		if err != nil {
 			return fmt.Errorf("failed to marshal the value for key %s: %w", key, err)
 		}
+		totalBytes += len(bytes)
 		scriptArgs = append(scriptArgs, FormatKey(r.database, key), bytes)
 	}
 	scriptArgs = append(scriptArgs, int(expiration.Seconds()))
@@ -95,6 +118,15 @@ func (r *BaseRDB) MSet(ctx context.Context, entries map[string]any, expiration t
 	if err != nil {
 		return fmt.Errorf("failed to set the entries in the redis client: %w", err)
 	}
+
+	// log the operation if the verbose log is not nil
+	if r.verboseLog != nil {
+		r.verboseLog.With(
+			"num_keys", len(entries),
+			"size_mb", float64(totalBytes)/1024/1024,
+		).Info(ctx, "method MSET called")
+	}
+
 	return nil
 }
 
@@ -114,6 +146,14 @@ func (r *BaseRDB) Get(ctx context.Context, key string, dest any) error {
 		return fmt.Errorf("failed to unmarshal the value: %w", err)
 	}
 
+	// log the operation if the verbose log is not nil
+	if r.verboseLog != nil {
+		r.verboseLog.With(
+			"key", FormatKey(r.database, key),
+			"size_mb", float64(len(val))/1024/1024,
+		).Info(ctx, "method GET called")
+	}
+
 	return nil
 }
 
@@ -156,6 +196,7 @@ func (r *BaseRDB) MGet(ctx context.Context, keys []string, dests any) error {
 	}
 
 	// unmarshal the values into the given destinations
+	totalBytes := 0
 	for i, val := range vals {
 		if val == nil {
 			continue
@@ -164,6 +205,7 @@ func (r *BaseRDB) MGet(ctx context.Context, keys []string, dests any) error {
 		if !ok {
 			return fmt.Errorf("the value is not a string")
 		}
+		totalBytes += len(str)
 
 		// create a new value of the pointed-to type
 		pointedValue := reflect.New(pointedType).Elem()
@@ -179,6 +221,14 @@ func (r *BaseRDB) MGet(ctx context.Context, keys []string, dests any) error {
 		destsValue.Index(i).Set(ptrValue)
 	}
 
+	// log the operation if the verbose log is not nil
+	if r.verboseLog != nil {
+		r.verboseLog.With(
+			"num_keys", len(keys),
+			"size_mb", float64(totalBytes)/1024/1024,
+		).Info(ctx, "method MGET called")
+	}
+
 	return nil
 }
 
@@ -208,6 +258,14 @@ func (r *BaseRDB) GetKeysWithPattern(ctx context.Context, pattern string, window
 		}
 	}
 
+	// log the operation if the verbose log is not nil
+	if r.verboseLog != nil {
+		r.verboseLog.With(
+			"pattern", FormatKey(r.database, pattern),
+			"num_keys", len(result),
+		).Info(ctx, "method GET_KEYS_WITH_PATTERN called")
+	}
+
 	return result, nil
 }
 
@@ -218,6 +276,13 @@ func (r *BaseRDB) Delete(ctx context.Context, key string) error {
 		return fmt.Errorf("failed to delete the value from the redis client: %w", err)
 	}
 
+	// log the operation if the verbose log is not nil
+	if r.verboseLog != nil {
+		r.verboseLog.With(
+			"key", FormatKey(r.database, key),
+		).Info(ctx, "method DELETE called")
+	}
+
 	return nil
 }
 
@@ -231,5 +296,9 @@ func (r *BaseRDB) Close() error {
 	return nil
 }
 
+func (r *BaseRDB) SetVerboseLog(log log.Logger) {
+	r.verboseLog = log.With("name", "Redis Verbose Log")
+}
+
 //exhaustruct:ignore - check for interface implementation
 var _ RDB = &BaseRDB{}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivascva/dt-idl",
-  "version": "1.1.180",
+  "version": "1.1.182",
   "description": "Dream Trade - Interface Definition Language",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",