Set tutorial cookie by reading x_tutorial query in middleware

Author: carmenlau

pkg/auth/deps.go

@@ -55,6 +55,7 @@ var DependencySet = wire.NewSet(
 
 	wire.Bind(new(webapp.GraphService), new(*interaction.Service)),
 	wire.Bind(new(webapp.CookieManager), new(*httputil.CookieManager)),
+	wire.Bind(new(webapp.TutorialMiddlewareTutorialCookie), new(*httputil.TutorialCookie)),
 	wire.Bind(new(handlerwebapp.CookieManager), new(*httputil.CookieManager)),
 	wire.Bind(new(oauthhandler.CookieManager), new(*httputil.CookieManager)),
 	wire.Bind(new(handlerwebapp.TutorialCookie), new(*httputil.TutorialCookie)),

pkg/auth/routes.go

@@ -83,6 +83,7 @@ func NewRouter(p *deps.RootProvider, configSource *configsource.ConfigSource) *h
 		p.Middleware(newWebAppUILocalesMiddleware),
 		p.Middleware(newWebAppWeChatRedirectURIMiddleware),
 		p.Middleware(newWebAppClientIDMiddleware),
+		p.Middleware(newTutorialMiddleware),
 	)
 	webappSSOCallbackChain := httproute.Chain(
 		webappChain,

pkg/auth/webapp/deps.go

@@ -26,6 +26,7 @@ var DependencySet = wire.NewSet(
 	wire.Struct(new(VisitorIDMiddleware), "*"),
 	wire.Struct(new(SettingsSubRoutesMiddleware), "*"),
 	wire.Struct(new(SuccessPageMiddleware), "*"),
+	wire.Struct(new(TutorialMiddleware), "*"),
 
 	NewPublicOriginMiddlewareLogger,
 	wire.Struct(new(PublicOriginMiddleware), "*"),

pkg/auth/webapp/tutorial_middleware.go

@@ -0,0 +1,28 @@
+package webapp
+
+import (
+	"net/http"
+)
+
+//go:generate mockgen -source=tutorial_middleware.go -destination=tutorial_middleware_mock_test.go -package webapp
+
+type TutorialMiddlewareTutorialCookie interface {
+	SetAll(rw http.ResponseWriter)
+}
+
+type TutorialMiddleware struct {
+	TutorialCookie TutorialMiddlewareTutorialCookie
+}
+
+func (m *TutorialMiddleware) Handle(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		q := r.URL.Query()
+		if q.Get("x_tutorial") == "true" {
+			q.Del("x_tutorial")
+			r.URL.RawQuery = q.Encode()
+			m.TutorialCookie.SetAll(w)
+		}
+
+		next.ServeHTTP(w, r)
+	})
+}

pkg/auth/webapp/tutorial_middleware_mock_test.go

@@ -0,0 +1,45 @@
+package webapp
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	. "github.com/smartystreets/goconvey/convey"
+)
+
+func TestTutorialMiddleware(t *testing.T) {
+	Convey("TutorialMiddleware", t, func() {
+		ctrl := gomock.NewController(t)
+		defer ctrl.Finish()
+
+		tutorialCookie := NewMockTutorialMiddlewareTutorialCookie(ctrl)
+		middleware := TutorialMiddleware{
+			TutorialCookie: tutorialCookie,
+		}
+
+		makeHandler := func() http.Handler {
+			dummy := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {})
+			h := middleware.Handle(dummy)
+			return h
+		}
+
+		Convey("x_tutorial", func() {
+			test := func(requestQuery string, resultQuery string, setCookie bool) {
+				w := httptest.NewRecorder()
+				r, _ := http.NewRequest("GET", requestQuery, nil)
+				if setCookie {
+					tutorialCookie.EXPECT().SetAll(w)
+				}
+				makeHandler().ServeHTTP(w, r)
+				So(r.URL.RawQuery, ShouldEqual, resultQuery)
+			}
+
+			test("/", "", false)
+			test("/?abc=test", "abc=test", false)
+			test("/?x_tutorial=true&abc=test", "abc=test", true)
+			test("/?abc=test&x_tutorial=true&state=test", "abc=test&state=test", true)
+		})
+	})
+}

pkg/auth/webapp/tutorial_middleware_test.go

@@ -143,3 +143,10 @@ func newAPIRRequireAuthenticatedMiddlewareMiddleware(p *deps.RequestProvider) ht
 		wire.Bind(new(httproute.Middleware), new(*api.RequireAuthenticatedMiddleware)),
 	))
 }
+
+func newTutorialMiddleware(p *deps.RequestProvider) httproute.Middleware {
+	panic(wire.Build(
+		DependencySet,
+		wire.Bind(new(httproute.Middleware), new(*webapp.TutorialMiddleware)),
+	))
+}