Enforce new code style via TSLint

Author: darnfish

.editorconfig

@@ -5,13 +5,13 @@ root = true
 [*]
 charset = utf-8
 end_of_line = lf
-indent_size = 4
-indent_style = space
+indent_size = 2
+indent_style = tab
 insert_final_newline = true
 trim_trailing_whitespace = true
 
 [*.md]
-trim_trailing_whitespace = false
+trim_trailing_whitespace = true
 
 [*.json]
 indent_size = 2

README.md

@@ -9,6 +9,7 @@ _**API** - Core services_
     * [Status](#status)
 * [Codebase](#codebase)
     * [Folder Structure](#folder-structure)
+		* [Code Style](#code-style)
     * [First time setup](#first-time-setup)
         * [Installation](#installation)
     * [Running the app locally](#running-the-app-locally)
@@ -29,6 +30,13 @@ The codebase for `@cryb/api` is written in JavaScript, utilising TypeScript and
 
 MongoDB is used as the primary database, while Redis is used for cache and PUB/SUB.
 
+### Code Style
+We ask that you follow our [code style guidelines](https://github.com/crybapp/library/blob/master/code-style/STYLE.md) when contributing to this repository.
+
+We use TSLint in order to lint our code. Run `yarn lint` before committing any code to ensure it's clean.
+
+*Note: while we have most rules covered in our `tslint.json` config, it's good practice to familarise yourself with our code style guidelines*
+
 ### Folder Structure
 ```
 cryb/api/

package.json

@@ -9,7 +9,8 @@
   "scripts": {
     "start": "node dist",
     "dev": "tsc-watch --outDir ./dist --onSuccess \"yarn start\" --compiler typescript/bin/tsc",
-    "build": "tsc"
+    "build": "tsc",
+    "lint": "tslint src/**/*.ts{,x}"
   },
   "dependencies": {
     "axios": "^0.19.0",
@@ -39,6 +40,7 @@
   "devDependencies": {
     "@types/chance": "^1.0.6",
     "@types/cors": "^2.8.6",
+    "@types/dotenv": "^8.2.0",
     "@types/express": "^4.17.0",
     "@types/ioredis": "^4.0.17",
     "@types/lodash": "^4.14.144",
@@ -48,6 +50,7 @@
     "@types/passport": "^1.0.0",
     "@types/passport-discord": "^0.1.3",
     "@types/passport-jwt": "^3.0.1",
-    "@types/ws": "^6.0.1"
+    "@types/ws": "^6.0.1",
+    "tslint": "^5.20.1"
   }
 }

src/config/defaults.ts

@@ -1,22 +1,32 @@
 export default {
-    /**
-     * The amount of members a room needs to hit for a Portal (VM) to be created / queued (default 2)
-     */
-    min_member_portal_creation_count: parseInt(process.env.MIN_MEMBER_PORTAL_CREATION_COUNT || '2'),
+	/**
+	 * The amount of members a room needs to hit for a Portal (VM) to be created / queued (default 2)
+	 */
+	min_member_portal_creation_count: parseInt(process.env.MIN_MEMBER_PORTAL_CREATION_COUNT || '2'),
 
-    /**
-     * The maximum amount of members a room can have (default 10)
-     */
-    max_room_member_count: parseInt(process.env.MAX_ROOM_MEMBER_COUNT || '10'),
+	/**
+	 * The maximum amount of members a room can have (default 10)
+	 */
+	max_room_member_count: parseInt(process.env.MAX_ROOM_MEMBER_COUNT || '10'),
 
-    /**
-     * Whenever destroy portals when room gets empty
-     */
-    destroy_portal_when_empty: typeof process.env.DESTROY_PORTAL_WHEN_EMPTY !== 'undefined' ?
-                                (process.env.DESTROY_PORTAL_WHEN_EMPTY === 'true') : true,
+	/**
+	 * Whenever destroy portals when room gets empty
+	 */
+	destroy_portal_when_empty: typeof process.env.DESTROY_PORTAL_WHEN_EMPTY !== 'undefined' ?
+		(process.env.DESTROY_PORTAL_WHEN_EMPTY === 'true') : true,
 
-    /**
-     * The timeout before an empty room gets their portal destroyed in seconds (default 5)
-     */
-    empty_room_portal_destroy: parseInt(process.env.EMPTY_ROOM_PORTAL_DESTROY || '5')
-}
+	/**
+	 * The timeout before an empty room gets their portal destroyed in seconds (default 5)
+	 */
+	empty_room_portal_destroy: parseInt(process.env.EMPTY_ROOM_PORTAL_DESTROY || '5'),
+
+	/**
+	 * The user IDs that are allowed to create rooms, comma (,) separated
+	 */
+	room_whitelist: (process.env.ROOM_WHITELIST === 'true'),
+
+	/**
+	 * The user IDs that are allowed to create rooms, comma (,) separated
+	 */
+	allowed_user_ids: (process.env.ALLOWED_USER_IDS || '').split(',')
+}

src/config/passport.config.ts

@@ -1,74 +1,76 @@
 import axios from 'axios'
+import { NextFunction, Request, Response } from 'express'
 import passport from 'passport'
-import { Strategy, ExtractJwt } from 'passport-jwt'
-import { Request, Response, NextFunction } from 'express'
-
+import { ExtractJwt, Strategy } from 'passport-jwt'
 import User from '../models/user'
 
-import { handleError, UserNoAuth } from '../utils/errors.utils'
+import { handleError, UserBanned, UserNoAuth } from '../utils/errors.utils'
 
 passport.serializeUser((user, done) => done(null, user))
 passport.deserializeUser((id, done) => done(null, id))
 
 passport.use(new Strategy({
-    jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
-    secretOrKey: process.env.JWT_KEY
+	jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
+	secretOrKey: process.env.JWT_KEY
 }, async ({ id }, done) => {
-    try {
-        const user = await new User().load(id)
+	try {
+		const user = await new User().load(id)
 
-        return done(null, user)
-    } catch(error) {
-        done(error)
-    }
+		return done(null, user)
+	} catch (error) {
+		done(error)
+	}
 }))
 
 const BAN_SAFE_ENDPOINTS = [
-    'GET /user/me'
+	'GET /user/me'
 ]
 
 const fetchEndpoint = (req: Request) => `${req.method} ${req.baseUrl}${req.route.path}`
 
-const fetchUser = async (req: Request, res: Response, next: NextFunction) => new Promise<User>(async (resolve, reject) => {
-    try {
-        if(process.env.AUTH_BASE_URL) {
-            const { authorization } = req.headers,
-                    token = authorization.split(' ')[1],
-                    { data } = await axios.post(process.env.AUTH_BASE_URL, { token }),
-                    user = new User(data)
-    
-            resolve(user)
-        } else {
-            passport.authenticate('jwt', { session: false }, async (err, user: User) => {
-                if(err) return res.sendStatus(500)
-                if(!user) return res.sendStatus(401)
-        
-                resolve(user)
-            })(req, res, next)
-        }
-    } catch(error) {
-        reject(error)
-    }
+const fetchUser = async (
+	req: Request,
+	res: Response,
+	next: NextFunction
+) => new Promise<User>(async (resolve, reject) => {
+	try {
+		if (process.env.AUTH_BASE_URL) {
+			const { authorization } = req.headers,
+				token = authorization.split(' ')[1],
+				{ data } = await axios.post(process.env.AUTH_BASE_URL, { token }),
+				user = new User(data)
+
+			resolve(user)
+		} else
+			passport.authenticate('jwt', { session: false }, async (err, user: User) => {
+				if (err) return res.sendStatus(500)
+				if (!user) return handleError(UserNoAuth, res)
+
+				resolve(user)
+			})(req, res, next)
+	} catch (error) {
+		reject(error)
+	}
 })
 
 export const authenticate = async (req: Request, res: Response, next: NextFunction) => {
-    try {
-        const user = await fetchUser(req, res, next),
-                endpoint = fetchEndpoint(req),
-                ban = await user.fetchBan()
-        
-        if(ban && BAN_SAFE_ENDPOINTS.indexOf(endpoint) > -1)
-            return handleError('UserBanned', res)
+	try {
+		const user = await fetchUser(req, res, next),
+			endpoint = fetchEndpoint(req),
+			ban = await user.fetchBan()
+
+		if (ban && BAN_SAFE_ENDPOINTS.indexOf(endpoint) > -1)
+			return handleError(UserBanned, res)
 
-        if(req.baseUrl === '/admin' && user.roles.indexOf('admin') === -1)
-            return handleError(UserNoAuth, res)
+		if (req.baseUrl === '/admin' && user.roles.indexOf('admin') === -1)
+			return handleError(UserNoAuth, res)
 
-        req.user = user
+		req.user = user
 
-        next()
-    } catch(error) {
-        handleError(error, res)
-    }
+		next()
+	} catch (error) {
+		handleError(error, res)
+	}
 }
 
 export default passport

src/config/redis.config.ts

@@ -1,37 +1,37 @@
-import { URL } from 'url'
 import Redis from 'ioredis'
+import { URL } from 'url'
 
-interface Sentinel {
-    host: string
-    port: number
+interface ISentinel {
+	host: string
+	port: number
 }
 
 const parseSentinels = (sentinels: string) =>
-        sentinels.split(',').map(uri => ({
-            host: uri.split(':')[1].replace('//', ''),
-            port: parseInt(uri.split(':')[2])
-        } as Sentinel)), // Parse sentinels from process env
-        getOptions = () => { // Get Options Method
-            if(!process.env.REDIS_URI && !process.env.REDIS_SENTINELS)
-                throw 'No value was found for REDIS_URI or REDIS_SENTINELS - make sure .env is setup correctly!'
-            
-            if(process.env.REDIS_SENTINELS)
-                return {
-                    sentinels: parseSentinels(process.env.REDIS_SENTINELS),
-                    name: 'mymaster'
-                } as Redis.RedisOptions
+	sentinels.split(',').map(uri => ({
+		host: uri.split(':')[1].replace('//', ''),
+		port: parseInt(uri.split(':')[2])
+	} as ISentinel)), // Parse sentinels from process env
+	getOptions = () => { // Get Options Method
+		if (!process.env.REDIS_URI && !process.env.REDIS_SENTINELS)
+			throw new Error('No value was found for REDIS_URI or REDIS_SENTINELS - make sure .env is setup correctly!')
+
+		if (process.env.REDIS_SENTINELS)
+			return {
+				sentinels: parseSentinels(process.env.REDIS_SENTINELS),
+				name: 'mymaster'
+			} as Redis.RedisOptions
 
-            if(process.env.REDIS_URI) {
-                const uri = new URL(process.env.REDIS_URI)
+		if (process.env.REDIS_URI) {
+			const uri = new URL(process.env.REDIS_URI)
 
-                return {
-                    host: uri.hostname || 'localhost',
-                    port: parseInt(uri.port) || 6379,
-                    db: parseInt(uri.pathname) || 0,
-                    password: uri.password ? decodeURIComponent(uri.password) : null
-                } as Redis.RedisOptions
-            }
-        }
+			return {
+				host: uri.hostname || 'localhost',
+				port: parseInt(uri.port) || 6379,
+				db: parseInt(uri.pathname) || 0,
+				password: uri.password ? decodeURIComponent(uri.password) : null
+			} as Redis.RedisOptions
+		}
+	}
 
 export const createPubSubClient = () => new Redis(getOptions())