crisp-api 5.3.0 → 6.0.0

package/CHANGELOG.md

@@ -1,6 +1,21 @@
 Changelog
 =========
 
+## v6.0.0
+
+### Breaking Changes
+
+* Support for NodeJS 6 has been removed. The minimum version is now NodeJS 8.
+* The `CrispClient.on` method now returns a `Promise`. Please update your code accordingly. We do recommend that you add error catchers.
+
+### New Features
+
+* The RTM API URL is now dynamically pulled from the REST API, based on the authentication tier. This allows for (much) more efficient message routing at Crisp scale, and offers performance and stability benefits to your integration.
+
+### Bug Fixes
+
+* Fixed an issue where the library would not reconnect to the RTM API when it lost connection with the server.
+
 ## v5.3.0
 
 ### New Features

package/README.md

@@ -79,7 +79,13 @@ CrispClient.on("message:send", function(message) {
     .catch(function(error) {
       console.error("Error sending message:", error);
     });
-});
+})
+  .then(function() {
+    console.error("Requested to listen to sent messages");
+  })
+  .catch(function(error) {
+    console.error("Failed listening to sent messages:", error);
+  });
 ```
 
 ## Resource Methods
@@ -2338,7 +2344,7 @@ _👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
 
 You can bind to realtime events from Crisp, in order to get notified of incoming messages and updates in websites.
 
-You won't receive any event if you don't explicitly subscribe to realtime events using `CrispClient.on()`, as the library doesn't connect to the realtime backend automatically.
+You won't receive any event if you don't explicitly subscribe to realtime events using `CrispClient.on()`, as the library doesn't connect to the realtime backend automatically. This method returns a `Promise` object.
 
 Available events are listed below:
 

package/lib/crisp.js

@@ -10,15 +10,12 @@
 
 
 // Imports
-var pkg           = require('../package.json');
+var pkg           = require("../package.json");
 var got           = require("got");
 
+var URL           = require("url").URL;
 var EventEmitter  = require("fbemitter").EventEmitter;
 
-var __Promise     = (
-  (typeof Promise !== "undefined") ? Promise : require("q").Promise
-);
-
 
 // Base configuration
 Crisp.DEFAULT_REQUEST_TIMEOUT            = 10000;
@@ -36,8 +33,6 @@ Crisp.DEFAULT_REST_BASE_PATH   = "/v1/";
 
 
 // RTM API defaults
-Crisp.DEFAULT_RTM_HOST   = "https://app.relay.crisp.chat";
-
 Crisp.DEFAULT_RTM_EVENTS = [
   // Session Events
   "session:update_availability",
@@ -165,7 +160,7 @@ function Crisp() {
 
   /** @private */
   this._rtm  = {
-    host : Crisp.DEFAULT_RTM_HOST
+    host : null
   };
 
   /** @private */
@@ -270,7 +265,7 @@ Crisp.prototype = {
   head : function(resource, query, body) {
     var self = this;
 
-    return new __Promise(function(resolve, reject) {
+    return new Promise(function(resolve, reject) {
       self._request(
         resource, "head", (query || {}), null, resolve, reject
       );
@@ -288,7 +283,7 @@ Crisp.prototype = {
   get : function(resource, query) {
     var self = this;
 
-    return new __Promise(function(resolve, reject) {
+    return new Promise(function(resolve, reject) {
       self._request(
         resource, "get", (query || {}), null, resolve, reject
       );
@@ -306,7 +301,7 @@ Crisp.prototype = {
   post : function(resource, query, body) {
     var self = this;
 
-    return new __Promise(function(resolve, reject) {
+    return new Promise(function(resolve, reject) {
       self._request(
         resource, "post", (query || {}), (body || {}), resolve, reject
       );
@@ -324,7 +319,7 @@ Crisp.prototype = {
   patch : function(resource, query, body) {
     var self = this;
 
-    return new __Promise(function(resolve, reject) {
+    return new Promise(function(resolve, reject) {
       self._request(
         resource, "patch", (query || {}), (body || {}), resolve, reject
       );
@@ -342,7 +337,7 @@ Crisp.prototype = {
   put : function(resource, query, body) {
     var self = this;
 
-    return new __Promise(function(resolve, reject) {
+    return new Promise(function(resolve, reject) {
       self._request(
         resource, "put", (query || {}), (body || {}), resolve, reject
       );
@@ -360,7 +355,7 @@ Crisp.prototype = {
   delete : function(resource, query, body) {
     var self = this;
 
-    return new __Promise(function(resolve, reject) {
+    return new Promise(function(resolve, reject) {
       self._request(
         resource, "delete", (query || {}), (body || null), resolve, reject
       );
@@ -409,7 +404,7 @@ Crisp.prototype = {
       this._boundEvents.push(event);
 
       // Socket not connected? Connect now.
-      this._prepareSocket(
+      return this._prepareSocket(
         function(socket, emitter) {
           // Listen for event (once socket is bound)
           socket.on(event, function(data) {
@@ -418,6 +413,8 @@ Crisp.prototype = {
         }
       );
     }
+
+    return Promise.resolve();
   },
 
   /**
@@ -455,7 +452,10 @@ Crisp.prototype = {
       // No resources defined in service?
       if (!serviceInstance._resources  ||
             serviceInstance._resources.length === 0) {
-        throw new Error("Service '" + name + "' has no resources defined");
+        throw new Error(
+          "[Crisp] prepareServices: service '" + name + "' has no resources "  +
+            "defined"
+        );
       }
 
       // Prepare all resources (for service)
@@ -471,9 +471,9 @@ Crisp.prototype = {
    * Binds resources to the service object
    * @memberof Crisp
    * @private
+   * @method _prepareResources
    * @param {object} serviceInstance
    * @param {Array} resources
-   * @method _prepareResources
    */
   _prepareResources : function(serviceInstance, resources) {
     for (var i = 0; i < resources.length; i++) {
@@ -494,41 +494,116 @@ Crisp.prototype = {
   _prepareSocket : function(fnBindHook) {
     var self = this;
 
-    var rtmHost = this._rtm.host;
+    return new Promise(function(resolve, reject) {
+      var rtmHostOverride = self._rtm.host;
+
+      // Append bind hook to pending stack
+      self._socketBindHooks.push(fnBindHook);
 
-    // Append bind hook to pending stack
-    this._socketBindHooks.push(fnBindHook);
+      // Make sure to prepare socket once? (defer socket binding, waiting that \
+      //   all listeners have been bound, that way we submit the list of \
+      //   filtered events to the RTM API once, and never again in the future)
+      if (self._socketScheduler === null) {
+        // Socket is already set? We should not even have entered there.
+        if (self._socket) {
+          throw new Error(
+            "[Crisp] prepareSocket: illegal call to prepare socket (tie break)"
+          );
+        }
 
-    // Make sure to prepare socket once? (defer socket binding, waiting that \
-    //   all listeners have been bound, that way we submit the list of \
-    //   filtered events to the RTM API once, and never again in the future)
-    if (this._socketScheduler === null) {
-      // Socket is already set? We should not even have entered there.
-      if (this._socket) {
-        throw new Error("[Crisp] illegal call to prepare socket (tie break)");
+        self._socketScheduler = setTimeout(function() {
+          // Connect to socket now
+          self._connectSocket(rtmHostOverride)
+            .then(resolve)
+            .catch(reject);
+        }, Crisp.DEFAULT_SOCKET_SCHEDULE);
+      } else {
+        // Pass-through
+        resolve();
       }
+    });
+  },
+
+  /**
+   * Connects socket, using preferred RTM API host
+   * @memberof Crisp
+   * @private
+   * @method _connectSocket
+   * @param {string} rtmHostOverride
+   */
+  _connectSocket : function(rtmHostOverride) {
+    var self = this;
+
+    return Promise.resolve()
+      .then(function() {
+        // Any override RTM API host?
+        if (rtmHostOverride) {
+          return Promise.resolve({
+            socket : {
+              app : rtmHostOverride
+            }
+          });
+        }
+
+        // Acquire RTM API URL from remote
+        var restUrlSegments;
+
+        switch (self._tier) {
+          case "plugin": {
+            restUrlSegments = ["plugin", "connect", "endpoints"];
 
-      this._socketScheduler = setTimeout(function() {
-        self._socket = require('socket.io-client')(rtmHost, {
+            break;
+          }
+
+          default: {
+            restUrlSegments = ["user", "connect", "endpoints"];
+          }
+        }
+
+        return self.get(
+          self._prepareRestUrl(restUrlSegments)
+        )
+          .catch(function() {
+            // Void error (consider as empty response)
+            return Promise.resolve({});
+          });
+      })
+      .then(function(endpoints) {
+        var rtmHostAffinity = ((endpoints.socket || {}).app || null);
+
+        // No RTM API host acquired?
+        if (rtmHostAffinity === null) {
+          throw new Error(
+            "[Crisp] connectSocket: could not acquire target host to "  +
+              "connect to, is your session valid for tier?"
+          );
+        }
+
+        // Parse target RTM API host as an URL object
+        var rtmHostUrl = new URL(rtmHostAffinity);
+
+        // Connect to socket
+        self._socket = require("socket.io-client")(rtmHostUrl.origin, {
+          path                 : (rtmHostUrl.pathname || "/"),
           transports           : ["websocket"],
           timeout              : Crisp.DEFAULT_SOCKET_TIMEOUT,
           reconnection         : true,
           reconnectionDelay    : Crisp.DEFAULT_SOCKET_RECONNECT_DELAY,
           reconnectionDelayMax : Crisp.DEFAULT_SOCKET_RECONNECT_DELAY_MAX,
           randomizationFactor  : Crisp.DEFAULT_SOCKET_RECONNECT_FACTOR
-
         });
 
         self._emitAuthenticate();
 
         // Setup base socket event listeners
-        self._socket.on("reconnect", function() {
+        self._socket.io.on("reconnect", function() {
           self._emitAuthenticate();
         });
 
         self._socket.on("unauthorized", function() {
           throw new Error(
-            "[Crisp] cannot listen for events as authentication is invalid"
+            "[Crisp] connectSocket: cannot listen for events as "  +
+              "authentication is invalid"
           );
         });
 
@@ -538,8 +613,7 @@ Crisp.prototype = {
             self._socket, self._emitter
           );
         }
-      }, Crisp.DEFAULT_SOCKET_SCHEDULE);
-    }
+      });
   },
 
   /**
@@ -555,7 +629,7 @@ Crisp.prototype = {
    * @param {function} reject
    */
   _request : function(resource, method, query, body, resolve, reject) {
-    var _parameters = {
+    var requestParameters = {
       json    : true,
       timeout : Crisp.DEFAULT_REQUEST_TIMEOUT,
 
@@ -567,21 +641,21 @@ Crisp.prototype = {
 
     // Add authorization?
     if (this.auth.token) {
-      _parameters.headers.Authorization = ("Basic " + this.auth.token);
+      requestParameters.headers.Authorization = ("Basic " + this.auth.token);
     }
 
     // Add body?
     if (body) {
-      _parameters.body = body;
+      requestParameters.body = body;
     }
 
     // Add query?
     if (query) {
-      _parameters.query = query;
+      requestParameters.query = query;
     }
 
     // Proceed request
-    got[method](resource, _parameters)
+    got[method](resource, requestParameters)
       .catch(function(error) {
         return Promise.resolve(error);
       })
@@ -644,17 +718,20 @@ Crisp.prototype = {
 
     if (!this._socket) {
       throw new Error(
-        "[Crisp] cannot listen for events as socket is not yet bound"
+        "[Crisp] emitAuthenticate: cannot listen for events as socket is "  +
+          "not yet bound"
       );
     }
     if (!auth.identifier || !auth.key) {
       throw new Error(
-        "[Crisp] cannot listen for events as you did not authenticate"
+        "[Crisp] emitAuthenticate: cannot listen for events as you did not "  +
+          "authenticate"
       );
     }
     if (this._boundEvents.length === 0) {
       throw new Error(
-        "[Crisp] cannot listen for events as no event is being listened to"
+        "[Crisp] emitAuthenticate: cannot listen for events as no event is "  +
+          "being listened to"
       );
     }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "crisp-api",
   "description": "Crisp API wrapper for Node - official, maintained by Crisp",
-  "version": "5.3.0",
+  "version": "6.0.0",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {
@@ -25,7 +25,7 @@
   "main": "./lib/crisp",
   "types": "./types/crisp.d.ts",
   "engines": {
-    "node": ">= 6.0.0"
+    "node": ">= 8.0.0"
   },
   "scripts": {
     "test": "check-build",
@@ -38,8 +38,7 @@
   "dependencies": {
     "socket.io-client": "4.4.1",
     "fbemitter": "3.0.0",
-    "got": "9.6.0",
-    "q": "2.0.3"
+    "got": "9.6.0"
   },
   "keywords": [
     "crisp",

package/types/crisp.d.ts

@@ -48,7 +48,7 @@ declare class Crisp {
     _emitAuthenticate: () => void;
 }
 declare namespace Crisp {
-    export { DEFAULT_REQUEST_TIMEOUT, DEFAULT_SOCKET_TIMEOUT, DEFAULT_SOCKET_RECONNECT_DELAY, DEFAULT_SOCKET_RECONNECT_DELAY_MAX, DEFAULT_SOCKET_RECONNECT_FACTOR, DEFAULT_SOCKET_SCHEDULE, DEFAULT_USERAGENT_PREFIX, DEFAULT_REST_HOST, DEFAULT_REST_BASE_PATH, DEFAULT_RTM_HOST, DEFAULT_RTM_EVENTS, Crisp };
+    export { DEFAULT_REQUEST_TIMEOUT, DEFAULT_SOCKET_TIMEOUT, DEFAULT_SOCKET_RECONNECT_DELAY, DEFAULT_SOCKET_RECONNECT_DELAY_MAX, DEFAULT_SOCKET_RECONNECT_FACTOR, DEFAULT_SOCKET_SCHEDULE, DEFAULT_USERAGENT_PREFIX, DEFAULT_REST_HOST, DEFAULT_REST_BASE_PATH, DEFAULT_RTM_EVENTS, Crisp };
 }
 declare var DEFAULT_REQUEST_TIMEOUT: number;
 declare var DEFAULT_SOCKET_TIMEOUT: number;
@@ -59,5 +59,4 @@ declare var DEFAULT_SOCKET_SCHEDULE: number;
 declare var DEFAULT_USERAGENT_PREFIX: string;
 declare var DEFAULT_REST_HOST: string;
 declare var DEFAULT_REST_BASE_PATH: string;
-declare var DEFAULT_RTM_HOST: string;
 declare var DEFAULT_RTM_EVENTS: string[];