Updated libraries, docker engine version, docker distro version

.envdev

@@ -1,6 +1,8 @@
 WEB_PORT=3300
 
-DB_HOSTNAME=database
+WEB_ORIGIN=http://localhost:3001
+
+DB_HOSTNAME=localhost
 DB_DATABASE=chat
 DB_USERNAME=chat
 DB_PASSWORD=blastoise

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+patreon: krgamestudios
+ko_fi: krgamestudios
+custom: ["https://www.paypal.com/donate/?hosted_button_id=73Q82T2ZHV8AA"]

.github/workflows/docker.yml

@@ -26,7 +26,7 @@ jobs:
           docker_image: krgamestudios/chat-server
 
       - name: Login to DockerHub
-        uses: docker/login-action@v1 
+        uses: docker/login-action@v1
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}

Dockerfile

@@ -1,9 +1,9 @@
 
-FROM node:15
+FROM node:21-bookworm-slim
 WORKDIR "/app"
-COPY package*.json ./
-COPY . /app
+COPY package*.json /app
 RUN npm install --production
+COPY . /app
 EXPOSE 3300
 USER node
 ENTRYPOINT ["bash", "-c"]

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2021 Kayne Ruse, KR Game Studios
+Copyright (c) 2021-2023 Kayne Ruse, KR Game Studios
 
 This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
 

README.md

@@ -2,13 +2,34 @@
 
 An API centric chat server. Uses Sequelize and mariaDB by default.
 
+This server is available via docker hub at krgamestudios/chat-server.
+
 # Setup
 
 There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker-compose up --build` - run `node configure-script.js` to generate docker-compose.yml and startup.sql.
 
+To generate an authorization token, use [auth-server](https://github.com/krgamestudios/auth-server). A public-facing development auth-server is available here (tokens are valid for 10 minutes):
+
+```
+POST https://dev-auth.krgamestudios.com/auth/login HTTP/1.1
+Content-Type: application/json
+
+{
+	"email": "example@example.com",
+	"password": "helloworld"
+}
+```
+
 # API
 
-This server uses socket.io for communication. Be aware that every chat message requires a valid JWT. See the [auth-server](https://github.com/krgamestudios/auth-server) for details.
+This server uses socket.io for communication. Be aware that every 'open chat', 'message' and 'report' signal requires a valid JWT, as part of the message:
+
+```js
+socket.emit('message', {
+	accessToken,
+	text: inputRef.current.value
+});
+```
 
 The event types are as follows:
 

configure-script.js

@@ -30,10 +30,11 @@ const question = (prompt, def = null) => {
 	//project configuration
 	const appName = await question('App Name', 'chat');
 	const appWebAddress = await question('Web Addr', `${appName}.example.com`);
+	const appWebOrigin = await question('Web Origin', `https://example.com`); //TODO: clean these up properly
 	const appPort = await question('App Port', '3300');
 
 	const appDBUser = await question('DB User', appName);
-	const appDBPass = await question('DB Pass', uuid());
+	const appDBPass = await question('DB Pass', 'blastoise');
 	const dbRootPass = await question('DB Root Pass');
 
 	const appSecretAccess = await question('Access Token Secret', uuid(32));
@@ -42,7 +43,7 @@ const question = (prompt, def = null) => {
 
 	//generate the files
 	const ymlfile = `
-version: '3'
+version: '3.8'
 
 services:
   ${appName}:
@@ -59,6 +60,7 @@ services:
       - "traefik.http.services.${appName}service.loadbalancer.server.port=${appPort}"
     environment:
       - WEB_PORT=${appPort}
+      - WEB_ORIGIN=${appWebOrigin}
       - DB_HOSTNAME=database
       - DB_DATABASE=${appName}
       - DB_USERNAME=${appDBUser}
@@ -76,14 +78,14 @@ services:
       MYSQL_USER: ${appDBUser}
       MYSQL_PASSWORD: ${appDBPass}
       MYSQL_ROOT_PASSWORD: ${dbRootPass}
-    networks: 
+    networks:
       - app-network
     volumes:
       - ./mysql:/var/lib/mysql
       - ./startup.sql:/docker-entrypoint-initdb.d/startup.sql:ro
   traefik_${appName}:
     container_name: ${appName}_traefik
-    image: "traefik:v2.4"
+    image: "traefik:v2.10"
     container_name: "traefik"
     command:
       - "--log.level=ERROR"
@@ -108,7 +110,7 @@ networks:
 `;
 
 	const dockerfile = `
-FROM node:15
+FROM node:21-bookworm-slim
 WORKDIR "/app"
 COPY package*.json ./
 RUN npm install --production

package.json

@@ -1,6 +1,6 @@
 {
   "name": "chat-server",
-  "version": "1.2.1",
+  "version": "1.5.0",
   "description": "An API centric chat server. Uses Sequelize and mariaDB by default.",
   "main": "server/server.js",
   "scripts": {
@@ -20,14 +20,14 @@
   "homepage": "https://github.com/krgamestudios/chat-server#readme",
   "dependencies": {
     "cors": "^2.8.5",
-    "dotenv": "^8.6.0",
-    "express": "^4.17.1",
-    "jsonwebtoken": "^8.5.1",
-    "mariadb": "^2.5.4",
-    "sequelize": "^6.6.5",
-    "socket.io": "^4.1.3"
+    "dotenv": "^16.3.1",
+    "express": "^4.18.2",
+    "jsonwebtoken": "^9.0.2",
+    "mariadb": "^3.2.3",
+    "sequelize": "^6.35.2",
+    "socket.io": "^4.7.2"
   },
   "devDependencies": {
-    "nodemon": "^2.0.12"
+    "nodemon": "^3.0.2"
   }
 }

server/chat/index.js

@@ -35,7 +35,7 @@ const chat = io => {
 		});
 
 		//from here, handles all normal messages
-		socket.on('open chat', message => {
+		socket.on('open chat', async message => {
 			//handle rooms - only in a room if you've opened chat
 			const newlyOpened = !socket.user.room;
 			socket.user.room = socket.user.room || 'general'; //default to general
@@ -46,11 +46,8 @@ const chat = io => {
 
 			socket.join(socket.user.room);
 
-			//broadcast to this room
-			socket.broadcast.to(socket.user.room).emit('message', { emphasis: true, text: `${socket.user.username} entered chat` });
-
 			//log
-			chatlog.create({
+			const log = await chatlog.create({
 				notification: true,
 				username: socket.user.username,
 				text: `${socket.user.username} entered chat`,
@@ -58,6 +55,9 @@ const chat = io => {
 				emphasis: true
 			});
 
+			//broadcast to this room
+			socket.broadcast.to(socket.user.room).emit('message', {timestamp: log.createdAt, emphasis: true, text: `${socket.user.username} entered chat` });
+
 			//send backlog to the user
 			chatlog.findAll({
 				where: {
@@ -120,7 +120,7 @@ const chat = io => {
 			socket.broadcast.to(socket.user.room).emit('message', log);
 		});
 
-		socket.on('disconnect', reason => {
+		socket.on('disconnect', async reason => {
 			//broadcast to this room
 			if (!socket.user) {
 				return;

server/database/models/index.js

@@ -1,5 +1,12 @@
+const chatlog = require('./chatlog');
+const mute = require('./mute');
+const reports = require('./reports');
+
+//relationships
+reports.belongsTo(chatlog);
+
 module.exports = {
-	chatlog: require('./chatlog'),
-	mute: require('./mute'),
-	reports: require('./reports')
-};
+	chatlog,
+	mute,
+	reports,
+};

server/database/models/reports.js

@@ -1,9 +1,7 @@
 const Sequelize = require('sequelize');
 const sequelize = require('..');
 
-const chatlog = require('./chatlog');
-
-const reports = sequelize.define('reports', {
+module.exports = sequelize.define('reports', {
 	index: {
 		type: Sequelize.INTEGER(11),
 		allowNull: false,
@@ -17,10 +15,3 @@ const reports = sequelize.define('reports', {
 		allowNull: false
 	},
 });
-
-chatlog.hasMany(reports, { foreignKey: 'chatlogIndex', foreignKeyConstraint: true });
-reports.belongsTo(chatlog, { foreignKey: 'chatlogIndex' });
-
-sequelize.sync();
-
-module.exports = reports;

server/server.js

@@ -7,14 +7,19 @@ const app = express();
 const server = require('http').Server(app);
 const io = require('socket.io')(server, {
 	cors: {
-		origin: '*'
+		origin: process.env.WEB_ORIGIN
 	}
 });
 const cors = require('cors');
 
 //config
 app.use(express.json());
-app.use(cors());
+app.use(cors({
+	credentials: true,
+	origin: [`${process.env.WEB_ORIGIN}`], //because auth-server
+	allowedHeaders: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization', 'Set-Cookie'],
+	exposedHeaders: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization', 'Set-Cookie'],
+}));
 
 //database connection
 const database = require('./database');

tools/debug-startup.sql

@@ -0,0 +1,4 @@
+#use this while debugging
+CREATE DATABASE IF NOT EXISTS chat;
+CREATE USER IF NOT EXISTS 'chat'@'%' IDENTIFIED BY 'blastoise';
+GRANT ALL PRIVILEGES ON chat.* TO 'chat'@'%';