ORCT-117 - sequelize minimal model for runs per period view

app/application.js

@@ -19,7 +19,8 @@ const { buildPublicConfig } = require('./lib/config/publicConfigProvider.js');
 // Services
 const alimonitorServices = require('./lib/alimonitor-services');
 // Database
-const database = require('./lib/database');
+const { databaseManager } = require('./lib/database/DatabaseManager.js');
+const { databaseService } = require('./lib/database/DatabaseService.js');
 
 // Server
 const { webUiServer } = require('./lib/server');
@@ -43,7 +44,8 @@ class RunConditionTableApplication {
         this.logger = new Log(RunConditionTableApplication.name);
 
         this.webUiServer = webUiServer;
-        this.databaseService = database.databaseService;
+        this.databaseService = databaseService;
+        this.databaseManager = databaseManager;
         this.databaseService.healthcheckInsertData();
         this.syncManager = alimonitorServices.syncManager;
         this.defineEndpoints();
@@ -72,6 +74,7 @@ class RunConditionTableApplication {
     async run() {
         this.logger.info('Starting RCT app...');
         try {
+            await this.databaseManager.migrate();
             await this.httpServer.listen();
         } catch (error) {
             this.logger.error(`Error while starting RCT app: ${error}`);
@@ -103,7 +106,7 @@ class RunConditionTableApplication {
     }
 
     static isInDevMode() {
-        return process.env.ENV_MODE === 'development';
+        return process.env.ENV_MODE === 'dev';
     }
 
     static getEnvMode() {

app/lib/alimonitor-services/SyncManager.js

@@ -12,7 +12,7 @@
  * or submit itself to any jurisdiction.
  */
 const { Log } = require('@aliceo2/web-ui');
-const { databaseService } = require('../database');
+const { databaseService } = require('../database/DatabaseService.js');
 const config = require('../../config');
 
 const monalisaService = require('./MonalisaService');

app/lib/database/DatabaseManager.js

@@ -0,0 +1,98 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+ */
+
+const { Sequelize } = require('sequelize');
+const { Log } = require('@aliceo2/web-ui')
+const { Umzug, SequelizeStorage, memoryStorage } = require('umzug');
+const path = require('path')
+const config = require('../../config');
+const modelsFactory = require('./models');
+const repositoriesFactory = require('./repositories');
+
+/**
+ * Sequelize implementation of the Database.
+ */
+class DatabaseManager {
+    constructor() {
+        this.logger = new Log(DatabaseManager.name);
+        this.schema = 'public';
+
+        this.sequelize = new Sequelize({
+            ...config.database,
+            username: config.database.user, // TEMPORARILY
+            logging: config.database.logging ? this.logger.debug.bind(this.logger) : false,
+            dialect: 'postgres',
+            define: {
+                underscored: false,
+                schema: this.schema,
+            },
+        });
+        this.models = modelsFactory(this.sequelize);
+        this.repositories = repositoriesFactory(this.models);
+    }
+
+    /**
+     * Executes every *pending* migrations.
+     *
+     * @returns {Promise} Promise object represents the outcome.
+     */
+    async migrate() {
+        this.logger.info('Executing pending migrations...');
+
+        try {
+            const umzug = this.getUmzug(
+                path.join(__dirname, 'migrations'),
+                new SequelizeStorage({
+                    sequelize: this.sequelize,
+                }),
+            );
+
+            await umzug.up();
+        } catch (error) {
+            this.logger.error(`Error while executing migrations: ${error}`);
+            return Promise.reject(error);
+        }
+
+        this.logger.info('Executed pending migrations');
+    }
+
+    /**
+     * Returns a new Umzug instance for the given migration directory and storage
+     *
+     * @param {string} migrationsDirectory the path to the migrations directory
+     * @param {string} storage the data storage to use
+     * @return {Umzug} the Umzug instance
+     */
+    getUmzug(migrationsDirectory, storage) {
+        return new Umzug({
+            migrations: {
+                glob: `${migrationsDirectory}/*.js`,
+                resolve: ({ name, path: migrationPath, context }) => {
+                    const migration = require(migrationPath || '');
+
+                    return {
+                        name,
+                        up: async () => migration.up(context, Sequelize),
+                        down: async () => migration.down(context, Sequelize),
+                    };
+                },
+            },
+            context: this.sequelize.getQueryInterface(),
+            storage,
+        });
+    }
+}
+
+module.exports = {
+    databaseManager: new DatabaseManager(),
+};

app/lib/database/DatabaseService.js

@@ -13,8 +13,8 @@
  */
 
 const { Log } = require('@aliceo2/web-ui');
-const { Client, Pool } = require('pg');
-const QueryBuilder = require('./QueryBuilder.js');
+const { Pool } = require('pg');
+const { PGQueryBuilder } = require('./utilities');
 const config = require('./../config/configProvider.js');
 const {distinct} = require('../utils')
 
@@ -151,7 +151,7 @@ class DatabaseService {
         }
 
         try {
-            const query = QueryBuilder.buildSelect(params);
+            const query = PGQueryBuilder.buildSelect(params);
             await this.pgExec(query, connectErrorHandler, dbResponseHandler, dbResErrorHandler);
         } catch (e) {
             this.logger.error(e.stack)
@@ -176,7 +176,7 @@ class DatabaseService {
 
         try {
             await this.pgExec(
-                QueryBuilder.buildInsert(params), 
+                PGQueryBuilder.buildInsert(params), 
                 connectErrorHandler, 
                 dbResponseHandler, 
                 dbResErrorHandler);
@@ -207,4 +207,6 @@ class DatabaseService {
 
 }
 
-module.exports = new DatabaseService();
+module.exports = {
+    databaseService: new DatabaseService()
+};

app/lib/database/adapters/RunAdapter.js

@@ -0,0 +1,90 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+ */
+
+
+/**
+ * RunAdapter
+ */
+class RunAdapter {
+    /**
+     * Converts the given database object to an entity object.
+     *
+     * @param {SequelizeRun} databaseObject Object to convert.
+     * @returns {Run} Converted entity object.
+     */
+    toEntity(databaseObject) {
+        const {
+            runNumber,
+            timeO2Start,
+            timeO2End,
+            timeTrgStart,
+            timeTrgEnd,
+            startTime,
+            endTime,
+            runDuration,
+            fillNumber,
+            lhcBeamEnergy,
+            l3CurrentVal,
+            dipoleCurrentVal,
+        } = databaseObject;
+
+        return {
+            runNumber,
+            timeO2Start,
+            timeO2End,
+            timeTrgStart,
+            timeTrgEnd,
+            startTime,
+            endTime,
+            runDuration,
+            fillNumber,
+            lhcBeamEnergy,
+            l3CurrentVal,
+            dipoleCurrentVal,
+        }
+    }
+
+    /**
+     * Converts the given entity object to database object.
+     *
+     * @param {Run} databaseObject Object to convert.
+     * @returns {SequelizeRun} Converted entity object.
+     */
+    toDatabase(entityObject) {
+        const {
+            runNumber,
+            timeO2Start,
+            timeO2End,
+            timeTrgStart,
+            timeTrgEnd,
+            fillNumber,
+            lhcBeamEnergy,
+            l3CurrentVal,
+            dipoleCurrentVal,
+        } = entityObject;
+
+        return {
+            runNumber,
+            timeO2Start,
+            timeO2End,
+            timeTrgStart,
+            timeTrgEnd,
+            fillNumber,
+            lhcBeamEnergy,
+            l3CurrentVal,
+            dipoleCurrentVal,
+        }
+    }
+}
+
+module.exports = RunAdapter;

app/lib/database/adapters/index.js

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+ */
+
+const RunAdapter = require('./RunAdapter');
+
+const runAdapter = new RunAdapter();
+
+module.exports = {
+    runAdapter,
+}