Skip to content

armgit / fider

Public Imported from GitHub
0

Open platform to collect and prioritize feedback

refactor: organize tenant middleware into Get + Require (#456)

Guilherme Oenninge5db7e4821b9
diff --git a/app/cmd/routes.go b/app/cmd/routes.go
index 5d91f6eae..03e69c234 100644
--- a/app/cmd/routes.go
+++ b/app/cmd/routes.go
@@ -25,6 +25,7 @@ func routes(r *web.Engine) *web.Engine {
}
r.Use(middlewares.WebSetup())
+ r.Use(middlewares.Tenant())
noTenant := r.Group()
{
@@ -40,14 +41,14 @@ func routes(r *web.Engine) *web.Engine {
noTenant.Get("/oauth/:provider/callback", handlers.OAuthCallback())
}
- r.Use(middlewares.Tenant())
+ r.Use(middlewares.RequireTenant())
- avatar := r.Group()
+ tenantAssets := r.Group()
{
- avatar.Use(middlewares.ClientCache(72 * time.Hour))
- avatar.Get("/avatars/:size/:id/:name", handlers.Avatar())
- avatar.Get("/logo/:size/:id", handlers.Logo())
- avatar.Get("/custom/:md5.css", func(c web.Context) error {
+ tenantAssets.Use(middlewares.ClientCache(72 * time.Hour))
+ tenantAssets.Get("/avatars/:size/:id/:name", handlers.Avatar())
+ tenantAssets.Get("/logo/:size/:id", handlers.Logo())
+ tenantAssets.Get("/custom/:md5.css", func(c web.Context) error {
return c.Blob(http.StatusOK, "text/css", []byte(c.Tenant().CustomCSS))
})
}
diff --git a/app/middlewares/domain.go b/app/middlewares/domain.go
index cb263866d..38e5321ec 100644
--- a/app/middlewares/domain.go
+++ b/app/middlewares/domain.go
@@ -9,7 +9,6 @@ import (
"github.com/getfider/fider/app/pkg/env"
"github.com/getfider/fider/app/pkg/errors"
"github.com/getfider/fider/app/pkg/jwt"
- "github.com/getfider/fider/app/pkg/log"
"github.com/getfider/fider/app/pkg/web"
"github.com/getfider/fider/app/pkg/web/util"
)
@@ -27,14 +26,14 @@ func SingleTenant() web.MiddlewareFunc {
return func(next web.HandlerFunc) web.HandlerFunc {
return func(c web.Context) error {
tenant, err := c.Services().Tenants.First()
- if err != nil {
- if errors.Cause(err) == app.ErrNotFound {
- return c.Redirect("/signup")
- }
+ if err != nil && errors.Cause(err) != app.ErrNotFound {
return c.Failure(err)
}
- c.SetTenant(tenant)
+ if tenant != nil {
+ c.SetTenant(tenant)
+ }
+
return next(c)
}
}
@@ -54,7 +53,11 @@ func MultiTenant() web.MiddlewareFunc {
}
tenant, err := c.Services().Tenants.GetByDomain(hostname)
- if err == nil {
+ if err != nil && errors.Cause(err) != app.ErrNotFound {
+ return c.Failure(err)
+ }
+
+ if tenant != nil {
c.SetTenant(tenant)
if tenant.CNAME != "" && !c.IsAjax() {
@@ -64,17 +67,24 @@ func MultiTenant() web.MiddlewareFunc {
c.Response.Header().Set("Link", fmt.Sprintf("<%s>; rel=\"canonical\"", link))
}
}
- return next(c)
}
- if errors.Cause(err) == app.ErrNotFound {
- c.Logger().Debugf("Tenant not found for '@{Hostname}'.", log.Props{
- "Hostname": hostname,
- })
+ return next(c)
+ }
+ }
+}
+
+// RequireTenant returns 404 if tenant is not available
+func RequireTenant() web.MiddlewareFunc {
+ return func(next web.HandlerFunc) web.HandlerFunc {
+ return func(c web.Context) error {
+ if c.Tenant() == nil {
+ if env.IsSingleHostMode() {
+ return c.Redirect("/signup")
+ }
return c.NotFound()
}
-
- return c.Failure(err)
+ return next(c)
}
}
}
diff --git a/app/middlewares/domain_test.go b/app/middlewares/domain_test.go
index 3e56197d1..3fd19dd26 100644
--- a/app/middlewares/domain_test.go
+++ b/app/middlewares/domain_test.go
@@ -1,6 +1,7 @@
package middlewares_test
import (
+ "errors"
"net/http"
"testing"
"time"
@@ -60,10 +61,13 @@ func TestMultiTenant_SubSubDomain(t *testing.T) {
server.Use(middlewares.MultiTenant())
status, _ := server.WithURL("http://demo.demo.test.fider.io").Execute(func(c web.Context) error {
- return c.String(http.StatusOK, c.Tenant().Name)
+ if c.Tenant() == nil {
+ return c.Ok(web.Map{})
+ }
+ return c.Failure(errors.New("should not have found tenant"))
})
- Expect(status).Equals(http.StatusNotFound)
+ Expect(status).Equals(http.StatusOK)
}
func TestMultiTenant_UnknownDomain(t *testing.T) {
@@ -73,10 +77,13 @@ func TestMultiTenant_UnknownDomain(t *testing.T) {
server.Use(middlewares.MultiTenant())
status, _ := server.WithURL("http://somedomain.com").Execute(func(c web.Context) error {
- return c.String(http.StatusOK, c.Tenant().Name)
+ if c.Tenant() == nil {
+ return c.Ok(web.Map{})
+ }
+ return c.Failure(errors.New("should not have found tenant"))
})
- Expect(status).Equals(http.StatusNotFound)
+ Expect(status).Equals(http.StatusOK)
}
func TestMultiTenant_CanonicalHeader(t *testing.T) {
@@ -138,18 +145,19 @@ func TestMultiTenant_CanonicalHeader(t *testing.T) {
}
-func TestSingleTenant_NoTenants_RedirectToSignUp(t *testing.T) {
+func TestSingleTenant_NoTenants(t *testing.T) {
RegisterT(t)
-
server, _ := mock.NewSingleTenantServer()
server.Use(middlewares.SingleTenant())
- status, response := server.WithURL("http://somedomain.com").Execute(func(c web.Context) error {
- return c.NoContent(http.StatusOK)
+ status, _ := server.WithURL("http://somedomain.com").Execute(func(c web.Context) error {
+ if c.Tenant() == nil {
+ return c.Ok(web.Map{})
+ }
+ return c.Failure(errors.New("should not have found tenant"))
})
- Expect(status).Equals(http.StatusTemporaryRedirect)
- Expect(response.HeaderMap.Get("Location")).Equals("/signup")
+ Expect(status).Equals(http.StatusOK)
}
func TestSingleTenant_WithTenants_ShouldSetFirstToContext(t *testing.T) {
@@ -242,6 +250,61 @@ func TestCheckTenantPrivacy_NotPrivate_Unauthenticated(t *testing.T) {
Expect(status).Equals(http.StatusOK)
}
+func TestRequireTenant_MultiHostMode_NoTenants_404(t *testing.T) {
+ RegisterT(t)
+ server, _ := mock.NewServer()
+ server.Use(middlewares.MultiTenant())
+ server.Use(middlewares.RequireTenant())
+
+ status, _ := server.WithURL("http://somedomain.com").Execute(func(c web.Context) error {
+ return c.NoContent(http.StatusOK)
+ })
+
+ Expect(status).Equals(http.StatusNotFound)
+}
+
+func TestRequireTenant_MultiHostMode_ValidTenant(t *testing.T) {
+ RegisterT(t)
+ server, _ := mock.NewServer()
+ server.Use(middlewares.MultiTenant())
+ server.Use(middlewares.RequireTenant())
+
+ status, response := server.WithURL("http://avengers.test.fider.io").Execute(func(c web.Context) error {
+ return c.String(http.StatusOK, c.Tenant().Name)
+ })
+
+ Expect(status).Equals(http.StatusOK)
+ Expect(response.Body.String()).Equals("Avengers")
+}
+
+func TestRequireTenant_SingleHostMode_NoTenants_RedirectToSignUp(t *testing.T) {
+ RegisterT(t)
+ server, _ := mock.NewSingleTenantServer()
+ server.Use(middlewares.SingleTenant())
+ server.Use(middlewares.RequireTenant())
+
+ status, response := server.WithURL("http://somedomain.com").Execute(func(c web.Context) error {
+ return c.NoContent(http.StatusOK)
+ })
+
+ Expect(status).Equals(http.StatusTemporaryRedirect)
+ Expect(response.HeaderMap.Get("Location")).Equals("/signup")
+}
+
+func TestRequireTenant_SingleHostMode_ValidTenant(t *testing.T) {
+ RegisterT(t)
+ server, _ := mock.NewServer()
+ server.Use(middlewares.SingleTenant())
+ server.Use(middlewares.RequireTenant())
+
+ status, response := server.WithURL("http://demo.test.fider.io").Execute(func(c web.Context) error {
+ return c.String(http.StatusOK, c.Tenant().Name)
+ })
+
+ Expect(status).Equals(http.StatusOK)
+ Expect(response.Body.String()).Equals("Demonstration")
+}
+
func TestUser_NoCookie(t *testing.T) {
RegisterT(t)
diff --git a/app/pkg/mock/server.go b/app/pkg/mock/server.go
index f0a9d77b7..123c9bdf4 100644
--- a/app/pkg/mock/server.go
+++ b/app/pkg/mock/server.go
@@ -8,7 +8,6 @@ import (
"net/url"
"github.com/getfider/fider/app"
- "github.com/getfider/fider/app/middlewares"
"github.com/getfider/fider/app/models"
"github.com/getfider/fider/app/pkg/jsonq"
"github.com/getfider/fider/app/pkg/web"
@@ -19,7 +18,7 @@ type Server struct {
engine *web.Engine
context web.Context
recorder *httptest.ResponseRecorder
- middleware web.MiddlewareFunc
+ middleware []web.MiddlewareFunc
}
func createServer(services *app.Services) *Server {
@@ -35,7 +34,7 @@ func createServer(services *app.Services) *Server {
engine: engine,
recorder: recorder,
context: context,
- middleware: middlewares.Noop(),
+ middleware: []web.MiddlewareFunc{},
}
}
@@ -46,7 +45,7 @@ func (s *Server) Engine() *web.Engine {
// Use adds a new middleware to pipeline
func (s *Server) Use(middleware web.MiddlewareFunc) {
- s.middleware = middleware
+ s.middleware = append(s.middleware, middleware)
}
// OnTenant set current context tenant
@@ -90,7 +89,12 @@ func (s *Server) WithURL(fullURL string) *Server {
// Execute given handler and return response
func (s *Server) Execute(handler web.HandlerFunc) (int, *httptest.ResponseRecorder) {
- if err := s.middleware(handler)(s.context); err != nil {
+ next := handler
+ for i := len(s.middleware) - 1; i >= 0; i-- {
+ next = s.middleware[i](next)
+ }
+
+ if err := next(s.context); err != nil {
s.context.Failure(err)
}
@@ -110,11 +114,7 @@ func (s *Server) ExecutePost(handler web.HandlerFunc, body string) (int, *httpte
s.context.Request.ContentLength = int64(len(body))
s.context.Request.SetHeader("Content-Type", web.UTF8JSONContentType)
- if err := s.middleware(handler)(s.context); err != nil {
- s.context.Failure(err)
- }
-
- return s.recorder.Code, s.recorder
+ return s.Execute(handler)
}
// ExecutePostAsJSON executes given handler as POST and return json response