code-health: update format for Call to 1.7

An incompatible change was introduced in
Tarantool 1.7 which was released in 2016.
This change is about a new binary protocol
command for CALL, which no more restricts
a function to returning an array of tuples
and allows returning an arbitrary MsgPack/JSON
result, including scalars, nil and void (nothing).

We should be in-line with tarantool here and
provide `Call17` as just `Call` and rename
current `Call` to `Call16`.

Closes #125

Author: AnaNek

.github/workflows/testing.yml

@@ -60,6 +60,9 @@ jobs:
       - name: Run tests
         run: make test
 
+      - name: Run tests with call_17
+        run: make test TAGS="go_tarantool_call_17"
+
       - name: Run tests, collect code coverage data and send to Coveralls
         if: ${{ matrix.coveralls }}
         env:
@@ -134,6 +137,13 @@ jobs:
         env:
           TEST_TNT_SSL: ${{matrix.ssl}}
 
+      - name: Run tests with call_17
+        run: |
+          source tarantool-enterprise/env.sh
+          make test TAGS="go_tarantool_call_17"
+        env:
+          TEST_TNT_SSL: ${{matrix.ssl}}
+
       - name: Run tests, collect code coverage data and send to Coveralls
         if: ${{ matrix.coveralls }}
         env:

CHANGELOG.md

@@ -15,6 +15,8 @@ Versioning](http://semver.org/spec/v2.0.0.html) except to the first release.
 
 ### Changed
 
+- Breaking change: rename `Call` to `Call16` and `Call17` to `Call` (#125)
+
 ### Fixed
 
 ## [1.6.0] - 2022-06-01

Makefile

@@ -13,6 +13,7 @@ BENCH_REFERENCE_REPO := ${BENCH_PATH}/go-tarantool
 BENCH_OPTIONS := -bench=. -run=^Benchmark -benchmem -benchtime=${DURATION} -count=${COUNT}
 GO_TARANTOOL_URL := https://github.com/tarantool/go-tarantool
 GO_TARANTOOL_DIR := ${PROJECT_DIR}/${BENCH_PATH}/go-tarantool
+TAGS :=
 
 .PHONY: clean
 clean:
@@ -33,7 +34,7 @@ golangci-lint:
 
 .PHONY: test
 test:
-	go test ./... -v -p 1
+	go test -tags "$(TAGS)" ./... -v -p 1
 
 .PHONY: testdata
 testdata:
@@ -43,38 +44,38 @@ testdata:
 test-connection-pool:
 	@echo "Running tests in connection_pool package"
 	go clean -testcache
-	go test ./connection_pool/ -v -p 1
+	go test -tags "$(TAGS)" ./connection_pool/ -v -p 1
 
 .PHONY: test-multi
 test-multi:
 	@echo "Running tests in multiconnection package"
 	go clean -testcache
-	go test ./multi/ -v -p 1
+	go test -tags "$(TAGS)" ./multi/ -v -p 1
 
 .PHONY: test-queue
 test-queue:
 	@echo "Running tests in queue package"
 	cd ./queue/ && tarantool -e "require('queue')"
 	go clean -testcache
-	go test ./queue/ -v -p 1
+	go test -tags "$(TAGS)" ./queue/ -v -p 1
 
 .PHONY: test-uuid
 test-uuid:
 	@echo "Running tests in UUID package"
 	go clean -testcache
-	go test ./uuid/ -v -p 1
+	go test -tags "$(TAGS)" ./uuid/ -v -p 1
 
 .PHONY: test-main
 test-main:
 	@echo "Running tests in main package"
 	go clean -testcache
-	go test . -v -p 1
+	go test -tags "$(TAGS)" . -v -p 1
 
 .PHONY: coverage
 coverage:
 	go clean -testcache
 	go get golang.org/x/tools/cmd/cover
-	go test ./... -v -p 1 -covermode=atomic -coverprofile=$(COVERAGE_FILE) -coverpkg=./...
+	go test -tags "$(TAGS)" ./... -v -p 1 -covermode=atomic -coverprofile=$(COVERAGE_FILE) -coverpkg=./...
 	go tool cover -func=$(COVERAGE_FILE)
 
 .PHONY: coveralls
@@ -94,7 +95,7 @@ ${BENCH_PATH} bench-deps:
 .PHONY: bench
 ${BENCH_FILE} bench: ${BENCH_PATH}
 	@echo "Running benchmark tests from the current branch"
-	go test ${TEST_PATH} ${BENCH_OPTIONS} 2>&1 \
+	go test -tags "$(TAGS)" ${TEST_PATH} ${BENCH_OPTIONS} 2>&1 \
 		| tee ${BENCH_FILE}
 	benchstat ${BENCH_FILE}
 
@@ -104,7 +105,7 @@ ${GO_TARANTOOL_DIR}:
 
 ${REFERENCE_FILE}: ${GO_TARANTOOL_DIR}
 	@echo "Running benchmark tests from master for using results in bench-diff target"
-	cd ${GO_TARANTOOL_DIR} && git pull && go test ./... ${BENCH_OPTIONS} 2>&1 \
+	cd ${GO_TARANTOOL_DIR} && git pull && go test ./... -tags "$(TAGS)" ${BENCH_OPTIONS} 2>&1 \
 		| tee ${REFERENCE_FILE}
 
 bench-diff: ${BENCH_FILES}

call_16_test.go

@@ -0,0 +1,27 @@
+//go:build !go_tarantool_call_17
+// +build !go_tarantool_call_17
+
+package tarantool_test
+
+import (
+	"testing"
+
+	. "github.com/tarantool/go-tarantool"
+)
+
+func TestConnection_Call(t *testing.T) {
+	var resp *Response
+	var err error
+
+	conn := connect(t, server, opts)
+	defer conn.Close()
+
+	// Call16
+	resp, err = conn.Call("simple_incr", []interface{}{1})
+	if err != nil {
+		t.Errorf("Failed to use Call")
+	}
+	if resp.Data[0].([]interface{})[0].(uint64) != 2 {
+		t.Errorf("result is not {{1}} : %v", resp.Data)
+	}
+}

call_17_test.go

@@ -0,0 +1,27 @@
+//go:build go_tarantool_call_17
+// +build go_tarantool_call_17
+
+package tarantool_test
+
+import (
+	"testing"
+
+	. "github.com/tarantool/go-tarantool"
+)
+
+func TestConnection_Call(t *testing.T) {
+	var resp *Response
+	var err error
+
+	conn := connect(t, server, opts)
+	defer conn.Close()
+
+	// Call17
+	resp, err = conn.Call17("simple_incr", []interface{}{1})
+	if err != nil {
+		t.Errorf("Failed to use Call")
+	}
+	if resp.Data[0].(uint64) != 2 {
+		t.Errorf("result is not {{1}} : %v", resp.Data)
+	}
+}

connection.go

@@ -116,9 +116,9 @@ func (d defaultLogger) Report(event ConnLogKind, conn *Connection, v ...interfac
 //
 // ATTENTION: result argument for *Typed methods should deserialize from
 // msgpack array, cause Tarantool always returns result as an array.
-// For all space related methods and Call* (but not Call17*) methods Tarantool
+// For all space related methods and Call16* (but not Call*) methods Tarantool
 // always returns array of array (array of tuples for space related methods).
-// For Eval* and Call17* Tarantool always returns array, but does not forces
+// For Eval* and Call* Tarantool always returns array, but does not forces
 // array of arrays.
 type Connection struct {
 	addr  string

connection_pool/connection_pool.go

@@ -255,8 +255,10 @@ func (connPool *ConnectionPool) Upsert(space interface{}, tuple, ops interface{}
 	return conn.Upsert(space, tuple, ops)
 }
 
-// Call calls registered Tarantool function.
-// It uses request code for Tarantool 1.6, so result is converted to array of arrays.
+// Call16 calls registered Tarantool function.
+// It uses request code for Tarantool >= 1.7 if go-tarantool
+// was build with go_tarantool_call_17 tag.
+// Otherwise, uses request code for Tarantool 1.6.
 func (connPool *ConnectionPool) Call(functionName string, args interface{}, userMode Mode) (resp *tarantool.Response, err error) {
 	conn, err := connPool.getNextConnection(userMode)
 	if err != nil {
@@ -266,8 +268,21 @@ func (connPool *ConnectionPool) Call(functionName string, args interface{}, user
 	return conn.Call(functionName, args)
 }
 
+// Call16 calls registered Tarantool function.
+// It uses request code for Tarantool 1.6, so result is converted to array of arrays.
+// Deprecated since 1.7.4. This breaking change was needed to extend call() and eval()
+// API with per-requests options.
+func (connPool *ConnectionPool) Call16(functionName string, args interface{}, userMode Mode) (resp *tarantool.Response, err error) {
+	conn, err := connPool.getNextConnection(userMode)
+	if err != nil {
+		return nil, err
+	}
+
+	return conn.Call16(functionName, args)
+}
+
 // Call17 calls registered Tarantool function.
-// It uses request code for Tarantool 1.7, so result is not converted
+// It uses request code for Tarantool >= 1.7, so result is not converted
 // (though, keep in mind, result is always array).
 func (connPool *ConnectionPool) Call17(functionName string, args interface{}, userMode Mode) (resp *tarantool.Response, err error) {
 	conn, err := connPool.getNextConnection(userMode)
@@ -352,7 +367,9 @@ func (connPool *ConnectionPool) UpdateTyped(space, index interface{}, key, ops i
 }
 
 // CallTyped calls registered function.
-// It uses request code for Tarantool 1.6, so result is converted to array of arrays.
+// It uses request code for Tarantool >= 1.7 if go-tarantool
+// was build with go_tarantool_call_17 tag.
+// Otherwise, uses request code for Tarantool 1.6.
 func (connPool *ConnectionPool) CallTyped(functionName string, args interface{}, result interface{}, userMode Mode) (err error) {
 	conn, err := connPool.getNextConnection(userMode)
 	if err != nil {
@@ -362,8 +379,21 @@ func (connPool *ConnectionPool) CallTyped(functionName string, args interface{},
 	return conn.CallTyped(functionName, args, result)
 }
 
+// Call16Typed calls registered function.
+// It uses request code for Tarantool 1.6, so result is converted to array of arrays.
+// Deprecated since 1.7.4. This breaking change was needed to extend call() and eval()
+// API with per-requests options.
+func (connPool *ConnectionPool) Call16Typed(functionName string, args interface{}, result interface{}, userMode Mode) (err error) {
+	conn, err := connPool.getNextConnection(userMode)
+	if err != nil {
+		return err
+	}
+
+	return conn.Call16Typed(functionName, args, result)
+}
+
 // Call17Typed calls registered function.
-// It uses request code for Tarantool 1.7, so result is not converted
+// It uses request code for Tarantool >= 1.7, so result is not converted
 // (though, keep in mind, result is always array).
 func (connPool *ConnectionPool) Call17Typed(functionName string, args interface{}, result interface{}, userMode Mode) (err error) {
 	conn, err := connPool.getNextConnection(userMode)
@@ -450,7 +480,9 @@ func (connPool *ConnectionPool) UpsertAsync(space interface{}, tuple interface{}
 }
 
 // CallAsync sends a call to registered Tarantool function and returns Future.
-// It uses request code for Tarantool 1.6, so future's result is always array of arrays.
+// It uses request code for Tarantool >= 1.7 if go-tarantool
+// was build with go_tarantool_call_17 tag.
+// Otherwise, uses request code for Tarantool 1.6.
 func (connPool *ConnectionPool) CallAsync(functionName string, args interface{}, userMode Mode) *tarantool.Future {
 	conn, err := connPool.getNextConnection(userMode)
 	if err != nil {
@@ -460,8 +492,21 @@ func (connPool *ConnectionPool) CallAsync(functionName string, args interface{},
 	return conn.CallAsync(functionName, args)
 }
 
+// Call16Async sends a call to registered Tarantool function and returns Future.
+// It uses request code for Tarantool 1.6, so future's result is always array of arrays.
+// Deprecated since 1.7.4. This breaking change was needed to extend call() and eval()
+// API with per-requests options.
+func (connPool *ConnectionPool) Call16Async(functionName string, args interface{}, userMode Mode) *tarantool.Future {
+	conn, err := connPool.getNextConnection(userMode)
+	if err != nil {
+		return tarantool.NewErrorFuture(err)
+	}
+
+	return conn.Call16Async(functionName, args)
+}
+
 // Call17Async sends a call to registered Tarantool function and returns Future.
-// It uses request code for Tarantool 1.7, so future's result will not be converted
+// It uses request code for Tarantool >= 1.7, so future's result will not be converted
 // (though, keep in mind, result is always array).
 func (connPool *ConnectionPool) Call17Async(functionName string, args interface{}, userMode Mode) *tarantool.Future {
 	conn, err := connPool.getNextConnection(userMode)

connection_pool/example_test.go

@@ -490,7 +490,7 @@ func ExampleConnectionPool_Update() {
 	// Data [[key1 new_value]]
 }
 
-func ExampleConnectionPool_Call17() {
+func ExampleConnectionPool_Call() {
 	pool, err := examplePool(testRoles)
 	if err != nil {
 		fmt.Println(err)

connector.go

@@ -15,6 +15,7 @@ type Connector interface {
 	Update(space, index interface{}, key, ops interface{}) (resp *Response, err error)
 	Upsert(space interface{}, tuple, ops interface{}) (resp *Response, err error)
 	Call(functionName string, args interface{}) (resp *Response, err error)
+	Call16(functionName string, args interface{}) (resp *Response, err error)
 	Call17(functionName string, args interface{}) (resp *Response, err error)
 	Eval(expr string, args interface{}) (resp *Response, err error)
 	Execute(expr string, args interface{}) (resp *Response, err error)
@@ -26,6 +27,7 @@ type Connector interface {
 	DeleteTyped(space, index interface{}, key interface{}, result interface{}) (err error)
 	UpdateTyped(space, index interface{}, key, ops interface{}, result interface{}) (err error)
 	CallTyped(functionName string, args interface{}, result interface{}) (err error)
+	Call16Typed(functionName string, args interface{}, result interface{}) (err error)
 	Call17Typed(functionName string, args interface{}, result interface{}) (err error)
 	EvalTyped(expr string, args interface{}, result interface{}) (err error)
 
@@ -36,6 +38,7 @@ type Connector interface {
 	UpdateAsync(space, index interface{}, key, ops interface{}) *Future
 	UpsertAsync(space interface{}, tuple interface{}, ops interface{}) *Future
 	CallAsync(functionName string, args interface{}) *Future
+	Call16Async(functionName string, args interface{}) *Future
 	Call17Async(functionName string, args interface{}) *Future
 	EvalAsync(expr string, args interface{}) *Future
 }

const.go

@@ -6,11 +6,11 @@ const (
 	ReplaceRequest   = 3
 	UpdateRequest    = 4
 	DeleteRequest    = 5
-	CallRequest      = 6 /* call in 1.6 format */
+	Call16Request    = 6 /* call in 1.6 format */
 	AuthRequest      = 7
 	EvalRequest      = 8
 	UpsertRequest    = 9
-	Call17Request    = 10
+	Call17Request    = 10 /* call in >= 1.7 format */
 	ExecuteRequest   = 11
 	PingRequest      = 64
 	SubscribeRequest = 66

const_call_16.go

@@ -0,0 +1,8 @@
+//go:build !go_tarantool_call_17
+// +build !go_tarantool_call_17
+
+package tarantool
+
+const (
+	CallRequest = 6 // CALL_16
+)

const_call_17.go

@@ -0,0 +1,8 @@
+//go:build go_tarantool_call_17
+// +build go_tarantool_call_17
+
+package tarantool
+
+const (
+	CallRequest = 10 // CALL_17
+)

example_custom_unpacking_test.go

@@ -118,8 +118,8 @@ func Example_customUnpacking() {
 	fmt.Println("Tuples (tuples2):", tuples2)
 
 	// Call a function "func_name" returning a table of custom tuples.
-	var tuples3 []Tuple3
-	err = conn.CallTyped("func_name", []interface{}{}, &tuples3)
+	var tuples3 [][]Tuple3
+	err = conn.Call17Typed("func_name", []interface{}{}, &tuples3)
 	if err != nil {
 		log.Fatalf("Failed to CallTyped: %s", err.Error())
 		return
@@ -131,6 +131,6 @@ func Example_customUnpacking() {
 	// Code 0
 	// Tuples (tuples1) [{777 orig [{lol  1} {wut  3}]}]
 	// Tuples (tuples2): [{{} 777 orig [{lol  1} {wut  3}]}]
-	// Tuples (tuples3): [{{} 221  [{Moscow  34} {Minsk  23} {Kiev  31}]}]
+	// Tuples (tuples3): [[{{} 221  [{Moscow  34} {Minsk  23} {Kiev  31}]}]]
 
 }

example_test.go

@@ -309,7 +309,7 @@ func ExampleConnection_Update() {
 	// Data [[14 bye bla]]
 }
 
-func ExampleConnection_Call17() {
+func ExampleConnection_Call() {
 	conn := example_connect()
 	defer conn.Close()