OpenSTF/lib/util/apiutil.js

/**
* Copyright © 2019 code initially contributed by Orange SA, authors: Denis Barbaron - Licensed under the Apache license 2.0
**/

const Promise = require('bluebird')
const _ = require('lodash')
const logger = require('./logger')
const datautil = require('./datautil')

const apiutil = Object.create(null)
const log = logger.createLogger('api:controllers:apiutil')

apiutil.PENDING = 'pending'
apiutil.READY = 'ready'
apiutil.WAITING = 'waiting'

apiutil.BOOKABLE = 'bookable'
apiutil.STANDARD = 'standard'
apiutil.ONCE = 'once'
apiutil.DEBUG = 'debug'
apiutil.ORIGIN = 'origin'
apiutil.STANDARDIZABLE = 'standardizable'

apiutil.ROOT = 'root'
apiutil.ADMIN = 'admin'
apiutil.USER = 'user'

apiutil.FIVE_MN = 300 * 1000
apiutil.ONE_HOUR = 3600 * 1000
apiutil.ONE_DAY = 24 * apiutil.ONE_HOUR
apiutil.ONE_WEEK = 7 * apiutil.ONE_DAY
apiutil.ONE_MONTH = 30 * apiutil.ONE_DAY
apiutil.ONE_QUATER = 3 * apiutil.ONE_MONTH
apiutil.ONE_HALF_YEAR = 6 * apiutil.ONE_MONTH
apiutil.ONE_YEAR = 365 * apiutil.ONE_DAY

apiutil.MAX_USER_GROUPS_NUMBER = 5
apiutil.MAX_USER_GROUPS_DURATION = 15 * apiutil.ONE_DAY
apiutil.MAX_USER_GROUPS_REPETITIONS = 10

apiutil.CLASS_DURATION = {
  once: Infinity
, bookable: Infinity
, standard: Infinity
, hourly: apiutil.ONE_HOUR
, daily: apiutil.ONE_DAY
, weekly: apiutil.ONE_WEEK
, monthly: apiutil.ONE_MONTH
, quaterly: apiutil.ONE_QUATER
, halfyearly: apiutil.ONE_HALF_YEAR
, yearly: apiutil.ONE_YEAR
, debug: apiutil.FIVE_MN
}

apiutil.isOriginGroup = function(_class) {
  return _class === apiutil.BOOKABLE || _class === apiutil.STANDARD
}

apiutil.isAdminGroup = function(_class) {
  return apiutil.isOriginGroup(_class) || _class === apiutil.DEBUG
}

apiutil.internalError = function(res, ...args) {
  log.error.apply(log, args)
  apiutil.respond(res, 500, 'Internal Server Error')
}

apiutil.respond = function(res, code, message, data) {
  const status = code >= 200 && code < 300
  const response = {
    success: status
  , description: message
  }

  if (data) {
    for (const key in data) {
      if (data.hasOwnProperty(key)) {
        response[key] = data[key]
      }
    }
  }
  res.status(code).json(response)
  return status
}

apiutil.publishGroup = function(group) {
//  delete group.lock
  delete group.createdAt
  delete group.ticket
  return group
}

apiutil.publishDevice = function(device, user) {
  datautil.normalize(device, user)
//  delete device.group.lock
  return device
}

apiutil.publishUser = function(user) {
//  delete user.groups.lock
  return user
}

apiutil.publishAccessToken = function(token) {
  delete token.email
  delete token.jwt
  return token
}

apiutil.filterDevice = function(req, device) {
  const fields = req.swagger.params.fields.value

  if (fields) {
    return _.pick(apiutil.publishDevice(device, req.user), fields.split(','))
  }
  return apiutil.publishDevice(device, req.user)
}

apiutil.computeDuration = function(group, deviceNumber) {
  return (group.devices.length + deviceNumber) *
         (group.dates[0].stop - group.dates[0].start) *
         (group.repetitions + 1)
}

apiutil.lightComputeStats = function(res, stats) {
  if (stats.locked) {
    apiutil.respond(res, 503, 'Server too busy, please try again later')
    return Promise.reject('busy')
  }
  return 'not found'
}

apiutil.computeStats = function(res, stats, objectName, ...lock) {
  if (!stats.replaced) {
    if (stats.skipped) {
      return apiutil.respond(res, 404, `Not Found (${objectName})`)
    }
    if (stats.locked) {
      return apiutil.respond(res, 503, 'Server too busy, please try again later')
    }
    return apiutil.respond(res, 403, `Forbidden (${objectName})`)
  }
  if (lock.length) {
    lock[0][objectName] = stats.changes[0].new_val
  }
  return true
}

apiutil.lockResult = function(stats) {
  const result = {status: false, data: stats}

  if (stats.replaced || stats.skipped) {
    result.status = true
    result.data.locked = false
  }
  else {
    result.data.locked = true
  }
  return result
}

apiutil.lockDeviceResult = function(stats, fn, groups, serial) {
  const result = apiutil.lockResult(stats)
  if (!result.status) {
    return fn(groups, serial).then(function(devices) {
      if (!devices.length) {
        result.data.locked = false
        result.status = true
      }
      return result
    })
  }
  return result
}

apiutil.setIntervalWrapper = function(fn, numTimes, delay) {
  return fn().then(function(result) {
    if (result.status) {
      return result.data
    }
    return new Promise(function(resolve, reject) {
      let counter = 0
      const interval = setInterval(function() {
        return fn().then(function(result) {
          if (result.status || ++counter === numTimes) {
            if (!result.status && counter === numTimes) {
              log.debug('%s() failed %s times in a loop!', fn.name, counter)
            }
            clearInterval(interval)
            resolve(result.data)
          }
        })
        .catch(function(err) {
          clearInterval(interval)
          reject(err)
        })
      }, delay)
    })
 })
}

apiutil.redirectApiWrapper = function(field, fn, req, res) {
  if (typeof req.body === 'undefined') {
    req.body = {}
  }
  req.body[field + 's'] = req.swagger.params[field].value
  req.swagger.params.redirected = {value: true}
  fn(req, res)
}

apiutil.computeGroupDates = function(lifeTime, _class, repetitions) {
  const dates = new Array(lifeTime)

  for(let repetition = 1
      , currentLifeTime = {
          start: new Date(lifeTime.start.getTime())
        , stop: new Date(lifeTime.stop.getTime())
        }
      ; repetition <= repetitions
      ; repetition++) {
    currentLifeTime.start = new Date(
      currentLifeTime.start.getTime() +
      apiutil.CLASS_DURATION[_class]
    )
    currentLifeTime.stop = new Date(
      currentLifeTime.stop.getTime() +
      apiutil.CLASS_DURATION[_class]
    )
    dates.push({
      start: new Date(currentLifeTime.start.getTime())
    , stop: new Date(currentLifeTime.stop.getTime())
    })
  }
  return dates
}

apiutil.checkBodyParameter = function(body, parameter) {
  return typeof body !== 'undefined' && typeof body[parameter] !== 'undefined'
}

apiutil.getBodyParameter = function(body, parameter) {
  let undef

  return apiutil.checkBodyParameter(body, parameter) ? body[parameter] : undef
}

apiutil.checkQueryParameter = function(parameter) {
  return typeof parameter !== 'undefined' && typeof parameter.value !== 'undefined'
}

apiutil.getQueryParameter = function(parameter) {
  let undef

  return apiutil.checkQueryParameter(parameter) ? parameter.value : undef
}

module.exports = apiutil