jam-cloud/app/assets/javascripts/JamServer.js

// TODO: Rename? This is really only the websocket/messaging
// part of the server (none of the REST calls go through this).
// perhaps something like RealTimeMessages or something...
//
// The wrapper around the web-socket connection to the server
(function(context, $) {

    "use strict";

    context.JK = context.JK || {};

    var logger = context.JK.logger;
    var msg_factory = context.JK.MessageFactory;

    // Let socket.io know where WebSocketMain.swf is
    context.WEB_SOCKET_SWF_LOCATION = "assets/flash/WebSocketMain.swf";

    var server = {};
    server.socket = {};
    server.signedIn = false;
    server.clientID = "";
    server.publicIP = "";
    server.dispatchTable = {};

    server.registerMessageCallback = function(messageType, callback) {
        if (server.dispatchTable[messageType] === undefined) {
            server.dispatchTable[messageType] = [];
        }

        server.dispatchTable[messageType].push(callback);
    };

    server.unregisterMessageCallback = function(messageType, callback) {
        if (server.dispatchTable[messageType] !== undefined) {
            for(var i = server.dispatchTable.length; i--;) {
                if (server.dispatchTable[messageType][i] === callback)
                {
                    server.dispatchTable[messageType].splice(i, 1);
                    break;
                }
            }
        }

        if (server.dispatchTable[messageType].length === 0) {
            delete server.dispatchTable[messageType];
        }
    };

    server.connect = function() {
        logger.log("server.connect");
        var uri = context.JK.websocket_gateway_uri;  // Set in index.html.erb.
        //var uri = context.gon.websocket_gateway_uri; // Leaving here for now, as we're looking for a better solution.
        server.socket = new context.WebSocket(uri);
        server.socket.onopen = server.onOpen;
        server.socket.onmessage = server.onMessage;
        server.socket.onclose = server.onClose;
    };

    server.onOpen = function() {
        logger.log("server.onOpen");
        var token, loginMessage;
        token = $.cookie("remember_token");
        loginMessage = msg_factory.login_with_token(token);
        server.send(loginMessage);
    };

    server.onMessage = function(e) {
        logger.log("server.onMessage");
        var message = JSON.parse(e.data),
            messageType = message.type.toLowerCase(),
            payload = message[messageType],
            callbacks = server.dispatchTable[message.type];

        if (callbacks !== undefined) {
            var len = callbacks.length;
            for(var i = 0; i < len; i++) {
                callbacks[i](message, payload);
            }
        }
        else {
            logger.log("Unexpected message type %s.", message.type);
        }
    };

    server.onClose = function() {
        logger.log("Socket to server closed.");

        if (context.jamClient !== undefined)
        {
            context.jamClient.connected = false;
        }

        // TODO: reconnect
    };

    server.send = function(message) {

        var jsMessage = JSON.stringify(message);

        // make sure we're connected before sending
        if (context.jamClient.connected === true) {
            logger.log("server.send(" + jsMessage + ")");
            if (server !== undefined && server.socket !== undefined && server.socket.send !== undefined) {
                server.socket.send(jsMessage);
            } else {
                logger.log("Dropped message because server connection is closed.");
            }
        }
        else {
            logger.log("Could not send " + jsMessage + " since we're not connected yet.");
        }
    };

    server.loginSession = function(sessionId) {
        var loginMessage;

        if (!server.signedIn) {
            logger.log("Not signed in!");
            // TODO: surface the error
            return;
        }

        loginMessage = msg_factory.login_jam_session(sessionId);
        server.send(loginMessage);
    };

    server.sendP2PMessage = function(receiver_id, message) {
        logger.log("P2P message from [" + server.clientID + "] to [" + receiver_id + "]: " + message);
        var outgoing_msg = msg_factory.client_p2p_message(server.clientID, receiver_id, message);
        server.send(outgoing_msg);
    };

    context.JK.JamServer = server;

    // Message callbacks
    server.registerMessageCallback(context.JK.MessageType.LOGIN_ACK, function(header, payload) {
        server.signedIn = true;
        server.clientID = payload.client_id;
        server.publicIP = payload.public_ip;

        if (context.jamClient !== undefined)
        {
            context.jamClient.connected = true;
            context.jamClient.clientID = server.clientID;
        }
    });

    server.registerMessageCallback(context.JK.MessageType.PEER_MESSAGE, function(header, payload) {
        if (context.jamClient !== undefined)
        {
            context.jamClient.P2PMessageReceived(header.from, payload.message);
        }
    });

    server.registerMessageCallback(context.JK.MessageType.USER_JOINED_MUSIC_SESSION, function(header, payload) {
        context.JK.refreshMusicSession(payload.session_id);
    });

    // TODO: not used
    server.registerMessageCallback(context.JK.MessageType.LOGIN_MUSIC_SESSION_ACK, function(header, payload) {
        if (context.jamClient !== undefined)
        {
            // TODO: modify the LOGIN_MUSIC_SESSION_ACK message to include session_id
            context.jamClient.JoinSession({ sessionID : payload.session_id});
        }
    });

    // Callbacks from jamClient
    if (context.jamClient !== undefined)
    {
        context.jamClient.SendP2PMessage.connect(server.sendP2PMessage);
    }

})(window, jQuery);