add config ActivateRPCLog

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>

Author: Nexucis

config/config.go

@@ -66,9 +66,10 @@ var mapLogFormat = map[LogFormat]bool{ // nolint: gochecknoglobals
 
 // Config contains the configuration for a server.
 type Config struct {
-	LogFormat     LogFormat `yaml:"log_format"`
-	PrometheusURL string    `yaml:"prometheus_url"`
-	RESTAPIPort   uint64    `yaml:"rest_api_port"`
+	ActivateRPCLog bool      `yaml:"activate_rpc_log"`
+	LogFormat      LogFormat `yaml:"log_format"`
+	PrometheusURL  string    `yaml:"prometheus_url"`
+	RESTAPIPort    uint64    `yaml:"rest_api_port"`
 }
 
 // UnmarshalYAML overrides a function used internally by the yaml.v3 lib.
@@ -88,8 +89,9 @@ func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error {
 func (c *Config) unmarshalENV() error {
 	prefix := "LANGSERVER"
 	conf := &struct {
-		LogFormat     string
-		PrometheusURL string
+		ActivateRPCLog bool
+		LogFormat      string
+		PrometheusURL  string
 		// the envconfig lib is not able to convert an empty string to the value 0
 		// so we have to convert it manually
 		RESTAPIPort string
@@ -104,6 +106,7 @@ func (c *Config) unmarshalENV() error {
 			return parseError
 		}
 	}
+	c.ActivateRPCLog = conf.ActivateRPCLog
 	c.PrometheusURL = conf.PrometheusURL
 	c.LogFormat = LogFormat(conf.LogFormat)
 	return c.Validate()

config/config_test.go

@@ -30,20 +30,23 @@ func TestUnmarshalENV(t *testing.T) {
 			title:     "empty config",
 			variables: map[string]string{},
 			expected: &Config{
-				LogFormat: TextFormat,
+				ActivateRPCLog: false,
+				LogFormat:      TextFormat,
 			},
 		},
 		{
 			title: "full config",
 			variables: map[string]string{
-				"LANGSERVER_PROMETHEUSURL": "http://localhost:9090",
-				"LANGSERVER_RESTAPIPORT":   "8080",
-				"LANGSERVER_LOGFORMAT":     "json",
+				"LANGSERVER_ACTIVATERPCLOG": "true",
+				"LANGSERVER_PROMETHEUSURL":  "http://localhost:9090",
+				"LANGSERVER_RESTAPIPORT":    "8080",
+				"LANGSERVER_LOGFORMAT":      "json",
 			},
 			expected: &Config{
-				PrometheusURL: "http://localhost:9090",
-				RESTAPIPort:   8080,
-				LogFormat:     JSONFormat,
+				ActivateRPCLog: true,
+				PrometheusURL:  "http://localhost:9090",
+				RESTAPIPort:    8080,
+				LogFormat:      JSONFormat,
 			},
 		},
 	}

langserver/server.go

@@ -106,19 +106,21 @@ func CreateHeadlessServer(ctx context.Context, metadataService promClient.Metada
 func ServerFromStream(ctx context.Context, stream jsonrpc2.Stream, conf *config.Config) (context.Context, Server) {
 	s := &server{}
 
-	switch conf.LogFormat {
-	case config.TextFormat:
-		stream = protocol.LoggingStream(stream, os.Stderr)
-	case config.JSONFormat:
-		stream = jSONLogStream(stream, os.Stderr)
-	default:
-		err := fmt.Errorf("invalid log format: '%s'", conf.LogFormat)
-		// nolint: errcheck
-		s.client.ShowMessage(s.lifetime, &protocol.ShowMessageParams{
-			Type:    protocol.Error,
-			Message: err.Error(),
-		})
-		panic(err)
+	if conf.ActivateRPCLog {
+		switch conf.LogFormat {
+		case config.TextFormat:
+			stream = protocol.LoggingStream(stream, os.Stderr)
+		case config.JSONFormat:
+			stream = jSONLogStream(stream, os.Stderr)
+		default:
+			err := fmt.Errorf("invalid log format: '%s'", conf.LogFormat)
+			// nolint: errcheck
+			s.client.ShowMessage(s.lifetime, &protocol.ShowMessageParams{
+				Type:    protocol.Error,
+				Message: err.Error(),
+			})
+			panic(err)
+		}
 	}
 
 	s.Conn = jsonrpc2.NewConn(stream)