Trying to make clearer structure and include idea of having generic tasks within the api

Author: norkator

.env_template

@@ -1,6 +1,11 @@
 # Can be 'development' or 'production'
 NODE_ENV=development
 
+# Server
+USE_HTTPS=false
+KEY_LOCATION=/etc/letsencrypt/live/any.example.com/privkey.pem
+CERT_LOCATION=/etc/letsencrypt/live/any.example.com/cert.pem
+
 # Your app port
 PORT=3000
 
@@ -9,7 +14,7 @@ DB_DIALECT=postgres
 DB_HOST=localhost
 DB_PORT=5432
 DB_USER=postgres
-DB_PASSWD=some_password
+DB_PASSWORD=some_password
 DB_DATABASE=example
 
 # Sequelize logging

nodemon.json

@@ -1,5 +1,5 @@
 {
     "watch": ["src"],
     "ext": "ts",
-    "exec": "ts-node ./src/server/index.ts"
+    "exec": "ts-node ./src/app.ts"
 }

package.json

@@ -1,11 +1,11 @@
 {
   "name": "node-express-orm-typescript-template",
   "version": "1.0.0",
-  "description": "Simple API template",
+  "description": "Simplified ts api, app template",
   "main": "./build/index.js",
   "scripts": {
     "build": "tsc --skipLibCheck",
-    "start": "tsc --skipLibCheck && node ./build/config/server/index.js",
+    "start": "tsc --skipLibCheck && node ./build/app.js",
     "ts:watch": "tsc -w"
   },
   "repository": {

src/components/Authentication/index.ts renamed to src/api/components/Authentication/index.ts

@@ -1,9 +1,9 @@
 import {NextFunction, Request, Response} from 'express';
 import app from "../../server/server";
-import HttpError from "../../server/error";
+import HttpError from "../../server/error/index";
 import * as jwt from 'jsonwebtoken';
-import {UserModelInterface} from "../../database/models/user";
-import * as User from '../../database/dao/user'
+import {UserModelInterface} from "../../../database/models/user";
+import * as User from '../../../database/dao/user'
 import * as bcrypt from 'bcrypt';
 
 /**

src/components/Example/index.ts renamed to src/api/components/Example/index.ts

@@ -1,4 +1,4 @@
-import * as AuthenticationComponent from './Authentication'
+import * as AuthenticationComponent from './Authentication/index'
 import * as ExampleComponent from './Example/index';
 
 export {

src/components/index.ts renamed to src/api/components/index.ts

@@ -1,4 +1,4 @@
-import {AuthenticationComponent} from '../components';
+import {AuthenticationComponent} from '../components/index';
 import {Router} from 'express';
 
 /**

src/routes/AuthenticationRouter.ts renamed to src/api/routes/AuthenticationRouter.ts

@@ -1,5 +1,5 @@
 import {Router} from 'express'
-import {ExampleComponent} from '../components'
+import {ExampleComponent} from '../components/index'
 import * as jwtConfig from "../server/jwtAuth";
 
 /**

src/routes/ExampleRouter.ts renamed to src/api/routes/ExampleRouter.ts

@@ -4,11 +4,11 @@ import * as swaggerJsdoc from 'swagger-jsdoc'
 import * as swaggerUi from 'swagger-ui-express';
 import * as jwtConfig from '../server/jwtAuth';
 
-import AuthenticationRouter from '../routes/AuthenticationRouter'
-import ExampleRouter from '../routes/ExampleRouter'
+import AuthenticationRouter from './AuthenticationRouter'
+import ExampleRouter from './ExampleRouter'
 
 
-const swaggerOptions = require('../../swagger');
+const swaggerOptions = require('../../../swagger');
 
 
 const swaggerSpecs = swaggerJsdoc(swaggerOptions);

src/routes/index.ts renamed to src/api/routes/index.ts

@@ -1,6 +1,6 @@
 import * as jwt from 'jsonwebtoken';
 import {NextFunction, Request, Response} from 'express';
-import HttpError from '../server/error';
+import HttpError from './error/index';
 import * as http from 'http';
 import app from "./server";
 

src/server/error/index.ts renamed to src/api/server/error/index.ts

@@ -0,0 +1,14 @@
+import * as express from 'express';
+import * as Middleware from './middleware';
+import * as Routes from '../routes/index';
+import * as dotEnv from 'dotenv'
+
+dotEnv.config();
+
+const app: express.Application = express();
+
+Middleware.configure(app);
+Routes.init(app);
+Middleware.initErrorHandler(app);
+
+export default app;

src/server/error/sendHttpError.ts renamed to src/api/server/error/sendHttpError.ts

@@ -0,0 +1,45 @@
+import * as dbTools from './database/dbTools'
+import * as http from 'http';
+import * as https from 'https';
+import * as eventHandlers from './api/server/eventHandlers';
+import server from './api/server/server';
+import * as loggingUtil from './app/loggingUtil'
+import * as dotEnv from 'dotenv'
+import {readFileSync} from 'fs';
+import * as app from "./app";
+
+dotEnv.config();
+
+dbTools.dbExists().then(() => {
+
+    /**
+     * API
+     */
+    if (process.env.USE_HTTPS === 'true') {
+        const options = {
+            key: readFileSync(process.env.KEY_LOCATION),
+            cert: readFileSync(process.env.CERT_LOCATION),
+        };
+        const Server: https.Server = https.createServer(options, server);
+        Server.listen(process.env.PORT);
+        loggingUtil.logInfo('Server running at port ' + process.env.PORT);
+        Server.on('error', (error: Error) => eventHandlers.onError(error, process.env.PORT));
+        Server.on('listening', eventHandlers.onListening.bind(Server));
+
+    } else {
+        const Server: http.Server = http.createServer(server);
+        Server.listen(process.env.PORT);
+        loggingUtil.logInfo('Server running at port ' + process.env.PORT);
+        Server.on('error', (error: Error) => eventHandlers.onError(error, process.env.PORT));
+        Server.on('listening', eventHandlers.onListening.bind(Server));
+
+    }
+
+    /**
+     * Jobs
+     */
+    app.app();
+
+}).catch(() => {
+    process.exit();
+});

src/server/eventHandlers.ts renamed to src/api/server/eventHandlers.ts

@@ -0,0 +1,15 @@
+const schedule = require('node-schedule');
+import * as utils from './utils/utils'
+
+export function app(): void {
+
+    // Register scheduled tasks
+    schedule.scheduleJob('* * 6 * * *', () => { // Every 6 hours
+        utils.exampleTask().then(result => {
+        }).catch(error => {
+        });
+    });
+
+    /* More tasks here? */
+
+}

src/server/jwtAuth.ts renamed to src/api/server/jwtAuth.ts

@@ -0,0 +1,20 @@
+import * as dotEnv from 'dotenv'
+
+dotEnv.config();
+
+
+function loggingEnabled(): boolean {
+    return process.env.NODE_ENV === 'development';
+}
+
+export function logInfo(str: string) {
+    if (loggingEnabled()) {
+        console.info(str);
+    }
+}
+
+export function logError(str: string) {
+    if (loggingEnabled()) {
+        console.error(str);
+    }
+}

src/server/middleware.ts renamed to src/api/server/middleware.ts

@@ -0,0 +1,17 @@
+import * as loggingUtil from "../loggingUtil";
+import * as dotEnv from 'dotenv'
+
+dotEnv.config();
+
+export async function exampleTask(): Promise<boolean> {
+    try {
+        return await examplePromiseFunction;
+    } catch (error) {
+        loggingUtil.logError(error);
+        return false;
+    }
+}
+
+const examplePromiseFunction = new Promise<boolean>((resolve, reject) => {
+    resolve(true);
+});

src/api/server/server.ts

@@ -0,0 +1,37 @@
+import * as dotEnv from 'dotenv'
+import * as loggingUtil from '../app/loggingUtil'
+
+const pgTools = require('pgtools');
+
+dotEnv.config();
+
+
+export async function dbExists(): Promise<boolean> {
+    try {
+        return await createDatabase;
+    } catch (error) {
+        loggingUtil.logError(error);
+        return false;
+    }
+}
+
+
+const createDatabase = new Promise<boolean>((resolve, reject) => {
+    loggingUtil.logInfo('Pg tools checking database existence...');
+    pgTools.createdb({
+        user: process.env.DB_USER,
+        password: process.env.DB_PASSWORD,
+        port: process.env.DB_PORT,
+        host: process.env.DB_HOST
+        // @ts-ignore
+    }, process.env.DB_DATABASE, function (error, response) {
+        if (!error) {
+            loggingUtil.logInfo('db ' + process.env.DB_DATABASE + ' did not exists. Created it.');
+            resolve(true);
+        } else {
+            loggingUtil.logError(error);
+            reject(false);
+        }
+    });
+
+});

src/app.ts

@@ -0,0 +1,34 @@
+import {Dialect, Sequelize} from 'sequelize'
+import * as dotEnv from 'dotenv'
+import * as loggingUtil from "../app/loggingUtil";
+
+dotEnv.config();
+
+const sequelize = new Sequelize(
+    process.env.DB_DATABASE,
+    process.env.DB_USER,
+    process.env.DB_PASSWORD,
+    {
+        port: Number(process.env.DB_PORT),
+        host: process.env.DB_HOST,
+        dialect: process.env.DB_DIALECT as Dialect,
+        pool: {
+            max: 10,
+            min: 0,
+            idle: 10000
+        },
+        logging: function (str) {
+            if ((process.env.SEQ_LOGGING === 'true')) {
+                console.info(str);
+            }
+        },
+    }
+);
+
+sequelize.sync().then(function () {
+    loggingUtil.logInfo('DB connection success.');
+}, function (err) {
+    loggingUtil.logError(JSON.stringify(err));
+});
+
+export default sequelize