Open platform to collect and prioritize feedback
Use a new binder and avoid duplicate code (#138)
Guilherme Oenning415d987eef5c
diff --git a/app/actions/idea.go b/app/actions/idea.goindex 31d233250..d84ac3d6f 100644--- a/app/actions/idea.go+++ b/app/actions/idea.go@@ -28,8 +28,6 @@ func (input *CreateNewIdea) IsAuthorized(user *models.User) bool {func (input *CreateNewIdea) Validate(services *app.Services) *validate.Result {result := validate.Success()- input.Model.Title = strings.Trim(input.Model.Title, " ")-if input.Model.Title == "" {result.AddFieldFailure("title", "Title is required.")}@@ -61,7 +59,7 @@ func (input *AddNewComment) IsAuthorized(user *models.User) bool {func (input *AddNewComment) Validate(services *app.Services) *validate.Result {result := validate.Success()- if strings.Trim(input.Model.Content, " ") == "" {+ if input.Model.Content == "" {result.AddFieldFailure("content", "Comment is required.")}@@ -92,7 +90,7 @@ func (input *SetResponse) Validate(services *app.Services) *validate.Result {result.AddFieldFailure("status", "Status is invalid.")}- if strings.Trim(input.Model.Text, " ") == "" {+ if input.Model.Text == "" {result.AddFieldFailure("text", "Text is required.")}diff --git a/app/actions/settings.go b/app/actions/settings.goindex 52d2ed807..d0dd42df4 100644--- a/app/actions/settings.go+++ b/app/actions/settings.go@@ -1,8 +1,6 @@package actionsimport (- "strings"-"github.com/getfider/fider/app""github.com/getfider/fider/app/models""github.com/getfider/fider/app/pkg/validate"@@ -27,7 +25,6 @@ func (input *UpdateUserSettings) IsAuthorized(user *models.User) bool {// Validate is current model is validfunc (input *UpdateUserSettings) Validate(services *app.Services) *validate.Result {result := validate.Success()- input.Model.Name = strings.Trim(input.Model.Name, " ")if input.Model.Name == "" {result.AddFieldFailure("name", "Name is required.")diff --git a/app/actions/settings_test.go b/app/actions/settings_test.goindex 28753f11d..17bfdebda 100644--- a/app/actions/settings_test.go+++ b/app/actions/settings_test.go@@ -14,7 +14,6 @@ func TestInvalidUserNames(t *testing.T) {for _, name := range []string{"",- " ","123456789012345678901234567890123456789012345678901", // 51 chars} {action := &actions.UpdateUserSettings{Model: &models.UpdateUserSettings{Name: name}}diff --git a/app/actions/signin.go b/app/actions/signin.goindex dc63f5bba..17e7b001a 100644--- a/app/actions/signin.go+++ b/app/actions/signin.go@@ -29,7 +29,6 @@ func (input *SignInByEmail) IsAuthorized(user *models.User) bool {// Validate is current model is validfunc (input *SignInByEmail) Validate(services *app.Services) *validate.Result {result := validate.Success()- input.Model.Email = strings.ToLower(strings.Trim(input.Model.Email, " "))if input.Model.Email == "" {result.AddFieldFailure("email", "E-mail is required.")@@ -67,8 +66,6 @@ func (input *CompleteProfile) IsAuthorized(user *models.User) bool {// Validate is current model is validfunc (input *CompleteProfile) Validate(services *app.Services) *validate.Result {result := validate.Success()- input.Model.Key = strings.Trim(input.Model.Key, " ")- input.Model.Name = strings.Trim(input.Model.Name, " ")if input.Model.Name == "" {result.AddFieldFailure("name", "Name is required.")diff --git a/app/actions/tenant.go b/app/actions/tenant.goindex 45cb4ce3a..515d070ab 100644--- a/app/actions/tenant.go+++ b/app/actions/tenant.go@@ -31,10 +31,6 @@ func (input *CreateTenant) IsAuthorized(user *models.User) bool {// Validate is current model is validfunc (input *CreateTenant) Validate(services *app.Services) *validate.Result {result := validate.Success()- input.Model.Name = strings.Trim(input.Model.Name, " ")- input.Model.Email = strings.ToLower(strings.Trim(input.Model.Email, " "))- input.Model.TenantName = strings.Trim(input.Model.TenantName, " ")- input.Model.Subdomain = strings.ToLower(strings.Trim(input.Model.Subdomain, " "))var err errorif input.Model.Name == "" && input.Model.Email == "" {@@ -102,10 +98,6 @@ func (input *UpdateTenantSettings) IsAuthorized(user *models.User) bool {func (input *UpdateTenantSettings) Validate(services *app.Services) *validate.Result {result := validate.Success()- input.Model.Title = strings.Trim(input.Model.Title, " ")- input.Model.Invitation = strings.Trim(input.Model.Invitation, " ")- input.Model.WelcomeMessage = strings.Trim(input.Model.WelcomeMessage, " ")-if input.Model.Title == "" {result.AddFieldFailure("title", "Title is required.")}diff --git a/app/actions/tenant_test.go b/app/actions/tenant_test.goindex 5563e8e3d..11386f343 100644--- a/app/actions/tenant_test.go+++ b/app/actions/tenant_test.go@@ -66,15 +66,6 @@ func TestCreateTenant_EmptySubdomain(t *testing.T) {ExpectFailed(result, "subdomain")}-func TestCreateTenant_UpperCaseSubdomain(t *testing.T) {- RegisterTestingT(t)-- action := actions.CreateTenant{Model: &models.CreateTenant{Token: jonSnowToken, TenantName: "My Company", Subdomain: "MyCompany"}}- result := action.Validate(services)- ExpectSuccess(result)- Expect(action.Model.Subdomain).To(Equal("mycompany"))-}-func TestUpdateTenantSettings_EmptyTitle(t *testing.T) {RegisterTestingT(t)diff --git a/app/handlers/idea.go b/app/handlers/idea.goindex 2b23ec83a..6a789a38c 100644--- a/app/handlers/idea.go+++ b/app/handlers/idea.go@@ -106,13 +106,7 @@ func PostComment() web.HandlerFunc {return c.HandleValidation(result)}- ideaNumber, err := c.ParamAsInt("number")- if err != nil {- return c.Failure(err)- }-- ideas := c.Services().Ideas- _, err = ideas.AddComment(ideaNumber, input.Model.Content, c.User().ID)+ _, err := c.Services().Ideas.AddComment(input.Model.Number, input.Model.Content, c.User().ID)if err != nil {if err == app.ErrNotFound {return c.NotFound()@@ -132,13 +126,7 @@ func SetResponse() web.HandlerFunc {return c.HandleValidation(result)}- ideaNumber, err := c.ParamAsInt("number")- if err != nil {- return c.Failure(err)- }-- ideas := c.Services().Ideas- err = ideas.SetResponse(ideaNumber, input.Model.Text, c.User().ID, input.Model.Status)+ err := c.Services().Ideas.SetResponse(input.Model.Number, input.Model.Text, c.User().ID, input.Model.Status)if err != nil {if err == app.ErrNotFound {return c.NotFound()diff --git a/app/handlers/signin_test.go b/app/handlers/signin_test.goindex d156f5124..a51a2b64d 100644--- a/app/handlers/signin_test.go+++ b/app/handlers/signin_test.go@@ -45,12 +45,11 @@ func TestCallbackHandler_InvalidState(t *testing.T) {RegisterTestingT(t)server, _ := mock.NewServer()+ code, _ := server.+ WithURL("http://login.test.fider.io/oauth/callback?state=abc").+ Execute(handlers.OAuthCallback(oauth.FacebookProvider))- Expect(func() {- server.- WithURL("http://login.test.fider.io/oauth/callback?state=abc").- Execute(handlers.OAuthCallback(oauth.FacebookProvider))- }).To(Panic())+ Expect(code).To(Equal(http.StatusInternalServerError))}func TestCallbackHandler_InvalidCode(t *testing.T) {diff --git a/app/middlewares/setup.go b/app/middlewares/setup.goindex 3e7e99d66..d5e200396 100644--- a/app/middlewares/setup.go+++ b/app/middlewares/setup.go@@ -47,7 +47,7 @@ func Setup(db *dbx.Database, emailer email.Sender) web.MiddlewareFunc {if trx != nil {trx.Rollback()}- c.Error(err)+ c.Failure(err)}}()diff --git a/app/models/feedback.go b/app/models/feedback.goindex 89ea718a4..49f3d3368 100644--- a/app/models/feedback.go+++ b/app/models/feedback.go@@ -32,11 +32,13 @@ type NewIdea struct {// NewComment represents a new commenttype NewComment struct {+ Number int `route:"number"`Content string `json:"content"`}// SetResponse represents the action to update an idea responsetype SetResponse struct {+ Number int `route:"number"`Status int `json:"status"`Text string `json:"text"`}diff --git a/app/models/identity.go b/app/models/identity.goindex dc3c26c87..36c55ac58 100644--- a/app/models/identity.go+++ b/app/models/identity.go@@ -86,10 +86,10 @@ type OAuthClaims struct {type CreateTenant struct {Token string `json:"token"`Name string `json:"name"`- Email string `json:"email"`+ Email string `json:"email" format:"lower"`VerificationKey stringTenantName string `json:"tenantName"`- Subdomain string `json:"subdomain"`+ Subdomain string `json:"subdomain" format:"lower"`UserClaims *OAuthClaims}@@ -103,7 +103,7 @@ type UpdateTenantSettings struct {//SignInByEmail is the input model when user request to sign in by emailtype SignInByEmail struct {- Email string `json:"email"`+ Email string `json:"email" format:"lower"`VerificationKey string}diff --git a/app/pkg/dbx/dbx.go b/app/pkg/dbx/dbx.goindex 00afe2f3f..72c6073f7 100644--- a/app/pkg/dbx/dbx.go+++ b/app/pkg/dbx/dbx.go@@ -26,6 +26,8 @@ func New() (*Database, error) {// NewWithLogger creates a new Database instance with loggingfunc NewWithLogger(logger log.Logger) (*Database, error) {conn, err := sql.Open("postgres", env.MustGet("DATABASE_URL"))+ conn.SetMaxIdleConns(20)+ conn.SetMaxOpenConns(50)if err != nil {return nil, err}diff --git a/app/pkg/mock/server.go b/app/pkg/mock/server.goindex a343c8399..ec134366d 100644--- a/app/pkg/mock/server.go+++ b/app/pkg/mock/server.go@@ -14,7 +14,6 @@ import ("github.com/getfider/fider/app/models""github.com/getfider/fider/app/pkg/web""github.com/jmoiron/jsonq"- "github.com/julienschmidt/httprouter")// Server is a HTTP server wrapper for testing purpose@@ -31,7 +30,7 @@ func createServer(services *app.Services) *Server {request, _ := http.NewRequest("GET", "/", nil)recorder := httptest.NewRecorder()- context := engine.NewContext(recorder, request, make([]httprouter.Param, 0))+ context := engine.NewContext(recorder, request, make(web.StringMap, 0))context.SetServices(services)return &Server{diff --git a/app/pkg/web/binder.go b/app/pkg/web/binder.gonew file mode 100644index 000000000..6f03c1adb--- /dev/null+++ b/app/pkg/web/binder.go@@ -0,0 +1,73 @@+package web++import (+ "encoding/json"+ "net/http"+ "reflect"+ "strconv"+ "strings"+)++var (+ intType = reflect.TypeOf(0)+ stringType = reflect.TypeOf("")+)++//DefaultBinder is the default HTTP binder+type DefaultBinder struct {+}++//NewDefaultBinder creates a new default binder+func NewDefaultBinder() *DefaultBinder {+ return &DefaultBinder{}+}++//Bind request data to object i+func (b *DefaultBinder) Bind(target interface{}, c *Context) error {+ req := c.Request()+ if req.Method == http.MethodPost {+ if err := json.NewDecoder(req.Body).Decode(target); err != nil {+ return err+ }+ }++ targetValue := reflect.ValueOf(target).Elem()+ targetType := targetValue.Type()+ for i := 0; i < targetValue.NumField(); i++ {+ b.bindRoute(i, targetValue, targetType, c.params)+ b.format(i, targetValue, targetType)+ }+ return nil+}++func (b *DefaultBinder) bindRoute(idx int, target reflect.Value, targetType reflect.Type, params StringMap) error {+ name := targetType.Field(idx).Tag.Get("route")+ if name != "" {+ field := target.Field(idx)+ fieldType := field.Type()+ if fieldType == intType {+ value, _ := strconv.ParseInt(params[name], 10, 64)+ field.SetInt(value)+ } else if fieldType == stringType {+ field.SetString(params[name])+ }+ }++ return nil+}++func (b *DefaultBinder) format(idx int, target reflect.Value, targetType reflect.Type) {+ field := target.Field(idx)++ if field.Type() != stringType {+ return+ }++ format := targetType.Field(idx).Tag.Get("format")+ str := field.Interface().(string)+ str = strings.TrimSpace(str)+ if format == "lower" {+ str = strings.ToLower(str)+ }+ field.SetString(str)+}diff --git a/app/pkg/web/binder_test.go b/app/pkg/web/binder_test.gonew file mode 100644index 000000000..b8d451360--- /dev/null+++ b/app/pkg/web/binder_test.go@@ -0,0 +1,66 @@+package web_test++import (+ "net/http/httptest"+ "strings"+ "testing"++ "github.com/getfider/fider/app/pkg/web"+ . "github.com/onsi/gomega"+)++var binder = web.NewDefaultBinder()++func newGetContext(params web.StringMap) *web.Context {+ e := web.New(nil)+ res := httptest.NewRecorder()+ req := httptest.NewRequest("GET", "/", nil)+ ctx := e.NewContext(res, req, params)+ return &ctx+}++func newPostContext(params web.StringMap, body string) *web.Context {+ e := web.New(nil)+ res := httptest.NewRecorder()+ req := httptest.NewRequest("POST", "/", strings.NewReader(body))+ ctx := e.NewContext(res, req, params)+ return &ctx+}++func TestDefaultBinder_FromParams(t *testing.T) {+ type updateUser struct {+ Number int `route:"number"`+ Slug string `route:"slug"`+ Name string `json:"name"`+ }++ RegisterTestingT(t)+ params := make(web.StringMap, 0)+ params["number"] = "2"+ params["slug"] = "jon-snow"+ ctx := newPostContext(params, `{ "name": "Jon Snow" }`)+ u := new(updateUser)+ err := binder.Bind(u, ctx)+ Expect(err).To(BeNil())+ Expect(u.Number).To(Equal(2))+ Expect(u.Slug).To(Equal("jon-snow"))+ Expect(u.Name).To(Equal("Jon Snow"))+}++func TestDefaultBinder_TrimSpaces(t *testing.T) {+ RegisterTestingT(t)++ type user struct {+ Name string `json:"name"`+ Email string `json:"email" format:"lower"`+ Other string+ }++ ctx := newPostContext(make(web.StringMap, 0), `{ "name": " Jon Snow ", "email": " [email protected] " }`)+ u := new(user)+ err := binder.Bind(u, ctx)+ Expect(err).To(BeNil())+ Expect(u.Name).To(Equal("Jon Snow"))+ Expect(u.Email).To(Equal("[email protected]"))+ Expect(u.Other).To(Equal(""))+}diff --git a/app/pkg/web/context.go b/app/pkg/web/context.goindex 002352164..e5edb1dd7 100644--- a/app/pkg/web/context.go+++ b/app/pkg/web/context.go@@ -75,7 +75,7 @@ func (ctx *Context) SetTenant(tenant *models.Tenant) {//BindTo context values into given modelfunc (ctx *Context) BindTo(i actions.Actionable) *validate.Result {- err := ctx.Bind(i.Initialize())+ err := ctx.engine.binder.Bind(i.Initialize(), ctx)if err != nil {return validate.Error(err)}@@ -107,7 +107,8 @@ func (ctx *Context) NotFound() error {//Failure returns a 500 pagefunc (ctx *Context) Failure(err error) error {- panic(err)+ ctx.Logger().Error(err)+ return ctx.Render(http.StatusInternalServerError, "500.html", Map{})}//HandleValidation handles given validation result property to return 400 or 500@@ -146,12 +147,6 @@ func (ctx *Context) Page(dict Map) error {return ctx.Render(http.StatusOK, "index.html", dict)}-// Error logs and returns a 500 response-func (ctx *Context) Error(err error) error {- ctx.Logger().Error(err)- return ctx.Render(http.StatusInternalServerError, "500.html", Map{})-}-// Render renders a template with data and sends a text/html response with statusfunc (ctx *Context) Render(code int, template string, data Map) error {buf := new(bytes.Buffer)@@ -374,18 +369,6 @@ func (ctx *Context) Blob(code int, contentType string, b []byte) (err error) {return}-// Bind binds the request body into provided type `i`. The default binder-// does it based on Content-Type header.-func (ctx *Context) Bind(i interface{}) error {- req := ctx.Request()- if req.Method == "POST" {- if err := json.NewDecoder(req.Body).Decode(i); err != nil {- return err- }- }- return nil-}-// Cookie returns the named cookie provided in the request.func (ctx *Context) Cookie(name string) (*http.Cookie, error) {return ctx.req.Cookie(name)diff --git a/app/pkg/web/engine.go b/app/pkg/web/engine.goindex 7319a9971..1cedb7475 100644--- a/app/pkg/web/engine.go+++ b/app/pkg/web/engine.go@@ -22,6 +22,7 @@ type Engine struct {mux *httprouter.Routerlogger log.Loggerrenderer *Renderer+ binder *DefaultBinder}//New creates a new Engine@@ -31,6 +32,7 @@ func New(settings *models.AppSettings) *Engine {mux: httprouter.New(),logger: logger,renderer: NewRenderer(settings, logger),+ binder: NewDefaultBinder(),}router.mux.NotFound = func(res http.ResponseWriter, req *http.Request) {@@ -60,11 +62,7 @@ func (e *Engine) Start(address string) {}//NewContext creates and return a new context-func (e *Engine) NewContext(res http.ResponseWriter, req *http.Request, ps httprouter.Params) Context {- params := make(StringMap, 0)- for _, p := range ps {- params[p.Key] = p.Value- }+func (e *Engine) NewContext(res http.ResponseWriter, req *http.Request, params StringMap) Context {return Context{engine: e,res: res,@@ -124,8 +122,14 @@ func (g *Group) handler(handler HandlerFunc) httprouter.Handle {next = g.middlewares[i](next)}var h = func(res http.ResponseWriter, req *http.Request, ps httprouter.Params) {- ctx := g.engine.NewContext(res, req, ps)- next(ctx)+ params := make(StringMap, 0)+ for _, p := range ps {+ params[p.Key] = p.Value+ }+ ctx := g.engine.NewContext(res, req, params)+ if err := next(ctx); err != nil {+ ctx.Failure(err)+ }}return h}