feat: use SSE instead of ws (#667)

Author: aster-void

bun.lock

@@ -1,5 +1,7 @@
 // common/type/types.ts
 
+import type { Message } from "./zod/types.ts";
+
 export type {
   UserID,
   GUID,
@@ -34,3 +36,23 @@ export type {
   InitSharedRoom,
   UpdateRoom,
 } from "./zod/types.ts";
+
+export type SSEChatEvents = {
+  "Chat:Append": {
+    message: Message;
+    sender: string; // user name
+  };
+  "Chat:Update": {
+    id: number;
+    message: Message;
+  };
+  "Chat:Delete": {
+    id: number;
+  };
+  "Chat:Ping": "";
+};
+export type SSEChatEventEnum = "Chat:Append" | "Chat:Update" | "Chat:Delete";
+export type SSEChatEvent<T extends SSEChatEventEnum> = {
+  event: T;
+  data: SSEChatEvents[T];
+};

common/types.ts

@@ -1,8 +1,16 @@
 {
   "name": "course-mate",
   "version": "1.0.0",
-  "description": "",
+  "author": "",
   "main": "index.js",
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.1",
+    "lefthook": "^1.10.10",
+    "lint-staged": "^15.2.10"
+  },
+  "description": "",
+  "keywords": [],
+  "license": "ISC",
   "scripts": {
     "prepare": "lefthook install && (cd server; bun run prepare)",
     "check": "bun type && bun style:check",
@@ -27,15 +35,6 @@
     "test": "make test",
     "spell": "bunx cspell --quiet ."
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "workspaces": ["common", "web", "server"],
-  "devDependencies": {
-    "@biomejs/biome": "^1.9.1",
-    "lefthook": "^1.10.10",
-    "lint-staged": "^15.2.10"
-  },
-  "dependencies": {},
-  "trustedDependencies": ["@biomejs/biome", "lefthook"]
+  "trustedDependencies": ["@biomejs/biome", "lefthook"],
+  "workspaces": ["common", "web", "server"]
 }

package.json

@@ -5,7 +5,7 @@
   "main": "src/index.ts",
   "scripts": {
     "prepare": "bun --env-file=./.env.dev prisma generate --sql || (echo 'please set DATABASE_URL in server/.env.dev' && exit 1)",
-    "dev": "bun --watch src/main.ts",
+    "dev": "bun --watch src/index.ts",
     "build": "tsc",
     "serve": "bun target/main.js"
   },
@@ -24,10 +24,9 @@
     "dotenv": "^16.4.5",
     "dotenv-cli": "^7.4.2",
     "firebase-admin": "^12.2.0",
-    "lru-cache": "^11.0.2",
     "hono": "^4.7.1",
+    "lru-cache": "^11.0.2",
     "sharp": "^0.33.5",
-    "socket.io": "^4.7.5",
     "sql-formatter": "^15.4.10",
     "zod": "^3.23.8"
   },

server/package.json

@@ -8,6 +8,7 @@ import type {
   SendMessage,
   ShareRoomID,
 } from "common/types";
+import { HTTPException } from "hono/http-exception";
 import * as db from "../database/chat";
 import { areAllMatched, getRelation } from "../database/matches";
 import { getUserByID } from "../database/users";
@@ -37,12 +38,13 @@ export async function sendDM(
   from: UserID,
   to: UserID,
   send: SendMessage,
-): Promise<http.Response<Message>> {
+): Promise<Message> {
   const rel = await getRelation(from, to);
   if (rel.status === "REJECTED")
-    return http.forbidden(
-      "You cannot send a message because the friendship request was rejected.",
-    );
+    throw new HTTPException(403, {
+      message:
+        "You cannot send a message because the friendship request was rejected.",
+    });
 
   // they are now MATCHED
   const msg: Omit<Omit<Message, "id">, "isPicture"> = {
@@ -53,8 +55,9 @@ export async function sendDM(
   };
 
   const result = await db.sendDM(rel.id, msg);
-  if (!result) return http.internalError("Failed to send DM");
-  return http.created(result);
+  if (!result)
+    throw new HTTPException(500, { message: "Failed to send message" });
+  return result;
 }
 
 export async function getDM(

server/src/functions/chat.ts

@@ -1,14 +1,13 @@
-import type { Server } from "node:http";
 import { Hono } from "hono";
 import { cors } from "hono/cors";
 import { HTTPException } from "hono/http-exception";
-import { initializeSocket } from "./lib/socket/socket";
 import { allUrlMustBeValid, env } from "./lib/utils";
 import chatRoutes from "./router/chat";
 import coursesRoutes from "./router/courses";
 import matchesRoutes from "./router/matches";
 import pictureRoutes from "./router/picture";
 import requestsRoutes from "./router/requests";
+import sseRoutes from "./router/sse";
 import subjectsRoutes from "./router/subjects";
 import usersRoutes from "./router/users";
 
@@ -31,12 +30,11 @@ if (corsOptions.origin.length > 1) {
 const app = new Hono()
   .onError((err, c) => {
     if (err instanceof HTTPException) {
-      console.error(err);
-      c.status(err.status);
-      return c.json({ error: err });
+      console.log(err);
+      return c.json({ error: err.message }, err.status);
     }
-    c.status(500);
-    return c.json({ error: err });
+    console.error(err);
+    return c.json({ error: err }, 500);
   })
 
   .use(cors(corsOptions))
@@ -51,15 +49,7 @@ const app = new Hono()
   .route("/subjects", subjectsRoutes)
   .route("/requests", requestsRoutes)
   .route("/matches", matchesRoutes)
-  .route("/chat", chatRoutes);
+  .route("/chat", chatRoutes)
+  .route("/sse", sseRoutes);
 
-export function main() {
-  const server = Bun.serve({
-    fetch: app.fetch,
-    port: process.env.PORT ?? 3000,
-  });
-  // ??
-  initializeSocket(server as unknown as Server, corsOptions);
-  return server;
-}
 export default app;