Client: Implement product check on first call (#289)

Anaethelion · web-flow · commit b90935821c23 · 2021-06-30T16:42:28.000+02:00
* Client: Implement product check on first call
* Examples: Update dependency retrieval
* BulkIndexer: Update test to reflect product check changes
* Client: Use sync.Once to restrict to one product check per client instance
diff --git a/Makefile b/Makefile
@@ -101,7 +101,7 @@ test-examples: ## Execute the _examples
 			printf "\033[2m────────────────────────────────────────────────────────────────────────────────\n"; \
 			printf "\033[1mUpdating dependencies for $$d\033[0m\n"; \
 			printf "\033[2m────────────────────────────────────────────────────────────────────────────────\033[0m\n"; \
-			(cd $$d && go mod download) || \
+			(cd $$d && go mod download && make setup) || \
 			( \
 				printf "\033[31m────────────────────────────────────────────────────────────────────────────────\033[0m\n"; \
 				printf "\033[31;1m⨯ ERROR\033[0m\n"; \
@@ -152,7 +152,7 @@ lint:  ## Run lint on the package
 		set -e ; \
 		trap "test -d ../../../.git && git checkout --quiet go.mod" INT TERM EXIT; \
 		echo "cd internal/build/ && go vet ./..."; \
-		cd "internal/build/" && go mod download && go vet ./...; \
+		cd "internal/build/" && go mod tidy && go mod download && go vet ./...; \
 	}
 
 
diff --git a/_examples/bulk/Makefile b/_examples/bulk/Makefile
@@ -13,7 +13,9 @@ test-benchmarks: clean setup
 
 setup:
 	@go get -u github.com/mailru/easyjson/...
-	cd benchmarks && go generate ./model
+	@go mod download github.com/dustin/go-humanize
+	@go mod download github.com/cenkalti/backoff/v4
+	cd benchmarks && go mod download && go mod download github.com/mailru/easyjson && go generate ./model
 
 clean:
 	@rm -f benchmarks/model/*_easyjson.go
diff --git a/_examples/bulk/benchmarks/go.mod b/_examples/bulk/benchmarks/go.mod
@@ -6,7 +6,7 @@ replace github.com/elastic/go-elasticsearch/v7 => ../../..
 
 require (
 	github.com/dustin/go-humanize v1.0.0
-	github.com/elastic/go-elasticsearch/v7 7.x
+	github.com/elastic/go-elasticsearch/v7 v7.5.1-0.20210608143310-9747f0e42f35
 	github.com/mailru/easyjson v0.7.1
 	github.com/montanaflynn/stats v0.6.3
 	github.com/valyala/fasthttp v1.9.0
diff --git a/_examples/bulk/go.mod b/_examples/bulk/go.mod
@@ -7,5 +7,6 @@ replace github.com/elastic/go-elasticsearch/v7 => ../..
 require (
 	github.com/cenkalti/backoff/v4 v4.0.0
 	github.com/dustin/go-humanize v1.0.0
-	github.com/elastic/go-elasticsearch/v7 7.x
+	github.com/elastic/go-elasticsearch/v7 v7.5.1-0.20210608143310-9747f0e42f35
+	github.com/mailru/easyjson v0.7.7 // indirect
 )
diff --git a/_examples/cloudfunction/Makefile b/_examples/cloudfunction/Makefile
@@ -3,4 +3,6 @@ GO_TEST_CMD = $(if $(shell which richgo),richgo test,go test)
 test:  ## Run tests
 	$(GO_TEST_CMD) -v ./...
 
-.PHONY: test
+setup:
+
+.PHONY: test setup
diff --git a/_examples/cloudfunction/function_test.go b/_examples/cloudfunction/function_test.go
@@ -35,7 +35,10 @@ type MockTransport struct{}
 
 // RoundTrip returns a mock response.
 func (t *MockTransport) RoundTrip(req *http.Request) (*http.Response, error) {
-	return &http.Response{Body: ioutil.NopCloser(strings.NewReader(`{"status":"mocked"}`))}, nil
+	return &http.Response{
+		Body: ioutil.NopCloser(strings.NewReader(`{"status":"mocked"}`)),
+		Header: http.Header{"X-Elastic-Product": []string{"Elasticsearch"}},
+	}, nil
 }
 
 func TestHealth(t *testing.T) {
diff --git a/_examples/encoding/Makefile b/_examples/encoding/Makefile
@@ -10,6 +10,8 @@ bench: clean setup # Run benchmarks
 
 setup: ## Install & Setup
 	@go get -u github.com/mailru/easyjson/...
+	@go mod tidy
+	@go mod download
 	go generate ./model
 
 clean: ## Remove artifacts
diff --git a/_examples/encoding/go.mod b/_examples/encoding/go.mod
@@ -6,13 +6,10 @@ replace github.com/elastic/go-elasticsearch/v7 => ../..
 
 require (
 	github.com/elastic/go-elasticsearch/v7 v7.0.0-20190407092644-3fb2a278216b
-
 	github.com/fatih/color v1.7.0
-
-	github.com/mailru/easyjson v0.0.0-20190403194419-1ea4449da983
+	github.com/mailru/easyjson v0.7.7
 	github.com/mattn/go-colorable v0.1.1 // indirect
 	github.com/mattn/go-isatty v0.0.7 // indirect
-
 	github.com/tidwall/gjson v1.2.1
 	github.com/tidwall/match v1.0.1 // indirect
 	github.com/tidwall/pretty v0.0.0-20180105212114-65a9db5fad51 // indirect
diff --git a/_examples/extension/Makefile b/_examples/extension/Makefile
@@ -3,4 +3,6 @@ GO_TEST_CMD = $(if $(shell which richgo),richgo test,go test)
 test:  ## Run tests
 	go run main.go
 
-.PHONY: test
+setup:
+
+.PHONY: test setup
diff --git a/_examples/fasthttp/Makefile b/_examples/fasthttp/Makefile
@@ -6,4 +6,8 @@ test:  ## Run tests
 bench:  ## Run benchmarks
 	$(GO_TEST_CMD) -run=none -bench=. -benchmem -benchtime=10s -v fasthttp_benchmark_test.go
 
-.PHONY: test bench
+setup:
+	@go mod tidy
+	@go mod download
+
+.PHONY: test bench setup
diff --git a/_examples/fasthttp/go.mod b/_examples/fasthttp/go.mod
@@ -5,6 +5,8 @@ go 1.11
 replace github.com/elastic/go-elasticsearch/v7 => ../..
 
 require (
-	github.com/elastic/go-elasticsearch/v7 7.x
-	github.com/valyala/fasthttp v1.5.0
+	github.com/andybalholm/brotli v1.0.3 // indirect
+	github.com/elastic/go-elasticsearch/v7 v7.5.1-0.20210608143310-9747f0e42f35
+	github.com/klauspost/compress v1.13.1 // indirect
+	github.com/valyala/fasthttp v1.27.0
 )
diff --git a/_examples/instrumentation/Makefile b/_examples/instrumentation/Makefile
@@ -3,4 +3,9 @@ test:
 	go build -o /dev/null opencensus.go
 	go build -o /dev/null apmelasticsearch.go
 
-.PHONY: test
+setup:
+	@go mod tidy
+	@go mod download
+
+
+.PHONY: test setup
diff --git a/_examples/instrumentation/go.mod b/_examples/instrumentation/go.mod
@@ -6,15 +6,11 @@ replace github.com/elastic/go-elasticsearch/v7 => ../..
 
 require (
 	github.com/elastic/go-elasticsearch/v7 v7.0.0-20190407092644-3fb2a278216b
-
 	github.com/fatih/color v1.7.0
 	github.com/mattn/go-colorable v0.1.0 // indirect
 	github.com/mattn/go-isatty v0.0.4 // indirect
-
 	go.elastic.co/apm v1.5.0
 	go.elastic.co/apm/module/apmelasticsearch v1.5.0
-
 	go.opencensus.io v0.19.0
-
 	golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2
 )
diff --git a/_examples/logging/Makefile b/_examples/logging/Makefile
@@ -4,4 +4,8 @@ test:  ## Run tests
 	go run default.go
 	go run custom.go
 
-.PHONY: test
+setup:
+	@go mod download
+	@go mod download github.com/rs/zerolog
+
+.PHONY: test setup
diff --git a/_examples/security/Makefile b/_examples/security/Makefile
@@ -31,4 +31,6 @@ certificates-clean:
 cluster-clean:
 	docker-compose --file elasticsearch-cluster.yml down --volumes
 
-.PHONY: test test-integ certificates cluster certificates-clean cluster-clean
+setup:
+
+.PHONY: test test-integ certificates cluster certificates-clean cluster-clean setup
diff --git a/_examples/security/go.mod b/_examples/security/go.mod
@@ -4,6 +4,4 @@ go 1.11
 
 replace github.com/elastic/go-elasticsearch/v7 => ../..
 
-require (
-	github.com/elastic/go-elasticsearch/v7 7.x
-)
+require github.com/elastic/go-elasticsearch/v7 v7.5.1-0.20210608143310-9747f0e42f35
diff --git a/_examples/xkcdsearch/Makefile b/_examples/xkcdsearch/Makefile
@@ -3,4 +3,8 @@ GO_TEST_CMD = $(if $(shell which richgo),richgo test,go test)
 test:  ## Run tests
 	$(GO_TEST_CMD) -v ./...
 
-.PHONY: test
+setup:
+	@go mod tidy
+	@go mod download
+
+.PHONY: test setup
diff --git a/_examples/xkcdsearch/store_test.go b/_examples/xkcdsearch/store_test.go
@@ -81,6 +81,7 @@ func TestStore(t *testing.T) {
 		Response: &http.Response{
 			StatusCode: http.StatusOK,
 			Body:       ioutil.NopCloser(strings.NewReader(`{}`)),
+			Header: http.Header{"X-Elastic-Product": []string{"Elasticsearch"}},
 		},
 	}
 	mocktrans.RoundTripFn = func(req *http.Request) (*http.Response, error) { return mocktrans.Response, nil }
diff --git a/elasticsearch.go b/elasticsearch.go
@@ -18,22 +18,38 @@
 package elasticsearch
 
 import (
+	"context"
 	"encoding/base64"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"net/http"
 	"net/url"
 	"os"
+	"regexp"
+	"strconv"
 	"strings"
+	"sync"
 	"time"
 
 	"github.com/elastic/go-elasticsearch/v7/esapi"
 	"github.com/elastic/go-elasticsearch/v7/estransport"
 	"github.com/elastic/go-elasticsearch/v7/internal/version"
 )
 
+var (
+	reVersion          *regexp.Regexp
+)
+
+func init() {
+	versionPattern := `^([0-9]+)\.([0-9]+)\.([0-9]+)`
+	reVersion = regexp.MustCompile(versionPattern)
+}
+
 const (
 	defaultURL = "http://localhost:9200"
+	tagline    = "You Know, for Search"
+    unknownProduct = "the client noticed that the server is not Elasticsearch and we do not support this unknown product"
 )
 
 // Version returns the package version as a string.
@@ -69,7 +85,7 @@ type Config struct {
 	EnableMetrics     bool // Enable the metrics collection.
 	EnableDebugLogger bool // Enable the debug logging.
 
-	DisableMetaHeader bool // Disable the additional "X-Elastic-Client-Meta" HTTP header.
+	DisableMetaHeader  bool // Disable the additional "X-Elastic-Client-Meta" HTTP header.
 
 	RetryBackoff func(attempt int) time.Duration // Optional backoff duration. Default: nil.
 
@@ -84,8 +100,21 @@ type Config struct {
 // Client represents the Elasticsearch client.
 //
 type Client struct {
-	*esapi.API // Embeds the API methods
-	Transport  estransport.Interface
+	*esapi.API// Embeds the API methods
+	Transport          estransport.Interface
+
+	once              sync.Once
+	productCheckError error
+}
+
+type esVersion struct {
+	Number                           string    `json:"number"`
+	BuildFlavor                      string    `json:"build_flavor"`
+}
+
+type info struct {
+	Version     esVersion `json:"version"`
+	Tagline     string    `json:"tagline"`
 }
 
 // NewDefaultClient creates a new client with default options.
@@ -183,21 +212,129 @@ func NewClient(cfg Config) (*Client, error) {
 		return nil, fmt.Errorf("error creating transport: %s", err)
 	}
 
-	client := &Client{Transport: tp, API: esapi.New(tp)}
+	client := &Client{Transport: tp}
+	client.API = esapi.New(client)
 
 	if cfg.DiscoverNodesOnStart {
 		go client.DiscoverNodes()
 	}
 
-	return client, nil
+	return client, err
+}
+
+// genuineCheckHeader validates the presence of the X-Elastic-Product header
+//
+func genuineCheckHeader(header http.Header) error {
+	if header.Get("X-Elastic-Product") != "Elasticsearch" {
+		return fmt.Errorf(unknownProduct)
+	}
+	return nil
+}
+
+// genuineCheckInfo validates the informations given by Elasticsearch
+//
+func genuineCheckInfo(info info) error {
+	major, minor, _, err := ParseElasticsearchVersion(info.Version.Number)
+	if err != nil {
+		return err
+	}
+
+	if major < 6 {
+		return fmt.Errorf(unknownProduct)
+	}
+	if major < 7 {
+		if info.Tagline != tagline {
+			return fmt.Errorf(unknownProduct)
+		}
+	}
+	if major >= 7 {
+		if minor < 14 {
+			if info.Tagline != tagline ||
+				info.Version.BuildFlavor != "default" {
+				return fmt.Errorf(unknownProduct)
+			}
+		}
+	}
+
+	return nil
+}
+
+// ParseElasticsearchVersion returns an int64 representation of Elasticsearch version.
+//
+func ParseElasticsearchVersion(version string) (int64, int64, int64, error) {
+	matches := reVersion.FindStringSubmatch(version)
+
+	if len(matches) < 4 {
+		return 0, 0, 0, fmt.Errorf("")
+	}
+	major, _ := strconv.ParseInt(matches[1], 10, 0)
+	minor, _ := strconv.ParseInt(matches[2], 10, 0)
+	patch, _ := strconv.ParseInt(matches[3], 10, 0)
+
+	return major, minor, patch, nil
 }
 
 // Perform delegates to Transport to execute a request and return a response.
 //
 func (c *Client) Perform(req *http.Request) (*http.Response, error) {
+	c.once.Do(func() {
+		err := c.productCheck()
+		if err != nil {
+			c.productCheckError = err
+		}
+		return
+	})
+	if c.productCheckError != nil {
+		return nil, c.productCheckError
+	}
+
 	return c.Transport.Perform(req)
 }
 
+// productCheck runs an esapi.Info query to retrieve informations of the current cluster
+// decodes the response and decides if the cluster is a genuine Elasticsearch product.
+func (c *Client) productCheck() (error) {
+	var info info
+
+	req := esapi.InfoRequest{}
+	res, err := req.Do(context.Background(), c.Transport)
+	if err != nil {
+		return err
+	}
+
+	contentType := res.Header.Get("Content-Type")
+	if res.Body != nil {
+		defer res.Body.Close()
+
+		if strings.Contains(contentType, "json") {
+			decoder := json.NewDecoder(res.Body)
+			err = decoder.Decode(&info)
+			if err != nil {
+				return fmt.Errorf("error decoding Elasticsearch informations: %s", err)
+			}
+		}
+
+		switch res.StatusCode {
+		case http.StatusForbidden:
+		case http.StatusUnauthorized:
+			break
+		default:
+			err = genuineCheckHeader(res.Header)
+
+			if err != nil {
+				if info.Version.Number != "" {
+					err = genuineCheckInfo(info)
+				}
+			}
+		}
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
 // Metrics returns the client metrics.
 //
 func (c *Client) Metrics() (estransport.Metrics, error) {
diff --git a/elasticsearch_benchmark_test.go b/elasticsearch_benchmark_test.go
diff --git a/elasticsearch_integration_test.go b/elasticsearch_integration_test.go
diff --git a/elasticsearch_internal_test.go b/elasticsearch_internal_test.go
diff --git a/esapi/esapi_benchmark_test.go b/esapi/esapi_benchmark_test.go
diff --git a/esutil/bulk_indexer_internal_test.go b/esutil/bulk_indexer_internal_test.go
diff --git a/internal/build/go.mod b/internal/build/go.mod

Original file line number	Diff line number	Diff line change
`@@ -7,5 +7,6 @@ replace github.com/elastic/go-elasticsearch/v7 => ../..`
`7`	`7`	`require (`
`8`	`8`	`github.com/cenkalti/backoff/v4 v4.0.0`
`9`	`9`	`github.com/dustin/go-humanize v1.0.0`
`10`		`- github.com/elastic/go-elasticsearch/v7 7.x`
	`10`	`+ github.com/elastic/go-elasticsearch/v7 v7.5.1-0.20210608143310-9747f0e42f35`
	`11`	`+ github.com/mailru/easyjson v0.7.7 // indirect`
`11`	`12`	`)`