From 1142eef56c72dbbe2fad75fbe50ce32d6e92d906 Mon Sep 17 00:00:00 2001 From: Andy Pliszka Date: Fri, 20 Sep 2024 09:38:50 -0400 Subject: [PATCH] chore: code cleanup --- README.md | 2 +- cmd/flags.go | 2 +- cmd/start.go | 12 ++---------- cmd/start_test.go | 30 +++++++++++++++--------------- 4 files changed, 19 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 095fcd323..88e296a93 100644 --- a/README.md +++ b/README.md @@ -193,7 +193,7 @@ Additional information on how IBC works can be found [here](https://ibc.cosmos.n $ rly start ``` - >When running multiple instances of `rly start`, you will need to use the `--debug-listen-addr` flag and provide an address:port. You can also pass an empty string `''` to turn off this feature or pass `localhost:0` to randomly select a port. + >When running multiple instances of `rly start`, you will need to use the `--enable-debug-server` and `--debug-listen-addr` flag and provide an address:port. You can also pass an empty string `''` to turn off this feature or pass `localhost:0` to randomly select a port. --- [[TROUBLESHOOTING](docs/troubleshooting.md)] diff --git a/cmd/flags.go b/cmd/flags.go index aa78be2eb..c87c90c5b 100644 --- a/cmd/flags.go +++ b/cmd/flags.go @@ -424,7 +424,7 @@ func debugServerFlags(v *viper.Viper, cmd *cobra.Command) *cobra.Command { cmd.Flags().String( flagDebugListenAddr, "", - "address to use for debug and metrics server. By default, "+ + "address to use for debug server. By default, "+ "will be the debug-listen-addr parameter in the global config. "+ "Make sure to enable debug server using --enable-debug-server flag.", ) diff --git a/cmd/start.go b/cmd/start.go index a289adbd6..f36374d3c 100644 --- a/cmd/start.go +++ b/cmd/start.go @@ -199,11 +199,7 @@ func setupMetricsServer(cmd *cobra.Command, a *appState, err error, chains map[s a.log.Info("Metrics server is enabled") ln, err := net.Listen("tcp", metricsListenAddr) if err != nil { - a.log.Error( - "Failed to listen on metrics address. If you have another relayer process open, use --" + - metricsListenAddr + - " to pick a different address or port.", - ) + a.log.Error(fmt.Sprintf("Failed to start metrics server. You can change the address and port using metrics-listen-addr config settingh or --metrics-listen-flag.")) return nil, fmt.Errorf("failed to listen on metrics address %q: %w", metricsListenAddr, err) } @@ -246,11 +242,7 @@ func setupDebugServer(cmd *cobra.Command, a *appState, err error) error { a.log.Warn("SECURITY WARNING! Debug server should only be run with caution and proper security in place.") ln, err := net.Listen("tcp", debugListenAddr) if err != nil { - a.log.Error( - "Failed to listen on debug address. If you have another relayer process open, use --" + - debugListenAddr + - " to pick a different address or port.", - ) + a.log.Error(fmt.Sprintf("Failed to start debug server. You can change the address and port using debug-listen-addr config settingh or --debug-listen-flag.")) return fmt.Errorf("failed to listen on debug address %q: %w", debugListenAddr, err) } diff --git a/cmd/start_test.go b/cmd/start_test.go index 90c4a97dc..bd89dff11 100644 --- a/cmd/start_test.go +++ b/cmd/start_test.go @@ -18,7 +18,7 @@ import ( "go.uber.org/zap/zaptest/observer" ) -func TestMetricsServerFlag(t *testing.T) { +func TestMetricsServerFlags(t *testing.T) { t.Parallel() tests := []struct { @@ -136,7 +136,7 @@ func TestMissingMetricsListenAddr(t *testing.T) { requireMessage(t, logs, "Disabled metrics server due to missing metrics-listen-addr setting in config file or --metrics-listen-addr flag.") } -func TestDebugServerFlag(t *testing.T) { +func TestDebugServerFlags(t *testing.T) { t.Parallel() tests := []struct { @@ -182,19 +182,6 @@ func TestDebugServerFlag(t *testing.T) { } } -func TestMissingDebugListenAddr(t *testing.T) { - sys := setupRelayer(t) - - logs, logger := setupLogger() - - updateConfig(t, sys, "debug-listen-addr: 127.0.0.1:5183", "") - - sys.MustRunWithLogger(t, logger, []string{"start", "--enable-debug-server"}...) - - requireDisabledMetricsServer(t, logs, 0) - requireMessage(t, logs, "Disabled debug server due to missing debug-listen-addr setting in config file or --debug-listen-addr flag.") -} - func TestDebugServerConfig(t *testing.T) { t.Parallel() @@ -237,6 +224,19 @@ func TestDebugServerConfig(t *testing.T) { } } +func TestMissingDebugListenAddr(t *testing.T) { + sys := setupRelayer(t) + + logs, logger := setupLogger() + + updateConfig(t, sys, "debug-listen-addr: 127.0.0.1:5183", "") + + sys.MustRunWithLogger(t, logger, []string{"start", "--enable-debug-server"}...) + + requireDisabledMetricsServer(t, logs, 0) + requireMessage(t, logs, "Disabled debug server due to missing debug-listen-addr setting in config file or --debug-listen-addr flag.") +} + func requireDisabledMetricsServer(t *testing.T, logs *observer.ObservedLogs, port int) { conn, err := net.Dial("tcp", fmt.Sprintf("127.0.0.1:%d", port)) if conn != nil {