Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: introduce logger choice via slog #292

Merged
merged 6 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
version: [ 'stable', 'oldstable', '1.20' ]
version: [ 'stable', 'oldstable', '1.21' ]
name: Go ${{ matrix.version }}
outputs:
pr_number: ${{ github.event.number }}
Expand Down
10 changes: 5 additions & 5 deletions api.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
package brokerapi

import (
"log/slog"
"net/http"

"code.cloudfoundry.org/lager/v3"
"github.com/go-chi/chi/v5"
"github.com/pivotal-cf/brokerapi/v10/handlers"
)
Expand All @@ -28,19 +28,19 @@ type BrokerCredentials struct {
Password string
}

func New(serviceBroker ServiceBroker, logger lager.Logger, brokerCredentials BrokerCredentials) http.Handler {
func New(serviceBroker ServiceBroker, logger *slog.Logger, brokerCredentials BrokerCredentials) http.Handler {
return NewWithOptions(serviceBroker, logger, WithBrokerCredentials(brokerCredentials))
}

func NewWithCustomAuth(serviceBroker ServiceBroker, logger lager.Logger, authMiddleware middlewareFunc) http.Handler {
func NewWithCustomAuth(serviceBroker ServiceBroker, logger *slog.Logger, authMiddleware middlewareFunc) http.Handler {
return NewWithOptions(serviceBroker, logger, WithCustomAuth(authMiddleware))
}

func AttachRoutes(router chi.Router, serviceBroker ServiceBroker, logger lager.Logger) {
func AttachRoutes(router chi.Router, serviceBroker ServiceBroker, logger *slog.Logger) {
attachRoutes(router, serviceBroker, logger)
}

func attachRoutes(router chi.Router, serviceBroker ServiceBroker, logger lager.Logger) {
func attachRoutes(router chi.Router, serviceBroker ServiceBroker, logger *slog.Logger) {
apiHandler := handlers.NewApiHandler(serviceBroker, logger)
router.Get("/v2/catalog", apiHandler.Catalog)

Expand Down
16 changes: 6 additions & 10 deletions api_options.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
package brokerapi

import (
"log/slog"
"net/http"

"code.cloudfoundry.org/lager/v3"
"github.com/go-chi/chi/v5"
"github.com/pivotal-cf/brokerapi/v10/auth"
"github.com/pivotal-cf/brokerapi/v10/domain"
Expand All @@ -30,17 +30,13 @@ type middlewareFunc func(http.Handler) http.Handler
type config struct {
router chi.Router
customRouter bool
logger lager.Logger
additionalMiddleware []middlewareFunc
}

func NewWithOptions(serviceBroker domain.ServiceBroker, logger lager.Logger, opts ...Option) http.Handler {
cfg := config{
router: chi.NewRouter(),
logger: logger,
}
func NewWithOptions(serviceBroker domain.ServiceBroker, logger *slog.Logger, opts ...Option) http.Handler {
cfg := config{router: chi.NewRouter()}

WithOptions(append(opts, withDefaultMiddleware())...)(&cfg)
WithOptions(append(opts, withDefaultMiddleware(logger))...)(&cfg)
attachRoutes(cfg.router, serviceBroker, logger)

return cfg.router
Expand Down Expand Up @@ -91,11 +87,11 @@ func WithEncodedPath() Option {
return func(*config) {}
}

func withDefaultMiddleware() Option {
func withDefaultMiddleware(logger *slog.Logger) Option {
return func(c *config) {
if !c.customRouter {
defaults := []middlewareFunc{
middlewares.APIVersionMiddleware{LoggerFactory: c.logger}.ValidateAPIVersionHdr,
middlewares.APIVersionMiddleware{Logger: logger}.ValidateAPIVersionHdr,
middlewares.AddCorrelationIDToContext,
middlewares.AddOriginatingIdentityToContext,
middlewares.AddInfoLocationToContext,
Expand Down
Loading
Loading