encode message queue as JSON

jberkman · jberkman · commit 9297f5c3db30 · 2013-07-30T09:59:23.000-07:00
If JS included the separator as part of its data, the Obj-C side would
interpret it incorrectly:

WebViewJavascriptBridge.send('Including __WVJB_MESSAGE_SEPERATOR__ in
my message is broken.');

Before:
WVJB receivd: {"data":"Including
WVJB receivd:  in my message is broken."}

After:
WVJB receivd: {"data":"Including __WVJB_MESSAGE_SEPERATOR__ in my
message is broken."}
diff --git a/WebViewJavascriptBridge/WebViewJavascriptBridge.h b/WebViewJavascriptBridge/WebViewJavascriptBridge.h
@@ -8,7 +8,6 @@
 
 #import <Foundation/Foundation.h>
 
-#define kMessageSeparator     @"__WVJB_MESSAGE_SEPERATOR__"
 #define kCustomProtocolScheme @"wvjbscheme"
 #define kQueueHasMessage      @"__WVJB_QUEUE_MESSAGE__"
 
diff --git a/WebViewJavascriptBridge/WebViewJavascriptBridge.js.txt b/WebViewJavascriptBridge/WebViewJavascriptBridge.js.txt
@@ -5,7 +5,6 @@
 	var receiveMessageQueue = []
 	var messageHandlers = {}
 	
-	var MESSAGE_SEPARATOR = '__WVJB_MESSAGE_SEPERATOR__'
 	var CUSTOM_PROTOCOL_SCHEME = 'wvjbscheme'
 	var QUEUE_HAS_MESSAGE = '__WVJB_QUEUE_MESSAGE__'
 	
@@ -46,12 +45,12 @@
 			responseCallbacks[callbackId] = responseCallback
 			message['callbackId'] = callbackId
 		}
-		sendMessageQueue.push(JSON.stringify(message))
+		sendMessageQueue.push(message)
 		messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://' + QUEUE_HAS_MESSAGE
 	}
 
 	function _fetchQueue() {
-		var messageQueueString = sendMessageQueue.join(MESSAGE_SEPARATOR)
+		var messageQueueString = JSON.stringify(sendMessageQueue)
 		sendMessageQueue = []
 		return messageQueueString
 	}
diff --git a/WebViewJavascriptBridge/WebViewJavascriptBridge.m b/WebViewJavascriptBridge/WebViewJavascriptBridge.m
@@ -138,12 +138,18 @@ - (void)_dispatchMessage:(NSDictionary *)message {
 - (void)_flushMessageQueue {
     NSString *messageQueueString = [_webView stringByEvaluatingJavaScriptFromString:@"WebViewJavascriptBridge._fetchQueue();"];
     
-    NSArray* messages = [messageQueueString componentsSeparatedByString:kMessageSeparator];
-    for (NSString *messageJSON in messages) {
-        [self _log:@"receivd" json:messageJSON];
-        
-        NSDictionary* message = [self _deserializeMessageJSON:messageJSON];
-        
+    id messages = [self _deserializeMessageJSON:messageQueueString];
+    if (![messages isKindOfClass:[NSArray class]]) {
+        NSLog(@"WebViewJavascriptBridge: WARNING: Invalid %@ received: %@", [messages class], messages);
+        return;
+    }
+    for (NSDictionary *message in messages) {
+        if (![message isKindOfClass:[NSDictionary class]]) {
+            NSLog(@"WebViewJavascriptBridge: WARNING: Invalid %@ received: %@", [message class], message);
+            continue;
+        }
+        [self _log:@"receivd" json:message];
+
         NSString* responseId = message[@"responseId"];
         if (responseId) {
             WVJBResponseCallback responseCallback = _responseCallbacks[responseId];
@@ -202,10 +208,13 @@ - (NSDictionary *)_deserializeMessageJSON:(NSString *)messageJSON {
 #endif
 }
 
-- (void)_log:(NSString *)action json:(NSString *)json {
+- (void)_log:(NSString *)action json:(id)json {
     if (!logging) { return; }
-    if (json.length > 500) {
-        NSLog(@"WVJB %@: %@", action, [[json substringToIndex:500] stringByAppendingString:@" [...]"]);
+    if (![json isKindOfClass:[NSString class]]) {
+        json = [self _serializeMessage:json];
+    }
+    if ([json length] > 500) {
+        NSLog(@"WVJB %@: %@ [...]", action, [json substringToIndex:500]);
     } else {
         NSLog(@"WVJB %@: %@", action, json);
     }

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`var receiveMessageQueue = []`
`6`	`6`	`var messageHandlers = {}`
`7`	`7`
`8`		`- var MESSAGE_SEPARATOR = '__WVJB_MESSAGE_SEPERATOR__'`
`9`	`8`	`var CUSTOM_PROTOCOL_SCHEME = 'wvjbscheme'`
`10`	`9`	`var QUEUE_HAS_MESSAGE = '__WVJB_QUEUE_MESSAGE__'`
`11`	`10`
`@@ -46,12 +45,12 @@`
`46`	`45`	`responseCallbacks[callbackId] = responseCallback`
`47`	`46`	`message['callbackId'] = callbackId`
`48`	`47`	`}`
`49`		`- sendMessageQueue.push(JSON.stringify(message))`
	`48`	`+ sendMessageQueue.push(message)`
`50`	`49`	`messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://' + QUEUE_HAS_MESSAGE`
`51`	`50`	`}`
`52`	`51`
`53`	`52`	`function _fetchQueue() {`
`54`		`- var messageQueueString = sendMessageQueue.join(MESSAGE_SEPARATOR)`
	`53`	`+ var messageQueueString = JSON.stringify(sendMessageQueue)`
`55`	`54`	`sendMessageQueue = []`
`56`	`55`	`return messageQueueString`
`57`	`56`	`}`