wkr-util/cjs/rate-limit.js

Utility library for wkr project.

"use strict";

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

var _f = require("@cullylarson/f");

var _expressRateLimit = _interopRequireDefault(require("express-rate-limit"));

var _validate = require("@cullylarson/validate");

var _ = require("./");

var _log = require("./log");

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

function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }

function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }

function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }

function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }

function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }

const RateLimit = (_ref) => {
  let {
    tooManyErrorMessage = 'You have made too many requests to this resource. Please try again later.',
    tooManyErrorKey = 'too-many-requests',
    tooManyErrorStatus = 429,
    rateLimitIpsWhitelistStr = null,
    rateLimitIpsWhitelist = [],
    logRepo = null
  } = _ref,
      rateLimitParams = _objectWithoutProperties(_ref, ["tooManyErrorMessage", "tooManyErrorKey", "tooManyErrorStatus", "rateLimitIpsWhitelistStr", "rateLimitIpsWhitelist", "logRepo"]);

  if (rateLimitIpsWhitelistStr && (!rateLimitIpsWhitelist || !rateLimitIpsWhitelist.length)) {
    rateLimitIpsWhitelist = (0, _f.compose)((0, _f.map)(_f.trim), (0, _f.split)(','))(rateLimitIpsWhitelistStr);
  }

  return (0, _expressRateLimit.default)(_objectSpread({
    windowMs: 5 * 60 * 1000,
    // 5 minutes
    max: 300,
    // limit each IP to this many requests per windowMs
    skipSuccessfulRequests: true,
    skip: req => {
      const ip = (0, _.formatIpv4)(req.ip);
      return ip === '127.0.0.1' || rateLimitIpsWhitelist.includes(ip);
    },
    handler: (req, res) => {
      return res.status(tooManyErrorStatus).json((0, _.responseError)((0, _validate.messageObj)(tooManyErrorKey, tooManyErrorMessage)));
    },
    onLimitReached: (req, res, options) => {
      if (!logRepo) return;
      logRepo.add('too-many-requests', _log.logLevels.NOTICE, 'This IP address has made too many requests and has been rate-limited.', {
        data: _objectSpread(_objectSpread({}, (0, _f.pick)(['windowMs', 'max'], options)), (0, _f.pick)(['limit', 'current', 'remaining', 'resetTime'], req.rateLimit))
      }, req);
    }
  }, rateLimitParams));
};

exports.RateLimit = RateLimit;