Merge pull request #18 from AnujPanthri/ws_server

server/.eslintrc.json

@@ -12,7 +12,6 @@
     "plugins": ["@typescript-eslint"],
     "rules": {
         "semi": [2, "always"],
-        "no-unused-vars": "error",
         "linebreak-style": ["error", "unix"],
         "indent": ["error", 4]
     }

server/README.md

@@ -31,24 +31,38 @@ Room messages are sent to everyone in a room
 ## Test Connection
 
 **Type:** `client -> server`  
-**Payload:**  
+**Payload:**
 
 ```typescript
 {
     "route": "test_connection"
 }
 ```
+
+**Type:** `server -> client <private>`  
+**Response:**
+
+```typescript
+{
+    "message": "test_connection_response",
+}
+```
+
 ## Set Username
+
 **Type:** `client -> server`  
-**Payload:**  
+**Payload:**
+
 ```typescript
 {
     "route": "set_username",
     "username": string,
 }
 ```
+
 **Type:** `server -> client <private>`  
-**Payload:**  
+**Payload:**
+
 ```typescript
 {
     "message": "set_username_response",
@@ -56,12 +70,29 @@ Room messages are sent to everyone in a room
 }
 ```
 
+## Get User Info
+
+**Type:** `client -> server`  
+**Payload:**
+
+```typescript
+{
+    "route": "get_user_info",
+}
+```
+
 **Type:** `server -> client <private>`  
-**Response:**  
+**Payload:**
 
 ```typescript
 {
-    "message": "test_connection_response",
+    "message": "set_username_response",
+    "status": string,
+    "user": {
+        "username": string,
+        "id": string,
+        "currentRoom": string,
+    }
 }
 ```
 
@@ -69,7 +100,7 @@ Room messages are sent to everyone in a room
 
 **Type:** `client -> server`  
 **Description:** Used to enter a room. Join an existing room by including roomId, or if room doesn't exist, create one with that roomId  
-**Payload:**  
+**Payload:**
 
 ```typescript
 {
@@ -80,7 +111,7 @@ Room messages are sent to everyone in a room
 ```
 
 **Type:** `server -> client <private>`  
-**Payload (If error):**  
+**Payload (If error):**
 
 ```typescript
 {
@@ -93,7 +124,7 @@ Room messages are sent to everyone in a room
 
 **Type:** `client -> server`  
 **Description:** Used to enter a room.  
-**Payload:**  
+**Payload:**
 
 ```typescript
 {
@@ -103,7 +134,7 @@ Room messages are sent to everyone in a room
 ```
 
 **Type:** `server -> client <private>`  
-**Payload:**  
+**Payload:**
 
 ```typescript
 {
@@ -116,7 +147,8 @@ Room messages are sent to everyone in a room
 
 **Type:** `client -> server`  
 **Description:** Used to get list of joined rooms  
-**Payload:**  
+**Payload:**
+
 ```typescript
 {
     "route": "get_rooms"
@@ -124,7 +156,8 @@ Room messages are sent to everyone in a room
 ```
 
 **Type:** `server -> client <private>`  
-**Payload:**  
+**Payload:**
+
 ```typescript
 {
     "message": "get_rooms_response",
@@ -136,7 +169,7 @@ Room messages are sent to everyone in a room
 
 **Type:** `server -> client <room>`  
 **Description:** Server message that is sent when the room gets updated such as someone joins or leaves  
-**Payload:**  
+**Payload:**
 
 ```typescript
 {
@@ -155,7 +188,7 @@ Room messages are sent to everyone in a room
 
 **Type:** `client -> server`  
 **Description:** Used to send touch/vibration data to room. Client assigns a number for an ID. That ID is then used to update the vibration. Re-use `send_touch` to update previous vibration. Use `"type": "disable"` to disable the vibration. If an update isn't sent within 1 second of creation/last update it will automatically be disabled.  
-**Payload:**  
+**Payload:**
 
 ```typescript
 {
@@ -175,7 +208,7 @@ Room messages are sent to everyone in a room
 
 **Type:** `server -> client <room>`  
 **Description:**  
-**Payload:**  
+**Payload:**
 
 ```typescript
 {

server/src/socket/hapticLinkServer.ts

@@ -21,6 +21,7 @@ export class User {
     constructor(socket: WebSocketInterface) {
         this.id = generateSessionToken(32);
         this.socket = socket;
+        this.username = "Unknown";
     }
 }
 

server/src/socket/routes.ts

@@ -1,4 +1,5 @@
 import { HapticLinkServer } from "./hapticLinkServer";
+import { GetUserInfoHandler, GetUserInfoSchema } from "./routes/get_user_info";
 import { JoinRoomHandler, JoinRoomSchema } from "./routes/join_room";
 import { LeaveRoomHandler, LeaveRoomSchema } from "./routes/leave_room";
 import { SendVibrationHandler, SendVibrationSchema } from "./routes/send_touch";
@@ -11,4 +12,5 @@ export function registerRoutes(router: HapticLinkServer) {
     router.addRoute("leave_room", LeaveRoomSchema, LeaveRoomHandler);
     router.addRoute("send_touch", SendVibrationSchema, SendVibrationHandler);
     router.addRoute("set_username", SetUsernameSchema, SetUsernameHandler);
+    router.addRoute("get_user_info", GetUserInfoSchema, GetUserInfoHandler);
 }

server/src/socket/routes/get_user_info.ts

@@ -0,0 +1,19 @@
+import { z } from "zod";
+import { Context } from "../hapticLinkServer";
+
+export interface GetUserInfoPayload { }
+export const GetUserInfoSchema = z.object({ });
+
+export function GetUserInfoHandler(ctx: Context<GetUserInfoPayload>) {
+    return ctx.ws.send(
+        JSON.stringify({
+            message: "get_user_info_response",
+            status: "success",
+            user: {
+                id: ctx.user.id,
+                username: ctx.user.username,
+                currentRoom: ctx.user.currentRoom,
+            },
+        })
+    );
+}

server/test/socket/routes/get_user_info.spec.ts

@@ -0,0 +1,35 @@
+import { expect } from "chai";
+import { Context, HapticLinkServer, User } from "../../../src/socket/hapticLinkServer";
+import { GetUserInfoHandler, GetUserInfoPayload } from "../../../src/socket/routes/get_user_info";
+import { WebSocketWrapper } from "../hapticLinkServer.spec";
+
+describe("Get User Info", () => {
+    let server: HapticLinkServer;
+    let ws: WebSocketWrapper;
+    let user: User;
+    let ctx: Context<GetUserInfoPayload>;
+
+    beforeEach(() => {
+        server = new HapticLinkServer();
+        ws = new WebSocketWrapper();
+        user = new User(ws);
+        user.username = "testname";
+        ctx = {
+            ws: ws,
+            user: user,
+            payload: {},
+            server: server,
+        };
+    });
+
+    it("should get user info", (done) => {
+        GetUserInfoHandler(ctx);
+        const res = JSON.parse(ws.sendData as string);
+        expect(res.message).to.equal("get_user_info_response", "incorrect message");
+        expect(res.status).to.equal("success", "incorrect status");
+        expect(res.user.username).to.equal("testname", "incorrect username");
+        expect(res.user.currentRoom).to.equal(undefined, "incorrect current room");
+        expect(res.user.id.length).to.gt(4, "incorrect id");
+        done();
+    });
+});