From fb5ab81be5d060e54c988140527c370cb4880b47 Mon Sep 17 00:00:00 2001
From: Mohammed Sohail <sohailsameja@gmail.com>
Date: Fri, 17 Feb 2023 11:43:20 +0300
Subject: [PATCH] docs: pkg inline

---
 pkg/logg/asynq.go    |  1 +
 pkg/logg/goredis.go  | 21 ---------------------
 pkg/logg/pgx.go      | 22 ----------------------
 pkg/postgres/pool.go | 10 +---------
 pkg/redis/pool.go    | 11 ++++-------
 pkg/status/status.go |  2 ++
 6 files changed, 8 insertions(+), 59 deletions(-)
 delete mode 100644 pkg/logg/goredis.go
 delete mode 100644 pkg/logg/pgx.go

diff --git a/pkg/logg/asynq.go b/pkg/logg/asynq.go
index 4ad8594..ab85ce5 100644
--- a/pkg/logg/asynq.go
+++ b/pkg/logg/asynq.go
@@ -6,6 +6,7 @@ type AsynqLogg struct {
 	logg *logf.Logger
 }
 
+// NewAsynqLogg creates a logf based logging adapter for asynq.
 func NewAsynqLogg(lo logf.Logger) AsynqLogg {
 	return AsynqLogg{
 		logg: &lo,
diff --git a/pkg/logg/goredis.go b/pkg/logg/goredis.go
deleted file mode 100644
index ef67937..0000000
--- a/pkg/logg/goredis.go
+++ /dev/null
@@ -1,21 +0,0 @@
-package logg
-
-import (
-	"context"
-
-	"github.com/zerodha/logf"
-)
-
-type RedisLogg struct {
-	logg *logf.Logger
-}
-
-func NewRedisTraceLogg(lo logf.Logger) RedisLogg {
-	return RedisLogg{
-		logg: &lo,
-	}
-}
-
-func (l RedisLogg) Printf(ctx context.Context, format string, v ...interface{}) {
-	l.logg.Debug("redis", "debug", "format", format, "data", v)
-}
diff --git a/pkg/logg/pgx.go b/pkg/logg/pgx.go
deleted file mode 100644
index 3ac3605..0000000
--- a/pkg/logg/pgx.go
+++ /dev/null
@@ -1,22 +0,0 @@
-package logg
-
-import (
-	"context"
-
-	"github.com/jackc/pgx/v5/tracelog"
-	"github.com/zerodha/logf"
-)
-
-type PgxLogg struct {
-	logg *logf.Logger
-}
-
-func NewPgxTraceLogg(lo logf.Logger) PgxLogg {
-	return PgxLogg{
-		logg: &lo,
-	}
-}
-
-func (l PgxLogg) Log(ctx context.Context, level tracelog.LogLevel, msg string, data map[string]any) {
-	l.logg.Debug("pgx", "level", level, "msg", msg, "data", data)
-}
diff --git a/pkg/postgres/pool.go b/pkg/postgres/pool.go
index b065222..66af5db 100644
--- a/pkg/postgres/pool.go
+++ b/pkg/postgres/pool.go
@@ -9,23 +9,15 @@ import (
 
 type PostgresPoolOpts struct {
 	DSN string
-	// Debug bool
-	// Logg  tracelog.Logger
 }
 
+// NewPostgresPool creates a reusbale connection pool across the cic-custodial component.
 func NewPostgresPool(o PostgresPoolOpts) (*pgxpool.Pool, error) {
 	parsedConfig, err := pgxpool.ParseConfig(o.DSN)
 	if err != nil {
 		return nil, err
 	}
 
-	// if o.Debug {
-	// 	parsedConfig.ConnConfig.Tracer = &tracelog.TraceLog{
-	// 		Logger:   o.Logg,
-	// 		LogLevel: tracelog.LogLevelDebug,
-	// 	}
-	// }
-
 	dbPool, err := pgxpool.NewWithConfig(context.Background(), parsedConfig)
 	if err != nil {
 		return nil, err
diff --git a/pkg/redis/pool.go b/pkg/redis/pool.go
index 7af60e9..f65a9d7 100644
--- a/pkg/redis/pool.go
+++ b/pkg/redis/pool.go
@@ -8,9 +8,7 @@ import (
 )
 
 type RedisPoolOpts struct {
-	DSN string
-	// Debug        bool
-	// Logg         logg.RedisLogg
+	DSN          string
 	MinIdleConns int
 }
 
@@ -18,6 +16,8 @@ type RedisPool struct {
 	Client *redis.Client
 }
 
+// NewRedisPool creates a reusable connection across the cic-custodial componenent.
+// Note: Each db namespace requires its own connection pool.
 func NewRedisPool(o RedisPoolOpts) (*RedisPool, error) {
 	redisOpts, err := redis.ParseURL(o.DSN)
 	if err != nil {
@@ -28,10 +28,6 @@ func NewRedisPool(o RedisPoolOpts) (*RedisPool, error) {
 
 	redisClient := redis.NewClient(redisOpts)
 
-	// if o.Debug {
-	// 	redis.SetLogger(o.Logg)
-	// }
-
 	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
 	defer cancel()
 
@@ -45,6 +41,7 @@ func NewRedisPool(o RedisPoolOpts) (*RedisPool, error) {
 	}, nil
 }
 
+// Interface adapter for asynq to resuse the same Redis connection pool.
 func (r *RedisPool) MakeRedisClient() interface{} {
 	return r.Client
 }
diff --git a/pkg/status/status.go b/pkg/status/status.go
index 189dd53..cc01d90 100644
--- a/pkg/status/status.go
+++ b/pkg/status/status.go
@@ -1,5 +1,7 @@
 package status
 
+// Status represents enum-like values received in the dispatcher from the RPC node.
+// It includes a subset of well-known and likely failures the dispatcher may encounter.
 type Status string
 
 const (