volos-quota-common/lib/memory_buffer.js

Common library for Quota enforcement in the Volos system.

/****************************************************************************
 The MIT License (MIT)

 Copyright (c) 2013 Apigee Corporation

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ****************************************************************************/
'use strict';

var assert = require('assert');
var Quota = require('./quota');
var _ = require('underscore');
var debug = require('debug')('quota');

/*
 * options.bufferSize (Number) optional, use a memory buffer up to bufferSize to hold quota elements
 * options.bufferTimeout (Number) optional, flush the buffer every Number ms (default: 300)
 */

// todo: update clockOffset & bucket expires occasionally to account for clock drift?
// todo: after failure, only fail locally (no flush to remote) until end of time bucket?

var create = function(spi, options) {
  return new MemoryBuffer(spi, options);
};
module.exports.create = create;

function MemoryBuffer(spi, options) {
  if ( options.debug  && typeof options.debug === "function") {
    debug = options.debug;
  }
  debug('Creating MemoryBuffer, timeInterval: %d, bufferTimeout: %d', options.timeInterval, options.bufferTimeout);
  this.spi = spi;
  this.options = options;
  this.buckets = {};
  this.clockOffset = undefined;
  this.remoteApplyFailed =  false;

  assert(options.timeInterval);
  if (options.startTime) {
    assert.equal(typeof options.startTime, 'number');
  }

  var self = this;
  if ( options.timeInterval <= options.maxTimeInterval) {
    self.bucketTimer = setInterval(function() {
      trimTokens(self);
    }, options.timeInterval);
  } else {
    this.customSetIntervalSet = true;
    this.customSetInterval(options.timeInterval, options.maxTimeInterval, function() {
      trimTokens(self);
    });
  }

  if (options.bufferTimeout) {
    self.flushTimer = setInterval(function() {
      self.flushBuffer();
    }, options.bufferTimeout);
  }
}

MemoryBuffer.prototype.customSetInterval = function(timeInterval, maxTimeInterval, cb){
  if ( !this.customSetIntervalSet ) {
    return;
  }
  this.customSetTimeOut(timeInterval, maxTimeInterval, () => {
      cb();
      this.customSetInterval(timeInterval, maxTimeInterval, cb);
  });
}

MemoryBuffer.prototype.customSetTimeOut = function(timeInterval, maxTimeInterval, cb){
  if ( !this.customSetIntervalSet ) {
    return;
  }
  if ( timeInterval > maxTimeInterval ) {
    this.customTimeoutRef = setTimeout(() => {
      this.customSetTimeOut( ( timeInterval - maxTimeInterval ), maxTimeInterval, cb);
    }, maxTimeInterval );
  } else {
    this.customTimeoutRef = setTimeout(function() {
      cb();
    }, timeInterval);
  }
}

MemoryBuffer.prototype.destroy = function() {
  clearInterval(this.bucketTimer);
  clearInterval(this.flushTimer);
  this.customSetIntervalSet = false;
  clearTimeout(this.customTimeoutRef);
  this.spi.destroy();
};

MemoryBuffer.prototype.apply = function(options, cb) {

  var bucket = this.buckets[options.identifier];
  var now = _.now();

  if (!bucket) {
    bucket = new Bucket(now, options, this);
    this.buckets[options.identifier] = bucket;
    debug('current buckets:', Object.keys(this.buckets));
  }
  bucket.apply(now, options, cb);
};

MemoryBuffer.prototype.flushBuffer = function() {
  _.each(this.buckets, function(bucket) {
    bucket.flushBucket();
  });
};

/*
 * Quotas always obey their expiration times (which prevents us from having to register a huge
 * number of individual timeouts) but we still want to periodically clean them up to prevent memory
 * issues. This job runs once per time interval (minute, hour, day, or week) and removes expired tokens.
 */
function trimTokens(self) {
  var now = _.now();
  for (var b in Object.keys(self.buckets)) {
    if (now > b.expires) {
      debug('Bucket: %s expired at: %s in bucketTimer, deleting now.',b.options.identifier,new Date(b.expires).toISOString());
      delete self.buckets.b;
    }
  }
}

function Bucket(time, options, owner) {
  debug('new bucket:', options.identifier);
  this.options = options;
  this.owner = owner;
  this.reset(time);
}

Bucket.prototype.reset = function(time) {
  debug('bucket reset:', this.options.identifier);
  this.count = 0;
  this.resetAt = time;
  this.expires = undefined;
  this.remoteCount = 0;
  this.remoteExpires = undefined;
  this.flushing = false;
  this.remoteExpiryTimestamp =  undefined;
  this.calculateExpiration();
};

Bucket.prototype.calculateExpiration = function() {
  var time = this.resetAt + (this.owner.clockOffset || 0);
  var startTime = this.owner.options.startTime;
  var timeInterval = this.owner.options.timeInterval;
  let remaining = 0;
  if (startTime) {
    // "calendar" start quota -- calculate time until the end of the bucket
    remaining = (time - startTime) % timeInterval;
  }
  this.expires = time + timeInterval - remaining;
  debug('Bucket: %s expires set to: %s', this.options.identifier, new Date(this.expires).toISOString());
};

Bucket.prototype.apply = function(time, options, cb) {
  debug('apply: ', options.weight);
  var now = _.now();
  if (time > this.expires) {
    debug('Bucket expired at: %s',new Date(this.expires).toISOString());
    this.reset(now); // Quota bucket has expired. The timer also runs but only periodically
  }

  this.count += options.weight;

  var allow = options.allow || this.options.allow;

  var count = this.count + this.remoteCount;
  debug('Bucket:%s applying check,count: %d, allow: %d',this.options.identifier, count, allow);
  var result = {
    allowed: allow,
    used: count,
    isAllowed: (count <= allow),
    expiryTime: this.expires - now,
    remoteApplyFailed: this.owner.remoteApplyFailed 
  };

  cb(null, result);

  if (!this.remoteExpires || (this.count % this.owner.options.bufferSize === 0)) {
    this.flushBucket();
  }
};

Bucket.prototype.flushBucket = function(cb) {
  if (this.flushing || (!this.count && this.remoteExpires)) { return cb ? cb() : null; }
  this.flushing = true

  debug('flushing bucket: ', this.options.identifier);
  var localExpires = this.expires;
  var remoteExpires = this.remoteExpires;
  var options = {
    identifier: this.options.identifier,
    weight: this.count
  };
  var self = this;
  self.owner.spi.apply(options, function(err, reply) {
    self.flushing = false;
    if (err) {
      if (self.owner.options.failOpen === true ) {
        self.owner.remoteApplyFailed = true;
      }
      return (cb) ? cb(err) : console.error(err); 
    }
    self.owner.remoteApplyFailed = false;

    // sync time with remote if never been synced
    if (self.owner.clockOffset === undefined) {
      if (!reply.timestamp) {
        debug('Warning: Quota spi not reporting timestamp. Buffer assuming spi timestamp is identical.');
      }
      var offset = reply.timestamp ? reply.timestamp - _.now() : 0;
      self.owner.clockOffset = offset;
      debug('clockOffset:', offset);
    }

    var sameTimeBucket = (self.expires === localExpires) &&                        // same local time bucket?
                         (!remoteExpires || remoteExpires === self.remoteExpires); // same remote time bucket?

    if ( reply.expiryTimestamp ) { // filter out back dated remote expiry, these are invalid responses from remote
      sameTimeBucket = sameTimeBucket && ( !self.remoteExpiryTimestamp || reply.expiryTimestamp >= self.remoteExpiryTimestamp );
    }

    if (!sameTimeBucket) {
      debug('new time bucket');
      return cb ? cb() : null;
    }

    self.remoteExpires = reply.expiryTime;
    self.remoteCount = reply.used;
    if ( reply.expiryTimestamp ) {
      self.remoteExpiryTimestamp = reply.expiryTimestamp;
    }

    self.count -= options.weight; // subtract applied value

    // if it wasn't set because offset wasn't available, calc expiration
    if (!self.expires) { self.calculateExpiration(); }
    debug('Bucket state after flushing: %j ', { 
      remoteCount: self.remoteCount, count: self.count,
      expires: new Date(self.expires).toISOString()
    });
    if (cb) { cb(); }
  });
};