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
|
import inspect
import os
from pathlib import Path
from wslink import register as exportRpc
from wslink import server
from wslink.websocket import ServerProtocol
from trame_server.state import TRAME_NON_INIT_VALUE
from trame_server.utils import clean_state, logger
class CoreServer(ServerProtocol):
authentication_token = "wslink-secret"
server = None
# ---------------------------------------------------------------
# Static methods
# ---------------------------------------------------------------
@staticmethod
def bind_server(server):
logger.initialize_logger(server.options)
CoreServer.server = server
# Forward options to wslink
os.environ["WSLINK_MAX_MSG_SIZE"] = str(server.options["ws_max_msg_size"])
os.environ["WSLINK_HEART_BEAT"] = str(server.options["ws_heart_beat"])
@staticmethod
def add_arguments(parser):
server.add_arguments(parser)
@staticmethod
def configure(args):
if args.authKeyFile:
with Path(args.authKeyFile).open("r") as key_file:
CoreServer.authentication_token = key_file.read().strip()
else:
CoreServer.authentication_token = args.authKey
@staticmethod
def server_start(
options,
disableLogging=False,
backend="aiohttp",
exec_mode="main",
**kwargs,
):
# NOTE: **kwargs to wslink's start_webserver are currently unused
return server.start_webserver(
options=options,
protocol=CoreServer,
disableLogging=disableLogging,
backend=backend,
exec_mode=exec_mode,
**kwargs,
)
@staticmethod
def server_stop():
server.stop_webserver()
# ---------------------------------------------------------------
# Server
# ---------------------------------------------------------------
def initialize(self): # Called by wslink
self.rpcMethods = {}
self.server = CoreServer.server
self.server._root_protocol = self
self.server.context.network_monitor = self.network_monitor
self._clients_state = {}
for configure in self.server._protocols_to_configure:
configure(self)
self.updateSecret(CoreServer.authentication_token)
def set_server(self, _server):
self.server._server = _server
if self.server.controller.on_server_bind.exists():
# Hack - use internal of aiohttp to rework routes order
# FIXME: WON'T WORK with a different backend
server_routes = _server.app.router._resources
wslink_routes = list(server_routes)
server_routes.clear()
self.server.controller.on_server_bind(_server)
server_routes.extend(wslink_routes)
def port_callback(self, port_used):
self.server._running_port = port_used
if self.server._running_stage < 2:
self.server._running_stage = 2
self.server.state.ready()
self.server.context.ready()
if self.server.controller.on_server_ready.exists():
self.server.controller.on_server_ready(**self.server.state.to_dict())
# Mark the server as ready
if not self.server.ready.done():
self.server.ready.set_result(True)
# ---------------------------------------------------------------
def getRPCMethod(self, name):
if len(self.rpcMethods) == 0:
def is_method(x):
return inspect.ismethod(x) or inspect.isfunction(x)
for protocolObject in self.getLinkProtocols():
for k in inspect.getmembers(protocolObject.__class__, is_method):
proc = k[1]
if "_wslinkuris" in proc.__dict__:
uri_info = proc.__dict__["_wslinkuris"][0]
if "uri" in uri_info:
uri = uri_info["uri"]
self.rpcMethods[uri] = (protocolObject, proc)
if name in self.rpcMethods:
return self.rpcMethods[name]
return None
# ---------------------------------------------------------------
# Publish
# ---------------------------------------------------------------
def push_state_change(self, modified_state, skip_last_active_client=False):
ok, str_values = clean_state(modified_state)
# Only send changes
state_to_send = {}
for key, value in ok.items():
prev_str = self._clients_state.get(key, TRAME_NON_INIT_VALUE)
new_str = str_values.get(key, TRAME_NON_INIT_VALUE)
if prev_str != new_str:
state_to_send[key] = value
# Log and send state
if state_to_send:
logger.state_s2c(state_to_send)
self.publish(
"trame.state.topic",
state_to_send,
skip_last_active_client=skip_last_active_client,
)
# Keep track of last push
self._clients_state.update(str_values)
# ---------------------------------------------------------------
def push_actions(self, actions):
logger.action_s2c(actions)
self.publish("trame.actions.topic", actions)
# ---------------------------------------------------------------
# Internal RPCs
# ---------------------------------------------------------------
def clear_state_client_cache(self, *keys):
for k in keys:
del self._clients_state[k]
# ---------------------------------------------------------------
# RPCs
# ---------------------------------------------------------------
@exportRpc("trame.force.push")
def force_push_state(self, *keys):
state_to_send = {key: self.server.state[key] for key in keys}
if state_to_send:
self.publish(
"trame.state.topic",
state_to_send,
skip_last_active_client=False,
)
# ---------------------------------------------------------------
@exportRpc("trame.lifecycle.update")
def life_cycle_update(self, name):
_fn = self.server.controller[f"on_{name}"]
if _fn.exists():
_fn()
# ---------------------------------------------------------------
@exportRpc("trame.error.client")
def js_error(self, message):
print(f" JS Error => {message}")
# ---------------------------------------------------------------
@exportRpc("trame.state.get")
def get_server_state(self):
server_state = self.server.get_server_state()
ok, _ = clean_state(server_state.get("state", {}))
state_to_send = {**server_state, "state": ok}
logger.initial_state(state_to_send)
return state_to_send
# ---------------------------------------------------------------
@exportRpc("trame.trigger")
async def trigger(self, name, args, kwargs):
logger.action_c2s({"name": name, "args": args, "kwargs": kwargs})
with self.server.state:
fn = self.server.controller.trigger_fn(name)
if fn:
result = fn(*args, **kwargs)
if inspect.isawaitable(result):
result = await result
return result
print(f"Trigger {name} seems to be missing")
return None
# ---------------------------------------------------------------
@exportRpc("trame.state.update")
def update_state(self, changes):
logger.state_c2s(changes)
with self.server.state:
client_state = {}
for change in changes:
client_state[change["key"]] = change.get("value")
# Push to other clients (collaboration) before flush
self.push_state_change(client_state, skip_last_active_client=True)
# Update server state
self.server.state.update(client_state)
|
