Docker behaviour changed, fixed

This should make it easier to set time zones and enable database logging.

Related to krgamestudios/MERN-template#16

.dockerignore

@@ -0,0 +1,10 @@
+.git*
+
+tools*
+mysql*
+letsencrypt*
+test*
+
+.env*
+.github*
+LICENSE*

.envdev

@@ -1,9 +1,17 @@
 WEB_PORT=3300
 
+WEB_ORIGIN=http://localhost:3001
+
 DB_HOSTNAME=database
 DB_DATABASE=chat
 DB_USERNAME=chat
 DB_PASSWORD=blastoise
+
+# Select a "TZ database name" that suits your needs: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
 DB_TIMEZONE=Australia/Sydney
 
+# Give this any value to enable database logging (such as "true")
+DB_LOGGING=
+
+# Make sure this value matches the system that you connect to
 SECRET_ACCESS=access

.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"]

Dockerfile

@@ -1,7 +1,7 @@
 
-FROM node:15
+FROM node:18-bullseye-slim
 WORKDIR "/app"
-COPY package*.json ./
+COPY package*.json /app
 RUN npm install --production
 COPY . /app
 EXPOSE 3300

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.
+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:
 
@@ -19,6 +40,7 @@ on 'error' -> Server emits and logs an error
 on 'open chat' -> Preps the server for your messages, places you in the room 'general'
 on 'message' -> Server broadcasts to all other users in your room
 on 'disconnect' -> Server will no longer accept your messages
+on 'report' -> Report the chatlog with the index 'id'
 
 
 Chat Commands:

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));
@@ -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}
@@ -108,7 +110,7 @@ networks:
 `;
 
 	const dockerfile = `
-FROM node:15
+FROM node:18-bullseye-slim
 WORKDIR "/app"
 COPY package*.json ./
 RUN npm install --production

package.json

@@ -1,6 +1,6 @@
 {
   "name": "chat-server",
-  "version": "1.0.0",
+  "version": "1.4.6",
   "description": "An API centric chat server. Uses Sequelize and mariaDB by default.",
   "main": "server/server.js",
   "scripts": {
@@ -19,16 +19,18 @@
   },
   "homepage": "https://github.com/krgamestudios/chat-server#readme",
   "dependencies": {
-    "body-parser": "^1.19.0",
     "cors": "^2.8.5",
-    "dotenv": "^8.2.0",
+    "dotenv": "^16.3.1",
-    "express": "^4.17.1",
+    "express": "^4.18.2",
-    "jsonwebtoken": "^8.5.1",
+    "jsonwebtoken": "^9.0.0",
-    "mariadb": "^2.5.2",
+    "mariadb": "^3.2.0",
-    "sequelize": "^6.5.0",
+    "sequelize": "^6.32.1",
-    "socket.io": "^4.0.0"
+    "socket.io": "^4.7.0"
   },
   "devDependencies": {
-    "nodemon": "^2.0.7"
+    "nodemon": "^2.0.22"
+  },
+  "overrides": {
+    "semver": "^7.5.2"
   }
 }

server/admin/index.js

@@ -0,0 +1,21 @@
+const express = require('express');
+const router = express.Router();
+
+//middleware
+const tokenAuth = require('../utilities/token-auth');
+
+router.use(tokenAuth);
+router.use((req, res, next) => {
+	//check the user's admin status
+	if (!req.user.mod) {
+		return res.status(401).send('Mods only');
+	}
+
+	next();
+});
+
+//basic route management
+router.get('/reports', require('./reports'));
+router.delete('/reports', require('./reports-delete'));
+
+module.exports = router;

server/admin/reports-delete.js

@@ -0,0 +1,15 @@
+const { chatlog, reports } = require('../database/models');
+
+//admin/reports
+const route = async (req, res) => {
+	const reps = await reports.destroy({
+		where: {
+			chatlogIndex: req.body.chatlogIndex
+		}
+	});
+
+	//respond
+	res.status(200).end();
+};
+
+module.exports = route;

server/admin/reports.js

@@ -0,0 +1,31 @@
+const { chatlog, reports } = require('../database/models');
+
+//admin/reports
+const route = async (req, res) => {
+	const reps = await reports.findAll({
+		include: [{
+			model: chatlog,
+			required: true
+		}],
+		order: ['chatlogIndex']
+	});
+
+	//collate
+	const response = [];
+	for(let i = 0; i < reps.length; i++) {
+		//new chatlog
+		if (response.length == 0 || response[response.length - 1].chatlogIndex != reps[i].chatlogIndex) {
+			response.push(reps[i]);
+			response[response.length - 1].reporter = [response[response.length - 1].reporter]; //reporters in an array
+			continue;
+		}
+
+		//multiple people reported this, add to the existing array
+		response[response.length - 1].reporter.push(reps[i].reporter);
+	}
+
+	//respond
+	res.status(200).json(response);
+};
+
+module.exports = route;

server/chat/index.js

@@ -1,13 +1,13 @@
 const jwt = require('jsonwebtoken');
 const { Op } = require('sequelize');
-const { chatlog, mute } = require('../database/models');
+const { chatlog, mute, reports } = require('../database/models');
 
 const chat = io => {
 	io.on('connection', socket => {
 		//middleware
 		socket.use((request, next) => {
 			//verify request format
-			if (!['open chat', 'message'].includes(request[0])) {
+			if (!['open chat', 'message', 'report'].includes(request[0])) {
 				return next(`Invalid request to the chat server ${request[0]}`);
 			}
 			return next();
@@ -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: {
@@ -72,7 +72,7 @@ const chat = io => {
 					}
 				},
 				order: [
-					['id', 'DESC']
+					['index', 'DESC']
 				],
 				limit: 50
 			})
@@ -109,18 +109,18 @@ const chat = io => {
 				return;
 			}
 
-			//broadcast to this room
-			socket.broadcast.to(socket.user.room).emit('message', { username: socket.user.username, text: message.text });
-
 			//log
-			chatlog.create({
+			const log = await chatlog.create({
 				username: socket.user.username,
 				text: message.text,
 				room: socket.user.room
 			});
+
+			//broadcast to this room (with the id)
+			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;
@@ -137,6 +137,19 @@ const chat = io => {
 				emphasis: true
 			});
 		});
+
+		socket.on('report', info => {
+			//handle reports of malicious content
+			if (!info.index) {
+				return;
+			}
+
+			//report
+			reports.create({
+				reporter: socket.user.username,
+				chatlogIndex: info.index
+			});
+		});
 	});
 };
 
@@ -186,7 +199,7 @@ const executeCommand = (io, socket, command) => {
 		}
 
 		case '/mute': {//NOTE: mutes globally, broadcasts only to admin's room
-			if (socket.user.privilege != 'administrator' && socket.user.privilege != 'moderator') {
+			if (!socket.user.admin && !socket.user.mod) {
 				socket.emit('message', { emphasis: true, text: '/mute is only available to admins and mods' });
 				break;
 			}
@@ -229,7 +242,7 @@ const executeCommand = (io, socket, command) => {
 		}
 
 		case '/unmute': {
-			if (socket.user.privilege != 'administrator' && socket.user.privilege != 'moderator') {
+			if (!socket.user.admin && !socket.user.mod) {
 				socket.emit('message', { emphasis: true, text: '/unmute is only available to admins and mods' });
 				break;
 			}

server/database/models/chatlog.js

@@ -2,7 +2,7 @@ const Sequelize = require('sequelize');
 const sequelize = require('..');
 
 module.exports = sequelize.define('chatlog', {
-	id: {
+	index: {
 		type: Sequelize.INTEGER(11),
 		allowNull: false,
 		autoIncrement: true,

server/database/models/index.js

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

server/database/models/reports.js

@@ -0,0 +1,17 @@
+const Sequelize = require('sequelize');
+const sequelize = require('..');
+
+module.exports = sequelize.define('reports', {
+	index: {
+		type: Sequelize.INTEGER(11),
+		allowNull: false,
+		autoIncrement: true,
+		primaryKey: true,
+		unique: true
+	},
+
+	reporter: {
+		type: 'varchar(320)',
+		allowNull: false
+	},
+});

server/server.js

@@ -7,19 +7,26 @@ const app = express();
 const server = require('http').Server(app);
 const io = require('socket.io')(server, {
 	cors: {
-		origin: '*'
+		origin: process.env.WEB_ORIGIN
 	}
 });
-const bodyParser = require('body-parser');
 const cors = require('cors');
 
 //config
-app.use(bodyParser.json());
+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');
 
+//admin stuff
+app.use('/admin', require('./admin'));
+
 //access the chat
 require('./chat')(io.of('/chat'));
 

server/utilities/token-auth.js

@@ -0,0 +1,21 @@
+const jwt = require('jsonwebtoken');
+
+//middleware to authenticate the JWT token
+module.exports = (req, res, next) => {
+	const authHeader = req.headers['authorization'];
+	const token = authHeader?.split (' ')[1]; //'Bearer token'
+
+	if (!token) {
+		return res.status(401).send('No token found');
+	}
+
+	return jwt.verify(token, process.env.SECRET_ACCESS, (err, user) => {
+		if (err) {
+			return res.status(403).send(err);
+		}
+
+		req.user = user;
+
+		return next();
+	});
+};

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'@'%';