Release v3.0.0

[oleg-jukovec]

v3 redesigns the connector for a simpler, more idiomatic Go experience.

Logging plugs into *slog.Logger — no custom interface.

Error handling now works the way Go expects: errors.Is and errors.As just work — write if errors.Is(err, tarantool.ErrTimeouted) instead of comparing numeric codes. Context cancellation errors carry ctx.Cause(), so the underlying reason is always inspectable.

Request builders return immutable values, safe to share across goroutines without defensive copying.

For high-throughput workloads, the new Allocator interface and Future.Release() give you explicit control over buffer reuse — push allocations out of the hot path. Future and Stream became opaque interfaces, hiding internals and giving us freedom to evolve them.

Requires Go 1.24. See MIGRATION.md for upgrade details.

Added

• New types for MessagePack extensions compatible with go-option (feat(arrow, datetime, decimal, uuid): add support for go-option #459).
• Added box.MustNew wrapper for box.New without an error (v3: box.New should return an error instead of panic #448).
• Added missing IPROTO feature flags to greeting negotiation (iproto.IPROTO_FEATURE_IS_SYNC, iproto.IPROTO_FEATURE_INSERT_ARROW) (v3: add missing IPROTO feature flags to greeting negotiation #466).
• Added Future.cond (sync.Cond) and Future.finished bool. Added Future.finish() marks Future as done (v3: replace channel in Future with a cond.Sync #496).
• Added function String() for type datetime (messagepack extensions: add String() for Decimal, Datetime and Interval #322).
• New Future interface (v3: proposal re make tarantool.Future to be interface type #470).
• Method Release for Future and Response interface that allows to free used data directly by calling (v3: design API to avoid allocations in responses #493).
• Resources allocated for a Future object created by the Connection type could be released with the Future.Release() call (v3: design API to avoid allocations in responses #493).
• Added function String() for type interval (messagepack extensions: add String() for Decimal, Datetime and Interval #322).
• New Allocator interface for custom allocation of response buffers (v3: design API to avoid allocations in responses #493).
• New PoolAllocator type that implements Allocator using sync.Pool for power-of-two sized byte slices (v3: design API to avoid allocations in responses #493).
• New Opts.Allocator option to configure a custom allocator for a connection (v3: design API to avoid allocations in responses #493).
• Method String() for type decimal.Decimal (messagepack extensions: add String() for Decimal, Datetime and Interval #322).
• New T interface compatible with testing.T methods to make testing easier, test_helpers updated with it (v3: use interface instead of *testing.T in test_helpers #474).
• New MockDoer interface for custom Doer testing with builder pattern methods: AddResponse, AddResponseRaw, AddResponseError, Requests (v3: refactor request/response mocking to use a unified MockDoer API #487).
• New MockRequestNamed type for verifying specific requests in tests (tests: MockDoer refactoring #574).
• New test_helpers.ExecuteOnAll function to execute operations on all instances in parallel with context support (v3: multiple improvements on test_helpers package [pool_helper.go] #485).
• New (*test_helpers.TarantoolInstance).LogTail() method that returns the last 50 lines of captured tarantool stdout/stderr (tests: capture tarantool log tail in startup errors #587).
• New test_helpers.DumpLogsIfFailed(t, inst) helper that prints the captured tarantool log via t.Logf when the test failed — intended for defer test_helpers.DumpLogsIfFailed(t, inst) after a successful StartTarantool (tests: capture tarantool log tail in startup errors #587).

Changed

• All top-level New*Request() constructors now return values instead of pointers. All methods on request types use value receivers and return values, enabling immutable builder-style chaining (request: switch all request types to value receivers and value returns #584).
• Renamed value constructors Make* to New* for naming consistency across the connector (request: switch all request types to value receivers and value returns #584). Affects crud.Make*Request (now crud.New*Request), datetime.MakeDatetime (now datetime.NewDatetime), decimal.MakeDecimal and decimal.MakeDecimalFromString (now decimal.NewDecimal and decimal.NewDecimalFromString), decimal.MustMakeDecimal (now decimal.MustNewDecimal), arrow.MakeArrow (now arrow.NewArrow), and crud.MakeResult (now crud.NewResult).
• Removed intermediate spaceRequest, spaceIndexRequest types — space and index fields are now inlined directly into each request struct. The same flattening was applied to crud.spaceRequest (request: switch all request types to value receivers and value returns #584).
• Required Go version is 1.24 now (package: update go and package versions #456).
• Error types redesigned around errors.Is / errors.As (v3: new design for go-tarantool errors #469): tarantool.Error renamed to tarantool.ServerError; the seven legacy client error code constants are now package-level error sentinels (ErrConnectionClosed, ErrTimeouted, ...) with numeric forms exposed as tarantool.Code*; ClientError gained a Cause field that wraps the underlying I/O error; ClientError.Temporary() removed in favour of tarantool.IsRetryableError(err) / errors.Is(err, ErrRetryable). See MIGRATION.md.
• test_helpers.MockDoer is now an interface instead of a struct (v3: refactor request/response mocking to use a unified MockDoer API #487). The Requests field became a method Requests(). The NewMockDoer() constructor now returns the interface and uses a builder pattern. Old NewMockDoer(t, ...interface{}) is removed. Use NewMockDoer(t), then chain AddResponseRaw(), AddResponseError(), AddResponse() to configure responses.
• box.New returns an error instead of panic (v3: box.New should return an error instead of panic #448).
• Now cases of <-ctx.Done() returns wrapped error provided by ctx.Cause(). Allows you compare it using errors.Is/As (v3: return context error after it is done #457).
• Removed deprecated pool methods, related interfaces and tests are updated (v3: remove all deprecated pooler methods and their implementations #478).
• Removed deprecated box.session.push() support: Future.AppendPush() and Future.GetIterator() methods, ResponseIterator and TimeoutResponseIterator types, Future.pushes[], Future.ready (v3: remove all deprecated methods re obsolete push API #480, v3: remove Future.ready usage #497).
• LogAppendPushFailed replaced with LogBoxSessionPushUnsupported (v3: remove all deprecated methods re obsolete push API #480).
• Removed deprecated Connection methods, related interfaces and tests are updated (v3: remove all deprecated connection methods and their implementations #479).
• Replaced the use of optional types in crud with go-option library (v3: replace usage of optional types in crud with go-option #492).
• Future.done replaced with Future.cond (sync.Cond) + Future.finished bool (v3: replace channel in Future with a cond.Sync #496).
• Future transform into future that implements interface Future and become private, SetError and SetResponse become private (v3: proposal re make tarantool.Future to be interface type #470).
• ConnectionPool.Close() returns a single error value, combining multiple errors using errors.Join() (v3: refactor ConnectionPool.Close() to return a single error #540).
• test_helpers.CheckPoolStatuses and test_helpers.ProcessListenOnInstance now accept typed arguments (CheckStatusesArgs and ListenOnInstanceArgs respectively) instead of interface{} (v3: multiple improvements on test_helpers package [pool_helper.go] #485).
• ConnectionPool.ConnectWithOpts(), ConnectionPool.Connect() and ConnectionPool.Add() now return an error if tarantool.Opts.Reconnect, tarantool.Opts.MaxReconnects or tarantool.Opts.Notify options are set for an instance connection (pool: ban Reconnect, MaxReconnects and Notify opts #581). These options conflict with the pool's own reconnection logic and produce misleading events. Use
  pool.ConnectionHandler to track connection availability instead of tarantool.Opts.Notify. All validation errors are combined using errors.Join and can be checked with errors.Is.
• Rename pool.ConnectionPool to pool.Pool, pool.ConnectionHandler to pool.Handler, pool.ConnectionInfo to pool.Info, pool.ConnectionInfo.ConnRole to pool.Info.Role (api: rename pool package public API for Go idiomatic naming #580).
• Rename pool.Pool.GetInfo() to pool.Pool.Info() (api: rename pool package public API for Go idiomatic naming #580).
• Rename pool.Pool.DoInstance() to pool.Pool.DoOn() (api: rename pool package public API for Go idiomatic naming #580).
• Rename pool.Connect() to pool.New(), pool.ConnectWithOpts() to pool.NewWithOpts() (api: rename pool package public API for Go idiomatic naming #580).
• Rename pool enum constants to use prefix: ANY → ModeAny, RW → ModeRW, RO → ModeRO, PreferRW → ModePreferRW, PreferRO → ModePreferRO, UnknownRole → RoleUnknown, MasterRole → RoleMaster,
  ReplicaRole → RoleReplica (api: rename pool package public API for Go idiomatic naming #580).
• Replaced custom Logger interface with *slog.Logger from the standard library (v3: change design of tarantool.Logger #504). The Logger interface, ConnLogKind type, and its constants (LogReconnectFailed, LogLastReconnectFailed, LogUnexpectedResultId,
  LogWatchEventReadFailed, LogBoxSessionPushUnsupported) are removed. Use Opts.Logger *slog.Logger instead. Pool Opts.Logger *slog.Logger replaces direct log.Printf calls that were not customizable. By default, logs are
  discarded (silent). See MIGRATION.md for details.
• Stream struct fields Id and Conn are now unexported, making Stream an opaque handle. Neither the stream identifier nor the underlying connection is reachable from outside the package (v3: refactor Stream struct #471).

Removed

• Deprecated NewCall16Request and NewCall17Request constructors. Use NewCallRequest instead (api: remove deprecated Call16/Call17 constructors #579).
• test_helpers.Retry function. Use assert.Eventually from testify instead. test_helpers.WaitUntilReconnected reimplemented without Retry (v3: multiple improvements on test_helpers package [pool_helper.go] #485).
• Logger interface and defaultLogger type — replaced by *slog.Logger (v3: change design of tarantool.Logger #504).
• ConnLogKind type and its constants — log messages are now identified by string constants in log.go (v3: change design of tarantool.Logger #504).

Fixed

• Fixed the fluctuating behavior of the TestConnectionHandlerOpenUpdateClose test by increasing the waiting time (tests: flaky TestConnectionHandlerOpenUpdateClose #502).
• On Linux, tarantool processes started by test_helpers.StartTarantool are now terminated when the parent test process dies, preventing leaked instances after a panic (tests: prevent leaked tarantool and panic on bad start #586).
• test_helpers.StartTarantool now captures the last lines of the spawned tarantool's stdout/stderr and includes them in the returned error when startup fails, so test failures show the underlying tarantool error directly instead of just "exit status 1" or a connection timeout (tests: capture tarantool log tail in startup errors #587).
• Reordered tests to defer test_helpers.StopTarantoolWithCleanup only after asserting StartTarantool did not return an error, so a failed start no longer panics with a nil-pointer dereference in the deferred cleanup (tests: prevent leaked tarantool and panic on bad start #586).