Skip to content

C
coopwire-hypothesis
Unverified Commit b42e5324 authored by Sean Hammond's avatar Sean Hammond Committed by GitHub
Browse files
Options

Merge pull request #806 from hypothesis/convert-discovery-tests-to-js 

Convert shared/discovery tests to JS
parents 37928f53 8cbbbb7b
Hide whitespace changes
Inline Side-by-side
Showing with 222 additions and 203 deletions
src/shared/test/discovery-test.coffee deleted 100644 → 0
View file @ 37928f53
{module, inject} = angular.mock
describe 'Discovery', ->
sandbox = sinon.sandbox.create()
fakeTopWindow = null
fakeFrameWindow = null
createDiscovery = null
before ->
angular.module('h', [])
.value('Discovery', require('../discovery'))
beforeEach module('h')
beforeEach inject (Discovery) ->
createDiscovery = (win, options) ->
new Discovery(win, options)
createWindow = ->
top: null
addEventListener: sandbox.stub()
removeEventListener: sandbox.stub()
postMessage: sandbox.stub()
length: 0
frames: []
fakeTopWindow = createWindow()
fakeTopWindow.top = fakeTopWindow
fakeFrameWindow = createWindow()
fakeFrameWindow.top = fakeTopWindow
fakeTopWindow.frames = [fakeFrameWindow]
afterEach ->
sandbox.restore()
describe 'startDiscovery', ->
it 'adds a "message" listener to the window object', ->
discovery = createDiscovery(fakeTopWindow)
discovery.startDiscovery(->)
assert.called(fakeTopWindow.addEventListener)
assert.calledWith(fakeTopWindow.addEventListener, 'message', sinon.match.func, false)
describe 'when acting as a server (options.server = true)', ->
server = null
beforeEach ->
server = createDiscovery(fakeFrameWindow, server: true)
it 'sends out a "offer" message to every frame', ->
server.startDiscovery(->)
assert.called(fakeTopWindow.postMessage)
assert.calledWith(fakeTopWindow.postMessage, '__cross_frame_dhcp_offer', '*')
it 'allows the origin to be provided', ->
server = createDiscovery(fakeFrameWindow, server: true, origin: 'foo')
server.startDiscovery(->)
assert.called(fakeTopWindow.postMessage)
assert.calledWith(fakeTopWindow.postMessage, '__cross_frame_dhcp_offer', 'foo')
it 'does not send the message to itself', ->
server.startDiscovery(->)
assert.notCalled(fakeFrameWindow.postMessage)
it 'sends an "ack" on receiving a "request"', ->
fakeFrameWindow.addEventListener.yields({
data: '__cross_frame_dhcp_request'
source: fakeTopWindow
origin: 'top'
})
server.startDiscovery(->)
assert.called(fakeTopWindow.postMessage)
matcher = sinon.match(/__cross_frame_dhcp_ack:\d+/)
assert.calledWith(fakeTopWindow.postMessage, matcher, 'top')
it 'sends an "ack" to the wildcard origin if a request comes from a frame with null origin', ->
fakeFrameWindow.addEventListener.yields({
data: '__cross_frame_dhcp_request'
source: fakeTopWindow
origin: 'null'
})
server.startDiscovery(->)
assert.called(fakeTopWindow.postMessage)
matcher = sinon.match(/__cross_frame_dhcp_ack:\d+/)
assert.calledWith(fakeTopWindow.postMessage, matcher, '*')
it 'calls the discovery callback on receiving "request"', ->
fakeFrameWindow.addEventListener.yields({
data: '__cross_frame_dhcp_request'
source: fakeTopWindow
origin: 'top'
})
handler = sandbox.stub()
server.startDiscovery(handler)
assert.called(handler)
assert.calledWith(handler, fakeTopWindow, 'top', sinon.match(/\d+/))
it 'raises an error if it recieves an event from another server', ->
fakeFrameWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer'
source: fakeTopWindow
origin: 'top'
})
handler = sandbox.stub()
assert.throws ->
server.startDiscovery(handler)
describe 'when acting as a client (options.client = false)', ->
client = null
beforeEach ->
client = createDiscovery(fakeTopWindow)
it 'sends out a discovery message to every frame', ->
client.startDiscovery(->)
assert.called(fakeFrameWindow.postMessage)
assert.calledWith(fakeFrameWindow.postMessage, '__cross_frame_dhcp_discovery', '*')
it 'does not send the message to itself', ->
client.startDiscovery(->)
assert.notCalled(fakeTopWindow.postMessage)
it 'sends a "request" in response to an "offer"', ->
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer'
source: fakeFrameWindow
origin: 'iframe'
})
client.startDiscovery(->)
assert.called(fakeFrameWindow.postMessage)
assert.calledWith(fakeFrameWindow.postMessage, '__cross_frame_dhcp_request', 'iframe')
it 'does not respond to an "offer" if a "request" is already in progress', ->
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer'
source: fakeFrameWindow
origin: 'iframe1'
})
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer'
source: fakeFrameWindow
origin: 'iframe2'
})
client.startDiscovery(->)
# Twice, once for discovery, once for offer.
assert.calledTwice(fakeFrameWindow.postMessage)
lastCall = fakeFrameWindow.postMessage.lastCall
assert(lastCall.notCalledWith(sinon.match.string, 'iframe2'))
it 'allows responding to a "request" once a previous "request" has completed', ->
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer'
source: fakeFrameWindow
origin: 'iframe1'
})
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_ack:1234'
source: fakeFrameWindow
origin: 'iframe1'
})
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer'
source: fakeFrameWindow
origin: 'iframe2'
})
client.startDiscovery(->)
assert.called(fakeFrameWindow.postMessage)
assert.calledWith(fakeFrameWindow.postMessage, '__cross_frame_dhcp_request', 'iframe2')
it 'calls the discovery callback on receiving an "ack"', ->
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_ack:1234'
source: fakeFrameWindow
origin: 'iframe'
})
callback = sandbox.stub()
client.startDiscovery(callback)
assert.called(callback)
assert.calledWith(callback, fakeFrameWindow, 'iframe', '1234')
describe 'stopDiscovery', ->
it 'removes the "message" listener from the window', ->
discovery = createDiscovery(fakeFrameWindow)
discovery.startDiscovery()
discovery.stopDiscovery()
handler = fakeFrameWindow.addEventListener.lastCall.args[1]
assert.called(fakeFrameWindow.removeEventListener)
assert.calledWith(fakeFrameWindow.removeEventListener, 'message', handler)
it 'allows startDiscovery to be called with a new handler', ->
discovery = createDiscovery(fakeFrameWindow)
discovery.startDiscovery()
discovery.stopDiscovery()
assert.doesNotThrow ->
discovery.startDiscovery()
src/shared/test/discovery-test.js 0 → 100644
View file @ b42e5324
'use strict';
const Discovery = require('../discovery');
function createWindow() {
return {
top: null,
addEventListener: sinon.stub(),
removeEventListener: sinon.stub(),
postMessage: sinon.stub(),
length: 0,
frames: [],
};
}
describe('shared/discovery', () => {
let fakeFrameWindow;
let fakeTopWindow;
beforeEach(() => {
fakeTopWindow = createWindow();
fakeTopWindow.top = fakeTopWindow;
fakeFrameWindow = createWindow();
fakeFrameWindow.top = fakeTopWindow;
fakeTopWindow.frames = [fakeFrameWindow];
});
describe('#startDiscovery', () => {
it('adds a "message" listener to the window object', () => {
const discovery = new Discovery(fakeTopWindow);
discovery.startDiscovery(sinon.stub());
assert.calledWith(fakeTopWindow.addEventListener, 'message', sinon.match.func, false);
});
});
context('when acting as a server', () => {
let server;
beforeEach(() => {
server = new Discovery(fakeFrameWindow, { server: true });
});
it('sends "offer" messages to every frame in the current tab', () => {
server.startDiscovery(sinon.stub());
assert.calledWith(fakeTopWindow.postMessage, '__cross_frame_dhcp_offer', '*');
});
it('allows the origin to be provided', () => {
server = new Discovery(fakeFrameWindow, { server: true, origin: 'https://example.com' });
server.startDiscovery(sinon.stub());
assert.calledWith(
fakeTopWindow.postMessage,
'__cross_frame_dhcp_offer',
'https://example.com'
);
});
it('does not send "offer" messages to itself', () => {
server.startDiscovery(sinon.stub());
assert.notCalled(fakeFrameWindow.postMessage);
});
it('sends an "ack" when it receives a "request" message', () => {
fakeFrameWindow.addEventListener.yields({
data: '__cross_frame_dhcp_request',
source: fakeTopWindow,
origin: 'https://top.com',
});
server.startDiscovery(sinon.stub());
assert.calledWith(
fakeTopWindow.postMessage,
sinon.match(/__cross_frame_dhcp_ack:\d+/),
'https://top.com'
);
});
it('calls the `onDiscovery` callback on receiving a request', () => {
fakeFrameWindow.addEventListener.yields({
data: '__cross_frame_dhcp_request',
source: fakeTopWindow,
origin: 'https://top.com',
});
const onDiscovery = sinon.stub();
server.startDiscovery(onDiscovery);
assert.calledWith(onDiscovery, fakeTopWindow, 'https://top.com', sinon.match(/\d+/));
});
it('raises an error if it receives an event from another server', () => {
fakeFrameWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer',
source: fakeTopWindow,
origin: 'https://top.com',
});
const onDiscovery = sinon.stub();
assert.throws(() => {
server.startDiscovery(onDiscovery);
});
});
});
context('when acting as a client', () => {
let client;
beforeEach(() => {
client = new Discovery(fakeTopWindow);
});
it('sends out a discovery message to every frame', () => {
client.startDiscovery(sinon.stub());
assert.calledWith(fakeFrameWindow.postMessage, '__cross_frame_dhcp_discovery', '*');
});
it('does not send the message to itself', () => {
client.startDiscovery(sinon.stub());
assert.notCalled(fakeTopWindow.postMessage);
});
it('sends a "request" message in response to an "offer" message', () => {
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer',
source: fakeFrameWindow,
origin: 'https://iframe.com',
});
client.startDiscovery(sinon.stub());
assert.calledWith(
fakeFrameWindow.postMessage,
'__cross_frame_dhcp_request',
'https://iframe.com'
);
});
it('does not respond to an "offer" if a "request" is already in progress', () => {
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer',
source: fakeFrameWindow,
origin: 'https://iframe1.com',
});
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer',
source: fakeFrameWindow,
origin: 'https://iframe2.com',
});
client.startDiscovery(sinon.stub());
// `postMessage` should be called first for discovery, then for offer.
assert.calledTwice(fakeFrameWindow.postMessage);
const lastCall = fakeFrameWindow.postMessage.lastCall;
assert.isTrue(lastCall.notCalledWith(sinon.match.string, 'https://iframe2.com'));
});
it('does respond to an "offer" if a previous "request" has completed', () => {
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer',
source: fakeFrameWindow,
origin: 'https://iframe1.com',
});
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_ack:1234',
source: fakeFrameWindow,
origin: 'https://iframe1.com',
});
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_offer',
source: fakeFrameWindow,
origin: 'https://iframe2.com',
});
client.startDiscovery(sinon.stub());
assert.calledWith(
fakeFrameWindow.postMessage,
'__cross_frame_dhcp_request',
'https://iframe2.com'
);
});
it('calls the `onDiscovery` callback on receiving an "ack"', () => {
fakeTopWindow.addEventListener.yields({
data: '__cross_frame_dhcp_ack:1234',
source: fakeFrameWindow,
origin: 'https://iframe.com',
});
const onDiscovery = sinon.stub();
client.startDiscovery(onDiscovery);
assert.calledWith(onDiscovery, fakeFrameWindow, 'https://iframe.com', '1234');
});
});
describe('#stopDiscovery', () => {
it('removes the "message" listener from the window', () => {
const discovery = new Discovery(fakeFrameWindow);
discovery.startDiscovery(sinon.stub());
discovery.stopDiscovery();
const handler = fakeFrameWindow.addEventListener.lastCall.args[1];
assert.calledWith(fakeFrameWindow.removeEventListener, 'message', handler);
});
it('allows `startDiscovery` to be called with a new handler', () => {
const discovery = new Discovery(fakeFrameWindow);
discovery.startDiscovery();
discovery.stopDiscovery();
assert.doesNotThrow(() => {
discovery.startDiscovery();
});
});
});
});
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment