Simplify API by focusing on explicitly named handlers instead of a default handler and plain send.

Author: marcuswestin

Changelog

@@ -13,15 +13,17 @@ Release Checklist
 Version History
 ---------------
 
-Intended v5.0.0
+Next version
++ Pretty-print json in log messages
+
+Intended v5.0.1
 + Removed `WebViewJavascriptBridge -reset`. It should never have been exposed as a public API.
 + Fixed compilation in C99 mode
 + Inline JS source code. WVJB no longer requires `WebViewJavascriptBridge.js.txt` to be included as a resource.
 + Automated testing: see `make test`
 + Added Makefile with common commands
-
-Next version
-+ Pretty-print json in log messages
++ Significantly simplified and improved wvjb load detection
++ Simplify API by focusing on explicitly named handlers instead of a default handler and plain `send`.
 
 v4.1.4
 + Improve how WVJB handles the case when there is no ObjC handler for a message received from js.

Example Apps/ExampleApp-OSX/AppDelegate.m

@@ -28,38 +28,24 @@ - (void)applicationDidFinishLaunching:(NSNotification *)aNotification
 
 - (void)_configureWebview {
     // Create Bridge
-    _bridge = [WebViewJavascriptBridge bridgeForWebView:_webView handler:^(id data, WVJBResponseCallback responseCallback) {
-        NSLog(@"ObjC received message from JS: %@", data);
-        responseCallback(@"Response for message from ObjC");
-    }];
+    _bridge = [WebViewJavascriptBridge bridgeForWebView:_webView];
 
     [_bridge registerHandler:@"testObjcCallback" handler:^(id data, WVJBResponseCallback responseCallback) {
         NSLog(@"testObjcCallback called: %@", data);
         responseCallback(@"Response from testObjcCallback");
     }];
 
-    [_bridge send:@"A string sent from ObjC before Webview has loaded." responseCallback:^(id responseData) {
-        NSLog(@"objc got response! %@", responseData);
-    }];
-    
     [_bridge callHandler:@"testJavascriptHandler" data:@{ @"foo":@"before ready" }];
 
     // Create Buttons
-    NSButton *messageButton = [[NSButton alloc] initWithFrame:NSMakeRect(5, 0, 120, 40)];
-    [messageButton setTitle:@"Send message"];
-    [messageButton setBezelStyle:NSRoundedBezelStyle];
-    [messageButton setTarget:self];
-    [messageButton setAction:@selector(_sendMessage)];
-    [_webView addSubview:messageButton];
-    
-    NSButton *callbackButton = [[NSButton alloc] initWithFrame:NSMakeRect(120, 0, 120, 40)];
+    NSButton *callbackButton = [[NSButton alloc] initWithFrame:NSMakeRect(5, 0, 120, 40)];
     [callbackButton setTitle:@"Call handler"];
     [callbackButton setBezelStyle:NSRoundedBezelStyle];
     [callbackButton setTarget:self];
     [callbackButton setAction:@selector(_callHandler)];
     [_webView addSubview:callbackButton];
 
-    NSButton *webViewToggleButton = [[NSButton alloc] initWithFrame:NSMakeRect(235, 0, 180, 40)];
+    NSButton *webViewToggleButton = [[NSButton alloc] initWithFrame:NSMakeRect(120, 0, 180, 40)];
     [webViewToggleButton setTitle:@"Switch to WKWebView"];
     [webViewToggleButton setBezelStyle:NSRoundedBezelStyle];
     [webViewToggleButton setTarget:self];
@@ -76,38 +62,24 @@ - (void)_configureWebview {
 
 - (void)_configureWKWebview {
     // Create Bridge
-    _WKBridge = [WKWebViewJavascriptBridge bridgeForWebView:_WKWebView handler:^(id data, WVJBResponseCallback responseCallback) {
-        NSLog(@"ObjC received message from JS: %@", data);
-        responseCallback(@"Response for message from ObjC");
-    }];
+    _WKBridge = [WKWebViewJavascriptBridge bridgeForWebView:_WKWebView];
 
     [_WKBridge registerHandler:@"testObjcCallback" handler:^(id data, WVJBResponseCallback responseCallback) {
         NSLog(@"testObjcCallback called: %@", data);
         responseCallback(@"Response from testObjcCallback");
     }];
 
-    [_WKBridge send:@"A string sent from ObjC before Webview has loaded." responseCallback:^(id responseData) {
-        NSLog(@"objc got response! %@", responseData);
-    }];
-    
     [_WKBridge callHandler:@"testJavascriptHandler" data:@{ @"foo":@"before ready" }];
 
     // Create Buttons
-    NSButton *messageButton = [[NSButton alloc] initWithFrame:NSMakeRect(5, 0, 120, 40)];
-    [messageButton setTitle:@"Send message"];
-    [messageButton setBezelStyle:NSRoundedBezelStyle];
-    [messageButton setTarget:self];
-    [messageButton setAction:@selector(_WKSendMessage)];
-    [_WKWebView addSubview:messageButton];
-    
-    NSButton *callbackButton = [[NSButton alloc] initWithFrame:NSMakeRect(120, 0, 120, 40)];
+    NSButton *callbackButton = [[NSButton alloc] initWithFrame:NSMakeRect(5, 0, 120, 40)];
     [callbackButton setTitle:@"Call handler"];
     [callbackButton setBezelStyle:NSRoundedBezelStyle];
     [callbackButton setTarget:self];
     [callbackButton setAction:@selector(_WKCallHandler)];
     [_WKWebView addSubview:callbackButton];
 
-    NSButton *webViewToggleButton = [[NSButton alloc] initWithFrame:NSMakeRect(235, 0, 180, 40)];
+    NSButton *webViewToggleButton = [[NSButton alloc] initWithFrame:NSMakeRect(120, 0, 180, 40)];
     [webViewToggleButton setTitle:@"Switch to WebView"];
     [webViewToggleButton setBezelStyle:NSRoundedBezelStyle];
     [webViewToggleButton setTarget:self];
@@ -125,25 +97,13 @@ -(void)_toggleExample {
     _webView.hidden = !_webView.isHidden;
 }
 
-- (void)_sendMessage {
-    [_bridge send:@"A string sent from ObjC to JS" responseCallback:^(id response) {
-        NSLog(@"sendMessage got response: %@", response);
-    }];
-}
-
 - (void)_callHandler {
     id data = @{ @"greetingFromObjC": @"Hi there, JS!" };
     [_bridge callHandler:@"testJavascriptHandler" data:data responseCallback:^(id response) {
         NSLog(@"testJavascriptHandler responded: %@", response);
     }];
 }
 
-- (void)_WKSendMessage {
-    [_WKBridge send:@"A string sent from ObjC to JS" responseCallback:^(id response) {
-        NSLog(@"sendMessage got response: %@", response);
-    }];
-}
-
 - (void)_WKCallHandler {
     id data = @{ @"greetingFromObjC": @"Hi there, JS!" };
     [_WKBridge callHandler:@"testJavascriptHandler" data:data responseCallback:^(id response) {

Example Apps/ExampleApp-iOS/ExampleUIWebViewController.m

@@ -23,26 +23,17 @@ - (void)viewWillAppear:(BOOL)animated {
 
     [WebViewJavascriptBridge enableLogging];
 
-    _bridge = [WebViewJavascriptBridge bridgeForWebView:webView webViewDelegate:self handler:^(id data, WVJBResponseCallback responseCallback) {
-        NSLog(@"ObjC received message from JS: %@", data);
-        responseCallback(@"Response for message from ObjC");
-    }];
+    _bridge = [WebViewJavascriptBridge bridgeForWebView:webView];
 
     [_bridge registerHandler:@"testObjcCallback" handler:^(id data, WVJBResponseCallback responseCallback) {
         NSLog(@"testObjcCallback called: %@", data);
         responseCallback(@"Response from testObjcCallback");
     }];
 
-    [_bridge send:@"A string sent from ObjC before Webview has loaded." responseCallback:^(id responseData) {
-        NSLog(@"objc got response! %@", responseData);
-    }];
-    
     [_bridge callHandler:@"testJavascriptHandler" data:@{ @"foo":@"before ready" }];
 
     [self renderButtons:webView];
     [self loadExamplePage:webView];
-    
-    [_bridge send:@"A string sent from ObjC after Webview has loaded."];
 }
 
 - (void)webViewDidStartLoad:(UIWebView *)webView {
@@ -56,35 +47,21 @@ - (void)webViewDidFinishLoad:(UIWebView *)webView {
 - (void)renderButtons:(UIWebView*)webView {
     UIFont* font = [UIFont fontWithName:@"HelveticaNeue" size:12.0];
 
-    UIButton *messageButton = [UIButton buttonWithType:UIButtonTypeRoundedRect];
-    [messageButton setTitle:@"Send message" forState:UIControlStateNormal];
-    [messageButton addTarget:self action:@selector(sendMessage:) forControlEvents:UIControlEventTouchUpInside];
-    [self.view insertSubview:messageButton aboveSubview:webView];
-    messageButton.frame = CGRectMake(10, 400, 100, 35);
-    messageButton.titleLabel.font = font;
-    messageButton.backgroundColor = [UIColor colorWithWhite:1 alpha:0.75];
-    
     UIButton *callbackButton = [UIButton buttonWithType:UIButtonTypeRoundedRect];
     [callbackButton setTitle:@"Call handler" forState:UIControlStateNormal];
     [callbackButton addTarget:self action:@selector(callHandler:) forControlEvents:UIControlEventTouchUpInside];
     [self.view insertSubview:callbackButton aboveSubview:webView];
-    callbackButton.frame = CGRectMake(110, 400, 100, 35);
+    callbackButton.frame = CGRectMake(10, 400, 100, 35);
     callbackButton.titleLabel.font = font;
 
     UIButton* reloadButton = [UIButton buttonWithType:UIButtonTypeRoundedRect];
     [reloadButton setTitle:@"Reload webview" forState:UIControlStateNormal];
     [reloadButton addTarget:webView action:@selector(reload) forControlEvents:UIControlEventTouchUpInside];
     [self.view insertSubview:reloadButton aboveSubview:webView];
-    reloadButton.frame = CGRectMake(210, 400, 100, 35);
+    reloadButton.frame = CGRectMake(110, 400, 100, 35);
     reloadButton.titleLabel.font = font;
 }
 
-- (void)sendMessage:(id)sender {
-    [_bridge send:@"A string sent from ObjC to JS" responseCallback:^(id response) {
-        NSLog(@"sendMessage got response: %@", response);
-    }];
-}
-
 - (void)callHandler:(id)sender {
     id data = @{ @"greetingFromObjC": @"Hi there, JS!" };
     [_bridge callHandler:@"testJavascriptHandler" data:data responseCallback:^(id response) {

Example Apps/ExampleApp-iOS/ExampleWKWebViewController.m

@@ -24,28 +24,17 @@ - (void)viewWillAppear:(BOOL)animated {
     webView.navigationDelegate = self;
     [self.view addSubview:webView];
     [WKWebViewJavascriptBridge enableLogging];
-    _bridge = [WKWebViewJavascriptBridge bridgeForWebView:webView webViewDelegate:self handler:^(id data, WVJBResponseCallback responseCallback) {
-        NSLog(@"ObjC received message from JS: %@", data);
-        responseCallback(@"Response for message from ObjC");
-    }];
-    
-    
+    _bridge = [WKWebViewJavascriptBridge bridgeForWebView:webView];
 
     [_bridge registerHandler:@"testObjcCallback" handler:^(id data, WVJBResponseCallback responseCallback) {
         NSLog(@"testObjcCallback called: %@", data);
         responseCallback(@"Response from testObjcCallback");
     }];
 
-    [_bridge send:@"A string sent from ObjC before Webview has loaded." responseCallback:^(id responseData) {
-        NSLog(@"objc got response! %@", responseData);
-    }];
-    
     [_bridge callHandler:@"testJavascriptHandler" data:@{ @"foo":@"before ready" }];
 
     [self renderButtons:webView];
     [self loadExamplePage:webView];
-    
-    [_bridge send:@"A string sent from ObjC after Webview has loaded."];
 }
 
 - (void)webViewDidStartLoad:(UIWebView *)webView {
@@ -59,35 +48,21 @@ - (void)webViewDidFinishLoad:(UIWebView *)webView {
 - (void)renderButtons:(WKWebView*)webView {
     UIFont* font = [UIFont fontWithName:@"HelveticaNeue" size:12.0];
 
-    UIButton *messageButton = [UIButton buttonWithType:UIButtonTypeRoundedRect];
-    [messageButton setTitle:@"Send message" forState:UIControlStateNormal];
-    [messageButton addTarget:self action:@selector(sendMessage:) forControlEvents:UIControlEventTouchUpInside];
-    [self.view insertSubview:messageButton aboveSubview:webView];
-    messageButton.frame = CGRectMake(10, 400, 100, 35);
-    messageButton.titleLabel.font = font;
-    messageButton.backgroundColor = [UIColor colorWithWhite:1 alpha:0.75];
-    
     UIButton *callbackButton = [UIButton buttonWithType:UIButtonTypeRoundedRect];
     [callbackButton setTitle:@"Call handler" forState:UIControlStateNormal];
     [callbackButton addTarget:self action:@selector(callHandler:) forControlEvents:UIControlEventTouchUpInside];
     [self.view insertSubview:callbackButton aboveSubview:webView];
-    callbackButton.frame = CGRectMake(110, 400, 100, 35);
+    callbackButton.frame = CGRectMake(10, 400, 100, 35);
     callbackButton.titleLabel.font = font;
 
     UIButton* reloadButton = [UIButton buttonWithType:UIButtonTypeRoundedRect];
     [reloadButton setTitle:@"Reload webview" forState:UIControlStateNormal];
     [reloadButton addTarget:webView action:@selector(reload) forControlEvents:UIControlEventTouchUpInside];
     [self.view insertSubview:reloadButton aboveSubview:webView];
-    reloadButton.frame = CGRectMake(210, 400, 100, 35);
+    reloadButton.frame = CGRectMake(110, 400, 100, 35);
     reloadButton.titleLabel.font = font;
 }
 
-- (void)sendMessage:(id)sender {
-    [_bridge send:@"A string sent from ObjC to JS" responseCallback:^(id response) {
-        NSLog(@"sendMessage got response: %@", response);
-    }];
-}
-
 - (void)callHandler:(id)sender {
     id data = @{ @"greetingFromObjC": @"Hi there, JS!" };
     [_bridge callHandler:@"testJavascriptHandler" data:data responseCallback:^(id response) {

Example Apps/ExampleApp.html

@@ -35,12 +35,6 @@ <h1>WebViewJavascriptBridge Demo</h1>
 			if (log.children.length) { log.insertBefore(el, log.children[0]) }
 			else { log.appendChild(el) }
 		}
-		bridge.init(function(message, responseCallback) {
-			log('JS got a message', message)
-			var data = { 'Javascript Responds':'Wee!' }
-			log('JS responding with', data)
-			responseCallback(data)
-		})
 
 		bridge.registerHandler('testJavascriptHandler', function(data, responseCallback) {
 			log('ObjC called testJavascriptHandler with', data)
@@ -49,17 +43,6 @@ <h1>WebViewJavascriptBridge Demo</h1>
 			responseCallback(responseData)
 		})
 
-		var button = document.getElementById('buttons').appendChild(document.createElement('button'))
-		button.innerHTML = 'Send message to ObjC'
-		button.onclick = function(e) {
-			e.preventDefault()
-			var data = 'Hello from JS button'
-			log('JS sending message', data)
-			bridge.send(data, function(responseData) {
-				log('JS got response', responseData)
-			})
-		}
-
 		document.body.appendChild(document.createElement('br'))
 
 		var callbackButton = document.getElementById('buttons').appendChild(document.createElement('button'))

Tests/WebViewJavascriptBridgeTests/BridgeTests.m

@@ -12,7 +12,6 @@
 #import "AppDelegate.h"
 
 static NSString *const echoHandler = @"echoHandler";
-static const WVJBHandler nullHandler = ^(id data, WVJBResponseCallback callback) {};
 
 @interface BridgeTests : XCTestCase
 
@@ -46,46 +45,20 @@ static void loadEchoSample(UIWebView *webView)
 - (void)testInitialization
 {
   XCTestExpectation *startup = [self expectationWithDescription:@"Startup completed"];
-  WebViewJavascriptBridge *bridge = [WebViewJavascriptBridge bridgeForWebView:_webView handler:^(id data, WVJBResponseCallback responseCallback) {
-    XCTAssertEqualObjects(data, @"Hello world");
-    [startup fulfill];
-  }];
+    WebViewJavascriptBridge *bridge = [WebViewJavascriptBridge bridgeForWebView:_webView];
+    [bridge registerHandler:@"Greet" handler:^(id data, WVJBResponseCallback responseCallback) {
+        XCTAssertEqualObjects(data, @"Hello world");
+        [startup fulfill];
+    }];
   XCTAssertNotNil(bridge);
 
   loadEchoSample(_webView);
   [self waitForExpectationsWithTimeout:1 handler:NULL];
 }
 
-- (void)testMessageAfterSetup {
-    WebViewJavascriptBridge *bridge = [WebViewJavascriptBridge bridgeForWebView:_webView handler:nullHandler];
-    loadEchoSample(_webView);
-    XCTestExpectation *callbackInvoked = [self expectationWithDescription:@"Callback invoked"];
-    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 150 * NSEC_PER_MSEC), dispatch_get_main_queue(), ^{
-        [bridge send:@"testResponseHandler" responseCallback:^(id responseData) {
-            XCTAssertEqualObjects(responseData, @"testResponseHandler");
-            [callbackInvoked fulfill];
-        }];
-    });
-    [self waitForExpectationsWithTimeout:1 handler:NULL];
-}
-
-- (void)testResponseHandler
-{
-  WebViewJavascriptBridge *bridge = [WebViewJavascriptBridge bridgeForWebView:_webView handler:nullHandler];
-
-  XCTestExpectation *callbackInvoked = [self expectationWithDescription:@"Callback invoked"];
-  [bridge send:@"testResponseHandler" responseCallback:^(id responseData) {
-    XCTAssertEqualObjects(responseData, @"testResponseHandler");
-    [callbackInvoked fulfill];
-  }];
-
-  loadEchoSample(_webView);
-  [self waitForExpectationsWithTimeout:1 handler:NULL];
-}
-
 - (void)testEchoHandler
 {
-  WebViewJavascriptBridge *bridge = [WebViewJavascriptBridge bridgeForWebView:_webView handler:nullHandler];
+  WebViewJavascriptBridge *bridge = [WebViewJavascriptBridge bridgeForWebView:_webView];
 
   XCTestExpectation *callbackInvocked = [self expectationWithDescription:@"Callback invoked"];
   [bridge callHandler:echoHandler data:@"testEchoHandler" responseCallback:^(id responseData) {
@@ -97,9 +70,24 @@ - (void)testEchoHandler
   [self waitForExpectationsWithTimeout:1 handler:NULL];
 }
 
+- (void)testEchoHandlerAfterSetup
+{
+    WebViewJavascriptBridge *bridge = [WebViewJavascriptBridge bridgeForWebView:_webView];
+    
+    XCTestExpectation *callbackInvocked = [self expectationWithDescription:@"Callback invoked"];
+    loadEchoSample(_webView);
+    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 150 * NSEC_PER_MSEC), dispatch_get_main_queue(), ^{
+        [bridge callHandler:echoHandler data:@"testEchoHandler" responseCallback:^(id responseData) {
+            XCTAssertEqualObjects(responseData, @"testEchoHandler");
+            [callbackInvocked fulfill];
+        }];
+    });
+    [self waitForExpectationsWithTimeout:1 handler:NULL];
+}
+
 - (void)testObjectEncoding
 {
-  WebViewJavascriptBridge *bridge = [WebViewJavascriptBridge bridgeForWebView:_webView handler:nullHandler];
+  WebViewJavascriptBridge *bridge = [WebViewJavascriptBridge bridgeForWebView:_webView];
 
   void (^echoObject)(id) = ^void(id object) {
     XCTestExpectation *callbackInvocked = [self expectationWithDescription:@"Callback invoked"];

Tests/WebViewJavascriptBridgeTests/echo.html

@@ -15,12 +15,7 @@
 	}
 
 	setupWebViewJavascriptBridge(function(bridge) {
-		bridge.init(function(data, responseCallback) {
-			if (responseCallback) {
-				responseCallback(data);
-			}
-		});
-		WebViewJavascriptBridge.send('Hello world')
+		WebViewJavascriptBridge.callHandler('Greet', 'Hello world');
 		WebViewJavascriptBridge.registerHandler('echoHandler', function(data, responseCallback) {
 			responseCallback(data)
 		})