Merge pull request #89 from numary/feature/make-stateless

feature/make stateless

Author: flemzord

api/api.go

@@ -1,15 +1,14 @@
 package api
 
 import (
-	"context"
 	_ "embed"
+	"net/http"
 
 	"github.com/gin-contrib/cors"
 	"github.com/gin-gonic/gin"
 	"github.com/numary/ledger/api/controllers"
 	"github.com/numary/ledger/api/middlewares"
 	"github.com/numary/ledger/api/routes"
-	"github.com/spf13/viper"
 	"go.uber.org/fx"
 )
 
@@ -21,13 +20,15 @@ var Module = fx.Options(
 
 // API struct
 type API struct {
-	addr   string
 	engine *gin.Engine
 }
 
+func (a *API) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	a.engine.ServeHTTP(w, r)
+}
+
 // NewAPI
 func NewAPI(
-	lc fx.Lifecycle,
 	routes *routes.Routes,
 ) *API {
 	gin.SetMode(gin.ReleaseMode)
@@ -38,21 +39,8 @@ func NewAPI(
 	cc.AddAllowHeaders("authorization")
 
 	h := &API{
-		addr:   viper.GetString("server.http.bind_address"),
 		engine: routes.Engine(cc),
 	}
 
-	lc.Append(fx.Hook{
-		OnStart: func(c context.Context) error {
-			go h.Start()
-			return nil
-		},
-	})
-
 	return h
 }
-
-// Start
-func (h *API) Start() {
-	h.engine.Run(h.addr)
-}

api/controllers/account_controller.go

@@ -30,6 +30,7 @@ func NewAccountController() AccountController {
 func (ctl *AccountController) GetAccounts(c *gin.Context) {
 	l, _ := c.Get("ledger")
 	cursor, err := l.(*ledger.Ledger).FindAccounts(
+		c,
 		query.After(c.Query("after")),
 	)
 	if err != nil {
@@ -58,7 +59,7 @@ func (ctl *AccountController) GetAccounts(c *gin.Context) {
 // @Router /{ledger}/accounts/{accountId} [get]
 func (ctl *AccountController) GetAccount(c *gin.Context) {
 	l, _ := c.Get("ledger")
-	acc, err := l.(*ledger.Ledger).GetAccount(c.Param("address"))
+	acc, err := l.(*ledger.Ledger).GetAccount(c, c.Param("address"))
 	if err != nil {
 		ctl.responseError(
 			c,
@@ -88,6 +89,7 @@ func (ctl *AccountController) PostAccountMetadata(c *gin.Context) {
 	var m core.Metadata
 	c.ShouldBind(&m)
 	err := l.(*ledger.Ledger).SaveMeta(
+		c,
 		"account",
 		c.Param("address"),
 		m,

api/controllers/config_controller.go

@@ -8,17 +8,32 @@ import (
 	"github.com/gin-gonic/gin"
 	"github.com/numary/ledger/config"
 	_ "github.com/numary/ledger/docs"
-	"github.com/spf13/viper"
 )
 
+type LedgerLister interface {
+	List() []string
+}
+type LedgerListerFn func() []string
+
+func (fn LedgerListerFn) List() []string {
+	return fn()
+}
+
 // ConfigController -
 type ConfigController struct {
 	BaseController
+	Version       string
+	StorageDriver string
+	LedgerLister  LedgerLister
 }
 
 // NewConfigController -
-func NewConfigController() ConfigController {
-	return ConfigController{}
+func NewConfigController(version string, storageDriver string, lister LedgerLister) ConfigController {
+	return ConfigController{
+		Version:       version,
+		StorageDriver: storageDriver,
+		LedgerLister:  lister,
+	}
 }
 
 // GetInfo godoc
@@ -36,11 +51,11 @@ func (ctl *ConfigController) GetInfo(c *gin.Context) {
 		http.StatusOK,
 		config.ConfigInfo{
 			Server:  "numary-ledger",
-			Version: viper.Get("version"),
+			Version: ctl.Version,
 			Config: &config.Config{
 				LedgerStorage: &config.LedgerStorage{
-					Driver:  viper.Get("storage.driver"),
-					Ledgers: viper.Get("ledgers"),
+					Driver:  ctl.StorageDriver,
+					Ledgers: ctl.LedgerLister.List(),
 				},
 			},
 		},

api/controllers/controllers.go

@@ -5,7 +5,9 @@ import (
 )
 
 var Module = fx.Options(
-	fx.Provide(NewConfigController),
+	fx.Provide(
+		fx.Annotate(NewConfigController, fx.ParamTags(`name:"version"`, `name:"storageDriver"`, `name:"ledgerLister"`)),
+	),
 	fx.Provide(NewLedgerController),
 	fx.Provide(NewScriptController),
 	fx.Provide(NewAccountController),

api/controllers/ledger_controller.go

@@ -31,7 +31,7 @@ func NewLedgerController() LedgerController {
 func (ctl *LedgerController) GetStats(c *gin.Context) {
 	l, _ := c.Get("ledger")
 
-	stats, err := l.(*ledger.Ledger).Stats()
+	stats, err := l.(*ledger.Ledger).Stats(c)
 	if err != nil {
 		ctl.responseError(
 			c,

api/controllers/script_controller.go

@@ -4,7 +4,6 @@ import (
 	"encoding/base64"
 	"encoding/json"
 	"fmt"
-	"log"
 	"strings"
 
 	"github.com/gin-gonic/gin"
@@ -39,24 +38,24 @@ func (ctl *ScriptController) PostScript(c *gin.Context) {
 	var script core.Script
 	c.ShouldBind(&script)
 
-	err := l.(*ledger.Ledger).Execute(script)
+	err := l.(*ledger.Ledger).Execute(c, script)
 
 	res := gin.H{
 		"ok": err == nil,
 	}
 
 	if err != nil {
-		err_str := err.Error()
-		err_str = strings.ReplaceAll(err_str, "\n", "\r\n")
+		errStr := err.Error()
+		errStr = strings.ReplaceAll(errStr, "\n", "\r\n")
 		payload, err := json.Marshal(gin.H{
-			"error": err_str,
+			"error": errStr,
 		})
 		if err != nil {
-			log.Fatal(err)
+			panic(err)
 		}
-		payload_b64 := base64.StdEncoding.EncodeToString([]byte(payload))
-		link := fmt.Sprintf("https://play.numscript.org/?payload=%v", payload_b64)
-		res["err"] = err_str
+		payloadB64 := base64.StdEncoding.EncodeToString(payload)
+		link := fmt.Sprintf("https://play.numscript.org/?payload=%v", payloadB64)
+		res["err"] = errStr
 		res["details"] = link
 	}
 

api/controllers/transaction_controller.go

@@ -34,6 +34,7 @@ func NewTransactionController() TransactionController {
 func (ctl *TransactionController) GetTransactions(c *gin.Context) {
 	l, _ := c.Get("ledger")
 	cursor, err := l.(*ledger.Ledger).FindTransactions(
+		c,
 		query.After(c.Query("after")),
 		query.Reference(c.Query("reference")),
 		query.Account(c.Query("account")),
@@ -71,7 +72,7 @@ func (ctl *TransactionController) PostTransaction(c *gin.Context) {
 	var t core.Transaction
 	c.ShouldBind(&t)
 
-	ts, err := l.(*ledger.Ledger).Commit([]core.Transaction{t})
+	ts, err := l.(*ledger.Ledger).Commit(c, []core.Transaction{t})
 	if err != nil {
 		ctl.responseError(
 			c,
@@ -101,7 +102,7 @@ func (ctl *TransactionController) PostTransaction(c *gin.Context) {
 // @Router /{ledger}/transactions/{txid} [get]
 func (ctl *TransactionController) GetTransaction(c *gin.Context) {
 	l, _ := c.Get("ledger")
-	tx, err := l.(*ledger.Ledger).GetTransaction(c.Param("txid"))
+	tx, err := l.(*ledger.Ledger).GetTransaction(c, c.Param("txid"))
 	if err != nil {
 		ctl.responseError(
 			c,
@@ -138,7 +139,7 @@ func (ctl *TransactionController) GetTransaction(c *gin.Context) {
 // @Router /{ledger}/transactions/{txid}/revert [post]
 func (ctl *TransactionController) RevertTransaction(c *gin.Context) {
 	l, _ := c.Get("ledger")
-	err := l.(*ledger.Ledger).RevertTransaction(c.Param("txid"))
+	err := l.(*ledger.Ledger).RevertTransaction(c, c.Param("txid"))
 	if err != nil {
 		ctl.responseError(
 			c,
@@ -172,6 +173,7 @@ func (ctl *TransactionController) PostTransactionMetadata(c *gin.Context) {
 	c.ShouldBind(&m)
 
 	err := l.(*ledger.Ledger).SaveMeta(
+		c,
 		"transaction",
 		c.Param("txid"),
 		m,

api/middlewares/auth_middleware.go

@@ -4,22 +4,25 @@ import (
 	"strings"
 
 	"github.com/gin-gonic/gin"
-	"github.com/spf13/viper"
 )
 
 // AuthMiddleware struct
-type AuthMiddleware struct{}
+type AuthMiddleware struct {
+	HTTPBasic string
+}
 
 // NewAuthMiddleware
-func NewAuthMiddleware() AuthMiddleware {
-	return AuthMiddleware{}
+func NewAuthMiddleware(httpBasic string) AuthMiddleware {
+	return AuthMiddleware{
+		HTTPBasic: httpBasic,
+	}
 }
 
 // AuthMiddleware
 func (m AuthMiddleware) AuthMiddleware(engine *gin.Engine) gin.HandlerFunc {
 	return func(c *gin.Context) {
-		if auth := viper.Get("server.http.basic_auth"); auth != nil {
-			segment := strings.Split(auth.(string), ":")
+		if auth := m.HTTPBasic; auth != "" {
+			segment := strings.Split(auth, ":")
 			engine.Use(gin.BasicAuth(gin.Accounts{
 				segment[0]: segment[1],
 			}))

api/middlewares/ledger_middleware.go

@@ -3,6 +3,7 @@ package middlewares
 import (
 	"github.com/gin-gonic/gin"
 	"github.com/numary/ledger/ledger"
+	"github.com/sirupsen/logrus"
 )
 
 // LedgerMiddleware struct
@@ -28,15 +29,21 @@ func (m *LedgerMiddleware) LedgerMiddleware() gin.HandlerFunc {
 			return
 		}
 
-		l, err := m.resolver.GetLedger(name)
-
+		l, err := m.resolver.GetLedger(c, name)
 		if err != nil {
 			c.JSON(400, gin.H{
 				"ok":  false,
 				"err": err.Error(),
 			})
 		}
-
+		defer func() {
+			err := l.Close(c)
+			if err != nil {
+				logrus.Printf("error closing ledger: %s", err)
+			}
+		}()
 		c.Set("ledger", l)
+
+		c.Next()
 	}
 }

api/middlewares/middlewares.go

@@ -5,6 +5,8 @@ import (
 )
 
 var Module = fx.Options(
-	fx.Provide(NewAuthMiddleware),
+	fx.Provide(
+		fx.Annotate(NewAuthMiddleware, fx.ParamTags(`name:"httpBasic"`)),
+	),
 	fx.Provide(NewLedgerMiddleware),
 )