volos-analytics-apigee/lib/apigeeanalytics.js

Apigee provider for Analytics in the Volos system.

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

 Copyright (c) 2014 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 Analytics = require('volos-analytics-common');
var onFinished = require('on-finished');
var request = require('postman-request');

var MICROGATEWAY = 'microgateway';
var REMOTE_PROXY_PATH = '/v2/analytics/accept';
const clientClosedRequestErrCode = 499;

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

var ApigeeAnalyticsSpi = function(options) {
  if (!options.uri) {
    throw new Error('uri parameter must be specified');
  }
  if (!options.key) {
    throw new Error('key parameter must be specified');
  }
  if (!options.proxy) {
    throw new Error('Proxy parameter must be specified');
  }

  this.key = options.key;
  this.proxy = options.proxy;
  this.compress = !!options.compress;
  if (options.proxy_revision) { this.proxy_revision = options.proxy_revision; }

  if (options.source === MICROGATEWAY) {
    this.microgateway = true;
    this.uri = options.uri;
    if (options.secret) {
      this.secret = options.secret;
    } else {
      throw new Error('secret parameter must be specified');
    }
  } else {
    this.uri = options.uri + REMOTE_PROXY_PATH;
  }

  if (options.finalizeRecord) {
    if (typeof options.finalizeRecord !== 'function') {
      throw new Error('finalizeRecord must be a function');
    }
    this.finalizeRecord = options.finalizeRecord;
  } else {
    this.finalizeRecord = function(req, res, record, cb) { cb(undefined, record); }
  }
  this.request = options.request ? request.defaults(options.request) : request;
};

ApigeeAnalyticsSpi.prototype.flush = function(recordsQueue, cb) {

  var recordsToBeUploaded = {
    records: recordsQueue
  };

  function sendResponse(err, resp) {
    if (err || resp.statusCode !== 200) {
      cb(err || new Error('error from server: ' + resp.statusCode), recordsQueue);
    } else if( resp.body ) {
      resp.body.rejected > 0 ? cb(undefined, recordsQueue.slice(recordsQueue.length - resp.body.rejected)) : cb();
    } else {
      cb(new Error('Empty response from server: ' + resp.statusCode));
    }
  }

  if (this.compress) {
    var zlib = require('zlib');
    var uncompressed = JSON.stringify(recordsToBeUploaded);
    var self = this;
    zlib.gzip(uncompressed, function(err, compressed) {
      if (err) { return cb(err); }
      self.send(compressed, sendResponse);
    });
  } else {
    this.send(recordsToBeUploaded, sendResponse);
  }

};

ApigeeAnalyticsSpi.prototype.makeRecord = function(req, resp, cb) {

  var now = Date.now();
  var record = {
    client_received_start_timestamp:  now,
    client_received_end_timestamp:    now + 1, // hack to avoid error in server calculations    
    recordType:                       'APIAnalytics',
    apiproxy:                         this.proxy,
    request_uri:                      (req.protocol || 'http') + '://' + req.headers.host + req.url,
    request_path:                     req.url.split('?')[0],
    request_verb:                     req.method,
    client_ip:                        req.connection.remoteAddress,
    useragent:                        req.headers['user-agent'],
    apiproxy_revision:                this.proxy_revision
  };

  var self = this;
  onFinished(resp, function() {
    if(req.aborted ){
      resp.statusCode = clientClosedRequestErrCode;
    }
    var now = Date.now();
    record.response_status_code      = resp.statusCode;
    record.client_sent_start_timestamp = now;
    record.client_sent_end_timestamp = now+1;

    // oauth
    var token = req.token;
    if (token) {
      record.developer_email = token.developer_email;
      record.developer_app   = token.application_name;
      record.access_token    = token.access_token;
      record.client_id       = token.client_id;

      var prodList = token.api_product_list;
      if (prodList && prodList.length) {
        if (typeof prodList === 'string') { prodList = prodList.slice(1, -1).split(','); }
        // hack: analytics server only accepts a single product
        record.api_product = prodList[0];
      }
    }

    self.finalizeRecord(req, resp, record, cb);
  });
};

ApigeeAnalyticsSpi.prototype.send = function send(data, cb) {
  if ( !data ) { // add null check to payload
    return;
  }
  var options = {
    url: this.uri,
    headers: {},
    json: data
  };

  if (this.microgateway) {
    options.auth = {
      user: this.key,
      pass: this.secret
    }
  } else {
    options.headers['x-DNA-Api-Key'] = this.key;
  }

  if (this.compress) {
    options.headers['Content-Encoding'] = 'gzip';
  }

  this.request.post(options, cb);
};