simplify router structure

Author: Gitznik

cmd/server/main.go

@@ -10,15 +10,11 @@ import (
 	"time"
 
 	"github.com/getsentry/sentry-go"
-	sentrygin "github.com/getsentry/sentry-go/gin"
 
-	"github.com/gin-gonic/gin"
 	"github.com/gitznik/robswebhub/internal/auth"
 	"github.com/gitznik/robswebhub/internal/config"
 	"github.com/gitznik/robswebhub/internal/database"
-	"github.com/gitznik/robswebhub/internal/handlers"
-	"github.com/gitznik/robswebhub/internal/middleware"
-	"github.com/gitznik/robswebhub/internal/sessions"
+	"github.com/gitznik/robswebhub/internal/router"
 )
 
 func main() {
@@ -66,7 +62,7 @@ func main() {
 	if err != nil {
 		log.Fatalf("Could not setup authenticator: %v", err)
 	}
-	router := setupRouter(cfg, queries, auth)
+	router := router.SetupRouter(cfg, queries, auth)
 
 	// Create HTTP server
 	srv := &http.Server{
@@ -97,58 +93,3 @@ func main() {
 
 	log.Print("Server exiting")
 }
-
-func setupRouter(cfg *config.Config, queries *database.Queries, authenticator *auth.Authenticator) *gin.Engine {
-	// Set Gin mode based on environment
-	if os.Getenv("APP_ENVIRONMENT") == "production" {
-		gin.SetMode(gin.ReleaseMode)
-	}
-
-	router := gin.Default()
-	router.Use(sentrygin.New(sentrygin.Options{Repanic: true}))
-	router.Use(middleware.ErrorHandler)
-
-	sessionMiddleware, err := sessions.SetupSessionMiddleware(cfg.Auth.CookieAuthKey, cfg.Auth.CookieEncryptionKey)
-	if err != nil {
-		log.Fatalf("Could not attach session information: %v", err)
-	}
-	router.Use(sessionMiddleware)
-	router.Use(middleware.LoginStatus)
-
-	// Serve static files
-	router.Static("/static", "./static")
-	router.Static("/images", "./static/images")
-	router.StaticFile("/favicon.ico", "./static/images/favicon.ico")
-
-	// Create handlers
-	h := handlers.New(queries, cfg)
-
-	// Routes
-	router.GET("/", h.Home)
-	router.HEAD("/", h.HomeHead)
-	router.GET("/about", h.About)
-
-	// Scores routes
-	scores := router.Group("/scores")
-	{
-		scores.GET("", h.ScoresIndex)
-		scores.POST("/single", h.ScoresSingle)
-		scores.POST("/batch", h.ScoresBatch)
-		scores.GET("/single-form", h.SingleScoreForm)
-		scores.GET("/batch-form", h.BatchScoreForm)
-		scores.GET("/chart/:id", h.ScoresChart)
-	}
-
-	router.GET("/login", h.MakeLogin(authenticator))
-	router.GET("/logout", h.Logout)
-	router.GET("/callback", h.MakeCallback(authenticator))
-	gamekeeper := router.Group("/gamekeeper")
-	gamekeeper.Use(middleware.IsAuthenticated)
-	{
-		gamekeeper.GET("", h.GamesIndex)
-		gamekeeper.GET("/signup", h.SignUp)
-		gamekeeper.POST("/signup", h.DoSignUp)
-	}
-
-	return router
-}

internal/handlers/about.go

@@ -0,0 +1,47 @@
+package auth
+
+import (
+	"errors"
+	"net/http"
+
+	"github.com/gin-contrib/sessions"
+	"github.com/gin-gonic/gin"
+	"github.com/gitznik/robswebhub/internal/auth"
+)
+
+func (h *Handler) Callback(c *gin.Context) {
+	session := sessions.Default(c)
+	if c.Query("state") != session.Get("state") {
+		c.String(http.StatusBadRequest, "Invalid state parameter.")
+		return
+	}
+
+	// Exchange an authorization code for a token.
+	token, err := h.authenticator.Exchange(c.Request.Context(), c.Query("code"))
+	if err != nil {
+		c.String(http.StatusUnauthorized, "Failed to convert an authorization code into a token.")
+		return
+	}
+
+	idToken, err := h.authenticator.VerifyIDToken(c.Request.Context(), token)
+	if err != nil {
+		_ = c.Error(errors.New("Failed to verify ID Token."))
+		return
+	}
+
+	var profile auth.UserProfile
+	if err := idToken.Claims(&profile); err != nil {
+		c.String(http.StatusInternalServerError, err.Error())
+		return
+	}
+
+	session.Set("access_token", token.AccessToken)
+	session.Set("profile", profile)
+	if err := session.Save(); err != nil {
+		_ = c.Error(err)
+		return
+	}
+
+	// Redirect to logged in page.
+	c.Redirect(http.StatusTemporaryRedirect, "/")
+}

internal/handlers/auth/callback.go

@@ -0,0 +1,25 @@
+package auth
+
+import (
+	"github.com/gin-gonic/gin"
+	"github.com/gitznik/robswebhub/internal/auth"
+	"github.com/gitznik/robswebhub/internal/config"
+)
+
+type Handler struct {
+	cfg           *config.Config
+	authenticator *auth.Authenticator
+}
+
+func New(cfg *config.Config, authenticator *auth.Authenticator) *Handler {
+	return &Handler{
+		cfg:           cfg,
+		authenticator: authenticator,
+	}
+}
+
+func (h *Handler) RegisterRoute(rg *gin.RouterGroup) {
+	rg.GET("/login", h.Login)
+	rg.GET("/logout", h.Logout)
+	rg.GET("/callback", h.Callback)
+}

internal/handlers/auth/handler.go

@@ -0,0 +1,40 @@
+package auth
+
+import (
+	"crypto/rand"
+	"encoding/base64"
+	"net/http"
+
+	"github.com/gin-contrib/sessions"
+	"github.com/gin-gonic/gin"
+)
+
+func (h *Handler) Login(c *gin.Context) {
+	state, err := generateRandomState()
+	if err != nil {
+		_ = c.Error(err)
+		return
+	}
+
+	// Save the state inside the session.
+	session := sessions.Default(c)
+	session.Set("state", state)
+	if err := session.Save(); err != nil {
+		_ = c.Error(err)
+		return
+	}
+
+	c.Redirect(http.StatusTemporaryRedirect, h.authenticator.AuthCodeURL(state))
+}
+
+func generateRandomState() (string, error) {
+	b := make([]byte, 32)
+	_, err := rand.Read(b)
+	if err != nil {
+		return "", err
+	}
+
+	state := base64.StdEncoding.EncodeToString(b)
+
+	return state, nil
+}

internal/handlers/auth/login.go

@@ -1,4 +1,4 @@
-package handlers
+package auth
 
 import (
 	"net/http"

internal/handlers/logout.go renamed to internal/handlers/auth/logout.go

@@ -1,4 +1,4 @@
-package handlers
+package games
 
 import (
 	"errors"

internal/handlers/callback.go

@@ -0,0 +1,26 @@
+package games
+
+import (
+	"github.com/gin-gonic/gin"
+	"github.com/gitznik/robswebhub/internal/database"
+	"github.com/gitznik/robswebhub/internal/middleware"
+)
+
+type Handler struct {
+	queries *database.Queries
+}
+
+func New(queries *database.Queries) *Handler {
+	return &Handler{
+		queries: queries,
+	}
+}
+
+func (h *Handler) RegisterRoute(rg *gin.RouterGroup) {
+	rg.Use(middleware.IsAuthenticated)
+	{
+		rg.GET("", h.GamesIndex)
+		rg.GET("/signup", h.SignUp)
+		rg.POST("/signup", h.DoSignUp)
+	}
+}

internal/handlers/games.go renamed to internal/handlers/games/games.go

@@ -23,6 +23,12 @@ func New(queries *database.Queries, cfg *config.Config) *Handler {
 	}
 }
 
+func (h *Handler) RegisterRoute(rg *gin.RouterGroup) {
+	rg.GET("/", h.Home)
+	rg.HEAD("/", h.HomeHead)
+	rg.GET("/about", h.About)
+}
+
 func (h *Handler) Home(c *gin.Context) {
 	redirectError := c.Query("error")
 	component := pages.Home(redirectError, c.GetBool(middleware.LoginKey))
@@ -35,3 +41,11 @@ func (h *Handler) Home(c *gin.Context) {
 func (h *Handler) HomeHead(c *gin.Context) {
 	c.Status(http.StatusOK)
 }
+
+func (h *Handler) About(c *gin.Context) {
+	component := pages.About(c.GetBool(middleware.LoginKey))
+	if err := component.Render(c.Request.Context(), c.Writer); err != nil {
+		_ = c.Error(errors.New("Failed to render page"))
+		return
+	}
+}