[explorer/nodewatch]: Added query params for get node list endpoint

Author: AnthonyLaw

explorer/nodewatch/nodewatch/RoutesFacade.py

@@ -1,5 +1,6 @@
 import asyncio
 import datetime
+import random
 
 from zenlog import log
 
@@ -68,15 +69,35 @@ def html_nodes(self):
 			'explorer_endpoint': self.explorer_endpoint
 		})
 
-	def json_nodes(self, role, exact_match=False):
-		"""Returns all nodes with matching role."""
+	def json_nodes(self, **kwargs):
+		"""Returns all nodes with condition."""
 
-		def role_filter(descriptor):
-			return role == descriptor.roles if exact_match else role == (role & descriptor.roles)
+		role = kwargs.get('role')
+		exact_match = kwargs.get('exact_match')
 
-		return list(map(
+		limit = kwargs.get('limit')
+		only_ssl = kwargs.get('only_ssl')
+		order = kwargs.get('order')
+
+		def custom_filter(descriptor):
+			role_condition = True
+
+			if role is not None:
+				role_condition = role == descriptor.roles if exact_match else role == (role & descriptor.roles)
+
+			if only_ssl:
+				return role_condition and descriptor.is_ssl_enabled
+
+			return role_condition
+
+		nodes = list(map(
 			lambda descriptor: descriptor.to_json(),
-			filter(role_filter, self.repository.node_descriptors)))
+			filter(custom_filter, self.repository.node_descriptors)))
+
+		if order == 'random':
+			random.shuffle(nodes)
+
+		return nodes if limit == 0 else nodes[:limit]
 
 	def json_node(self, filter_field, public_key):
 		"""Returns a node with matching main or node public key."""

explorer/nodewatch/nodewatch/__init__.py

@@ -61,7 +61,7 @@ def nem_summary():  # pylint: disable=unused-variable
 
 	@app.route('/api/nem/nodes')
 	def api_nem_nodes():  # pylint: disable=unused-variable
-		return jsonify(nem_routes_facade.json_nodes(1))
+		return jsonify(nem_routes_facade.json_nodes(role=1))
 
 	@app.route('/api/nem/chart/height')
 	def api_nem_chart_height():  # pylint: disable=unused-variable
@@ -91,6 +91,17 @@ def symbol_summary():  # pylint: disable=unused-variable
 		template_name, context = symbol_routes_facade.html_summary()
 		return render_template(template_name, **context)
 
+	def _get_json_nodes(role, exact_match, request_args):
+		only_ssl = None
+		if 'only_ssl' in request_args:
+			only_ssl = True
+
+		order = request_args.get('order', None)
+
+		limit = int(request_args.get('limit', 0))
+
+		return jsonify(symbol_routes_facade.json_nodes(role=role, exact_match=exact_match, only_ssl=only_ssl, limit=limit, order=order))
+
 	def _get_json_node(result):
 		if not result:
 			abort(404)
@@ -105,11 +116,11 @@ def _validate_public_key(public_key):
 
 	@app.route('/api/symbol/nodes/api')
 	def api_symbol_nodes_api():  # pylint: disable=unused-variable
-		return jsonify(symbol_routes_facade.json_nodes(2, exact_match=True))
+		return _get_json_nodes(2, True, request.args)
 
 	@app.route('/api/symbol/nodes/peer')
 	def api_symbol_nodes_peer():  # pylint: disable=unused-variable
-		return jsonify(symbol_routes_facade.json_nodes(1))
+		return _get_json_nodes(1, False, request.args)
 
 	@app.route('/api/symbol/nodes/mainPublicKey/<main_public_key>')
 	def api_symbol_nodes_get_main_public_key(main_public_key):  # pylint: disable=unused-variable

explorer/nodewatch/tests/test_RoutesFacade.py

@@ -150,7 +150,7 @@ def test_can_generate_nodes_json(self):
 		facade.reload_all(Path('tests/resources'), True)
 
 		# Act:
-		node_descriptors = facade.json_nodes(1)
+		node_descriptors = facade.json_nodes(role=1)
 
 		# Assert: spot check names and roles
 		self.assertEqual(4, len(node_descriptors))
@@ -361,7 +361,7 @@ def test_can_generate_nodes_json(self):
 		facade.reload_all(Path('tests/resources'), True)
 
 		# Act:
-		node_descriptors = facade.json_nodes(1)
+		node_descriptors = facade.json_nodes(role=1)
 
 		# Assert: spot check names and roles
 		self.assertEqual(5, len(node_descriptors))
@@ -378,7 +378,7 @@ def test_can_generate_nodes_json_filtered(self):
 		facade.reload_all(Path('tests/resources'), True)
 
 		# Act: select nodes with api role (role 2)
-		node_descriptors = facade.json_nodes(2)
+		node_descriptors = facade.json_nodes(role=2)
 
 		# Assert: spot check names and roles
 		self.assertEqual(5, len(node_descriptors))
@@ -395,7 +395,7 @@ def test_can_generate_nodes_json_filtered_exact_match(self):
 		facade.reload_all(Path('tests/resources'), True)
 
 		# Act: select nodes with only api role (role 2)
-		node_descriptors = facade.json_nodes(2, True)
+		node_descriptors = facade.json_nodes(role=2, exact_match=True)
 
 		# Assert: spot check names and roles
 		self.assertEqual(1, len(node_descriptors))
@@ -406,6 +406,56 @@ def test_can_generate_nodes_json_filtered_exact_match(self):
 			[2],
 			list(map(lambda descriptor: descriptor['roles'], node_descriptors)))
 
+	def test_can_generate_nodes_json_filtered_only_ssl(self):
+		# Arrange:
+		facade = SymbolRoutesFacade(SymbolNetwork.MAINNET, '<symbol_explorer>')
+		facade.reload_all(Path('tests/resources'), True)
+
+		# Act: select nodes with only ssl enabled
+		node_descriptors = facade.json_nodes(only_ssl=True)
+
+		# Assert: spot check names and roles
+		self.assertEqual(2, len(node_descriptors))
+		self.assertEqual(
+			['Allnodes250', 'ibone74'],
+			list(map(lambda descriptor: descriptor['name'], node_descriptors)))
+
+	def test_can_generate_nodes_json_filtered_order_random_subset(self):
+		# Arrange:
+		facade = SymbolRoutesFacade(SymbolNetwork.MAINNET, '<symbol_explorer>')
+		facade.reload_all(Path('tests/resources'), True)
+
+		# Act: select 2 nodes with order random
+		node_descriptors = facade.json_nodes(limit=2, order='random')
+
+		# Assert:
+		all_node_descriptors = facade.json_nodes()
+
+		full_node_names = list(map(lambda descriptor: descriptor['name'], all_node_descriptors))
+		random_node_names = list(map(lambda descriptor: descriptor['name'], node_descriptors))
+
+		self.assertEqual(2, len(node_descriptors))
+		self.assertEqual(2, len(set(random_node_names)))
+		for name in random_node_names:
+			self.assertIn(name, full_node_names)
+
+	def test_can_generate_nodes_json_filtered_limit_5(self):
+		# Arrange:
+		facade = SymbolRoutesFacade(SymbolNetwork.MAINNET, '<symbol_explorer>')
+		facade.reload_all(Path('tests/resources'), True)
+
+		# Act:
+		node_descriptors = facade.json_nodes(limit=5)
+
+		# Assert: spot check names
+		self.assertEqual(5, len(node_descriptors))
+		self.assertEqual(
+			['Allnodes250', 'Apple', 'Shin-Kuma-Node', 'ibone74', 'jaguar'],
+			list(map(lambda descriptor: descriptor['name'], node_descriptors)))
+		self.assertEqual(
+			[2, 7, 3, 3, 5],
+			list(map(lambda descriptor: descriptor['roles'], node_descriptors)))
+
 	def test_can_find_known_node_by_main_public_key(self):  # pylint: disable=invalid-name
 		# Arrange:
 		facade = SymbolRoutesFacade(SymbolNetwork.MAINNET, '<symbol_explorer>')