[O2B-1104] environment history occurrences API (#1327)

* [O2B-1104] add router, controller, service and repository for environment history histogram api

* [O2B-1104] changed the naming for some of the api variables

* [O2B-1104] Altered query so that it excludes history without DESTROYED or ERROR at the end and changed filter

* [O2B-1104] Added StatisticsService tests for the history occurences endpoint

* [O2B-1104] Redefined the way to check if ERROR or DESTROYED are in a given environement

* [O2B-1104] Implemented changes requested in the PR

Author: SandroBoelsz

lib/database/repositories/EnvironmentHistoryItemRepository.js

@@ -11,8 +11,32 @@
  * or submit itself to any jurisdiction.
  */
 
-const { models: { EnvironmentHistoryItem } } = require('../');
+const { models: { EnvironmentHistoryItem }, sequelize } = require('../');
 const Repository = require('./Repository');
+const { timestampToMysql } = require('../../server/utilities/timestampToMysql.js');
+
+/**
+ * Returns the SQL query for fetching the environment history combinations and
+ * their occurrences within a specified time period.
+ *
+ * @param {Period} period the period on which the occurrences must be counted
+ * @return {string} the raw SQL query
+ */
+const getHistoryDistributionQuery = ({ from, to }) => `
+    SELECT statusHistory, COUNT(*) AS count
+    FROM (
+        SELECT e.id, GROUP_CONCAT(ehi.status) AS statusHistory
+        FROM environments e
+        INNER JOIN environments_history_items AS ehi 
+        ON e.id = ehi.environment_id
+    	WHERE e.updated_at >= '${timestampToMysql(from)}'
+    	AND e.created_at < '${timestampToMysql(to)}'
+        GROUP BY e.id
+        HAVING FIND_IN_SET('DESTROYED', statusHistory) > 0 OR FIND_IN_SET('ERROR', statusHistory) > 0
+    ) AS statusHistoryByEnvironmentId
+    GROUP BY statusHistory
+    ORDER BY count DESC;
+`;
 
 /**
  * Sequelize implementation of the EnvironmentHistoryItemRepository.
@@ -34,6 +58,17 @@ class EnvironmentHistoryItemRepository extends Repository {
     async bulkInsert(historyItems) {
         return EnvironmentHistoryItem.bulkCreate(historyItems, { returning: false });
     }
+
+    /**
+     * Returns the occurrences of each environment status history combination for a given period.
+     *
+     * @param {Period} period the period on which occurrences must be counted
+     * @return {Promise<{statusHistory: string, count: number}[]>} the resulting histogram
+     */
+    async getHistoryDistribution(period) {
+        const [rows] = await sequelize.query(getHistoryDistributionQuery(period), { raw: true });
+        return rows;
+    }
 }
 
 module.exports = new EnvironmentHistoryItemRepository();

lib/server/controllers/statistics.controller.js

@@ -154,11 +154,35 @@ const getEorReasonsOccurrencesHandler = async (request, response) => {
     }
 };
 
+// eslint-disable-next-line valid-jsdoc
+/**
+ * Route to get the environment status history combinations and their occurrences
+ */
+const getHistoryOccurrencesInEnvironmentsHandler = async (request, response) => {
+    const requestDto = await dtoValidator(DtoFactory.queryOnly({
+        from: Joi.date().required(),
+        to: Joi.date().required(),
+    }), request, response);
+
+    if (requestDto) {
+        try {
+            const data = await statisticsService.getHistoryOccurrencesInEnvironments({
+                from: requestDto.query.from,
+                to: requestDto.query.to,
+            });
+            response.status(200).json({ data });
+        } catch (error) {
+            updateExpressResponseFromNativeError(response, error);
+        }
+    }
+};
+
 exports.StatisticsController = {
     getLhcFillStatisticsHandler,
     getWeeklyRunDataSizeHandler,
     getTimeBetweenRunsDistributionHandler,
     getDetectorEfficiencyPerFillHandler,
     getTagsOccurrencesInLogsHandler,
     getEorReasonsOccurrencesHandler,
+    getHistoryOccurrencesInEnvironmentsHandler,
 };

lib/server/routers/statistics.router.js

@@ -48,5 +48,10 @@ exports.statisticsRouter = {
             path: '/runs/eorReasonsOccurrences',
             controller: StatisticsController.getEorReasonsOccurrencesHandler,
         },
+        {
+            method: 'get',
+            path: '/environments/historyOccurrences',
+            controller: StatisticsController.getHistoryOccurrencesInEnvironmentsHandler,
+        },
     ],
 };

lib/server/services/statistics/StatisticsService.js

@@ -10,7 +10,12 @@
  *  granted to it by virtue of its status as an Intergovernmental Organization
  *  or submit itself to any jurisdiction.
  */
-const { LhcFillStatisticsRepository, StableBeamRunsRepository, LogRepository } = require('../../../database/repositories/index.js');
+const {
+    LhcFillStatisticsRepository,
+    StableBeamRunsRepository,
+    LogRepository,
+    EnvironmentHistoryItemRepository,
+} = require('../../../database/repositories/index.js');
 const { lhcFillStatisticsAdapter } = require('../../../database/adapters/index.js');
 const { Op } = require('sequelize');
 
@@ -138,6 +143,16 @@ class StatisticsService {
     async getEorReasonsOccurrences(period) {
         return StableBeamRunsRepository.getEorDistribution(period);
     }
+
+    /**
+     * Return the list of environment status history combinations and their occurrences
+     *
+     * @param {Period} period the period of statistics to query
+     * @return {Promise<{statusHistory: string, count: number}[]>} the resulting histogram
+     */
+    async getHistoryOccurrencesInEnvironments(period) {
+        return EnvironmentHistoryItemRepository.getHistoryDistribution(period);
+    }
 }
 
 exports.StatisticsService = StatisticsService;

test/lib/server/services/statistics/StatisticsService.test.js

@@ -323,4 +323,53 @@ module.exports = () => {
             expect(eorReasonsOccurrences).to.lengthOf(0);
         }
     });
+
+    it('should successfully extract history occurrences for environments in a given period', async () => {
+        const historyOccurrences = await statisticsService.getHistoryOccurrencesInEnvironments({
+            from: new Date('2019/08/09 15:00:00').getTime(),
+            to: new Date('2019/08/09 17:00:00').getTime(),
+        });
+        expect(historyOccurrences).to.lengthOf(3);
+        expect(historyOccurrences).to.eql([
+            { statusHistory: 'STANDBY,ERROR', count: 1 },
+            { statusHistory: 'STANDBY,DEPLOYED,ERROR,DESTROYED', count: 1 },
+            { statusHistory: 'CONFIGURED,RUNNING,STOPPED,DESTROYED', count: 1 },
+        ]);
+    });
+
+    it('should successfully filter out environment history before a date (included) for history occurences', async () => {
+        {
+            const historyOccurrences = await statisticsService.getHistoryOccurrencesInEnvironments({
+                from: new Date('2019/08/09 14:30:00').getTime(),
+                to: new Date('2019/08/09 14:40:00').getTime(),
+            });
+            expect(historyOccurrences).to.lengthOf(1);
+            expect(historyOccurrences).to.eql([{ statusHistory: 'DESTROYED', count: 1 }]);
+        }
+        {
+            const historyOccurrences = await statisticsService.getHistoryOccurrencesInEnvironments({
+                from: new Date('2019/08/09 14:30:01').getTime(),
+                to: new Date('2019/08/09 14:40:00').getTime(),
+            });
+            expect(historyOccurrences).to.lengthOf(0);
+        }
+    });
+
+    it('should successfully filter out environment history after a date (excluded) for history occurences', async () => {
+        {
+            const historyOccurrences = await statisticsService.getHistoryOccurrencesInEnvironments({
+                from: new Date('2019/08/09 14:15:00').getTime(),
+                to: new Date('2019/08/09 14:30:01').getTime(),
+            });
+            expect(historyOccurrences).to.lengthOf(1);
+            expect(historyOccurrences).to.eql([{ statusHistory: 'DESTROYED', count: 1 }]);
+        }
+        {
+            const historyOccurrences = await statisticsService.getHistoryOccurrencesInEnvironments({
+                from: new Date('2019/08/09 14:15:00').getTime(),
+                to: new Date('2019/08/09 14:30:00').getTime(),
+            });
+            expect(historyOccurrences).to.lengthOf(0);
+        }
+    });
 };