Remove unused EngineTypes from p2p messages (ava-labs#2735)

mboben · Mar 15, 2023 · b6c16e1 · b6c16e1
1 parent 109fc3d
commit b6c16e1
Show file tree

Hide file tree

Showing 11 changed files with 163 additions and 253 deletions.
diff --git a/message/fields.go b/message/fields.go
@@ -53,16 +53,12 @@ var (
 	_ requestIDGetter = (*p2p.AppResponse)(nil)
 
 	_ engineTypeGetter = (*p2p.GetAcceptedFrontier)(nil)
-	_ engineTypeGetter = (*p2p.AcceptedFrontier)(nil)
 	_ engineTypeGetter = (*p2p.GetAccepted)(nil)
-	_ engineTypeGetter = (*p2p.Accepted)(nil)
 	_ engineTypeGetter = (*p2p.GetAncestors)(nil)
-	_ engineTypeGetter = (*p2p.Ancestors)(nil)
 	_ engineTypeGetter = (*p2p.Get)(nil)
 	_ engineTypeGetter = (*p2p.Put)(nil)
 	_ engineTypeGetter = (*p2p.PushQuery)(nil)
 	_ engineTypeGetter = (*p2p.PullQuery)(nil)
-	_ engineTypeGetter = (*p2p.Chits)(nil)
 
 	_ deadlineGetter = (*p2p.GetStateSummaryFrontier)(nil)
 	_ deadlineGetter = (*p2p.GetAcceptedStateSummary)(nil)
@@ -127,7 +123,7 @@ type engineTypeGetter interface {
 func GetEngineType(m any) (p2p.EngineType, bool) {
 	msg, ok := m.(engineTypeGetter)
 	if !ok {
-		return 0, false
+		return p2p.EngineType_ENGINE_TYPE_UNSPECIFIED, false
 	}
 	return msg.GetEngineType(), true
 }

diff --git a/message/inbound_msg_builder.go b/message/inbound_msg_builder.go
@@ -137,7 +137,6 @@ func InboundAcceptedFrontier(
 	requestID uint32,
 	containerIDs []ids.ID,
 	nodeID ids.NodeID,
-	engineType p2p.EngineType,
 ) InboundMessage {
 	containerIDBytes := make([][]byte, len(containerIDs))
 	encodeIDs(containerIDs, containerIDBytes)
@@ -148,7 +147,6 @@ func InboundAcceptedFrontier(
 			ChainId:      chainID[:],
 			RequestId:    requestID,
 			ContainerIds: containerIDBytes,
-			EngineType:   engineType,
 		},
 		expiration: mockable.MaxTime,
 	}
@@ -183,7 +181,6 @@ func InboundAccepted(
 	requestID uint32,
 	containerIDs []ids.ID,
 	nodeID ids.NodeID,
-	engineType p2p.EngineType,
 ) InboundMessage {
 	containerIDBytes := make([][]byte, len(containerIDs))
 	encodeIDs(containerIDs, containerIDBytes)
@@ -194,7 +191,6 @@ func InboundAccepted(
 			ChainId:      chainID[:],
 			RequestId:    requestID,
 			ContainerIds: containerIDBytes,
-			EngineType:   engineType,
 		},
 		expiration: mockable.MaxTime,
 	}
@@ -250,7 +246,6 @@ func InboundChits(
 	preferredContainerIDs []ids.ID,
 	acceptedContainerIDs []ids.ID,
 	nodeID ids.NodeID,
-	engineType p2p.EngineType,
 ) InboundMessage {
 	preferredContainerIDBytes := make([][]byte, len(preferredContainerIDs))
 	encodeIDs(preferredContainerIDs, preferredContainerIDBytes)
@@ -264,7 +259,6 @@ func InboundChits(
 			RequestId:             requestID,
 			PreferredContainerIds: preferredContainerIDBytes,
 			AcceptedContainerIds:  acceptedContainerIDBytes,
-			EngineType:            engineType,
 		},
 		expiration: mockable.MaxTime,
 	}

diff --git a/message/inbound_msg_builder_test.go b/message/inbound_msg_builder_test.go
@@ -185,7 +185,6 @@ func TestInboundMsgBuilder(t *testing.T) {
 				requestID,
 				containerIDs,
 				nodeID,
-				engineType,
 			)
 
 			require.Equal(AcceptedFrontierOp, msg.Op())
@@ -201,7 +200,6 @@ func TestInboundMsgBuilder(t *testing.T) {
 				containerIDsBytes[i] = id[:]
 			}
 			require.Equal(containerIDsBytes, innerMsg.ContainerIds)
-			require.Equal(engineType, innerMsg.EngineType)
 		},
 	)
 
@@ -243,7 +241,6 @@ func TestInboundMsgBuilder(t *testing.T) {
 				requestID,
 				containerIDs,
 				nodeID,
-				engineType,
 			)
 
 			require.Equal(AcceptedOp, msg.Op())
@@ -259,7 +256,6 @@ func TestInboundMsgBuilder(t *testing.T) {
 				containerIDsBytes[i] = id[:]
 			}
 			require.Equal(containerIDsBytes, innerMsg.ContainerIds)
-			require.Equal(engineType, innerMsg.EngineType)
 		},
 	)
 
@@ -332,7 +328,6 @@ func TestInboundMsgBuilder(t *testing.T) {
 				containerIDs,
 				acceptedContainerIDs,
 				nodeID,
-				engineType,
 			)
 
 			require.Equal(ChitsOp, msg.Op())
@@ -354,7 +349,6 @@ func TestInboundMsgBuilder(t *testing.T) {
 				acceptedContainerIDsBytes[i] = id[:]
 			}
 			require.Equal(acceptedContainerIDsBytes, innerMsg.AcceptedContainerIds)
-			require.Equal(engineType, innerMsg.EngineType)
 		},
 	)
 

diff --git a/message/messages_test.go b/message/messages_test.go
@@ -325,7 +325,6 @@ func TestMessage(t *testing.T) {
 						ChainId:      testID[:],
 						RequestId:    1,
 						ContainerIds: [][]byte{testID[:], testID[:]},
-						EngineType:   p2p.EngineType_ENGINE_TYPE_AVALANCHE,
 					},
 				},
 			},
@@ -360,7 +359,6 @@ func TestMessage(t *testing.T) {
 						ChainId:      testID[:],
 						RequestId:    1,
 						ContainerIds: [][]byte{testID[:], testID[:]},
-						EngineType:   p2p.EngineType_ENGINE_TYPE_AVALANCHE,
 					},
 				},
 			},
@@ -395,7 +393,6 @@ func TestMessage(t *testing.T) {
 						ChainId:    testID[:],
 						RequestId:  12345,
 						Containers: compressibleContainers,
-						EngineType: p2p.EngineType_ENGINE_TYPE_AVALANCHE,
 					},
 				},
 			},
@@ -412,7 +409,6 @@ func TestMessage(t *testing.T) {
 						ChainId:    testID[:],
 						RequestId:  12345,
 						Containers: compressibleContainers,
-						EngineType: p2p.EngineType_ENGINE_TYPE_AVALANCHE,
 					},
 				},
 			},
@@ -535,7 +531,6 @@ func TestMessage(t *testing.T) {
 						ChainId:               testID[:],
 						RequestId:             1,
 						PreferredContainerIds: [][]byte{testID[:], testID[:]},
-						EngineType:            p2p.EngineType_ENGINE_TYPE_AVALANCHE,
 					},
 				},
 			},

diff --git a/message/mock_outbound_message_builder.go b/message/mock_outbound_message_builder.go
diff --git a/message/outbound_msg_builder.go b/message/outbound_msg_builder.go
@@ -79,7 +79,6 @@ type OutboundMsgBuilder interface {
 		chainID ids.ID,
 		requestID uint32,
 		containerIDs []ids.ID,
-		engineType p2p.EngineType,
 	) (OutboundMessage, error)
 
 	GetAccepted(
@@ -94,7 +93,6 @@ type OutboundMsgBuilder interface {
 		chainID ids.ID,
 		requestID uint32,
 		containerIDs []ids.ID,
-		engineType p2p.EngineType,
 	) (OutboundMessage, error)
 
 	GetAncestors(
@@ -109,7 +107,6 @@ type OutboundMsgBuilder interface {
 		chainID ids.ID,
 		requestID uint32,
 		containers [][]byte,
-		engineType p2p.EngineType,
 	) (OutboundMessage, error)
 
 	Get(
@@ -148,7 +145,6 @@ type OutboundMsgBuilder interface {
 		requestID uint32,
 		preferredContainerIDs []ids.ID,
 		acceptedContainerIDs []ids.ID,
-		engineType p2p.EngineType,
 	) (OutboundMessage, error)
 
 	AppRequest(
@@ -395,7 +391,6 @@ func (b *outMsgBuilder) AcceptedFrontier(
 	chainID ids.ID,
 	requestID uint32,
 	containerIDs []ids.ID,
-	engineType p2p.EngineType,
 ) (OutboundMessage, error) {
 	containerIDBytes := make([][]byte, len(containerIDs))
 	encodeIDs(containerIDs, containerIDBytes)
@@ -406,7 +401,6 @@ func (b *outMsgBuilder) AcceptedFrontier(
 					ChainId:      chainID[:],
 					RequestId:    requestID,
 					ContainerIds: containerIDBytes,
-					EngineType:   engineType,
 				},
 			},
 		},
@@ -445,7 +439,6 @@ func (b *outMsgBuilder) Accepted(
 	chainID ids.ID,
 	requestID uint32,
 	containerIDs []ids.ID,
-	engineType p2p.EngineType,
 ) (OutboundMessage, error) {
 	containerIDBytes := make([][]byte, len(containerIDs))
 	encodeIDs(containerIDs, containerIDBytes)
@@ -456,7 +449,6 @@ func (b *outMsgBuilder) Accepted(
 					ChainId:      chainID[:],
 					RequestId:    requestID,
 					ContainerIds: containerIDBytes,
-					EngineType:   engineType,
 				},
 			},
 		},
@@ -493,7 +485,6 @@ func (b *outMsgBuilder) Ancestors(
 	chainID ids.ID,
 	requestID uint32,
 	containers [][]byte,
-	engineType p2p.EngineType,
 ) (OutboundMessage, error) {
 	return b.builder.createOutbound(
 		&p2p.Message{
@@ -502,7 +493,6 @@ func (b *outMsgBuilder) Ancestors(
 					ChainId:    chainID[:],
 					RequestId:  requestID,
 					Containers: containers,
-					EngineType: engineType,
 				},
 			},
 		},
@@ -610,7 +600,6 @@ func (b *outMsgBuilder) Chits(
 	requestID uint32,
 	preferredContainerIDs []ids.ID,
 	acceptedContainerIDs []ids.ID,
-	engineType p2p.EngineType,
 ) (OutboundMessage, error) {
 	preferredContainerIDBytes := make([][]byte, len(preferredContainerIDs))
 	encodeIDs(preferredContainerIDs, preferredContainerIDBytes)
@@ -624,7 +613,6 @@ func (b *outMsgBuilder) Chits(
 					RequestId:             requestID,
 					PreferredContainerIds: preferredContainerIDBytes,
 					AcceptedContainerIds:  acceptedContainerIDBytes,
-					EngineType:            engineType,
 				},
 			},
 		},