Skip to content

Commit d4d5791

Browse files
authored
feat!: introduce logger choice via slog (#292)
## Breaking Changes This package now accepts a `*slog.Logger` from the Go standard library, rather than a [Lager logger](https://github.com/cloudfoundry/lager). This allows the use of alternative loggers. - This package no longer requires you to import `code.cloudfoundry.org/lager/v3`. - The constructors `New()`, `NewWithCustomAuth()`, `NewWithOptions()`, and also `AttachRoutes()` all take a `*slog.Logger` - `apiresponses.FailureResponse` errors with a `ValidatedStatusCode()` method also take a `*slog.Logger` rather than a Lager logger - The middleware `middlewares.APIVersionMiddleware` has had the `LoggerFactory` field removed, and a new field `Logger` added with type `*slog.Logger`. If you want to continue to use Lager, you can just convert it to a `*slog.Logger`, for which you will need Lager [v3.0.3](https://github.com/cloudfoundry/lager/releases/tag/v3.0.3) for example: ```go logger := lager.NewLogger("a-lager-logger") router := brokerapi.New(serviceBroker, slog.New(lager.NewHandler(logger)), credentials) ``` ## Reasons Historically brokerapi has required use of the [`lager`](https://github.com/cloudfoundry/lager) logger. In Go 1.21, structured logging was introduced into the Go standard library via the [`log/slog`](https://pkg.go.dev/log/slog) package, and `slog` [compatability was added](cloudfoundry/lager@4bf4955) to `lager`. `brokerapi` has been modified to require a `slog` logger to be passed rather than a `lager` logger. This allows users a choice of logger. Users who still want to use lager can easily do that using the lager/slog compatability. And users who want to use `slog` or an `slog`-compatible logger can do that instead. A key advantage is that `lager` is no longer a dependency of this package, which simplifies package management for apps that use brokerapi and other libraries which use `lager`. Resolves #267
1 parent 6992873 commit d4d5791

28 files changed

+427
-311
lines changed

.github/workflows/run-tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
runs-on: ubuntu-latest
1616
strategy:
1717
matrix:
18-
version: [ 'stable', 'oldstable', '1.20' ]
18+
version: [ 'stable', 'oldstable', '1.21' ]
1919
name: Go ${{ matrix.version }}
2020
outputs:
2121
pr_number: ${{ github.event.number }}

api.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
package brokerapi
1717

1818
import (
19+
"log/slog"
1920
"net/http"
2021

21-
"code.cloudfoundry.org/lager/v3"
2222
"github.com/go-chi/chi/v5"
2323
"github.com/pivotal-cf/brokerapi/v10/handlers"
2424
)
@@ -28,19 +28,19 @@ type BrokerCredentials struct {
2828
Password string
2929
}
3030

31-
func New(serviceBroker ServiceBroker, logger lager.Logger, brokerCredentials BrokerCredentials) http.Handler {
31+
func New(serviceBroker ServiceBroker, logger *slog.Logger, brokerCredentials BrokerCredentials) http.Handler {
3232
return NewWithOptions(serviceBroker, logger, WithBrokerCredentials(brokerCredentials))
3333
}
3434

35-
func NewWithCustomAuth(serviceBroker ServiceBroker, logger lager.Logger, authMiddleware middlewareFunc) http.Handler {
35+
func NewWithCustomAuth(serviceBroker ServiceBroker, logger *slog.Logger, authMiddleware middlewareFunc) http.Handler {
3636
return NewWithOptions(serviceBroker, logger, WithCustomAuth(authMiddleware))
3737
}
3838

39-
func AttachRoutes(router chi.Router, serviceBroker ServiceBroker, logger lager.Logger) {
39+
func AttachRoutes(router chi.Router, serviceBroker ServiceBroker, logger *slog.Logger) {
4040
attachRoutes(router, serviceBroker, logger)
4141
}
4242

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

api_options.go

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
package brokerapi
1717

1818
import (
19+
"log/slog"
1920
"net/http"
2021

21-
"code.cloudfoundry.org/lager/v3"
2222
"github.com/go-chi/chi/v5"
2323
"github.com/pivotal-cf/brokerapi/v10/auth"
2424
"github.com/pivotal-cf/brokerapi/v10/domain"
@@ -30,17 +30,13 @@ type middlewareFunc func(http.Handler) http.Handler
3030
type config struct {
3131
router chi.Router
3232
customRouter bool
33-
logger lager.Logger
3433
additionalMiddleware []middlewareFunc
3534
}
3635

37-
func NewWithOptions(serviceBroker domain.ServiceBroker, logger lager.Logger, opts ...Option) http.Handler {
38-
cfg := config{
39-
router: chi.NewRouter(),
40-
logger: logger,
41-
}
36+
func NewWithOptions(serviceBroker domain.ServiceBroker, logger *slog.Logger, opts ...Option) http.Handler {
37+
cfg := config{router: chi.NewRouter()}
4238

43-
WithOptions(append(opts, withDefaultMiddleware())...)(&cfg)
39+
WithOptions(append(opts, withDefaultMiddleware(logger))...)(&cfg)
4440
attachRoutes(cfg.router, serviceBroker, logger)
4541

4642
return cfg.router
@@ -91,11 +87,11 @@ func WithEncodedPath() Option {
9187
return func(*config) {}
9288
}
9389

94-
func withDefaultMiddleware() Option {
90+
func withDefaultMiddleware(logger *slog.Logger) Option {
9591
return func(c *config) {
9692
if !c.customRouter {
9793
defaults := []middlewareFunc{
98-
middlewares.APIVersionMiddleware{LoggerFactory: c.logger}.ValidateAPIVersionHdr,
94+
middlewares.APIVersionMiddleware{Logger: logger}.ValidateAPIVersionHdr,
9995
middlewares.AddCorrelationIDToContext,
10096
middlewares.AddOriginatingIdentityToContext,
10197
middlewares.AddInfoLocationToContext,

0 commit comments

Comments
 (0)