GT-352 Add x-arango-driver header flag (#473)

Author: jwierzbo

Makefile

@@ -1,3 +1,5 @@
+DRIVER_VERSION := 1.5.0
+
 PROJECT := go-driver
 SCRIPTDIR := $(shell pwd)
 
@@ -564,4 +566,9 @@ run-v2-tests-resilientsingle: run-v2-tests-resilientsingle-with-auth
 
 run-v2-tests-resilientsingle-with-auth:
 	@echo "Resilient Single, with authentication, v2"
-	@${MAKE} TEST_MODE="resilientsingle" TEST_AUTH="rootpw" __run_v2_tests
+	@${MAKE} TEST_MODE="resilientsingle" TEST_AUTH="rootpw" __run_v2_tests
+
+apply-version:
+	@echo "Updating version to: $(DRIVER_VERSION)"
+	@VERSION=$(DRIVER_VERSION) go generate version-driver.go
+	@VERSION=$(DRIVER_VERSION) go generate ./v2/connection/version-driver.go

context.go

@@ -28,6 +28,7 @@ import (
 	"fmt"
 	"reflect"
 	"strconv"
+	"strings"
 	"time"
 
 	"github.com/arangodb/go-driver/util"
@@ -66,6 +67,7 @@ const (
 	keyOverwrite                ContextKey = "arangodb-overwrite"
 	keyUseQueueTimeout          ContextKey = "arangodb-use-queue-timeout"
 	keyMaxQueueTime             ContextKey = "arangodb-max-queue-time-seconds"
+	keyDriverFlags              ContextKey = "arangodb-driver-flags"
 )
 
 type OverwriteMode string
@@ -274,6 +276,11 @@ func WithOverwrite(parent context.Context) context.Context {
 	return context.WithValue(contextOrBackground(parent), keyOverwrite, true)
 }
 
+// WithDriverFlags is used to configure additional flags for the `x-arango-driver` header.
+func WithDriverFlags(parent context.Context, value []string) context.Context {
+	return context.WithValue(contextOrBackground(parent), keyDriverFlags, value)
+}
+
 type contextSettings struct {
 	Silent                   bool
 	WaitForSync              bool
@@ -322,6 +329,19 @@ func setDirtyReadFlagIfRequired(ctx context.Context, wasDirty bool) {
 	}
 }
 
+// ApplyVersionHeader adds the driver version to the request.
+func ApplyVersionHeader(ctx context.Context, req Request) {
+	val := fmt.Sprintf("go-driver-v1/%s", driverVersion)
+	if ctx != nil {
+		if v := ctx.Value(keyDriverFlags); v != nil {
+			if flags, ok := v.([]string); ok {
+				val = fmt.Sprintf("%s (%s)", val, strings.Join(flags, ","))
+			}
+		}
+	}
+	req.SetHeader("x-arango-driver", val)
+}
+
 // applyContextSettings returns the settings configured in the context in the given request.
 // It then returns information about the applied settings that may be needed later in API implementation functions.
 func applyContextSettings(ctx context.Context, req Request) contextSettings {

http/connection.go

@@ -235,6 +235,8 @@ func (c *httpConnection) Do(ctx context.Context, req driver.Request) (driver.Res
 		return nil, driver.WithStack(driver.InvalidArgumentError{Message: "request is not a httpRequest type"})
 	}
 
+	driver.ApplyVersionHeader(ctx, req)
+
 	r, err := request.createHTTPRequest(c.endpoint)
 	rctx := ctx
 	if rctx == nil {

scripts/update-version.sh

@@ -0,0 +1,7 @@
+cat << EOF > ./version-driver.go
+// Code generated by go generate; DO NOT EDIT.
+package driver
+
+//go:generate bash ./scripts/update-version.sh
+var driverVersion = "$VERSION"
+EOF

test/context_test.go

@@ -51,6 +51,7 @@ func TestContextParentNil(t *testing.T) {
 	testValue(driver.WithRawResponse(nil, &[]byte{}))
 	testValue(driver.WithArangoQueueTimeout(nil, true))
 	testValue(driver.WithArangoQueueTime(nil, time.Second*5))
+	testValue(driver.WithDriverFlags(nil, []string{"foo", "bar"}))
 }
 
 func TestContextWithArangoQueueTimeoutParams(t *testing.T) {

v2/connection/context.go

@@ -32,6 +32,7 @@ type ContextKey string
 const (
 	keyUseQueueTimeout ContextKey = "arangodb-use-queue-timeout"
 	keyMaxQueueTime    ContextKey = "arangodb-max-queue-time-seconds"
+	keyDriverFlags     ContextKey = "arangodb-driver-flags"
 )
 
 // contextOrBackground returns the given context if it is not nil.
@@ -53,3 +54,8 @@ func WithArangoQueueTimeout(parent context.Context, useQueueTimeout bool) contex
 func WithArangoQueueTime(parent context.Context, duration time.Duration) context.Context {
 	return context.WithValue(contextOrBackground(parent), keyMaxQueueTime, duration)
 }
+
+// WithDriverFlags is used to configure additional flags for the `x-arango-driver` header.
+func WithDriverFlags(parent context.Context, value []string) context.Context {
+	return context.WithValue(contextOrBackground(parent), keyDriverFlags, value)
+}

v2/connection/modifiers.go

@@ -25,6 +25,7 @@ package connection
 import (
 	"context"
 	"fmt"
+	"strings"
 	"time"
 )
 
@@ -53,6 +54,17 @@ func WithQuery(s, value string) RequestModifier {
 func applyGlobalSettings(ctx context.Context) RequestModifier {
 	return func(r Request) error {
 
+		// Set version header
+		val := fmt.Sprintf("go-driver-v2/%s", driverVersion)
+		if ctx != nil {
+			if v := ctx.Value(keyDriverFlags); v != nil {
+				if flags, ok := v.([]string); ok {
+					val = fmt.Sprintf("%s (%s)", val, strings.Join(flags, ","))
+				}
+			}
+		}
+		r.AddHeader("x-arango-driver", val)
+
 		// Enable Queue timeout
 		if v := ctx.Value(keyUseQueueTimeout); v != nil {
 			if useQueueTimeout, ok := v.(bool); ok && useQueueTimeout {

v2/connection/version-driver.go

@@ -0,0 +1,7 @@
+cat << EOF > ../connection/version-driver.go
+// Code generated by go generate; DO NOT EDIT.
+package connection
+
+//go:generate bash ../scripts/update-version.sh
+var driverVersion = "$VERSION"
+EOF