mirror
/
miguelgrinberg.python-socketio
mirror of https://github.com/miguelgrinberg/python-socketio
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Updates for recent changes in main

pull/1164/head
Miguel Grinberg 2 years ago
parent
8423bec185
commit
ee86b0e8d0
Failed to extract signature
6 changed files with 139 additions and 64 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 20
      examples/server/asgi/app.py
  2. 18
      examples/server/wsgi/app.py
  3. 64
      src/socketio/admin.py
  4. 15
      src/socketio/async_server.py
  5. 71
      src/socketio/asyncio_admin.py
  6. 15
      src/socketio/server.py

20
examples/server/asgi/app.py
View File

@ -1,9 +1,25 @@
#!/usr/bin/env python #!/usr/bin/env python
import uvicorn
# set instrument to `True` to accept connections from the official Socket.IO
# Admin UI hosted at https://admin.socket.io
instrument = True
admin_login = {
'username': 'admin',
'password': 'python', # change this to a strong secret for production use!
}
import uvicorn
import socketio import socketio
sio = socketio.AsyncServer(async_mode='asgi') sio = socketio.AsyncServer(
async_mode='asgi',
cors_allowed_origins=None if not instrument else [
'http://localhost:5000',
'https://admin.socket.io', # edit the allowed origins if necessary
])
if instrument:
sio.instrument(auth=admin_login)
app = socketio.ASGIApp(sio, static_files={ app = socketio.ASGIApp(sio, static_files={
'/': 'app.html', '/': 'app.html',
}) })

18
examples/server/wsgi/app.py
View File

@ -3,10 +3,26 @@
# installed # installed
async_mode = None async_mode = None
# set instrument to `True` to accept connections from the official Socket.IO
# Admin UI hosted at https://admin.socket.io
instrument = False
admin_login = {
'username': 'admin',
'password': 'python', # change this to a strong secret for production use!
}
from flask import Flask, render_template from flask import Flask, render_template
import socketio import socketio
sio = socketio.Server(logger=True, async_mode=async_mode) sio = socketio.Server(
async_mode=async_mode,
cors_allowed_origins=None if not instrument else [
'http://localhost:5000',
'https://admin.socket.io', # edit the allowed origins if necessary
])
if instrument:
sio.instrument(auth=admin_login)
app = Flask(__name__) app = Flask(__name__)
app.wsgi_app = socketio.WSGIApp(sio, app.wsgi_app) app.wsgi_app = socketio.WSGIApp(sio, app.wsgi_app)
app.config['SECRET_KEY'] = 'secret!' app.config['SECRET_KEY'] = 'secret!'

64
src/socketio/admin.py
View File

@ -4,6 +4,7 @@ import os
import socket import socket
import time import time
from urllib.parse import parse_qs from urllib.parse import parse_qs
from .exceptions import ConnectionRefusedError
HOSTNAME = socket.gethostname() HOSTNAME = socket.gethostname()
PID = os.getpid() PID = os.getpid()
@ -92,8 +93,8 @@ class InstrumentedServer:
self.sio.manager.leave_room = self._leave_room self.sio.manager.leave_room = self._leave_room
# report emit events # report emit events
self.sio.__emit_internal = self.sio._emit_internal self.sio.manager.__emit = self.sio.manager.emit
self.sio._emit_internal = self._emit_internal self.sio.manager.emit = self._emit
# report receive events # report receive events
self.sio.__handle_event_internal = self.sio._handle_event_internal self.sio.__handle_event_internal = self.sio._handle_event_internal
@ -117,9 +118,16 @@ class InstrumentedServer:
self.__class__._eio_websocket_handler, self) self.__class__._eio_websocket_handler, self)
def admin_connect(self, sid, environ, client_auth): def admin_connect(self, sid, environ, client_auth):
if self.auth: if self.auth != None:
if not self.auth(client_auth): authenticated = False
raise ConnectionRefusedError('Invalid credentials') if isinstance(self.auth, dict):
authenticated = client_auth == self.auth
elif isinstance(self.auth, list):
authenticated = client_auth in self.auth
else:
authenticated = self.auth(client_auth)
if not authenticated:
raise ConnectionRefusedError('authentication failed')
def config(sid): def config(sid):
self.sio.sleep(0.1) self.sio.sleep(0.1)
@ -183,13 +191,16 @@ class InstrumentedServer:
def check_for_upgrade(): def check_for_upgrade():
for _ in range(5): for _ in range(5):
self.sio.sleep(5) self.sio.sleep(5)
if self.sio.eio._get_socket(eio_sid).upgraded: try:
self.sio.emit('socket_updated', { if self.sio.eio._get_socket(eio_sid).upgraded:
'id': sid, self.sio.emit('socket_updated', {
'nsp': namespace, 'id': sid,
'transport': 'websocket', 'nsp': namespace,
}, namespace=self.admin_namespace) 'transport': 'websocket',
break }, namespace=self.admin_namespace)
break
except KeyError:
pass
if serialized_socket['transport'] == 'polling': if serialized_socket['transport'] == 'polling':
self.sio.start_background_task(check_for_upgrade) self.sio.start_background_task(check_for_upgrade)
@ -226,17 +237,24 @@ class InstrumentedServer:
), namespace=self.admin_namespace) ), namespace=self.admin_namespace)
return self.sio.manager.__leave_room(sid, namespace, room) return self.sio.manager.__leave_room(sid, namespace, room)
def _emit_internal(self, eio_sid, event, data, namespace=None, id=None): def _emit(self, event, data, namespace, room=None, skip_sid=None,
ret = self.sio.__emit_internal(eio_sid, event, data, callback=None, **kwargs):
namespace=namespace, id=id) ret = self.sio.manager.__emit(event, data, namespace, room=room,
skip_sid=skip_sid, callback=callback,
**kwargs)
if namespace != self.admin_namespace: if namespace != self.admin_namespace:
sid = self.sio.manager.sid_from_eio_sid(eio_sid, namespace) event_data = [event] + list(data) if isinstance(data, tuple) \
self.sio.emit('event_sent', ( else [data]
namespace, if not isinstance(skip_sid, list):
sid, skip_sid = [skip_sid]
[event] + list(data) if isinstance(data, tuple) else [data], for sid, _ in self.sio.manager.get_participants(namespace, room):
datetime.utcnow().isoformat() + 'Z', if sid not in skip_sid:
), namespace=self.admin_namespace) self.sio.emit('event_sent', (
namespace,
sid,
event_data,
datetime.utcnow().isoformat() + 'Z',
), namespace=self.admin_namespace)
return ret return ret
def _handle_event_internal(self, server, sid, eio_sid, data, namespace, def _handle_event_internal(self, server, sid, eio_sid, data, namespace,
@ -282,7 +300,7 @@ class InstrumentedServer:
def _wait(ws): def _wait(ws):
ret = ws.__wait() ret = ws.__wait()
self.event_buffer.push('packetsIn') self.event_buffer.push('packetsIn')
self.event_buffer.push('bytesIn', len(ret)) self.event_buffer.push('bytesIn', len(ret or ''))
return ret return ret
ws.__send = ws.send ws.__send = ws.send

15
src/socketio/async_server.py
View File

@ -472,11 +472,16 @@ class AsyncServer(base_server.BaseServer):
"""Instrument the Socket.IO server for monitoring with the `Socket.IO """Instrument the Socket.IO server for monitoring with the `Socket.IO
Admin UI <https://socket.io/docs/v4/admin-ui/>`_. Admin UI <https://socket.io/docs/v4/admin-ui/>`_.
:param auth: A function that receives a dictionary with the credentials :param auth: Authentication credentials for Admin UI access. Set to a
provided by the client (usually ``username`` and dictionary with the expected login (usually ``username``
``password``) and returns ``True`` if the user is allowed. and ``password``) or a list of dictionaries if more than
To disable authentication, set this argument to ``False`` one set of credentials need to be available. For more
(not recommended, never do this on a production server). complex authentication methods, set to a callable that
receives the authentication dictionary as an argument and
returns ``True`` if the user is allowed or ``False``
otherwise. To disable authentication, set this argument to
``False`` (not recommended, never do this on a production
server).
:param mode: The reporting mode. The default is ``'development'``, :param mode: The reporting mode. The default is ``'development'``,
which is best used while debugging, as it may have a which is best used while debugging, as it may have a
significant performance effect. Set to ``'production'`` to significant performance effect. Set to ``'production'`` to

71
src/socketio/asyncio_admin.py
View File

@ -6,6 +6,7 @@ import socket
import time import time
from urllib.parse import parse_qs from urllib.parse import parse_qs
from .admin import EventBuffer from .admin import EventBuffer
from .exceptions import ConnectionRefusedError
HOSTNAME = socket.gethostname() HOSTNAME = socket.gethostname()
PID = os.getpid() PID = os.getpid()
@ -73,8 +74,8 @@ class InstrumentedAsyncServer:
self.sio.manager.leave_room = self._leave_room self.sio.manager.leave_room = self._leave_room
# report emit events # report emit events
self.sio.__emit_internal = self.sio._emit_internal self.sio.manager.__emit = self.sio.manager.emit
self.sio._emit_internal = self._emit_internal self.sio.manager.emit = self._emit
# report receive events # report receive events
self.sio.__handle_event_internal = self.sio._handle_event_internal self.sio.__handle_event_internal = self.sio._handle_event_internal
@ -98,13 +99,19 @@ class InstrumentedAsyncServer:
async def admin_connect(self, sid, environ, client_auth): async def admin_connect(self, sid, environ, client_auth):
authenticated = True authenticated = True
if self.auth: if self.auth != None:
if asyncio.iscoroutinefunction(self.auth): authenticated = False
authenticated = await self.auth(client_auth) if isinstance(self.auth, dict):
authenticated = client_auth == self.auth
elif isinstance(self.auth, list):
authenticated = client_auth in self.auth
else: else:
authenticated = self.auth(client_auth) if asyncio.iscoroutinefunction(self.auth):
if not authenticated: authenticated = await self.auth(client_auth)
raise ConnectionRefusedError('Invalid credentials') else:
authenticated = self.auth(client_auth)
if not authenticated:
raise ConnectionRefusedError('authentication failed')
async def config(sid): async def config(sid):
await self.sio.sleep(0.1) await self.sio.sleep(0.1)
@ -137,7 +144,6 @@ class InstrumentedAsyncServer:
await self.sio.emit(event, data, to=room_filter, namespace=namespace) await self.sio.emit(event, data, to=room_filter, namespace=namespace)
def admin_enter_room(self, _, namespace, room, room_filter=None): def admin_enter_room(self, _, namespace, room, room_filter=None):
print(namespace, room, room_filter)
for sid, _ in self.sio.manager.get_participants( for sid, _ in self.sio.manager.get_participants(
namespace, room_filter): namespace, room_filter):
self.sio.enter_room(sid, room, namespace=namespace) self.sio.enter_room(sid, room, namespace=namespace)
@ -169,13 +175,16 @@ class InstrumentedAsyncServer:
async def check_for_upgrade(): async def check_for_upgrade():
for _ in range(5): for _ in range(5):
await self.sio.sleep(5) await self.sio.sleep(5)
if self.sio.eio._get_socket(eio_sid).upgraded: try:
await self.sio.emit('socket_updated', { if self.sio.eio._get_socket(eio_sid).upgraded:
'id': sid, await self.sio.emit('socket_updated', {
'nsp': namespace, 'id': sid,
'transport': 'websocket', 'nsp': namespace,
}, namespace=self.admin_namespace) 'transport': 'websocket',
break }, namespace=self.admin_namespace)
break
except KeyError:
pass
if serialized_socket['transport'] == 'polling': if serialized_socket['transport'] == 'polling':
self.sio.start_background_task(check_for_upgrade) self.sio.start_background_task(check_for_upgrade)
@ -212,18 +221,24 @@ class InstrumentedAsyncServer:
))) )))
return self.sio.manager.__leave_room(sid, namespace, room) return self.sio.manager.__leave_room(sid, namespace, room)
async def _emit_internal(self, eio_sid, event, data, namespace=None, async def _emit(self, event, data, namespace, room=None, skip_sid=None,
id=None): callback=None, **kwargs):
ret = await self.sio.__emit_internal(eio_sid, event, data, ret = await self.sio.manager.__emit(event, data, namespace, room=room,
namespace=namespace, id=id) skip_sid=skip_sid, callback=callback,
**kwargs)
if namespace != self.admin_namespace: if namespace != self.admin_namespace:
sid = self.sio.manager.sid_from_eio_sid(eio_sid, namespace) event_data = [event] + list(data) if isinstance(data, tuple) \
await self.sio.emit('event_sent', ( else [data]
namespace, if not isinstance(skip_sid, list):
sid, skip_sid = [skip_sid]
[event] + list(data) if isinstance(data, tuple) else [data], for sid, _ in self.sio.manager.get_participants(namespace, room):
datetime.utcnow().isoformat() + 'Z', if sid not in skip_sid:
), namespace=self.admin_namespace) await self.sio.emit('event_sent', (
namespace,
sid,
event_data,
datetime.utcnow().isoformat() + 'Z',
), namespace=self.admin_namespace)
return ret return ret
async def _handle_event_internal(self, server, sid, eio_sid, data, async def _handle_event_internal(self, server, sid, eio_sid, data,
@ -269,7 +284,7 @@ class InstrumentedAsyncServer:
async def _wait(ws): async def _wait(ws):
ret = await ws.__wait() ret = await ws.__wait()
self.event_buffer.push('packetsIn') self.event_buffer.push('packetsIn')
self.event_buffer.push('bytesIn', len(ret)) self.event_buffer.push('bytesIn', len(ret or ''))
return ret return ret
ws.__send = ws.send ws.__send = ws.send

15
src/socketio/server.py
View File

@ -459,11 +459,16 @@ class Server(base_server.BaseServer):
"""Instrument the Socket.IO server for monitoring with the `Socket.IO """Instrument the Socket.IO server for monitoring with the `Socket.IO
Admin UI <https://socket.io/docs/v4/admin-ui/>`_. Admin UI <https://socket.io/docs/v4/admin-ui/>`_.
:param auth: A function that receives a dictionary with the credentials :param auth: Authentication credentials for Admin UI access. Set to a
provided by the client (usually ``username`` and dictionary with the expected login (usually ``username``
``password``) and returns ``True`` if the user is allowed. and ``password``) or a list of dictionaries if more than
To disable authentication, set this argument to ``False`` one set of credentials need to be available. For more
(not recommended, never do this on a production server). complex authentication methods, set to a callable that
receives the authentication dictionary as an argument and
returns ``True`` if the user is allowed or ``False``
otherwise. To disable authentication, set this argument to
``False`` (not recommended, never do this on a production
server).
:param mode: The reporting mode. The default is ``'development'``, :param mode: The reporting mode. The default is ``'development'``,
which is best used while debugging, as it may have a which is best used while debugging, as it may have a
significant performance effect. Set to ``'production'`` to significant performance effect. Set to ``'production'`` to

Write Preview
Loading…
Cancel
Save