openhim-core/lib/reports.js

The OpenHIM core application that provides logging and routing of http requests

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.setupAgenda = setupAgenda;

var _emailTemplates = require('email-templates');

var _winston = require('winston');

var _winston2 = _interopRequireDefault(_winston);

var _moment = require('moment');

var _moment2 = _interopRequireDefault(_moment);

var _authorisation = require('./api/authorisation');

var authorisation = _interopRequireWildcard(_authorisation);

var _config = require('./config');

var _contact = require('./contact');

var contact = _interopRequireWildcard(_contact);

var _metrics = require('./metrics');

var metrics = _interopRequireWildcard(_metrics);

var _users = require('./model/users');

var _utils = require('./utils');

var utils = _interopRequireWildcard(_utils);

function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } }

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

_config.config.reports = _config.config.get('reports');

// Function Sends the reports
function sendReports(job, flag, done) {
  let fetchUsers;
  let from;
  let to;

  const reportMap = {};
  const channelReportMap = {};
  const channelMap = {};

  if (flag === 'dailyReport') {
    from = (0, _moment2.default)().subtract(1, 'days').startOf('day').toDate();
    to = (0, _moment2.default)().subtract(1, 'days').endOf('day').toDate();
  } else {
    from = (0, _moment2.default)().startOf('isoWeek').subtract(1, 'weeks').toDate();
    to = (0, _moment2.default)().endOf('isoWeek').subtract(1, 'weeks').toDate();
  }

  // Select the right subscribers for the report
  if (flag === 'dailyReport') {
    fetchUsers = fetchDailySubscribers;
  }
  if (flag === 'weeklyReport') {
    fetchUsers = fetchWeeklySubscribers;
  }

  return fetchUsers((err, users) => {
    if (err) {
      return done(err);
    }
    const usersArray = [];
    const promises = Array.from(users).map((user, userIndex) => {
      return authorisation.getUserViewableChannels(user).then(channels => {
        usersArray[userIndex] = user;
        usersArray[userIndex].allowedChannels = channels;
        for (const channel of Array.from(usersArray[userIndex].allowedChannels)) {
          channelMap[channel._id] = {
            user,
            channel
          };
        }
      });
    });

    // Loop through the enriched user array
    return Promise.all(promises).then(() => {
      // Pre-Fetch report data into Channel Map
      const innerPromises = Object.entries(channelMap).map(([key, obj]) => {
        return new Promise((resolve, reject) => {
          fetchChannelReport(obj.channel, obj.user, flag, from, to, (err, item) => {
            if (err) {
              return reject(err);
            }
            channelReportMap[key] = item;
            return resolve();
          });
        });
      });

      return Promise.all(innerPromises).then(() => {
        for (const user of Array.from(usersArray)) {
          const userKey = user.email;
          for (const channel of Array.from(user.allowedChannels)) {
            if (reportMap[userKey]) {
              // Do nothing since object already exists
            } else {
              // Create the object
              reportMap[userKey] = {
                email: user.email,
                data: []
              };
            }

            // If report has been fetched get it from the map
            if (channelReportMap[channel._id]) {
              const data = channelReportMap[channel._id];
              // add report - always add if the channel is enabled (treating undefined status as enabled), otherwise only if there is data
              if (data.channel.status == null || data.channel.status === 'enabled' || data.data.length !== 0) {
                return reportMap[userKey].data.push(data);
              }
            } else {
              return _winston2.default.error('should never be here since channels have been pre-fetched');
            }
          }
        }

        // Iterate over reports and send the emails
        for (const key in reportMap) {
          const report = reportMap[key];
          if (flag === 'dailyReport') {
            report.type = 'Daily';
            report.isDaily = true;
          } else {
            report.type = 'Weekly';
            report.isDaily = false;
          }

          report.instance = _config.config.alerts.himInstance;
          report.consoleURL = _config.config.alerts.consoleURL;

          report.from = (0, _moment2.default)(from).format('YYYY-MM-DD');
          report.to = (0, _moment2.default)(to).format('YYYY-MM-DD');

          try {
            for (let i = 0; i < report.data.length; i++) {
              const data = report.data[i];
              const colorGrey = 'color: grey;';
              let rowColor = 'background-color: #d9ead3';
              if (i % 2) {
                rowColor = 'background-color: #b6d7a8;';
              }

              const totals = calculateTotalsFromGrouping(data);
              for (const key in totals) {
                report.data[i][key] = totals[key];
              }

              report.data[i].totalStyle = report.data[i].total > 0 ? '' : colorGrey;
              report.data[i].avgRespStyle = report.data[i].avgResp > 0 ? '' : colorGrey;
              report.data[i].failedStyle = report.data[i].failed > 0 ? 'color: red;' : colorGrey;
              report.data[i].successfulStyle = report.data[i].successful > 0 ? '' : colorGrey;
              report.data[i].processingStyle = report.data[i].processing > 0 ? '' : colorGrey;
              report.data[i].completedStyle = report.data[i].completed > 0 ? 'color: orange;' : colorGrey;
              report.data[i].completedWErrorsStyle = report.data[i].completedWErrors > 0 ? 'color: orangered;' : colorGrey;
              report.data[i].rowColor = rowColor;
            }

            sendUserEmail(report);
          } catch (err) {
            _winston2.default.error(err);
            job.fail(`Failed to send report reason: ${err}`);
          }
        }

        return done();
      }).catch(done);
    });
  });
}

function calculateTotalsFromGrouping(data) {
  const reduced = data.data.reduce((totals, metric, index) => ({
    requests: totals.requests + metric.requests,
    responseTime: totals.responseTime + metric.responseTime,
    successful: totals.successful + metric.successful,
    failed: totals.failed + metric.failed,
    processing: totals.processing + metric.processing,
    completed: totals.completed + metric.completed,
    completedWithErrors: totals.completedWithErrors + metric.completedWithErrors
  }), {
    requests: 0,
    responseTime: 0,
    successful: 0,
    failed: 0,
    processing: 0,
    completed: 0,
    completedWithErrors: 0
  });

  return {
    total: reduced.requests,
    avgResp: Math.round(calculateAverage(reduced.responseTime, reduced.requests) / 1000),
    failed: reduced.failed,
    successful: reduced.successful,
    processing: reduced.processing,
    completed: reduced.completed,
    completedWErrors: reduced.completedWithErrors
  };
}

function calculateAverage(total, count) {
  if (count === 0) {
    return 0;
  }
  return total / count;
}

function sendUserEmail(report) {
  report.date = new Date().toString();
  return renderTemplate('report', report, reportHtml => contact.contactUser('email', report.email, `${report.type} report for: ${report.instance}`, plainTemplate(report), reportHtml, afterEmail));
}

function fetchChannelReport(channel, user, flag, from, to, callback) {
  let period;
  if (flag === 'dailyReport') {
    period = 'day';
  } else {
    period = 'week';
  }

  const item = {};

  _winston2.default.info(`fetching ${flag} for #${channel.name} ${user.email} ${channel._id}`);

  const filters = {
    startDate: from,
    endDate: to,
    timeSeries: period,
    channels: [channel._id]
  };

  return metrics.calculateMetrics(filters).then(data => {
    item.channel = channel;
    item.data = data;
    return callback(null, item);
  }).catch(err => {
    _winston2.default.error('Error calculating metrics: ', err);
    return callback(err);
  });
}

const fetchDailySubscribers = callback => {
  _users.UserModel.find({ dailyReport: true }, callback);
};

const fetchWeeklySubscribers = callback => {
  _users.UserModel.find({ weeklyReport: true }, callback);
};

function plainTemplate(report) {
  let text = `Generated on: ${new Date().toString()}`;
  for (const data of Array.from(report.data)) {
    text += ` \r\n \r\n <---------- Start Channel  ${data.channel.name} ---------------------------> \r\n \r\n \
Channel Name: ${data.channel.name} \r\n \
Channel total: ${(data.data[0] != null ? data.data[0].total : undefined) != null ? data.data[0].total : 0} transactions  \r\n \
Ave response time: ${(data.data[0] != null ? data.data[0].avgResp : undefined) != null ? data.data[0].avgResp : 0} \r\n \
Failed:  ${(data.data[0] != null ? data.data[0].failed : undefined) != null ? data.data[0].failed : 0}  \r\n \
Successful:  ${(data.data[0] != null ? data.data[0].successful : undefined) != null ? data.data[0].successful : 0}  \r\n \
Processing: ${(data.data[0] != null ? data.data[0].processing : undefined) != null ? data.data[0].processing : 0}  \r\n \
Completed:  ${(data.data[0] != null ? data.data[0].completed : undefined) != null ? data.data[0].completed : 0}  \r\n \
Completed with errors: ${(data.data[0] != null ? data.data[0].completedWErrors : undefined) != null ? data.data[0].completedWErrors : 0} \r\n \r\n \
<---------- End Channel -------------------------------------------------> \r\n \r\n \
\r\n \
\r\n\
`;
  }
  return text;
}

function renderTemplate(templateName, templateData, callback) {
  const templateDir = `${_config.appRoot}/templates/${templateName}`;
  const template = new _emailTemplates.EmailTemplate(templateDir);
  return template.render(templateData, (err, result) => {
    if (err) {
      _winston2.default.error(err);
    }
    return callback(result.html.toString());
  });
}

const afterEmail = callback => _winston2.default.info('email sent..');

function setupAgenda(agenda) {
  agenda.define('send weekly channel metrics', (job, done) => sendReports(job, 'weeklyReport', done));

  agenda.define('send daily channel metrics', (job, done) => sendReports(job, 'dailyReport', done));

  agenda.every(_config.config.reports.weeklyReportAt, 'send weekly channel metrics', null, { timezone: utils.serverTimezone() });
  return agenda.every(_config.config.reports.dailyReportAt, 'send daily channel metrics', null, { timezone: utils.serverTimezone() });
}

if (process.env.NODE_ENV === 'test') {
  exports.sendReports = sendReports;
  exports.fetchDailySubscribers = fetchDailySubscribers;
  exports.fetchWeeklySubscribers = fetchWeeklySubscribers;
  exports.fetchChannelReport = fetchChannelReport;
  exports.sendUserEmail = sendUserEmail;
  exports.calculateTotalsFromGrouping = calculateTotalsFromGrouping;
}
//# sourceMappingURL=reports.js.map