Merge pull request #886 from 0xProject/release/9.4.1

Release 9.4.1

Author: jalextowle

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 This changelog is a work in progress and may contain notes for versions which have not actually been released. Check the [Releases](https://github.com/0xProject/0x-mesh/releases) page to see full release notes and more information about the latest released versions.
 
+## v9.4.1
+
+### Bug fixes 🐞
+
+-   Fixed a problem in the filtered pagination subprotocols of ordersync that caused the nodes to use the wrong orderfilter [#882](https://github.com/0xProject/0x-mesh/pull/882)
+
+
 ## v9.4.0
 
 ### Features ✅

README.md

@@ -1,4 +1,4 @@
-[![Version](https://img.shields.io/badge/version-9.4.0-orange.svg)](https://github.com/0xProject/0x-mesh/releases)
+[![Version](https://img.shields.io/badge/version-9.4.1-orange.svg)](https://github.com/0xProject/0x-mesh/releases)
 [![Docs](https://img.shields.io/badge/docs-website-yellow.svg)](https://0x-org.gitbook.io/mesh)
 [![Chat with us on Discord](https://img.shields.io/badge/chat-Discord-blueViolet.svg)](https://discord.gg/HF7fHwk)
 [![Circle CI](https://img.shields.io/circleci/project/0xProject/0x-mesh/master.svg)](https://circleci.com/gh/0xProject/0x-mesh/tree/master)

RELEASE_CHANGELOG.md

@@ -1,11 +1,11 @@
 - [Docker image](https://hub.docker.com/r/0xorg/mesh/tags)
-- [README](https://github.com/0xProject/0x-mesh/blob/v9.4.0/README.md)
+- [README](https://github.com/0xProject/0x-mesh/blob/v9.4.1/README.md)
 
 ## Summary
 
-### Features ✅
+### Bug fixes 🐞
 
-- Improved the performance of validating order filters in the browser [#809](https://github.com/0xProject/0x-mesh/pull/809).
+-   Fixed a problem in the filtered pagination subprotocols of ordersync that caused the nodes to use the wrong orderfilter [#882](https://github.com/0xProject/0x-mesh/pull/882)
 
 
 

core/core.go

@@ -60,7 +60,7 @@ const (
 	estimatedNonPollingEthereumRPCRequestsPer24Hrs = 50000
 	// logStatsInterval is how often to log stats for this node.
 	logStatsInterval = 5 * time.Minute
-	version          = "9.4.0"
+	version          = "9.4.1"
 	// ordersyncMinPeers is the minimum amount of peers to receive orders from
 	// before considering the ordersync process finished.
 	ordersyncMinPeers = 5

core/ordersync/ordersync.go

@@ -148,6 +148,9 @@ type Subprotocol interface {
 	// ParseResponseMetadata converts raw response metadata into a concrete type
 	// that the subprotocol expects.
 	ParseResponseMetadata(metadata json.RawMessage) (interface{}, error)
+	// GenerateFirstRequestMetadata generates the metadata for the first request
+	// that should be made with this subprotocol.
+	GenerateFirstRequestMetadata() (json.RawMessage, error)
 }
 
 // New creates and returns a new ordersync service, which is used for both
@@ -172,19 +175,19 @@ func New(ctx context.Context, node *p2p.Node, subprotocols []Subprotocol) *Servi
 
 // GetMatchingSubprotocol returns the most preferred subprotocol to use
 // based on the given request.
-func (s *Service) GetMatchingSubprotocol(rawReq *rawRequest) (Subprotocol, error) {
-	for _, protoID := range rawReq.Subprotocols {
+func (s *Service) GetMatchingSubprotocol(rawReq *rawRequest) (Subprotocol, int, error) {
+	for i, protoID := range rawReq.Subprotocols {
 		subprotocol, found := s.subprotocols[protoID]
 		if found {
-			return subprotocol, nil
+			return subprotocol, i, nil
 		}
 	}
 
 	err := NoMatchingSubprotocolsError{
 		Requested: rawReq.Subprotocols,
 		Supported: s.SupportedSubprotocols(),
 	}
-	return nil, err
+	return nil, 0, err
 }
 
 // HandleStream is a stream handler that is used to handle incoming ordersync requests.
@@ -225,12 +228,19 @@ func (s *Service) HandleStream(stream network.Stream) {
 			s.handlePeerScoreEvent(requesterID, psInvalidMessage)
 			return
 		}
-		subprotocol, err := s.GetMatchingSubprotocol(rawReq)
+		subprotocol, i, err := s.GetMatchingSubprotocol(rawReq)
 		if err != nil {
 			log.WithError(err).Warn("GetMatchingSubprotocol returned error")
 			s.handlePeerScoreEvent(requesterID, psSubprotocolNegotiationFailed)
 			return
 		}
+		if len(rawReq.Subprotocols) > 1 {
+			firstRequests := FirstRequestsForSubprotocols{}
+			err := json.Unmarshal(rawReq.Metadata, &firstRequests)
+			if err == nil {
+				rawReq.Metadata = firstRequests.MetadataForSubprotocol[i]
+			}
+		}
 		res, err := handleRequestWithSubprotocol(s.ctx, subprotocol, requesterID, rawReq)
 		if err != nil {
 			log.WithError(err).Warn("subprotocol returned error")
@@ -406,6 +416,38 @@ func parseResponseWithSubprotocol(subprotocol Subprotocol, providerID peer.ID, r
 	}, nil
 }
 
+type FirstRequestsForSubprotocols struct {
+	MetadataForSubprotocol []json.RawMessage `json:"metadata"`
+}
+
+// createFirstRequestForAllSubprotocols creates an initial ordersync request that
+// contains metadata for all of the ordersync subprotocols.
+func (s *Service) createFirstRequestForAllSubprotocols() (*rawRequest, error) {
+	metadata := []json.RawMessage{}
+	for _, subprotocolString := range s.SupportedSubprotocols() {
+		subprotocol, found := s.subprotocols[subprotocolString]
+		if !found {
+			return nil, fmt.Errorf("cannot generate first request metadata for subprotocol %s", subprotocolString)
+		}
+		m, err := subprotocol.GenerateFirstRequestMetadata()
+		if err != nil {
+			return nil, err
+		}
+		metadata = append(metadata, m)
+	}
+	encodedMetadata, err := json.Marshal(FirstRequestsForSubprotocols{
+		MetadataForSubprotocol: metadata,
+	})
+	if err != nil {
+		return nil, err
+	}
+	return &rawRequest{
+		Type:         TypeRequest,
+		Subprotocols: s.SupportedSubprotocols(),
+		Metadata:     encodedMetadata,
+	}, nil
+}
+
 func (s *Service) getOrdersFromPeer(ctx context.Context, providerID peer.ID) error {
 	stream, err := s.node.NewStream(ctx, providerID, ID)
 	if err != nil {
@@ -428,10 +470,9 @@ func (s *Service) getOrdersFromPeer(ctx context.Context, providerID peer.ID) err
 		var rawReq *rawRequest
 		if nextReq == nil {
 			// First request
-			rawReq = &rawRequest{
-				Type:         TypeRequest,
-				Subprotocols: s.SupportedSubprotocols(),
-				Metadata:     nil,
+			rawReq, err = s.createFirstRequestForAllSubprotocols()
+			if err != nil {
+				return err
 			}
 		} else {
 			encodedMetadata, err := json.Marshal(nextReq.Metadata)

core/ordersync_subprotocols.go

@@ -38,8 +38,9 @@ func NewFilteredPaginationSubprotocol(app *App, perPage int) *FilteredPagination
 // FilteredPaginationSubProtocol. It keeps track of the current page and SnapshotID,
 // which is expected to be an empty string on the first request.
 type FilteredPaginationRequestMetadata struct {
-	Page       int    `json:"page"`
-	SnapshotID string `json:"snapshotID"`
+	Page        int                 `json:"page"`
+	SnapshotID  string              `json:"snapshotID"`
+	OrderFilter *orderfilter.Filter `json:"orderfilter"`
 }
 
 // FilteredPaginationResponseMetadata is the response metadata for the
@@ -96,10 +97,16 @@ func (p *FilteredPaginationSubProtocol) HandleOrderSyncRequest(ctx context.Conte
 			break
 		}
 		// Filter the orders for this page.
-		for _, orderInfo := range ordersResp.OrdersInfos {
-			if matches, err := p.orderFilter.MatchOrder(orderInfo.SignedOrder); err != nil {
-				return nil, err
-			} else if matches {
+		if metadata.OrderFilter != nil {
+			for _, orderInfo := range ordersResp.OrdersInfos {
+				if matches, err := metadata.OrderFilter.MatchOrder(orderInfo.SignedOrder); err != nil {
+					return nil, err
+				} else if matches {
+					filteredOrders = append(filteredOrders, orderInfo.SignedOrder)
+				}
+			}
+		} else {
+			for _, orderInfo := range ordersResp.OrdersInfos {
 				filteredOrders = append(filteredOrders, orderInfo.SignedOrder)
 			}
 		}
@@ -166,8 +173,9 @@ func (p *FilteredPaginationSubProtocol) HandleOrderSyncResponse(ctx context.Cont
 
 	return &ordersync.Request{
 		Metadata: &FilteredPaginationRequestMetadata{
-			Page:       metadata.Page + 1,
-			SnapshotID: metadata.SnapshotID,
+			OrderFilter: p.orderFilter,
+			Page:        metadata.Page + 1,
+			SnapshotID:  metadata.SnapshotID,
 		},
 	}, nil
 }
@@ -187,3 +195,11 @@ func (p *FilteredPaginationSubProtocol) ParseResponseMetadata(metadata json.RawM
 	}
 	return &parsed, nil
 }
+
+func (p *FilteredPaginationSubProtocol) GenerateFirstRequestMetadata() (json.RawMessage, error) {
+	return json.Marshal(FilteredPaginationRequestMetadata{
+		OrderFilter: p.orderFilter,
+		Page:        0,
+		SnapshotID:  "",
+	})
+}

docs/browser-bindings/browser-lite/README.md

@@ -1,4 +1,4 @@
-# @0x/mesh-browser-lite - v9.4.0
+# @0x/mesh-browser-lite - v9.4.1
 
 ## @0x/mesh-browser-lite