attester/lib/test-server/client/slave-client.js

/* global SockJS */
/*
 * Copyright 2012 Amadeus s.a.s.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

(function () {
    var window = this;
    var config = window.attesterConfig || {}; // a config object can be set by the PhantomJS script
    window.attesterConfig = null;
    var AttesterAPI = function (taskExecutionId) {
        this.__taskExecutionId = taskExecutionId || -1;
        this.currentTask = {};
    };
    var attesterPrototype = AttesterAPI.prototype = {};

    var location = window.location;
    var document = window.document;
    var statusBar = document.getElementById('status_text');
    var statusInfo = document.getElementById('status_info');
    var pauseResume = document.getElementById('pause_resume');
    var logs = document.getElementById('status_logs');
    var paused = false;
    var iframeParent = document.getElementById('content');
    var iframe;
    var baseUrl = location.protocol + "//" + location.host;
    var socketStatus = "loading";
    var testStatus = "waiting";
    var testInfo = "loading";
    var currentTask = null;
    var pendingTestStarts = null;
    var slaveId = (function () {
        var match = /(?:\?|\&)id=([^&]+)/.exec(location.search);
        if (match) {
            return match[1];
        }
        return null;
    })();
    var flags = (function () {
        var match = /(?:\?|\&)flags=([^&]+)/.exec(location.search);
        if (match) {
            return decodeURIComponent(match[1]);
        }
        return null;
    })();
    var beginning = new Date();

    var log = window.location.search.indexOf("log=true") !== -1 ?
        function (message) {
            var time = (new Date() - beginning) + "ms";
            // Log to the browser console
            if (window.console && window.console.log) {
                console.log(time, message);
            }
            // Log to the div console (useful for remote slaves or when console is missing)
            logs.innerHTML = "<p><span class='timestamp'>" + time + "</span>" + message + "</p>" + logs.innerHTML;
            logs.firstChild.scrollIntoView(false);
        } : function () {};

    var reportLogToServer = function (level, args, taskExecutionId) {
        var time = new Date().getTime();
        var msg = [];
        for (var i = 0, l = args.length; i < l; i++) {
            msg.push(String(args[i]));
        }
        socket.send(JSON.stringify({
            type: 'log',
            taskExecutionId: taskExecutionId,
            event: {
                time: time,
                level: level,
                message: msg.join(" ")
            }
        }));
    };

    var updateStatus = function () {
        statusBar.innerHTML = socketStatus + " - " + testStatus;
        pauseResume.innerHTML = paused ? "Resume" : "Pause";
        statusInfo.innerHTML = "<span id='_info_" + testInfo + "'></span>";
    };

    var socketStatusUpdate = function (status, info) {
        socketStatus = status;
        testInfo = info || status;
        updateStatus();
    };

    var removeIframe = function () {
        if (iframe) {
            window.attester = new AttesterAPI();
            iframeParent.removeChild(iframe);
            iframe = null;
        }
    };

    var createIframe = function (src, taskExecutionId) {
        removeIframe();
        window.attester = new AttesterAPI(taskExecutionId);
        iframe = document.createElement("iframe");
        iframe.setAttribute("id", "iframe");
        iframe.setAttribute("src", src);
        // IE 7 needs frameBorder with B in upper case
        iframe.setAttribute("frameBorder", "0");
        iframeParent.appendChild(iframe);
    };

    var stop = function () {
        currentTask = null;
        pendingTestStarts = null;
        removeIframe();
        testStatus = paused ? "paused" : "waiting";
        testInfo = "idle";
        updateStatus();
    };

    log("creating a socket");

    var socket;

    var onSocketOpen = function () {
        log("slave connected");
        socketStatusUpdate('connected');
        attesterPrototype.connected = true;
        stop();
        socket.send(JSON.stringify({
            type: 'slave',
            id: slaveId,
            paused: paused,
            userAgent: window.navigator.userAgent,
            documentMode: document.documentMode,
            flags: flags
        }));
    };

    var onSocketClose = function () {
        log("slave disconnected");
        socketStatusUpdate('disconnected');
        attesterPrototype.connected = false;
        stop();
        if (config.onDisconnect) {
            config.onDisconnect();
        }
        setTimeout(createConnection, 1000);
    };

    var messages = {
        slaveExecute: function (data) {
            currentTask = data;
            pendingTestStarts = {};
            removeIframe();
            testStatus = "executing " + data.name + " remaining " + data.stats.remainingTasks + " tasks in this campaign";
            if (data.stats.browserRemainingTasks != data.stats.remainingTasks) {
                testStatus += ", including " + data.stats.browserRemainingTasks + " tasks for this browser";
            }
            testInfo = "executing";
            updateStatus();
            log("<i>slave-execute</i> task <i>" + data.name + "</i>, " + data.stats.remainingTasks + " tasks left");
            createIframe(baseUrl + data.url, data.taskExecutionId);
        },
        slaveStop: stop,
        dispose: function () {
            if (config.onDispose) {
                config.onDispose();
            }
        }
    };

    var onSocketMessage = function (message) {
        var data = JSON.parse(message.data);
        var type = data.type;
        if (messages.hasOwnProperty(type)) {
            messages[type](data);
        }
    };

    var createConnection = function () {
        socketStatusUpdate('connecting');
        socket = new SockJS(location.protocol + '//' + location.host + '/sockjs');
        socket.onopen = onSocketOpen;
        socket.onclose = onSocketClose;
        socket.onmessage = onSocketMessage;
    };

    createConnection();

    pauseResume.onclick = function () {
        log("toggle pause status");
        paused = !paused;
        updateStatus();
        if (attesterPrototype.connected) {
            socket.send(JSON.stringify({
                type: 'pauseChanged',
                paused: paused
            }));
        }
        return false;
    };

    var checkTaskExecutionId = function (scope, name) {
        var res = currentTask && scope.__taskExecutionId === currentTask.taskExecutionId;
        if (!res) {
            var message = "ignoring call to attester." + name + " for a task that is not (or no longer) valid.";
            reportLogToServer("warn", [message]);
            log("<i>warning</i> " + message);
        }
        return res;
    };

    var sendTestUpdate = function (scope, name, info) {
        if (!checkTaskExecutionId(scope, name)) {
            return false;
        }
        if (!info) {
            info = {};
        }
        if (!info.time) {
            info.time = new Date().getTime();
        }
        info.event = name;
        log("sending test update <i class='event'>" + name + "</i> for test <i>" + info.name + "</i>");
        if (name === "testStarted") {
            if (pendingTestStarts.hasOwnProperty(info.testId)) {
                log("<i>warning</i> this <i>testStarted</i> is (wrongly) reusing a previous testId: <i>" + info.testId + "</i>");
            }
            pendingTestStarts[info.testId] = info;
        } else if (name === "testFinished") {
            var previousTestStart = pendingTestStarts[info.testId];
            if (!previousTestStart) {
                log("<i>warning</i> this <i>testFinished</i> is ignored as it has no previous <i>testStarted</i>");
                return false;
            }
            pendingTestStarts[info.testId] = false;
            info.duration = info.time - previousTestStart.time;
        }
        if (name === "error") {
            log("<i class='error'>error</i> message: <i>" + info.error.message + "</i>");
        }
        socket.send(JSON.stringify({
            type: 'testUpdate',
            event: info,
            taskExecutionId: currentTask.taskExecutionId
        }));
        return true;
    };

    attesterPrototype.testStart = function (info) {
        sendTestUpdate(this, 'testStarted', info);
    };
    attesterPrototype.testEnd = function (info) {
        sendTestUpdate(this, 'testFinished', info);
    };
    attesterPrototype.testError = function (info) {
        sendTestUpdate(this, 'error', info);
    };
    attesterPrototype.taskFinished = function () {
        var self = this;
        if (!checkTaskExecutionId(this, "taskFinished")) {
            return;
        }
        whenPendingXHRsFinished(function () {
            if (!checkTaskExecutionId(self, "taskFinished (callback)")) {
                return;
            }
            socket.send(JSON.stringify({
                type: 'taskFinished',
                taskExecutionId: currentTask.taskExecutionId
            }));
        });
    };
    attesterPrototype.stackTrace = function (exception) {
        // this function is re-defined in stacktrace.js
        return [];
    };

    var emptyFunction = function () {};
    var replaceConsoleFunction = function (console, name, scope) {
        var oldFunction = config.localConsole === false ? emptyFunction : console[name] || emptyFunction;
        console[name] = function () {
            var res;
            try {
                // IE < 9 compatible: http://stackoverflow.com/questions/5538972/console-log-apply-not-working-in-ie9#comment8444540_5539378
                res = Function.prototype.apply.call(oldFunction, this, arguments);
            } catch (e) {}
            var taskExecutionId = scope.__taskExecutionId;
            if (!currentTask || currentTask.taskExecutionId !== taskExecutionId) {
                taskExecutionId = -1;
            }
            reportLogToServer(name, arguments, taskExecutionId);
            return res;
        };
    };

    attesterPrototype.installConsole = function (window) {
        var console = window.console;
        if (!console) {
            console = window.console = {};
        }
        replaceConsoleFunction(console, "debug", this);
        replaceConsoleFunction(console, "log", this);
        replaceConsoleFunction(console, "info", this);
        replaceConsoleFunction(console, "warn", this);
        replaceConsoleFunction(console, "error", this);
    };

    var pendingXHRs = 0;
    var pendingXHRsCallbacks = [];
    var whenPendingXHRsFinished = function (callback) {
        if (pendingXHRs > 0) {
            pendingXHRsCallbacks.push(callback);
        } else {
            callback();
        }
    };
    var callPendingXHRsCallbacks = function () {
        while (pendingXHRsCallbacks.length > 0) {
            var callback = pendingXHRsCallbacks.shift();
            callback();
        }
    };

    // To send coverage, using a POST request rather than using sockjs is better for performance reasons
    var send = function (url, data) {
        pendingXHRs++;
        var xhr = (window.ActiveXObject) ? new window.ActiveXObject("Microsoft.XMLHTTP") : new window.XMLHttpRequest();
        xhr.open('POST', url);
        xhr.setRequestHeader('Content-Type', 'application/json');
        xhr.onreadystatechange = function () {
            if (xhr && xhr.readyState === 4) {
                xhr = null;
                pendingXHRs--;
                if (pendingXHRs === 0) {
                    callPendingXHRsCallbacks();
                }
            }
        };
        xhr.send(data);
    };

    attesterPrototype.coverage = function (window) {
        if (!checkTaskExecutionId(this, "coverage")) {
            return false;
        }
        var $$_l = window.$$_l;
        if ($$_l) {
            send('/__attester__/coverage/data/' + currentTask.campaignId + '/' + currentTask.taskId, JSON.stringify({
                name: "",
                run: $$_l.run,
                staticInfo: $$_l.staticInfo
            }));
        }
    };

    // Creating an empty iframe so that IE can replace its url without any harm
    // (when refreshing the page, IE tries to restore the previous URL of the iframe)
    createIframe(baseUrl + location.pathname.replace(/\/[^\/]+$/, "/empty.html"));
})();