Merge pull request #2 from Gambitier/database-setup

Database setup

Author: gambitier

Projects/BooksLibrary/.env.sample

@@ -1,4 +1,9 @@
 BASE_URL=http://localhost:7272/api/v1
 PORT=7272
 NODE_ENV=development
-API_VERSION=0.0.1
+API_VERSION=0.0.1
+
+DB_USER_NAME = someusername
+DB_USER_PASSWORD = somepass
+DB_NAME = somename
+DB_HOST = host

Projects/BooksLibrary/package-lock.json

@@ -5,8 +5,8 @@
     "main": "src/index.ts",
     "scripts": {
         "build": "tsc",
-        "start": "tsc && ts-node --files ./src/index.ts",
-        "start:dev": "tsc && ts-node --files ./src/index.ts --watch",
+        "rebuild": "rimraf dist && tsc",
+        "start": "ts-node -r tsconfig-paths/register src/index.ts",
         "lint:fix": "eslint ./src/** --fix"
     },
     "author": "akash jadhav",
@@ -17,11 +17,14 @@
         "@types/express-fileupload": "^1.2.2",
         "@types/jsonwebtoken": "^8.5.8",
         "@types/node": "^17.0.21",
+        "@types/uuid": "^8.3.4",
         "@typescript-eslint/eslint-plugin": "^5.13.0",
         "@typescript-eslint/parser": "^5.13.0",
         "eslint": "^8.10.0",
         "eslint-config-google": "^0.14.0",
         "prettier": "2.5.1",
+        "ts-node": "^10.7.0",
+        "tsconfig-paths": "^3.13.0",
         "typescript": "^4.6.2"
     },
     "dependencies": {
@@ -30,7 +33,10 @@
         "express": "^4.17.3",
         "express-fileupload": "^1.3.1",
         "jsonwebtoken": "^8.5.1",
+        "pg": "^8.7.3",
         "reflect-metadata": "^0.1.13",
+        "sequelize": "^6.17.0",
+        "sequelize-typescript": "^2.1.3",
         "tsyringe": "^4.6.0"
     }
 }

Projects/BooksLibrary/package.json

@@ -7,7 +7,7 @@
     "Database": {
         "Type": "SQL",
         "ORM": "Sequelize",
-        "Flavour": "MySQL"
+        "Flavour": "PostGreSQL"
     },
     "FileStorage": {
         "Provider": "AWS-S3"

Projects/BooksLibrary/src/app.config.json

@@ -37,6 +37,13 @@ export default class Application {
             //Load the modules
             await Loader.init();
 
+            if (process.env.NODE_ENV === 'test') {
+                await Loader.databaseConnector.dropDatabase();
+            }
+
+            //Connect with database
+            await Loader.databaseConnector.init();
+
             //Set-up middlewares
             await this.setupMiddlewares();
 

Projects/BooksLibrary/src/app.ts

@@ -1,17 +1,37 @@
-import { AuthenticationType, AuthorizationType, Configurations } from './configuration.types';
-import * as AppConfig from '../app.config.json';
+import {
+    AuthenticationType,
+    AuthorizationType,
+    Configurations,
+    DatabaseFlavour,
+    DatabaseORM,
+    DatabaseType,
+} from './configuration.types';
+import * as configuration from '../app.config.json';
 
 export class ConfigurationManager {
     static _config: Configurations = null;
 
+    public static DatabaseFlavour = (): DatabaseFlavour => {
+        return ConfigurationManager._config.Database.Flavour;
+    };
+
+    public static DatabaseType = (): DatabaseType => {
+        return ConfigurationManager._config.Database.Type;
+    };
+
     public static loadConfigurations = (): void => {
         ConfigurationManager._config = {
             BaseUrl: process.env.BASE_URL,
             SystemIdentifier: '',
             MaxUploadFileSize: 0,
             Auth: {
-                Authentication: AppConfig.Auth.Authentication as AuthenticationType,
-                Authorization: AppConfig.Auth.Authorization as AuthorizationType,
+                Authentication: configuration.Auth.Authentication as AuthenticationType,
+                Authorization: configuration.Auth.Authorization as AuthorizationType,
+            },
+            Database: {
+                Type: configuration.Database.Type as DatabaseType,
+                ORM: configuration.Database.ORM as DatabaseORM,
+                Flavour: configuration.Database.Flavour as DatabaseFlavour,
             },
         };
     };

Projects/BooksLibrary/src/config/configuration.manager.ts

@@ -1,10 +1,22 @@
 export type AuthorizationType = 'Custom'; //TBD: Other options need to be supported
 export type AuthenticationType = 'Custom'; //TBD: Other options need to be supported
+
+export type DatabaseFlavour = 'MySQL' | 'PostGreSQL' | 'MongoDB';
+export type DatabaseType = 'SQL' | 'NoSQL';
+export type DatabaseORM = 'Sequelize' | 'Knex' | 'Mongoose';
+
+export interface DatabaseConfig {
+    Type: DatabaseType;
+    ORM: DatabaseORM;
+    Flavour: DatabaseFlavour;
+}
+
 export interface Configurations {
     SystemIdentifier: string;
     BaseUrl: string;
     MaxUploadFileSize: number;
     Auth: AuthConfig;
+    Database: DatabaseConfig;
 }
 export interface AuthConfig {
     Authentication: AuthenticationType;

Projects/BooksLibrary/src/config/configuration.types.ts

@@ -0,0 +1,13 @@
+export interface IDatabaseConnector {
+    connect(): Promise<boolean>;
+
+    sync(): Promise<boolean>;
+
+    createDatabase(): Promise<boolean>;
+
+    dropDatabase(): Promise<boolean>;
+
+    executeQuery(query: string): Promise<boolean>;
+
+    migrate(): Promise<boolean>;
+}

Projects/BooksLibrary/src/database/database.connector.interface.ts

@@ -0,0 +1,28 @@
+import { Logger } from 'common/logger';
+import { inject, injectable } from 'tsyringe';
+import { IDatabaseConnector } from './database.connector.interface';
+
+@injectable()
+export class DatabaseConnector {
+    constructor(@inject('IDatabaseConnector') private _db: IDatabaseConnector) {}
+
+    public init = async (): Promise<boolean> => {
+        try {
+            await this._db.connect();
+            return true;
+        } catch (error) {
+            Logger.instance().log('Create database error: ' + error.message);
+            throw error;
+        }
+    };
+
+    public dropDatabase = async (): Promise<boolean> => {
+        try {
+            await this._db.dropDatabase();
+            return true;
+        } catch (error) {
+            Logger.instance().log('Drop database error: ' + error.message);
+            return false;
+        }
+    };
+}

Projects/BooksLibrary/src/database/database.connector.ts

@@ -0,0 +1,13 @@
+import { ConfigurationManager } from 'config/configuration.manager';
+import { DependencyContainer } from 'tsyringe';
+import { SQLInjector } from './sql/sql.injector';
+
+export class DatabaseInjector {
+    static registerInjections(container: DependencyContainer) {
+        //
+        const databaseType = ConfigurationManager.DatabaseType();
+        if (databaseType === 'SQL') {
+            SQLInjector.registerInjections(container);
+        }
+    }
+}