experiment-service_controller_pattern #1

Merged
weirdcat merged 8 commits from experiment-service_controller_pattern into main 2025-06-20 17:57:12 +03:00
10 changed files with 208 additions and 156 deletions
Showing only changes of commit aab55a143f - Show all commits

View File

@@ -1,27 +1,31 @@
// @title Easywish client API // @title Easywish client API
// @version 1.0 // @version 1.0
// @description Easy and feature-rich wishlist. // @description Easy and feature-rich wishlist.
// @license.name GPL 3.0 // @license.name GPL 3.0
// @BasePath /api/ // @BasePath /api/
// @Schemes http // @Schemes http
// @securityDefinitions.apikey JWT // @securityDefinitions.apikey JWT
// @in header // @in header
// @name Authorization // @name Authorization
package main package main
import ( import (
"time"
"net/http"
"context"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"go.uber.org/fx"
"easywish/config" "easywish/config"
"easywish/internal/controllers"
"easywish/internal/logger" "easywish/internal/logger"
"easywish/internal/routes" "easywish/internal/routes"
"easywish/internal/services"
docs "easywish/docs" // swaggerfiles "github.com/swaggo/files"
swaggerfiles "github.com/swaggo/files" // ginSwagger "github.com/swaggo/gin-swagger"
ginSwagger "github.com/swaggo/gin-swagger"
) )
func main() { func main() {
@@ -32,12 +36,43 @@ func main() {
defer logger.Sync() defer logger.Sync()
r := gin.Default() fx.New(
r = routes.SetupRoutes(r) services.Module,
fx.Provide(
// func() *gin.Engine {
// engine := gin.Default()
// engine.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
// return engine
// },
gin.New,
controllers.NewAuthController,
controllers.NewServiceController,
),
routes.Module,
docs.SwaggerInfo.Schemes = []string{"http"}
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
r.Run(":8080") fx.Invoke(func(lc fx.Lifecycle, router *gin.Engine) {
server := &http.Server{
Addr: ":8080",
Handler: router,
}
lc.Append(fx.Hook{
OnStart: func(ctx context.Context) error {
go func() {
if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
}
}()
return nil
},
OnStop: func(ctx context.Context) error {
shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
return server.Shutdown(shutdownCtx)
},
})
}),
).Run()
} }

View File

@@ -49,6 +49,8 @@ require (
github.com/subosito/gotenv v1.6.0 // indirect github.com/subosito/gotenv v1.6.0 // indirect
github.com/twitchyliquid64/golang-asm v0.15.1 // indirect github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
github.com/ugorji/go/codec v1.3.0 // indirect github.com/ugorji/go/codec v1.3.0 // indirect
go.uber.org/dig v1.19.0 // indirect
go.uber.org/fx v1.24.0 // indirect
go.uber.org/multierr v1.11.0 // indirect go.uber.org/multierr v1.11.0 // indirect
golang.org/x/arch v0.18.0 // indirect golang.org/x/arch v0.18.0 // indirect
golang.org/x/crypto v0.39.0 // indirect golang.org/x/crypto v0.39.0 // indirect

View File

@@ -120,6 +120,10 @@ github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2
github.com/ugorji/go/codec v1.3.0 h1:Qd2W2sQawAfG8XSvzwhBeoGq71zXOC/Q1E9y/wUcsUA= github.com/ugorji/go/codec v1.3.0 h1:Qd2W2sQawAfG8XSvzwhBeoGq71zXOC/Q1E9y/wUcsUA=
github.com/ugorji/go/codec v1.3.0/go.mod h1:pRBVtBSKl77K30Bv8R2P+cLSGaTtex6fsA2Wjqmfxj4= github.com/ugorji/go/codec v1.3.0/go.mod h1:pRBVtBSKl77K30Bv8R2P+cLSGaTtex6fsA2Wjqmfxj4=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
go.uber.org/dig v1.19.0 h1:BACLhebsYdpQ7IROQ1AGPjrXcP5dF80U3gKoFzbaq/4=
go.uber.org/dig v1.19.0/go.mod h1:Us0rSJiThwCv2GteUN0Q7OKvU7n5J4dxZ9JKUXozFdE=
go.uber.org/fx v1.24.0 h1:wE8mruvpg2kiiL1Vqd0CC+tr0/24XIB10Iwp2lLWzkg=
go.uber.org/fx v1.24.0/go.mod h1:AmDeGyS+ZARGKM4tlH4FY2Jr63VjbEDJHtqXTGP5hbo=
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=

View File

@@ -1,50 +1,31 @@
package controllers package controllers
import ( import (
"easywish/internal/models"
"easywish/internal/services" "easywish/internal/services"
"net/http" "net/http"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
) )
// @Summary Register an account type AuthController interface {
// @Tags Auth RegistrationBegin(c *gin.Context)
// @Accept json RegistrationComplete(c *gin.Context)
// @Produce json Login(c *gin.Context)
// @Router /auth/registrationBegin [post] Refresh(c *gin.Context)
func RegistrationBegin(c *gin.Context) { PasswordResetBegin(c *gin.Context)
PasswordResetComplete(c *gin.Context)
var request models.RegistrationBeginRequest Router
if err := c.ShouldBindJSON(&request); err != nil {
c.Status(http.StatusBadRequest)
return
}
auths := services.NewAuthService()
result, err := auths.Login(request)
if err != nil {
c.Status(http.StatusTeapot)
return
}
c.JSON(http.StatusFound, result)
c.Status(http.StatusNotImplemented)
} }
// @Summary Confirm with code, finish creating the account type authControllerImpl struct {
// @Tags Auth authService services.AuthService
// @Accept json
// @Produce json
// @Router /auth/registrationComplete [post]
func RegistrationComplete(c *gin.Context) {
c.Status(http.StatusNotImplemented)
} }
func NewAuthController(as services.AuthService) AuthController {
return &authControllerImpl{authService: as}
}
// Login implements AuthController.
// @Summary Acquire tokens via login credentials (and 2FA code if needed) // @Summary Acquire tokens via login credentials (and 2FA code if needed)
// @Tags Auth // @Tags Auth
// @Accept json // @Accept json
@@ -52,50 +33,65 @@ func RegistrationComplete(c *gin.Context) {
// @Param request body models.LoginRequest true "desc" // @Param request body models.LoginRequest true "desc"
// @Success 200 {object} models.LoginResponse "desc" // @Success 200 {object} models.LoginResponse "desc"
// @Router /auth/login [post] // @Router /auth/login [post]
func Login(c *gin.Context) { func (a *authControllerImpl) Login(c *gin.Context) {
var request models.LoginRequest
if err := c.ShouldBindJSON(&request); err != nil {
c.Status(http.StatusBadRequest)
return
}
auths := services.NewAuthService()
result, err := auths.Login(request)
if err != nil {
c.Status(http.StatusTeapot)
return
}
c.JSON(http.StatusFound, result)
}
// @Summary Receive new tokens via refresh token
// @Tags Auth
// @Accept json
// @Produce json
// @Router /auth/refresh [post]
func Refresh(c *gin.Context) {
c.Status(http.StatusNotImplemented) c.Status(http.StatusNotImplemented)
} }
// PasswordResetBegin implements AuthController.
// @Summary Request password reset email // @Summary Request password reset email
// @Tags Auth // @Tags Auth
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Router /auth/passwordResetBegin [post] // @Router /auth/passwordResetBegin [post]
func PasswordResetBegin(c *gin.Context) { func (a *authControllerImpl) PasswordResetBegin(c *gin.Context) {
c.Status(http.StatusNotImplemented) c.Status(http.StatusNotImplemented)
} }
// PasswordResetComplete implements AuthController.
// @Summary Complete password reset with email code and provide 2FA code or backup code if needed // @Summary Complete password reset with email code and provide 2FA code or backup code if needed
// @Tags Auth // @Tags Auth
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Router /auth/passwordResetComplete [post] // @Router /auth/passwordResetComplete [post]
func PasswordResetComplete(c *gin.Context) { func (a *authControllerImpl) PasswordResetComplete(c *gin.Context) {
c.Status(http.StatusNotImplemented) c.Status(http.StatusNotImplemented)
} }
// Refresh implements AuthController.
// @Summary Receive new tokens via refresh token
// @Tags Auth
// @Accept json
// @Produce json
// @Router /auth/refresh [post]
func (a *authControllerImpl) Refresh(c *gin.Context) {
c.Status(http.StatusNotImplemented)
}
// RegistrationComplete implements AuthController.
// @Summary Register an account
// @Tags Auth
// @Accept json
// @Produce json
// @Router /auth/registrationBegin [post]
func (a *authControllerImpl) RegistrationBegin(c *gin.Context) {
c.Status(http.StatusNotImplemented)
}
// RegistrationBegin implements AuthController.
// @Summary Confirm with code, finish creating the account
// @Tags Auth
// @Accept json
// @Produce json
// @Router /auth/registrationComplete [post]
func (a *authControllerImpl) RegistrationComplete(c *gin.Context) {
c.Status(http.StatusNotImplemented)
}
func (a *authControllerImpl) RegisterRoutes(group *gin.RouterGroup) {
group.POST("/registrationBegin", a.RegistrationBegin)
group.POST("/registrationComplete", a.RegistrationComplete)
group.POST("/login", a.Login)
group.POST("/refresh", a.Refresh)
group.POST("/passwordResetBegin", a.PasswordResetBegin)
group.POST("/passwordResetComplete", a.PasswordResetComplete)
}

View File

@@ -0,0 +1,9 @@
package controllers
import (
"github.com/gin-gonic/gin"
)
type Router interface {
RegisterRoutes(group *gin.RouterGroup)
}

View File

@@ -6,10 +6,18 @@ import (
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
) )
type HealthStatus struct { type ServiceController interface {
Healthy bool `json:"healthy"` HealthCheck(c *gin.Context)
Router
} }
type serviceControllerImpl struct{}
func NewServiceController() ServiceController {
return &serviceControllerImpl{}
}
// HealthCheck implements ServiceController.
// @Summary Get health status // @Summary Get health status
// @Description Used internally for checking service health // @Description Used internally for checking service health
// @Tags Service // @Tags Service
@@ -17,6 +25,15 @@ type HealthStatus struct {
// @Produce json // @Produce json
// @Success 200 {object} HealthStatus "Says whether it's healthy or not" // @Success 200 {object} HealthStatus "Says whether it's healthy or not"
// @Router /service/health [get] // @Router /service/health [get]
func HealthCheck(c *gin.Context) { func (s *serviceControllerImpl) HealthCheck(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"healthy": true}) c.JSON(http.StatusOK, gin.H{"healthy": true})
} }
// RegisterRoutes implements ServiceController.
func (s *serviceControllerImpl) RegisterRoutes(group *gin.RouterGroup) {
group.GET("/health", s.HealthCheck)
}
type HealthStatus struct {
Healthy bool `json:"healthy"`
}

View File

@@ -0,0 +1,39 @@
package routes
import (
"easywish/internal/controllers"
"github.com/gin-gonic/gin"
)
func NewRouter(engine *gin.Engine, groups []RouteGroup) *gin.Engine {
apiGroup := engine.Group("/api")
for _, group := range groups {
subgroup := apiGroup.Group(group.BasePath)
subgroup.Use(group.Middleware...)
group.Router.RegisterRoutes(subgroup)
}
return engine
}
type RouteGroup struct {
BasePath string
Middleware []gin.HandlerFunc
Router controllers.Router
}
func NewRouteGroups(
authController controllers.AuthController,
serviceController controllers.ServiceController,
) []RouteGroup {
return []RouteGroup{
{
BasePath: "/auth",
Router: authController,
},
{
BasePath: "/service",
Router: serviceController,
},
}
}

View File

@@ -1,52 +1,12 @@
package routes package routes
import ( import (
"easywish/internal/controllers" "go.uber.org/fx"
"easywish/internal/middleware"
"github.com/gin-gonic/gin"
) )
func SetupRoutes(r *gin.Engine) *gin.Engine { var Module = fx.Module("routes",
apiGroup := r.Group("/api") fx.Provide(
{ NewRouteGroups,
serviceGroup := apiGroup.Group("/service") ),
{ fx.Invoke(NewRouter),
serviceGroup.GET("/health", controllers.HealthCheck) )
}
authGroup := apiGroup.Group("/auth")
{
authGroup.POST("/registrationBegin", controllers.RegistrationBegin)
authGroup.POST("/registrationComplete", controllers.RegistrationComplete)
authGroup.POST("/login", controllers.Login)
authGroup.POST("/refresh", controllers.Refresh)
authGroup.POST("/passwordResetBegin", controllers.PasswordResetBegin)
authGroup.POST("/passwordResetComplete", controllers.PasswordResetComplete)
}
profileGroup := apiGroup.Group("/profile")
{
profileGroup.GET("/:username", controllers.GetProfile)
}
protected := apiGroup.Group("")
protected.Use(middleware.JWTAuthMiddleware())
{
accountGroup := protected.Group("/account")
{
accountGroup.PUT("/changePassword", controllers.ChangePassword)
}
profileGroup := protected.Group("/profile")
{
profileGroup.GET("/me", controllers.GetOwnProfile)
profileGroup.GET("/privacy", controllers.GetPrivacySettings)
profileGroup.PATCH("/privacy", controllers.UpdatePrivacySettings)
}
}
}
return r
}

View File

@@ -2,7 +2,6 @@ package services
import ( import (
"easywish/internal/database" "easywish/internal/database"
"easywish/internal/errors"
errs "easywish/internal/errors" errs "easywish/internal/errors"
"easywish/internal/models" "easywish/internal/models"
"easywish/internal/utils" "easywish/internal/utils"
@@ -23,32 +22,11 @@ func NewAuthService() AuthService {
} }
func (a *authServiceImpl) RegistrationBegin(request models.RegistrationBeginRequest) (bool, error) { func (a *authServiceImpl) RegistrationBegin(request models.RegistrationBeginRequest) (bool, error) {
conn, ctx, err := utils.GetDbConn() return false, errs.ErrNotImplemented
if err != nil {
return false, err
}
defer conn.Close(ctx)
queries := database.New(conn)
tx, err := database.Begin()
if err != nil {
return err
}
defer tx.Rollback()
qtx := queries.WithTx(tx)
tx.Commit()
return
} }
func (a *authServiceImpl) RegistrationComplete(request models.RegistrationBeginRequest) (*models.RegistrationCompleteResponse, error) { func (a *authServiceImpl) RegistrationComplete(request models.RegistrationBeginRequest) (*models.RegistrationCompleteResponse, error) {
conn, ctx, err := utils.GetDbConn() return nil, errs.ErrNotImplemented
if err != nil {
return nil, err
}
defer conn.Close(ctx)
} }
func (a *authServiceImpl) Login(request models.LoginRequest) (*models.LoginResponse, error) { func (a *authServiceImpl) Login(request models.LoginRequest) (*models.LoginResponse, error) {
@@ -75,5 +53,5 @@ func (a *authServiceImpl) Login(request models.LoginRequest) (*models.LoginRespo
} }
func (a *authServiceImpl) Refresh(request models.RefreshRequest) (*models.RefreshResponse, error) { func (a *authServiceImpl) Refresh(request models.RefreshRequest) (*models.RefreshResponse, error) {
return nil, errors.ErrNotImplemented return nil, errs.ErrNotImplemented
} }

View File

@@ -0,0 +1,12 @@
package services
import (
"go.uber.org/fx"
)
var Module = fx.Module("services",
fx.Provide(
NewAuthService,
),
)