Merge pull request #431 from blinklabs-io/chore/remove-is-response

agaffney · web-flow · commit 03f0b9e7cd26 · 2023-11-25T08:04:20.000-06:00
chore: remove unused isResponse param in message handlers
diff --git a/protocol/blockfetch/client.go b/protocol/blockfetch/client.go
@@ -124,7 +124,7 @@ func (c *Client) GetBlock(point common.Point) (ledger.Block, error) {
 	return block, nil
 }
 
-func (c *Client) messageHandler(msg protocol.Message, isResponse bool) error {
+func (c *Client) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeStartBatch:
diff --git a/protocol/blockfetch/server.go b/protocol/blockfetch/server.go
@@ -44,7 +44,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server {
 	return s
 }
 
-func (s *Server) messageHandler(msg protocol.Message, isResponse bool) error {
+func (s *Server) messageHandler(msg protocol.Message) error {
 	var err error
 	// TODO: add cases for messages from client
 	switch msg.Type() {
diff --git a/protocol/chainsync/client.go b/protocol/chainsync/client.go
@@ -96,7 +96,7 @@ func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client {
 	return c
 }
 
-func (c *Client) messageHandler(msg protocol.Message, isResponse bool) error {
+func (c *Client) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeAwaitReply:
diff --git a/protocol/chainsync/server.go b/protocol/chainsync/server.go
@@ -54,7 +54,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server {
 	return s
 }
 
-func (s *Server) messageHandler(msg protocol.Message, isResponse bool) error {
+func (s *Server) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeRequestNext:
diff --git a/protocol/handshake/client.go b/protocol/handshake/client.go
@@ -70,7 +70,7 @@ func (c *Client) Start() {
 	})
 }
 
-func (c *Client) handleMessage(msg protocol.Message, isResponse bool) error {
+func (c *Client) handleMessage(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeAcceptVersion:
diff --git a/protocol/handshake/server.go b/protocol/handshake/server.go
@@ -47,7 +47,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server {
 	return s
 }
 
-func (s *Server) handleMessage(msg protocol.Message, isResponse bool) error {
+func (s *Server) handleMessage(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeProposeVersions:
diff --git a/protocol/keepalive/client.go b/protocol/keepalive/client.go
@@ -86,7 +86,7 @@ func (c *Client) startTimer() {
 	})
 }
 
-func (c *Client) messageHandler(msg protocol.Message, isResponse bool) error {
+func (c *Client) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeKeepAliveResponse:
diff --git a/protocol/keepalive/server.go b/protocol/keepalive/server.go
@@ -44,7 +44,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server {
 	return s
 }
 
-func (s *Server) messageHandler(msg protocol.Message, isResponse bool) error {
+func (s *Server) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeKeepAlive:
diff --git a/protocol/localstatequery/client.go b/protocol/localstatequery/client.go
@@ -91,7 +91,7 @@ func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client {
 	return c
 }
 
-func (c *Client) messageHandler(msg protocol.Message, isResponse bool) error {
+func (c *Client) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeAcquired:
diff --git a/protocol/localstatequery/server.go b/protocol/localstatequery/server.go
@@ -58,7 +58,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server {
 	return s
 }
 
-func (s *Server) messageHandler(msg protocol.Message, isResponse bool) error {
+func (s *Server) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeAcquire:
diff --git a/protocol/localtxmonitor/client.go b/protocol/localtxmonitor/client.go
@@ -83,7 +83,7 @@ func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client {
 	return c
 }
 
-func (c *Client) messageHandler(msg protocol.Message, isResponse bool) error {
+func (c *Client) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeAcquired:
diff --git a/protocol/localtxmonitor/server.go b/protocol/localtxmonitor/server.go
@@ -52,7 +52,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server {
 	return s
 }
 
-func (s *Server) messageHandler(msg protocol.Message, isResponse bool) error {
+func (s *Server) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeAcquire:
diff --git a/protocol/localtxsubmission/client.go b/protocol/localtxsubmission/client.go
@@ -69,7 +69,7 @@ func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client {
 	return c
 }
 
-func (c *Client) messageHandler(msg protocol.Message, isResponse bool) error {
+func (c *Client) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeAcceptTx:
diff --git a/protocol/localtxsubmission/server.go b/protocol/localtxsubmission/server.go
@@ -48,7 +48,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server {
 	return s
 }
 
-func (s *Server) messageHandler(msg protocol.Message, isResponse bool) error {
+func (s *Server) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeSubmitTx:
diff --git a/protocol/peersharing/client.go b/protocol/peersharing/client.go
@@ -69,7 +69,7 @@ func (c *Client) GetPeers(amount uint8) ([]interface{}, error) {
 	return peers, nil
 }
 
-func (c *Client) handleMessage(msg protocol.Message, isResponse bool) error {
+func (c *Client) handleMessage(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeSharePeers:
diff --git a/protocol/peersharing/server.go b/protocol/peersharing/server.go
@@ -47,7 +47,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server {
 	return s
 }
 
-func (s *Server) handleMessage(msg protocol.Message, isResponse bool) error {
+func (s *Server) handleMessage(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeShareRequest:
diff --git a/protocol/protocol.go b/protocol/protocol.go
@@ -93,7 +93,7 @@ type ProtocolOptions struct {
 }
 
 // MessageHandlerFunc represents a function that handles an incoming message
-type MessageHandlerFunc func(Message, bool) error
+type MessageHandlerFunc func(Message) error
 
 // MessageFromCborFunc represents a function that parses a mini-protocol message
 type MessageFromCborFunc func(uint, []byte) (Message, error)
@@ -316,7 +316,6 @@ func (p *Protocol) sendLoop() {
 func (p *Protocol) recvLoop() {
 	defer p.waitGroup.Done()
 	leftoverData := false
-	isResponse := false
 	for {
 		var err error
 		// Don't grab the next segment from the muxer if we still have data in the buffer
@@ -333,8 +332,6 @@ func (p *Protocol) recvLoop() {
 				}
 				// Add segment payload to buffer
 				p.recvBuffer.Write(segment.Payload)
-				// Save whether it's a response
-				isResponse = segment.IsResponse()
 			}
 		}
 		leftoverData = false
@@ -383,7 +380,7 @@ func (p *Protocol) recvLoop() {
 			return
 		}
 		// Handle message
-		if err := p.handleMessage(msg, isResponse); err != nil {
+		if err := p.handleMessage(msg); err != nil {
 			p.SendError(err)
 			return
 		}
@@ -470,7 +467,7 @@ func (p *Protocol) setState(state State) {
 	}
 }
 
-func (p *Protocol) handleMessage(msg Message, isResponse bool) error {
+func (p *Protocol) handleMessage(msg Message) error {
 	// Lock the state to prevent collisions
 	p.stateMutex.Lock()
 	newState, err := p.getNewState(msg)
@@ -481,5 +478,5 @@ func (p *Protocol) handleMessage(msg Message, isResponse bool) error {
 	p.setState(newState)
 	p.stateMutex.Unlock()
 	// Call handler function
-	return p.config.MessageHandlerFunc(msg, isResponse)
+	return p.config.MessageHandlerFunc(msg)
 }
diff --git a/protocol/txsubmission/client.go b/protocol/txsubmission/client.go
@@ -67,7 +67,7 @@ func (c *Client) Init() {
 	})
 }
 
-func (c *Client) messageHandler(msg protocol.Message, isResponse bool) error {
+func (c *Client) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeRequestTxIds:
diff --git a/protocol/txsubmission/server.go b/protocol/txsubmission/server.go
@@ -57,7 +57,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server {
 	return s
 }
 
-func (s *Server) messageHandler(msg protocol.Message, isResponse bool) error {
+func (s *Server) messageHandler(msg protocol.Message) error {
 	var err error
 	switch msg.Type() {
 	case MessageTypeReplyTxIds:

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ func (c *Client) GetBlock(point common.Point) (ledger.Block, error) {`
`124`	`124`	`return block, nil`
`125`	`125`	`}`
`126`	`126`
`127`		`-func (c *Client) messageHandler(msg protocol.Message, isResponse bool) error {`
	`127`	`+func (c *Client) messageHandler(msg protocol.Message) error {`
`128`	`128`	`var err error`
`129`	`129`	`switch msg.Type() {`
`130`	`130`	`case MessageTypeStartBatch:`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg Config) Server {`
`44`	`44`	`return s`
`45`	`45`	`}`
`46`	`46`
`47`		`-func (s *Server) messageHandler(msg protocol.Message, isResponse bool) error {`
	`47`	`+func (s *Server) messageHandler(msg protocol.Message) error {`
`48`	`48`	`var err error`
`49`	`49`	`// TODO: add cases for messages from client`
`50`	`50`	`switch msg.Type() {`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ func NewClient(protoOptions protocol.ProtocolOptions, cfg Config) Client {`
`96`	`96`	`return c`
`97`	`97`	`}`
`98`	`98`
`99`		`-func (c *Client) messageHandler(msg protocol.Message, isResponse bool) error {`
	`99`	`+func (c *Client) messageHandler(msg protocol.Message) error {`
`100`	`100`	`var err error`
`101`	`101`	`switch msg.Type() {`
`102`	`102`	`case MessageTypeAwaitReply:`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg Config) Server {`
`54`	`54`	`return s`
`55`	`55`	`}`
`56`	`56`
`57`		`-func (s *Server) messageHandler(msg protocol.Message, isResponse bool) error {`
	`57`	`+func (s *Server) messageHandler(msg protocol.Message) error {`
`58`	`58`	`var err error`
`59`	`59`	`switch msg.Type() {`
`60`	`60`	`case MessageTypeRequestNext:`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ func (c *Client) Start() {`
`70`	`70`	`})`
`71`	`71`	`}`
`72`	`72`
`73`		`-func (c *Client) handleMessage(msg protocol.Message, isResponse bool) error {`
	`73`	`+func (c *Client) handleMessage(msg protocol.Message) error {`
`74`	`74`	`var err error`
`75`	`75`	`switch msg.Type() {`
`76`	`76`	`case MessageTypeAcceptVersion:`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg Config) Server {`
`47`	`47`	`return s`
`48`	`48`	`}`
`49`	`49`
`50`		`-func (s *Server) handleMessage(msg protocol.Message, isResponse bool) error {`
	`50`	`+func (s *Server) handleMessage(msg protocol.Message) error {`
`51`	`51`	`var err error`
`52`	`52`	`switch msg.Type() {`
`53`	`53`	`case MessageTypeProposeVersions:`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ func (c *Client) startTimer() {`
`86`	`86`	`})`
`87`	`87`	`}`
`88`	`88`
`89`		`-func (c *Client) messageHandler(msg protocol.Message, isResponse bool) error {`
	`89`	`+func (c *Client) messageHandler(msg protocol.Message) error {`
`90`	`90`	`var err error`
`91`	`91`	`switch msg.Type() {`
`92`	`92`	`case MessageTypeKeepAliveResponse:`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ func NewClient(protoOptions protocol.ProtocolOptions, cfg Config) Client {`
`91`	`91`	`return c`
`92`	`92`	`}`
`93`	`93`
`94`		`-func (c *Client) messageHandler(msg protocol.Message, isResponse bool) error {`
	`94`	`+func (c *Client) messageHandler(msg protocol.Message) error {`
`95`	`95`	`var err error`
`96`	`96`	`switch msg.Type() {`
`97`	`97`	`case MessageTypeAcquired:`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ func NewServer(protoOptions protocol.ProtocolOptions, cfg Config) Server {`
`58`	`58`	`return s`
`59`	`59`	`}`
`60`	`60`
`61`		`-func (s *Server) messageHandler(msg protocol.Message, isResponse bool) error {`
	`61`	`+func (s *Server) messageHandler(msg protocol.Message) error {`
`62`	`62`	`var err error`
`63`	`63`	`switch msg.Type() {`
`64`	`64`	`case MessageTypeAcquire:`