Skip to content

Commit

Permalink
refactor(middleware): rename to reduce stuttering
Browse files Browse the repository at this point in the history
Signed-off-by: Felix Gateru <[email protected]>
  • Loading branch information
felixgateru committed Jan 20, 2025
1 parent ed59865 commit 5de0889
Show file tree
Hide file tree
Showing 27 changed files with 57 additions and 75 deletions.
4 changes: 2 additions & 2 deletions auth/middleware/logging.go
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Check warning on line 26 in auth/middleware/logging.go

View check run for this annotation

Codecov / codecov/patch

auth/middleware/logging.go#L25-L26

Added lines #L25 - L26 were not covered by tests
}

Expand Down
4 changes: 2 additions & 2 deletions auth/middleware/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions auth/middleware/tracing.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Check warning on line 25 in auth/middleware/tracing.go

View check run for this annotation

Codecov / codecov/patch

auth/middleware/tracing.go#L25

Added line #L25 was not covered by tests
return &tracingMiddleware{tracer, svc}
}

Expand Down
9 changes: 0 additions & 9 deletions bootstrap/middleware/doc.go

This file was deleted.

4 changes: 2 additions & 2 deletions certs/middleware/logging.go
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Check warning on line 25 in certs/middleware/logging.go

View check run for this annotation

Codecov / codecov/patch

certs/middleware/logging.go#L24-L25

Added lines #L24 - L25 were not covered by tests
}

Expand Down
4 changes: 2 additions & 2 deletions certs/middleware/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions certs/middleware/tracing.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Check warning on line 22 in certs/middleware/tracing.go

View check run for this annotation

Codecov / codecov/patch

certs/middleware/tracing.go#L22

Added line #L22 was not covered by tests
return &tracingMiddleware{tracer, svc}
}

Expand Down
9 changes: 4 additions & 5 deletions cmd/auth/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
}
8 changes: 4 additions & 4 deletions cmd/certs/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
}
8 changes: 4 additions & 4 deletions cmd/coap/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion cmd/invitations/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
4 changes: 2 additions & 2 deletions cmd/journal/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 3 additions & 4 deletions cmd/users/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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 {
Expand Down
8 changes: 4 additions & 4 deletions cmd/ws/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
}

Expand Down
4 changes: 2 additions & 2 deletions coap/middleware/logging.go
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Check warning on line 26 in coap/middleware/logging.go

View check run for this annotation

Codecov / codecov/patch

coap/middleware/logging.go#L25-L26

Added lines #L25 - L26 were not covered by tests
}

Expand Down
4 changes: 2 additions & 2 deletions coap/middleware/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions coap/middleware/tracing.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Check warning on line 32 in coap/middleware/tracing.go

View check run for this annotation

Codecov / codecov/patch

coap/middleware/tracing.go#L32

Added line #L32 was not covered by tests
return &tracingServiceMiddleware{
tracer: tracer,
svc: svc,
Expand Down
2 changes: 1 addition & 1 deletion invitations/middleware/authorization.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Check warning on line 28 in invitations/middleware/authorization.go

View check run for this annotation

Codecov / codecov/patch

invitations/middleware/authorization.go#L28

Added line #L28 was not covered by tests
return &authorizationMiddleware{authz, svc}
}

Expand Down
4 changes: 2 additions & 2 deletions journal/middleware/logging.go
Original file line number Diff line number Diff line change
Expand Up @@ -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{

Check warning on line 24 in journal/middleware/logging.go

View check run for this annotation

Codecov / codecov/patch

journal/middleware/logging.go#L23-L24

Added lines #L23 - L24 were not covered by tests
logger: logger,
service: service,
Expand Down
5 changes: 2 additions & 3 deletions journal/middleware/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
6 changes: 0 additions & 6 deletions readers/middleware/doc.go

This file was deleted.

4 changes: 2 additions & 2 deletions users/middleware/logging.go
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Check warning on line 25 in users/middleware/logging.go

View check run for this annotation

Codecov / codecov/patch

users/middleware/logging.go#L24-L25

Added lines #L24 - L25 were not covered by tests
}

Expand Down
4 changes: 2 additions & 2 deletions users/middleware/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions users/middleware/tracing.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Check warning on line 24 in users/middleware/tracing.go

View check run for this annotation

Codecov / codecov/patch

users/middleware/tracing.go#L24

Added line #L24 was not covered by tests
return &tracingMiddleware{tracer, svc}
}

Expand Down
4 changes: 2 additions & 2 deletions ws/middleware/logging.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Check warning on line 22 in ws/middleware/logging.go

View check run for this annotation

Codecov / codecov/patch

ws/middleware/logging.go#L22

Added line #L22 was not covered by tests
return &loggingMiddleware{logger, svc}
}

Expand Down
4 changes: 2 additions & 2 deletions ws/middleware/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Check warning on line 25 in ws/middleware/metrics.go

View check run for this annotation

Codecov / codecov/patch

ws/middleware/metrics.go#L25

Added line #L25 was not covered by tests
return &metricsMiddleware{
counter: counter,
latency: latency,
Expand Down
4 changes: 2 additions & 2 deletions ws/middleware/tracing.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Check warning on line 27 in ws/middleware/tracing.go

View check run for this annotation

Codecov / codecov/patch

ws/middleware/tracing.go#L27

Added line #L27 was not covered by tests
return &tracingMiddleware{
tracer: tracer,
svc: svc,
Expand Down

0 comments on commit 5de0889

Please sign in to comment.