feat: initial scaffolding, client can connect with a user name

This commit is contained in:
Alexander Daichendt 2025-02-11 18:29:57 +01:00
commit b0ce2fe0af
31 changed files with 3342 additions and 0 deletions

175
server/.gitignore vendored Normal file
View file

@ -0,0 +1,175 @@
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
# Logs
logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*
# Caches
.cache
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
# Runtime data
pids
_.pid
_.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# Snowpack dependency directory (https://snowpack.dev/)
web_modules/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional stylelint cache
.stylelintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
# parcel-bundler cache (https://parceljs.org/)
.parcel-cache
# Next.js build output
.next
out
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# vuepress v2.x temp and cache directory
.temp
# Docusaurus cache and generated files
.docusaurus
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port
# Stores VSCode versions used for testing VSCode extensions
.vscode-test
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
# IntelliJ based IDEs
.idea
# Finder (MacOS) folder config
.DS_Store

15
server/README.md Normal file
View file

@ -0,0 +1,15 @@
# server
To install dependencies:
```bash
bun install
```
To run:
```bash
bun run index.ts
```
This project was created using `bun init` in bun v1.2.2. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

27
server/bun.lock Normal file
View file

@ -0,0 +1,27 @@
{
"lockfileVersion": 1,
"workspaces": {
"": {
"name": "server",
"devDependencies": {
"@types/bun": "latest",
},
"peerDependencies": {
"typescript": "^5.0.0",
},
},
},
"packages": {
"@types/bun": ["@types/bun@1.2.2", "", { "dependencies": { "bun-types": "1.2.2" } }, "sha512-tr74gdku+AEDN5ergNiBnplr7hpDp3V1h7fqI2GcR/rsUaM39jpSeKH0TFibRvU0KwniRx5POgaYnaXbk0hU+w=="],
"@types/node": ["@types/node@22.13.1", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-jK8uzQlrvXqEU91UxiK5J7pKHyzgnI1Qnl0QDHIgVGuolJhRb9EEl28Cj9b3rGR8B2lhFCtvIm5os8lFnO/1Ew=="],
"@types/ws": ["@types/ws@8.5.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw=="],
"bun-types": ["bun-types@1.2.2", "", { "dependencies": { "@types/node": "*", "@types/ws": "~8.5.10" } }, "sha512-RCbMH5elr9gjgDGDhkTTugA21XtJAy/9jkKe/G3WR2q17VPGhcquf9Sir6uay9iW+7P/BV0CAHA1XlHXMAVKHg=="],
"typescript": ["typescript@5.7.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw=="],
"undici-types": ["undici-types@6.20.0", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
}
}

14
server/package.json Normal file
View file

@ -0,0 +1,14 @@
{
"name": "server",
"module": "index.ts",
"type": "module",
"scripts": {
"dev": "bun --hot src/index.ts"
},
"devDependencies": {
"@types/bun": "latest"
},
"peerDependencies": {
"typescript": "^5.0.0"
}
}

View file

@ -0,0 +1,12 @@
import type { ServerWebSocket } from "bun";
import type { ClientMessage } from "../../shared";
import type { Room, WebSocketData } from "./types";
export default function handleClientMessage(
client: ServerWebSocket<WebSocketData>,
data: ClientMessage,
room: Room,
) {
// handle client messages
console.log("Received new message ", data);
}

85
server/src/index.ts Normal file
View file

@ -0,0 +1,85 @@
import type { ClientMessage } from "../../shared.ts";
import handleClientMessage from "./handleClientMessage.ts";
import type { Room, WebSocketData } from "./types.ts";
const rooms = new Map<string, Room>(); // roomId -> Room
const server = Bun.serve<WebSocketData>({
port: 3000,
async fetch(request, server) {
// check if not a websocket request
if (!request.headers.get("Upgrade")) {
return new Response("Only Websocket Connections supported", {
status: 200,
});
}
// extract the roomId out of the URL
const url = new URL(request.url);
const matches = url.pathname.match(/^\/ws\/room\/(.+)$/);
if (!matches) {
return new Response("Invalid room URL format", { status: 400 });
}
const roomId = matches[1];
// pass it to on as data attr
if (
server.upgrade(request, {
data: { roomId },
})
) {
return;
}
return new Response("Upgrade failed", { status: 500 });
},
websocket: {
open(ws) {
const roomId = ws.data.roomId;
if (!roomId) {
console.log("Error: RoomId cannot be empty");
ws.close();
return;
}
if (!rooms.has(roomId)) {
console.log(`Creating room: ${roomId}`);
rooms.set(roomId, {
roomId,
userConnections: new Map(),
});
}
},
close(ws) {
// cleanup, delete room if empty
const roomId = ws.data.roomId;
const room = rooms.get(roomId);
if (!room) {
return;
}
if (room.userConnections.size === 0) {
rooms.delete(roomId);
console.log("Cleaned up room", roomId);
}
},
message(ws, message) {
const roomId = ws.data.roomId;
const room = rooms.get(roomId);
if (!room) {
console.log(`Room not found: ${roomId}`);
return;
}
const data = JSON.parse(message.toString()) as ClientMessage;
handleClientMessage(ws, data, room);
},
},
});
console.log(`Server running at ${server.url}`);

17
server/src/types.ts Normal file
View file

@ -0,0 +1,17 @@
import type { ServerWebSocket } from "bun";
import type { User } from "../../shared";
export interface WebSocketData {
roomId: string;
}
export interface Room {
roomId: string;
userConnections: Map<
string, // userId
{
user: User;
socket: ServerWebSocket<WebSocketData>;
}
>;
}

27
server/tsconfig.json Normal file
View file

@ -0,0 +1,27 @@
{
"compilerOptions": {
// Enable latest features
"lib": ["ESNext", "DOM"],
"target": "ESNext",
"module": "ESNext",
"moduleDetection": "force",
"jsx": "react-jsx",
"allowJs": true,
// Bundler mode
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"verbatimModuleSyntax": true,
"noEmit": true,
// Best practices
"strict": true,
"skipLibCheck": true,
"noFallthroughCasesInSwitch": true,
// Some stricter flags (disabled by default)
"noUnusedLocals": false,
"noUnusedParameters": false,
"noPropertyAccessFromIndexSignature": false
}
}