appengine-channel-api-stub

Google App Engine Channel API Stub

A simple stub for unit testing with the Google App Engine Channel API javascript client. Includes a convenient way to access Socket objects outside of their declared scope for triggering handlers.

Installation

NPM: npm install appengine-channel-api-stub

Bower:
bower install --save-dev appengine-channel-api-stub

Or manually download the latest release.

Use

CommonJS

require('appengine-channel-api-stub');
// goog.appengine.Channel and goog.appengine.Socket will now be set

Script

Include the dist/channel-api-stub[.min].js file with your testing framework files. Any references to the Channel API client classes and methods will now be valid.

API

In addition to all of the implemented API classes and methods, a special method has been added which allows the fetching of any Socket object from anywhere, allowing a socket to be accessed and triggered from outside it's declared scope such as in unit test functions where it may not have been otherwise accessible.

goog.appengine.Socket._get(token)

Returns the socket object opened from anywhere using the specified token.

// example usage

function openChannel() {
	// channel and socket are contained within the function scope and not accessible outside
	var channel = new goog.appengine.Channel('token');
	var socket = channel.open();
    socket.onmessage = function(message) {
		console.log(message);
	};  
}

// open the channel
openChannel();

// get the socket and trigger it's onmessage handler
var socket = goog.appengine.Socket._get('token');
socket.onmessage('test'); // console.log('test')

Contribute

Pull requests more than welcome. Just remember to add tests for any new functionality and make sure all existing tests still pass!

Alternatively, report a bug or feature request using the issue tracker.

Building Guide

Fork the project and then in your terminal run the following commands:

$ git clone https://github.com/[username]/appengine-channel-api-stub.git
$ cd appengine-channel-api-stub
$ npm install

This will download the project and all gulp dependencies. Whilst developing, run the gulp command from the project directory which will automatically run tests as you develop. Then once finished run gulp build to run tests once more and generate a build in the ./dist directory. Commit and push your changes and then submit a pull request.

Full Example

The general principal is to create/intercept the request for the Channel token, and then use the special goog.appengine.Socket._get(token) method to access the created socket and manually call the socket handler methods, passing in different messages for your test cases.

This simple example uses Jasmine testing framework but can be easily adapted for most other frameworks.

// channel.js

function openChannel() {
        	
  fetch('/openchannel').then(function(data) {
    
    // assume already converted to JSON
    var token = data.token;
    
    var channel = new goog.appengine.Channel(token);
    var socket = channel.open();
    
    socket.onmessage = function(message) {
      processMessage(message);
    };
      
  });
  
};

function processMessage(message) {
  // do something with the message
}

module.exports = {
  openChannel: openChannel,
  processMessage: processMessage
};

// test.spec.js

var channel = require('channel');

describe('ChannelApi Test', function() {

  beforeEach(function() {
    jasmine.Ajax.install();
  });
  
  afterEach(function() {
    jasmine.Ajax.uninstall();
  });
    
  describe('when opening a channel', function() {
    
    var response;
    
    beforeEach(function() {
    
      spyOn(channel, 'processMessage');
    
      // set the channel token and mock the request for it
      // we can then use this token in our tests to gain access to the socket
      // created for the channel and trigger it's handlers
      response = {
        token: 'test-token';
      };            
      jasmine.Ajax.stubRequest('/openchannel').andReturn({
        "responseText": response
      });
        
    });
    
    it ('should process the message', function() {
      
      channel.openChannel();
      
      // use goog.appengine.Socket._get() to access the socket within the controller
      var socket = goog.appengine.Socket._get(response.token);
      
      // trigger an onmessage handler on the socket
      socket.onmessage('test message');
      
      // check that the onmessage handler inside the controller was called and worked as expected
      expect(channel.processMessage).toHaveBeenCalledWith('test message');
        
    });
      
  });
    
});