watch.go

package option

import (
	"github.com/GabrielHCataldo/go-helper/helper"
	"go.mongodb.org/mongo-driver/bson"
	"go.mongodb.org/mongo-driver/bson/primitive"
	"time"
)

// Watch represents options that can be used to configure a 'Watch'  operation.
type Watch struct {
	// DatabaseName database name to watch
	DatabaseName string
	// CollectionName collection name to watch
	CollectionName string
	// BatchSize The maximum number of documents to be included in each batch returned by the server.
	BatchSize *int32
	// Collation Specifies a collation to use for string comparisons during the operation. This option is only valid
	// for MongoDB  versions >= 3.4. For previous server versions, the driver will return an error if this option is
	// used. The default value is nil, which means the default collation of the collection will be used.
	Collation *Collation
	// Comment A string that will be included in server logs, profiling logs, and currentOp queries to help trace the operation.
	// The default is nil, which means that no comment will be included in the logs.
	Comment *string
	// FullDocument Specifies how the updated document should be returned in Change notifications for update operations.
	// The default is FullDocumentDefault, which means that only partial update deltas will be included in the Change
	// notification.
	FullDocument *FullDocument
	// FullDocumentBeforeChange Specifies how the pre-update document should be returned in Change notifications for
	// update operations. The default is FullDocumentOff, which means that the pre-update document will not be included
	// in the Change notification.
	FullDocumentBeforeChange *FullDocument
	// MaxAwaitTime The maximum amount of time that the server should wait for new documents to satisfy a tailable cursor query.
	MaxAwaitTime *time.Duration
	// ResumeAfter A document specifying the logical starting point for the Change stream. Only changes corresponding to an oplog
	// entry immediately after the resume token will be returned. If this is specified, StartAtOperationTime and
	// StartAfter must not be set.
	ResumeAfter any
	// ShowExpandedEvents specifies whether the server will return an expanded list of Change stream events. Additional
	// events include: createIndexes, dropIndexes, modify, create, shardCollection, reshardCollection and
	// refineCollectionShardKey. This option is only valid for MongoDB versions >= 6.0.
	ShowExpandedEvents *bool
	// StartAtOperationTime If specified, the Change stream will only return changes that occurred at or after the given timestamp. This
	// option is only valid for MongoDB versions >= 4.0. If this is specified, ResumeAfter and StartAfter must not be
	// set.
	StartAtOperationTime *primitive.Timestamp
	// StartAfter A document specifying the logical starting point for the Change stream. This is similar to the ResumeAfter
	// option, but allows a resume token from an "invalidate" notification to be used. This allows a Change stream on a
	// collection to be resumed after the collection has been dropped and recreated or renamed. Only changes
	// corresponding to an oplog entry immediately after the specified token will be returned. If this is specified,
	// ResumeAfter and StartAtOperationTime must not be set. This option is only valid for MongoDB versions >= 4.1.1.
	StartAfter any
	// Custom options to be added to the initial aggregate for the Change stream. Key-value pairs of the BSON map should
	// correlate with desired option names and values. Values must be Marshalable. Custom options may conflict with
	// non-custom options, and custom options bypass client-side validation. Prefer using non-custom options where possible.
	Custom bson.M
	// CustomPipeline options to be added to the $changeStream stage in the initial aggregate. Key-value pairs of the BSON map should
	// correlate with desired option names and values. Values must be Marshalable. Custom pipeline options bypass client-side
	// validation. Prefer using non-custom options where possible.
	CustomPipeline bson.M
}

// WatchWithHandler represents options that can be used to configure a 'WatchWithHandler'  operation.
type WatchWithHandler struct {
	// DatabaseName database name to watch
	DatabaseName string
	// CollectionName collection name to watch
	CollectionName string
	// ContextFuncTimeout Duration time to process the func watch, timeout applied in the past context.
	//
	// default: 5 seconds
	ContextFuncTimeout time.Duration
	// DelayLoop Delay to run the next search for messages in the queue
	//
	// default: 5 seconds
	DelayLoop time.Duration
	// BatchSize The maximum number of documents to be included in each batch returned by the server.
	BatchSize *int32
	// Collation Specifies a collation to use for string comparisons during the operation. This option is only valid
	// for MongoDB  versions >= 3.4. For previous server versions, the driver will return an error if this option is
	// used. The default value is nil, which means the default collation of the collection will be used.
	Collation *Collation
	// Comment A string that will be included in server logs, profiling logs, and currentOp queries to help trace the operation.
	// The default is nil, which means that no comment will be included in the logs.
	Comment *string
	// FullDocument Specifies how the updated document should be returned in Change notifications for update operations.
	// The default is FullDocumentDefault, which means that only partial update deltas will be included in the Change
	// notification.
	FullDocument *FullDocument
	// FullDocumentBeforeChange Specifies how the pre-update document should be returned in Change notifications for
	// update operations. The default is FullDocumentOff, which means that the pre-update document will not be included
	// in the Change notification.
	FullDocumentBeforeChange *FullDocument
	// MaxAwaitTime The maximum amount of time that the server should wait for new documents to satisfy a tailable cursor query.
	MaxAwaitTime *time.Duration
	// ResumeAfter A document specifying the logical starting point for the Change stream. Only changes corresponding to an oplog
	// entry immediately after the resume token will be returned. If this is specified, StartAtOperationTime and
	// StartAfter must not be set.
	ResumeAfter any
	// ShowExpandedEvents specifies whether the server will return an expanded list of Change stream events. Additional
	// events include: createIndexes, dropIndexes, modify, create, shardCollection, reshardCollection and
	// refineCollectionShardKey. This option is only valid for MongoDB versions >= 6.0.
	ShowExpandedEvents *bool
	// StartAtOperationTime If specified, the Change stream will only return changes that occurred at or after the given timestamp. This
	// option is only valid for MongoDB versions >= 4.0. If this is specified, ResumeAfter and StartAfter must not be
	// set.
	StartAtOperationTime *primitive.Timestamp
	// StartAfter A document specifying the logical starting point for the Change stream. This is similar to the ResumeAfter
	// option, but allows a resume token from an "invalidate" notification to be used. This allows a Change stream on a
	// collection to be resumed after the collection has been dropped and recreated or renamed. Only changes
	// corresponding to an oplog entry immediately after the specified token will be returned. If this is specified,
	// ResumeAfter and StartAtOperationTime must not be set. This option is only valid for MongoDB versions >= 4.1.1.
	StartAfter any
	// Custom options to be added to the initial aggregate for the Change stream. Key-value pairs of the BSON map should
	// correlate with desired option names and values. Values must be Marshalable. Custom options may conflict with
	// non-custom options, and custom options bypass client-side validation. Prefer using non-custom options where possible.
	Custom bson.M
	// CustomPipeline options to be added to the $changeStream stage in the initial aggregate. Key-value pairs of the BSON map should
	// correlate with desired option names and values. Values must be Marshalable. Custom pipeline options bypass client-side
	// validation. Prefer using non-custom options where possible.
	CustomPipeline bson.M
}

// NewWatch creates a new Watch instance.
func NewWatch() *Watch {
	return &Watch{}
}

// NewWatchWithHandler creates a new WatchWithHandler instance.
func NewWatchWithHandler() *WatchWithHandler {
	return &WatchWithHandler{}
}

// SetDatabaseName creates a new DatabaseName instance.
func (w *Watch) SetDatabaseName(s string) *Watch {
	w.DatabaseName = s
	return w
}

// SetCollectionName creates a new CollectionName instance.
func (w *Watch) SetCollectionName(s string) *Watch {
	w.CollectionName = s
	return w
}

// SetBatchSize creates a new BatchSize instance.
func (w *Watch) SetBatchSize(i int32) *Watch {
	w.BatchSize = &i
	return w
}

// SetCollation sets value for the Collation field.
func (w *Watch) SetCollation(c *Collation) *Watch {
	w.Collation = c
	return w
}

// SetComment sets value for the Comment field.
func (w *Watch) SetComment(s string) *Watch {
	w.Comment = &s
	return w
}

// SetFullDocument sets value for the FullDocument field.
func (w *Watch) SetFullDocument(f FullDocument) *Watch {
	w.FullDocument = &f
	return w
}

// SetFullDocumentBeforeChange sets value for the FullDocumentBeforeChange field.
func (w *Watch) SetFullDocumentBeforeChange(f FullDocument) *Watch {
	w.FullDocumentBeforeChange = &f
	return w
}

// SetMaxAwaitTime sets value for the MaxAwaitTime field.
func (w *Watch) SetMaxAwaitTime(d time.Duration) *Watch {
	w.MaxAwaitTime = &d
	return w
}

// SetResumeAfter sets value for the ResumeAfter field.
func (w *Watch) SetResumeAfter(a any) *Watch {
	w.ResumeAfter = a
	return w
}

// SetShowExpandedEvents sets value for the ShowExpandedEvents field.
func (w *Watch) SetShowExpandedEvents(b bool) *Watch {
	w.ShowExpandedEvents = &b
	return w
}

// SetStartAtOperationTime sets value for the StartAtOperationTime field.
func (w *Watch) SetStartAtOperationTime(t primitive.Timestamp) *Watch {
	w.StartAtOperationTime = &t
	return w
}

// SetStartAfter sets value for the StartAfter field.
func (w *Watch) SetStartAfter(a any) *Watch {
	w.StartAfter = a
	return w
}

// SetCustom sets value for the Custom field.
func (w *Watch) SetCustom(b bson.M) *Watch {
	w.Custom = b
	return w
}

// SetCustomPipeline sets value for the CustomPipeline field.
func (w *Watch) SetCustomPipeline(b bson.M) *Watch {
	w.CustomPipeline = b
	return w
}

// SetDatabaseName sets value for the DatabaseName field.
func (w *WatchWithHandler) SetDatabaseName(s string) *WatchWithHandler {
	w.DatabaseName = s
	return w
}

// SetCollectionName sets value for the WatchWithHandler field.
func (w *WatchWithHandler) SetCollectionName(s string) *WatchWithHandler {
	w.CollectionName = s
	return w
}

func (w *WatchWithHandler) SetContextFuncTimeout(d time.Duration) *WatchWithHandler {
	w.ContextFuncTimeout = d
	return w
}

func (w *WatchWithHandler) SetDelayLoop(d time.Duration) *WatchWithHandler {
	w.DelayLoop = d
	return w
}

// SetBatchSize creates a new BatchSize instance.
func (w *WatchWithHandler) SetBatchSize(i int32) *WatchWithHandler {
	w.BatchSize = &i
	return w
}

// SetCollation sets value for the Collation field.
func (w *WatchWithHandler) SetCollation(c *Collation) *WatchWithHandler {
	w.Collation = c
	return w
}

// SetComment sets value for the Comment field.
func (w *WatchWithHandler) SetComment(s string) *WatchWithHandler {
	w.Comment = &s
	return w
}

// SetFullDocument sets value for the FullDocument field.
func (w *WatchWithHandler) SetFullDocument(f FullDocument) *WatchWithHandler {
	w.FullDocument = &f
	return w
}

// SetFullDocumentBeforeChange sets value for the FullDocumentBeforeChange field.
func (w *WatchWithHandler) SetFullDocumentBeforeChange(f FullDocument) *WatchWithHandler {
	w.FullDocumentBeforeChange = &f
	return w
}

// SetMaxAwaitTime sets value for the MaxAwaitTime field.
func (w *WatchWithHandler) SetMaxAwaitTime(d time.Duration) *WatchWithHandler {
	w.MaxAwaitTime = &d
	return w
}

// SetResumeAfter sets value for the ResumeAfter field.
func (w *WatchWithHandler) SetResumeAfter(a any) *WatchWithHandler {
	w.ResumeAfter = a
	return w
}

// SetShowExpandedEvents sets value for the ShowExpandedEvents field.
func (w *WatchWithHandler) SetShowExpandedEvents(b bool) *WatchWithHandler {
	w.ShowExpandedEvents = &b
	return w
}

// SetStartAtOperationTime sets value for the StartAtOperationTime field.
func (w *WatchWithHandler) SetStartAtOperationTime(t primitive.Timestamp) *WatchWithHandler {
	w.StartAtOperationTime = &t
	return w
}

// SetStartAfter sets value for the StartAfter field.
func (w *WatchWithHandler) SetStartAfter(a any) *WatchWithHandler {
	w.StartAfter = a
	return w
}

// SetCustom sets value for the Custom field.
func (w *WatchWithHandler) SetCustom(b bson.M) *WatchWithHandler {
	w.Custom = b
	return w
}

// SetCustomPipeline sets value for the CustomPipeline field.
func (w *WatchWithHandler) SetCustomPipeline(b bson.M) *WatchWithHandler {
	w.CustomPipeline = b
	return w
}

// MergeWatchByParams assembles the Watch object from optional parameters.
func MergeWatchByParams(opts []*Watch) *Watch {
	result := &Watch{}
	for _, opt := range opts {
		if helper.IsNil(opt) {
			continue
		}
		if helper.IsNotNil(opt.BatchSize) {
			result.BatchSize = opt.BatchSize
		}
		if helper.IsNotNil(opt.Collation) {
			result.Collation = opt.Collation
		}
		if helper.IsNotNil(opt.Comment) {
			result.Comment = opt.Comment
		}
		if helper.IsNotEmpty(opt.DatabaseName) {
			result.DatabaseName = opt.DatabaseName
		}
		if helper.IsNotEmpty(opt.CollectionName) {
			result.CollectionName = opt.CollectionName
		}
		if helper.IsNotNil(opt.MaxAwaitTime) {
			result.MaxAwaitTime = opt.MaxAwaitTime
		}
		if helper.IsNotNil(opt.Custom) {
			result.Custom = opt.Custom
		}
		if helper.IsNotNil(opt.ResumeAfter) {
			result.ResumeAfter = opt.ResumeAfter
		}
		if helper.IsNotNil(opt.FullDocument) {
			result.FullDocument = opt.FullDocument
		}
		if helper.IsNotNil(opt.FullDocumentBeforeChange) {
			result.FullDocumentBeforeChange = opt.FullDocumentBeforeChange
		}
		if helper.IsNotNil(opt.ShowExpandedEvents) {
			result.ShowExpandedEvents = opt.ShowExpandedEvents
		}
		if helper.IsNotNil(opt.StartAtOperationTime) {
			result.StartAtOperationTime = opt.StartAtOperationTime
		}
		if helper.IsNotNil(opt.StartAfter) {
			result.StartAfter = opt.StartAfter
		}
		if helper.IsNotNil(opt.Custom) {
			result.Custom = opt.Custom
		}
		if helper.IsNotNil(opt.CustomPipeline) {
			result.CustomPipeline = opt.CustomPipeline
		}
	}
	return result
}

// MergeWatchHandlerByParams assembles the WatchWithHandler object from optional parameters.
func MergeWatchHandlerByParams(opts []*WatchWithHandler) *WatchWithHandler {
	result := WatchWithHandler{}
	for _, opt := range opts {
		if helper.IsNil(opt) {
			continue
		}
		if helper.IsGreaterThan(opt.ContextFuncTimeout, 0) {
			result.ContextFuncTimeout = opt.ContextFuncTimeout
		}
		if helper.IsGreaterThan(opt.DelayLoop, 0) {
			result.DelayLoop = opt.DelayLoop
		}
		if helper.IsNotNil(opt.BatchSize) {
			result.BatchSize = opt.BatchSize
		}
		if helper.IsNotNil(opt.Collation) {
			result.Collation = opt.Collation
		}
		if helper.IsNotNil(opt.Comment) {
			result.Comment = opt.Comment
		}
		if helper.IsNotEmpty(opt.DatabaseName) {
			result.DatabaseName = opt.DatabaseName
		}
		if helper.IsNotEmpty(opt.CollectionName) {
			result.CollectionName = opt.CollectionName
		}
		if helper.IsNotNil(opt.MaxAwaitTime) {
			result.MaxAwaitTime = opt.MaxAwaitTime
		}
		if helper.IsNotNil(opt.Custom) {
			result.Custom = opt.Custom
		}
		if helper.IsNotNil(opt.ResumeAfter) {
			result.ResumeAfter = opt.ResumeAfter
		}
		if helper.IsNotNil(opt.FullDocument) {
			result.FullDocument = opt.FullDocument
		}
		if helper.IsNotNil(opt.FullDocumentBeforeChange) {
			result.FullDocumentBeforeChange = opt.FullDocumentBeforeChange
		}
		if helper.IsNotNil(opt.ShowExpandedEvents) {
			result.ShowExpandedEvents = opt.ShowExpandedEvents
		}
		if helper.IsNotNil(opt.StartAtOperationTime) {
			result.StartAtOperationTime = opt.StartAtOperationTime
		}
		if helper.IsNotNil(opt.StartAfter) {
			result.StartAfter = opt.StartAfter
		}
		if helper.IsNotNil(opt.Custom) {
			result.Custom = opt.Custom
		}
		if helper.IsNotNil(opt.CustomPipeline) {
			result.CustomPipeline = opt.CustomPipeline
		}
	}
	if helper.IsLessThanOrEqual(result.ContextFuncTimeout, 0) {
		result.ContextFuncTimeout = 5 * time.Second
	}
	if helper.IsLessThanOrEqual(result.DelayLoop, 0) {
		result.DelayLoop = 5 * time.Second
	}
	return &result
}