Migrate Notifications server to python #198

UPGRADING.rst

@@ -84,7 +84,7 @@ List of changes since the *CONFIG_VERSION* numbering was introduced:
    * Added *NOTIFICATIONS_* options to *deployment/settings.py*::
 
         # Notifications configuration (client)
-        # This one is for JavaScript socket.io client.
+        # This one is for JavaScript WebSocket client.
         # It should contain actual URL available from remote machines.
         NOTIFICATIONS_SERVER_URL = 'http://localhost:7887/'
 

oioioi/default_settings.py

@@ -780,7 +780,7 @@
 RANKING_MAX_COOLDOWN = 100  # seconds
 
 # Notifications configuration (client)
-# This one is for JavaScript socket.io client.
+# This one is for JavaScript WebSocket client.
 # It should contain actual URL available from remote machines.
 NOTIFICATIONS_SERVER_URL = 'http://localhost:7887/'
 

oioioi/deployment/settings.py.template

@@ -501,7 +501,7 @@ ZEUS_INSTANCES = {
 # RANKING_MAX_COOLDOWN = 100  # seconds
 
 # Notifications configuration (client)
-# This one is for JavaScript socket.io client.
+# This one is for JavaScript WebSocket client.
 # It should contain actual URL available from remote machines.
 # NOTIFICATIONS_SERVER_URL = 'http://localhost:7887/'
 

oioioi/notifications/README.rst

@@ -1,17 +1,17 @@
 An optional module for transmitting instant notifications to users.
-It consists of a Django app and a Node.js server passing notifications.
+It consists of a Django app and a Python server passing notifications.
+The server is tested with normal Django unit tests.
 
 How to use:
 - expose port 7887 for web container in docker-compose-dev.yml
 - open container bash (easy_toolbox.py bash)
-- install Node.js (sudo apt install nodejs npm)
 - uncomment notifications from INSTALLED_APPS in settings.py
 - uncomment notifications from context_processors in settings.py
 - set following settings in settings.py:
     NOTIFICATIONS_SERVER_ENABLED = True
     NOTIFICATIONS_RABBITMQ_URL = 'amqp://oioioi:oioioi@broker'
     NOTIFICATIONS_SERVER_URL = 'http://localhost:7887/'
-- stop and start again the containers (easy_toolbox.py stop; easy_toolbox.py start)
+- stop and start again the containers (easy_toolbox.py stop; easy_toolbox.py up)
 
 
 
@@ -23,8 +23,6 @@ If required, modify appropriate settings in settings.py file - their names begin
 with "NOTIFICATIONS_" prefix.
 
 
-How to run tests:
-- in ./server directory, invoke: npm test
 
 How to notify users manually:
 - invoke: ./manage.py notify [options]

oioioi/notifications/management/commands/notifications_server.py

@@ -1,36 +1,18 @@
-import os
+import asyncio
 
 from django.conf import settings
 from django.core.management.base import BaseCommand
 
+from oioioi.notifications.server.server import Server
+
 
 class Command(BaseCommand):
     help = "Runs the OIOIOI notifications server"
     requires_model_validation = False
 
-    def add_arguments(self, parser):
-        parser.add_argument(
-            "-i",
-            "--install",
-            action="store_true",
-            help="install dependencies required by the server",
-        )
-
     def handle(self, *args, **options):
-        path = os.path.join(os.path.dirname(__file__), "..", "..", "server")
-        os.chdir(path)
-        if options["install"]:
-            os.execlp("env", "env", "npm", "install")
-        else:
-            os.execlp(
-                "env",
-                "env",
-                "node",
-                "ns-main.js",
-                "--port",
-                settings.NOTIFICATIONS_SERVER_PORT.__str__(),
-                "--url",
-                settings.NOTIFICATIONS_OIOIOI_URL,
-                "--amqp",
-                settings.NOTIFICATIONS_RABBITMQ_URL,
-            )
+        server = Server(settings.NOTIFICATIONS_SERVER_PORT, settings.NOTIFICATIONS_RABBITMQ_URL, settings.NOTIFICATIONS_OIOIOI_URL)
+        try:
+            asyncio.run(server.run())
+        except KeyboardInterrupt:
+            pass  # Allow graceful shutdown on Ctrl+C

oioioi/notifications/server/auth.py

@@ -0,0 +1,50 @@
+import logging
+
+import aiohttp
+from cachetools import TTLCache
+
+
+class Auth:
+    AUTH_CACHE_EXPIRATION_SECONDS = 300
+    AUTH_CACHE_MAX_SIZE = 10000
+    URL_AUTHENTICATE_SUFFIX = "notifications/authenticate/"
+
+    def __init__(self, url: str):
+        self.auth_url = url + self.URL_AUTHENTICATE_SUFFIX
+        self.auth_cache: TTLCache[str, str] = TTLCache(maxsize=self.AUTH_CACHE_MAX_SIZE, ttl=self.AUTH_CACHE_EXPIRATION_SECONDS)
+        self.logger = logging.getLogger(__name__)
+        self.http_client: aiohttp.ClientSession | None = None
+
+    async def connect(self):
+        self.http_client = aiohttp.ClientSession()
+
+    async def close(self):
+        if self.http_client is not None:
+            await self.http_client.close()
+            self.http_client = None
+            self.logger.info("HTTP client closed")
+
+    async def authenticate(self, session_id: str) -> str:
+        """
+        Authenticate a user with session ID.
+
+        Returns the user ID if authentication is successful.
+        Raises RuntimeError if authentication fails.
+        """
+        if self.http_client is None:
+            raise RuntimeError("Connection not established. Call connect() first.")
+
+        if session_id in self.auth_cache:
+            user_id = self.auth_cache[session_id]
+            self.logger.debug(f"Cache hit for session ID: {session_id} with user ID: {user_id}")
+            return user_id
+
+        async with self.http_client.post(self.auth_url, data={"nsid": session_id}, headers={"Content-Type": "application/x-www-form-urlencoded"}) as response:
+            response.raise_for_status()
+            result = await response.json()
+
+            user_id = result["user"]
+            self.auth_cache[session_id] = user_id
+
+            self.logger.debug(f"Authenticated session ID: {session_id} with user ID: {user_id}")
+            return user_id