feature/box: first box and box.info implementation

[KaymeKaydex]

I implemented the box interface for tarantool with a small number of fields, which in the future can be supplemented

I didn't forget about (remove if it is not applicable):

• Tests (see documentation for a testing package)
• Changelog (see documentation for changelog format)
• Documentation (see documentation for documentation style guide)

Related issues: #410

[oleg-jukovec]

The problem with this approach is that it cannot be extended. As example:

1. How to use a context with the method? How to cancel the request?
2. How to make an async request?

It's better to implement a custom request type, as it is already done in the crud and the arrow subpackages. It is possible to implement a custom response type for a request too:

go-tarantool/example_test.go

Line 577 in 8cf8673

exResp, ok := resp.(*tarantool.ExecuteResponse)

[oleg-jukovec]

In the Tarantool 3 the field has name replicaset.

[KaymeKaydex]

there should be a custom decoder for this type or extend the type to avoid problems, this implementation is rather minimal

[KaymeKaydex]

Well, that is, I propose in this case, for example, to remove this field altogether, leaving a minimal non-conflicting implementation

[KaymeKaydex]

The problem with this approach is that it cannot be extended. As example:

1. How to use a context with the method? How to cancel the request?

2. How to make an async request?

It's better to implement a custom request type, as it is already done in the crud and the arrow subpackages. It is possible to implement a custom response type for a request too:

go-tarantool/example_test.go

Line 577 in 8cf8673

exResp, ok := resp.(*tarantool.ExecuteResponse)

I absolutely agree about the context and even think that it should be mandatory when calling any method, but I see the asynchronous implementation of using box as redundant, the asynchronous implementation may be cheaper than a goroutine, but still

I mean the complexity of using asynchronous calls to the future

[oleg-jukovec]

The problem with this approach is that it cannot be extended. As example:

1. How to use a context with the method? How to cancel the request?

2. How to make an async request?

It's better to implement a custom request type, as it is already done in the crud and the arrow subpackages. It is possible to implement a custom response type for a request too:

go-tarantool/example_test.go

Line 577 in 8cf8673

exResp, ok := resp.(*tarantool.ExecuteResponse)

I absolutely agree about the context and even think that it should be mandatory when calling any method, but I see the asynchronous implementation of using box as redundant, the asynchronous implementation may be cheaper than a goroutine, but still

I mean the complexity of using asynchronous calls to the future

Maybe the user will use it this way, and maybe he will want it differently. And considering that we are developing a public library, I am not so sure about the answer.

In any case, I would prefer to do it a way that is already implemented in the crud or arrow subpackage: create a custom request and response. In our experience, this is easier to improve and maintain. It is more universal in practice, it is easier to implement custom connections/types/pools with custom API that used requests, it's easier to test etc.

[KaymeKaydex]

The problem with this approach is that it cannot be extended. As example:

1. How to use a context with the method? How to cancel the request?

2. How to make an async request?

It's better to implement a custom request type, as it is already done in the crud and the arrow subpackages. It is possible to implement a custom response type for a request too:

go-tarantool/example_test.go

Line 577 in 8cf8673

exResp, ok := resp.(*tarantool.ExecuteResponse)

I absolutely agree about the context and even think that it should be mandatory when calling any method, but I see the asynchronous implementation of using box as redundant, the asynchronous implementation may be cheaper than a goroutine, but still
I mean the complexity of using asynchronous calls to the future

Maybe the user will use it this way, and maybe he will want it differently. And considering that we are developing a public library, I am not so sure about the answer.

In any case, I would prefer to do it a way that is already implemented in the crud or arrow subpackage: create a custom request and response. In our experience, this is easier to improve and maintain. It is more universal in practice, it is easier to implement custom connections/types/pools with custom API that used requests, it's easier to test etc.

yes, I understand, but the ease of use of the box is lost in this case, I understood the fixes and am implementing them. I just wanted to note that, just like an active user of the library, it would be easier for me to add a context to the Info() signature, if necessary, launch a goroutine

[oleg-jukovec]

I agree that it is easier at the moment, but not in the long term. As example, think about adding context here to all these methods with backward compatibility.

go-tarantool/connector.go

Lines 20 to 128 in 8cf8673

	// Deprecated: the method will be removed in the next major version,
	// use a PingRequest object + Do() instead.
	Ping() ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use a SelectRequest object + Do() instead.
	Select(space, index interface{}, offset, limit uint32, iterator Iter,
	key interface{}) ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use an InsertRequest object + Do() instead.
	Insert(space interface{}, tuple interface{}) ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use a ReplicaRequest object + Do() instead.
	Replace(space interface{}, tuple interface{}) ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use a DeleteRequest object + Do() instead.
	Delete(space, index interface{}, key interface{}) ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use a UpdateRequest object + Do() instead.
	Update(space, index interface{}, key interface{}, ops *Operations) ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use a UpsertRequest object + Do() instead.
	Upsert(space interface{}, tuple interface{}, ops *Operations) ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use a CallRequest object + Do() instead.
	Call(functionName string, args interface{}) ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use a Call16Request object + Do() instead.
	Call16(functionName string, args interface{}) ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use a Call17Request object + Do() instead.
	Call17(functionName string, args interface{}) ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use an EvalRequest object + Do() instead.
	Eval(expr string, args interface{}) ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use an ExecuteRequest object + Do() instead.
	Execute(expr string, args interface{}) ([]interface{}, error)
	// Deprecated: the method will be removed in the next major version,
	// use a SelectRequest object + Do() instead.
	GetTyped(space, index interface{}, key interface{}, result interface{}) error
	// Deprecated: the method will be removed in the next major version,
	// use a SelectRequest object + Do() instead.
	SelectTyped(space, index interface{}, offset, limit uint32, iterator Iter, key interface{},
	result interface{}) error
	// Deprecated: the method will be removed in the next major version,
	// use an InsertRequest object + Do() instead.
	InsertTyped(space interface{}, tuple interface{}, result interface{}) error
	// Deprecated: the method will be removed in the next major version,
	// use a ReplaceRequest object + Do() instead.
	ReplaceTyped(space interface{}, tuple interface{}, result interface{}) error
	// Deprecated: the method will be removed in the next major version,
	// use a DeleteRequest object + Do() instead.
	DeleteTyped(space, index interface{}, key interface{}, result interface{}) error
	// Deprecated: the method will be removed in the next major version,
	// use a UpdateRequest object + Do() instead.
	UpdateTyped(space, index interface{}, key interface{}, ops *Operations,
	result interface{}) error
	// Deprecated: the method will be removed in the next major version,
	// use a CallRequest object + Do() instead.
	CallTyped(functionName string, args interface{}, result interface{}) error
	// Deprecated: the method will be removed in the next major version,
	// use a Call16Request object + Do() instead.
	Call16Typed(functionName string, args interface{}, result interface{}) error
	// Deprecated: the method will be removed in the next major version,
	// use a Call17Request object + Do() instead.
	Call17Typed(functionName string, args interface{}, result interface{}) error
	// Deprecated: the method will be removed in the next major version,
	// use an EvalRequest object + Do() instead.
	EvalTyped(expr string, args interface{}, result interface{}) error
	// Deprecated: the method will be removed in the next major version,
	// use an ExecuteRequest object + Do() instead.
	ExecuteTyped(expr string, args interface{},
	result interface{}) (SQLInfo, []ColumnMetaData, error)
	// Deprecated: the method will be removed in the next major version,
	// use a SelectRequest object + Do() instead.
	SelectAsync(space, index interface{}, offset, limit uint32, iterator Iter,
	key interface{}) *Future
	// Deprecated: the method will be removed in the next major version,
	// use an InsertRequest object + Do() instead.
	InsertAsync(space interface{}, tuple interface{}) *Future
	// Deprecated: the method will be removed in the next major version,
	// use a ReplaceRequest object + Do() instead.
	ReplaceAsync(space interface{}, tuple interface{}) *Future
	// Deprecated: the method will be removed in the next major version,
	// use a DeleteRequest object + Do() instead.
	DeleteAsync(space, index interface{}, key interface{}) *Future
	// Deprecated: the method will be removed in the next major version,
	// use a UpdateRequest object + Do() instead.
	UpdateAsync(space, index interface{}, key interface{}, ops *Operations) *Future
	// Deprecated: the method will be removed in the next major version,
	// use a UpsertRequest object + Do() instead.
	UpsertAsync(space interface{}, tuple interface{}, ops *Operations) *Future
	// Deprecated: the method will be removed in the next major version,
	// use a CallRequest object + Do() instead.
	CallAsync(functionName string, args interface{}) *Future
	// Deprecated: the method will be removed in the next major version,
	// use a Call16Request object + Do() instead.
	Call16Async(functionName string, args interface{}) *Future
	// Deprecated: the method will be removed in the next major version,
	// use a Call17Request object + Do() instead.
	Call17Async(functionName string, args interface{}) *Future
	// Deprecated: the method will be removed in the next major version,
	// use an EvalRequest object + Do() instead.
	EvalAsync(expr string, args interface{}) *Future
	// Deprecated: the method will be removed in the next major version,
	// use an ExecuteRequest object + Do() instead.
	ExecuteAsync(expr string, args interface{}) *Future

+ Connection + ConnectionPool.

API with requests vs API with ready to call methods a much easier to maintain and to extend over time.