stakey/vspd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

webapi: Move VSP closed check to middleware.

Browse Source 
Checking this in middleware not only removes duplicated code from each of the handlers, but also makes things more efficient. Previously, dcrd/dcrwallet/database clients were initialized (and could possibly cause errors) **before** checking if the VSP is closed. Now the check happens before those other things.

Also bundled with some improvements to setaltsignaddr_test.go which I implemented along the way.
This commit is contained in:
Jamie Holdstock 2023-02-17 20:44:13 +00:00 committed by GitHub
parent 824c41c2a5
commit 7718476caf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 123 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
webapi/getfeeaddress.go
View File

@ -90,11 +90,6 @@ func (s *Server) feeAddress(c *gin.Context) {
}
reqBytes := c.MustGet(requestBytesKey).([]byte)
if s.cfg.VspClosed {
s.sendError(types.ErrVspClosed, c)
return
}
var request types.FeeAddressRequest
if err := binding.JSON.BindBody(reqBytes, &request); err != nil {
s.log.Warnf("%s: Bad request (clientIP=%s): %v", funcName, c.ClientIP(), err)

7
webapi/middleware.go
View File

@ -111,6 +111,13 @@ func drainAndReplaceBody(req *http.Request) ([]byte, error) {
return reqBytes, nil
}
func (s *Server) vspMustBeOpen(c *gin.Context) {
if s.cfg.VspClosed {
s.sendError(types.ErrVspClosed, c)
return
}
}
// broadcastTicket will ensure that the local dcrd instance is aware of the
// provided ticket.
// Ticket hash, ticket hex, and parent hex are parsed from the request body and

5
webapi/payfee.go
View File

@ -36,11 +36,6 @@ func (s *Server) payFee(c *gin.Context) {
}
reqBytes := c.MustGet(requestBytesKey).([]byte)
if s.cfg.VspClosed {
s.sendError(types.ErrVspClosed, c)
return
}
if !knownTicket {
s.log.Warnf("%s: Unknown ticket (clientIP=%s)", funcName, c.ClientIP())
s.sendError(types.ErrUnknownTicket, c)

5
webapi/setaltsignaddr.go
View File

@ -40,11 +40,6 @@ func (s *Server) setAltSignAddr(c *gin.Context) {
}
reqBytes := c.MustGet(requestBytesKey).([]byte)
if s.cfg.VspClosed {
s.sendError(types.ErrVspClosed, c)
return
}
var request types.SetAltSignAddrRequest
if err := binding.JSON.BindBody(reqBytes, &request); err != nil {
s.log.Warnf("%s: Bad request (clientIP=%s): %v", funcName, c.ClientIP(), err)

123
webapi/setaltsignaddr_test.go
View File

@ -10,6 +10,7 @@ import (
"encoding/json"
"errors"
"fmt"
"io"
"math/rand"
"net/http"
"net/http/httptest"
@ -130,17 +131,18 @@ func (n *testNode) GetRawTransaction(txHash string) (*dcrdtypes.TxRawResult, err
func TestSetAltSignAddress(t *testing.T) {
const testAddr = "DsVoDXNQqyF3V83PJJ5zMdnB4pQuJHBAh15"
tests := []struct {
name string
tests := map[string]struct {
dcrdClientErr bool
vspClosed bool
deformReq int
addr string
node *testNode
isExistingAltSignAddr bool
wantCode int
}{{
name: "ok",
wantHTTPStatus int
// wantErrCode and wantErrMsg only checked if wantHTTPStatus != 200.
wantErrCode types.ErrorCode
wantErrMsg string
}{
"ok": {
addr: testAddr,
node: &testNode{
getRawTransaction: &dcrdtypes.TxRawResult{
@ -149,37 +151,42 @@ func TestSetAltSignAddress(t *testing.T) {
getRawTransactionErr: nil,
existsLiveTicket: true,
},
wantCode: http.StatusOK,
}, {
name: "vsp closed",
vspClosed: true,
wantCode: http.StatusBadRequest,
}, {
name: "dcrd client error",
wantHTTPStatus: http.StatusOK,
},
"dcrd client error": {
dcrdClientErr: true,
wantCode: http.StatusInternalServerError,
}, {
name: "bad request",
wantHTTPStatus: http.StatusInternalServerError,
wantErrCode: types.ErrInternalError,
wantErrMsg: types.ErrInternalError.DefaultMessage(),
},
"bad request": {
deformReq: 1,
wantCode: http.StatusBadRequest,
}, {
name: "bad addr",
wantHTTPStatus: http.StatusBadRequest,
wantErrCode: types.ErrBadRequest,
wantErrMsg: "json: cannot unmarshal string into Go value of type types.SetAltSignAddrRequest",
},
"bad addr": {
addr: "xxx",
wantCode: http.StatusBadRequest,
}, {
name: "addr wrong type",
wantHTTPStatus: http.StatusBadRequest,
wantErrCode: types.ErrBadRequest,
wantErrMsg: "failed to decoded address \"xxx\": invalid format: version and/or checksum bytes missing",
},
"addr wrong type": {
addr: "DkM3ZigNyiwHrsXRjkDQ8t8tW6uKGW9g61qEkG3bMqQPQWYEf5X3J",
wantCode: http.StatusBadRequest,
}, {
name: "getRawTransaction error from dcrd client",
wantHTTPStatus: http.StatusBadRequest,
wantErrCode: types.ErrBadRequest,
wantErrMsg: "wrong type for alternate signing address",
},
"getRawTransaction error from dcrd client": {
addr: testAddr,
node: &testNode{
getRawTransactionErr: errors.New("getRawTransaction error"),
},
wantCode: http.StatusInternalServerError,
}, {
name: "existsLiveTicket error from dcrd client",
wantHTTPStatus: http.StatusInternalServerError,
wantErrCode: types.ErrInternalError,
wantErrMsg: types.ErrInternalError.DefaultMessage(),
},
"existsLiveTicket error from dcrd client": {
addr: testAddr,
node: &testNode{
getRawTransaction: &dcrdtypes.TxRawResult{
@ -187,9 +194,11 @@ func TestSetAltSignAddress(t *testing.T) {
},
existsLiveTicketErr: errors.New("existsLiveTicket error"),
},
wantCode: http.StatusInternalServerError,
}, {
name: "ticket can't vote",
wantHTTPStatus: http.StatusInternalServerError,
wantErrCode: types.ErrInternalError,
wantErrMsg: types.ErrInternalError.DefaultMessage(),
},
"ticket can't vote": {
addr: testAddr,
node: &testNode{
getRawTransaction: &dcrdtypes.TxRawResult{
@ -197,20 +206,25 @@ func TestSetAltSignAddress(t *testing.T) {
},
existsLiveTicket: false,
},
wantCode: http.StatusBadRequest,
}, {
name: "only one alt sign addr allowed",
wantHTTPStatus: http.StatusBadRequest,
wantErrCode: types.ErrTicketCannotVote,
wantErrMsg: types.ErrTicketCannotVote.DefaultMessage(),
},
"only one alt sign addr allowed": {
addr: testAddr,
node: &testNode{
getRawTransaction: &dcrdtypes.TxRawResult{},
existsLiveTicket: true,
},
isExistingAltSignAddr: true,
wantCode: http.StatusBadRequest,
}}
wantHTTPStatus: http.StatusBadRequest,
wantErrCode: types.ErrBadRequest,
wantErrMsg: "alternate sign address data already exists",
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
for testName, test := range tests {
t.Run(testName, func(t *testing.T) {
ticketHash := randString(64, hexCharset)
req := &types.SetAltSignAddrRequest{
Timestamp: time.Now().Unix(),
@ -238,8 +252,6 @@ func TestSetAltSignAddress(t *testing.T) {
}
}
api.cfg.VspClosed = test.vspClosed
w := httptest.NewRecorder()
c, r := gin.CreateTestContext(w)
@ -266,8 +278,31 @@ func TestSetAltSignAddress(t *testing.T) {
r.ServeHTTP(w, c.Request)
if test.wantCode != w.Code {
t.Fatalf("expected status %d, got %d", test.wantCode, w.Code)
if test.wantHTTPStatus != w.Code {
t.Fatalf("expected http status %d, got %d", test.wantHTTPStatus, w.Code)
}
if test.wantHTTPStatus != http.StatusOK {
respBytes, err := io.ReadAll(w.Body)
if err != nil {
t.Fatalf("failed reading response body bytes: %v", err)
}
var apiError types.ErrorResponse
err = json.Unmarshal(respBytes, &apiError)
if err != nil {
t.Fatalf("could not unmarshal error response: %v", err)
}
if int64(test.wantErrCode) != apiError.Code {
t.Fatalf("incorrect error code, expected %d, actual %d",
test.wantErrCode, apiError.Code)
}
if test.wantErrMsg != apiError.Message {
t.Fatalf("incorrect error message, expected %q, actual %q",
test.wantErrMsg, apiError.Message)
}
}
altsig, err := api.db.AltSignAddrData(ticketHash)
@ -275,7 +310,7 @@ func TestSetAltSignAddress(t *testing.T) {
t.Fatalf("unable to get alt sign addr data: %v", err)
}
if test.wantCode != http.StatusOK && !test.isExistingAltSignAddr {
if test.wantHTTPStatus != http.StatusOK && !test.isExistingAltSignAddr {
if altsig != nil {
t.Fatalf("expected no alt sign addr saved for errored state")
}

6
webapi/webapi.go
View File

@ -236,10 +236,10 @@ func (s *Server) router(cookieSecret []byte, dcrd rpc.DcrdConnect, wallets rpc.W
api := router.Group("/api/v3")
api.GET("/vspinfo", s.vspInfo)
api.POST("/setaltsignaddr", s.withDcrdClient(dcrd), s.broadcastTicket, s.vspAuth, s.setAltSignAddr)
api.POST("/feeaddress", s.withDcrdClient(dcrd), s.broadcastTicket, s.vspAuth, s.feeAddress)
api.POST("/setaltsignaddr", s.vspMustBeOpen, s.withDcrdClient(dcrd), s.broadcastTicket, s.vspAuth, s.setAltSignAddr)
api.POST("/feeaddress", s.vspMustBeOpen, s.withDcrdClient(dcrd), s.broadcastTicket, s.vspAuth, s.feeAddress)
api.POST("/ticketstatus", s.withDcrdClient(dcrd), s.vspAuth, s.ticketStatus)
api.POST("/payfee", s.withDcrdClient(dcrd), s.vspAuth, s.payFee)
api.POST("/payfee", s.vspMustBeOpen, s.withDcrdClient(dcrd), s.vspAuth, s.payFee)
api.POST("/setvotechoices", s.withDcrdClient(dcrd), s.withWalletClients(wallets), s.vspAuth, s.setVoteChoices)
// Website routes.