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
|
from collections import namedtuple
from flask import request
from functools import wraps
from geventwebsocket.handler import WebSocketHandler
import inspect
import logging
from socketio import socketio_manage
from socketio.server import SocketIOHandler
from socketio.server import SocketIOServer
from model.graph import Attr_Diff, Topo_Diff
from rz_api_websocket import WebSocket_Graph_NS
from rz_kernel import RZ_Kernel
from rz_req_handling import make_response__http__empty,\
HTTP_STATUS__500_INTERNAL_SERVER_ERROR, make_response__json
from rz_api_rest import Req_Context
log = logging.getLogger('rhizi')
class RZ_WebSocket_Server(SocketIOServer):
"""
Rhizi customized SocketIOServer:
- allow response header injection on websocket connections
"""
class RZ_SocketIOHandler(SocketIOHandler):
def __init__(self, config, *args, **kwargs):
SocketIOHandler.__init__(self, config, *args, **kwargs)
def start_response(self, status, headers, exc_info=None):
# headers['Access-Control-Allow-Origin'] = '*'
return SocketIOHandler.start_response(self, status, headers, exc_info)
def handle_disconnect_request(self):
SocketIOHandler.handle_disconnect_request(self)
class RZ_WebSocketHandler(WebSocketHandler):
def __init__(self, socket, address, server, rfile=None):
WebSocketHandler.__init__(self, socket, address, server, rfile=rfile)
def upgrade_connection(self):
return WebSocketHandler.upgrade_connection(self)
def upgrade_websocket(self):
return WebSocketHandler.upgrade_websocket(self)
def __init__ (self, cfg, wsgi_app):
self.wsgi_app = wsgi_app
SocketIOServer.__init__(self,
(cfg.listen_address, cfg.listen_port),
wsgi_app,
resource='socket.io', # URL prefix for socket.io requests
policy_server=False,
handler_class=RZ_WebSocket_Server.RZ_SocketIOHandler,
ws_handler_class=RZ_WebSocket_Server.RZ_WebSocketHandler)
def log_multicast(self, msg_name):
multicast_size = len(self.sockets) - 1 # subtract self socket
log.info('ws: multicast: msg: \'%s\', cast-size ~= %d' % (msg_name, multicast_size)) # ~=: as race conditions apply
def init_ws_interface(cfg, kernel, flask_webapp):
"""
Initialize websocket interface:
- apply websocket route handlers
@return: an initialized RZ_WebSocket_Server object
"""
# init websocket-env
ws_env = namedtuple('RZ_websocket_env', ['kernel'])
ws_env.kernel = kernel
def decorator__ws_multicast(ws_srv, f, f_multicast):
"""
Emit multicast on topo_diff, attr_diff
@param f: [!] wrapped function, name used to derive socket message name
"""
def _prep_for_serialization(obj):
# handle special serialization cases
if isinstance(obj, Topo_Diff):
return obj.to_json_dict()
return obj
@wraps(f)
def wrapped_function(*args, **kw):
f_ret = f(*args, **kw)
assert type(f_ret) in [list, tuple] # expect (X_Diff, X_Diff.Commit_Result_Type)
#
# Identify f caller
#
# TODO: avoid stack inspection if possible
#
try:
stack = inspect.stack()
stack_frame = stack[1][0]
obj_instance = stack_frame.f_locals.get('self')
if None != obj_instance:
# [!] no need emit broadcast if call originated from a websocket as
# WebSocket_Graph_NS#on_diff_commit__xxx emit their own self-excluding multicast
# we still asser call class == WebSocket_Graph_NS
caller_class = obj_instance.__class__
assert WebSocket_Graph_NS == caller_class, 'decorator__ws_multicast: unknown callpath: not from WebSocket_Graph_NS'
return f_ret
except Exception as e:
log.exception('decorator__ws_multicast: failed to detect REST/Websocket call via stack inspection') # exception derived from stack
return # f caller unidentified, abort cast
rzdoc = rzdoc_from_f_args_extractor(args)
pkt_data = map(_prep_for_serialization, f_ret)
msg_name = f.__name__
pkt = dict(type="event",
name=msg_name,
args=pkt_data,
endpoint='/graph')
ws_srv.log_multicast(msg_name)
ws_broadcast_to_rzdoc_readers(ws_srv, pkt, rzdoc)
return f_ret
return wrapped_function
def rzdoc_from_f_args_extractor(f_args): # extract rzdoc from req ctx
if len(f_args) < 2 or not isinstance(f_args[1], Req_Context):
return
req_ctx = f_args[1]
return req_ctx.rzdoc
def socketio_route_handler(url_path):
# FIXME: ws upgrade process for non socketio clients
if None == request.environ.get('socketio'):
header__upgrade = request.headers.get('Upgrade')
if 'websocket' == header__upgrade:
remote_addr = request.environ['REMOTE_ADDR']
remote_port = request.environ['REMOTE_PORT']
log.debug('ws: \'Upgrade: websocket\' header detected, serving \'101\': remote-socket-addr: %s:%s' % (remote_addr, remote_port))
resp = make_response__http__empty(101) # 'switching protocols' HTTP status code
resp.headers['Upgrade'] = 'websocket'
resp.headers['Connection'] = 'Upgrade'
return resp
else:
raise Exception('ws: failed to obtain socketio object from WSGI environment')
try:
socketio_manage(request.environ, {'/graph': WebSocket_Graph_NS}, ws_env) # connect socketio manager
except:
log.exception("ws: exception while handling connection", exc_info=True)
return make_response__json(status=HTTP_STATUS__500_INTERNAL_SERVER_ERROR)
def ws_broadcast_to_rzdoc_readers(ws_srv, pkt, rzdoc):
"""
Cast update messege to subscribed readers
"""
cast_set = []
rzdoc_r_set = kernel.rzdoc__reader_set_from_rzdoc(rzdoc)
for r_assoc in rzdoc_r_set:
cast_set.append(r_assoc)
log.debug('reader diff cast: rzdoc: %s, cast size: %d' % (rzdoc.name, len(cast_set)))
for r_assoc in cast_set:
try:
r_assoc.socket.send_packet(pkt)
except Exception as e:
r_assoc.err_count__IO += 1
# connect socketio route
route_dec = flask_webapp.route('/socket.io/<path:url_path>')
f = route_dec(socketio_route_handler)
flask_webapp.f = f
# init ws server
ws_srv = RZ_WebSocket_Server(cfg, flask_webapp)
kernel.diff_commit__topo = decorator__ws_multicast(ws_srv,
kernel.diff_commit__topo,
f_multicast=WebSocket_Graph_NS.on_diff_commit__topo)
kernel.diff_commit__attr = decorator__ws_multicast(ws_srv,
kernel.diff_commit__attr,
f_multicast=WebSocket_Graph_NS.on_diff_commit__attr)
return ws_srv;
|
