Remove deprecated method (#146)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: AlekSi

internal/util/must/must.go

@@ -15,10 +15,6 @@
 // Package must provides helper functions that panic on error.
 package must
 
-import (
-	"fmt"
-)
-
 // NoError panics if the error is not nil.
 //
 // Use that function only for static initialization, test code, or code that "can't" fail.
@@ -28,14 +24,3 @@ func NoError(err error) {
 		panic(err)
 	}
 }
-
-// NotBeZero panics if argument has zero value.
-//
-// Use that function only for static initialization, test code, or code that "can't" fail.
-// When in doubt, don't.
-func NotBeZero[T comparable](v T) {
-	var zero T
-	if v == zero {
-		panic(fmt.Sprintf("v has zero value (%#v)", v))
-	}
-}

op_msg.go

@@ -23,9 +23,11 @@ import (
 	"github.com/FerretDB/wire/wirebson"
 )
 
-// OpMsg is the main wire protocol message type.
+// OpMsg represents the OP_MSG wire protocol message type.
+// It stores BSON documents in the raw form.
 //
-// Message is checked during construction by [NewOpMsg], [MustOpMsg], or [OpMsg.UnmarshalBinaryNocopy].
+// Message is checked during construction by [NewOpMsg], [MustOpMsg], or [OpMsg.UnmarshalBinaryNocopy]
+// without decoding BSON documents inside.
 type OpMsg struct {
 	// The order of fields is weird to make the struct smaller due to alignment.
 	// The wire order is: flags, sections, optional checksum.
@@ -76,10 +78,6 @@ func (msg *OpMsg) msgbody() {}
 
 // check implements [MsgBody].
 func (msg *OpMsg) check() error {
-	if err := checkSections(msg.sections); err != nil {
-		return lazyerrors.Error(err)
-	}
-
 	for _, s := range msg.sections {
 		for _, d := range s.documents {
 			if _, err := d.DecodeDeep(); err != nil {

op_query.go

@@ -22,9 +22,11 @@ import (
 	"github.com/FerretDB/wire/wirebson"
 )
 
-// OpQuery is a deprecated request message type.
+// OpQuery represents the deprecated OP_QUERY wire protocol message type.
+// It stores BSON documents in the raw form.
 //
-// Message is checked during construction by [NewOpQuery], [MustOpQuery], or [OpQuery.UnmarshalBinaryNocopy].
+// Message is checked during construction by [NewOpQuery], [MustOpQuery], or [OpQuery.UnmarshalBinaryNocopy]
+// without decoding BSON documents inside.
 type OpQuery struct {
 	// The order of fields is weird to make the struct smaller due to alignment.
 	// The wire order is: flags, collection name, number to skip, number to return, query, fields selector.

op_reply.go

@@ -22,11 +22,12 @@ import (
 	"github.com/FerretDB/wire/wirebson"
 )
 
-// OpReply is a deprecated response message type.
-//
-// Message is checked during construction by [NewOpReply], [MustOpReply], or [OpReply.UnmarshalBinaryNocopy].
-//
+// OpReply represents the deprecated OP_REPLY wire protocol message type.
+// It stores BSON documents in the raw form.
 // Only up to one returned document is supported.
+//
+// Message is checked during construction by [NewOpReply], [MustOpReply], or [OpReply.UnmarshalBinaryNocopy]
+// without decoding BSON documents inside.
 type OpReply struct {
 	// The order of fields is weird to make the struct smaller due to alignment.
 	// The wire order is: flags, cursor ID, starting from, documents.

wire_test.go

@@ -136,6 +136,8 @@ func testMessages(t *testing.T, testCases []testCase) {
 
 				switch msgBody := msgBody.(type) {
 				case *OpMsg:
+					require.NoError(t, checkSections(msgBody.sections))
+
 					_, _ = msgBody.Document()
 					_, _ = msgBody.DocumentDeep()
 					_, _ = msgBody.DocumentRaw()
@@ -231,6 +233,8 @@ func fuzzMessages(f *testing.F, testCases []testCase) {
 
 			switch msgBody := msgBody.(type) {
 			case *OpMsg:
+				require.NoError(t, checkSections(msgBody.sections))
+
 				_, _ = msgBody.Document()
 				_, _ = msgBody.DocumentDeep()
 				_, _ = msgBody.DocumentRaw()

wirebson/array.go

@@ -27,7 +27,6 @@ import (
 	"go.mongodb.org/mongo-driver/v2/bson"
 
 	"github.com/FerretDB/wire/internal/util/lazyerrors"
-	"github.com/FerretDB/wire/internal/util/must"
 )
 
 // Array represents a BSON array in the (partially) decoded form.
@@ -161,7 +160,9 @@ func (arr *Array) SortInterface(less func(a, b any) bool) sort.Interface {
 // This method should accept a slice of bytes, not return it.
 // That would allow to avoid unnecessary allocations.
 func (arr *Array) Encode() (RawArray, error) {
-	must.NotBeZero(arr)
+	if arr == nil {
+		panic("arr is nil")
+	}
 
 	size := sizeArray(arr)
 	buf := bytes.NewBuffer(make([]byte, 0, size))
@@ -187,7 +188,9 @@ func (arr *Array) Encode() (RawArray, error) {
 // by encoding Canonical Extended JSON v2 representation of the array.
 func (arr *Array) MarshalJSON() ([]byte, error) {
 	// encoding/json does not call this method on nil
-	must.NotBeZero(arr)
+	if arr == nil {
+		panic("arr is nil")
+	}
 
 	a, err := ToDriver(arr)
 	if err != nil {
@@ -206,15 +209,20 @@ func (arr *Array) MarshalJSON() ([]byte, error) {
 //
 // Receiver must not be nil.
 func (arr *Array) Decode() (*Array, error) {
-	must.NotBeZero(arr)
+	if arr == nil {
+		panic("arr is nil")
+	}
+
 	return arr, nil
 }
 
 // UnmarshalJSON implements [json.Unmarshaler]
 // by decoding Canonical Extended JSON v2 representation of the array.
 func (arr *Array) UnmarshalJSON(b []byte) error {
 	// encoding/json does not call this method on nil
-	must.NotBeZero(arr)
+	if arr == nil {
+		panic("arr is nil")
+	}
 
 	var a bson.A
 	if err := bson.UnmarshalExtJSON(b, true, &a); err != nil {
@@ -228,7 +236,6 @@ func (arr *Array) UnmarshalJSON(b []byte) error {
 
 	switch v := v.(type) {
 	case *Array:
-		must.NotBeZero(v)
 		*arr = *v
 		return nil
 	default:
@@ -244,10 +251,17 @@ func (arr *Array) Copy() *Array {
 	for v := range arr.Values() {
 		switch v := v.(type) {
 		case Binary:
-			must.NoError(res.Add(Binary{B: slices.Clip(slices.Clone(v.B)), Subtype: v.Subtype}))
+			if err := res.Add(Binary{B: slices.Clip(slices.Clone(v.B)), Subtype: v.Subtype}); err != nil {
+				panic(err)
+			}
+
 		default:
-			must.NoError(validBSONType(v))
-			must.NoError(res.Add(v))
+			if err := validBSONType(v); err != nil {
+				panic(err)
+			}
+			if err := res.Add(v); err != nil {
+				panic(err)
+			}
 		}
 	}
 

wirebson/document.go

@@ -25,7 +25,6 @@ import (
 	"go.mongodb.org/mongo-driver/v2/bson"
 
 	"github.com/FerretDB/wire/internal/util/lazyerrors"
-	"github.com/FerretDB/wire/internal/util/must"
 )
 
 // field represents a single Document field in the (partially) decoded form.
@@ -136,15 +135,6 @@ func (doc *Document) Get(name string) any {
 	return nil
 }
 
-// GetByIndex returns the name and the value of the field at the given index (between 0 and [Document.Len]-1).
-// It panics if index is out of bounds.
-//
-// Deprecated: use [Document.All] instead.
-func (doc *Document) GetByIndex(i int) (string, any) {
-	f := doc.fields[i]
-	return f.name, f.value
-}
-
 // All returns an iterator over all field name/value pairs of the Document.
 func (doc *Document) All() iter.Seq2[string, any] {
 	return func(yield func(string, any) bool) {
@@ -239,7 +229,9 @@ func (doc *Document) Command() string {
 // This method should accept a slice of bytes, not return it.
 // That would allow to avoid unnecessary allocations.
 func (doc *Document) Encode() (RawDocument, error) {
-	must.NotBeZero(doc)
+	if doc == nil {
+		panic("doc is nil")
+	}
 
 	size := sizeDocument(doc)
 	buf := bytes.NewBuffer(make([]byte, 0, size))
@@ -265,7 +257,9 @@ func (doc *Document) Encode() (RawDocument, error) {
 // by encoding Canonical Extended JSON v2 representation of the document.
 func (doc *Document) MarshalJSON() ([]byte, error) {
 	// encoding/json does not call this method on nil
-	must.NotBeZero(doc)
+	if doc == nil {
+		panic("doc is nil")
+	}
 
 	d, err := ToDriver(doc)
 	if err != nil {
@@ -284,15 +278,20 @@ func (doc *Document) MarshalJSON() ([]byte, error) {
 //
 // Receiver must not be nil.
 func (doc *Document) Decode() (*Document, error) {
-	must.NotBeZero(doc)
+	if doc == nil {
+		panic("doc is nil")
+	}
+
 	return doc, nil
 }
 
 // UnmarshalJSON implements [json.Unmarshaler]
 // by decoding Canonical Extended JSON v2 representation of the document.
 func (doc *Document) UnmarshalJSON(b []byte) error {
 	// encoding/json does not call this method on nil
-	must.NotBeZero(doc)
+	if doc == nil {
+		panic("doc is nil")
+	}
 
 	var d bson.D
 	if err := bson.UnmarshalExtJSON(b, true, &d); err != nil {
@@ -306,7 +305,6 @@ func (doc *Document) UnmarshalJSON(b []byte) error {
 
 	switch v := v.(type) {
 	case *Document:
-		must.NotBeZero(v)
 		*doc = *v
 		return nil
 	default:
@@ -322,10 +320,17 @@ func (doc *Document) Copy() *Document {
 	for k, v := range doc.All() {
 		switch v := v.(type) {
 		case Binary:
-			must.NoError(res.Add(k, Binary{B: slices.Clip(slices.Clone(v.B)), Subtype: v.Subtype}))
+			if err := res.Add(k, Binary{B: slices.Clip(slices.Clone(v.B)), Subtype: v.Subtype}); err != nil {
+				panic(err)
+			}
+
 		default:
-			must.NoError(validBSONType(v))
-			must.NoError(res.Add(k, v))
+			if err := validBSONType(v); err != nil {
+				panic(err)
+			}
+			if err := res.Add(k, v); err != nil {
+				panic(err)
+			}
 		}
 	}