Add mongo/deleteopt

GODRIVER-272

Change-Id: I288c7632ae66e39998ebcc68eb958ba8a0ec23c8

Author: Divjot Arora

mongo/collection.go

@@ -21,6 +21,7 @@ import (
 	"github.com/mongodb/mongo-go-driver/core/writeconcern"
 	"github.com/mongodb/mongo-go-driver/mongo/aggregateopt"
 	"github.com/mongodb/mongo-go-driver/mongo/countopt"
+	"github.com/mongodb/mongo-go-driver/mongo/deleteopt"
 	"github.com/mongodb/mongo-go-driver/mongo/distinctopt"
 	"github.com/mongodb/mongo-go-driver/mongo/findopt"
 	"github.com/mongodb/mongo-go-driver/mongo/insertopt"
@@ -185,7 +186,7 @@ func (coll *Collection) InsertMany(ctx context.Context, documents []interface{},
 // *bson.Document. See TransformDocument for the list of valid types for
 // filter.
 func (coll *Collection) DeleteOne(ctx context.Context, filter interface{},
-	opts ...option.DeleteOptioner) (*DeleteResult, error) {
+	opts ...deleteopt.Delete) (*DeleteResult, error) {
 
 	if ctx == nil {
 		ctx = context.Background()
@@ -201,11 +202,16 @@ func (coll *Collection) DeleteOne(ctx context.Context, filter interface{},
 			bson.EC.Int32("limit", 1)),
 	}
 
+	deleteOpts, err := deleteopt.BundleDelete(opts...).Unbundle(true)
+	if err != nil {
+		return nil, err
+	}
+
 	oldns := coll.namespace()
 	cmd := command.Delete{
 		NS:      command.Namespace{DB: oldns.DB, Collection: oldns.Collection},
 		Deletes: deleteDocs,
-		Opts:    opts,
+		Opts:    deleteOpts,
 	}
 
 	res, err := dispatch.Delete(ctx, cmd, coll.client.topology, coll.writeSelector, coll.writeConcern)
@@ -224,7 +230,7 @@ func (coll *Collection) DeleteOne(ctx context.Context, filter interface{},
 // *bson.Document. See TransformDocument for the list of valid types for
 // filter.
 func (coll *Collection) DeleteMany(ctx context.Context, filter interface{},
-	opts ...option.DeleteOptioner) (*DeleteResult, error) {
+	opts ...deleteopt.Delete) (*DeleteResult, error) {
 
 	if ctx == nil {
 		ctx = context.Background()
@@ -236,11 +242,16 @@ func (coll *Collection) DeleteMany(ctx context.Context, filter interface{},
 	}
 	deleteDocs := []*bson.Document{bson.NewDocument(bson.EC.SubDocument("q", f), bson.EC.Int32("limit", 0))}
 
+	deleteOpts, err := deleteopt.BundleDelete(opts...).Unbundle(true)
+	if err != nil {
+		return nil, err
+	}
+
 	oldns := coll.namespace()
 	cmd := command.Delete{
 		NS:      command.Namespace{DB: oldns.DB, Collection: oldns.Collection},
 		Deletes: deleteDocs,
-		Opts:    opts,
+		Opts:    deleteOpts,
 	}
 
 	res, err := dispatch.Delete(ctx, cmd, coll.client.topology, coll.writeSelector, coll.writeConcern)

mongo/collection_internal_test.go

@@ -19,6 +19,7 @@ import (
 	"github.com/mongodb/mongo-go-driver/internal/testutil"
 	"github.com/mongodb/mongo-go-driver/mongo/aggregateopt"
 	"github.com/mongodb/mongo-go-driver/mongo/countopt"
+	"github.com/mongodb/mongo-go-driver/mongo/deleteopt"
 	"github.com/mongodb/mongo-go-driver/mongo/distinctopt"
 	"github.com/mongodb/mongo-go-driver/mongo/findopt"
 	"github.com/mongodb/mongo-go-driver/mongo/insertopt"
@@ -394,7 +395,11 @@ func TestCollection_DeleteOne_notFound_withOption(t *testing.T) {
 	initCollection(t, coll)
 
 	filter := bson.NewDocument(bson.EC.Int32("x", 0))
-	result, err := coll.DeleteOne(context.Background(), filter, Opt.Collation(&option.Collation{Locale: "en_US"}))
+
+	collationOpt := &option.Collation{
+		Locale: "en_US",
+	}
+	result, err := coll.DeleteOne(context.Background(), filter, deleteopt.Collation(collationOpt))
 	require.Nil(t, err)
 	require.Equal(t, result.DeletedCount, int64(0))
 }
@@ -447,9 +452,8 @@ func TestCollection_DeleteMany_WriteConcernError(t *testing.T) {
 	filter := bson.NewDocument(bson.EC.Int32("x", 1))
 	coll := createTestCollection(t, nil, nil)
 
-	optwc, err := Opt.WriteConcern(writeconcern.New(writeconcern.W(25)))
-	require.NoError(t, err)
-	_, err = coll.DeleteOne(context.Background(), filter, optwc)
+	optwc := deleteopt.WriteConcern(writeconcern.New(writeconcern.W(25)))
+	_, err := coll.DeleteOne(context.Background(), filter, optwc)
 	got, ok := err.(WriteConcernError)
 	if !ok {
 		t.Errorf("Did not receive correct type of error. got %T; want %T", err, WriteConcernError{})
@@ -511,7 +515,7 @@ func TestCollection_DeleteMany_notFound_withOption(t *testing.T) {
 	filter := bson.NewDocument(
 		bson.EC.SubDocumentFromElements("x", bson.EC.Int32("$lt", 1)))
 
-	result, err := coll.DeleteMany(context.Background(), filter, Opt.Collation(&option.Collation{Locale: "en_US"}))
+	result, err := coll.DeleteMany(context.Background(), filter, deleteopt.Collation(&option.Collation{Locale: "en_US"}))
 	require.Nil(t, err)
 	require.Equal(t, result.DeletedCount, int64(0))
 }
@@ -564,9 +568,8 @@ func TestCollection_DeleteOne_WriteConcernError(t *testing.T) {
 	filter := bson.NewDocument(bson.EC.Int32("x", 1))
 	coll := createTestCollection(t, nil, nil)
 
-	optwc, err := Opt.WriteConcern(writeconcern.New(writeconcern.W(25)))
-	require.NoError(t, err)
-	_, err = coll.DeleteMany(context.Background(), filter, optwc)
+	optwc := deleteopt.WriteConcern(writeconcern.New(writeconcern.W(25)))
+	_, err := coll.DeleteMany(context.Background(), filter, optwc)
 	got, ok := err.(WriteConcernError)
 	if !ok {
 		t.Errorf("Did not receive correct type of error. got %T; want %T", err, WriteConcernError{})

mongo/crud_spec_test.go

@@ -16,6 +16,7 @@ import (
 	"github.com/mongodb/mongo-go-driver/internal/testutil/helpers"
 	"github.com/mongodb/mongo-go-driver/mongo/aggregateopt"
 	"github.com/mongodb/mongo-go-driver/mongo/countopt"
+	"github.com/mongodb/mongo-go-driver/mongo/deleteopt"
 	"github.com/mongodb/mongo-go-driver/mongo/distinctopt"
 	"github.com/mongodb/mongo-go-driver/mongo/findopt"
 	"github.com/mongodb/mongo-go-driver/mongo/replaceopt"
@@ -262,10 +263,11 @@ func deleteManyTest(t *testing.T, coll *Collection, test *testCase) {
 	t.Run(test.Description, func(t *testing.T) {
 		filter := test.Operation.Arguments["filter"].(map[string]interface{})
 
-		var opts []option.DeleteOptioner
+		var opts []deleteopt.Delete
 
 		if collation, found := test.Operation.Arguments["collation"]; found {
-			opts = append(opts, Opt.Collation(collationFromMap(collation.(map[string]interface{}))))
+			mapCollation := collation.(map[string]interface{})
+			opts = append(opts, deleteopt.Collation(collationFromMap(mapCollation)))
 		}
 
 		actual, err := coll.DeleteMany(context.Background(), filter, opts...)
@@ -288,10 +290,11 @@ func deleteOneTest(t *testing.T, coll *Collection, test *testCase) {
 	t.Run(test.Description, func(t *testing.T) {
 		filter := test.Operation.Arguments["filter"].(map[string]interface{})
 
-		var opts []option.DeleteOptioner
+		var opts []deleteopt.Delete
 
 		if collation, found := test.Operation.Arguments["collation"]; found {
-			opts = append(opts, Opt.Collation(collationFromMap(collation.(map[string]interface{}))))
+			mapCollation := collationFromMap(collation.(map[string]interface{}))
+			opts = append(opts, deleteopt.Collation(mapCollation))
 		}
 
 		actual, err := coll.DeleteOne(context.Background(), filter, opts...)

mongo/deleteopt/deleteopt.go

@@ -0,0 +1,203 @@
+package deleteopt
+
+import (
+	"reflect"
+
+	"github.com/mongodb/mongo-go-driver/core/option"
+	"github.com/mongodb/mongo-go-driver/core/writeconcern"
+)
+
+var deleteBundle = new(DeleteBundle)
+
+// Delete is options for the delete() function.
+type Delete interface {
+	delete()
+	ConvertOption() option.DeleteOptioner
+}
+
+// DeleteBundle is a bundle of Delete options
+type DeleteBundle struct {
+	option Delete
+	next   *DeleteBundle
+}
+
+func (db *DeleteBundle) delete() {}
+
+// ConvertOption implements the Delete interface.
+func (db *DeleteBundle) ConvertOption() option.DeleteOptioner {
+	return nil
+}
+
+// BundleDelete bundles Delete options.
+func BundleDelete(opts ...Delete) *DeleteBundle {
+	head := deleteBundle
+
+	for _, opt := range opts {
+		newBundle := DeleteBundle{
+			option: opt,
+			next:   head,
+		}
+
+		head = &newBundle
+	}
+
+	return head
+}
+
+// Collation adds an option to specify a collation.
+func (db *DeleteBundle) Collation(c *option.Collation) *DeleteBundle {
+	bundle := &DeleteBundle{
+		option: Collation(c),
+		next:   db,
+	}
+
+	return bundle
+}
+
+// WriteConcern adds an option to specify a write concern.
+func (db *DeleteBundle) WriteConcern(wc *writeconcern.WriteConcern) *DeleteBundle {
+	bundle := &DeleteBundle{
+		option: WriteConcern(wc),
+		next:   db,
+	}
+
+	return bundle
+}
+
+// Unbundle transforms a bundle into a slice of options, optionally deduplicating
+func (db *DeleteBundle) Unbundle(deduplicate bool) ([]option.DeleteOptioner, error) {
+
+	options, err := db.unbundle()
+	if err != nil {
+		return nil, err
+	}
+
+	if !deduplicate {
+		return options, nil
+	}
+
+	// iterate backwards and make dedup slice
+	optionsSet := make(map[reflect.Type]struct{})
+
+	for i := len(options) - 1; i >= 0; i-- {
+		currOption := options[i]
+		optionType := reflect.TypeOf(currOption)
+
+		if _, ok := optionsSet[optionType]; ok {
+			// option already found
+			options = append(options[:i], options[i+1:]...)
+			continue
+		}
+
+		optionsSet[optionType] = struct{}{}
+	}
+
+	return options, nil
+}
+
+// Calculates the total length of a bundle, accounting for nested bundles.
+func (db *DeleteBundle) bundleLength() int {
+	if db == nil {
+		return 0
+	}
+
+	bundleLen := 0
+	for ; db != nil && db.option != nil; db = db.next {
+		if converted, ok := db.option.(*DeleteBundle); ok {
+			// nested bundle
+			bundleLen += converted.bundleLength()
+			continue
+		}
+
+		bundleLen++
+	}
+
+	return bundleLen
+}
+
+// Helper that recursively unwraps bundle into slice of options
+func (db *DeleteBundle) unbundle() ([]option.DeleteOptioner, error) {
+	if db == nil {
+		return nil, nil
+	}
+
+	listLen := db.bundleLength()
+
+	options := make([]option.DeleteOptioner, listLen)
+	index := listLen - 1
+
+	for listHead := db; listHead != nil && listHead.option != nil; listHead = listHead.next {
+		// if the current option is a nested bundle, Unbundle it and add its options to the current array
+		if converted, ok := listHead.option.(*DeleteBundle); ok {
+			nestedOptions, err := converted.unbundle()
+			if err != nil {
+				return nil, err
+			}
+
+			// where to start inserting nested options
+			startIndex := index - len(nestedOptions) + 1
+
+			// add nested options in order
+			for _, nestedOp := range nestedOptions {
+				options[startIndex] = nestedOp
+				startIndex++
+			}
+			index -= len(nestedOptions)
+			continue
+		}
+
+		options[index] = listHead.option.ConvertOption()
+		index--
+	}
+
+	return options, nil
+}
+
+// String implements the Stringer interface
+func (db *DeleteBundle) String() string {
+	if db == nil {
+		return ""
+	}
+
+	str := ""
+	for head := db; head != nil && head.option != nil; head = head.next {
+		if converted, ok := head.option.(*DeleteBundle); ok {
+			str += converted.String()
+			continue
+		}
+
+		str += head.option.ConvertOption().String() + "\n"
+	}
+
+	return str
+}
+
+// Collation specifies a collation.
+func Collation(c *option.Collation) OptCollation {
+	return OptCollation{Collation: c}
+}
+
+// WriteConcern specifies a write concern.
+func WriteConcern(wc *writeconcern.WriteConcern) OptWriteConcern {
+	return OptWriteConcern{wc}
+}
+
+// OptCollation specifies a collation.
+type OptCollation option.OptCollation
+
+func (OptCollation) delete() {}
+
+// ConvertOption implements the Delete interface.
+func (opt OptCollation) ConvertOption() option.DeleteOptioner {
+	return option.OptCollation(opt)
+}
+
+// OptWriteConcern specifies a write concern.
+type OptWriteConcern option.OptWriteConcern
+
+func (OptWriteConcern) delete() {}
+
+// ConvertOption implements the Delete interface.
+func (opt OptWriteConcern) ConvertOption() option.DeleteOptioner {
+	return option.OptWriteConcern(opt)
+}