fix: resolve golangci-lint issues across new and moved packages

- Add package comments to all packages
- Add doc comments to all exported types and methods
- Fix unchecked error returns in tests and production code
- Fix unused parameters (rename to _)
- Fix staticcheck SA1012: use context.TODO() instead of nil
- Fix revive indent-error-flow in spa/handler.go
- Fix gofmt formatting
- Update .golangci.yml for v2 format

Author: ravisuhag

.golangci.yml

@@ -1,24 +1,20 @@
-output:
-  formats:
-    - format: line-number
+version: "2"
+formatters:
+  enable:
+    - goimports
+    - gofmt
 linters:
-  enable-all: false
-  disable-all: true
   enable:
     - govet
-    - goimports
     - thelper
     - tparallel
     - unconvert
     - wastedassign
     - revive
     - unused
-    - gofmt
     - whitespace
     - misspell
 linters-settings:
   revive:
     ignore-generated-header: true
     severity: warning
-severity:
-  default-severity: error

app/app.go

@@ -1,3 +1,4 @@
+// Package app provides a service lifecycle manager for raystack services.
 package app
 
 import (
@@ -6,6 +7,7 @@ import (
 	"os/signal"
 	"syscall"
 
+	"connectrpc.com/connect"
 	"github.com/raystack/salt/db"
 	"github.com/raystack/salt/logger"
 	"github.com/raystack/salt/server"
@@ -15,14 +17,15 @@ import (
 // App is a service lifecycle manager that wires together configuration,
 // logging, database, telemetry, and HTTP serving with graceful shutdown.
 type App struct {
-	logger    logger.Logger
-	db        *db.Client
-	dbCfg     *db.Config
-	telCfg    *telemetry.Config
-	telClean  func()
-	serverOps []server.Option
-	onStart   []func(context.Context) error
-	onStop    []func(context.Context) error
+	logger       logger.Logger
+	db           *db.Client
+	dbCfg        *db.Config
+	telCfg       *telemetry.Config
+	telClean     func()
+	interceptors []connect.Interceptor
+	serverOps    []server.Option
+	onStart      []func(context.Context) error
+	onStop       []func(context.Context) error
 }
 
 // New creates a new App by applying the given options.
@@ -103,6 +106,11 @@ func (a *App) DB() *db.Client {
 	return a.db
 }
 
+// Interceptors returns the registered Connect interceptors.
+func (a *App) Interceptors() []connect.Interceptor {
+	return a.interceptors
+}
+
 func (a *App) stop(ctx context.Context) {
 	for _, fn := range a.onStop {
 		if err := fn(ctx); err != nil {

app/app_test.go

@@ -32,7 +32,7 @@ func TestNew(t *testing.T) {
 	})
 
 	t.Run("returns error from option", func(t *testing.T) {
-		badOpt := func(a *app.App) error {
+		badOpt := func(_ *app.App) error {
 			return fmt.Errorf("bad option")
 		}
 		_, err := app.New(badOpt)
@@ -57,10 +57,9 @@ func TestAppStartAndShutdown(t *testing.T) {
 
 		time.Sleep(100 * time.Millisecond)
 
-		// Verify health check works
 		resp, err := http.Get("http://127.0.0.1:18950/ping")
 		require.NoError(t, err)
-		defer resp.Body.Close()
+		defer func() { _ = resp.Body.Close() }()
 		assert.Equal(t, http.StatusOK, resp.StatusCode)
 
 		cancel()
@@ -79,7 +78,7 @@ func TestAppStartAndShutdown(t *testing.T) {
 		var hookRan bool
 		a, err := app.New(
 			app.WithAddr("127.0.0.1:18951"),
-			app.WithOnStart(func(ctx context.Context) error {
+			app.WithOnStart(func(_ context.Context) error {
 				hookRan = true
 				return nil
 			}),
@@ -91,7 +90,7 @@ func TestAppStartAndShutdown(t *testing.T) {
 			cancel()
 		}()
 
-		a.Start(ctx)
+		_ = a.Start(ctx)
 		assert.True(t, hookRan)
 	})
 
@@ -101,7 +100,7 @@ func TestAppStartAndShutdown(t *testing.T) {
 		var hookRan bool
 		a, err := app.New(
 			app.WithAddr("127.0.0.1:18952"),
-			app.WithOnStop(func(ctx context.Context) error {
+			app.WithOnStop(func(_ context.Context) error {
 				hookRan = true
 				return nil
 			}),
@@ -113,7 +112,7 @@ func TestAppStartAndShutdown(t *testing.T) {
 			cancel()
 		}()
 
-		a.Start(ctx)
+		_ = a.Start(ctx)
 		assert.True(t, hookRan)
 	})
 
@@ -124,20 +123,20 @@ func TestAppStartAndShutdown(t *testing.T) {
 		a, err := app.New(
 			app.WithLogger(logger.NewNoop()),
 			app.WithAddr("127.0.0.1:18953"),
-			app.WithHandler("/hello", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-				fmt.Fprint(w, "world")
+			app.WithHandler("/hello", http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+				_, _ = fmt.Fprint(w, "world")
 			})),
 			app.WithHealthCheck("/ping"),
 			app.WithH2C(),
 		)
 		require.NoError(t, err)
 
-		go a.Start(ctx)
+		go func() { _ = a.Start(ctx) }()
 		time.Sleep(100 * time.Millisecond)
 
 		resp, err := http.Get("http://127.0.0.1:18953/hello")
 		require.NoError(t, err)
-		defer resp.Body.Close()
+		defer func() { _ = resp.Body.Close() }()
 
 		body, _ := io.ReadAll(resp.Body)
 		assert.Equal(t, "world", string(body))

app/option.go

@@ -20,7 +20,7 @@ type Option func(*App) error
 // The target must be a pointer to a struct. Config is loaded eagerly
 // so that subsequent options can reference fields from it.
 func WithConfig(target interface{}, loaderOpts ...config.Option) Option {
-	return func(a *App) error {
+	return func(_ *App) error {
 		loader := config.NewLoader(loaderOpts...)
 		return loader.Load(target)
 	}
@@ -101,10 +101,7 @@ func WithGracePeriod(d time.Duration) Option {
 // level. Store them on the App for use when wiring handlers.
 func WithMiddleware(interceptors ...connect.Interceptor) Option {
 	return func(a *App) error {
-		// Interceptors are stored but must be applied by the caller when
-		// creating ConnectRPC handlers via connect.WithInterceptors().
-		// This option exists for documentation and future integration.
-		_ = interceptors
+		a.interceptors = append(a.interceptors, interceptors...)
 		return nil
 	}
 }

logger/logger.go

@@ -1,3 +1,4 @@
+// Package logger provides a structured logging interface with multiple backends.
 package logger
 
 import (

logger/logrus.go

@@ -6,6 +6,7 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
+// Logrus implements Logger using sirupsen/logrus.
 type Logrus struct {
 	log *logrus.Logger
 }
@@ -20,38 +21,47 @@ func (l Logrus) getFields(args ...interface{}) map[string]interface{} {
 	return fieldMap
 }
 
+// Info logs at info level.
 func (l *Logrus) Info(msg string, args ...interface{}) {
 	l.log.WithFields(l.getFields(args...)).Info(msg)
 }
 
+// Debug logs at debug level.
 func (l *Logrus) Debug(msg string, args ...interface{}) {
 	l.log.WithFields(l.getFields(args...)).Debug(msg)
 }
 
+// Warn logs at warn level.
 func (l *Logrus) Warn(msg string, args ...interface{}) {
 	l.log.WithFields(l.getFields(args...)).Warn(msg)
 }
 
+// Error logs at error level.
 func (l *Logrus) Error(msg string, args ...interface{}) {
 	l.log.WithFields(l.getFields(args...)).Error(msg)
 }
 
+// Fatal logs at fatal level and exits.
 func (l *Logrus) Fatal(msg string, args ...interface{}) {
 	l.log.WithFields(l.getFields(args...)).Fatal(msg)
 }
 
+// Level returns the current log level.
 func (l *Logrus) Level() string {
 	return l.log.Level.String()
 }
 
+// Writer returns the logger's output writer.
 func (l *Logrus) Writer() io.Writer {
 	return l.log.Writer()
 }
 
+// Entry returns a logrus Entry with the given key/value pairs.
 func (l *Logrus) Entry(args ...interface{}) *logrus.Entry {
 	return l.log.WithFields(l.getFields(args...))
 }
 
+// LogrusWithLevel sets the log level for the Logrus logger.
 func LogrusWithLevel(level string) Option {
 	return func(logger interface{}) {
 		logLevel, err := logrus.ParseLevel(level)
@@ -62,6 +72,7 @@ func LogrusWithLevel(level string) Option {
 	}
 }
 
+// LogrusWithWriter sets the output writer for the Logrus logger.
 func LogrusWithWriter(writer io.Writer) Option {
 	return func(logger interface{}) {
 		logger.(*Logrus).log.SetOutput(writer)

logger/logrus_test.go

@@ -22,7 +22,7 @@ func TestLogrus(t *testing.T) {
 			DisableTimestamp: true,
 		}))
 		logger.Info("hello world")
-		foo.Flush()
+		_ = foo.Flush()
 
 		assert.Equal(t, "level=info msg=\"hello world\"\n", b.String())
 	})
@@ -34,7 +34,7 @@ func TestLogrus(t *testing.T) {
 			DisableTimestamp: true,
 		}))
 		logger.Debug("hello world")
-		foo.Flush()
+		_ = foo.Flush()
 
 		assert.Equal(t, "", b.String())
 	})
@@ -46,7 +46,7 @@ func TestLogrus(t *testing.T) {
 			DisableTimestamp: true,
 		}))
 		logger.Debug("current values", "day", 11, "month", "aug")
-		foo.Flush()
+		_ = foo.Flush()
 
 		assert.Equal(t, "level=debug msg=\"current values\" day=11 month=aug\n", b.String())
 	})
@@ -59,7 +59,7 @@ func TestLogrus(t *testing.T) {
 		}))
 		var err = fmt.Errorf("request failed")
 		logger.Error(err.Error(), "hello", "world")
-		foo.Flush()
+		_ = foo.Flush()
 		assert.Equal(t, "level=error msg=\"request failed\" hello=world\n", b.String())
 	})
 	t.Run("should ignore params if malformed", func(t *testing.T) {
@@ -71,7 +71,7 @@ func TestLogrus(t *testing.T) {
 		}))
 		var err = fmt.Errorf("request failed")
 		logger.Error(err.Error(), "hello", "world", "!")
-		foo.Flush()
+		_ = foo.Flush()
 		assert.Equal(t, "level=error msg=\"request failed\"\n", b.String())
 	})
 }

logger/noop.go

@@ -4,22 +4,35 @@ import (
 	"io"
 )
 
+// Noop is a no-operation logger that discards all output, useful in tests.
 type Noop struct{}
 
-func (n *Noop) Info(msg string, args ...interface{})  {}
-func (n *Noop) Debug(msg string, args ...interface{}) {}
-func (n *Noop) Warn(msg string, args ...interface{})  {}
-func (n *Noop) Error(msg string, args ...interface{}) {}
-func (n *Noop) Fatal(msg string, args ...interface{}) {}
+// Info is a no-op.
+func (n *Noop) Info(_ string, _ ...interface{}) {}
 
+// Debug is a no-op.
+func (n *Noop) Debug(_ string, _ ...interface{}) {}
+
+// Warn is a no-op.
+func (n *Noop) Warn(_ string, _ ...interface{}) {}
+
+// Error is a no-op.
+func (n *Noop) Error(_ string, _ ...interface{}) {}
+
+// Fatal is a no-op.
+func (n *Noop) Fatal(_ string, _ ...interface{}) {}
+
+// Level returns "unsupported".
 func (n *Noop) Level() string {
 	return "unsupported"
 }
+
+// Writer returns io.Discard.
 func (n *Noop) Writer() io.Writer {
 	return io.Discard
 }
 
-// NewNoop returns a no operation logger, useful in tests
-func NewNoop(opts ...Option) *Noop {
+// NewNoop returns a no-operation logger, useful in tests.
+func NewNoop(_ ...Option) *Noop {
 	return &Noop{}
 }

logger/slog.go

@@ -1,6 +1,7 @@
 package logger
 
 import (
+	"context"
 	"io"
 	"log/slog"
 	"os"
@@ -73,34 +74,41 @@ func (s *Slog) log(level slog.Level, msg string, args ...interface{}) {
 	for i, a := range attrs {
 		logArgs[i] = a
 	}
-	s.logger.Log(nil, level, msg, logArgs...)
+	s.logger.Log(context.TODO(), level, msg, logArgs...)
 }
 
+// Debug logs at debug level.
 func (s *Slog) Debug(msg string, args ...interface{}) {
 	s.log(slog.LevelDebug, msg, args...)
 }
 
+// Info logs at info level.
 func (s *Slog) Info(msg string, args ...interface{}) {
 	s.log(slog.LevelInfo, msg, args...)
 }
 
+// Warn logs at warn level.
 func (s *Slog) Warn(msg string, args ...interface{}) {
 	s.log(slog.LevelWarn, msg, args...)
 }
 
+// Error logs at error level.
 func (s *Slog) Error(msg string, args ...interface{}) {
 	s.log(slog.LevelError, msg, args...)
 }
 
+// Fatal logs at error level and exits.
 func (s *Slog) Fatal(msg string, args ...interface{}) {
 	s.log(slog.LevelError, msg, args...)
 	os.Exit(1)
 }
 
+// Level returns the current log level.
 func (s *Slog) Level() string {
 	return s.level.String()
 }
 
+// Writer returns the logger's output writer.
 func (s *Slog) Writer() io.Writer {
 	return s.writer
 }

logger/slog_test.go

@@ -11,7 +11,7 @@ import (
 )
 
 func TestSlog(t *testing.T) {
-	t.Run("should implement Logger interface", func(t *testing.T) {
+	t.Run("should implement Logger interface", func(_ *testing.T) {
 		var _ logger.Logger = logger.NewSlog()
 	})