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 Oct 23, 2024
1 parent 61c9c58 commit 430d8c0
Show file tree
Hide file tree
Showing 46 changed files with 107 additions and 108 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 @@ -20,8 +20,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 24 in auth/middleware/tracing.go

View check run for this annotation

Codecov / codecov/patch

auth/middleware/tracing.go#L24

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

Expand Down
4 changes: 2 additions & 2 deletions bootstrap/middleware/authorization.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ type authorizationMiddleware struct {
authz mgauthz.Authorization
}

// AuthorizationMiddleware adds authorization to the clients service.
func AuthorizationMiddleware(svc bootstrap.Service, authz mgauthz.Authorization) bootstrap.Service {
// Authorization adds authorization to the clients service.
func Authorization(svc bootstrap.Service, authz mgauthz.Authorization) bootstrap.Service {
return &authorizationMiddleware{
svc: svc,

Check warning on line 26 in bootstrap/middleware/authorization.go

View check run for this annotation

Codecov / codecov/patch

bootstrap/middleware/authorization.go#L24-L26

Added lines #L24 - L26 were not covered by tests
authz: authz,
Expand Down
4 changes: 2 additions & 2 deletions bootstrap/middleware/logging.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ type loggingMiddleware struct {
svc bootstrap.Service
}

// LoggingMiddleware adds logging facilities to the bootstrap service.
func LoggingMiddleware(svc bootstrap.Service, logger *slog.Logger) bootstrap.Service {
// Logging adds logging facilities to the bootstrap service.
func Logging(svc bootstrap.Service, logger *slog.Logger) bootstrap.Service {
return &loggingMiddleware{logger, svc}
}

Expand Down
4 changes: 2 additions & 2 deletions bootstrap/middleware/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ type metricsMiddleware struct {
svc bootstrap.Service
}

// MetricsMiddleware instruments core service by tracking request count and latency.
func MetricsMiddleware(svc bootstrap.Service, counter metrics.Counter, latency metrics.Histogram) bootstrap.Service {
// Metrics instruments core service by tracking request count and latency.
func Metrics(svc bootstrap.Service, counter metrics.Counter, latency metrics.Histogram) bootstrap.Service {
return &metricsMiddleware{
counter: counter,
latency: latency,
Expand Down
4 changes: 2 additions & 2 deletions bootstrap/middleware/tracing.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ type tracingMiddleware struct {
svc bootstrap.Service
}

// TracingMiddleware returns a new bootstrap service with tracing capabilities.
func TracingMiddleware(svc bootstrap.Service, tracer trace.Tracer) bootstrap.Service {
// Tracing returns a new bootstrap service with tracing capabilities.
func Tracing(svc bootstrap.Service, tracer trace.Tracer) bootstrap.Service {
return &tracingMiddleware{tracer, svc}
}

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

View check run for this annotation

Codecov / codecov/patch

bootstrap/middleware/tracing.go#L23-L25

Added lines #L23 - L25 were not covered by tests

Expand Down
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 bootstrap service.
func LoggingMiddleware(svc certs.Service, logger *slog.Logger) certs.Service {
// Logging adds logging facilities to the bootstrap service.
func Logging(svc certs.Service, logger *slog.Logger) certs.Service {
return &loggingMiddleware{logger, svc}
}

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
6 changes: 3 additions & 3 deletions cmd/auth/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -223,10 +223,10 @@ func newService(ctx context.Context, db *sqlx.DB, tracer trace.Tracer, cfg confi
logger.Error(fmt.Sprintf("failed to init event store middleware : %s", err))
return nil
}
svc = middleware.LoggingMiddleware(svc, logger)
svc = middleware.Logging(svc, logger)
counter, latency := prometheus.MakeMetrics("groups", "api")
svc = middleware.MetricsMiddleware(svc, counter, latency)
svc = middleware.TracingMiddleware(svc, tracer)
svc = middleware.Metrics(svc, counter, latency)
svc = middleware.Tracing(svc, tracer)

return svc
}
8 changes: 4 additions & 4 deletions cmd/bootstrap/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -217,12 +217,12 @@ func newService(ctx context.Context, authz mgauthz.Authorization, policySvc poli
return nil, err
}

svc = middleware.AuthorizationMiddleware(svc, authz)
svc = middleware.Authorization(svc, authz)
svc = producer.NewEventStoreMiddleware(svc, publisher)
svc = middleware.LoggingMiddleware(svc, logger)
svc = middleware.Logging(svc, logger)
counter, latency := prometheus.MakeMetrics(svcName, "api")
svc = middleware.MetricsMiddleware(svc, counter, latency)
svc = middleware.TracingMiddleware(svc, tracer)
svc = middleware.Metrics(svc, counter, latency)
svc = middleware.Tracing(svc, tracer)

return svc, nil
}
Expand Down
6 changes: 3 additions & 3 deletions cmd/certs/main.go
Original file line number Diff line number Diff line change
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 = middleware.LoggingMiddleware(svc, logger)
svc = middleware.Logging(svc, logger)
counter, latency := prometheus.MakeMetrics(svcName, "api")
svc = middleware.MetricsMiddleware(svc, counter, latency)
svc = middleware.TracingMiddleware(svc, tracer)
svc = middleware.Metrics(svc, counter, latency)
svc = middleware.Tracing(svc, tracer)

return svc
}
6 changes: 3 additions & 3 deletions cmd/coap/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -128,12 +128,12 @@ func main() {

svc := coap.New(thingsClient, nps)

svc = middleware.TracingMiddleware(tracer, svc)
svc = middleware.Tracing(tracer, svc)

svc = middleware.LoggingMiddleware(svc, logger)
svc = middleware.Logging(svc, logger)

counter, latency := prometheus.MakeMetrics(svcName, "api")
svc = middleware.MetricsMiddleware(svc, counter, latency)
svc = middleware.Metrics(svc, counter, latency)

hs := httpserver.NewServer(ctx, cancel, svcName, httpServerConfig, api.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 @@ -186,7 +186,7 @@ func newService(db *sqlx.DB, dbConfig clientspg.Config, authz mgauthz.Authorizat
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 @@ -184,9 +184,9 @@ func newService(db *sqlx.DB, dbConfig pgclient.Config, authn mgauthn.Authenticat
idp := uuid.New()

svc := journal.NewService(authn, authz, idp, repo)
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
4 changes: 2 additions & 2 deletions cmd/postgres-reader/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,9 @@ func main() {

func newService(db *sqlx.DB, logger *slog.Logger) readers.MessageRepository {
svc := postgres.New(db)
svc = middleware.LoggingMiddleware(svc, logger)
svc = middleware.Logging(svc, logger)
counter, latency := prometheus.MakeMetrics("postgres", "message_reader")
svc = middleware.MetricsMiddleware(svc, counter, latency)
svc = middleware.Metrics(svc, counter, latency)

return svc
}
16 changes: 8 additions & 8 deletions cmd/things/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -257,18 +257,18 @@ func newService(ctx context.Context, db *sqlx.DB, dbConfig pgclient.Config, auth
return nil, nil, err
}

csvc = tmiddleware.AuthorizationMiddleware(csvc, authz)
gsvc = gmiddleware.AuthorizationMiddleware(gsvc, authz)
csvc = tmiddleware.Authorization(csvc, authz)
gsvc = gmiddleware.Authorization(gsvc, authz)

csvc = tmiddleware.TracingMiddleware(csvc, tracer)
csvc = tmiddleware.LoggingMiddleware(csvc, logger)
csvc = tmiddleware.Tracing(csvc, tracer)
csvc = tmiddleware.Logging(csvc, logger)
counter, latency := prometheus.MakeMetrics(svcName, "api")
csvc = tmiddleware.MetricsMiddleware(csvc, counter, latency)
csvc = tmiddleware.Metrics(csvc, counter, latency)

gsvc = gmiddleware.TracingMiddleware(gsvc, tracer)
gsvc = gmiddleware.LoggingMiddleware(gsvc, logger)
gsvc = gmiddleware.Tracing(gsvc, tracer)
gsvc = gmiddleware.Logging(gsvc, logger)
counter, latency = prometheus.MakeMetrics(fmt.Sprintf("%s_groups", svcName), "api")
gsvc = gmiddleware.MetricsMiddleware(gsvc, counter, latency)
gsvc = gmiddleware.Metrics(gsvc, counter, latency)

return csvc, gsvc, err
}
Expand Down
4 changes: 2 additions & 2 deletions cmd/timescale-reader/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,9 @@ func main() {

func newService(db *sqlx.DB, logger *slog.Logger) readers.MessageRepository {
svc := timescale.New(db)
svc = middleware.LoggingMiddleware(svc, logger)
svc = middleware.Logging(svc, logger)
counter, latency := prometheus.MakeMetrics("timescale", "message_reader")
svc = middleware.MetricsMiddleware(svc, counter, latency)
svc = middleware.Metrics(svc, counter, latency)

return svc
}
16 changes: 8 additions & 8 deletions cmd/users/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -277,18 +277,18 @@ func newService(ctx context.Context, authz mgauthz.Authorization, token magistra
return nil, nil, err
}

csvc = cmiddleware.AuthorizationMiddleware(csvc, authz, c.SelfRegister)
gsvc = gmiddleware.AuthorizationMiddleware(gsvc, authz)
csvc = cmiddleware.Authorization(csvc, authz, c.SelfRegister)
gsvc = gmiddleware.Authorization(gsvc, authz)

csvc = cmiddleware.TracingMiddleware(csvc, tracer)
csvc = cmiddleware.LoggingMiddleware(csvc, logger)
csvc = cmiddleware.Tracing(csvc, tracer)
csvc = cmiddleware.Logging(csvc, logger)
counter, latency := prometheus.MakeMetrics(svcName, "api")
csvc = cmiddleware.MetricsMiddleware(csvc, counter, latency)
csvc = cmiddleware.Metrics(csvc, counter, latency)

gsvc = gmiddleware.TracingMiddleware(gsvc, tracer)
gsvc = gmiddleware.LoggingMiddleware(gsvc, logger)
gsvc = gmiddleware.Tracing(gsvc, tracer)
gsvc = gmiddleware.Logging(gsvc, logger)
counter, latency = prometheus.MakeMetrics("groups", "api")
gsvc = gmiddleware.MetricsMiddleware(gsvc, counter, latency)
gsvc = gmiddleware.Metrics(gsvc, counter, latency)

clientID, err := createAdmin(ctx, c, cRepo, hsr, csvc)
if err != nil {
Expand Down
6 changes: 3 additions & 3 deletions cmd/ws/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -156,10 +156,10 @@ func main() {

func newService(thingsClient magistrala.ThingsServiceClient, nps messaging.PubSub, logger *slog.Logger, tracer trace.Tracer) ws.Service {
svc := ws.New(thingsClient, nps)
svc = middleware.TracingMiddleware(tracer, svc)
svc = middleware.LoggingMiddleware(svc, logger)
svc = middleware.Tracing(tracer, svc)
svc = middleware.Logging(svc, logger)
counter, latency := prometheus.MakeMetrics("ws_adapter", "api")
svc = middleware.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 @@ -27,8 +27,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 31 in coap/middleware/tracing.go

View check run for this annotation

Codecov / codecov/patch

coap/middleware/tracing.go#L31

Added line #L31 was not covered by tests
return &tracingServiceMiddleware{
tracer: tracer,
svc: svc,
Expand Down
4 changes: 2 additions & 2 deletions consumers/notifiers/middleware/logging.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ type loggingMiddleware struct {
svc notifiers.Service
}

// LoggingMiddleware adds logging facilities to the core service.
func LoggingMiddleware(svc notifiers.Service, logger *slog.Logger) notifiers.Service {
// Logging adds logging facilities to the core service.
func Logging(svc notifiers.Service, logger *slog.Logger) notifiers.Service {
return &loggingMiddleware{logger, svc}

Check warning on line 25 in consumers/notifiers/middleware/logging.go

View check run for this annotation

Codecov / codecov/patch

consumers/notifiers/middleware/logging.go#L24-L25

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

Expand Down
4 changes: 2 additions & 2 deletions consumers/notifiers/middleware/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ type metricsMiddleware struct {
svc notifiers.Service
}

// MetricsMiddleware instruments core service by tracking request count and latency.
func MetricsMiddleware(svc notifiers.Service, counter metrics.Counter, latency metrics.Histogram) notifiers.Service {
// Metrics instruments core service by tracking request count and latency.
func Metrics(svc notifiers.Service, counter metrics.Counter, latency metrics.Histogram) notifiers.Service {
return &metricsMiddleware{
counter: counter,
latency: latency,
Expand Down
4 changes: 2 additions & 2 deletions internal/groups/middleware/authorization.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ type authorizationMiddleware struct {
authz mgauthz.Authorization
}

// AuthorizationMiddleware adds authorization to the clients service.
func AuthorizationMiddleware(svc groups.Service, authz mgauthz.Authorization) groups.Service {
// Authorization adds authorization to the clients service.
func Authorization(svc groups.Service, authz mgauthz.Authorization) groups.Service {

Check warning on line 25 in internal/groups/middleware/authorization.go

View check run for this annotation

Codecov / codecov/patch

internal/groups/middleware/authorization.go#L25

Added line #L25 was not covered by tests
return &authorizationMiddleware{
svc: svc,
authz: authz,
Expand Down
4 changes: 2 additions & 2 deletions internal/groups/middleware/logging.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ type loggingMiddleware struct {
svc groups.Service
}

// LoggingMiddleware adds logging facilities to the groups service.
func LoggingMiddleware(svc groups.Service, logger *slog.Logger) groups.Service {
// Logging adds logging facilities to the groups service.
func Logging(svc groups.Service, logger *slog.Logger) groups.Service {
return &loggingMiddleware{logger, svc}

Check warning on line 24 in internal/groups/middleware/logging.go

View check run for this annotation

Codecov / codecov/patch

internal/groups/middleware/logging.go#L23-L24

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

Expand Down
4 changes: 2 additions & 2 deletions internal/groups/middleware/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ type metricsMiddleware struct {
svc groups.Service
}

// MetricsMiddleware instruments policies service by tracking request count and latency.
func MetricsMiddleware(svc groups.Service, counter metrics.Counter, latency metrics.Histogram) groups.Service {
// Metrics instruments policies service by tracking request count and latency.
func Metrics(svc groups.Service, counter metrics.Counter, latency metrics.Histogram) groups.Service {
return &metricsMiddleware{
counter: counter,
latency: latency,
Expand Down
4 changes: 2 additions & 2 deletions internal/groups/middleware/tracing.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ type tracingMiddleware struct {
gsvc groups.Service
}

// TracingMiddleware returns a new group service with tracing capabilities.
func TracingMiddleware(gsvc groups.Service, tracer trace.Tracer) groups.Service {
// Tracing returns a new group service with tracing capabilities.
func Tracing(gsvc groups.Service, tracer trace.Tracer) groups.Service {

Check warning on line 23 in internal/groups/middleware/tracing.go

View check run for this annotation

Codecov / codecov/patch

internal/groups/middleware/tracing.go#L23

Added line #L23 was not covered by tests
return &tracingMiddleware{tracer, gsvc}
}

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
Loading

0 comments on commit 430d8c0

Please sign in to comment.