Inaugural Hacks.js - Replace Firefox turn candidates in Ack SDP

Gruntfile.js

@@ -26,6 +26,7 @@ module.exports = function(grunt) {
     'src/WebRTC.js',
     'src/UA.js',
     'src/Utils.js',
+    'src/Hacks.js',
     'src/SanityCheck.js',
     'src/DigestAuthentication.js',
     'src/tail.js'

src/Hacks.js

@@ -0,0 +1,35 @@
+/**
+ * @fileoverview Hacks - This file contains all of the things we
+ * wish we didn't have to do, just for interop.  It is similar to
+ * Utils, which provides actually useful and relevant functions for
+ * a SIP library. Methods in this file are grouped by vendor, so
+ * as to most easily track when particular hacks may not be necessary anymore.
+ */
+
+(function (SIP) {
+
+var Hacks;
+
+Hacks = {
+
+  Firefox: {
+    /* Condition to detect if hacks are applicable */
+    isFirefox: function () {
+      return window.mozRTCPeerConnection !== undefined;
+    },
+    cannotHandleRelayCandidates: function (message) {
+      if (this.isFirefox() && message.body) {
+        message.body = message.body.replace(/relay/g, 'host generation 0');
+      }
+    },
+    cannotHandleExtraWhitespace: function (message) {
+      if (this.isFirefox() && message.body) {
+        message.body = message.body.replace(/ \r\n/g, "\r\n");
+      }
+    }
+  }
+};
+
+
+SIP.Hacks = Hacks;
+}(SIP));

src/Session.js

@@ -973,11 +973,8 @@ InviteServerContext = function(ua, request) {
   }
 
   //TODO: move this into media handler
-  if (request.body && window.mozRTCPeerConnection !== undefined) {
-    request.body = request.body.
-      replace(/relay/g,"host generation 0").
-      replace(/ \r\n/g, "\r\n");
-  }
+  SIP.Hacks.Firefox.cannotHandleRelayCandidates(request);
+  SIP.Hacks.Firefox.cannotHandleExtraWhitespace(request);
 
   SIP.Utils.augment(this, SIP.ServerContext, [ua, request]);
   SIP.Utils.augment(this, SIP.Session, [ua.configuration.mediaHandlerFactory]);
@@ -1441,6 +1438,9 @@ InviteServerContext.prototype = {
         if (!this.hasAnswer) {
           if(request.body && request.getHeader('content-type') === 'application/sdp') {
             // ACK contains answer to an INVITE w/o SDP negotiation
+            SIP.Hacks.Firefox.cannotHandleRelayCandidates(request);
+            SIP.Hacks.Firefox.cannotHandleExtraWhitespace(request);
+
             this.hasAnswer = true;
             this.mediaHandler.setDescription(
               request.body,
@@ -1806,10 +1806,8 @@ InviteClientContext.prototype = {
             return;
           }
 
-          if (response.body && window.mozRTCPeerConnection !== undefined) {
-            response.body = response.body.replace(/relay/g, 'host generation 0');
-            response.body = response.body.replace(/ \r\n/g, '\r\n');
-          }
+          SIP.Hacks.Firefox.cannotHandleRelayCandidates(response);
+          SIP.Hacks.Firefox.cannotHandleExtraWhitespace(response);
 
           if (!response.body) {
             extraHeaders.push('RAck: ' + response.getHeader('rseq') + ' ' + response.getHeader('cseq'));
@@ -1934,10 +1932,8 @@ InviteClientContext.prototype = {
           break;
         }
 
-        if (response.body && window.mozRTCPeerConnection !== undefined) {
-          response.body = response.body.replace(/relay/g, 'host generation 0');
-          response.body = response.body.replace(/ \r\n/g, '\r\n');
-        }
+        SIP.Hacks.Firefox.cannotHandleRelayCandidates(response);
+        SIP.Hacks.Firefox.cannotHandleExtraWhitespace(response);
 
         // This is an invite without sdp
         if (!this.hasOffer) {