Merge branch 'master' into ermyar/gh-457_returning_ctx_cause_error

Author: ermyar

CHANGELOG.md

@@ -11,13 +11,15 @@ Versioning](http://semver.org/spec/v2.0.0.html) except to the first release.
 ### Added
 
 * New types for MessagePack extensions compatible with go-option (#459).
+* Added `box.MustNew` wrapper for `box.New` without an error (#448).
 
 ### Changed
 
-- Required Go version is `1.24` now (#456).
-- Now cases of `<-ctx.Done()` returns wrapped error provided by `ctx.Cause()`.
+* Required Go version is `1.24` now (#456).
+* `box.New` returns 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` (#457).
-
+  
 ### Fixed
 
 ## [v2.4.1] - 2025-10-16

MIGRATION.md

@@ -9,6 +9,8 @@ TODO
 ### <a id="major-changes-v3">Major changes</a>
 
 * Required Go version is `1.24` now.
+* `box.New` returns an error instead of panic
+* Added `box.MustNew` wrapper for `box.New` without an error
 
 ## Migration from v1.x.x to v2.x.x
 

box/box.go

@@ -1,6 +1,8 @@
 package box
 
 import (
+	"errors"
+
 	"github.com/tarantool/go-tarantool/v3"
 )
 
@@ -11,16 +13,24 @@ type Box struct {
 }
 
 // New returns a new instance of the box structure, which implements the Box interface.
-func New(conn tarantool.Doer) *Box {
+func New(conn tarantool.Doer) (*Box, error) {
 	if conn == nil {
-		// Check if the provided Tarantool connection is nil, and if it is, panic with an error
-		// message. panic early helps to catch and fix nil pointer issues in the code.
-		panic("tarantool connection cannot be nil")
+		return nil, errors.New("tarantool connection cannot be nil")
 	}
 
 	return &Box{
 		conn: conn, // Assigns the provided Tarantool connection.
+	}, nil
+}
+
+// MustNew returns a new instance of the box structure, which implements the Box interface.
+// It panics if conn == nil.
+func MustNew(conn tarantool.Doer) *Box {
+	b, err := New(conn)
+	if err != nil {
+		panic(err)
 	}
+	return b
 }
 
 // Schema returns a new Schema instance, providing access to schema-related operations.

box/box_test.go

@@ -15,8 +15,31 @@ import (
 func TestNew(t *testing.T) {
 	t.Parallel()
 
+	_, err := box.New(nil)
+	require.Error(t, err)
+}
+
+func TestMustNew(t *testing.T) {
+	t.Parallel()
+
 	// Create a box instance with a nil connection. This should lead to a panic.
-	require.Panics(t, func() { box.New(nil) })
+	require.Panics(t, func() { box.MustNew(nil) })
+}
+
+func TestMocked_BoxNew(t *testing.T) {
+	t.Parallel()
+
+	mock := test_helpers.NewMockDoer(t,
+		test_helpers.NewMockResponse(t, "valid"),
+	)
+
+	b, err := box.New(&mock)
+	require.NoError(t, err)
+	require.NotNil(t, b)
+
+	assert.Len(t, mock.Requests, 0)
+	b.Schema().User().Exists(box.NewInfoRequest().Ctx(), "")
+	require.Len(t, mock.Requests, 1)
 }
 
 func TestMocked_BoxInfo(t *testing.T) {
@@ -37,7 +60,7 @@ func TestMocked_BoxInfo(t *testing.T) {
 	mock := test_helpers.NewMockDoer(t,
 		test_helpers.NewMockResponse(t, data),
 	)
-	b := box.New(&mock)
+	b := box.MustNew(&mock)
 
 	info, err := b.Info()
 	require.NoError(t, err)
@@ -57,7 +80,7 @@ func TestMocked_BoxSchemaUserInfo(t *testing.T) {
 	mock := test_helpers.NewMockDoer(t,
 		test_helpers.NewMockResponse(t, data),
 	)
-	b := box.New(&mock)
+	b := box.MustNew(&mock)
 
 	privs, err := b.Schema().User().Info(context.Background(), "username")
 	require.NoError(t, err)
@@ -82,7 +105,7 @@ func TestMocked_BoxSessionSu(t *testing.T) {
 		test_helpers.NewMockResponse(t, []interface{}{}),
 		errors.New("user not found or supplied credentials are invalid"),
 	)
-	b := box.New(&mock)
+	b := box.MustNew(&mock)
 
 	err := b.Session().Su(context.Background(), "admin")
 	require.NoError(t, err)

box/example_test.go

@@ -45,7 +45,7 @@ func ExampleBox_Info() {
 
 	// Or use simple Box implementation.
 
-	b := box.New(client)
+	b := box.MustNew(client)
 
 	info, err := b.Info()
 	if err != nil {
@@ -88,7 +88,8 @@ func ExampleSchemaUser_Exists() {
 	}
 
 	// Or use simple User implementation.
-	b := box.New(client)
+	b := box.MustNew(client)
+
 	exists, err := b.Schema().User().Exists(ctx, "user")
 	if err != nil {
 		log.Fatalf("Failed get box schema user exists with error: %s", err)
@@ -120,7 +121,7 @@ func ExampleSchemaUser_Create() {
 	}
 
 	// Create SchemaUser.
-	schemaUser := box.New(client).Schema().User()
+	schemaUser := box.MustNew(client).Schema().User()
 
 	// Create a new user.
 	username := "new_user"
@@ -153,7 +154,7 @@ func ExampleSchemaUser_Drop() {
 	}
 
 	// Create SchemaUser.
-	schemaUser := box.New(client).Schema().User()
+	schemaUser := box.MustNew(client).Schema().User()
 
 	// Drop an existing user.
 	username := "new_user"
@@ -192,7 +193,7 @@ func ExampleSchemaUser_Password() {
 	}
 
 	// Create SchemaUser.
-	schemaUser := box.New(client).Schema().User()
+	schemaUser := box.MustNew(client).Schema().User()
 
 	// Get the password hash.
 	password := "my-password"
@@ -221,7 +222,7 @@ func ExampleSchemaUser_Info() {
 	}
 
 	// Create SchemaUser.
-	schemaUser := box.New(client).Schema().User()
+	schemaUser := box.MustNew(client).Schema().User()
 
 	info, err := schemaUser.Info(ctx, "test")
 	if err != nil {

box/session_test.go

@@ -10,7 +10,7 @@ import (
 )
 
 func TestBox_Session(t *testing.T) {
-	b := box.New(th.Ptr(th.NewMockDoer(t)))
+	b := box.MustNew(th.Ptr(th.NewMockDoer(t)))
 	require.NotNil(t, b.Session())
 }