CocoCAD/closure-library/closure/goog/labs/net/webchannel/webchannelbasetransport_test.js

// Copyright 2013 The Closure Library Authors. All Rights Reserved.
//
// 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.

/**
 * @fileoverview Unit tests for goog.labs.net.webChannel.WebChannelBase.
 * @suppress {accessControls} Private methods are accessed for test purposes.
 *
 */


goog.provide('goog.labs.net.webChannel.webChannelBaseTransportTest');

goog.require('goog.events');
goog.require('goog.functions');
goog.require('goog.json');
goog.require('goog.labs.net.webChannel.ChannelRequest');
goog.require('goog.labs.net.webChannel.WebChannelBase');
goog.require('goog.labs.net.webChannel.WebChannelBaseTransport');
goog.require('goog.net.WebChannel');
goog.require('goog.testing.PropertyReplacer');
goog.require('goog.testing.jsunit');


goog.setTestOnly('goog.labs.net.webChannel.webChannelBaseTransportTest');


var webChannel;
var channelUrl = 'http://127.0.0.1:8080/channel';

var stubs = new goog.testing.PropertyReplacer();


function shouldRunTests() {
  return goog.labs.net.webChannel.ChannelRequest.supportsXhrStreaming();
}


function setUp() {}


function tearDown() {
  goog.dispose(webChannel);
  stubs.reset();
}


/**
 * Stubs goog.labs.net.webChannel.ChannelRequest.
 */
function stubChannelRequest() {
  stubs.set(
      goog.labs.net.webChannel.ChannelRequest, 'supportsXhrStreaming',
      goog.functions.FALSE);
}


function testUnsupportedTransports() {
  stubChannelRequest();

  var err = assertThrows(function() {
    var webChannelTransport =
        new goog.labs.net.webChannel.WebChannelBaseTransport();
  });
  assertContains('error', err.message);
}

function testOpenWithUrl() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  webChannel = webChannelTransport.createWebChannel(channelUrl);

  var eventFired = false;
  goog.events.listen(
      webChannel, goog.net.WebChannel.EventType.OPEN,
      function(e) { eventFired = true; });

  webChannel.open();
  assertFalse(eventFired);

  var channel = webChannel.channel_;
  assertNotNull(channel);

  simulateOpenEvent(channel);
  assertTrue(eventFired);
}

function testOpenWithTestUrl() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  var options = {'testUrl': channelUrl + '/footest'};
  webChannel = webChannelTransport.createWebChannel(channelUrl, options);
  webChannel.open();

  var testPath = webChannel.channel_.connectionTest_.path_;
  assertNotNullNorUndefined(testPath);
}

function testOpenWithCustomHeaders() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  var options = {'messageHeaders': {'foo-key': 'foo-value'}};
  webChannel = webChannelTransport.createWebChannel(channelUrl, options);
  webChannel.open();

  var extraHeaders_ = webChannel.channel_.extraHeaders_;
  assertNotNullNorUndefined(extraHeaders_);
  assertEquals('foo-value', extraHeaders_['foo-key']);
  assertEquals(undefined, extraHeaders_['X-Client-Protocol']);
}

function testOpenWithInitHeaders() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  var options = {'initMessageHeaders': {'foo-key': 'foo-value'}};
  webChannel = webChannelTransport.createWebChannel(channelUrl, options);
  webChannel.open();

  var initHeaders_ = webChannel.channel_.initHeaders_;
  assertNotNullNorUndefined(initHeaders_);
  assertEquals('foo-value', initHeaders_['foo-key']);
}

function testClientProtocolHeaderRequired() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  var options = {'clientProtocolHeaderRequired': true};
  webChannel = webChannelTransport.createWebChannel(channelUrl, options);
  webChannel.open();

  var extraHeaders_ = webChannel.channel_.extraHeaders_;
  assertNotNullNorUndefined(extraHeaders_);
  assertEquals('webchannel', extraHeaders_['X-Client-Protocol']);
}

function testClientProtocolHeaderNotRequiredByDefault() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  webChannel = webChannelTransport.createWebChannel(channelUrl);
  webChannel.open();

  var extraHeaders_ = webChannel.channel_.extraHeaders_;
  assertNull(extraHeaders_);
}

function testClientProtocolHeaderRequiredWithCustomHeader() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  var options = {
    'clientProtocolHeaderRequired': true,
    'messageHeaders': {'foo-key': 'foo-value'}
  };
  webChannel = webChannelTransport.createWebChannel(channelUrl, options);
  webChannel.open();

  var extraHeaders_ = webChannel.channel_.extraHeaders_;
  assertNotNullNorUndefined(extraHeaders_);
  assertEquals('foo-value', extraHeaders_['foo-key']);
  assertEquals('webchannel', extraHeaders_['X-Client-Protocol']);
}

function testOpenWithCustomParams() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  var options = {'messageUrlParams': {'foo-key': 'foo-value'}};
  webChannel = webChannelTransport.createWebChannel(channelUrl, options);
  webChannel.open();

  var extraParams = webChannel.channel_.extraParams_;
  assertNotNullNorUndefined(extraParams);
}

function testOpenWithHttpSessionIdParam() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  var options = {'httpSessionIdParam': 'xsessionid'};
  webChannel = webChannelTransport.createWebChannel(channelUrl, options);
  webChannel.open();

  var httpSessionIdParam = webChannel.channel_.getHttpSessionIdParam();
  assertEquals('xsessionid', httpSessionIdParam);
}

function testOpenWithDuplicatedHttpSessionIdParam() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  var options = {
    'messageUrlParams': {'xsessionid': 'abcd1234'},
    'httpSessionIdParam': 'xsessionid'
  };
  webChannel = webChannelTransport.createWebChannel(channelUrl, options);
  webChannel.open();

  var httpSessionIdParam = webChannel.channel_.getHttpSessionIdParam();
  assertEquals('xsessionid', httpSessionIdParam);

  var extraParams = webChannel.channel_.extraParams_;
  assertUndefined(extraParams['xsessionid']);
}

function testOpenWithCorsEnabled() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  var options = {'supportsCrossDomainXhr': true};
  webChannel = webChannelTransport.createWebChannel(channelUrl, options);
  webChannel.open();

  assertTrue(webChannel.channel_.supportsCrossDomainXhrs_);
}

function testSendRawJson() {
  var channelMsg;
  stubs.set(
      goog.labs.net.webChannel.WebChannelBase.prototype, 'sendMap',
      function(message) { channelMsg = message; });

  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  var options = {'sendRawJson': true};
  webChannel = webChannelTransport.createWebChannel(channelUrl, options);
  webChannel.open();

  webChannel.send({foo: 'bar'});

  var receivedMsg = goog.json.parse(channelMsg['__data__']);
  assertEquals('bar', receivedMsg.foo);
}

function testOpenThenCloseChannel() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  webChannel = webChannelTransport.createWebChannel(channelUrl);

  var eventFired = false;
  goog.events.listen(
      webChannel, goog.net.WebChannel.EventType.CLOSE,
      function(e) { eventFired = true; });

  webChannel.open();
  assertFalse(eventFired);

  var channel = webChannel.channel_;
  assertNotNull(channel);

  simulateCloseEvent(channel);
  assertTrue(eventFired);
}


function testChannelError() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  webChannel = webChannelTransport.createWebChannel(channelUrl);

  var eventFired = false;
  goog.events.listen(
      webChannel, goog.net.WebChannel.EventType.ERROR, function(e) {
        eventFired = true;
        assertEquals(goog.net.WebChannel.ErrorStatus.NETWORK_ERROR, e.status);
      });

  webChannel.open();
  assertFalse(eventFired);

  var channel = webChannel.channel_;
  assertNotNull(channel);

  simulateErrorEvent(channel);
  assertTrue(eventFired);
}


function testChannelMessage() {
  var webChannelTransport =
      new goog.labs.net.webChannel.WebChannelBaseTransport();
  webChannel = webChannelTransport.createWebChannel(channelUrl);

  var eventFired = false;
  var data = 'foo';
  goog.events.listen(
      webChannel, goog.net.WebChannel.EventType.MESSAGE, function(e) {
        eventFired = true;
        assertEquals(e.data, data);
      });

  webChannel.open();
  assertFalse(eventFired);

  var channel = webChannel.channel_;
  assertNotNull(channel);

  simulateMessageEvent(channel, data);
  assertTrue(eventFired);
}


/**
 * Simulates the WebChannelBase firing the open event for the given channel.
 * @param {!goog.labs.net.webChannel.WebChannelBase} channel The WebChannelBase.
 */
function simulateOpenEvent(channel) {
  assertNotNull(channel.getHandler());
  channel.getHandler().channelOpened();
}


/**
 * Simulates the WebChannelBase firing the close event for the given channel.
 * @param {!goog.labs.net.webChannel.WebChannelBase} channel The WebChannelBase.
 */
function simulateCloseEvent(channel) {
  assertNotNull(channel.getHandler());
  channel.getHandler().channelClosed();
}


/**
 * Simulates the WebChannelBase firing the error event for the given channel.
 * @param {!goog.labs.net.webChannel.WebChannelBase} channel The WebChannelBase.
 */
function simulateErrorEvent(channel) {
  assertNotNull(channel.getHandler());
  channel.getHandler().channelError();
}


/**
 * Simulates the WebChannelBase firing the message event for the given channel.
 * @param {!goog.labs.net.webChannel.WebChannelBase} channel The WebChannelBase.
 * @param {String} data The message data.
 */
function simulateMessageEvent(channel, data) {
  assertNotNull(channel.getHandler());
  channel.getHandler().channelHandleArray(channel, data);
}