rename client in favor of metadataService

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

Author: Nexucis

langserver/completion.go

@@ -95,7 +95,7 @@ func (s *server) Completion(ctx context.Context, params *protocol.CompletionPara
 }
 
 func (s *server) completeMetricName(ctx context.Context, completions *[]protocol.CompletionItem, location *cache.Location, metricName string) error {
-	allMetadata, err := s.prometheusClient.AllMetricMetadata(ctx)
+	allMetadata, err := s.metadataService.AllMetricMetadata(ctx)
 	if err != nil {
 		return err
 	}
@@ -312,7 +312,7 @@ func (s *server) completeLabel(ctx context.Context, completions *[]protocol.Comp
 	if vs != nil {
 		metricName = vs.Name
 	}
-	allNames, err := s.prometheusClient.LabelNames(ctx, metricName, time.Now().Add(-100*time.Hour), time.Now())
+	allNames, err := s.metadataService.LabelNames(ctx, metricName, time.Now().Add(-100*time.Hour), time.Now())
 	if err != nil {
 		// nolint: errcheck
 		s.client.LogMessage(s.lifetime, &protocol.LogMessageParams{
@@ -355,7 +355,7 @@ OUTER:
 
 // nolint: funlen
 func (s *server) completeLabelValue(ctx context.Context, completions *[]protocol.CompletionItem, location *cache.Location, labelName string) error {
-	labelValues, err := s.prometheusClient.LabelValues(ctx, labelName)
+	labelValues, err := s.metadataService.LabelValues(ctx, labelName)
 	if err != nil {
 		// nolint: errcheck
 		s.client.LogMessage(s.lifetime, &protocol.LogMessageParams{

langserver/hover.go

@@ -138,7 +138,7 @@ func (s *server) nodeToDocMarkdown(ctx context.Context, location *cache.Location
 		}
 	}
 
-	promURL := s.prometheusClient.GetURL()
+	promURL := s.metadataService.GetURL()
 
 	if promURL != "" && !s.headless {
 		loc := *location
@@ -195,7 +195,7 @@ func (s *server) getMetricDocs(ctx context.Context, metric string) (string, erro
 	var ret strings.Builder
 	ret.WriteString(fmt.Sprintf("### %s\n\n", metric))
 
-	metadata, err := s.prometheusClient.MetricMetadata(ctx, metric)
+	metadata, err := s.metadataService.MetricMetadata(ctx, metric)
 	if err != nil {
 		return "", err
 	}

langserver/server.go

@@ -56,7 +56,7 @@ type server struct {
 
 	config *Config
 
-	prometheusClient promClient.Client
+	metadataService promClient.MetadataService
 
 	lifetime context.Context
 	exit     func()
@@ -80,12 +80,12 @@ func (s Server) Run() error {
 // CreateHeadlessServer creates a locked down server instance for the REST API.
 //
 // "locked down" in this case means, that the instance cannot send or receive any JSONRPC communication. Logging messages that the instance tries to send over JSONRPC are redirected to stderr.
-func CreateHeadlessServer(ctx context.Context, prometheusClient promClient.Client, logger log.Logger) (HeadlessServer, error) {
+func CreateHeadlessServer(ctx context.Context, metadataService promClient.MetadataService, logger log.Logger) (HeadlessServer, error) {
 	s := &server{
-		client:           &headlessClient{logger: logger},
-		headless:         true,
-		config:           &Config{PrometheusURL: prometheusClient.GetURL()},
-		prometheusClient: prometheusClient,
+		client:          &headlessClient{logger: logger},
+		headless:        true,
+		config:          &Config{PrometheusURL: metadataService.GetURL()},
+		metadataService: metadataService,
 	}
 
 	s.lifetime, s.exit = context.WithCancel(ctx)
@@ -130,13 +130,13 @@ func ServerFromStream(ctx context.Context, stream jsonrpc2.Stream, config *Confi
 		})
 		panic(err)
 	}
-	s.prometheusClient = prometheusClient
+	s.metadataService = prometheusClient
 
 	return ctx, Server{s}
 }
 
 func (s *server) connectPrometheus(url string) error {
-	if err := s.prometheusClient.ChangeDataSource(url); err != nil {
+	if err := s.metadataService.ChangeDataSource(url); err != nil {
 		// nolint: errcheck
 		s.client.ShowMessage(s.lifetime, &protocol.ShowMessageParams{
 			Type:    protocol.Error,

prometheus/compatible.go

@@ -23,7 +23,7 @@ import (
 
 // compatibleHTTPClient must be used to contact a distant prometheus with a version >= v2.15.
 type compatibleHTTPClient struct {
-	Client
+	MetadataService
 	prometheusClient v1.API
 }
 

prometheus/empty.go

@@ -23,7 +23,7 @@ import (
 
 // emptyHTTPClient must be used when no prometheus URL has been defined.
 type emptyHTTPClient struct {
-	Client
+	MetadataService
 }
 
 func (c *emptyHTTPClient) MetricMetadata(_ context.Context, _ string) (v1.Metadata, error) {

prometheus/client.go renamed to prometheus/metadata_service.go

@@ -84,8 +84,8 @@ type buildInfoData struct {
 	GoVersion string `json:"goVersion"`
 }
 
-// Client is a light prometheus client used by LSP to get data from a a prometheus Server.
-type Client interface {
+// MetadataService is a light prometheus client used by LSP to get metric or label information from prometheus Server.
+type MetadataService interface {
 	// MetricMetadata returns the first occurrence of metadata about metrics currently scraped by the metric name.
 	MetricMetadata(ctx context.Context, metric string) (v1.Metadata, error)
 	// AllMetricMetadata returns metadata about metrics currently scraped for all existing metrics.
@@ -107,14 +107,14 @@ type Client interface {
 // You should use this instance directly and not the other one (compatibleHTTPClient and notCompatibleHTTPClient)
 // because it will manage which sub instance of the Client to use (like a factory).
 type httpClient struct {
-	Client
+	MetadataService
 	requestTimeout time.Duration
 	mutex          sync.RWMutex
-	subClient      Client
+	subClient      MetadataService
 	url            string
 }
 
-func NewClient(prometheusURL string) (Client, error) {
+func NewClient(prometheusURL string) (MetadataService, error) {
 	c := &httpClient{
 		requestTimeout: 30,
 	}

prometheus/not_compatible.go

@@ -23,7 +23,7 @@ import (
 
 // notCompatibleHTTPClient must be used to contact a distant prometheus with a version < v2.15.
 type notCompatibleHTTPClient struct {
-	Client
+	MetadataService
 	prometheusClient v1.API
 }
 

rest/handler.go

@@ -35,16 +35,16 @@ import (
 //
 // Expects a prometheus Client as a second argument.
 // The provided Logger should be synchronized.
-func CreateHandler(ctx context.Context, prometheusClient promClient.Client, logger log.Logger) (http.Handler, error) {
-	return CreateInstHandler(ctx, prometheusClient, nil, logger)
+func CreateHandler(ctx context.Context, metadataService promClient.MetadataService, logger log.Logger) (http.Handler, error) {
+	return CreateInstHandler(ctx, metadataService, nil, logger)
 }
 
 // CreateInstHandler creates an instrumented http.Handler for the PromQL langserver REST API.
 //
 // Expects a prometheus Client as a second argument and a Registry as third argument.
 // The provided Logger should be synchronized.
-func CreateInstHandler(ctx context.Context, prometheusClient promClient.Client, r *prometheus.Registry, logger log.Logger) (http.Handler, error) {
-	lgs, err := langserver.CreateHeadlessServer(ctx, prometheusClient, logger)
+func CreateInstHandler(ctx context.Context, metadataService promClient.MetadataService, r *prometheus.Registry, logger log.Logger) (http.Handler, error) {
+	lgs, err := langserver.CreateHeadlessServer(ctx, metadataService, logger)
 	if err != nil {
 		return nil, err
 	}