Open platform to collect and prioritize feedback
enhancement: Add Session to Web Context (#632)
Guilherme Oenningb079c0ee2b59
diff --git a/app/cmd/routes.go b/app/cmd/routes.goindex ebd3f20e2..bd56fc597 100644--- a/app/cmd/routes.go+++ b/app/cmd/routes.go@@ -27,10 +27,6 @@ func routes(r *web.Engine) *web.Engine {r.Use(middlewares.Secure())r.Use(middlewares.Compress())- r.Get("/-/health", handlers.Health())- r.Get("/robots.txt", handlers.RobotsTXT())- r.Post("/_api/log-error", handlers.LogError())-assets := r.Group(){assets.Use(middlewares.CORS())@@ -39,6 +35,12 @@ func routes(r *web.Engine) *web.Engine {assets.Static("/assets/*filepath", "dist")}+ r.Use(middlewares.Session())++ r.Get("/-/health", handlers.Health())+ r.Get("/robots.txt", handlers.RobotsTXT())+ r.Post("/_api/log-error", handlers.LogError())+r.Use(middlewares.WebSetup())r.Use(middlewares.Tenant())r.Use(middlewares.User())diff --git a/app/middlewares/session.go b/app/middlewares/session.gonew file mode 100644index 000000000..0225a74f6--- /dev/null+++ b/app/middlewares/session.go@@ -0,0 +1,23 @@+package middlewares++import (+ "time"++ "github.com/getfider/fider/app/pkg/rand"+ "github.com/getfider/fider/app/pkg/web"+)++// Session starts a new Session if an Session ID is not yet set+func Session() web.MiddlewareFunc {+ return func(next web.HandlerFunc) web.HandlerFunc {+ return func(c web.Context) error {+ cookie, err := c.Request.Cookie(web.CookieSessionName)+ if err != nil {+ nextYear := time.Now().Add(365 * 24 * time.Hour)+ cookie = c.AddCookie(web.CookieSessionName, rand.String(48), nextYear)+ }+ c.SetSessionID(cookie.Value)+ return next(c)+ }+ }+}diff --git a/app/middlewares/session_test.go b/app/middlewares/session_test.gonew file mode 100644index 000000000..814be6bf8--- /dev/null+++ b/app/middlewares/session_test.go@@ -0,0 +1,49 @@+package middlewares_test++import (+ "net/http"+ "testing"+ "time"++ "github.com/getfider/fider/app/middlewares"+ . "github.com/getfider/fider/app/pkg/assert"+ "github.com/getfider/fider/app/pkg/mock"+ "github.com/getfider/fider/app/pkg/web"+)++func TestSession_New(t *testing.T) {+ RegisterT(t)++ server, _ := mock.NewServer()+ server.Use(middlewares.Session())++ var sessionID string+ status, response := server.Execute(func(c web.Context) error {+ sessionID = c.SessionID()+ return c.NoContent(http.StatusOK)+ })++ Expect(status).Equals(http.StatusOK)+ cookie := web.ParseCookie(response.Header().Get("Set-Cookie"))+ Expect(cookie.Name).Equals(web.CookieSessionName)+ Expect(cookie.Value).Equals(sessionID)+ Expect(cookie.HttpOnly).IsTrue()+ Expect(cookie.Path).Equals("/")+ Expect(cookie.Expires).TemporarilySimilar(time.Now().Add(365*24*time.Hour), 5*time.Second)+}++func TestSession_ExistingSession(t *testing.T) {+ RegisterT(t)++ server, _ := mock.NewServer()+ server.Use(middlewares.Session())++ status, response := server.+ AddCookie(web.CookieSessionName, "MY_SESSION_VALUE").+ Execute(func(c web.Context) error {+ return c.NoContent(http.StatusOK)+ })++ Expect(status).Equals(http.StatusOK)+ Expect(response.Header().Get("Set-Cookie")).Equals("")+}diff --git a/app/middlewares/setup_test.go b/app/middlewares/setup_test.goindex f03cdba34..a6738bd79 100644--- a/app/middlewares/setup_test.go+++ b/app/middlewares/setup_test.go@@ -82,7 +82,7 @@ func TestWebSetup_QueueTask_OnSuccess(t *testing.T) {func TestWorkerSetup(t *testing.T) {RegisterT(t)- c := worker.NewContext("0", "Any Task", dbx.New(), noop.NewLogger())+ c := worker.NewContext("0", worker.Task{Name: "Any Task"}, dbx.New(), noop.NewLogger())mw := middlewares.WorkerSetup()err := mw(func(c *worker.Context) error {Expect(c.Services()).IsNotNil()@@ -94,7 +94,7 @@ func TestWorkerSetup(t *testing.T) {func TestWorkerSetup_Failure(t *testing.T) {RegisterT(t)- c := worker.NewContext("0", "Any Task", dbx.New(), noop.NewLogger())+ c := worker.NewContext("0", worker.Task{Name: "Any Task"}, dbx.New(), noop.NewLogger())mw := middlewares.WorkerSetup()err := mw(func(c *worker.Context) error {Expect(c.Services()).IsNotNil()diff --git a/app/pkg/email/email_test.go b/app/pkg/email/email_test.goindex 77086fc8c..1c39b8339 100644--- a/app/pkg/email/email_test.go+++ b/app/pkg/email/email_test.go@@ -14,7 +14,7 @@ import (func TestRenderMessage(t *testing.T) {RegisterT(t)- ctx := worker.NewContext("ID-1", "TaskName", nil, noop.NewLogger())+ ctx := worker.NewContext("ID-1", worker.Task{Name: "TaskName"}, nil, noop.NewLogger())message := email.RenderMessage(ctx, "echo_test", email.Params{"name": "Fider",})diff --git a/app/pkg/email/mailgun/mailgun_test.go b/app/pkg/email/mailgun/mailgun_test.goindex d792fd01a..3660cb207 100644--- a/app/pkg/email/mailgun/mailgun_test.go+++ b/app/pkg/email/mailgun/mailgun_test.go@@ -24,7 +24,7 @@ var sender = mailgun.NewSender(logger, client, "mydomain.com", "mys3cr3tk3y")var tenant = &models.Tenant{Subdomain: "got",}-var ctx = worker.NewContext("ID-1", "TaskName", nil, logger)+var ctx = worker.NewContext("ID-1", worker.Task{Name: "TaskName"}, nil, logger)func init() {ctx.SetTenant(tenant)diff --git a/app/pkg/email/smtp/smtp_test.go b/app/pkg/email/smtp/smtp_test.goindex 2d6f383fd..005b570c1 100644--- a/app/pkg/email/smtp/smtp_test.go+++ b/app/pkg/email/smtp/smtp_test.go@@ -28,7 +28,7 @@ var tenant = &models.Tenant{Subdomain: "got",}-var ctx = worker.NewContext("ID-1", "TaskName", nil, logger)+var ctx = worker.NewContext("ID-1", worker.Task{Name: "TaskName"}, nil, logger)var requests = make([]request, 0)diff --git a/app/pkg/log/log.go b/app/pkg/log/log.goindex 03b5dce61..67a175de2 100644--- a/app/pkg/log/log.go+++ b/app/pkg/log/log.go@@ -29,6 +29,8 @@ type Logger interface {}const (+ // PropertyKeySessionID is the session id of current logger+ PropertyKeySessionID = "SessionID"// PropertyKeyContextID is the context id of current loggerPropertyKeyContextID = "ContextID"// PropertyKeyUserID is the user id of current loggerdiff --git a/app/pkg/mock/worker.go b/app/pkg/mock/worker.goindex 273a4b3e7..c12ac74b4 100644--- a/app/pkg/mock/worker.go+++ b/app/pkg/mock/worker.go@@ -41,7 +41,7 @@ func (w *Worker) WithBaseURL(baseURL string) *Worker {// Execute given task with current contextfunc (w *Worker) Execute(task worker.Task) error {- context := worker.NewContext("0", task.Name, nil, noop.NewLogger())+ context := worker.NewContext("0", task, nil, noop.NewLogger())context.SetServices(w.services)context.SetUser(w.user)context.SetTenant(w.tenant)diff --git a/app/pkg/web/context.go b/app/pkg/web/context.goindex b6df17164..269a7ee0b 100644--- a/app/pkg/web/context.go+++ b/app/pkg/web/context.go@@ -47,6 +47,9 @@ var (UTF8JSONContentType = JSONContentType + "; charset=utf-8")+// CookieSessionName is the name of the cookie that holds the session ID+const CookieSessionName = "user_session_id"+// CookieAuthName is the name of the cookie that holds the Authentication Tokenconst CookieAuthName = "auth"@@ -65,14 +68,15 @@ var (//Context shared between http pipelinetype Context struct {- id string- Response http.ResponseWriter- Request Request- engine *Engine- logger log.Logger- params StringMap- store Map- worker worker.Worker+ id string+ sessionID string+ Response http.ResponseWriter+ Request Request+ engine *Engine+ logger log.Logger+ params StringMap+ store Map+ worker worker.Worker}//Engine returns main HTTP engine@@ -80,6 +84,17 @@ func (ctx *Context) Engine() *Engine {return ctx.engine}+//SessionID returns the current session ID+func (ctx *Context) SessionID() string {+ return ctx.sessionID+}++//SetSessionID sets the session ID on current context+func (ctx *Context) SetSessionID(id string) {+ ctx.sessionID = id+ ctx.logger.SetProperty(log.PropertyKeySessionID, id)+}+//ContextID returns the unique id for this contextfunc (ctx *Context) ContextID() string {return ctx.id@@ -130,8 +145,9 @@ func (ctx *Context) Enqueue(task worker.Task) {}ctx.Set(tasksContextKey, append(tasks, worker.Task{- Name: task.Name,- Job: wrap(ctx),+ OriginSessionID: ctx.SessionID(),+ Name: task.Name,+ Job: wrap(ctx),}))}@@ -337,15 +353,17 @@ func (ctx *Context) Services() *app.Services {}//AddCookie adds a cookie-func (ctx *Context) AddCookie(name, value string, expires time.Time) {- http.SetCookie(ctx.Response, &http.Cookie{+func (ctx *Context) AddCookie(name, value string, expires time.Time) *http.Cookie {+ cookie := &http.Cookie{Name: name,Value: value,HttpOnly: true,Path: "/",Expires: expires,Secure: ctx.Request.IsSecure,- })+ }+ http.SetCookie(ctx.Response, cookie)+ return cookie}//RemoveCookie removes a cookiediff --git a/app/pkg/worker/context.go b/app/pkg/worker/context.goindex 55e3b7f53..0124108ff 100644--- a/app/pkg/worker/context.go+++ b/app/pkg/worker/context.go@@ -23,14 +23,18 @@ type Context struct {}//NewContext creates a new context-func NewContext(workerID, taskName string, db *dbx.Database, logger log.Logger) *Context {+func NewContext(workerID string, task Task, db *dbx.Database, logger log.Logger) *Context {ctxLogger := logger.New()contextID := rand.String(32)+ctxLogger.SetProperty(log.PropertyKeyContextID, contextID)+ if task.OriginSessionID != "" {+ ctxLogger.SetProperty(log.PropertyKeySessionID, task.OriginSessionID)+ }return &Context{workerID: workerID,- taskName: taskName,+ taskName: task.Name,db: db,logger: ctxLogger,}diff --git a/app/pkg/worker/worker.go b/app/pkg/worker/worker.goindex 1d7f5609b..616e3ebb6 100644--- a/app/pkg/worker/worker.go+++ b/app/pkg/worker/worker.go@@ -18,8 +18,9 @@ type Job func(c *Context) error//Task represents the Name and Job to be run on backgroundtype Task struct {- Name string- Job Job+ OriginSessionID string+ Name string+ Job Job}//Worker is a process that runs tasks@@ -57,13 +58,12 @@ func New(db *dbx.Database, logger log.Logger) *BackgroundWorker {}//Run initializes the worker loop-func (w *BackgroundWorker) Run(id string) {+func (w *BackgroundWorker) Run(workerID string) {w.logger.Infof("Starting worker @{WorkerID:magenta}.", log.Props{- "WorkerID": id,+ "WorkerID": workerID,})for task := range w.queue {-- c := NewContext(id, task.Name, w.db, w.logger)+ c := NewContext(workerID, task, w.db, w.logger)w.middleware(task.Job)(c)w.Lock()diff --git a/app/pkg/worker/worker_test.go b/app/pkg/worker/worker_test.goindex 7a80e7880..abbbd9ffc 100644--- a/app/pkg/worker/worker_test.go+++ b/app/pkg/worker/worker_test.go@@ -7,6 +7,7 @@ import ("time""github.com/getfider/fider/app/pkg/log/noop"+ "github.com/getfider/fider/app/pkg/rand""github.com/getfider/fider/app/pkg/worker"@@ -14,7 +15,8 @@ import ()var dummyTask = worker.Task{- Name: "Do Something",+ OriginSessionID: rand.String(32),+ Name: "Do Something",Job: func(c *worker.Context) error {return nil},