Implementation of Nodes method. First take on full handler

network/default.go

@@ -54,6 +54,16 @@ func (n *node) Network() Network {
 	return n.network
 }
 
+// Neighbourhood returns node neighbourhood
+func (n *node) Neighbourhood() []Node {
+	var nodes []Node
+	for _, node := range n.neighbours {
+		nodes = append(nodes, node)
+	}
+
+	return nodes
+}
+
 // network implements Network interface
 type network struct {
 	// node is network node
@@ -721,8 +731,43 @@ func (n *network) Connect() error {
 }
 
 // Nodes returns a list of all network nodes
+// NOTE: this is a naive i.e. inefficient BFS implementation
 func (n *network) Nodes() []Node {
-	return nil
+	// map to track visited nodes
+	visited := make(map[string]*node)
+	// queue of the nodes to visit
+	queue := make([]*node, 1)
+	queue[0] = n.node
+	// add the root node to the map of the visited nodes
+	visited[n.node.id] = n.node
+
+	for {
+		// pop a node from the queue
+		qnode := queue[0]
+		// pop is done by reslicing of the queue
+		// https://github.com/golang/go/wiki/SliceTricks
+		queue = queue[1:]
+		// iterate through all of its neighbours
+		// mark the visited nodes; enqueue the non-visted
+		for id, node := range qnode.neighbours {
+			if _, ok := visited[id]; !ok {
+				visited[id] = node
+				queue = append(queue, node)
+			}
+		}
+		// if no nodes are in the queue break
+		if len(queue) == 0 {
+			break
+		}
+	}
+
+	nodes := make([]Node, 0)
+	// collecte all the nodes into slice
+	for _, node := range visited {
+		nodes = append(nodes, node)
+	}
+
+	return nodes
 }
 
 func (n *network) close() error {

network/handler/handler.go

@@ -2,6 +2,7 @@ package handler
 
 import (
 	"context"
+	"sort"
 
 	"github.com/micro/go-micro/errors"
 	"github.com/micro/go-micro/network"
@@ -42,10 +43,61 @@ func (n *Network) ListRoutes(ctx context.Context, req *pbRtr.Request, resp *pbRt
 
 // ListNodes returns a list of all accessible nodes in the network
 func (n *Network) ListNodes(ctx context.Context, req *pbNet.ListRequest, resp *pbNet.ListResponse) error {
+	nodes := n.Network.Nodes()
+
+	var respNodes []*pbNet.Node
+	for _, node := range nodes {
+		respNode := &pbNet.Node{
+			Id:      node.Id(),
+			Address: node.Address(),
+		}
+		respNodes = append(respNodes, respNode)
+	}
+
+	resp.Nodes = respNodes
+
 	return nil
 }
 
-// ListNeighbours returns a list of immediate neighbours
+// Neighbourhood returns a list of immediate neighbours
-func (n *Network) ListNeighbours(ctx context.Context, req *pbNet.NeighbourhoodRequest, resp *pbNet.NeighbourhoodResponse) error {
+func (n *Network) Neighbourhood(ctx context.Context, req *pbNet.NeighbourhoodRequest, resp *pbNet.NeighbourhoodResponse) error {
+	// extract the id of the node to query
+	id := req.Id
+	// if no id is passed, we assume local node
+	if id == "" {
+		id = n.Network.Id()
+	}
+
+	// get all the nodes in the network
+	nodes := n.Network.Nodes()
+
+	var neighbours []*pbNet.Neighbour
+	// find a node with a given id
+	i := sort.Search(len(nodes), func(i int) bool { return nodes[i].Id() == id })
+	// collect all the nodes in the neighbourhood of the found node
+	if i < len(nodes) && nodes[i].Id() == id {
+		for _, neighbour := range nodes[i].Neighbourhood() {
+			var nodeNeighbours []*pbNet.Node
+			for _, nodeNeighbour := range neighbour.Neighbourhood() {
+				nn := &pbNet.Node{
+					Id:      nodeNeighbour.Id(),
+					Address: nodeNeighbour.Address(),
+				}
+				nodeNeighbours = append(nodeNeighbours, nn)
+			}
+			// node is present at node[i]
+			neighbour := &pbNet.Neighbour{
+				Node: &pbNet.Node{
+					Id:      neighbour.Id(),
+					Address: neighbour.Address(),
+				},
+				Neighbours: nodeNeighbours,
+			}
+			neighbours = append(neighbours, neighbour)
+		}
+	}
+
+	resp.Neighbours = neighbours
+
 	return nil
 }

network/network.go

@@ -19,6 +19,18 @@ var (
 	AnnounceTime = 30 * time.Second
 )
 
+// Node is network node
+type Node interface {
+	// Id is node id
+	Id() string
+	// Address is node bind address
+	Address() string
+	// Neighbourhood is node neighbourhood
+	Neighbourhood() []Node
+	// Network is the network node is in
+	Network() Network
+}
+
 // Network is micro network
 type Network interface {
 	// Node is network node
@@ -39,16 +51,6 @@ type Network interface {
 	Server() server.Server
 }
 
-// Node is network node
-type Node interface {
-	// Id is node id
-	Id() string
-	// Address is node bind address
-	Address() string
-	// Network is the network node is in
-	Network() Network
-}
-
 // NewNetwork returns a new network interface
 func NewNetwork(opts ...Option) Network {
 	return newNetwork(opts...)

network/proto/network.pb.go

@@ -135,7 +135,7 @@ func (m *NeighbourhoodRequest) GetId() string {
 
 // NeighbourhoodResponse contains node neighbourhood hierarchy
 type NeighbourhoodResponse struct {
-	Neighbourhood        *Neighbour `protobuf:"bytes,1,opt,name=neighbourhood,proto3" json:"neighbourhood,omitempty"`
+	Neighbours           []*Neighbour `protobuf:"bytes,1,rep,name=neighbours,proto3" json:"neighbours,omitempty"`
 	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
 	XXX_unrecognized     []byte       `json:"-"`
 	XXX_sizecache        int32        `json:"-"`
@@ -166,59 +166,9 @@ func (m *NeighbourhoodResponse) XXX_DiscardUnknown() {
 
 var xxx_messageInfo_NeighbourhoodResponse proto.InternalMessageInfo
 
-func (m *NeighbourhoodResponse) GetNeighbourhood() *Neighbour {
+func (m *NeighbourhoodResponse) GetNeighbours() []*Neighbour {
 	if m != nil {
-		return m.Neighbourhood
+		return m.Neighbours
-	}
-	return nil
-}
-
-// Neighbourhood is node neighbourhood
-type Neighbourhood struct {
-	// network node
-	Node *Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
-	// node neighbours
-	Neighbour            []*Neighbour `protobuf:"bytes,2,rep,name=neighbour,proto3" json:"neighbour,omitempty"`
-	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
-	XXX_unrecognized     []byte       `json:"-"`
-	XXX_sizecache        int32        `json:"-"`
-}
-
-func (m *Neighbourhood) Reset()         { *m = Neighbourhood{} }
-func (m *Neighbourhood) String() string { return proto.CompactTextString(m) }
-func (*Neighbourhood) ProtoMessage()    {}
-func (*Neighbourhood) Descriptor() ([]byte, []int) {
-	return fileDescriptor_8571034d60397816, []int{4}
-}
-
-func (m *Neighbourhood) XXX_Unmarshal(b []byte) error {
-	return xxx_messageInfo_Neighbourhood.Unmarshal(m, b)
-}
-func (m *Neighbourhood) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) {
-	return xxx_messageInfo_Neighbourhood.Marshal(b, m, deterministic)
-}
-func (m *Neighbourhood) XXX_Merge(src proto.Message) {
-	xxx_messageInfo_Neighbourhood.Merge(m, src)
-}
-func (m *Neighbourhood) XXX_Size() int {
-	return xxx_messageInfo_Neighbourhood.Size(m)
-}
-func (m *Neighbourhood) XXX_DiscardUnknown() {
-	xxx_messageInfo_Neighbourhood.DiscardUnknown(m)
-}
-
-var xxx_messageInfo_Neighbourhood proto.InternalMessageInfo
-
-func (m *Neighbourhood) GetNode() *Node {
-	if m != nil {
-		return m.Node
-	}
-	return nil
-}
-
-func (m *Neighbourhood) GetNeighbour() []*Neighbour {
-	if m != nil {
-		return m.Neighbour
 	}
 	return nil
 }
@@ -238,7 +188,7 @@ func (m *Node) Reset()         { *m = Node{} }
 func (m *Node) String() string { return proto.CompactTextString(m) }
 func (*Node) ProtoMessage()    {}
 func (*Node) Descriptor() ([]byte, []int) {
-	return fileDescriptor_8571034d60397816, []int{5}
+	return fileDescriptor_8571034d60397816, []int{4}
 }
 
 func (m *Node) XXX_Unmarshal(b []byte) error {
@@ -286,7 +236,7 @@ func (m *Connect) Reset()         { *m = Connect{} }
 func (m *Connect) String() string { return proto.CompactTextString(m) }
 func (*Connect) ProtoMessage()    {}
 func (*Connect) Descriptor() ([]byte, []int) {
-	return fileDescriptor_8571034d60397816, []int{6}
+	return fileDescriptor_8571034d60397816, []int{5}
 }
 
 func (m *Connect) XXX_Unmarshal(b []byte) error {
@@ -327,7 +277,7 @@ func (m *Close) Reset()         { *m = Close{} }
 func (m *Close) String() string { return proto.CompactTextString(m) }
 func (*Close) ProtoMessage()    {}
 func (*Close) Descriptor() ([]byte, []int) {
-	return fileDescriptor_8571034d60397816, []int{7}
+	return fileDescriptor_8571034d60397816, []int{6}
 }
 
 func (m *Close) XXX_Unmarshal(b []byte) error {
@@ -370,7 +320,7 @@ func (m *Neighbour) Reset()         { *m = Neighbour{} }
 func (m *Neighbour) String() string { return proto.CompactTextString(m) }
 func (*Neighbour) ProtoMessage()    {}
 func (*Neighbour) Descriptor() ([]byte, []int) {
-	return fileDescriptor_8571034d60397816, []int{8}
+	return fileDescriptor_8571034d60397816, []int{7}
 }
 
 func (m *Neighbour) XXX_Unmarshal(b []byte) error {
@@ -410,7 +360,6 @@ func init() {
 	proto.RegisterType((*ListResponse)(nil), "go.micro.network.ListResponse")
 	proto.RegisterType((*NeighbourhoodRequest)(nil), "go.micro.network.NeighbourhoodRequest")
 	proto.RegisterType((*NeighbourhoodResponse)(nil), "go.micro.network.NeighbourhoodResponse")
-	proto.RegisterType((*Neighbourhood)(nil), "go.micro.network.Neighbourhood")
 	proto.RegisterType((*Node)(nil), "go.micro.network.Node")
 	proto.RegisterType((*Connect)(nil), "go.micro.network.Connect")
 	proto.RegisterType((*Close)(nil), "go.micro.network.Close")
@@ -420,28 +369,27 @@ func init() {
 func init() { proto.RegisterFile("network.proto", fileDescriptor_8571034d60397816) }
 
 var fileDescriptor_8571034d60397816 = []byte{
-	// 367 bytes of a gzipped FileDescriptorProto
+	// 344 bytes of a gzipped FileDescriptorProto
-	0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x94, 0x53, 0xc1, 0x4e, 0xc2, 0x40,
+	0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x94, 0x52, 0x41, 0x4f, 0xf2, 0x40,
-	0x10, 0x95, 0x02, 0x92, 0x0e, 0x62, 0xcc, 0x46, 0x4d, 0x53, 0x83, 0x21, 0x7b, 0x40, 0x62, 0xb4,
+	0x10, 0xfd, 0x28, 0xf0, 0x11, 0x06, 0x31, 0x66, 0xa3, 0xa6, 0xa9, 0xc1, 0x90, 0x3d, 0x20, 0x31,
-	0x18, 0x88, 0x26, 0x26, 0x5e, 0x0c, 0x07, 0x2f, 0x84, 0x43, 0x8f, 0xde, 0x2c, 0xbb, 0x29, 0x8d,
+	0x5a, 0x0c, 0x44, 0x2f, 0x7a, 0xe3, 0xe0, 0x85, 0x70, 0x68, 0xfc, 0x03, 0x96, 0xdd, 0x94, 0x8d,
-	0xd2, 0xc1, 0xdd, 0xad, 0xfe, 0x80, 0x1f, 0x6e, 0xba, 0x5d, 0x4a, 0x29, 0x82, 0xe1, 0xd6, 0x99,
+	0xb2, 0x83, 0xbb, 0xdb, 0xf8, 0x07, 0xfc, 0xe1, 0xa6, 0xdb, 0x2d, 0x16, 0x10, 0x0c, 0xb7, 0xce,
-	0x79, 0xf3, 0xde, 0xbc, 0xf6, 0x15, 0x5a, 0x31, 0x57, 0xdf, 0x28, 0xde, 0xbd, 0x85, 0x40, 0x85,
+	0xcc, 0x7b, 0xf3, 0x66, 0xfb, 0x1e, 0xb4, 0x25, 0x37, 0x9f, 0xa8, 0xde, 0xc2, 0xa5, 0x42, 0x83,
-	0xe4, 0x24, 0x44, 0x6f, 0x1e, 0x4d, 0x05, 0x7a, 0xa6, 0xef, 0x0e, 0xc3, 0x48, 0xcd, 0x92, 0xc0,
+	0xe4, 0x24, 0xc1, 0x70, 0x21, 0x66, 0x0a, 0x43, 0xd7, 0x0f, 0x46, 0x89, 0x30, 0xf3, 0x34, 0x0e,
-	0x9b, 0xe2, 0xbc, 0xaf, 0x27, 0xfd, 0x10, 0x6f, 0xb3, 0x07, 0x81, 0x89, 0xe2, 0xa2, 0xaf, 0x37,
+	0x67, 0xb8, 0x18, 0xd8, 0xc9, 0x20, 0xc1, 0xdb, 0xfc, 0x43, 0x61, 0x6a, 0xb8, 0x1a, 0x58, 0xa6,
-	0x4d, 0x91, 0xd1, 0xd0, 0x16, 0x34, 0xc7, 0x91, 0x54, 0x3e, 0xff, 0x4c, 0xb8, 0x54, 0xf4, 0x09,
+	0x2b, 0xf2, 0x35, 0xb4, 0x0d, 0xad, 0x89, 0xd0, 0x26, 0xe2, 0x1f, 0x29, 0xd7, 0x86, 0x3e, 0xc1,
-	0x8e, 0xb2, 0x52, 0x2e, 0x30, 0x96, 0x9c, 0xdc, 0x40, 0x3d, 0x46, 0xc6, 0xa5, 0x53, 0xe9, 0x54,
+	0x51, 0x5e, 0xea, 0x25, 0x4a, 0xcd, 0xc9, 0x0d, 0xd4, 0x25, 0x32, 0xae, 0xfd, 0x4a, 0xb7, 0xda,
-	0x7b, 0xcd, 0xc1, 0xb9, 0x57, 0x56, 0xf5, 0x26, 0xc8, 0xb8, 0x9f, 0x81, 0x68, 0x17, 0x4e, 0x27,
+	0x6f, 0x0d, 0xcf, 0xc3, 0x4d, 0xd5, 0x70, 0x8a, 0x8c, 0x47, 0x39, 0x88, 0xf6, 0xe0, 0x74, 0xca,
-	0x3c, 0x0a, 0x67, 0x01, 0x26, 0x62, 0x86, 0xc8, 0x0c, 0x2b, 0x39, 0x06, 0x2b, 0x62, 0x4e, 0xa5,
+	0x45, 0x32, 0x8f, 0x31, 0x55, 0x73, 0x44, 0xe6, 0xb6, 0x92, 0x63, 0xf0, 0x04, 0xf3, 0x2b, 0xdd,
-	0x53, 0xe9, 0xd9, 0xbe, 0x15, 0x31, 0xfa, 0x0a, 0x67, 0x25, 0x9c, 0x91, 0x7b, 0x4e, 0x5d, 0x16,
+	0x4a, 0xbf, 0x19, 0x79, 0x82, 0xd1, 0x17, 0x38, 0xdb, 0xc0, 0x39, 0xb9, 0x47, 0x00, 0x59, 0x0c,
-	0x06, 0x7a, 0xa7, 0x39, 0xb8, 0xf8, 0x43, 0x76, 0x09, 0xf3, 0xd7, 0x37, 0xe8, 0x17, 0xb4, 0xd6,
+	0x0a, 0xcd, 0x8b, 0x5f, 0x34, 0x0b, 0x4c, 0x54, 0x82, 0xd3, 0x3b, 0xa8, 0x65, 0xc7, 0x6c, 0xaa,
-	0xb8, 0xc9, 0x35, 0xd4, 0xd2, 0xeb, 0x0c, 0xd5, 0x36, 0x07, 0x1a, 0x43, 0x1e, 0xc1, 0xce, 0xd9,
+	0x11, 0x1f, 0x1a, 0xaf, 0x8c, 0x29, 0xae, 0xb5, 0xef, 0xd9, 0x66, 0x51, 0xd2, 0x7b, 0x68, 0x8c,
-	0x1c, 0x4b, 0x5b, 0xde, 0xa9, 0xbd, 0x42, 0xd3, 0x3b, 0xa8, 0xa5, 0x44, 0x65, 0xaf, 0xc4, 0x81,
+	0x51, 0x4a, 0x3e, 0x33, 0xe4, 0x1a, 0x6a, 0xd9, 0x1b, 0x2c, 0x6d, 0xf7, 0x3b, 0x2d, 0x86, 0x8e,
-	0xc6, 0x1b, 0x63, 0x82, 0x4b, 0xe9, 0x58, 0xba, 0xb9, 0x2c, 0xe9, 0x3d, 0x34, 0x46, 0x18, 0xc7,
+	0xa0, 0x3e, 0x7e, 0x47, 0xcd, 0x0f, 0x22, 0x21, 0x34, 0x57, 0x67, 0x1f, 0x42, 0x24, 0x0f, 0x6b,
-	0x7c, 0xaa, 0xf6, 0xb9, 0x91, 0x0e, 0xa1, 0x3e, 0xfa, 0x40, 0xc9, 0xf7, 0x5a, 0x42, 0xb0, 0xf3,
+	0xff, 0xa4, 0xba, 0xd7, 0x87, 0x12, 0x72, 0xf8, 0xe5, 0x41, 0x63, 0x9a, 0x0f, 0xc9, 0x33, 0x80,
-	0xab, 0xf7, 0x7a, 0x23, 0x0f, 0x00, 0xb9, 0x47, 0xe9, 0x54, 0x77, 0xa6, 0xa0, 0x80, 0x1c, 0xfc,
+	0xb5, 0x35, 0x73, 0x5e, 0x13, 0xff, 0x87, 0xed, 0xb2, 0xe0, 0x8c, 0x0a, 0x3a, 0x5b, 0x93, 0x72,
-	0x58, 0xd0, 0x98, 0x64, 0x43, 0xf2, 0x02, 0xa0, 0x43, 0x95, 0xe6, 0x4e, 0x12, 0x67, 0xb5, 0x6d,
+	0x1a, 0xe8, 0x3f, 0x32, 0x81, 0x66, 0xd6, 0xc9, 0xc4, 0x34, 0xe9, 0x6c, 0x5f, 0x51, 0xca, 0x52,
-	0x92, 0x68, 0x62, 0xe2, 0xb6, 0x37, 0x26, 0xc5, 0x2c, 0xd2, 0x03, 0x32, 0x06, 0x3b, 0xed, 0xa4,
+	0x70, 0xb9, 0x6b, 0xbc, 0xda, 0x16, 0x43, 0x7b, 0x2d, 0x07, 0xa4, 0xb7, 0xc7, 0xeb, 0x52, 0xa0,
-	0x62, 0x92, 0xb4, 0x37, 0xaf, 0x28, 0x24, 0xd9, 0xbd, 0xdc, 0x36, 0xce, 0xd9, 0x82, 0x72, 0x52,
+	0x82, 0xab, 0x3f, 0x71, 0x85, 0x46, 0xfc, 0xdf, 0xe6, 0x7c, 0xf4, 0x1d, 0x00, 0x00, 0xff, 0xff,
-	0xba, 0x3b, 0x3e, 0x75, 0x21, 0xce, 0xee, 0xd5, 0xbf, 0xb8, 0xa5, 0x46, 0x70, 0xa8, 0xff, 0xb2,
+	0x11, 0x41, 0xd2, 0x02, 0x3f, 0x03, 0x00, 0x00,
-	0xe1, 0x6f, 0x00, 0x00, 0x00, 0xff, 0xff, 0xcc, 0x4f, 0xab, 0x3f, 0xbd, 0x03, 0x00, 0x00,
 }

network/proto/network.proto

@@ -26,15 +26,7 @@ message NeighbourhoodRequest {
 
 // NeighbourhoodResponse contains node neighbourhood hierarchy
 message NeighbourhoodResponse {
-        Neighbour neighbourhood = 1;
+        repeated Neighbour neighbours = 1;
-}
-
-// Neighbourhood is node neighbourhood
-message Neighbourhood {
-        // network node
-        Node node = 1;
-        // node neighbours
-        repeated Neighbour neighbour = 2;
 }
 
 // Node is network node