Add Netflux API with WebSocket service V1

www/common/realtime-input.js

@@ -16,31 +16,22 @@
  */
 define([
     '/common/messages.js',
-    // TODO remove in favour of netflux
+    '/common/Netflux.js',
-    '/bower_components/reconnectingWebsocket/reconnecting-websocket.js',
     '/common/crypto.js',
     '/common/toolbar.js',
     '/common/sharejs_textarea.js',
     '/common/chainpad.js',
     '/bower_components/jquery/dist/jquery.min.js',
-], function (Messages,/*FIXME*/ ReconnectingWebSocket, Crypto, Toolbar, sharejs) {
+], function (Messages, Netflux, Crypto, Toolbar, sharejs) {
     var $ = window.jQuery;
     var ChainPad = window.ChainPad;
     var PARANOIA = true;
     var module = { exports: {} };
 
-    /**
-     * If an error is encountered but it is recoverable, do not immediately fail
-     * but if it keeps firing errors over and over, do fail.
-     */
-    var MAX_RECOVERABLE_ERRORS = 15;
-
-    /** Maximum number of milliseconds of lag before we fail the connection. */
-    var MAX_LAG_BEFORE_DISCONNECT = 20000;
-
     var debug = function (x) { console.log(x); },
         warn = function (x) { console.error(x); },
-        verbose = function (x) { /*console.log(x);*/ };
+        verbose = function (x) { console.log(x); };
+    // verbose = function () {}; // comment out to enable verbose logging
 
     // ------------------ Trapping Keyboard Events ---------------------- //
 
@@ -82,67 +73,6 @@ define([
                    unbind);
     };
 
-    /* websocket stuff */
-    var isSocketDisconnected = function (socket, realtime) {
-        var sock = socket._socket;
-        return sock.readyState === sock.CLOSING
-            || sock.readyState === sock.CLOSED
-            || (realtime.getLag().waiting && realtime.getLag().lag > MAX_LAG_BEFORE_DISCONNECT);
-    };
-
-    // this differs from other functions with similar names in that
-    // you are expected to pass a socket into it.
-    var checkSocket = function (socket) {
-        if (isSocketDisconnected(socket, socket.realtime) &&
-            !socket.intentionallyClosing) {
-            return true;
-        } else {
-            return false;
-        }
-    };
-
-    // TODO before removing websocket implementation
-    // bind abort to onLeaving
-    var abort = function (socket, realtime) {
-        realtime.abort();
-        realtime.toolbar.failed();
-        try { socket._socket.close(); } catch (e) { warn(e); }
-    };
-
-    var handleError = function (socket, realtime, err, docHTML, allMessages) {
-        // var internalError = createDebugInfo(err, realtime, docHTML, allMessages);
-        abort(socket, realtime);
-    };
-
-    var makeWebsocket = function (url) {
-        var socket = new ReconnectingWebSocket(url);
-        var out = {
-            onOpen: [],
-            onClose: [],
-            onError: [],
-            onMessage: [],
-            send: function (msg) { socket.send(msg); },
-            close: function () { socket.close(); },
-            _socket: socket
-        };
-        var mkHandler = function (name) {
-            return function (evt) {
-                for (var i = 0; i < out[name].length; i++) {
-                    if (out[name][i](evt) === false) {
-                        console.log(name +"Handler");
-                        return;
-                    }
-                }
-            };
-        };
-        socket.onopen = mkHandler('onOpen');
-        socket.onclose = mkHandler('onClose');
-        socket.onerror = mkHandler('onError');
-        socket.onmessage = mkHandler('onMessage');
-        return out;
-    };
-    /* end websocket stuff */
-
     var start = module.exports.start =
         function (textarea, websocketUrl, userName, channel, cryptKey, config)
     {
@@ -155,86 +85,76 @@ define([
         var doc = config.doc || null;
         
         // trying to deprecate onRemote, prefer loading it via the conf
-        var onRemote = config.onRemote || null;
+        onRemote = config.onRemote || null;
 
-        var transformFunction = config.transformFunction || null;
+        transformFunction = config.transformFunction || null;
 
-        var socket;
-
-        if (config.socketAdaptor) {
-            // do netflux stuff
-        } else {
-            socket = makeWebsocket(websocketUrl);
-        }
         // define this in case it gets called before the rest of our stuff is ready.
         var onEvent = function () { };
 
         var allMessages = [];
-        var isErrorState = false;
         var initializing = true;
-        var recoverableErrorCount = 0;
-
-        var $textarea = $(textarea);
 
         var bump = function () {};
 
-        socket.onOpen.push(function (evt) {
+        var options = {
-            if (!initializing) {
+          signaling: websocketUrl,
-                console.log("Starting");
+          topology: 'StarTopologyService',
-                // realtime is passed around as an attribute of the socket
+          protocol: 'WebSocketProtocolService',
-                // FIXME??
+          connector: 'WebSocketService',
-                socket.realtime.start();
+          openWebChannel: true
-                return;
+        };
-            }
+        var realtime;
         
-            var realtime = socket.realtime = ChainPad.create(userName,
+        // Connect to the WebSocket server
-                                passwd,
+        Netflux.join(channel, options).then(function(wc) {
-                                channel,
+            wc.onMessage = onMessage; // On receiving message
-                                $(textarea).val(),
+            wc.onJoining = onJoining; // On user joining the session
-                                {
-                                    transformFunction: config.transformFunction
-                                });
 
-            if (config.onInit) {
+            // Open a Chainpad session
-                // extend as you wish
+            realtime = createRealtime();
-                config.onInit({
+            realtime.onUserListChange(function (userList) {
-                    realtime: realtime
+                var opt = {userList : userList};
+                // TODO : onJoining should only a a "newPeer" parameter
+                wc.onJoining(opt);
+            });
+            // On sending message
+            realtime.onMessage(function(message) {
+                message = Crypto.encrypt(message, cryptKey);
+                wc.send(message);
             });
-            }
 
-            onEvent = function () {
+            // Check the connection to the channel
-                // This looks broken
+            //checkConnection(wc);
-                if (isErrorState || initializing) { return; }
-            };
 
-            realtime.onUserListChange(function (userList) {
+            bindAllEvents(textarea, doc, onEvent, false);
-                if (!initializing || userList.indexOf(userName) === -1) {
-                    return;
-                }
-                // if we spot ourselves being added to the document, we'll switch
-                // 'initializing' off because it means we're fully synced.
-                initializing = false;
 
-                // execute an onReady callback if one was supplied
+            sharejs.attach(textarea, realtime);
-                // pass an object so we can extend this later
+            bump = realtime.bumpSharejs;
-                if (config.onReady) {
+
-                    // extend as you wish
+            realtime.start();
-                    config.onReady({
+        }, function(error) {
-                        userList: userList
+            warn(error);
         });
-                }
+
+        var createRealtime = function() {
+            return ChainPad.create(userName,
+                                        passwd,
+                                        channel,
+                                        $(textarea).val(),
+                                        {
+                                        transformFunction: config.transformFunction
                                         });
+        }
         
         var whoami = new RegExp(userName.replace(/[\/\+]/g, function (c) {
             return '\\' +c;
         }));
 
-            // when you receive a message...
+        var onMessage = function(user, message) {
-            socket.onMessage.push(function (evt) {
+
-                verbose(evt.data);
+            message = Crypto.decrypt(message, cryptKey);
-                if (isErrorState) { return; }
             
-                var message = Crypto.decrypt(evt.data, cryptKey);
             verbose(message);
             allMessages.push(message);
             if (!initializing) {
@@ -257,43 +177,40 @@ define([
                     }
                 }
             }
-            });
-
-            // when a message is ready to send
-            realtime.onMessage(function (message) {
-                if (isErrorState) { return; }
-                message = Crypto.encrypt(message, cryptKey);
-                try {
-                    socket.send(message);
-                } catch (e) {
-                    warn(e);
         }
-            });
+        var onJoining = function(optionnalData) {
+            var userList = optionnalData.userList || [];
+            if (!initializing || userList.indexOf(userName) === -1) {
+                return;
+            }
+            // if we spot ourselves being added to the document, we'll switch
+            // 'initializing' off because it means we're fully synced.
+            initializing = false;
 
-            // actual socket bindings
+            // execute an onReady callback if one was supplied
-            socket.onmessage = function (evt) {
+            // pass an object so we can extend this later
-                for (var i = 0; i < socket.onMessage.length; i++) {
+            if (config.onReady) {
-                    if (socket.onMessage[i](evt) === false) { return; }
+                config.onReady({
+                    userList: userList
+                });
             }
-            };
-            socket.onclose = function (evt) {
-                for (var i = 0; i < socket.onMessage.length; i++) {
-                    if (socket.onClose[i](evt) === false) { return; }
         }
-            };
 
-            socket.onerror = warn;
+        var checkConnection = function(wc) {
-
+          //TODO
-            // TODO confirm that we can rely on netflux API
+            /*var socketChecker = setInterval(function () {
-            var socketChecker = setInterval(function () {
+                if (netflux.checkSocket(realtime)) {
-                if (checkSocket(socket)) {
                     warn("Socket disconnected!");
 
                     recoverableErrorCount += 1;
 
                     if (recoverableErrorCount >= MAX_RECOVERABLE_ERRORS) {
                         warn("Giving up!");
-                        abort(socket, realtime);
+                        realtime.abort();
+                        wc.leave()
+                            .then(null, function(err) {
+                                warn(err);
+                            });
                         if (config.onAbort) {
                             config.onAbort({
                                 socket: socket
@@ -304,19 +221,9 @@ define([
                 } else {
                     // it's working as expected, continue
                 }
-            }, 200);
+            }, 200);*/
-
+        }
-            bindAllEvents(textarea, doc, onEvent, false);
-
-            // attach textarea
-            // NOTE: should be able to remove the websocket without damaging this
-            sharejs.attach(textarea, realtime);
-
-            realtime.start();
-            debug('started');
 
-            bump = realtime.bumpSharejs;
-        });
         return {
             onEvent: function () {
                 onEvent();