Merge branch 'n1-comms' into formatting

# Conflicts:
#	collab/main.go
#	compose.yaml
#	nginx/nginx.conf
#	peerprep/app/questions/[question]/[roomID]/page.tsx
#	peerprep/app/questions/[question]/[roomID]/question.tsx
#	peerprep/components/questionpage/CollabEditor.tsx

Author: tzyian

collab/main.go

@@ -8,6 +8,7 @@ import (
 	"net/http"
 	"os"
 	"sync"
+	"strconv"
 
 	"github.com/gin-gonic/gin"
 	"github.com/gorilla/websocket"
@@ -142,8 +143,11 @@ func (h *Hub) Run() {
 }
 
 // ServeWs handles WebSocket requests
-func serveWs(hub *Hub, c *gin.Context, roomMappings *verify.RoomMappings) {
-
+func serveWs(
+		hub *Hub, c *gin.Context,
+		roomMappings *verify.RoomMappings,
+		persistMappings *verify.PersistMappings,
+) {
 	log.Println("handler called!")
 	roomID := c.Query("roomID")
 	if roomID == "" {
@@ -160,20 +164,40 @@ func serveWs(hub *Hub, c *gin.Context, roomMappings *verify.RoomMappings) {
 	client := &Client{conn: conn, roomID: roomID}
 	hub.register <- client
 
-	go handleMessages(client, hub, roomMappings)
+	go handleMessages(client, hub, roomMappings, persistMappings)
+}
+
+func authenticateClient(
+		token string, match string, client *Client,
+		roomMappings *verify.RoomMappings,
+		persistMappings *verify.PersistMappings,
+) bool {
+	ok, userID := verifyToken(token)
+	if !ok {
+		log.Println("bad token in request")
+		return false
+	}
+	return verify.VerifyRoomAndMoveToPersist(
+		roomMappings, client.roomID, userID, match, persistMappings)
 }
 
-func authenticateClient(token string, client *Client, roomMappings *verify.RoomMappings) bool {
+func authenticateClientNoMatch(
+	token string, client *Client,
+	persistMappings *verify.PersistMappings,
+) bool {
 	ok, userID := verifyToken(token)
 	if !ok {
-		log.Println("bruh")
+		log.Println("bad token in request")
 		return false
 	}
-	return verify.VerifyRoom(roomMappings, client.roomID, userID)
+	return verify.VerifyPersist(persistMappings, client.roomID, userID)
 }
 
-func handleMessages(client *Client, hub *Hub, roomMappings *verify.RoomMappings) {
-	defer func() {
+func handleMessages(
+	client *Client, hub *Hub,
+	roomMappings *verify.RoomMappings,
+	persistMappings *verify.PersistMappings,
+) {	defer func() {
 		hub.unregister <- client
 	}()
 
@@ -189,12 +213,36 @@ func handleMessages(client *Client, hub *Hub, roomMappings *verify.RoomMappings)
 			log.Printf("Failed to parse message: %v", err)
 			continue
 		}
-		// Handle authentication message
 		if msgData["type"] == "auth" {
-			token, ok := msgData["token"].(string)
-			if !ok || !authenticateClient(token, client, roomMappings) {
-				log.Println("Authentication failed")
-				client.conn.WriteMessage(websocket.TextMessage, []byte("Authentication failed"))
+			token, tokenOk := msgData["token"].(string)
+			if !tokenOk {
+				log.Println("Authentication failed - no token attached")
+				client.conn.WriteMessage(
+					websocket.TextMessage,
+					[]byte("Authentication failed - no JWT token"),
+				)
+				client.conn.Close()
+				break
+			}
+			isSuccess := false
+			match, matchOk := msgData["matchHash"].(string)
+			if matchOk && !authenticateClient(token, match, client, roomMappings, persistMappings) {
+				log.Println(
+					"failed to find a matching room from match hash, proceeding with persistence check",
+				)
+			}
+			// I will ping the persistent map even if I've found it in the original map
+			if !authenticateClientNoMatch(token, client, persistMappings) {
+				log.Println("failed to find a persistent room")
+				isSuccess = false
+			} else {
+				isSuccess = true
+			}
+			if !isSuccess {
+				client.conn.WriteMessage(
+					websocket.TextMessage,
+					[]byte("Authentication failed - failed to find a matching room"),
+				)
 				client.conn.Close()
 				break
 			}
@@ -226,14 +274,14 @@ func statusHandler(hub *Hub) gin.HandlerFunc {
 		for client := range hub.clients {
 			roomID := client.roomID
 			currentStatus, ok := status[roomID]
-			if !ok {
-				// Initialize status for a new RoomID
+			if (!ok) {
+				// Initialize status for a new roomID
 				status[roomID] = map[string]interface{}{
-					"clients":   1,
-					"workspace": hub.workspaces[roomID],
+					"clients": 1,
+					"workspace":   hub.workspaces[roomID],
 				}
 			} else {
-				// Update the client count for an existing RoomID
+				// Update the client count for an existing roomID
 				status[roomID] = map[string]interface{}{
 					"clients":   currentStatus.(map[string]interface{})["clients"].(int) + 1,
 					"workspace": hub.workspaces[roomID],
@@ -254,10 +302,34 @@ func main() {
 	if REDIS_URI == "" {
 		REDIS_URI = "localhost:9190"
 	}
-	roomMappings := verify.InitialiseRoomMappings(REDIS_URI, 1)
+
+	REDIS_ROOM_MAPPING := 1
+	REDIS_ROOM_PERSIST := 2
+
+	if os.Getenv("REDIS_ROOM_MAPPING") != "" {
+		num, err := strconv.Atoi(os.Getenv("REDIS_ROOM_MAPPING"))
+		if err != nil {
+			log.Fatal("DB no of room map is badly formatted" + err.Error())
+		} else {
+			REDIS_ROOM_MAPPING = num
+		}
+	}
+
+	if os.Getenv("REDIS_ROOM_PERSIST") != "" {
+		num, err := strconv.Atoi(os.Getenv("REDIS_ROOM_PERSIST"))
+		if err != nil {
+			log.Fatal("DB no of room persistance store is badly formatted" + err.Error())
+		} else {
+			REDIS_ROOM_PERSIST = num
+		}
+	}
+
+	roomMappings    := verify.InitialiseRoomMappings(REDIS_URI, REDIS_ROOM_MAPPING)
+	persistMappings := verify.InitialisePersistMappings(REDIS_URI, REDIS_ROOM_PERSIST);
+
 	// WebSocket connection endpoint
 	r.GET("/ws", func(c *gin.Context) {
-		serveWs(hub, c, roomMappings)
+		serveWs(hub, c, roomMappings, persistMappings)
 	})
 
 	// Status endpoint

collab/verify/persistMappings.go

@@ -0,0 +1,34 @@
+package verify
+
+import (
+	"context"
+	"log"
+
+	redis "github.com/go-redis/redis/v8"
+)
+
+// same as room mappings, but separated for type safety
+type PersistMappings struct {
+	Conn *redis.Client
+}
+
+func InitialisePersistMappings(addr string, db_num int) *PersistMappings {
+	conn := redis.NewClient(&redis.Options{
+		Addr: addr,
+		DB:   db_num,
+	})
+
+	return &PersistMappings{
+		Conn: conn,
+	}
+}
+
+func VerifyPersist(persistMappings *PersistMappings, roomID string, userID string) bool {
+	data, err := persistMappings.Conn.HGetAll(context.Background(), userID).Result()
+	if err != nil {
+		log.Printf("Error retrieving data for userID %s: %v", userID, err)
+		return false
+	}
+
+	return data["roomId"] == roomID
+}

collab/verify/roomMappings.go

@@ -23,12 +23,44 @@ func InitialiseRoomMappings(addr string, db_num int) *RoomMappings {
 	}
 }
 
-func VerifyRoom(roomMappings *RoomMappings, roomID string, userID string) bool {
-	data, err := roomMappings.Conn.HGetAll(context.Background(), userID).Result()
+func VerifyRoomAndMoveToPersist(
+		roomMappings *RoomMappings,
+		roomID string,
+		userId string,
+		matchHash string,
+		persistMappings *PersistMappings,
+) bool {
+	ctx := context.Background()
+	data, err := roomMappings.Conn.HGetAll(ctx, matchHash).Result()
 	if err != nil {
-		log.Printf("Error retrieving data for userID %s: %v", userID, err)
+		log.Printf("Error retrieving data for matchHash %s: %v", matchHash, err)
 		return false
 	}
 
-	return data["roomId"] == roomID
+	if data["roomId"] != roomID || data["thisUser"] != userId {
+		log.Printf("Mismatch in room data and user data")
+		return false
+	}
+
+	roomMappings.Conn.Del(ctx, matchHash);
+	persistentRoom := map[string]interface{}{
+		"roomId":      roomID,
+		"otherUser":   data["otherUser"],
+		"requestTime": data["requestTime"],
+
+		"title":       data["title"],
+		"titleSlug":   data["titleSlug"],
+		"difficulty":  data["difficulty"],
+		"topicTags":   data["topicTags"],
+		"content":     data["content"],
+		"schemas":     data["schemas"],
+		"id":          data["id"],
+	}
+
+	// this always overrides the persistent room
+	if err := persistMappings.Conn.HSet(ctx, userId, persistentRoom).Err(); err != nil {
+		log.Printf("error sending room to persistent storage: %s", err.Error())
+	}
+
+	return true
 }

comms/.env.example

@@ -0,0 +1 @@
+FRONTEND=

comms/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.env

comms/Dockerfile

@@ -0,0 +1,8 @@
+FROM node:lts-alpine3.20
+
+WORKDIR /comms
+COPY package*.json ./
+RUN npm install --force
+COPY . .
+EXPOSE 4001
+CMD ["npm", "run", "dev"]