test_public_server.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329
  1. import json
  2. import unittest
  3. from public_server import PublicMcpHttpHandler, extract_client_ip
  4. from utils.rate_limiter import SimpleRateLimiter
  5. class FakeContext:
  6. def __init__(self, gateway_session_id):
  7. self.gateway_session_id = gateway_session_id
  8. def has_session(self):
  9. return bool(self.gateway_session_id)
  10. class FakeParser:
  11. def parse(self, headers):
  12. return FakeContext(headers.get('X-Gateway-Session', ''))
  13. class FakeGateway:
  14. def __init__(self):
  15. self.calls = []
  16. self.list_calls = []
  17. self.tool_result = {'code': 'MCP_0000', 'data': {'ok': True}}
  18. def registered_tool_names(self):
  19. return ('query_order', 'query_track')
  20. def list_tools(self, gateway_session_id):
  21. self.list_calls.append(gateway_session_id)
  22. return [{'name': 'query_track', 'description': 'query track', 'input_schema': {'type': 'object'}}]
  23. def call_tool(self, gateway_session_id, name, arguments=None, request_id='', client_ip=''):
  24. self.calls.append((gateway_session_id, name, arguments, request_id, client_ip))
  25. return self.tool_result
  26. class PublicMcpHttpHandlerTest(unittest.TestCase):
  27. def test_constructor_uses_registered_names_without_loading_dynamic_list(self):
  28. gateway = FakeGateway()
  29. PublicMcpHttpHandler(gateway, context_parser=FakeParser())
  30. self.assertEqual([], gateway.list_calls)
  31. def test_handle_tools_list_passes_session_and_returns_dynamic_tools(self):
  32. gateway = FakeGateway()
  33. handler = PublicMcpHttpHandler(gateway, context_parser=FakeParser())
  34. response = handler.handle_json_rpc(
  35. headers={'X-Gateway-Session': 'GWS_A'},
  36. message={
  37. 'jsonrpc': '2.0',
  38. 'id': 2,
  39. 'method': 'tools/list',
  40. 'params': {},
  41. },
  42. client_ip='10.0.0.5',
  43. )
  44. self.assertEqual(['GWS_A'], gateway.list_calls)
  45. self.assertEqual(
  46. ['query_track'],
  47. [tool['name'] for tool in response['result']['tools']],
  48. )
  49. self.assertIn('inputSchema', response['result']['tools'][0])
  50. def test_missing_session_on_tools_list_returns_protocol_error(self):
  51. gateway = FakeGateway()
  52. handler = PublicMcpHttpHandler(gateway, context_parser=FakeParser())
  53. response = handler.handle_json_rpc(
  54. headers={},
  55. message={
  56. 'jsonrpc': '2.0',
  57. 'id': 3,
  58. 'method': 'tools/list',
  59. 'params': {},
  60. },
  61. client_ip='10.0.0.5',
  62. )
  63. self.assertEqual(-32000, response['error']['code'])
  64. self.assertIn('Workbuddy', response['error']['message'])
  65. self.assertEqual([], gateway.list_calls)
  66. def test_handle_tools_call_passes_gateway_session_to_public_gateway(self):
  67. gateway = FakeGateway()
  68. handler = PublicMcpHttpHandler(gateway, context_parser=FakeParser())
  69. response = handler.handle_json_rpc(
  70. headers={'X-Gateway-Session': 'GWS_A'},
  71. message={
  72. 'jsonrpc': '2.0',
  73. 'id': 1,
  74. 'method': 'tools/call',
  75. 'params': {
  76. 'name': 'query_order',
  77. 'arguments': {'keyword': 'USC'},
  78. },
  79. },
  80. client_ip='10.0.0.5'
  81. )
  82. self.assertEqual(False, response['result']['isError'])
  83. self.assertEqual('GWS_A', gateway.calls[0][0])
  84. self.assertEqual('query_order', gateway.calls[0][1])
  85. self.assertEqual('10.0.0.5', gateway.calls[0][4])
  86. def test_backend_business_error_returns_tool_error_result(self):
  87. gateway = FakeGateway()
  88. gateway.tool_result = {
  89. 'code': 'MCP_1401',
  90. 'msg': 'invalid exact order query conditions',
  91. 'data': [],
  92. 'meta': {'request_id': 'rq_backend'},
  93. }
  94. handler = PublicMcpHttpHandler(gateway, context_parser=FakeParser())
  95. response = handler.handle_json_rpc(
  96. headers={'X-Gateway-Session': 'GWS_A'},
  97. message={
  98. 'jsonrpc': '2.0',
  99. 'id': 7,
  100. 'method': 'tools/call',
  101. 'params': {
  102. 'name': 'query_order',
  103. 'arguments': {'keyword': 'USC'},
  104. },
  105. },
  106. client_ip='10.0.0.5',
  107. )
  108. self.assertNotIn('error', response)
  109. self.assertTrue(response['result']['isError'])
  110. self.assertIn('MCP_1401', response['result']['content'][0]['text'])
  111. self.assertEqual(
  112. {
  113. 'code': 'MCP_1401',
  114. 'msg': 'invalid exact order query conditions',
  115. 'meta': {'request_id': 'rq_backend'},
  116. },
  117. response['result']['structuredContent'],
  118. )
  119. def test_query_track_success_uses_safe_public_output(self):
  120. gateway = FakeGateway()
  121. gateway.tool_result = {
  122. 'code': 'MCP_0000',
  123. 'data': {
  124. 'summary': '共 1 条轨迹',
  125. 'columns': [
  126. {'key': 'status', 'name': '轨迹节点'},
  127. {'key': 'tracking_number', 'name': '快递单号'},
  128. ],
  129. 'records': [{
  130. 'status': '已发货',
  131. 'tracking_number': 'TN-PUBLIC',
  132. 'time_zone': '8.00',
  133. }],
  134. },
  135. 'meta': {'request_id': 'rq_public', 'page': 1, 'limit': 5},
  136. }
  137. handler = PublicMcpHttpHandler(gateway, context_parser=FakeParser())
  138. response = handler.handle_json_rpc(
  139. headers={'X-Gateway-Session': 'GWS_A'},
  140. message={
  141. 'jsonrpc': '2.0',
  142. 'id': 8,
  143. 'method': 'tools/call',
  144. 'params': {
  145. 'name': 'query_track',
  146. 'arguments': {'tracking_number': 'TN-PUBLIC'},
  147. },
  148. },
  149. client_ip='10.0.0.5',
  150. )
  151. serialized = json.dumps(response['result'], ensure_ascii=False)
  152. self.assertFalse(response['result']['isError'])
  153. self.assertNotIn('tracking_number', serialized)
  154. self.assertNotIn('time_zone', serialized)
  155. self.assertIn('快递单号', serialized)
  156. self.assertIn('TN-PUBLIC', serialized)
  157. self.assertEqual('rq_public', response['result']['_meta']['request_id'])
  158. def test_missing_session_on_tool_call_returns_error_content(self):
  159. gateway = FakeGateway()
  160. handler = PublicMcpHttpHandler(gateway, context_parser=FakeParser())
  161. response = handler.handle_json_rpc(
  162. headers={},
  163. message={
  164. 'jsonrpc': '2.0',
  165. 'id': 1,
  166. 'method': 'tools/call',
  167. 'params': {'name': 'query_order', 'arguments': {'keyword': 'USC'}},
  168. },
  169. )
  170. self.assertTrue(response['result']['isError'])
  171. self.assertIn(
  172. '这台设备的 Workbuddy 配置已失效,请重新生成配置',
  173. response['result']['content'][0]['text'],
  174. )
  175. def test_non_object_tool_params_fail_safely(self):
  176. gateway = FakeGateway()
  177. handler = PublicMcpHttpHandler(gateway, context_parser=FakeParser())
  178. response = handler.handle_json_rpc(
  179. headers={'X-Gateway-Session': 'GWS_A'},
  180. message={
  181. 'jsonrpc': '2.0',
  182. 'id': 9,
  183. 'method': 'tools/call',
  184. 'params': 'not-an-object',
  185. },
  186. client_ip='10.0.0.5',
  187. )
  188. self.assertTrue(response['result']['isError'])
  189. self.assertEqual(
  190. '工具返回格式异常',
  191. response['result']['structuredContent']['message'],
  192. )
  193. self.assertEqual([], gateway.calls)
  194. def test_extract_client_ip_ignores_spoofable_forwarded_for_header(self):
  195. client_ip = extract_client_ip(
  196. {'X-Forwarded-For': '203.0.113.9'},
  197. ('10.0.0.5', 54321),
  198. )
  199. self.assertEqual('10.0.0.5', client_ip)
  200. class RateLimitTest(unittest.TestCase):
  201. def _make_handler(self, max_requests=2):
  202. gateway = FakeGateway()
  203. limiter = SimpleRateLimiter(max_requests=max_requests, window_seconds=60)
  204. return PublicMcpHttpHandler(gateway, context_parser=FakeParser(), rate_limiter=limiter)
  205. def _tools_call_msg(self, tool_name='query_order'):
  206. return {
  207. 'jsonrpc': '2.0', 'id': 1,
  208. 'method': 'tools/call',
  209. 'params': {'name': tool_name, 'arguments': {'keyword': 'test'}},
  210. }
  211. # --- tools/call per-tool独立限流 ---
  212. def test_known_tool_rate_limited_after_quota_exhausted(self):
  213. handler = self._make_handler(max_requests=1)
  214. handler.handle_json_rpc({'X-Gateway-Session': 'GWS_A'}, self._tools_call_msg(), client_ip='1.2.3.4')
  215. response = handler.handle_json_rpc({'X-Gateway-Session': 'GWS_A'}, self._tools_call_msg(), client_ip='1.2.3.4')
  216. self.assertIn('error', response)
  217. self.assertIn('Rate limit', response['error']['message'])
  218. def test_two_known_tools_have_independent_quotas(self):
  219. # query_order 限流不影响 query_track
  220. handler = self._make_handler(max_requests=1)
  221. handler.handle_json_rpc({'X-Gateway-Session': 'GWS_A'}, self._tools_call_msg('query_order'), client_ip='1.2.3.4')
  222. # query_order quota exhausted, query_track should still work
  223. response = handler.handle_json_rpc({'X-Gateway-Session': 'GWS_A'}, self._tools_call_msg('query_track'), client_ip='1.2.3.4')
  224. self.assertNotIn('error', response)
  225. def test_unknown_tool_name_uses_shared_session_bucket_not_new_bucket(self):
  226. # 未知工具名应归入 session_id 桶,同一会话的不同未知工具共享同一配额,不能无限新建桶
  227. handler = self._make_handler(max_requests=1)
  228. # 先用 session 桶打一次(用未知工具名触发)
  229. handler.handle_json_rpc({'X-Gateway-Session': 'GWS_A'}, self._tools_call_msg('fake_tool_1'), client_ip='1.2.3.4')
  230. # 再用同会话的另一个未知工具名,应该命中同一个 session 桶,被限流
  231. response = handler.handle_json_rpc({'X-Gateway-Session': 'GWS_A'}, self._tools_call_msg('fake_tool_2'), client_ip='1.2.3.4')
  232. self.assertIn('error', response)
  233. self.assertIn('Rate limit', response['error']['message'])
  234. def test_different_sessions_have_independent_quotas(self):
  235. # 不同会话(不同员工)即使来自同一IP,也拥有独立的配额
  236. handler = self._make_handler(max_requests=1)
  237. handler.handle_json_rpc({'X-Gateway-Session': 'GWS_A'}, self._tools_call_msg(), client_ip='1.1.1.1')
  238. # 不同 session,即使同一 IP,quota 独立 → 应该允许
  239. response = handler.handle_json_rpc({'X-Gateway-Session': 'GWS_B'}, self._tools_call_msg(), client_ip='1.1.1.1')
  240. self.assertNotIn('error', response)
  241. def test_same_session_from_different_ips_shares_quota(self):
  242. # 同一会话从不同IP发来(如移动网络切换),仍共享同一会话配额
  243. handler = self._make_handler(max_requests=1)
  244. handler.handle_json_rpc({'X-Gateway-Session': 'GWS_A'}, self._tools_call_msg(), client_ip='1.1.1.1')
  245. # 同 session,不同 IP → 命中同一 session 桶,被限流
  246. response = handler.handle_json_rpc({'X-Gateway-Session': 'GWS_A'}, self._tools_call_msg(), client_ip='2.2.2.2')
  247. self.assertIn('error', response)
  248. self.assertIn('Rate limit', response['error']['message'])
  249. # --- initialize 不受限流,tools/list 有独立 bucket ---
  250. def test_initialize_is_never_rate_limited(self):
  251. # initialize 是握手协议,无论请求多少次都不应被限流
  252. handler = self._make_handler(max_requests=1)
  253. for i in range(5):
  254. response = handler.handle_json_rpc({}, {'jsonrpc': '2.0', 'id': i, 'method': 'initialize'}, client_ip='1.2.3.4')
  255. self.assertNotIn('error', response, f'initialize should never be rate limited (attempt {i})')
  256. self.assertIn('protocolVersion', response['result'])
  257. def test_tools_list_is_rate_limited(self):
  258. handler = self._make_handler(max_requests=1)
  259. headers = {'X-Gateway-Session': 'GWS_A'}
  260. handler.handle_json_rpc(headers, {'jsonrpc': '2.0', 'id': 1, 'method': 'tools/list'}, client_ip='1.2.3.4')
  261. response = handler.handle_json_rpc(headers, {'jsonrpc': '2.0', 'id': 2, 'method': 'tools/list'}, client_ip='1.2.3.4')
  262. self.assertIn('error', response)
  263. self.assertIn('Rate limit', response['error']['message'])
  264. def test_tools_list_quota_independent_from_tools_call_quota(self):
  265. # tools/list 和 tools/call 使用不同 bucket,互不影响
  266. handler = self._make_handler(max_requests=1)
  267. # 用掉 tools/list 的1个 slot
  268. handler.handle_json_rpc({'X-Gateway-Session': 'GWS_A'}, {'jsonrpc': '2.0', 'id': 1, 'method': 'tools/list'}, client_ip='1.2.3.4')
  269. # tools/call 应仍可正常执行(使用独立的 client_ip:tool_name bucket)
  270. response = handler.handle_json_rpc(
  271. {'X-Gateway-Session': 'GWS_A'},
  272. {'jsonrpc': '2.0', 'id': 2, 'method': 'tools/call',
  273. 'params': {'name': 'query_order', 'arguments': {'keyword': 'test'}}},
  274. client_ip='1.2.3.4',
  275. )
  276. self.assertNotIn('error', response)
  277. if __name__ == '__main__':
  278. unittest.main()