comprodls-sdk 2.81.0 → 2.82.0-alpha

package/lib/comprodls.js

@@ -46,6 +46,7 @@ var drive = require('./services/drive');
 var taxonomy = require('./services/taxonomy');
 var rules = require('./services/rules');
 var datasyncmanager = require('./services/datasyncmanager');
+var helloWorld = require('./services/helloworld');
 
 
 /*********************************
@@ -145,6 +146,7 @@ comproDLS.prototype.Invitations = invitations;
 comproDLS.prototype.Workflows = workflows;
 comproDLS.prototype.Integrations = integrations;
 comproDLS.prototype.Drive = drive;
+comproDLS.prototype.HelloWorld = helloWorld;
 comproDLS.prototype.Taxonomy = taxonomy;
 comproDLS.prototype.Rules = rules;
 comproDLS.prototype.Datasyncmanager = datasyncmanager;

package/lib/config/index.js

@@ -53,7 +53,8 @@ exports.REALM_HOSTS = {
       PRODUCT: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-product',
       ANALYTICS: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-analytics',
       INTEGRATION: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-integrations',
-      DRIVE: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-drive'
+      DRIVE: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-drive',
+      HELLOWORLD: 'http://dls-asgard-thor-1453383019.us-west-2.elb.amazonaws.com/lb-helloworld'
     }
   },
   CUP: {
@@ -370,6 +371,10 @@ exports.DRIVE_API_URLS = {
   documents: '/accounts/{accountid}/users/{userid}/documents/multi'
 };
 
+exports.HELLO_WORLD_API_URLS = {
+  sayHello: '/org/{orgid}/hello?name=map-team'
+};
+
 exports.TAXONOMY_API_URLS = {
   associateTagsWithEntity: '/org/{orgId}/taxonomy/associate-tags-with-entity',
   tags: '/org/{orgId}/context/{context}/taxonomy/{taxonomyId}/tags'

package/lib/helpers/lib/errors.js

@@ -26,7 +26,9 @@
 var ERROR_TYPES = {
     "API_ERROR": "API_ERROR",
     "SDK_ERROR": "SDK_ERROR",
-    "CHANNEL_SUBSCRIPTION": "CHANNEL_SUBSCRIPTION"
+    "CHANNEL_SUBSCRIPTION": "CHANNEL_SUBSCRIPTION",
+    "UNEXPECTED_ERROR": "UNEXPECTED_ERROR",
+    "POLLING_INITIATION": "POLLING_INITIATION"
 };
 
 var ERROR_CATEGORY = {

package/lib/services/helloworld/index.js

@@ -0,0 +1,81 @@
+/*************************************************************************
+ *
+ * COMPRO CONFIDENTIAL
+ * __________________
+ *
+ *  [2015] - [2020] Compro Technologies Private Limited
+ *  All Rights Reserved.
+ *
+ * NOTICE:  All information contained herein is, and remains
+ * the property of Compro Technologies Private Limited. The
+ * intellectual and technical concepts contained herein are
+ * proprietary to Compro Technologies Private Limited and may
+ * be covered by U.S. and Foreign Patents, patents in process,
+ * and are protected by trade secret or copyright law.
+ *
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Compro Technologies Pvt. Ltd..
+ ***************************************************************************/
+
+/***********************************************************
+ * comproDLS SDK Hello World Service
+ * Function for calling Hello World API.
+ ************************************************************/
+
+var q = require('q');
+var request = require('superagent');
+var Agent = require('agentkeepalive');
+
+var helpers = require('../../helpers');
+var DLSError = helpers.errors.DLSError;
+
+module.exports = helloWorld;
+
+var keepaliveAgent = new Agent({
+  timeout: 60000,
+  freeSocketTimeout: 30000
+});
+
+/*********************************
+ * Public Function definitions
+ **********************************/
+function helloWorld() {
+  return {
+    sayHello: sayHello.bind(this)
+  };
+}
+
+/*
+  options = {
+    accountid : 'string', //mandatory
+    extuserid : 'string', //mandatory
+  }
+*/
+function sayHello() {
+  var self = this;
+  var dfd = q.defer();
+
+  // Passed all validations, Construct API url
+  var url = self.config.DEFAULT_HOSTS.HELLOWORLD + self.config.HELLO_WORLD_API_URLS.sayHello;
+  var urlOptions = {
+    orgid: self.orgId,
+  };
+  url = helpers.api.constructAPIUrl(url, urlOptions);
+
+  // Setup request with URL
+  var requestAPI = request.get(url);
+
+  if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+  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;
+}

package/lib/services/pushX/index.js

@@ -80,11 +80,8 @@ function _connect(pubnubCW, options) {
       'publishKey': options.publishKey,
       'subscribeKey': options.subscribeKey,
       'ssl': true
-    },
-    'pollingEndpoint': options.pollingEndpoint,
-    'pollingIterations': options.pollingIterations || 10, // Default polling iterations is 10
-    'pollingInterval': options.pollingInterval, // Default polling interval is exponential backoff
-});
+    }
+  });
 }
 
 function _cleanup(pubnubCW) { pubnubCW.cleanup(); }

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
         };
@@ -91,10 +77,6 @@ module.exports = function () {
 
     var _translatePubnubStatus = function(status, options) {
         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") {
@@ -156,10 +138,11 @@ module.exports = function () {
                 break;
             case "PNNetworkIssuesCategory":
                 if(status.operation === 'PNSubscribeOperation') {
-                    if(!options.accountId || !_userOptions.pollingEndpoint) {
+                    if(!options.accountId) {
                         error = {
-                            message: "Polling initiation error: Missing mandatory parameters to initiate polling operation - [accountId, pollingEndpoint]",
-                            status: status.statusCode
+                            message: "Missing mandatory parameters to initiate polling operation - accountId",
+                            status: status.statusCode,
+                            type: helpers.errors.ERROR_TYPES.POLLING_INITIATION,
                         };
                         error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
                         _eventEmitter.emit('pushx_status', error);
@@ -173,9 +156,6 @@ module.exports = function () {
                          * 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 {
@@ -188,8 +168,9 @@ module.exports = function () {
             default:
                 // Emit error for other status-category received from pubnub
                 error = {
-                    message: "PushX Error: unexpected error",
+                    message: "PushX Error",
                     status: status.statusCode,
+                    type: helpers.errors.ERROR_TYPES.UNEXPECTED_ERROR,
                     pushXError: status
                 };
                 error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
@@ -226,7 +207,6 @@ module.exports = function () {
      * @returns PROMISE.
      */
     var __setup = function (userOptions) {
-
         var pubnubConfig = userOptions.pubnub;
         pubnubConfig.uuid = userOptions.userid;
         var accountId = userOptions.accountid;
@@ -265,160 +245,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()
-        };
-        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
-                    _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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "comprodls-sdk",
   "description": "comproDLS SDK for JavaScript",
-  "version": "2.81.0",
+  "version": "2.82.0-alpha",
   "author": {
     "name": "Compro Technologies Private Limited",
     "url": "http://www.comprotechnologies.com/"