[Init] Add an executor provider to RCTBridge's init method

ide · ide · commit e6f1e9eecd15 · 2015-04-13T16:37:56.000-07:00
If you construct an RCTBridge you may want to configure the executor. However the constructor synchronously calls `setUp` and sets up the executor. Instead, let the code that constructs the bridge specify an executor source, which controls how the executor is provided. This allows for customizing the web view executor with a UIWebView of your choice, or configuring the URL of the debugger proxy that the web socket executor connects to. Now that RCTRootView takes a bridge in one of its initializers, it is possible to create a bridge with a custom executor and then use that to set up a root view as well. Test Plan: Run the UIExplorer app and confirm I am able to connect to the plain JSContext via Safari. Hit Cmd-D and see Chrome open a Tab. Hit Cmd-N and see that I can connect to a plain JSContext again. Shake the simulator and select "Enable Safari Debugging" and see that I can connect to the UIWebView from Safari. tl;dr the keyboard shortcuts and dev menu work as expected. Fixes #288
diff --git a/React/Base/RCTBridge.h b/React/Base/RCTBridge.h
@@ -15,6 +15,7 @@
 
 @class RCTBridge;
 @class RCTEventDispatcher;
+@protocol RCTJavaScriptExecutorSource;
 
 /**
  * This notification triggers a reload of all bridges currently running.
@@ -29,13 +30,19 @@ extern NSString *const RCTJavaScriptDidLoadNotification;
 /**
  * This block can be used to instantiate modules that require additional
  * init parameters, or additional configuration prior to being used.
- * The bridge will call this block to instatiate the modules, and will
+ * The bridge will call this block to instantiate the modules, and will
  * be responsible for invalidating/releasing them when the bridge is destroyed.
  * For this reason, the block should always return new module instances, and
  * module instances should not be shared between bridges.
  */
 typedef NSArray *(^RCTBridgeModuleProviderBlock)(void);
 
+/**
+ * A block that provides a new instance of an RCTJavaScript executor. The bridge
+ * will call this block to define the executor it uses.
+ */
+typedef id<RCTJavaScriptExecutor>(^RCTJavaScriptExecutorProviderBlock)(void);
+
 /**
  * This function returns the module name for a given class.
  */
@@ -50,13 +57,18 @@ extern NSString *RCTBridgeModuleNameForClass(Class bridgeModuleClass);
  * The designated initializer. This creates a new bridge on top of the specified
  * executor. The bridge should then be used for all subsequent communication
  * with the JavaScript code running in the executor. Modules will be automatically
- * instantiated using the default contructor, but you can optionally pass in an
+ * instantiated using the default constructor, but you can optionally pass in an
  * array of pre-initialized module instances if they require additional init
  * parameters or configuration.
  */
 - (instancetype)initWithBundleURL:(NSURL *)bundleURL
                    moduleProvider:(RCTBridgeModuleProviderBlock)block
-                    launchOptions:(NSDictionary *)launchOptions NS_DESIGNATED_INITIALIZER;
+                    launchOptions:(NSDictionary *)launchOptions
+                   executorSource:(id<RCTJavaScriptExecutorSource>)executorSource NS_DESIGNATED_INITIALIZER;
+
+- (instancetype)initWithBundleURL:(NSURL *)bundleURL
+                   moduleProvider:(RCTBridgeModuleProviderBlock)block
+                    launchOptions:(NSDictionary *)launchOptions;
 
 /**
  * This method is used to call functions in the JavaScript application context.
@@ -87,7 +99,10 @@ static const char *__rct_import_##module##_##method##__ = #module"."#method;
                              url:(NSURL *)url
                       onComplete:(RCTJavaScriptCompleteBlock)onComplete;
 
-@property (nonatomic, strong) Class executorClass;
+/**
+ * The source of JavaScript executors used by this bridge.
+ */
+@property (nonatomic, strong, readonly) id<RCTJavaScriptExecutorSource> executorSource;
 
 /**
  * The event dispatcher is a wrapper around -enqueueJSCall:args: that provides a
diff --git a/React/Base/RCTBridge.m b/React/Base/RCTBridge.m
@@ -16,7 +16,6 @@
 #import <mach-o/dyld.h>
 #import <mach-o/getsect.h>
 
-#import "RCTContextExecutor.h"
 #import "RCTConvert.h"
 #import "RCTEventDispatcher.h"
 #import "RCTJavaScriptLoader.h"
@@ -25,6 +24,7 @@
 #import "RCTRedBox.h"
 #import "RCTRootView.h"
 #import "RCTSparseArray.h"
+#import "RCTStandardExecutorSource.h"
 #import "RCTUtils.h"
 
 NSString *const RCTReloadNotification = @"RCTReloadNotification";
@@ -217,8 +217,6 @@ @implementation RCTModuleMethod
   NSString *_methodName;
 }
 
-static Class _globalExecutorClass;
-
 NS_INLINE NSString *RCTStringUpToFirstArgument(NSString *methodName) {
   NSRange colonRange = [methodName rangeOfString:@":"];
   if (colonRange.length) {
@@ -664,12 +662,13 @@ - (NSString *)description
   return localModules;
 }
 
+#pragma mark - RCTBridge
+
 @implementation RCTBridge
 {
   RCTSparseArray *_modulesByID;
   NSDictionary *_modulesByName;
   id<RCTJavaScriptExecutor> _javaScriptExecutor;
-  Class _executorClass;
   NSURL *_bundleURL;
   RCTBridgeModuleProviderBlock _moduleProvider;
   BOOL _loading;
@@ -680,21 +679,33 @@ @implementation RCTBridge
 - (instancetype)initWithBundleURL:(NSURL *)bundleURL
                    moduleProvider:(RCTBridgeModuleProviderBlock)block
                     launchOptions:(NSDictionary *)launchOptions
+                   executorSource:(id<RCTJavaScriptExecutorSource>)executorSource
 {
   if ((self = [super init])) {
     _bundleURL = bundleURL;
     _moduleProvider = block;
     _launchOptions = [launchOptions copy];
+    _executorSource = executorSource;
     [self setUp];
     [self bindKeys];
   }
 
   return self;
 }
+
+- (instancetype)initWithBundleURL:(NSURL *)bundleURL
+                   moduleProvider:(RCTBridgeModuleProviderBlock)block
+                    launchOptions:(NSDictionary *)launchOptions
+{
+  return [self initWithBundleURL:bundleURL
+                  moduleProvider:block
+                   launchOptions:launchOptions
+                  executorSource:[[RCTStandardExecutorSource alloc] init]];
+}
+
 - (void)setUp
 {
-  Class executorClass = _executorClass ?: _globalExecutorClass ?: [RCTContextExecutor class];
-  _javaScriptExecutor = [[executorClass alloc] init];
+  _javaScriptExecutor = [_executorSource executor];
   _latestJSExecutor = _javaScriptExecutor;
   _eventDispatcher = [[RCTEventDispatcher alloc] initWithBridge:self];
   _shadowQueue = dispatch_queue_create("com.facebook.React.ShadowQueue", DISPATCH_QUEUE_SERIAL);
@@ -803,34 +814,34 @@ - (void)bindKeys
   // will work like a charm!
   [commands registerKeyCommandWithInput:@""
                           modifierFlags:UIKeyModifierCommand
-                                 action:NULL];
-  // reload in current mode
+                                 action:^(UIKeyCommand *command) {
+                                   // Do nothing
+                                 }];
   [commands registerKeyCommandWithInput:@"r"
                           modifierFlags:UIKeyModifierCommand
                                  action:^(UIKeyCommand *command) {
                                    [weakSelf reload];
                                  }];
-  // reset to normal mode
   [commands registerKeyCommandWithInput:@"n"
                           modifierFlags:UIKeyModifierCommand
                                  action:^(UIKeyCommand *command) {
-                                   __strong RCTBridge *strongSelf = weakSelf;
-                                   strongSelf.executorClass = Nil;
+                                   RCTBridge *strongSelf = weakSelf;
+                                   if (!strongSelf || ![strongSelf.executorSource isKindOfClass:[RCTStandardExecutorSource class]]) {
+                                     return;
+                                   }
+                                   RCTStandardExecutorSource *source = (RCTStandardExecutorSource *)strongSelf.executorSource;
+                                   source.executorType = RCTStandardExecutorTypeJSContext;
                                    [strongSelf reload];
                                  }];
-  // reload in debug mode
   [commands registerKeyCommandWithInput:@"d"
                           modifierFlags:UIKeyModifierCommand
                                  action:^(UIKeyCommand *command) {
-                                   __strong RCTBridge *strongSelf = weakSelf;
-                                   strongSelf.executorClass = NSClassFromString(@"RCTWebSocketExecutor");
-                                   if (!strongSelf.executorClass) {
-                                     strongSelf.executorClass = NSClassFromString(@"RCTWebViewExecutor");
-                                   }
-                                   if (!strongSelf.executorClass) {
-                                     RCTLogError(@"WebSocket debugger is not available. "
-                                                 "Did you forget to include RCTWebSocketExecutor?");
+                                   RCTBridge *strongSelf = weakSelf;
+                                   if (!strongSelf || ![strongSelf.executorSource isKindOfClass:[RCTStandardExecutorSource class]]) {
+                                     return;
                                    }
+                                   RCTStandardExecutorSource *source = (RCTStandardExecutorSource *)strongSelf.executorSource;
+                                   source.executorType = RCTStandardExecutorTypeWebSocket;
                                    [strongSelf reload];
                                  }];
 #endif
diff --git a/React/Base/RCTDevMenu.m b/React/Base/RCTDevMenu.m
@@ -9,10 +9,11 @@
 
 #import "RCTDevMenu.h"
 
+#import "RCTBridge.h"
 #import "RCTRedBox.h"
-#import "RCTRootView.h"
+#import "RCTJavaScriptExecutorSource.h"
+#import "RCTStandardExecutorSource.h"
 #import "RCTSourceCode.h"
-#import "RCTWebViewExecutor.h"
 
 @interface RCTDevMenu () <UIActionSheetDelegate>
 
@@ -34,14 +35,20 @@ - (instancetype)initWithBridge:(RCTBridge *)bridge
 
 - (void)show
 {
-  NSString *debugTitleChrome = _bridge.executorClass != Nil && _bridge.executorClass == NSClassFromString(@"RCTWebSocketExecutor") ? @"Disable Chrome Debugging" : @"Enable Chrome Debugging";
-  NSString *debugTitleSafari = _bridge.executorClass == [RCTWebViewExecutor class] ? @"Disable Safari Debugging" : @"Enable Safari Debugging";
+  NSString *debugTitleChrome = nil;
+  NSString *debugTitleSafari = nil;
+  if ([_bridge.executorSource isKindOfClass:[RCTStandardExecutorSource class]]) {
+    RCTStandardExecutorSource *source = (RCTStandardExecutorSource *)_bridge.executorSource;
+    RCTStandardExecutorType executorType = source.executorType;
+    debugTitleChrome = (executorType == RCTStandardExecutorTypeWebSocket) ? @"Disable Chrome Debugging" : @"Enable Chrome Debugging";
+    debugTitleSafari = (executorType == RCTStandardExecutorTypeUIWebView) ? @"Disable Safari Debugging" : @"Enable Safari Debugging";
+  }
   NSString *liveReloadTitle = _liveReload ? @"Disable Live Reload" : @"Enable Live Reload";
   UIActionSheet *actionSheet = [[UIActionSheet alloc] initWithTitle:@"React Native: Development"
                                                            delegate:self
                                                   cancelButtonTitle:@"Cancel"
                                              destructiveButtonTitle:nil
-                                                  otherButtonTitles:@"Reload", debugTitleChrome, debugTitleSafari, liveReloadTitle, nil];
+                                                  otherButtonTitles:@"Reload", liveReloadTitle, debugTitleChrome, debugTitleSafari, nil];
   actionSheet.actionSheetStyle = UIBarStyleBlack;
   [actionSheet showInView:[[[[UIApplication sharedApplication] keyWindow] rootViewController] view]];
 }
@@ -51,17 +58,24 @@ - (void)actionSheet:(UIActionSheet *)actionSheet clickedButtonAtIndex:(NSInteger
   if (buttonIndex == 0) {
     [_bridge reload];
   } else if (buttonIndex == 1) {
-    Class cls = NSClassFromString(@"RCTWebSocketExecutor");
-    _bridge.executorClass = (_bridge.executorClass != cls) ? cls : nil;
-    [_bridge reload];
-  } else if (buttonIndex == 2) {
-    Class cls = [RCTWebViewExecutor class];
-    _bridge.executorClass = (_bridge.executorClass != cls) ? cls : Nil;
-    [_bridge reload];
-  } else if (buttonIndex == 3) {
     _liveReload = !_liveReload;
     [self _pollAndReload];
+  } else if (buttonIndex == 2) {
+    [self _toggleExecutorType:RCTStandardExecutorTypeWebSocket];
+  } else if (buttonIndex == 3) {
+    [self _toggleExecutorType:RCTStandardExecutorTypeUIWebView];
+  }
+}
+
+- (void)_toggleExecutorType:(RCTStandardExecutorType)executorType
+{
+  RCTStandardExecutorSource *source = (RCTStandardExecutorSource *)_bridge.executorSource;
+  if (source.executorType == executorType) {
+    source.executorType = RCTStandardExecutorTypeJSContext;
+  } else {
+    source.executorType = executorType;
   }
+  [_bridge reload];
 }
 
 - (void)_pollAndReload
diff --git a/React/Base/RCTJavaScriptExecutorSource.h b/React/Base/RCTJavaScriptExecutorSource.h
@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <Foundation/Foundation.h>
+
+@protocol RCTJavaScriptExecutor;
+
+@protocol RCTJavaScriptExecutorSource <NSObject>
+
+/**
+ * Return a new JavaScript executor to run a React application.
+ */
+- (id<RCTJavaScriptExecutor>)executor;
+
+@end
diff --git a/React/Base/RCTRootView.h b/React/Base/RCTRootView.h
@@ -11,6 +11,8 @@
 
 #import "RCTBridge.h"
 
+@class RCTStandardExecutorSource;
+
 @interface RCTRootView : UIView <RCTInvalidating>
 
 /**
@@ -51,11 +53,11 @@
 @property (nonatomic, copy) NSDictionary *initialProperties;
 
 /**
- * The class of the RCTJavaScriptExecutor to use with this view.
- * If not specified, it will default to using RCTContextExecutor.
- * Changes will take effect next time the bundle is reloaded.
+ * The source of the JavaScript executors that this RCTRootView uses. Set the
+ * executor type through the provider and reload the RCTRootView for a new
+ * executor.
  */
-@property (nonatomic, strong) Class executorClass;
+@property (nonatomic, strong, readonly) RCTStandardExecutorSource *executorSource;
 
 /**
  * If YES will watch for shake gestures and show development menu
diff --git a/React/Base/RCTRootView.m b/React/Base/RCTRootView.m
@@ -12,7 +12,6 @@
 #import <objc/runtime.h>
 
 #import "RCTBridge.h"
-#import "RCTContextExecutor.h"
 #import "RCTDevMenu.h"
 #import "RCTEventDispatcher.h"
 #import "RCTKeyCommands.h"
@@ -21,7 +20,6 @@
 #import "RCTTouchHandler.h"
 #import "RCTUIManager.h"
 #import "RCTUtils.h"
-#import "RCTWebViewExecutor.h"
 #import "UIView+React.h"
 
 /**
diff --git a/React/Base/RCTStandardExecutorSource.h b/React/Base/RCTStandardExecutorSource.h
@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import "RCTJavaScriptExecutorSource.h"
+
+typedef NS_ENUM(NSUInteger, RCTStandardExecutorType) {
+  RCTStandardExecutorTypeJSContext,
+  RCTStandardExecutorTypeUIWebView,
+  RCTStandardExecutorTypeWebSocket,
+};
+
+@interface RCTStandardExecutorSource : NSObject <RCTJavaScriptExecutorSource>
+
+@property (nonatomic) RCTStandardExecutorType executorType;
+
+- (id<RCTJavaScriptExecutor>)executor;
+
+@end
diff --git a/React/Base/RCTStandardExecutorSource.m b/React/Base/RCTStandardExecutorSource.m
@@ -0,0 +1,38 @@
+// Copyright 2015-present Facebook. All rights reserved.
+
+#import "RCTStandardExecutorSource.h"
+
+#import "RCTContextExecutor.h"
+#import "RCTJavaScriptExecutor.h"
+#import "RCTLog.h"
+#import "RCTWebViewExecutor.h"
+
+@implementation RCTStandardExecutorSource
+
+- (instancetype)init
+{
+  if (self = [super init]) {
+    _executorType = RCTStandardExecutorTypeJSContext;
+  }
+  return self;
+}
+
+- (id<RCTJavaScriptExecutor>)executor
+{
+  switch (_executorType) {
+    case RCTStandardExecutorTypeJSContext:
+      return [[RCTContextExecutor alloc] init];
+    case RCTStandardExecutorTypeUIWebView:
+      return [[RCTWebViewExecutor alloc]initWithWebView:[[UIWebView alloc] init]];
+    case RCTStandardExecutorTypeWebSocket: {
+      Class executorClass = NSClassFromString(@"RCTWebSocketExecutor");
+      if (!executorClass) {
+        RCTLogError(@"WebSocket debugger is not available. Did you forget to include RCTWebSocketExecutor?");
+        executorClass = [RCTContextExecutor class];
+      }
+      return [[executorClass alloc] init];
+    }
+  }
+}
+
+@end
diff --git a/React/React.xcodeproj/project.pbxproj b/React/React.xcodeproj/project.pbxproj
