Merge branch 'polishing' of github.com:Musare/MusareNode into polishing

README.md

@@ -41,6 +41,7 @@ We currently only utilize 1 backend, 1 MongoDB server and 1 Redis server running
     | Property | Description |
     | --- | --- |
     | `mode` | Should be either `development` or `production`. No more explanation needed. |
+    | `migration` | Should be set to true if you need to update DB documents to a newer version after an update. Should be false at all other times. |
     | `secret` | Whatever you want - used by express's session module. |
     | `domain` | Should be the url where the site will be accessible from,usually `http://localhost` for non-Docker. |
     | `serverDomain` | Should be the url where the backend will be accessible from, usually `http://localhost:8080` for non-Docker. |
@@ -59,6 +60,9 @@ We currently only utilize 1 backend, 1 MongoDB server and 1 Redis server running
     | `mongo.url` | Needs to have the proper password for the MongoDB musare user, and for non-Docker you need to replace `@musare:27017` with `@localhost:27017`. |
     | `cookie.domain` | Should be the ip or address you use to access the site, without protocols (http/https), so for example `localhost`. |
     | `cookie.secure` | Should be `true` for SSL connections, and `false` for normal http connections. |
+    | `skipConfigVersionCheck` | Skips checking if the config version is outdated or not. Should almost always be set to false. |
+    | `skipDbDocumentsVersionCheck` | Skips checking if there are any DB documents outdated or not. Should almost always be set to false. |
+    | `configVersion` | Version of the config. Every time the template changes, you should change your config accordingly and update the configVersion. |
 
 4. `cp frontend/build/config/template.json frontend/build/config/default.json`
 
@@ -74,6 +78,8 @@ We currently only utilize 1 backend, 1 MongoDB server and 1 Redis server running
     | `siteSettings.logo` | Path to the logo image, by default it is `/assets/wordmark.png`. |
     | `siteSettings.siteName` | Should be the name of the site. |
     | `siteSettings.github` | URL of GitHub repository, defaults to `https://github.com/Musare/MusareNode`. |
+    | `skipConfigVersionCheck` | Skips checking if the config version is outdated or not. Should almost always be set to false. |
+    | `configVersion` | Version of the config. Every time the template changes, you should change your config accordingly and update the configVersion. |
 
 5. Simply `cp .env.example .env` to setup your environment variables.
 

backend/config/template.json

@@ -57,6 +57,8 @@
 		"secure": false,
 		"SIDname": "SID"
 	},
+	"skipConfigVersionCheck": false,
+	"skipDbDocumentsVersionCheck": false,
 	"debug": {
 		"stationIssue": false,
 		"traceUnhandledPromises": false,
@@ -90,5 +92,6 @@
                 "Requeing"
             ]
         }
-    }
+	},
+	"configVersion": 1
 }

backend/index.js

@@ -3,6 +3,8 @@ import "./loadEnvVariables.js";
 import util from "util";
 import config from "config";
 
+const REQUIRED_CONFIG_VERSION = 1;
+
 // eslint-disable-next-line
 Array.prototype.remove = function (item) {
 	this.splice(this.indexOf(item), 1);
@@ -27,6 +29,16 @@ console.log = (...args) => {
 	if (!blacklisted) oldConsole.log.apply(null, args);
 };
 
+if (
+	(!config.has("configVersion") || config.get("configVersion") !== REQUIRED_CONFIG_VERSION) &&
+	!(config.has("skipConfigVersionCheck") && config.get("skipConfigVersionCheck"))
+) {
+	console.log(
+		"CONFIG VERSION IS WRONG. PLEASE UPDATE YOUR CONFIG WITH THE HELP OF THE TEMPLATE FILE AND THE README FILE."
+	);
+	process.exit();
+}
+
 const fancyConsole = config.get("fancyConsole");
 
 if (config.debug && config.debug.traceUnhandledPromises === true) {

backend/logic/db/index.js

@@ -1,9 +1,22 @@
 import config from "config";
 import mongoose from "mongoose";
 import bluebird from "bluebird";
+import async from "async";
 
 import CoreClass from "../../core";
 
+const REQUIRED_DOCUMENT_VERSIONS = {
+	activity: 1,
+	news: 1,
+	playlist: 1,
+	punishment: 1,
+	queueSong: 1,
+	report: 1,
+	song: 1,
+	station: 1,
+	user: 1
+};
+
 const regex = {
 	azAZ09_: /^[A-Za-z0-9_]+$/,
 	az09_: /^[a-z0-9_]+$/,
@@ -259,7 +272,16 @@ class _DBModule extends CoreClass {
 							"Invalid description."
 						);
 
-					resolve();
+					if (config.get("skipDbDocumentsVersionCheck")) resolve();
+					else {
+						this.runJob("CHECK_DOCUMENT_VERSIONS", {}, null, -1)
+							.then(() => {
+								resolve();
+							})
+							.catch(err => {
+								reject(err);
+							});
+					}
 				})
 				.catch(err => {
 					this.log("ERROR", err);
@@ -268,6 +290,35 @@ class _DBModule extends CoreClass {
 		});
 	}
 
+	/**
+	 * Checks if all documents have the correct document version
+	 *
+	 * @returns {Promise} - returns promise (reject, resolve)
+	 */
+	CHECK_DOCUMENT_VERSIONS() {
+		return new Promise((resolve, reject) => {
+			async.each(
+				Object.keys(REQUIRED_DOCUMENT_VERSIONS),
+				(modelName, next) => {
+					const model = DBModule.models[modelName];
+					const requiredDocumentVersion = REQUIRED_DOCUMENT_VERSIONS[modelName];
+					model.countDocuments({ documentVersion: { $ne: requiredDocumentVersion } }, (err, count) => {
+						if (err) next(err);
+						else if (count > 0)
+							next(
+								`Collection "${modelName}" has ${count} documents with a wrong document version. Run migration.`
+							);
+						else next();
+					});
+				},
+				err => {
+					if (err) reject(new Error(err));
+					else resolve();
+				}
+			);
+		});
+	}
+
 	/**
 	 * Returns a database model
 	 *

frontend/dist/config/template.json

@@ -16,5 +16,7 @@
 		"logo_blue": "/assets/blue_wordmark.png",
 		"siteName": "Musare",
 		"github": "https://github.com/Musare/MusareNode"
-	}
+	},
+	"skipConfigVersionCheck": false,
+	"configVersion": 1
 }

frontend/dist/index.tpl.html

@@ -36,7 +36,7 @@
 	<link rel='stylesheet' href='/index.css'>
 	<script src='https://www.youtube.com/iframe_api'></script>
 	<script type='text/javascript' src='/vendor/can-autoplay.min.js'></script>
-	<script src="/vendor/socket.io.2.2.0.js" integrity="sha256-yr4fRk/GU1ehYJPAs8P4JlTgu0Hdsp4ZKrx8bDEDC3I="></script>
+	<script src="/vendor/socket.io.2.2.0.js"></script>
 	<script type='text/javascript' src='/vendor/lofig.1.3.3.min.js'></script>
 </head>
 <body>

frontend/src/main.js

@@ -6,6 +6,8 @@ import store from "./store";
 import App from "./App.vue";
 import io from "./io";
 
+const REQUIRED_CONFIG_VERSION = 1;
+
 const handleMetadata = attrs => {
 	document.title = `Musare | ${attrs.title}`;
 };
@@ -136,7 +138,17 @@ const router = new VueRouter({
 });
 
 lofig.folder = "../config/default.json";
-lofig.get("serverDomain").then(serverDomain => {
+lofig.fetchConfig().then(config => {
+	const { configVersion, skipConfigVersionCheck } = config;
+	if (configVersion !== REQUIRED_CONFIG_VERSION && !skipConfigVersionCheck) {
+		// eslint-disable-next-line no-alert
+		alert(
+			"CONFIG VERSION IS WRONG. PLEASE UPDATE YOUR CONFIG WITH THE HELP OF THE TEMPLATE FILE AND THE README FILE."
+		);
+		window.stop();
+	}
+
+	const { serverDomain } = config;
 	io.init(serverDomain);
 	io.getSocket(socket => {
 		socket.on("ready", (loggedIn, role, username, userId) => {