isatdatapro-microservices/src/infra/database/utilities/getHighwatermark.js

A library for creating microservices to access Inmarsat's IsatData Pro satellite IoT system

'use strict';

require('dotenv').config();
const logger = require('../../logging').loggerProxy(__filename);
const { ApiCallLog } = require('../models');

const HISTORY_HOURS = process.env.SATELLITE_HISTORY_HOURS || 48;

/**
 * Returns the high water mark from the most recent IDP Messaging API call
 * @param {DatabaseContext} database The database client/connection
 * @param {string} mailboxId The mailbox id the operation was made against
 * @param {string} operation The api operation
 * @returns {object} { nextStartTimeUtc, [nextStartId] }
 */
async function getHighwatermark(database, mailboxId, operation) {
  const SUPPORTED_OPERATIONS = [
    'getReturnMessages',
    'getForwardStatuses',
  ];
  if (!(SUPPORTED_OPERATIONS.includes(operation))) {
    throw new Error(`Invalid operation must be one of ${SUPPORTED_OPERATIONS}`);
  }
  let apiFilter = {};
  const includeFilter = {
    operation: operation,
    mailboxId: mailboxId,
    completed: true,
  };
  const excludeFilter = { nextStartTimeUtc: '' };
  const options = {
    limit: 1,
    desc: '_ts',
  };
  const category = ApiCallLog.prototype.category;
  const apiCalls =
      await database.find(category, includeFilter, excludeFilter, options);
  if (apiCalls.length > 0) {
    const lastCall = apiCalls[0];
    if (lastCall.nextStartId > 0) {
      apifilter.startMessageId = lastCall.nextStartId;
      logger.debug(`Found next start ID ${apiFilter.startMessageId}`
                + ` for mailbox ${mailboxId} as filter`);
    } else if (lastCall.nextStartTimeUtc !== '') {
      apiFilter.startTimeUtc = lastCall.nextStartTimeUtc;
      logger.debug(`Found next start time ${apiFilter.startTimeUtc}`
                + ` for mailbox ${mailboxId} as filter`);
    }
  }
  if (!(apiFilter.startTimeUtc) && !(apiFilter.startMessageId)) {
    let date = new Date();
    date.setUTCHours(date.getUTCHours() - HISTORY_HOURS);
    apiFilter.startTimeUtc = date.toISOString();
    logger.debug(`No previous filter found for mailbox ${mailboxId} - using`
        + ` ${apiFilter.startTimeUtc}`);
  }
  return apiFilter;
}

module.exports = getHighwatermark;