refactor(middleware): rename to reduce stuttering

felixgateru · felixgateru · commit 5de088913f05 · 2025-01-20T14:54:26.000+03:00
Signed-off-by: Felix Gateru &lt;felix.gateru@gmail.com&gt;
diff --git a/auth/middleware/logging.go b/auth/middleware/logging.go
@@ -21,8 +21,8 @@ type loggingMiddleware struct {
 	svc    auth.Service
 }
 
-// LoggingMiddleware adds logging facilities to the core service.
-func LoggingMiddleware(svc auth.Service, logger *slog.Logger) auth.Service {
+// Logging adds logging facilities to the core service.
+func Logging(svc auth.Service, logger *slog.Logger) auth.Service {
 	return &loggingMiddleware{logger, svc}
 }
 
diff --git a/auth/middleware/metrics.go b/auth/middleware/metrics.go
@@ -22,8 +22,8 @@ type metricsMiddleware struct {
 	svc     auth.Service
 }
 
-// MetricsMiddleware instruments core service by tracking request count and latency.
-func MetricsMiddleware(svc auth.Service, counter metrics.Counter, latency metrics.Histogram) auth.Service {
+// Metrics instruments core service by tracking request count and latency.
+func Metrics(svc auth.Service, counter metrics.Counter, latency metrics.Histogram) auth.Service {
 	return &metricsMiddleware{
 		counter: counter,
 		latency: latency,
diff --git a/auth/middleware/tracing.go b/auth/middleware/tracing.go
@@ -21,8 +21,8 @@ type tracingMiddleware struct {
 	svc    auth.Service
 }
 
-// TracingMiddleware returns a new auth service with tracing capabilities.
-func TracingMiddleware(svc auth.Service, tracer trace.Tracer) auth.Service {
+// Tracing returns a new auth service with tracing capabilities.
+func Tracing(svc auth.Service, tracer trace.Tracer) auth.Service {
 	return &tracingMiddleware{tracer, svc}
 }
 
diff --git a/bootstrap/middleware/doc.go b/bootstrap/middleware/doc.go
diff --git a/certs/middleware/logging.go b/certs/middleware/logging.go
@@ -20,8 +20,8 @@ type loggingMiddleware struct {
 	svc    certs.Service
 }
 
-// LoggingMiddleware adds logging facilities to the certs service.
-func LoggingMiddleware(svc certs.Service, logger *slog.Logger) certs.Service {
+// Logging adds logging facilities to the certs service.
+func Logging(svc certs.Service, logger *slog.Logger) certs.Service {
 	return &loggingMiddleware{logger, svc}
 }
 
diff --git a/certs/middleware/metrics.go b/certs/middleware/metrics.go
@@ -21,8 +21,8 @@ type metricsMiddleware struct {
 	svc     certs.Service
 }
 
-// MetricsMiddleware instruments core service by tracking request count and latency.
-func MetricsMiddleware(svc certs.Service, counter metrics.Counter, latency metrics.Histogram) certs.Service {
+// Metrics instruments core service by tracking request count and latency.
+func Metrics(svc certs.Service, counter metrics.Counter, latency metrics.Histogram) certs.Service {
 	return &metricsMiddleware{
 		counter: counter,
 		latency: latency,
diff --git a/certs/middleware/tracing.go b/certs/middleware/tracing.go
@@ -18,8 +18,8 @@ type tracingMiddleware struct {
 	svc    certs.Service
 }
 
-// TracingMiddleware returns a new certs service with tracing capabilities.
-func TracingMiddleware(svc certs.Service, tracer trace.Tracer) certs.Service {
+// Tracing returns a new certs service with tracing capabilities.
+func Tracing(svc certs.Service, tracer trace.Tracer) certs.Service {
 	return &tracingMiddleware{tracer, svc}
 }
 
diff --git a/cmd/auth/main.go b/cmd/auth/main.go
@@ -17,15 +17,14 @@ import (
 	grpcAuthV1 "github.com/absmach/supermq/api/grpc/auth/v1"
 	grpcTokenV1 "github.com/absmach/supermq/api/grpc/token/v1"
 	"github.com/absmach/supermq/auth"
-	api "github.com/absmach/supermq/auth/api"
 	authgrpcapi "github.com/absmach/supermq/auth/api/grpc/auth"
 	tokengrpcapi "github.com/absmach/supermq/auth/api/grpc/token"
 	httpapi "github.com/absmach/supermq/auth/api/http"
 	"github.com/absmach/supermq/auth/bolt"
 	"github.com/absmach/supermq/auth/hasher"
 	"github.com/absmach/supermq/auth/jwt"
+	"github.com/absmach/supermq/auth/middleware"
 	apostgres "github.com/absmach/supermq/auth/postgres"
-	"github.com/absmach/supermq/auth/tracing"
 	boltclient "github.com/absmach/supermq/internal/clients/bolt"
 	smqlog "github.com/absmach/supermq/logger"
 	"github.com/absmach/supermq/pkg/jaeger"
@@ -244,10 +243,10 @@ func newService(_ context.Context, db *sqlx.DB, tracer trace.Tracer, cfg config,
 	t := jwt.New([]byte(cfg.SecretKey))
 
 	svc := auth.New(keysRepo, patsRepo, hasher, idProvider, t, pEvaluator, pService, cfg.AccessDuration, cfg.RefreshDuration, cfg.InvitationDuration)
-	svc = api.LoggingMiddleware(svc, logger)
+	svc = middleware.Logging(svc, logger)
 	counter, latency := prometheus.MakeMetrics("auth", "api")
-	svc = api.MetricsMiddleware(svc, counter, latency)
-	svc = tracing.New(svc, tracer)
+	svc = middleware.Metrics(svc, counter, latency)
+	svc = middleware.Tracing(svc, tracer)
 
 	return svc
 }
diff --git a/cmd/certs/main.go b/cmd/certs/main.go
@@ -16,8 +16,8 @@ import (
 	"github.com/absmach/supermq"
 	"github.com/absmach/supermq/certs"
 	httpapi "github.com/absmach/supermq/certs/api"
+	"github.com/absmach/supermq/certs/middleware"
 	pki "github.com/absmach/supermq/certs/pki/amcerts"
-	"github.com/absmach/supermq/certs/tracing"
 	smqlog "github.com/absmach/supermq/logger"
 	authsvcAuthn "github.com/absmach/supermq/pkg/authn/authsvc"
 	"github.com/absmach/supermq/pkg/grpcclient"
@@ -159,10 +159,10 @@ func newService(tracer trace.Tracer, logger *slog.Logger, cfg config, pkiAgent p
 	}
 	sdk := mgsdk.NewSDK(config)
 	svc := certs.New(sdk, pkiAgent)
-	svc = httpapi.LoggingMiddleware(svc, logger)
+	svc = middleware.Logging(svc, logger)
 	counter, latency := prometheus.MakeMetrics(svcName, "api")
-	svc = httpapi.MetricsMiddleware(svc, counter, latency)
-	svc = tracing.New(svc, tracer)
+	svc = middleware.Metrics(svc, counter, latency)
+	svc = middleware.Tracing(svc, tracer)
 
 	return svc
 }
diff --git a/cmd/coap/main.go b/cmd/coap/main.go
@@ -15,7 +15,7 @@ import (
 	"github.com/absmach/supermq"
 	"github.com/absmach/supermq/coap"
 	httpapi "github.com/absmach/supermq/coap/api"
-	"github.com/absmach/supermq/coap/tracing"
+	"github.com/absmach/supermq/coap/middleware"
 	smqlog "github.com/absmach/supermq/logger"
 	"github.com/absmach/supermq/pkg/grpcclient"
 	jaegerclient "github.com/absmach/supermq/pkg/jaeger"
@@ -145,12 +145,12 @@ func main() {
 
 	svc := coap.New(clientsClient, channelsClient, nps)
 
-	svc = middleware.TracingMiddleware(tracer, svc)
+	svc = middleware.Tracing(tracer, svc)
 
-	svc = httpapi.LoggingMiddleware(svc, logger)
+	svc = middleware.Logging(svc, logger)
 
 	counter, latency := prometheus.MakeMetrics(svcName, "api")
-	svc = httpapi.MetricsMiddleware(svc, counter, latency)
+	svc = middleware.Metrics(svc, counter, latency)
 
 	hs := httpserver.NewServer(ctx, cancel, svcName, httpServerConfig, httpapi.MakeHandler(cfg.InstanceID), logger)
 
diff --git a/cmd/invitations/main.go b/cmd/invitations/main.go
@@ -203,7 +203,7 @@ func newService(db *sqlx.DB, dbConfig clientspg.Config, authz smqauthz.Authoriza
 	sdk := mgsdk.NewSDK(config)
 
 	svc := invitations.NewService(token, repo, sdk)
-	svc = middleware.AuthorizationMiddleware(authz, svc)
+	svc = middleware.Authorization(authz, svc)
 	svc = middleware.Tracing(svc, tracer)
 	svc = middleware.Logging(logger, svc)
 	counter, latency := prometheus.MakeMetrics(svcName, "api")
diff --git a/cmd/journal/main.go b/cmd/journal/main.go
@@ -200,9 +200,9 @@ func newService(db *sqlx.DB, dbConfig pgclient.Config, authz smqauthz.Authorizat
 
 	svc := journal.NewService(idp, repo)
 	svc = middleware.AuthorizationMiddleware(svc, authz)
-	svc = middleware.LoggingMiddleware(svc, logger)
+	svc = middleware.Logging(svc, logger)
 	counter, latency := prometheus.MakeMetrics("journal", "journal_writer")
-	svc = middleware.MetricsMiddleware(svc, counter, latency)
+	svc = middleware.Metrics(svc, counter, latency)
 	svc = middleware.Tracing(svc, tracer)
 
 	return svc
diff --git a/cmd/users/main.go b/cmd/users/main.go
@@ -43,7 +43,6 @@ import (
 	"github.com/absmach/supermq/users/hasher"
 	"github.com/absmach/supermq/users/middleware"
 	"github.com/absmach/supermq/users/postgres"
-	"github.com/absmach/supermq/users/tracing"
 	"github.com/authzed/authzed-go/v1"
 	"github.com/authzed/grpcutil"
 	"github.com/caarlos0/env/v11"
@@ -276,10 +275,10 @@ func newService(ctx context.Context, authz smqauthz.Authorization, token grpcTok
 	}
 	svc = middleware.AuthorizationMiddleware(svc, authz, c.SelfRegister)
 
-	svc = tracing.New(svc, tracer)
-	svc = middleware.LoggingMiddleware(svc, logger)
+	svc = middleware.Tracing(svc, tracer)
+	svc = middleware.Logging(svc, logger)
 	counter, latency := prometheus.MakeMetrics(svcName, "api")
-	svc = middleware.MetricsMiddleware(svc, counter, latency)
+	svc = middleware.Metrics(svc, counter, latency)
 
 	userID, err := createAdmin(ctx, c, repo, hsr, svc)
 	if err != nil {
diff --git a/cmd/ws/main.go b/cmd/ws/main.go
@@ -31,7 +31,7 @@ import (
 	"github.com/absmach/supermq/pkg/uuid"
 	"github.com/absmach/supermq/ws"
 	httpapi "github.com/absmach/supermq/ws/api"
-	"github.com/absmach/supermq/ws/tracing"
+	"github.com/absmach/supermq/ws/middleware"
 	"github.com/caarlos0/env/v11"
 	"go.opentelemetry.io/otel/trace"
 	"golang.org/x/sync/errgroup"
@@ -193,10 +193,10 @@ func main() {
 
 func newService(clientsClient grpcClientsV1.ClientsServiceClient, channels grpcChannelsV1.ChannelsServiceClient, nps messaging.PubSub, logger *slog.Logger, tracer trace.Tracer) ws.Service {
 	svc := ws.New(clientsClient, channels, nps)
-	svc = tracing.New(tracer, svc)
-	svc = httpapi.LoggingMiddleware(svc, logger)
+	svc = middleware.Tracing(tracer, svc)
+	svc = middleware.Logging(svc, logger)
 	counter, latency := prometheus.MakeMetrics("ws_adapter", "api")
-	svc = httpapi.MetricsMiddleware(svc, counter, latency)
+	svc = middleware.Metrics(svc, counter, latency)
 	return svc
 }
 
diff --git a/coap/middleware/logging.go b/coap/middleware/logging.go
@@ -21,8 +21,8 @@ type loggingMiddleware struct {
 	svc    coap.Service
 }
 
-// LoggingMiddleware adds logging facilities to the adapter.
-func LoggingMiddleware(svc coap.Service, logger *slog.Logger) coap.Service {
+// Logging adds logging facilities to the adapter.
+func Logging(svc coap.Service, logger *slog.Logger) coap.Service {
 	return &loggingMiddleware{logger, svc}
 }
 
diff --git a/coap/middleware/metrics.go b/coap/middleware/metrics.go
@@ -22,8 +22,8 @@ type metricsMiddleware struct {
 	svc     coap.Service
 }
 
-// MetricsMiddleware instruments adapter by tracking request count and latency.
-func MetricsMiddleware(svc coap.Service, counter metrics.Counter, latency metrics.Histogram) coap.Service {
+// Metrics instruments adapter by tracking request count and latency.
+func Metrics(svc coap.Service, counter metrics.Counter, latency metrics.Histogram) coap.Service {
 	return &metricsMiddleware{
 		counter: counter,
 		latency: latency,
diff --git a/coap/middleware/tracing.go b/coap/middleware/tracing.go
@@ -28,8 +28,8 @@ type tracingServiceMiddleware struct {
 	svc    coap.Service
 }
 
-// TracingMiddleware creates a new instance of TracingServiceMiddleware that wraps an existing CoAP service with tracing capabilities.
-func TracingMiddleware(tracer trace.Tracer, svc coap.Service) coap.Service {
+// Tracing creates a new instance of TracingServiceMiddleware that wraps an existing CoAP service with tracing capabilities.
+func Tracing(tracer trace.Tracer, svc coap.Service) coap.Service {
 	return &tracingServiceMiddleware{
 		tracer: tracer,
 		svc:    svc,
diff --git a/invitations/middleware/authorization.go b/invitations/middleware/authorization.go
@@ -25,7 +25,7 @@ type authorizationMiddleware struct {
 	svc   invitations.Service
 }
 
-func AuthorizationMiddleware(authz authz.Authorization, svc invitations.Service) invitations.Service {
+func Authorization(authz authz.Authorization, svc invitations.Service) invitations.Service {
 	return &authorizationMiddleware{authz, svc}
 }
 
diff --git a/journal/middleware/logging.go b/journal/middleware/logging.go
@@ -19,8 +19,8 @@ type loggingMiddleware struct {
 	service journal.Service
 }
 
-// LoggingMiddleware adds logging facilities to the adapter.
-func LoggingMiddleware(service journal.Service, logger *slog.Logger) journal.Service {
+// Logging adds logging facilities to the adapter.
+func Logging(service journal.Service, logger *slog.Logger) journal.Service {
 	return &loggingMiddleware{
 		logger:  logger,
 		service: service,
diff --git a/journal/middleware/metrics.go b/journal/middleware/metrics.go
@@ -20,9 +20,8 @@ type metricsMiddleware struct {
 	service journal.Service
 }
 
-// MetricsMiddleware returns new message repository
-// with Save method wrapped to expose metrics.
-func MetricsMiddleware(service journal.Service, counter metrics.Counter, latency metrics.Histogram) journal.Service {
+// Metrics returns new message repository with Save method wrapped to expose metrics.
+func Metrics(service journal.Service, counter metrics.Counter, latency metrics.Histogram) journal.Service {
 	return &metricsMiddleware{
 		counter: counter,
 		latency: latency,
diff --git a/readers/middleware/doc.go b/readers/middleware/doc.go
diff --git a/users/middleware/logging.go b/users/middleware/logging.go
@@ -20,8 +20,8 @@ type loggingMiddleware struct {
 	svc    users.Service
 }
 
-// LoggingMiddleware adds logging facilities to the users service.
-func LoggingMiddleware(svc users.Service, logger *slog.Logger) users.Service {
+// Logging adds logging facilities to the users service.
+func Logging(svc users.Service, logger *slog.Logger) users.Service {
 	return &loggingMiddleware{logger, svc}
 }
 
diff --git a/users/middleware/metrics.go b/users/middleware/metrics.go
@@ -21,8 +21,8 @@ type metricsMiddleware struct {
 	svc     users.Service
 }
 
-// MetricsMiddleware instruments policies service by tracking request count and latency.
-func MetricsMiddleware(svc users.Service, counter metrics.Counter, latency metrics.Histogram) users.Service {
+// Metrics instruments policies service by tracking request count and latency.
+func Metrics(svc users.Service, counter metrics.Counter, latency metrics.Histogram) users.Service {
 	return &metricsMiddleware{
 		counter: counter,
 		latency: latency,
diff --git a/users/middleware/tracing.go b/users/middleware/tracing.go
@@ -20,8 +20,8 @@ type tracingMiddleware struct {
 	svc    users.Service
 }
 
-// TracingMiddleware returns a new users service with tracing capabilities.
-func TracingMiddleware(svc users.Service, tracer trace.Tracer) users.Service {
+// Tracing returns a new users service with tracing capabilities.
+func Tracing(svc users.Service, tracer trace.Tracer) users.Service {
 	return &tracingMiddleware{tracer, svc}
 }
 
diff --git a/ws/middleware/logging.go b/ws/middleware/logging.go
@@ -18,8 +18,8 @@ type loggingMiddleware struct {
 	svc    ws.Service
 }
 
-// LoggingMiddleware adds logging facilities to the websocket service.
-func LoggingMiddleware(svc ws.Service, logger *slog.Logger) ws.Service {
+// Logging adds logging facilities to the websocket service.
+func Logging(svc ws.Service, logger *slog.Logger) ws.Service {
 	return &loggingMiddleware{logger, svc}
 }
 
diff --git a/ws/middleware/metrics.go b/ws/middleware/metrics.go
@@ -21,8 +21,8 @@ type metricsMiddleware struct {
 	svc     ws.Service
 }
 
-// MetricsMiddleware instruments adapter by tracking request count and latency.
-func MetricsMiddleware(svc ws.Service, counter metrics.Counter, latency metrics.Histogram) ws.Service {
+// Metrics instruments adapter by tracking request count and latency.
+func Metrics(svc ws.Service, counter metrics.Counter, latency metrics.Histogram) ws.Service {
 	return &metricsMiddleware{
 		counter: counter,
 		latency: latency,
diff --git a/ws/middleware/tracing.go b/ws/middleware/tracing.go
@@ -23,8 +23,8 @@ type tracingMiddleware struct {
 	svc    ws.Service
 }
 
-// TracingMiddleware returns a new websocket service with tracing capabilities.
-func TracingMiddleware(tracer trace.Tracer, svc ws.Service) ws.Service {
+// Tracing returns a new websocket service with tracing capabilities.
+func Tracing(tracer trace.Tracer, svc ws.Service) ws.Service {
 	return &tracingMiddleware{
 		tracer: tracer,
 		svc:    svc,

Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,8 @@ type loggingMiddleware struct {`
`21`	`21`	`svc auth.Service`
`22`	`22`	`}`
`23`	`23`
`24`		`-// LoggingMiddleware adds logging facilities to the core service.`
`25`		`-func LoggingMiddleware(svc auth.Service, logger *slog.Logger) auth.Service {`
	`24`	`+// Logging adds logging facilities to the core service.`
	`25`	`+func Logging(svc auth.Service, logger *slog.Logger) auth.Service {`
`26`	`26`	`return &loggingMiddleware{logger, svc}`
`27`	`27`	`}`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,8 @@ type tracingMiddleware struct {`
`21`	`21`	`svc auth.Service`
`22`	`22`	`}`
`23`	`23`
`24`		`-// TracingMiddleware returns a new auth service with tracing capabilities.`
`25`		`-func TracingMiddleware(svc auth.Service, tracer trace.Tracer) auth.Service {`
	`24`	`+// Tracing returns a new auth service with tracing capabilities.`
	`25`	`+func Tracing(svc auth.Service, tracer trace.Tracer) auth.Service {`
`26`	`26`	`return &tracingMiddleware{tracer, svc}`
`27`	`27`	`}`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,8 @@ type loggingMiddleware struct {`
`20`	`20`	`svc certs.Service`
`21`	`21`	`}`
`22`	`22`
`23`		`-// LoggingMiddleware adds logging facilities to the certs service.`
`24`		`-func LoggingMiddleware(svc certs.Service, logger *slog.Logger) certs.Service {`
	`23`	`+// Logging adds logging facilities to the certs service.`
	`24`	`+func Logging(svc certs.Service, logger *slog.Logger) certs.Service {`
`25`	`25`	`return &loggingMiddleware{logger, svc}`
`26`	`26`	`}`
`27`	`27`
Original file line number	Diff line number	Diff line change
`@@ -18,8 +18,8 @@ type tracingMiddleware struct {`
`18`	`18`	`svc certs.Service`
`19`	`19`	`}`
`20`	`20`
`21`		`-// TracingMiddleware returns a new certs service with tracing capabilities.`
`22`		`-func TracingMiddleware(svc certs.Service, tracer trace.Tracer) certs.Service {`
	`21`	`+// Tracing returns a new certs service with tracing capabilities.`
	`22`	`+func Tracing(svc certs.Service, tracer trace.Tracer) certs.Service {`
`23`	`23`	`return &tracingMiddleware{tracer, svc}`
`24`	`24`	`}`
`25`	`25`