forked from FISCO-BCOS/python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathchannelhandler.py
More file actions
472 lines (425 loc) · 19.5 KB
/
channelhandler.py
File metadata and controls
472 lines (425 loc) · 19.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
#!/usr/bin/env python
# -*- coding: utf-8 -*-
'''
bcosliteclientpy is a python client for FISCO BCOS2.0 (https://github.com/FISCO-BCOS/)
bcosliteclientpy is free software: you can redistribute it and/or modify it under the
terms of the MIT License as published by the Free Software Foundation. This project is
distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. Thanks for
authors and contributors of eth-abi, eth-account, eth-hash,eth-keys, eth-typing, eth-utils,
rlp, eth-rlp , hexbytes ... and relative projects
@author: kentzhang
@date: 2019-06
channel protocol ref:
https://fisco-bcos-documentation.readthedocs.io/zh_CN/release-2.0/docs/design/protocol_description.html#channelmessage
'''
import queue
import threading
from queue import Empty
from pymitter import EventEmitter
from promise import Promise
import time
import itertools
import ssl
import json
import socket
from client.channelpack import ChannelPack
from utils.encoding import FriendlyJsonSerde
from client.bcoserror import BcosError, ChannelException
from eth_utils import (to_text, to_bytes)
class ChannelHandler(threading.Thread):
context = None
CA_File = None
node_crt_file = None
node_key_file = None
ECDH_curve = "secp256k1"
ssock = None
host = None
port = None
request_counter = itertools.count()
logger = None
recvThread = None
sendThread = None
def __init__(self, max_timeout=10, name="channelHandler"):
self.timeout = max_timeout
threading.Thread.__init__(self)
self.callbackEmitter = EventEmitter()
self.requests = []
self.name = name
self.blockNumber = 0
self.onResponsePrefix = "onResponse"
self.getResultPrefix = "getResult"
self.lock = threading.RLock()
def initTLSContext(self, ca_file, node_crt_file, node_key_file,
protocol=ssl.PROTOCOL_TLSv1_2,
verify_mode=ssl.CERT_REQUIRED):
try:
context = ssl.SSLContext(protocol)
context.check_hostname = False
context.load_verify_locations(ca_file)
context.load_cert_chain(node_crt_file, node_key_file)
# print(context.get_ca_certs())
context.set_ecdh_curve(self.ECDH_curve)
context.verify_mode = verify_mode
self.context = context
except Exception as e:
raise ChannelException(("init ssl context failed,"
" please check the certificatsreason: {}").
format(e))
def __del__(self):
self.finish()
def finish(self):
if self.ssock is not None:
self.ssock.shutdown(socket.SHUT_RDWR)
self.ssock.close()
self.ssock = None
if self.keepWorking is True:
self.keepWorking = False
self.join(timeout=1)
if self.recvThread is not None:
self.recvThread.finish()
self.recvThread.join(timeout=2)
if self.sendThread is not None:
self.sendThread.finish()
self.sendThread.join(timeout=2)
def run(self):
try:
self.keepWorking = True
self.logger.debug(self.name + ":start thread-->")
while self.keepWorking:
try:
responsepack = self.recvThread.recvQueue.get_nowait() # pop msg from queue
if responsepack is None and self.keepWorking:
time.sleep(0.001)
continue
emitter_str = ChannelHandler.getEmitterStr(self.onResponsePrefix,
responsepack.seq, responsepack.type)
if emitter_str in self.requests:
self.lock.acquire()
self.callbackEmitter.emit(emitter_str, responsepack)
self.lock.release()
except Empty:
time.sleep(0.001)
except Exception as e:
self.logger.error("{} recv error {}".format(self.name, e))
finally:
self.logger.debug("{}:thread finished ,keepWorking = {}".format(
self.name, self.keepWorking))
def start_channel(self, host, port):
try:
self.keepWorking = False
self.host = host
self.port = port
sock = socket.create_connection((host, port))
self.logger.debug("connect {}:{},as socket {}".format(host, port, sock))
# 将socket打包成SSL socket
ssock = self.context.wrap_socket(sock)
self.ssock = ssock
self.recvThread = ChannelRecvThread(self)
self.recvThread.start()
self.sendThread = ChannelSendThread(self)
self.sendThread.start()
super().start()
except Exception as e:
raise ChannelException(("start channelHandler Failed for {},"
" host: {}, port: {}").format(e,
self.host, self.port))
def decode_rpc_response(self, response):
text_response = to_text(response)
return FriendlyJsonSerde().json_decode(text_response)
def encode_rpc_request(self, method, params):
rpc_dict = {
"jsonrpc": "2.0",
"method": method,
"params": params or [],
"id": next(self.request_counter),
}
encoded = FriendlyJsonSerde().json_encode(rpc_dict)
return to_bytes(text=encoded)
'''
result:
0 成功
100 节点不可达
101 SDK不可达
102 超时
'''
errorMsg = dict()
errorMsg[0] = "success"
errorMsg[100] = "node unreachable"
errorMsg[101] = "sdk unreachable"
errorMsg[102] = "timeout"
def make_request(self, method, params, packet_type=ChannelPack.TYPE_RPC,
response_type=ChannelPack.TYPE_RPC):
rpc_data = self.encode_rpc_request(method, params)
self.logger.debug("request rpc_data : {}".format(rpc_data))
seq = ChannelPack.make_seq32()
request_pack = ChannelPack(packet_type, seq, 0, rpc_data)
self.send_pack(request_pack)
onresponse_emitter_str = ChannelHandler.getEmitterStr(self.onResponsePrefix,
seq, response_type)
# register onResponse emitter
self.lock.acquire()
self.callbackEmitter.on(onresponse_emitter_str, self.onResponse)
self.lock.release()
self.requests.append(onresponse_emitter_str)
# register onResponse emitter of RPC
rpc_onresponse_emitter_str = None
rpc_result_emitter_str = None
if response_type is ChannelPack.TYPE_TX_COMMITTED:
rpc_onresponse_emitter_str = ChannelHandler.getEmitterStr(self.onResponsePrefix,
seq, ChannelPack.TYPE_RPC)
self.requests.append(rpc_onresponse_emitter_str)
rpc_result_emitter_str = ChannelHandler.getEmitterStr(self.getResultPrefix,
seq, ChannelPack.TYPE_RPC)
self.lock.acquire()
self.callbackEmitter.on(rpc_onresponse_emitter_str, self.onResponse)
self.lock.release()
emitter_str = ChannelHandler.getEmitterStr(self.getResultPrefix,
seq, response_type)
def resolve_promise(resolve, reject):
"""
resolve promise
"""
# register getResult emitter
self.lock.acquire()
self.callbackEmitter.on(emitter_str, (lambda result, is_error: resolve(result)))
# 1. if send transaction failed, return the error message directly
# and erase the registered 0x1002 emitter
# 2. if send transaction success, remove the registered 0x12 emitter
if rpc_result_emitter_str is not None:
self.callbackEmitter.on(
rpc_result_emitter_str,
(lambda result, is_error:
resolve(result) and self.requests.remove(onresponse_emitter_str)
if is_error is True else self.requests.remove(rpc_onresponse_emitter_str)
if self.requests.count(rpc_onresponse_emitter_str) else None))
self.lock.release()
p = Promise(resolve_promise)
# default timeout is 60s
return p.get(60)
def setBlockNumber(self, blockNumber):
"""
init block number
"""
self.blockNumber = blockNumber
def getBlockNumber(self, groupId):
"""
get block number notify
"""
block_notify_emitter = ChannelHandler.getEmitterStr(self.onResponsePrefix,
ChannelPack.get_seq_zero(),
ChannelPack.TYPE_TX_BLOCKNUM)
self.callbackEmitter.on(block_notify_emitter, self.onResponse)
self.logger.debug("block notify emitter: {}".format(block_notify_emitter))
self.requests.append(block_notify_emitter)
seq = ChannelPack.make_seq32()
topic = json.dumps(["_block_notify_{}".format(groupId)])
request_pack = ChannelPack(ChannelPack.TYPE_TOPIC_REPORT, seq, 0, topic)
self.send_pack(request_pack)
@staticmethod
def getEmitterStr(prefix, seq, response_type):
"""
get emitter str
"""
return "{}_{}_{}".format(prefix, str(seq), str(response_type))
def onResponse(self, responsepack):
"""
obtain the response of given type
"""
result = responsepack.result
data = responsepack.data.decode("utf-8")
# get onResponse emitter
onresponse_emitter = ChannelHandler.getEmitterStr(self.onResponsePrefix,
responsepack.seq, responsepack.type)
if onresponse_emitter in self.requests:
self.requests.remove(onresponse_emitter)
emitter_str = ChannelHandler.getEmitterStr(self.getResultPrefix,
responsepack.seq, responsepack.type)
self.logger.debug("onResponse, emitter: {}".format(emitter_str))
if result != 0:
self.logger.error("response from server failed , seq: {}, type:{}, result: {}".
format(responsepack.seq, responsepack.type, result))
self.callbackEmitter.emit(emitter_str, result, True)
return
try:
# json packet
if responsepack.type == ChannelPack.TYPE_RPC or \
responsepack.type == ChannelPack.TYPE_TX_COMMITTED:
response = FriendlyJsonSerde().json_decode(data)
response_item = None
error_status = False
if 'error' in response.keys():
error_status = True
response_item = dict()
response_item["result"] = response
elif "result" not in response.keys():
response_item = dict()
response_item["result"] = response
else:
response_item = response
self.callbackEmitter.emit(emitter_str, response_item, error_status)
self.logger.debug("response from server , seq: {}, type:{}".
format(responsepack.seq, responsepack.type))
# block notify
elif responsepack.type == ChannelPack.TYPE_TX_BLOCKNUM:
number = int(data.split(',')[1], 10)
self.logger.debug("receive block notify: seq: {} type:{}".
format(responsepack.seq, responsepack.type))
if self.blockNumber < number:
self.blockNumber = number
self.logger.debug("currentBlockNumber: {}".format(self.blockNumber))
except Exception as e:
self.logger.error("decode response failed, seq:{}, type:{}, error info: {}"
.format(responsepack.seq, responsepack.type, e))
error_msg = "decode response failed, seq:{}, type:{}, message: {}".format(
responsepack.seq, responsepack.type, result)
self.callbackEmitter.emit(emitter_str, error_msg, True)
def send_pack(self, pack):
if self.sendThread.packQueue.full():
self.logger.error("channel send Queue full!")
raise BcosError(-1, None, "channel send Queue full!")
self.sendThread.packQueue.put(pack)
# --------------------------------------------------------------------
# --------------------------------------------------------------------
# thread: channel reading
# --------------------------------------------------------------------
# --------------------------------------------------------------------
class ChannelRecvThread(threading.Thread):
QUEUE_SIZE = 1024 * 1024 * 10
channelHandler = None
keepWorking = True
# threadLock = threading.RLock()
logger = None
def __init__(self, handler, name="ChannelRecvThread"):
threading.Thread.__init__(self)
# self.threadID = threadID
self.name = name
self.recvQueue = queue.Queue(ChannelRecvThread.QUEUE_SIZE)
self.channelHandler = handler
self.logger = handler.logger
respbuffer = bytearray() # a buffer append by read, consume by decode
def read_channel(self):
# 接收服务端返回的信息
try:
self.logger.debug("{} channelHandler.ssock.recv begin.".format(self.name))
msg = self.channelHandler.ssock.recv(1024 * 1024 * 10)
self.logger.debug("channelHandler.ssock.recv len:{}".format(len(msg)))
if msg is None:
return -1
if len(msg) == 0:
return 0
except Exception as e:
self.logger.error("{}:ssock read error {}".format(self.name, e))
return -1
self.respbuffer += msg
# if no enough data even for header ,continue to read
if len(self.respbuffer) < ChannelPack.getheaderlen():
return len(msg)
code = 0
# decode all packs in buffer from node,maybe got N packs on one read
# -1 means no enough bytes for decode, should break to continue read and wait
while code != -1:
(code, decodelen, responsePack) = ChannelPack.unpack(bytes(self.respbuffer))
if decodelen > 0:
# cut the buffer from last decode pos
self.respbuffer = self.respbuffer[decodelen:]
if code != -1 and responsePack is not None: # got a pack
# print("get a pack from node, put to queue {}".format(responsePack.detail()))
self.logger.debug("{}:pack from node, put queue(qsize{}),detail {}".format(
self.name, self.recvQueue.qsize(), responsePack.detail()))
if self.recvQueue.full():
self.recvQueue.get() # if queue full ,pop the head item ,!! the item LOST
self.logger.error("{}:queue {} FULL pop and LOST: {}".format(
self.name, responsePack.type, responsePack.detail()))
self.recvQueue.put(responsePack)
# self.print_queue()
return len(msg)
def finish(self):
self.keepWorking = False
def run(self):
# lockres = ChannelRecvThread.threadLock.acquire(blocking=False)
# if lockres is False: # other thread has got the lock and running
# print(self.name + ":other thread has got the lock and running ")
# self.logger.error(self.name + ":other thread has got the lock and running ")
# return
try:
self.keepWorking = True
self.logger.debug(self.name + ":start thread-->")
while self.keepWorking:
bytesread = self.read_channel()
if self.keepWorking is False:
break
if bytesread == 0: # if async read, maybe return 0
time.sleep(0.1)
if bytesread < 0: # error accord when read
time.sleep(1)
except Exception as e:
self.logger.error("{} recv error {}".format(self.name, e))
finally:
self.logger.debug("{}:thread finished ,keepWorking = {}".format(
self.name, self.keepWorking))
# ChannelRecvThread.threadLock.release()
# -----------------------------------------------------------
# -----------------------------------------------------------
# send thread begin
# -----------------------------------------------------------
# -----------------------------------------------------------
class ChannelSendThread(threading.Thread):
QUEUE_SIZE = 1024 * 1024 * 10
channelHandler = None
packQueue = None
keepWorking = True
# threadLock = threading.RLock()
heatbeatStamp = 3 # heatbeat very N sec
logger = None
def sendpack(self, pack):
if self.packQueue.full():
raise BcosError(-1, None, "sendThread Queue full")
self.packQueue.put(pack)
def __init__(self, handler, name="ChannelSendThread"):
threading.Thread.__init__(self)
self.name = "channelSendThread"
self.channelHandler = handler
self.packQueue = queue.Queue(ChannelSendThread.QUEUE_SIZE)
self.logger = handler.logger
lastheatbeattime = time.time()
def check_heatbeat(self):
if time.time() - self.lastheatbeattime < self.heatbeatStamp:
return
pack = ChannelPack(ChannelPack.TYPE_HEATBEAT,
ChannelPack.make_seq32(), 0, bytes("", "utf-8"))
self.sendpack(pack)
self.lastheatbeattime = time.time()
def finish(self):
self.keepWorking = False
def run(self):
# lockres = ChannelSendThread.threadLock.acquire(blocking=False)
# if lockres is False: # other thread has got the lock and running
# print(self.name + ":other thread has got the lock and running ")
# return
try:
self.keepWorking = True
self.logger.debug(self.name + ":start thread-->")
while self.keepWorking:
try:
pack = self.packQueue.get(block=True, timeout=0.2)
except Empty:
self.check_heatbeat()
continue
self.lastheatbeattime = time.time() # reset heatbeat time
self.logger.debug("{} send pack {}".format(self.name, pack.detail()))
# print("{} send pack {}".format(self.name,pack.detail()))
buffer = pack.pack()
try:
res = self.channelHandler.ssock.send(buffer)
if res < 0:
self.logger.error("{}:ssock send error {}".format(self.name, res))
except Exception as e:
self.logger.error("{}:ssock send error {}".format(self.name, e))
except Exception as e:
self.logger.error("{}:ssock send error {}".format(self.name, e))
# self.logger.error(traceback.format_exc())
finally:
self.logger.debug("{}:thread finished ,keepWorking = {}".format(
self.name, self.keepWorking))
# ChannelSendThread.threadLock.release()