Merge pull request #146 from uProxy/iislucas-separate-signal

iislucas · iislucas · commit 01c261b0ecb1 · 2015-04-10T13:30:07.000-04:00
Separate signal types from peerconnection
diff --git a/Gruntfile.coffee b/Gruntfile.coffee
@@ -46,7 +46,7 @@ taskManager.add 'copypasteFreedomChat', [
 ]
 
 # Create unit test code
-taskManager.add 'browserify_specs', [
+taskManager.add 'browserifySpecs', [
   'base'
   'browserify:arraybuffersSpec'
   'browserify:handlerSpec'
@@ -58,9 +58,22 @@ taskManager.add 'browserify_specs', [
   'browserify:queueSpec'
 ]
 
+# Create unit test code
+taskManager.add 'browserifyCovSpecs', [
+  'base'
+  'browserify:arraybuffersCovSpec'
+  'browserify:handlerCovSpec'
+  'browserify:buildToolsTaskmanagerCovSpec'
+  'browserify:loggingCovSpec'
+  'browserify:loggingProviderCovSpec'
+  'browserify:peerconnectionCovSpec'
+  'browserify:datachannelCovSpec'
+  'browserify:queueCovSpec'
+]
+
 # Run unit tests
 taskManager.add 'unit_test', [
-  'browserify_specs',
+  'browserifySpecs',
   'jasmine:arraybuffers'
   'jasmine:handler'
   'jasmine:buildTools'
@@ -73,7 +86,7 @@ taskManager.add 'unit_test', [
 # Run unit tests to produce coverage; these are separate from unit_tests because
 # they make tests hard to debug and fix.
 taskManager.add 'coverage', [
-  'browserify_specs'
+  'browserifyCovSpecs'
   'jasmine:arraybuffersCov'
   'jasmine:handlerCov'
   'jasmine:buildToolsCov'
@@ -212,13 +225,21 @@ module.exports = (grunt) ->
       loggingProvider: Rule.browserify 'loggingprovider/freedom-module'
       # Browserify specs
       arraybuffersSpec: Rule.browserifySpec 'arraybuffers/arraybuffers'
+      arraybuffersCovSpec: Rule.addCoverageToBrowserify(Rule.browserifySpec 'arraybuffers/arraybuffers')
       buildToolsTaskmanagerSpec: Rule.browserifySpec 'build-tools/taskmanager'
+      buildToolsTaskmanagerCovSpec: Rule.addCoverageToBrowserify(Rule.browserifySpec 'build-tools/taskmanager')
       handlerSpec: Rule.browserifySpec 'handler/queue'
+      handlerCovSpec: Rule.addCoverageToBrowserify(Rule.browserifySpec 'handler/queue')
       loggingProviderSpec: Rule.browserifySpec 'loggingprovider/loggingprovider'
+      loggingProviderCovSpec: Rule.addCoverageToBrowserify(Rule.browserifySpec 'loggingprovider/loggingprovider')
       loggingSpec: Rule.browserifySpec 'logging/logging'
+      loggingCovSpec: Rule.addCoverageToBrowserify(Rule.browserifySpec 'logging/logging')
       peerconnectionSpec: Rule.browserifySpec 'webrtc/peerconnection'
+      peerconnectionCovSpec: Rule.addCoverageToBrowserify(Rule.browserifySpec 'webrtc/peerconnection')
       datachannelSpec: Rule.browserifySpec 'webrtc/datachannel'
+      datachannelCovSpec: Rule.addCoverageToBrowserify(Rule.browserifySpec 'webrtc/datachannel')
       queueSpec: Rule.browserifySpec 'queue/queue'
+      queueCovSpec: Rule.addCoverageToBrowserify(Rule.browserifySpec 'queue/queue')
       # Browserify sample apps main freedom module and core environments
       copypasteFreedomChatFreedomModule: Rule.browserify 'samples/copypaste-freedom-chat/freedom-module'
       copypasteFreedomChatMain: Rule.browserify 'samples/copypaste-freedom-chat/main.core-env'
diff --git a/src/build-tools/common-grunt-rules.ts b/src/build-tools/common-grunt-rules.ts
@@ -39,6 +39,7 @@ export interface BrowserifyRule {
   src :string[];
   dest :string;
   options ?:{
+    transform ?:Object[][];
     debug ?:boolean;
   };
 }
@@ -59,6 +60,7 @@ export interface CopyRule {
 export class Rule {
   constructor(public config :RuleConfig) {}
 
+  // Note: argument is modified (and returned for conveniece);
   public addCoverageToSpec(spec:JasmineRule) :JasmineRule {
     var basePath = path.dirname(spec.options.outfile);
 
@@ -96,18 +98,26 @@ export class Rule {
   // Grunt browserify target creator
   public browserify(filepath:string, options = {
         browserifyOptions: { standalone: 'browserified_exports' }
-      }) : BrowserifyRule {
+      }) :BrowserifyRule {
     return {
       src: [ path.join(this.config.devBuildPath, filepath + '.js') ],
       dest: path.join(this.config.devBuildPath, filepath + '.static.js'),
       options: options
     };
   }
 
+  // Note: argument is modified (and returned for conveniece);
+  public addCoverageToBrowserify(rule:BrowserifyRule) :BrowserifyRule {
+    if(!rule.options.transform) {
+      rule.options.transform = [];
+    }
+    rule.options.transform.push(
+      ['browserify-istanbul', { ignore: ['**/mocks/**', '**/*.spec.js'] }]);
+    return rule
+  }
+
   // Grunt browserify target creator, instrumented for istanbul
   public browserifySpec(filepath:string, options = {
-        transform: [['browserify-istanbul',
-                    { ignore: ['**/mocks/**', '**/*.spec.js'] }]],
         browserifyOptions: { standalone: 'browserified_exports' }
       }) : BrowserifyRule {
     return {
diff --git a/src/samples/copypaste-freedom-chat/freedom-module.ts b/src/samples/copypaste-freedom-chat/freedom-module.ts
@@ -3,9 +3,9 @@
 
 import logging = require('../../logging/logging');
 
+import signals = require('../../webrtc/signals');
 import peerconnection = require('../../webrtc/peerconnection');
 import PeerConnection = peerconnection.PeerConnection;
-import SignallingMessage = peerconnection.SignallingMessage;
 import DataChannel = peerconnection.DataChannel;
 import Data = peerconnection.Data;
 
@@ -35,12 +35,12 @@ export function connectDataChannel(d:DataChannel) {
   });
 }
 
-export function makePeerConnection() : PeerConnection<SignallingMessage> {
-  var pc :PeerConnection<SignallingMessage> =
+export function makePeerConnection() : PeerConnection<signals.Message> {
+  var pc :PeerConnection<signals.Message> =
       peerconnection.createPeerConnection(pcConfig);
 
-  pc.signalForPeerQueue.setSyncHandler((signal:SignallingMessage) => {
-    parentModule.emit('signalForPeer', signal);
+  pc.signalForPeerQueue.setSyncHandler((message:signals.Message) => {
+    parentModule.emit('signalForPeer', message);
   });
 
   pc.onceConnected.then(() => {
@@ -62,7 +62,7 @@ export function makePeerConnection() : PeerConnection<SignallingMessage> {
   return pc;
 }
 
-export var pc :PeerConnection<SignallingMessage>;
+export var pc :PeerConnection<signals.Message>;
 
 parentModule.on('start', () => {
   pc = makePeerConnection();
@@ -82,9 +82,9 @@ parentModule.on('start', () => {
 // Receive signalling channel messages from the UI.
 // If pc doesn't exist yet then we are responding to the remote
 // peer's initiation.
-parentModule.on('signalFromPeer', (signal:SignallingMessage) => {
+parentModule.on('signalFromPeer', (message:signals.Message) => {
   if (pc === undefined) {
     pc = makePeerConnection();
   }
-  pc.handleSignalMessage(signal);
+  pc.handleSignalMessage(message);
 });
diff --git a/src/samples/simple-freedom-chat/freedom-module.ts b/src/samples/simple-freedom-chat/freedom-module.ts
@@ -3,9 +3,9 @@
 
 import logging = require('../../logging/logging');
 
+import signals = require('../../webrtc/signals');
 import peerconnection = require('../../webrtc/peerconnection');
 import PeerConnection = peerconnection.PeerConnection;
-import SignallingMessage = peerconnection.SignallingMessage;
 import DataChannel = peerconnection.DataChannel;
 import Data = peerconnection.Data;
 
@@ -30,7 +30,7 @@ function connectDataChannel(name:string, d:DataChannel) {
           d.toString());
     });
     d.dataFromPeerQueue.setSyncHandler((data:Data) => {
-      log.info(name + ': dataFromPeer: ' + JSON.stringify(data));
+      log.info('%1: dataFromPeer: %2', name, data);
       // Handle messages received on the datachannel(s).
       parentFreedomModule.emit('receive' + name, {
         message: data.str
@@ -49,7 +49,7 @@ function makePeerConnection(name:string) {
       urls: ['stun:stun.l.google.com:19302']},
       {urls: ['stun:stun1.l.google.com:19302']}]
   };
-  var pc :PeerConnection<SignallingMessage> =
+  var pc :PeerConnection<signals.Message> =
     peerconnection.createPeerConnection(pcConfig, name);
   pc.onceConnecting.then(() => { log.info(name + ': connecting...'); });
   pc.onceConnected.then(() => {
@@ -68,18 +68,18 @@ function makePeerConnection(name:string) {
   return pc;
 }
 
-var a :PeerConnection<SignallingMessage> = makePeerConnection('A');
-var b :PeerConnection<SignallingMessage> = makePeerConnection('B')
+var a :PeerConnection<signals.Message> = makePeerConnection('A');
+var b :PeerConnection<signals.Message> = makePeerConnection('B')
 
 // Connect the two signalling channels. Normally, these messages would be sent
 // over the internet.
-a.signalForPeerQueue.setSyncHandler((signal:SignallingMessage) => {
-  log.info('a: sending signal to b.');
-  b.handleSignalMessage(signal);
+a.signalForPeerQueue.setSyncHandler((message:signals.Message) => {
+  log.info('a: sending signalling message to b.');
+  b.handleSignalMessage(message);
 });
-b.signalForPeerQueue.setSyncHandler((signal:SignallingMessage) => {
-  log.info('b: sending signal to a.');
-  a.handleSignalMessage(signal);
+b.signalForPeerQueue.setSyncHandler((message:signals.Message) => {
+  log.info('b: sending signalling message to a.');
+  a.handleSignalMessage(message);
 });
 
 // Negotiate a peerconnection. Once negotiated, enable the UI and add
diff --git a/src/webrtc/datachannel.ts b/src/webrtc/datachannel.ts
@@ -184,7 +184,7 @@ export class DataChannelClass implements DataChannel {
     } else if (message.buffer instanceof ArrayBuffer) {
       this.dataFromPeerQueue.handle({buffer: message.buffer});
     } else {
-      log.error('Unexpected data from peer: ' + JSON.stringify(message));
+      log.error('Unexpected data from peer: %1', message);
     }
   }
 
diff --git a/src/webrtc/peerconnection.spec.ts b/src/webrtc/peerconnection.spec.ts
@@ -14,8 +14,8 @@ freedom = freedomMocker.makeMockFreedomInModuleEnv({
   'rtcdatachannel': () => { return new MockFreedomRtcDataChannel(); }
 });
 
-import PeerConnection = require('./peerconnection');
-import PeerConnectionClass = PeerConnection.PeerConnectionClass;
+import signals = require('./signals');
+import peerconnection = require('./peerconnection');
 
 describe('PeerConnection', function() {
   var mockRtcPeerConnection :MockFreedomRtcPeerConnection;
@@ -56,12 +56,13 @@ describe('PeerConnection', function() {
     var setLocalDescriptionSpy =
       spyOn(mockRtcPeerConnection, 'setLocalDescription');
 
-    var pc = new PeerConnectionClass(mockRtcPeerConnection, 'test');
+    var pc = new peerconnection.PeerConnectionClass(
+        mockRtcPeerConnection, 'test');
     pc.negotiateConnection();
 
     pc.signalForPeerQueue.setSyncNextHandler(
-        (signal:PeerConnection.SignallingMessage) => {
-      expect(signal.type).toEqual(PeerConnection.SignalType.OFFER);
+        (message:signals.Message) => {
+      expect(message.type).toEqual(signals.Type.OFFER);
       expect(mockRtcPeerConnection.setLocalDescription).not.toHaveBeenCalled();
       done();
     });
diff --git a/src/webrtc/peerconnection.ts b/src/webrtc/peerconnection.ts
diff --git a/src/webrtc/signals.ts b/src/webrtc/signals.ts

Original file line number	Diff line number	Diff line change
`@@ -184,7 +184,7 @@ export class DataChannelClass implements DataChannel {`
`184`	`184`	`} else if (message.buffer instanceof ArrayBuffer) {`
`185`	`185`	`this.dataFromPeerQueue.handle({buffer: message.buffer});`
`186`	`186`	`} else {`
`187`		`- log.error('Unexpected data from peer: ' + JSON.stringify(message));`
	`187`	`+ log.error('Unexpected data from peer: %1', message);`
`188`	`188`	`}`
`189`	`189`	`}`
`190`	`190`