Added SaveResult type for better validation error handling

Jason Raede · Jason Raede · commit 7e16dd3cd532 · 2014-12-29T21:13:43.000-05:00
diff --git a/collection.go b/collection.go
@@ -2,10 +2,11 @@ package bongo
 
 import (
 	"errors"
+	"fmt"
 	"github.com/oleiade/reflections"
 	"labix.org/v2/mgo"
 	"labix.org/v2/mgo/bson"
-	"log"
+	// "log"
 	"reflect"
 	// "math"
 	// "strings"
@@ -20,10 +21,18 @@ func (c *Collection) Collection() *mgo.Collection {
 	return c.Connection.Session.DB(c.Connection.Config.Database).C(c.Name)
 }
 
-func (c *Collection) Save(mod interface{}) (error, []string) {
+func (c *Collection) Save(mod interface{}) (result *SaveResult) {
 	defer func() {
+
 		if r := recover(); r != nil {
-			log.Fatal("Failed to save:\n", r)
+			if e, ok := r.(error); ok {
+				result = NewSaveResult(false, e)
+			} else if e, ok := r.(string); ok {
+				result = NewSaveResult(false, errors.New(e))
+			} else {
+				result = NewSaveResult(false, errors.New(fmt.Sprint(r)))
+			}
+
 		}
 	}()
 
@@ -58,8 +67,9 @@ func (c *Collection) Save(mod interface{}) (error, []string) {
 		results := reflect.ValueOf(mod).MethodByName("Validate").Call([]reflect.Value{})
 		if errs, ok := results[0].Interface().([]string); ok {
 			if len(errs) > 0 {
-				err := errors.New("Validation failed")
-				return err, errs
+				err := NewSaveResult(false, errors.New("Validation failed"))
+				err.ValidationErrors = errs
+				return err
 			}
 		}
 	}
@@ -87,7 +97,11 @@ func (c *Collection) Save(mod interface{}) (error, []string) {
 
 	_, err = c.Collection().UpsertId(modelMap["_id"], modelMap)
 
-	return err, nil
+	if err != nil {
+		panic(err)
+	}
+
+	return NewSaveResult(true, nil)
 }
 
 func (c *Collection) FindById(id bson.ObjectId, mod interface{}) error {
@@ -113,6 +127,7 @@ func (c *Collection) FindById(id bson.ObjectId, mod interface{}) error {
 // Pass in the sample just so we can get the collection name
 func (c *Collection) Find(query interface{}) *ResultSet {
 
+	// Count for testing
 	q := c.Collection().Find(query)
 
 	resultset := new(ResultSet)
@@ -125,7 +140,7 @@ func (c *Collection) Find(query interface{}) *ResultSet {
 
 func (c *Collection) FindOne(query interface{}, mod interface{}) error {
 	// Now run a find
-	results := c.Connection.Find(query, mod)
+	results := c.Find(query)
 
 	hasNext := results.Next(mod)
 
diff --git a/collection_test.go b/collection_test.go
@@ -17,9 +17,9 @@ func (s *TestSuite) TestSaveAndFindWithHooks(c *C) {
 	message.Msg = "Foo"
 	message.Count = 5
 
-	err, _ := connection.Save(message)
+	result := connection.Save(message)
 
-	c.Assert(err, Equals, nil)
+	c.Assert(result.Success, Equals, true)
 
 	newMessage := new(FooBar)
 
@@ -33,9 +33,9 @@ func (s *TestSuite) TestSaveAndFindWithHooks(c *C) {
 	c.Assert(newMessage.Count, Equals, 12)
 
 	// Saving it again should run +1 on BeforeSave and +2 on BeforeUpdate
-	err, _ = connection.Save(message)
+	result = connection.Save(message)
 
-	c.Assert(err, Equals, nil)
+	c.Assert(result.Success, Equals, true)
 	c.Assert(message.Count, Equals, 10)
 
 	connection.Session.DB(config.Database).DropDatabase()
@@ -55,9 +55,9 @@ func (s *TestSuite) TestSaveAndFindWithChild(c *C) {
 		Foo:     "foo",
 		BazBing: "bar",
 	}
-	err, _ := connection.Save(message)
+	result := connection.Save(message)
 
-	c.Assert(err, Equals, nil)
+	c.Assert(result.Success, Equals, true)
 
 	newMessage := new(FooBar)
 
@@ -79,10 +79,9 @@ func (s *TestSuite) TestValidationFailure(c *C) {
 	message.Msg = "Foo"
 	message.Count = 3
 
-	err, errs := connection.Save(message)
-
-	c.Assert(err.Error(), Equals, "Validation failed")
-	c.Assert(errs[0], Equals, "count cannot be 3")
+	err := connection.Save(message)
+	c.Assert(err.Error.Error(), Equals, "Validation failed")
+	c.Assert(err.ValidationErrors[0], Equals, "count cannot be 3")
 
 	connection.Session.DB(config.Database).DropDatabase()
 }
@@ -112,14 +111,14 @@ func (s *TestSuite) TestDelete(c *C) {
 	message.Msg = "Foo"
 	message.Count = 5
 
-	err, _ := connection.Save(message)
+	result := connection.Save(message)
 
-	c.Assert(err, Equals, nil)
+	c.Assert(result.Success, Equals, true)
 
 	connection.Delete(message)
 
 	newMessage := new(FooBar)
-	err = connection.FindById(message.Id, newMessage)
+	err := connection.FindById(message.Id, newMessage)
 	c.Assert(err.Error(), Equals, "not found")
 	// Make sure the ids are the same
 	//
@@ -138,17 +137,17 @@ func (s *TestSuite) TestFindOne(c *C) {
 	message.Msg = "Foo"
 	message.Count = 5
 
-	err, _ := connection.Save(message)
+	res := connection.Save(message)
 
-	c.Assert(err, Equals, nil)
+	c.Assert(res.Success, Equals, true)
 
 	result := &FooBar{}
 
 	query := bson.M{
 		"count": 7,
 	}
 
-	err = connection.FindOne(query, result)
+	err := connection.FindOne(query, result)
 
 	c.Assert(err, Equals, nil)
 
@@ -170,17 +169,17 @@ func (s *TestSuite) TestFind(c *C) {
 	message.Msg = "Foo"
 	message.Count = 5
 
-	err, _ := connection.Save(message)
+	result := connection.Save(message)
 
-	c.Assert(err, Equals, nil)
+	c.Assert(result.Success, Equals, true)
 
 	message2 := new(FooBar)
 	message2.Msg = "Bar"
 	message2.Count = 10
 
-	err, _ = connection.Save(message2)
+	result = connection.Save(message2)
 
-	c.Assert(err, Equals, nil)
+	c.Assert(result.Success, Equals, true)
 
 	// Now run a find
 	results := connection.Find(nil, &FooBar{})
@@ -214,17 +213,17 @@ func (s *TestSuite) TestFindWithPagination(c *C) {
 	message.Msg = "Foo"
 	message.Count = 5
 
-	err, _ := connection.Save(message)
+	result := connection.Save(message)
 
-	c.Assert(err, Equals, nil)
+	c.Assert(result.Success, Equals, true)
 
 	message2 := new(FooBar)
 	message2.Msg = "Bar"
 	message2.Count = 5
 
-	err, _ = connection.Save(message2)
+	result = connection.Save(message2)
 
-	c.Assert(err, Equals, nil)
+	c.Assert(result.Success, Equals, true)
 
 	// Now run a find (hooks will add 2)
 	results := connection.Find(&bson.M{"count": 7}, &FooBar{})
@@ -269,8 +268,8 @@ func createAndSaveDocument(conn *Connection) {
 		Count: 5,
 	}
 
-	err, _ := conn.Save(message)
-	if err != nil {
+	err := conn.Save(message)
+	if err.Error != nil {
 		panic(err)
 	}
 }
diff --git a/find.go b/find.go
@@ -2,7 +2,7 @@ package bongo
 
 import (
 	"labix.org/v2/mgo"
-	// "log"
+	"log"
 	"math"
 )
 
@@ -37,6 +37,9 @@ func (r *ResultSet) Next(mod interface{}) bool {
 		InitializeDocumentFromDB(r.Connection.GetEncryptionKey(colname), returnMap, mod)
 		return true
 	}
+
+	count, err := r.Query.Count()
+	log.Println("No result", count, err)
 	return false
 }
 
diff --git a/main.go b/main.go
@@ -2,6 +2,7 @@ package bongo
 
 import (
 	// "fmt"
+	"encoding/json"
 	"github.com/oleiade/reflections"
 	"labix.org/v2/mgo"
 	"labix.org/v2/mgo/bson"
@@ -20,6 +21,29 @@ type Config struct {
 	EncryptionKeyPerCollection map[string]string
 }
 
+type SaveResult struct {
+	Success          bool
+	Err              error
+	ValidationErrors []string
+}
+
+func (s *SaveResult) Error() string {
+	return s.Err.Error()
+}
+
+func NewSaveResult(success bool, err error) *SaveResult {
+	return &SaveResult{success, err, []string{}}
+}
+
+func (s *SaveResult) MarshalJSON() ([]byte, error) {
+	// If there are validation errors, just return those as an array. Otherwise marshal the error.Error() string
+	if len(s.ValidationErrors) > 0 {
+		return json.Marshal(s.ValidationErrors)
+	} else {
+		return json.Marshal(s.Err.Error())
+	}
+}
+
 type Connection struct {
 	Config  *Config
 	Session *mgo.Session
@@ -178,7 +202,7 @@ func (m *Connection) FindOne(query interface{}, mod interface{}) error {
 	return col.FindOne(query, mod)
 }
 
-func (m *Connection) Save(mod interface{}) (error, []string) {
+func (m *Connection) Save(mod interface{}) *SaveResult {
 	col := m.Collection(getCollectionName(mod))
 
 	return col.Save(mod)
diff --git a/main_test.go b/main_test.go
@@ -1,6 +1,9 @@
 package bongo
 
 import (
+	"encoding/json"
+	"errors"
+	// "fmt"
 	. "gopkg.in/check.v1"
 )
 
@@ -38,3 +41,30 @@ func (s *TestSuite) TestRegister(c *C) {
 	c.Assert(indexes[1].Key[0], Equals, "count")
 
 }
+
+type errorHolder struct {
+	Err *SaveResult
+}
+
+func (s *TestSuite) TestMarshalResult(c *C) {
+
+	err := NewSaveResult(false, errors.New("Failed to save"))
+
+	holder := &errorHolder{
+		Err: err,
+	}
+
+	marshaled, e := json.Marshal(holder)
+	c.Assert(e, IsNil)
+
+	c.Assert(string(marshaled), Equals, `{"Err":"Failed to save"}`)
+
+	holder.Err.ValidationErrors = []string{"foo", "bar"}
+
+	marshaled, e = json.Marshal(holder)
+	c.Assert(e, IsNil)
+
+	c.Assert(string(marshaled), Equals, `{"Err":["foo","bar"]}`)
+	// fmt.Println(string(marshaled))
+
+}
diff --git a/validate_test.go b/validate_test.go
@@ -26,9 +26,9 @@ func (s *TestSuite) TestValidateMongoIdRef(c *C) {
 	message.Msg = "Foo"
 	message.Count = 5
 
-	err, _ := connection.Save(message)
+	res := connection.Save(message)
 
-	c.Assert(err, Equals, nil)
+	c.Assert(res.Success, Equals, true)
 	c.Assert(ValidateMongoIdRef(message.Id, connection.Collection("foo_bar")), Equals, true)
 	c.Assert(ValidateMongoIdRef(bson.NewObjectId(), connection.Collection("foo_bar")), Equals, false)
 	c.Assert(ValidateMongoIdRef(bson.NewObjectId(), connection.Collection("other_collection")), Equals, false)

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ package bongo`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"labix.org/v2/mgo"`
`5`		`- // "log"`
	`5`	`+ "log"`
`6`	`6`	`"math"`
`7`	`7`	`)`
`8`	`8`
`@@ -37,6 +37,9 @@ func (r *ResultSet) Next(mod interface{}) bool {`
`37`	`37`	`InitializeDocumentFromDB(r.Connection.GetEncryptionKey(colname), returnMap, mod)`
`38`	`38`	`return true`
`39`	`39`	`}`
	`40`	`+`
	`41`	`+ count, err := r.Query.Count()`
	`42`	`+ log.Println("No result", count, err)`
`40`	`43`	`return false`
`41`	`44`	`}`
`42`	`45`