comprodls-sdk 2.89.0 → 2.90.3-development

package/lib/services/pushX/index.js

@@ -26,7 +26,6 @@
 
 var q = require('q');
 var request = require('superagent');
-var Agent = require('agentkeepalive');
 
 var helpers = require('../../helpers');
 var pubnubClientWrapper = require('./pubnubClientWrapper');
@@ -37,25 +36,18 @@ var DLSError = helpers.errors.DLSError;
  **********************************/
 module.exports = pushX;
 
-var keepaliveAgent = new Agent({
-  timeout: 60000,
-  freeSocketTimeout: 30000
-});
-
 /*********************************
  * Public Function definitions
  **********************************/
 function pushX() {
-  var _pubnubClientWrapper = pubnubClientWrapper();
-  return {
-    "connect": _connect.bind(this, _pubnubClientWrapper),
-    "cleanup": _cleanup.bind(this, _pubnubClientWrapper),
-    "grantByUserOrgId": grantByUserOrgId.bind(this),
-    "grantByAccountId": grantByAccountId.bind(this),
-    "grantByAccountIdOnExtUserId": grantByAccountIdOnExtUserId.bind(this),
-    "grantV2": grantV2.bind(this),
-    "getPushedEvents": getPushedEvents.bind(this)
-  };
+    var _pubnubClientWrapper = pubnubClientWrapper();
+    return {
+        "connect": _connect.bind(this, _pubnubClientWrapper),
+        "cleanup": _cleanup.bind(this, _pubnubClientWrapper),
+        "grantByUserOrgId": grantByUserOrgId.bind(this),
+        "grantByAccountId": grantByAccountId.bind(this),
+        "grantByAccountIdOnExtUserId": grantByAccountIdOnExtUserId.bind(this)
+    };
 }
 
 /*********************************
@@ -63,193 +55,144 @@ function pushX() {
  **********************************/
 
 function _connect(pubnubCW, options) {
-  var bpubnubV7 = true; // If pubnub v7 or higher in package.json, set it true
-  if (bpubnubV7 && !options.userid) {
-    var err = {};
-    err.message = err.description = 'Mandatory parameter userid not found in request options.';
-    err = new DLSError(helpers.errors.ERROR_TYPES.PUSHX_ERROR, err);
-    throw err;
-  }
-
-  // Adding SSL flag
-  return pubnubCW.setup({
-    'userid': options.userid,
-    'accountid': options.accountid,
-    'token': options.token,
-    'pubnub': {
-      'publishKey': options.publishKey,
-      'subscribeKey': options.subscribeKey,
-      'ssl': true,
-      'suppressLeaveEvents': true
-    },
-    'pollingEndpoint': options.pollingEndpoint,
-    'pollingIterations': options.pollingIterations || 10, // Default polling iterations is 10
-    'pollingInterval': options.pollingInterval, // Default polling interval is exponential backoff
-  });
+    var bpubnubV7 = true; // If pubnub v7 or higher in package.json, set it true
+    if (bpubnubV7 && !options.userid) {
+        var err = {};
+        err.message = err.description = 'Mandatory parameter userid not found in request options.';
+        err = new DLSError(helpers.errors.ERROR_TYPES.PUSHX_ERROR, err);
+        throw err;
+    }
+
+    // Adding SSL flag
+    return pubnubCW.setup({
+      'userid': options.userid,
+      'pubnub': {
+        'publishKey': options.publishKey,
+        'subscribeKey': options.subscribeKey,
+        'authKey': options.authKey,
+        'ssl': true
+      }
+    });
 }
 
 function _cleanup(pubnubCW) { pubnubCW.cleanup(); }
 
-/*options = {}*/
+/*options = {
+  authKey: <authKey>
+}*/
 function grantByUserOrgId(options) {
-  var dfd = q.defer();  // Initializing promise
-  var allowedChannels = ['jobs', 'systemevents'];
-  var baseChannelName = "o-" + this.orgId + "\\$u-" + this.token.access_token + "\\$";
-  var patterns = [];
-  for(var i in allowedChannels) {
-    var channelName = baseChannelName + allowedChannels[i] + "\\..*";
-    patterns.push(channelName);
-  }
-  options.channels = {};
-  options.channels.patterns = patterns;
-  grantV2.call(this, options)
-  .then(function (res) {
-    dfd.resolve(res);
-  })
-  .catch(function(err) {
-    dfd.reject(err);
-  });
-  return dfd.promise;
+    var self = this;
+    var dfd = q.defer();  // Initializing promise
+    // Validations
+    var err = helpers.validations.isAuthenticated(self.orgId, self.token);
+    if(err) { dfd.reject(err); }
+    else {
+        // Passed all validations, Construct API url
+        var url = self.config.DEFAULT_HOSTS.PUSHX + self.config.PUSHX_API_URLS.grantByUserOrgId;
+        url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
+        // Setup request with URL and Params
+        var requestAPI = request.post(url)
+                         .set('Content-Type', 'application/json')
+                         .set('Accept', 'application/json');
+
+        var body = {};
+        if(options.authKey) { body.authKey = options.authKey; }
+
+        requestAPI.send(body);
+
+        //Setup token in Authorization header
+        requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+        if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+        // Call Change Password Api
+        requestAPI.end(function(err, response) {
+            if(err) {
+                err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+                dfd.reject(err);
+            }
+            else { dfd.resolve(response.body); }
+        });
+    }
+    return dfd.promise;
 }
 
 /*options = {
     accountId: <accountid>,
-    refId: <extRefId>
+    refId: <extRefId>,
+    authKey: <authKey>
 }*/
 function grantByAccountId(options) {
-	var err ={};
-  var dfd = q.defer();  // Initializing promise
-
-  if(options.accountId && options.refId) {
-    var channel = "a-" + options.accountId + "$refid." + options.refId;
-    var exactMatch = [channel];
-    options.channels = {};
-    options.channels.exactMatch = exactMatch;
-    grantV2.call(this, options)
-    .then(function (res) {
-      dfd.resolve(res);
-    })
-    .catch(function(err) {
-      dfd.reject(err);
-    });
-  }
-  else {
-    err.message = err.description = "Required parameter ['accountId', 'refId'] " +
-                                    "not found in request options";
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    dfd.reject(err);
-  }
-  return dfd.promise;
+	var self = this, err ={};
+    var dfd = q.defer();  // Initializing promise
+
+    if(options.accountId && options.refId) {
+        // Passed all validations, Construct API url
+        var url = self.config.DEFAULT_HOSTS.PUSHX + self.config.PUSHX_API_URLS.grantByAccountId;
+        url = helpers.api.constructAPIUrl(url, { accountId: options.accountId });
+        // Setup request with URL and Params
+        var requestAPI = request.post(url)
+                         .set('Content-Type', 'application/json')
+                         .set('Accept', 'application/json');
+        if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+        var body = { refId: options.refId };
+        if(options.authKey) { body.authKey = options.authKey; }
+
+        requestAPI.send(body);
+        requestAPI.end(function(err, response) {
+            if(err) {
+                err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+                dfd.reject(err);
+            }
+            else { dfd.resolve(response.body); }
+        });
+    }
+    else {
+        err.message = err.description = "Required parameter ['accountId', 'refId'] " +
+                                        "not found in request options";
+        err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+        dfd.reject(err);
+    }
+    return dfd.promise;
 }
 
 /*options = {
     accountId: <accountid>,
     extUserId: <extUserId>, //mandatory
+    authKey: <authKey>
 }*/
 function grantByAccountIdOnExtUserId(options) {
-	var err ={};
-  var dfd = q.defer();  // Initializing promise
-
-  if(options.accountId && options.extUserId) {
-    var channel = "a-" + options.accountId + "$u-" + options.extUserId;
-    var exactMatch = [channel];
-    options.channels = {};
-    options.channels.exactMatch = exactMatch;
-    grantV2.call(this, options)
-    .then(function (res) {
-      dfd.resolve(res);
-    })
-    .catch(function(err) {
-      dfd.reject(err);
-    });
-  }
-  else {
-    err.message = err.description = "Required parameter ['accountId', 'extUserId'] " +
-                                    "not found in request options";
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    dfd.reject(err);
-  }
-  return dfd.promise;
-}
-
-/**
- * This function provides grant token on given channels
- * @param { channels: { exactMatch: [], patterns: [] } } options 
- * @returns { token, publishKey, subscribeKey }
- */
-function grantV2(options) {
-  var self = this, err = {};
-  var dfd = q.defer();
-  var body = { channels: {} };
-  if(!options.channels) {
-    err.message = err.description = "channels not given in input body.";
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    dfd.reject(err);
-    return dfd.promise;
-  }
-  body.channels = options.channels;
-  // Passed all validations, Construct API url
-  var url = self.config.DEFAULT_HOSTS.PUSHX + self.config.PUSHX_API_URLS.grantV2;
-  // Setup request with URL and Params
-  var requestAPI = request.post(url)
-                    .set('Content-Type', 'application/json')
-                    .set('Accept', 'application/json');
-  if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-
-  requestAPI.send(body);
-  requestAPI.end(function(err, response) {
-    if(err) {
-      err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-      dfd.reject(err);
+	var self = this, err ={};
+    var dfd = q.defer();  // Initializing promise
+
+    if(options.accountId && options.extUserId) {
+        // Passed all validations, Construct API url
+        var url = self.config.DEFAULT_HOSTS.PUSHX + self.config.PUSHX_API_URLS.grantByAccountId;
+        url = helpers.api.constructAPIUrl(url, { accountId: options.accountId });
+        // Setup request with URL and Params
+        var requestAPI = request.post(url)
+                         .set('Content-Type', 'application/json')
+                         .set('Accept', 'application/json');
+        if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+        var body = { extUserId: options.extUserId };
+        if(options.authKey) { body.authKey = options.authKey; }
+
+        requestAPI.send(body);
+        requestAPI.end(function(err, response) {
+            if(err) {
+                err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+                dfd.reject(err);
+            }
+            else { dfd.resolve(response.body); }
+        });
+    }
+    else {
+        err.message = err.description = "Required parameter ['accountId', 'extUserId'] " +
+                                        "not found in request options";
+        err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+        dfd.reject(err);
     }
-    else { dfd.resolve(response.body); }
-  });
-  return dfd.promise;
+    return dfd.promise;
 }
 
-/**
- * @param {
- *  *accountid: "string",
- *  *channelName: "string",
- *  *starttime: number,
- *  *endtime: number
- * } options
- */
-function getPushedEvents(options) {
-  var self = this;
-  var dfd = q.defer();  // Initializing promise
-  var accountid = options.accountid,
-    channelname = options.channelname,
-    starttime = options.starttime,
-    endtime = options.endtime;
-
-  if (accountid && channelname && starttime && endtime) {
-    // Passed all validations, Construct API url
-    var url = self.config.DEFAULT_HOSTS.PUSHX + self.config.PUSHX_API_URLS.getPushedEvents;
-    url = helpers.api.constructAPIUrl(url, { accountId: accountid });
-
-    // Setup request with URL and Params
-    var params = {channelname: channelname, starttime: starttime, endtime: endtime};
-    var requestAPI = request.get(url).query(params);
-    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-
-    requestAPI
-      .agent(keepaliveAgent)
-      .end(function(error, response) {
-        if (error) {
-          error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
-          dfd.reject(error);
-        } else {
-          dfd.resolve(response.body);
-        }
-    });
-  }
-  else {
-    var err = {};
-    err.message = err.description = 'Mandatory parameters [accountId, channelname,' +
-      ' starttime, endtime] not found in request options';
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    dfd.reject(err);
-  }
-  return dfd.promise;
-}

package/lib/services/pushX/pubnubClientWrapper.js

@@ -1,5 +1,4 @@
 var pubNub = require("pubnub");
-var request = require('superagent');
 var EventEmitter = require("events").EventEmitter;
 var helpers = require('../../helpers');
 
@@ -22,13 +21,6 @@ module.exports = function () {
     var _globalSubscription = [];
     var _globalSubscriptionStatus = {};
     var bStatusSubscribed = false;
-    /** ID of the setTimeout - used for Polling events when PubNub fails */
-    var _setTimeoutIDForPolling;
-    /** Timestamp from when the events need to be fetched */
-    var _startTimestampForPolling;
-    /** Counter for polling */
-    var _pollingCounter;
-    var bPollingInitiated = false;
 
     /** ###### END OF MODULE GLOBALS */
 
@@ -44,9 +36,6 @@ module.exports = function () {
         //Returning the adaptor (Plain Javascript object)
         return {
             "on": function (channelObj, handler) {
-                // If PubNub fails, we will fetch the events from this timestamp
-                _startTimestampForPolling = Date.now();
-
                 var pubNubChannel;
                 var channelContext = [];
 
@@ -75,9 +64,6 @@ module.exports = function () {
                     _eventEmitter.on(channelObj.channel, handler);
                     bStatusSubscribed = true;
                 }
-
-                // Clean up the old events
-                _checkOldBubbledEvents();
             },
             "getMySubscriptionStatus": __getMySubscriptionStatus
         };
@@ -89,12 +75,8 @@ module.exports = function () {
         _eventEmitter.emit(subscribedChannel, message);
     };
 
-    var _translatePubnubStatus = function(status, options) {
+    var _translatePubnubStatus = function(status) {
         var channels = [], error, successObj;
-
-        // If polling has been initiated, ignore all punnub status
-        if (bPollingInitiated) return;
-
         switch (status.category) {
             case "PNConnectedCategory":
                 if(status.operation === "PNSubscribeOperation") {
@@ -122,10 +104,8 @@ module.exports = function () {
                 break;
             case "PNAccessDeniedCategory":
                 if(status.operation === "PNSubscribeOperation") {
-                    var errorText = status.errorData.response && status.errorData.response.text;
-                    var errorJSON = errorText ? JSON.parse(errorText) : undefined;
                     var errorData = {
-                        payload: errorJSON && errorJSON.payload || status.errorData.payload,
+                        payload: JSON.parse(status.errorData.response.text).payload,
                         message: 'Forbidden: Subscription failed.',
                         errorDetails: {
                             operation: status.operation,
@@ -154,47 +134,6 @@ module.exports = function () {
                 error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
                 _eventEmitter.emit('pushx_status', error);
                 break;
-            case "PNNetworkIssuesCategory":
-                if(status.operation === 'PNSubscribeOperation') {
-                    if(!options.accountId || !_userOptions.pollingEndpoint) {
-                        error = {
-                            message: "Polling initiation error: Missing mandatory parameters to initiate polling operation - [accountId, pollingEndpoint]",
-                            status: status.statusCode
-                        };
-                        error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
-                        _eventEmitter.emit('pushx_status', error);
-                        break;
-                    }
-                    else {
-                        /**
-                         * Handle network issue category status for 'subscription' opreration
-                         * Start the events polling here.
-                         *
-                         * The wrapper supports multiple channels, but the APP currently uses a single channel only.
-                         * Polling will also limited to a single channel.
-                         */
-                        _pollingCounter = 0;
-                        _pollForEvents();
-                        bPollingInitiated = true;
-                    }
-                }
-                else {
-                    // Handle network issue category status for other operations like 'unsubscription'
-                }
-                break;
-            case "PNReconnectedCategory":
-                // Handle reconnected category status.
-                break;
-            default:
-                // Emit error for other status-category received from pubnub
-                error = {
-                    message: "PushX Error: unexpected error",
-                    status: status.statusCode,
-                    pushXError: status
-                };
-                error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
-                _eventEmitter.emit('pushx_status', error);
-                break;
         }
     };
 
@@ -226,15 +165,11 @@ module.exports = function () {
      * @returns PROMISE.
      */
     var __setup = function (userOptions) {
-
         var pubnubConfig = userOptions.pubnub;
         pubnubConfig.uuid = userOptions.userid;
-        var accountId = userOptions.accountid;
-        var token = userOptions.token;
 
         if (!_pubnubClient && pubnubConfig) {
             _pubnubClient = new pubNub(pubnubConfig); //Connect with PubNub SDK
-            _pubnubClient.setToken(token);
             processSetup();
         } else {
             return new Error('Already Initialized');
@@ -250,8 +185,7 @@ module.exports = function () {
                     _translatePubnubMessage(data);
                 },
                 "status": function (status) {
-                    var statusOptions = { accountId: accountId };
-                    _translatePubnubStatus(status, statusOptions);
+                    _translatePubnubStatus(status);
                 }
             });
         }
@@ -265,169 +199,8 @@ module.exports = function () {
             _globalSubscription = [];
             bStatusSubscribed = false;
             _globalSubscriptionStatus = {};
-            bPollingInitiated = false;
         }
         _pubnubClient = undefined;
-
-        // Clear the Polling
-        if (_setTimeoutIDForPolling) {
-            clearTimeout(_setTimeoutIDForPolling);
-            // Setting the start time to now to clear the old events
-            _startTimestampForPolling = Date.now();
-            _checkOldBubbledEvents();
-            _setTimeoutIDForPolling = undefined;
-            _pollingCounter = undefined;
-            _startTimestampForPolling = undefined;
-        }
-    };
-
-    /**
-     * Polling function
-     */
-    var _pollForEvents = function () {
-        // Setup request params
-        var params = {
-            accountid: _userOptions.accountid,
-            channelname: _globalSubscription[0],
-            starttime: _startTimestampForPolling,
-            endtime: Date.now()
-        };
-
-        // Safe check to avoid poll for events if the channel name or start time is not set
-        // This handles an edge condition where the clearTimeout doesn't work as expected
-        if (!params.channelname || !params.starttime) {
-            return;
-        }
-
-        var requestAPI = request.get(_userOptions.pollingEndpoint).query(params);
-    
-        requestAPI
-            .end(function(error, response) {
-                
-                if (!error) {
-                    // Bubble the connected status
-                    if (_pollingCounter === 0) {
-                        // Set the status of the channel to subscribed
-                        if(_globalSubscriptionStatus[_globalSubscription[0]]) {
-                            _globalSubscriptionStatus[_globalSubscription[0]].status = 'subscribed';
-                        }
-
-                        var successObj = {
-                            category: 'PUSHX',
-                            type: 'CHANNEL_SUBSCRIPTION',
-                            status: 'SUCCESS',
-                            message: 'Success: Subscribed successfully.',
-                            httpcode: 200,
-                            data: {
-                                payload: {
-                                    channels: _globalSubscription
-                                },
-                                message: 'Success: Subscribed successfully.'
-                            }
-                        };
-                        _eventEmitter.emit('pushx_status', successObj);
-                    }
-
-                    // Bubble the received events
-                    _bubblePolledEvents(response.body);
-
-                    // Increase the counter
-                    _pollingCounter++;
-                }
-
-                // Polling will be done only for specific number of times
-                if (_pollingCounter > _userOptions.pollingIterations) {
-                    var error = {
-                        message: "Polling error: Polling limit exceeded",
-                        status: 429
-                    };
-                    error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
-                    _eventEmitter.emit('pushx_status', error);
-                } else {
-                    var timeoutDelay;
-
-                    // If the polling interval is provided, use that
-                    if (_userOptions.pollingInterval) {
-                        timeoutDelay = _userOptions.pollingInterval * 60 * 1000;
-                    } else {
-                        // Else, use exponential backoff
-                        timeoutDelay = parseInt(Math.pow(1.3, _pollingCounter) * 10 * 1000, 10);
-                    }
-
-                    // Set timeout for next poll
-                    if (timeoutDelay) {
-                        _setTimeoutIDForPolling = setTimeout(_pollForEvents, timeoutDelay);
-                    }
-                }
-        });
-    };
-
-    /**
-     * Bubble the polled events to the FE APP
-     * @param {*} events - Events recieved from the polling endpoint 
-     */
-    var _bubblePolledEvents = function (events) {
-        // Load the old events from the session storage
-        var oldEventData = _checkOldBubbledEvents();
-
-        var oldEvents = oldEventData.events;
-        var sessionStorageKey = oldEventData.key;
-
-        for (var i = 0; i < events.entities.length; i++) {
-            var event = events.entities[i];
-            var eventId = event.pk + '_' + event.sk;
-
-            // Check if the event is already emitted
-            if (!oldEvents[eventId]) {
-                oldEvents[eventId] = event.context.start_time;
-
-                // Emit the event
-                _eventEmitter.emit(_globalSubscription[0], event);
-            }
-        }
-
-        // Save the bubbled events to session storage
-        sessionStorage.setItem(sessionStorageKey, JSON.stringify(oldEvents));
-    };
-
-    /**
-     * Check the old bubbled events and remove the events that are older than the start timestamp
-     * @returns {object} - Object containing the key and the events
-     */
-    var _checkOldBubbledEvents = function () {
-        var sessionStorageKey = 'comprodls.old_pushx_events.' + _userOptions.userid + '.' + _globalSubscription[0];
-        var oldEvents = sessionStorage.getItem(sessionStorageKey);
-
-        if (oldEvents) {
-            try {
-                oldEvents = JSON.parse(oldEvents);
-            } catch (e) {
-                oldEvents = {};
-            }
-
-            var oldEventIds = Object.keys(oldEvents);
-
-            // Remove the events that are older than the start timestamp
-            for (var i = 0; i < oldEventIds.length; i++) {
-                var oldEventId = oldEventIds[i];
-
-                if (oldEvents[oldEventId] < _startTimestampForPolling) {
-                    delete oldEvents[oldEventId];
-                }
-            }
-
-            // If the number of events has changed, save the events
-            if (oldEventIds.length !== Object.keys(oldEvents).length) {
-                sessionStorage.setItem(sessionStorageKey, JSON.stringify(oldEvents));
-            }
-        } else {
-            oldEvents = {};
-        }
-
-        return {
-            key: sessionStorageKey,
-            events: oldEvents
-        };
     };
 
     return { // Return public methods for the wrapper