refactor(grpc): improve code quality and fix linter issues

- Fix naming inconsistencies and standardize method names
- Add package comments and fix formatting
- Fix linter warnings (lll, revive, varnamelen, noctx, etc.)
- Improve code organization and readability

Author: batazor

go.work.sum

@@ -1,3 +1,5 @@
+// Package grpc provides gRPC client and server implementations with
+// middleware support for logging, tracing, metrics, and session management.
 package grpc
 
 import (
@@ -12,6 +14,7 @@ import (
 	"google.golang.org/grpc/credentials/insecure"
 )
 
+// Client represents a gRPC client configuration.
 type Client struct {
 	interceptorUnaryClientList  []grpc.UnaryClientInterceptor
 	interceptorStreamClientList []grpc.StreamClientInterceptor
@@ -22,12 +25,18 @@ type Client struct {
 	cfg  *config.Config
 }
 
+// GetURI returns the connection URI in the format "host:port".
 func (c *Client) GetURI() string {
 	return fmt.Sprintf("%s:%d", c.host, c.port)
 }
 
-// InitClient - set up a connection to the server.
-func InitClient(_ context.Context, log logger.Logger, cfg *config.Config, options ...Option) (*grpc.ClientConn, func(), error) {
+// InitClient sets up a connection to the gRPC server.
+func InitClient(
+	_ context.Context,
+	log logger.Logger,
+	cfg *config.Config,
+	options ...Option,
+) (*grpc.ClientConn, func(), error) {
 	config, err := SetClientConfig(cfg, options...)
 	if err != nil {
 		return nil, nil, err
@@ -54,7 +63,7 @@ func InitClient(_ context.Context, log logger.Logger, cfg *config.Config, option
 	return conn, cleanup, nil
 }
 
-// SetClientConfig - set configuration
+// SetClientConfig - set configuration.
 func SetClientConfig(cfg *config.Config, options ...Option) (*Client, error) {
 	cfg.SetDefault("GRPC_CLIENT_PORT", "50051") // gRPC port
 	grpcPort := cfg.GetInt("GRPC_CLIENT_PORT")
@@ -70,7 +79,7 @@ func SetClientConfig(cfg *config.Config, options ...Option) (*Client, error) {
 
 	config.apply(options...)
 
-	// Initialize your gRPC server's interceptor.
+	// Initialize your gRPC client's interceptor.
 	config.optionsNewClient = append(
 		config.optionsNewClient,
 		grpc.WithChainUnaryInterceptor(config.interceptorUnaryClientList...),
@@ -91,7 +100,7 @@ func (c *Client) GetOptions() []grpc.DialOption {
 	return c.optionsNewClient
 }
 
-// withTLS - setup TLS
+// withTLS - setup TLS.
 func (c *Client) withTLS() error {
 	c.cfg.SetDefault("GRPC_CLIENT_TLS_ENABLED", false) // gRPC TLS
 	isEnableTLS := c.cfg.GetBool("GRPC_CLIENT_TLS_ENABLED")

grpc/client.go

@@ -4,72 +4,82 @@ import (
 	grpc_prometheus "github.com/grpc-ecosystem/go-grpc-middleware/providers/prometheus"
 	"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/timeout"
 	"github.com/prometheus/client_golang/prometheus"
+	grpc_logger "github.com/shortlink-org/go-sdk/grpc/middleware/logger"
+	session_interceptor "github.com/shortlink-org/go-sdk/grpc/middleware/session"
+	"github.com/shortlink-org/go-sdk/logger"
 	"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
 	api "go.opentelemetry.io/otel/sdk/metric"
 	"go.opentelemetry.io/otel/trace"
 	"google.golang.org/grpc"
-
-	grpc_logger "github.com/shortlink-org/go-sdk/grpc/middleware/logger"
-	session_interceptor "github.com/shortlink-org/go-sdk/grpc/middleware/session"
-	"github.com/shortlink-org/go-sdk/logger"
 )
 
+// Option configures a gRPC client.
 type Option func(*Client)
 
-// Apply a batch of options
+// Apply a batch of options.
 func (c *Client) apply(options ...Option) {
 	for _, option := range options {
 		option(c)
 	}
 }
 
-// WithTimeout sets a unary timeout interceptor
+// WithTimeout sets a unary timeout interceptor.
 func WithTimeout() Option {
-	return func(c *Client) {
-		c.cfg.SetDefault("GRPC_CLIENT_TIMEOUT", "10s") // Set timeout for gRPC-Client
-		timeoutClient := c.cfg.GetDuration("GRPC_CLIENT_TIMEOUT")
+	return func(client *Client) {
+		client.cfg.SetDefault("GRPC_CLIENT_TIMEOUT", "10s") // Set timeout for gRPC-Client
+		timeoutClient := client.cfg.GetDuration("GRPC_CLIENT_TIMEOUT")
 
-		c.interceptorUnaryClientList = append(
-			c.interceptorUnaryClientList,
+		client.interceptorUnaryClientList = append(
+			client.interceptorUnaryClientList,
 			timeout.UnaryClientInterceptor(timeoutClient),
 		)
 	}
 }
 
-// WithLogger adds unary & stream logging interceptors
+// WithLogger adds unary & stream logging interceptors.
 func WithLogger(log logger.Logger) Option {
-	return func(c *Client) {
-		c.cfg.SetDefault("GRPC_CLIENT_LOGGER_ENABLED", true) // Enable logging for gRPC-Client
-		isEnableLogger := c.cfg.GetBool("GRPC_CLIENT_LOGGER_ENABLED")
+	return func(client *Client) {
+		client.cfg.SetDefault("GRPC_CLIENT_LOGGER_ENABLED", true) // Enable logging for gRPC-Client
+
+		isEnableLogger := client.cfg.GetBool("GRPC_CLIENT_LOGGER_ENABLED")
 		if !isEnableLogger {
 			return
 		}
 
-		c.interceptorUnaryClientList = append(c.interceptorUnaryClientList, grpc_logger.UnaryClientInterceptor(log))
-		c.interceptorStreamClientList = append(c.interceptorStreamClientList, grpc_logger.StreamClientInterceptor(log))
+		client.interceptorUnaryClientList = append(
+			client.interceptorUnaryClientList,
+			grpc_logger.UnaryClientInterceptor(log),
+		)
+		client.interceptorStreamClientList = append(
+			client.interceptorStreamClientList,
+			grpc_logger.StreamClientInterceptor(log),
+		)
 	}
 }
 
-// WithTracer wires up otel handler
+// WithTracer wires up otel handler.
 func WithTracer(tracer trace.TracerProvider, prom *prometheus.Registry, metrics *api.MeterProvider) Option {
-	return func(c *Client) {
+	return func(client *Client) {
 		if tracer == nil || prom == nil {
 			return
 		}
 
-		c.optionsNewClient = append(c.optionsNewClient, grpc.WithStatsHandler(
-			otelgrpc.NewClientHandler(
-				otelgrpc.WithTracerProvider(tracer),
-				otelgrpc.WithMeterProvider(metrics),
-				otelgrpc.WithMessageEvents(otelgrpc.ReceivedEvents, otelgrpc.SentEvents),
+		client.optionsNewClient = append(
+			client.optionsNewClient,
+			grpc.WithStatsHandler(
+				otelgrpc.NewClientHandler(
+					otelgrpc.WithTracerProvider(tracer),
+					otelgrpc.WithMeterProvider(metrics),
+					otelgrpc.WithMessageEvents(otelgrpc.ReceivedEvents, otelgrpc.SentEvents),
+				),
 			),
-		))
+		)
 	}
 }
 
-// WithMetrics registers Prom metrics + interceptors
+// WithMetrics registers Prom metrics + interceptors.
 func WithMetrics(prom *prometheus.Registry) Option {
-	return func(c *Client) {
+	return func(client *Client) {
 		if prom == nil {
 			return
 		}
@@ -83,21 +93,34 @@ func WithMetrics(prom *prometheus.Registry) Option {
 		)
 		exemplarFromCtx := grpc_prometheus.WithExemplarFromContext(exemplarFromContext)
 
-		c.interceptorUnaryClientList = append(c.interceptorUnaryClientList, clientMetrics.UnaryClientInterceptor(exemplarFromCtx))
-		c.interceptorStreamClientList = append(c.interceptorStreamClientList, clientMetrics.StreamClientInterceptor(exemplarFromCtx))
+		client.interceptorUnaryClientList = append(
+			client.interceptorUnaryClientList,
+			clientMetrics.UnaryClientInterceptor(exemplarFromCtx),
+		)
+		client.interceptorStreamClientList = append(
+			client.interceptorStreamClientList,
+			clientMetrics.StreamClientInterceptor(exemplarFromCtx),
+		)
 
 		defer func() {
 			// ignore duplicate-registration panic
 			_ = recover()
 		}()
+
 		prom.MustRegister(clientMetrics)
 	}
 }
 
-// WithSession adds session interceptors with optional ignore rules
+// WithSession adds session interceptors with optional ignore rules.
 func WithSession() Option {
-	return func(c *Client) {
-		c.interceptorUnaryClientList = append(c.interceptorUnaryClientList, session_interceptor.SessionUnaryClientInterceptor())
-		c.interceptorStreamClientList = append(c.interceptorStreamClientList, session_interceptor.SessionStreamClientInterceptor())
+	return func(client *Client) {
+		client.interceptorUnaryClientList = append(
+			client.interceptorUnaryClientList,
+			session_interceptor.SessionUnaryClientInterceptor(),
+		)
+		client.interceptorStreamClientList = append(
+			client.interceptorStreamClientList,
+			session_interceptor.SessionStreamClientInterceptor(),
+		)
 	}
 }

grpc/client_options.go

@@ -1,3 +1,6 @@
+// Package flight_trace provides gRPC interceptors for flight recorder integration.
+//
+//nolint:revive // package name uses underscore for consistency with project structure
 package flight_trace
 
 import (
@@ -7,27 +10,30 @@ import (
 	"time"
 
 	"github.com/google/uuid"
+	"github.com/shortlink-org/go-sdk/config"
+	"github.com/shortlink-org/go-sdk/flight_trace"
+	"github.com/shortlink-org/go-sdk/logger"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/trace"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/metadata"
 	"google.golang.org/grpc/status"
-
-	"github.com/shortlink-org/go-sdk/config"
-	"github.com/shortlink-org/go-sdk/flight_trace"
-	"github.com/shortlink-org/go-sdk/logger"
 )
 
 const debugTraceKey = "X-DEBUG-TRACE"
 
 // UnaryServerInterceptor records Flight Recorder dumps based on conditions:
 // - Incoming metadata contains "X-DEBUG-TRACE: true"
-// - The request latency exceeds FLIGHT_TRACE_LATENCY_THRESHOLD
-func UnaryServerInterceptor(fr *flight_trace.Recorder, log logger.Logger, cfg *config.Config) grpc.UnaryServerInterceptor {
+// - The request latency exceeds FLIGHT_TRACE_LATENCY_THRESHOLD.
+func UnaryServerInterceptor(
+	flightRecorder *flight_trace.Recorder,
+	log logger.Logger,
+	cfg *config.Config,
+) grpc.UnaryServerInterceptor {
 	cfg.SetDefault("FLIGHT_TRACE_LATENCY_THRESHOLD", "1s")
 
 	return func(ctx context.Context, req any, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (any, error) {
-		if fr == nil {
+		if flightRecorder == nil {
 			return handler(ctx, req)
 		}
 
@@ -50,7 +56,7 @@ func UnaryServerInterceptor(fr *flight_trace.Recorder, log logger.Logger, cfg *c
 			}
 
 			go func() {
-				fr.DumpToFileAsync(fileName)
+				flightRecorder.DumpToFileAsync(fileName)
 				log.InfoWithContext(ctx, "flight recorder dump triggered",
 					slog.String("file", fileName),
 					slog.String("grpc.service", path.Dir(info.FullMethod)[1:]),
@@ -66,11 +72,15 @@ func UnaryServerInterceptor(fr *flight_trace.Recorder, log logger.Logger, cfg *c
 }
 
 // StreamServerInterceptor is similar to UnaryServerInterceptor but for streaming RPCs.
-func StreamServerInterceptor(fr *flight_trace.Recorder, log logger.Logger, cfg *config.Config) grpc.StreamServerInterceptor {
+func StreamServerInterceptor(
+	flightRecorder *flight_trace.Recorder,
+	log logger.Logger,
+	cfg *config.Config,
+) grpc.StreamServerInterceptor {
 	cfg.SetDefault("FLIGHT_TRACE_LATENCY_THRESHOLD", "1s")
 
 	return func(srv any, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error {
-		if fr == nil {
+		if flightRecorder == nil {
 			return handler(srv, stream)
 		}
 
@@ -93,7 +103,7 @@ func StreamServerInterceptor(fr *flight_trace.Recorder, log logger.Logger, cfg *
 			}
 
 			go func() {
-				fr.DumpToFileAsync(fileName)
+				flightRecorder.DumpToFileAsync(fileName)
 				log.InfoWithContext(stream.Context(), "flight recorder dump triggered (stream)",
 					slog.String("file", fileName),
 					slog.String("grpc.service", path.Dir(info.FullMethod)[1:]),

grpc/middleware/flight_trace/server_interceptors.go

@@ -1,3 +1,4 @@
+// Package grpc_logger provides client-side logging interceptors for gRPC.
 package grpc_logger
 
 import (
@@ -6,18 +7,25 @@ import (
 	"path"
 	"time"
 
+	"github.com/shortlink-org/go-sdk/logger"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/trace"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/status"
 	"google.golang.org/protobuf/proto"
-
-	"github.com/shortlink-org/go-sdk/logger"
 )
 
-// UnaryClientInterceptor returns a new unary client interceptor that optionally logs the execution of external gRPC calls.
+// UnaryClientInterceptor returns a new unary client interceptor that optionally
+// logs the execution of external gRPC calls.
 func UnaryClientInterceptor(log logger.Logger) grpc.UnaryClientInterceptor {
-	return func(ctx context.Context, method string, req, reply any, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
+	return func(
+		ctx context.Context,
+		method string,
+		req, reply any,
+		cc *grpc.ClientConn,
+		invoker grpc.UnaryInvoker,
+		opts ...grpc.CallOption,
+	) error {
 		startTime := time.Now()
 		err := invoker(ctx, method, req, reply, cc, opts...)
 		duration := time.Since(startTime)
@@ -26,6 +34,7 @@ func UnaryClientInterceptor(log logger.Logger) grpc.UnaryClientInterceptor {
 			if msg, ok := req.(proto.Message); ok {
 				span.SetAttributes(attribute.String("rpc.request", string(proto.MessageName(msg))))
 			}
+
 			if msg, ok := reply.(proto.Message); ok {
 				span.SetAttributes(attribute.String("rpc.response", string(proto.MessageName(msg))))
 			}
@@ -46,7 +55,8 @@ func UnaryClientInterceptor(log logger.Logger) grpc.UnaryClientInterceptor {
 	}
 }
 
-// StreamClientInterceptor returns a new streaming client interceptor that optionally logs the execution of external gRPC calls.
+// StreamClientInterceptor returns a new streaming client interceptor that optionally
+// logs the execution of external gRPC calls.
 func StreamClientInterceptor(log logger.Logger) grpc.StreamClientInterceptor {
 	return func(
 		ctx context.Context,

grpc/middleware/logger/client_interceptors.go

@@ -1,18 +1,17 @@
+//nolint:revive // package name uses underscore for consistency with project structure
 package grpc_logger
 
 import (
 	"context"
 	"log/slog"
 
+	"github.com/shortlink-org/go-sdk/logger"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
-
-	"github.com/shortlink-org/go-sdk/logger"
 )
 
 func printLog(ctx context.Context, log logger.Logger, err error, fields ...slog.Attr) {
 	switch status.Code(err) {
-	//nolint:lll // TODO: refactor
 	case
 		codes.OK,
 		codes.Canceled,

grpc/middleware/logger/logger.go

@@ -7,13 +7,12 @@ import (
 	"time"
 
 	grpc_middleware "github.com/grpc-ecosystem/go-grpc-middleware/v2"
+	"github.com/shortlink-org/go-sdk/logger"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/trace"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/status"
 	"google.golang.org/protobuf/proto"
-
-	"github.com/shortlink-org/go-sdk/logger"
 )
 
 // UnaryServerInterceptor returns a new unary server interceptors that adds zap.Logger to the context.
@@ -27,6 +26,7 @@ func UnaryServerInterceptor(log logger.Logger) grpc.UnaryServerInterceptor {
 			if msg, ok := req.(proto.Message); ok {
 				span.SetAttributes(attribute.String("rpc.request", string(proto.MessageName(msg))))
 			}
+
 			if msg, ok := resp.(proto.Message); ok {
 				span.SetAttributes(attribute.String("rpc.response", string(proto.MessageName(msg))))
 			}