diff --git a/internal/httpserver/helpers_test.go b/internal/httpserver/helpers_test.go index 304b02e3..c17fa859 100644 --- a/internal/httpserver/helpers_test.go +++ b/internal/httpserver/helpers_test.go @@ -7,7 +7,6 @@ import ( gomock "github.com/golang/mock/gomock" ) -func stringPtr(s string) *string { return &s } func durationPtr(d time.Duration) *time.Duration { return &d } var _ Logger = (*testLogger)(nil) diff --git a/internal/httpserver/run.go b/internal/httpserver/run.go index 04284033..0fe61da4 100644 --- a/internal/httpserver/run.go +++ b/internal/httpserver/run.go @@ -23,12 +23,12 @@ func (s *Server) Run(ctx context.Context, ready chan<- struct{}, done chan<- str return } - s.logger.Warn(s.name + " http server shutting down: " + ctx.Err().Error()) + s.logger.Warn("http server shutting down: " + ctx.Err().Error()) shutdownCtx, cancel := context.WithTimeout( context.Background(), s.shutdownTimeout) defer cancel() if err := server.Shutdown(shutdownCtx); err != nil { - s.logger.Error(s.name + " http server failed shutting down within " + + s.logger.Error("http server failed shutting down within " + s.shutdownTimeout.String()) } }() @@ -47,7 +47,7 @@ func (s *Server) Run(ctx context.Context, ready chan<- struct{}, done chan<- str close(s.addressSet) // note: no further write so no need to mutex - s.logger.Info(s.name + " http server listening on " + s.address) + s.logger.Info("http server listening on " + s.address) close(ready) err = server.Serve(listener) diff --git a/internal/httpserver/run_test.go b/internal/httpserver/run_test.go index f6a4055b..4da72eac 100644 --- a/internal/httpserver/run_test.go +++ b/internal/httpserver/run_test.go @@ -16,12 +16,11 @@ func Test_Server_Run_success(t *testing.T) { ctrl := gomock.NewController(t) logger := NewMockLogger(ctrl) - logger.EXPECT().Info(newRegexMatcher("^test http server listening on 127.0.0.1:[1-9][0-9]{0,4}$")) - logger.EXPECT().Warn("test http server shutting down: context canceled") + logger.EXPECT().Info(newRegexMatcher("^http server listening on 127.0.0.1:[1-9][0-9]{0,4}$")) + logger.EXPECT().Warn("http server shutting down: context canceled") const shutdownTimeout = 10 * time.Second server := &Server{ - name: "test", address: "127.0.0.1:0", addressSet: make(chan struct{}), logger: logger, @@ -55,7 +54,6 @@ func Test_Server_Run_failure(t *testing.T) { logger.EXPECT().Error("listen tcp: address -1: invalid port") server := &Server{ - name: "test", address: "127.0.0.1:-1", addressSet: make(chan struct{}), logger: logger, diff --git a/internal/httpserver/server.go b/internal/httpserver/server.go index 0c0e7b2a..3c2562f0 100644 --- a/internal/httpserver/server.go +++ b/internal/httpserver/server.go @@ -29,7 +29,6 @@ type AddressGetter interface { // Server is an HTTP server implementation, which uses // the HTTP handler provided. type Server struct { - name string address string addressSet chan struct{} handler http.Handler @@ -47,7 +46,6 @@ func New(settings Settings) (s *Server, err error) { } return &Server{ - name: *settings.Name, address: settings.Address, addressSet: make(chan struct{}), handler: settings.Handler, diff --git a/internal/httpserver/server_test.go b/internal/httpserver/server_test.go index 2a097806..330b9af4 100644 --- a/internal/httpserver/server_test.go +++ b/internal/httpserver/server_test.go @@ -29,14 +29,12 @@ func Test_New(t *testing.T) { }, "filled settings": { settings: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, ShutdownTimeout: durationPtr(time.Second), }, expected: &Server{ - name: "name", address: ":8001", handler: someHandler, logger: someLogger, diff --git a/internal/httpserver/settings.go b/internal/httpserver/settings.go index f84ad439..e0bd0227 100644 --- a/internal/httpserver/settings.go +++ b/internal/httpserver/settings.go @@ -5,7 +5,6 @@ import ( "fmt" "net/http" "os" - "strings" "time" "github.com/qdm12/gluetun/internal/configuration/settings/helpers" @@ -14,9 +13,6 @@ import ( ) type Settings struct { - // Name is the server name to use in logs. - // It defaults to the empty string. - Name *string // Address is the server listening address. // It defaults to :8000. Address string @@ -32,7 +28,6 @@ type Settings struct { } func (s *Settings) SetDefaults() { - s.Name = helpers.DefaultStringPtr(s.Name, "") s.Address = helpers.DefaultString(s.Address, ":8000") const defaultShutdownTimeout = 3 * time.Second s.ShutdownTimeout = helpers.DefaultDuration(s.ShutdownTimeout, defaultShutdownTimeout) @@ -40,7 +35,6 @@ func (s *Settings) SetDefaults() { func (s Settings) Copy() Settings { return Settings{ - Name: helpers.CopyStringPtr(s.Name), Address: s.Address, Handler: s.Handler, Logger: s.Logger, @@ -49,7 +43,6 @@ func (s Settings) Copy() Settings { } func (s *Settings) MergeWith(other Settings) { - s.Name = helpers.MergeWithStringPtr(s.Name, other.Name) s.Address = helpers.MergeWithString(s.Address, other.Address) s.Handler = helpers.MergeWithHTTPHandler(s.Handler, other.Handler) if s.Logger == nil { @@ -59,7 +52,6 @@ func (s *Settings) MergeWith(other Settings) { } func (s *Settings) OverrideWith(other Settings) { - s.Name = helpers.OverrideWithStringPtr(s.Name, other.Name) s.Address = helpers.OverrideWithString(s.Address, other.Address) s.Handler = helpers.OverrideWithHTTPHandler(s.Handler, other.Handler) if other.Logger != nil { @@ -100,7 +92,7 @@ func (s Settings) Validate() (err error) { } func (s Settings) ToLinesNode() (node *gotree.Node) { - node = gotree.New("%s HTTP server settings:", strings.Title(*s.Name)) + node = gotree.New("HTTP server settings:") node.Appendf("Listening address: %s", s.Address) node.Appendf("Shutdown timeout: %s", *s.ShutdownTimeout) return node diff --git a/internal/httpserver/settings_test.go b/internal/httpserver/settings_test.go index 2fae6a14..8f4bdb1f 100644 --- a/internal/httpserver/settings_test.go +++ b/internal/httpserver/settings_test.go @@ -21,19 +21,16 @@ func Test_Settings_SetDefaults(t *testing.T) { "empty settings": { settings: Settings{}, expected: Settings{ - Name: stringPtr(""), Address: ":8000", ShutdownTimeout: durationPtr(defaultTimeout), }, }, "filled settings": { settings: Settings{ - Name: stringPtr("name"), Address: ":8001", ShutdownTimeout: durationPtr(time.Second), }, expected: Settings{ - Name: stringPtr("name"), Address: ":8001", ShutdownTimeout: durationPtr(time.Second), }, @@ -65,14 +62,12 @@ func Test_Settings_Copy(t *testing.T) { "empty settings": {}, "filled settings": { settings: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, ShutdownTimeout: durationPtr(time.Second), }, expected: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, @@ -107,14 +102,12 @@ func Test_Settings_MergeWith(t *testing.T) { "merge empty with empty": {}, "merge empty with filled": { other: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, ShutdownTimeout: durationPtr(time.Second), }, expected: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, @@ -123,14 +116,12 @@ func Test_Settings_MergeWith(t *testing.T) { }, "merge filled with empty": { settings: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, ShutdownTimeout: durationPtr(time.Second), }, expected: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, @@ -165,14 +156,12 @@ func Test_Settings_OverrideWith(t *testing.T) { "override empty with empty": {}, "override empty with filled": { other: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, ShutdownTimeout: durationPtr(time.Second), }, expected: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, @@ -181,14 +170,12 @@ func Test_Settings_OverrideWith(t *testing.T) { }, "override filled with empty": { settings: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, ShutdownTimeout: durationPtr(time.Second), }, expected: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, @@ -197,19 +184,16 @@ func Test_Settings_OverrideWith(t *testing.T) { }, "override filled with filled": { settings: Settings{ - Name: stringPtr("name"), Address: ":8001", Handler: someHandler, Logger: someLogger, ShutdownTimeout: durationPtr(time.Second), }, other: Settings{ - Name: stringPtr("name2"), Address: ":8002", ShutdownTimeout: durationPtr(time.Hour), }, expected: Settings{ - Name: stringPtr("name2"), Address: ":8002", Handler: someHandler, Logger: someLogger, @@ -307,11 +291,10 @@ func Test_Settings_String(t *testing.T) { }{ "all values": { settings: Settings{ - Name: stringPtr("name"), Address: ":8000", ShutdownTimeout: durationPtr(time.Second), }, - s: `Name HTTP server settings: + s: `HTTP server settings: ├── Listening address: :8000 └── Shutdown timeout: 1s`, }, diff --git a/internal/pprof/helpers_test.go b/internal/pprof/helpers_test.go index 168a5be2..f74e6d6a 100644 --- a/internal/pprof/helpers_test.go +++ b/internal/pprof/helpers_test.go @@ -8,7 +8,6 @@ import ( ) func boolPtr(b bool) *bool { return &b } -func stringPtr(s string) *string { return &s } func durationPtr(d time.Duration) *time.Duration { return &d } var _ gomock.Matcher = (*regexMatcher)(nil) diff --git a/internal/pprof/server.go b/internal/pprof/server.go index ad246eca..10cb7420 100644 --- a/internal/pprof/server.go +++ b/internal/pprof/server.go @@ -26,9 +26,6 @@ func New(settings Settings) (server *httpserver.Server, err error) { handler.Handle("/debug/pprof/goroutine", pprof.Handler("goroutine")) handler.Handle("/debug/pprof/heap", pprof.Handler("heap")) handler.Handle("/debug/pprof/threadcreate", pprof.Handler("threadcreate")) - - httpServerName := "pprof" - settings.HTTPServer.Name = &httpServerName settings.HTTPServer.Handler = handler settings.SetDefaults() diff --git a/internal/pprof/server_test.go b/internal/pprof/server_test.go index e4d91123..0d3cd588 100644 --- a/internal/pprof/server_test.go +++ b/internal/pprof/server_test.go @@ -22,8 +22,8 @@ func Test_Server(t *testing.T) { const address = "127.0.0.1:0" logger := NewMockLogger(ctrl) - logger.EXPECT().Info(newRegexMatcher("^pprof http server listening on 127.0.0.1:[1-9][0-9]{0,4}$")) - logger.EXPECT().Warn("pprof http server shutting down: context canceled") + logger.EXPECT().Info(newRegexMatcher("^http server listening on 127.0.0.1:[1-9][0-9]{0,4}$")) + logger.EXPECT().Warn("http server shutting down: context canceled") const httpServerShutdownTimeout = 10 * time.Second // 10s in case test worker is slow settings := Settings{ diff --git a/internal/pprof/settings.go b/internal/pprof/settings.go index 5d0ece0e..a0d1bff4 100644 --- a/internal/pprof/settings.go +++ b/internal/pprof/settings.go @@ -26,7 +26,6 @@ type Settings struct { func (s *Settings) SetDefaults() { s.Enabled = helpers.DefaultBool(s.Enabled, false) - s.HTTPServer.Name = helpers.DefaultStringPtr(s.HTTPServer.Name, "pprof") s.HTTPServer.Address = helpers.DefaultString(s.HTTPServer.Address, "localhost:6060") s.HTTPServer.SetDefaults() } diff --git a/internal/pprof/settings_test.go b/internal/pprof/settings_test.go index ac5b953e..0ae9d155 100644 --- a/internal/pprof/settings_test.go +++ b/internal/pprof/settings_test.go @@ -21,7 +21,6 @@ func Test_Settings_SetDefaults(t *testing.T) { expected: Settings{ Enabled: boolPtr(false), HTTPServer: httpserver.Settings{ - Name: stringPtr("pprof"), Address: "localhost:6060", ShutdownTimeout: durationPtr(3 * time.Second), }, @@ -33,7 +32,6 @@ func Test_Settings_SetDefaults(t *testing.T) { BlockProfileRate: 1, MutexProfileRate: 1, HTTPServer: httpserver.Settings{ - Name: stringPtr("custom"), Address: ":6061", ShutdownTimeout: durationPtr(time.Second), }, @@ -43,7 +41,6 @@ func Test_Settings_SetDefaults(t *testing.T) { BlockProfileRate: 1, MutexProfileRate: 1, HTTPServer: httpserver.Settings{ - Name: stringPtr("custom"), Address: ":6061", ShutdownTimeout: durationPtr(time.Second), }, @@ -77,7 +74,6 @@ func Test_Settings_Copy(t *testing.T) { BlockProfileRate: 1, MutexProfileRate: 1, HTTPServer: httpserver.Settings{ - Name: stringPtr("custom"), Address: ":6061", ShutdownTimeout: durationPtr(time.Second), }, @@ -87,7 +83,6 @@ func Test_Settings_Copy(t *testing.T) { BlockProfileRate: 1, MutexProfileRate: 1, HTTPServer: httpserver.Settings{ - Name: stringPtr("custom"), Address: ":6061", ShutdownTimeout: durationPtr(time.Second), }, @@ -325,7 +320,6 @@ func Test_Settings_String(t *testing.T) { BlockProfileRate: 2, MutexProfileRate: 1, HTTPServer: httpserver.Settings{ - Name: stringPtr("name"), Address: ":8000", ShutdownTimeout: durationPtr(time.Second), }, @@ -333,7 +327,7 @@ func Test_Settings_String(t *testing.T) { s: `Pprof settings: ├── Block profile rate: 2 ├── Mutex profile rate: 1 -└── Name HTTP server settings: +└── HTTP server settings: ├── Listening address: :8000 └── Shutdown timeout: 1s`, },