Add EnsureParanoidIndices method

Author: EtienneM

mongo/document/base.go

@@ -13,11 +13,11 @@ type Base struct {
 	UpdatedAt time.Time     `bson:"updated_at" json:"updated_at"`
 }
 
-func (d Base) IsPersisted() bool {
+func (d *Base) IsPersisted() bool {
 	return !d.CreatedAt.IsZero()
 }
 
-func (d Base) getID() bson.ObjectId {
+func (d *Base) getID() bson.ObjectId {
 	return d.ID
 }
 

mongo/document/document.go

@@ -5,6 +5,8 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/sirupsen/logrus"
+
 	"gopkg.in/mgo.v2"
 	"gopkg.in/mgo.v2/bson"
 
@@ -22,14 +24,23 @@ type document interface {
 	Validable
 }
 
+var _ document = &Base{}
+var _ document = &Paranoid{}
+
 type scopable interface {
 	scope(bson.M) bson.M
 }
 
+var _ scopable = &Base{}
+var _ scopable = &Paranoid{}
+
 type destroyable interface {
 	destroy(ctx context.Context, collectionName string) error
 }
 
+var _ destroyable = &Base{}
+var _ destroyable = &Paranoid{}
+
 type Closer interface {
 	Close()
 }
@@ -38,6 +49,8 @@ type Validable interface {
 	Validate(ctx context.Context) *ValidationErrors
 }
 
+var _ Validable = &Base{}
+
 // Create inser the document in the database, returns an error if document already exists and set CreatedAt timestamp
 func Create(ctx context.Context, collectionName string, doc document) error {
 	log := logger.Get(ctx)
@@ -221,3 +234,26 @@ func Update(ctx context.Context, collectionName string, update bson.M, doc docum
 	log.WithField("query", update).Debugf("update %v", collectionName)
 	return c.UpdateId(doc.getID(), update)
 }
+
+func EnsureParanoidIndices(ctx context.Context, collectionNames ...string) {
+	go func() {
+		log := logger.Get(ctx)
+
+		for _, collectionName := range collectionNames {
+			log := logger.Get(ctx).WithFields(logrus.Fields{
+				"init":       "setup-indices",
+				"collection": collectionName,
+			})
+			ctx := logger.ToCtx(ctx, log)
+			log.Info("Setup the MongoDB index")
+
+			c := mongo.Session(log).Clone().DB("").C(collectionName)
+			defer c.Database.Session.Close()
+			err := c.EnsureIndexKey("deleted_at")
+			if err != nil {
+				log.WithError(err).Error("fail to setup the deleted_at index")
+				return
+			}
+		}
+	}()
+}

mongo/document/paranoid.go

@@ -12,15 +12,15 @@ type Paranoid struct {
 	DeletedAt *time.Time `bson:"deleted_at,omitempty" json:"deleted_at,omitempty"`
 }
 
-func (p Paranoid) IsDeleted() bool {
+func (p *Paranoid) IsDeleted() bool {
 	return p.DeletedAt != nil && !p.DeletedAt.IsZero()
 }
 
 func (d *Paranoid) setDeletedAt(t time.Time) {
 	d.DeletedAt = &t
 }
 
-func (d Paranoid) scope(query bson.M) bson.M {
+func (d *Paranoid) scope(query bson.M) bson.M {
 	if _, ok := query["deleted_at"]; !ok {
 		query["deleted_at"] = nil
 	}