merge: websockets & refactoring

backend/src/app.py

@@ -1,27 +1,27 @@
-import dotenv
-from flask import Flask, Response, jsonify, request
-from flask_cors import CORS
-from flask_socketio import SocketIO, emit
 import uuid
 from dataclasses import asdict
 
-from .state import State
+import dotenv
-from .connect import get_connection
+from flask import Flask, Response, jsonify, request
-from .room import Room
+from flask_cors import CORS
-from .song import Song, init_db, get_song_by_title_artist, add_song_in_db
+from flask_socketio import SocketIO, join_room, leave_room
-from .song_fetch import lastfm_query_search, download_song_mp3
-from .qrcode_gen import generate_qr
 
-from typing import Any
+from .connect import get_connection
+from .qrcode_gen import generate_qr
+from .room import Room
+from .song import Song, add_song_in_db, get_song_by_title_artist, init_db
+from .song_fetch import download_song_mp3, lastfm_query_search
+from .state import State
 
 dotenv.load_dotenv()
 
 
 app = Flask(__name__)
 app.config["SECRET_KEY"] = "your_secret_key"
-socketio = SocketIO(app)
+socketio = SocketIO(app, cors_allowed_origins="*", path="/ws")
 CORS(app)
 
+
 db_conn = get_connection()
 state = State(app, socketio, db_conn.cursor())
 init_db(state.db)
@@ -46,15 +46,28 @@ def error(msg: str, status: int = 400) -> Response:
     return res
 
 
-def ws_broadcast(event: str, *, room_id: int | None = None, data: Any) -> None:
+@socketio.on("connect")
-    final = {}
+def handle_connection():
+    print("somebody connected to socket.io", flush=True)
 
-    if room_id is not None:
-        final["room_id"] = room_id
 
-    final["data"] = data
+@socketio.on("disconnect")
+def handle_disconnection():
+    print("somebody disconnected from socket.io", flush=True)
 
-    emit(event, final, broadcast=True, namespace="/")
+
+@socketio.on("join_room")
+def on_join(data):
+    room = data["id"]
+    join_room(room)
+    print(f"somebody joined {room=}", flush=True)
+
+
+@socketio.on("leave_room")
+def on_leave(data):
+    room = data["id"]
+    leave_room(room)
+    print(f"somebody left {room=}", flush=True)
 
 
 @app.get("/api/join")
@@ -98,10 +111,11 @@ def queue_next():
     if room.playing_idx >= len(room.playing):
         ## queue ended
 
-        room.renew_queue()
+        # room.renew_queue()
-        emit("update_songs", {"songs": [1, 2, 3]}, broadcast=True, namespace="/")
+        data = {"success": True, "ended": True, "index": room.playing_idx, "queue": room.playing}
+        state.socketio.emit("new_queue", data, to=str(room.id))
 
-        return {"success": True, "ended": True, "index": room.playing_idx, "queue": room.playing}
+        return data
 
     return {"success": True, "ended": False, "index": room.playing_idx}
 
@@ -189,6 +203,7 @@ def add_song():
     ## add the song in the room if does not exists
     if song.uuid not in room.songs:
         room.songs[song.uuid] = (song, 1)  # start with one vote
+        socketio.emit("new_song", {"song": song, "user_score": 1}, to=str(room.id))
 
     return {"success": True, "song": song}
 
@@ -220,6 +235,7 @@ def post_song_vote():
 
     ## update the song
     room.songs[song_id] = (song_info[0], song_info[1] + int(request.args["increment"]))
+    socketio.emit("new_vote", {"song": song_info[0], "user_score": song_info[1]})
 
     return {"success": True}
 

frontend/package-lock.json

@@ -8,6 +8,7 @@
 			"name": "frontend",
 			"version": "0.0.1",
 			"dependencies": {
+				"socket.io-client": "^4.8.1",
 				"zod": "^4.0.14"
 			},
 			"devDependencies": {
@@ -820,6 +821,12 @@
 				"win32"
 			]
 		},
+		"node_modules/@socket.io/component-emitter": {
+			"version": "3.1.2",
+			"resolved": "https://registry.npmjs.org/@socket.io/component-emitter/-/component-emitter-3.1.2.tgz",
+			"integrity": "sha512-9BCxFwvbGg/RsZK9tjXd8s4UcwR0MWeFQ1XEKIQVVvAGJyINdrqKMcTRyLoK8Rse1GjzLV9cwjWV1olXRWEXVA==",
+			"license": "MIT"
+		},
 		"node_modules/@sveltejs/acorn-typescript": {
 			"version": "1.0.5",
 			"resolved": "https://registry.npmjs.org/@sveltejs/acorn-typescript/-/acorn-typescript-1.0.5.tgz",
@@ -1203,6 +1210,18 @@
 			"dev": true,
 			"license": "MIT"
 		},
+		"node_modules/@types/node": {
+			"version": "24.1.0",
+			"resolved": "https://registry.npmjs.org/@types/node/-/node-24.1.0.tgz",
+			"integrity": "sha512-ut5FthK5moxFKH2T1CUOC6ctR67rQRvvHdFLCD2Ql6KXmMuCrjsSsRI9UsLCm9M18BMwClv4pn327UvB7eeO1w==",
+			"dev": true,
+			"license": "MIT",
+			"optional": true,
+			"peer": true,
+			"dependencies": {
+				"undici-types": "~7.8.0"
+			}
+		},
 		"node_modules/acorn": {
 			"version": "8.15.0",
 			"resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz",
@@ -1327,6 +1346,45 @@
 			"dev": true,
 			"license": "MIT"
 		},
+		"node_modules/engine.io-client": {
+			"version": "6.6.3",
+			"resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-6.6.3.tgz",
+			"integrity": "sha512-T0iLjnyNWahNyv/lcjS2y4oE358tVS/SYQNxYXGAJ9/GLgH4VCvOQ/mhTjqU88mLZCQgiG8RIegFHYCdVC+j5w==",
+			"license": "MIT",
+			"dependencies": {
+				"@socket.io/component-emitter": "~3.1.0",
+				"debug": "~4.3.1",
+				"engine.io-parser": "~5.2.1",
+				"ws": "~8.17.1",
+				"xmlhttprequest-ssl": "~2.1.1"
+			}
+		},
+		"node_modules/engine.io-client/node_modules/debug": {
+			"version": "4.3.7",
+			"resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz",
+			"integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==",
+			"license": "MIT",
+			"dependencies": {
+				"ms": "^2.1.3"
+			},
+			"engines": {
+				"node": ">=6.0"
+			},
+			"peerDependenciesMeta": {
+				"supports-color": {
+					"optional": true
+				}
+			}
+		},
+		"node_modules/engine.io-parser": {
+			"version": "5.2.3",
+			"resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-5.2.3.tgz",
+			"integrity": "sha512-HqD3yTBfnBxIrbnM1DoD6Pcq8NECnh8d4As1Qgh0z5Gg3jRRIqijury0CL3ghu/edArpUYiYqQiDUQBIs4np3Q==",
+			"license": "MIT",
+			"engines": {
+				"node": ">=10.0.0"
+			}
+		},
 		"node_modules/enhanced-resolve": {
 			"version": "5.18.2",
 			"resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.18.2.tgz",
@@ -1786,7 +1844,6 @@
 			"version": "2.1.3",
 			"resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
 			"integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
-			"dev": true,
 			"license": "MIT"
 		},
 		"node_modules/nanoid": {
@@ -2060,6 +2117,68 @@
 				"node": ">=18"
 			}
 		},
+		"node_modules/socket.io-client": {
+			"version": "4.8.1",
+			"resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.8.1.tgz",
+			"integrity": "sha512-hJVXfu3E28NmzGk8o1sHhN3om52tRvwYeidbj7xKy2eIIse5IoKX3USlS6Tqt3BHAtflLIkCQBkzVrEEfWUyYQ==",
+			"license": "MIT",
+			"dependencies": {
+				"@socket.io/component-emitter": "~3.1.0",
+				"debug": "~4.3.2",
+				"engine.io-client": "~6.6.1",
+				"socket.io-parser": "~4.2.4"
+			},
+			"engines": {
+				"node": ">=10.0.0"
+			}
+		},
+		"node_modules/socket.io-client/node_modules/debug": {
+			"version": "4.3.7",
+			"resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz",
+			"integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==",
+			"license": "MIT",
+			"dependencies": {
+				"ms": "^2.1.3"
+			},
+			"engines": {
+				"node": ">=6.0"
+			},
+			"peerDependenciesMeta": {
+				"supports-color": {
+					"optional": true
+				}
+			}
+		},
+		"node_modules/socket.io-parser": {
+			"version": "4.2.4",
+			"resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-4.2.4.tgz",
+			"integrity": "sha512-/GbIKmo8ioc+NIWIhwdecY0ge+qVBSMdgxGygevmdHj24bsfgtCmcUUcQ5ZzcylGFHsN3k4HB4Cgkl96KVnuew==",
+			"license": "MIT",
+			"dependencies": {
+				"@socket.io/component-emitter": "~3.1.0",
+				"debug": "~4.3.1"
+			},
+			"engines": {
+				"node": ">=10.0.0"
+			}
+		},
+		"node_modules/socket.io-parser/node_modules/debug": {
+			"version": "4.3.7",
+			"resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz",
+			"integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==",
+			"license": "MIT",
+			"dependencies": {
+				"ms": "^2.1.3"
+			},
+			"engines": {
+				"node": ">=6.0"
+			},
+			"peerDependenciesMeta": {
+				"supports-color": {
+					"optional": true
+				}
+			}
+		},
 		"node_modules/source-map-js": {
 			"version": "1.2.1",
 			"resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz",
@@ -2196,6 +2315,15 @@
 				"node": ">=14.17"
 			}
 		},
+		"node_modules/undici-types": {
+			"version": "7.8.0",
+			"resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.8.0.tgz",
+			"integrity": "sha512-9UJ2xGDvQ43tYyVMpuHlsgApydB8ZKfVYTsLDhXkFL/6gfkp+U8xTGdh8pMJv1SpZna0zxG1DwsKZsreLbXBxw==",
+			"dev": true,
+			"license": "MIT",
+			"optional": true,
+			"peer": true
+		},
 		"node_modules/vite": {
 			"version": "7.0.6",
 			"resolved": "https://registry.npmjs.org/vite/-/vite-7.0.6.tgz",
@@ -2291,6 +2419,35 @@
 				}
 			}
 		},
+		"node_modules/ws": {
+			"version": "8.17.1",
+			"resolved": "https://registry.npmjs.org/ws/-/ws-8.17.1.tgz",
+			"integrity": "sha512-6XQFvXTkbfUOZOKKILFG1PDK2NDQs4azKQl26T0YS5CxqWLgXajbPZ+h4gZekJyRqFU8pvnbAbbs/3TgRPy+GQ==",
+			"license": "MIT",
+			"engines": {
+				"node": ">=10.0.0"
+			},
+			"peerDependencies": {
+				"bufferutil": "^4.0.1",
+				"utf-8-validate": ">=5.0.2"
+			},
+			"peerDependenciesMeta": {
+				"bufferutil": {
+					"optional": true
+				},
+				"utf-8-validate": {
+					"optional": true
+				}
+			}
+		},
+		"node_modules/xmlhttprequest-ssl": {
+			"version": "2.1.2",
+			"resolved": "https://registry.npmjs.org/xmlhttprequest-ssl/-/xmlhttprequest-ssl-2.1.2.tgz",
+			"integrity": "sha512-TEU+nJVUUnA4CYJFLvK5X9AOeH4KvDvhIfm0vV1GaQRtchnG0hgK5p8hw/xjv8cunWYCsiPCSDzObPyhEwq3KQ==",
+			"engines": {
+				"node": ">=0.4.0"
+			}
+		},
 		"node_modules/yallist": {
 			"version": "5.0.0",
 			"resolved": "https://registry.npmjs.org/yallist/-/yallist-5.0.0.tgz",

frontend/package.json

@@ -28,6 +28,7 @@
 		"vite": "^7.0.4"
 	},
 	"dependencies": {
-		"zod": "^4.0.14"
+		"zod": "^4.0.14",
+		"socket.io-client": "^4.8.1"
 	}
 }

frontend/src/lib/util.ts

@@ -0,0 +1 @@
+export type FetchError = { code: number, message: string }

frontend/src/routes/room/[id]/+page.svelte

@@ -7,6 +7,7 @@
     import SuggestionList from "$lib/components/SuggestionList.svelte"
     import { getQueueSongs, getSuggestions, joinRoom } from "$lib/utils.js"
     import type { FetchError } from "$lib/types.js"
+    import { io } from "socket.io-client"
 
     let { data } = $props()
 
@@ -29,10 +30,11 @@
         }
 
         ;[returnError, sugg] = await getSuggestions(data.roomId)
-        if (returnError) {
+        if (returnError) return
-            return
-        }
 
+        // Setup websocket connection
+        let socket = io("/", { path: "/ws" })
+        await socket.emitWithAck("join_room", { id: data.roomId })
         ;[returnError, queue, index] = await getQueueSongs(data.roomId)
         if (returnError) {
             return

frontend/src/routes/room/[id]/+page.ts

@@ -1,5 +1,7 @@
 import { error, type Load, type ServerLoad } from "@sveltejs/kit"
 import type { PageLoad } from "./$types"
+import type { FetchError } from "$lib/util"
+import { parseSuggestion, type Suggestion } from "$lib/types"
 
 export const load: PageLoad = async ({ params }) => {
     if (params.id) {

frontend/src/routes/zesty/wsio/+page.svelte

@@ -0,0 +1,8 @@
+<script lang="ts">
+    import { io } from "socket.io-client"
+    const socket = io("/", { path: "/ws" })
+    socket.on("connect", () => {
+        console.log("successfully connected to socket.io server")
+        socket.emit("join_room", { id: "gang" })
+    })
+</script>

frontend/vite.config.ts

@@ -10,6 +10,11 @@ export default defineConfig({
                 target: "http://backend:5000",
                 changeOrigin: false,
                 secure: false
+            },
+            '/ws': {
+                target: "http://backend:5000",
+                changeOrigin: false,
+                secure: false
             }
         }
     }