Invoke all commands on the main thread (#5857)

* Invoke all commands on the main thread

* Fix tests

* Remove flaky test

lib/ios/RNNAssert.h

@@ -0,0 +1,23 @@
+#import <Foundation/Foundation.h>
+
+extern BOOL RNNIsMainQueue(void);
+
+#ifndef RNN_NSASSERT
+#define RNN_NSASSERT RCT_DEBUG
+#endif
+
+#ifndef NS_BLOCK_ASSERTIONS
+#define RNNAssert(condition, ...) do { \
+  if ((condition) == 0) { \
+    if (RNN_NSASSERT) { \
+      [[NSAssertionHandler currentHandler] handleFailureInFunction:(NSString * _Nonnull)@(__func__) \
+        file:(NSString * _Nonnull)@(__FILE__) lineNumber:__LINE__ description:__VA_ARGS__]; \
+    } \
+  } \
+} while (false)
+#else
+#define RNNAssert(condition, ...) do {} while (false)
+#endif
+
+#define RNNAssertMainQueue() RNNAssert(RNNIsMainQueue(), \
+@"This function must be called on the main queue")

lib/ios/RNNBridgeModule.m

@@ -2,108 +2,136 @@
 #import "Constants.h"
 
 @implementation RNNBridgeModule {
-	RNNCommandsHandler* _commandsHandler;
+    RNNCommandsHandler* _commandsHandler;
 }
 @synthesize bridge = _bridge;
 RCT_EXPORT_MODULE();
 
 - (dispatch_queue_t)methodQueue {
-	return dispatch_get_main_queue();
+    return dispatch_get_main_queue();
 }
 
 -(instancetype)initWithCommandsHandler:(RNNCommandsHandler *)commandsHandler {
-	self = [super init];
-	_commandsHandler = commandsHandler;
-	return self;
+    self = [super init];
+    _commandsHandler = commandsHandler;
+    return self;
 }
 
 #pragma mark - JS interface
 
 RCT_EXPORT_METHOD(setRoot:(NSString*)commandId layout:(NSDictionary*)layout resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler setRoot:layout commandId:commandId completion:^{
-		resolve(layout);
-	}];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler setRoot:layout commandId:commandId completion:^{
+            resolve(layout);
+        }];
+    });
 }
 
 RCT_EXPORT_METHOD(mergeOptions:(NSString*)componentId options:(NSDictionary*)options resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler mergeOptions:componentId options:options completion:^{
-		resolve(componentId);
-	}];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler mergeOptions:componentId options:options completion:^{
+            resolve(componentId);
+        }];
+    });
 }
 
 RCT_EXPORT_METHOD(setDefaultOptions:(NSDictionary*)options resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler setDefaultOptions:options completion:^{
-		resolve(nil);
-	}];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler setDefaultOptions:options completion:^{
+            resolve(nil);
+        }];
+    });
 }
 
 RCT_EXPORT_METHOD(push:(NSString*)commandId componentId:(NSString*)componentId layout:(NSDictionary*)layout resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler push:componentId commandId:commandId layout:layout completion:^{
-		resolve(componentId);
-	} rejection:reject];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler push:componentId commandId:commandId layout:layout completion:^{
+            resolve(componentId);
+        } rejection:reject];
+    });
 }
 
 RCT_EXPORT_METHOD(pop:(NSString*)commandId componentId:(NSString*)componentId mergeOptions:(NSDictionary*)options resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler pop:componentId commandId:commandId mergeOptions:(NSDictionary*)options completion:^{
-		resolve(componentId);
-	} rejection:reject];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler pop:componentId commandId:commandId mergeOptions:(NSDictionary*)options completion:^{
+            resolve(componentId);
+        } rejection:reject];
+    });
 }
 
 RCT_EXPORT_METHOD(setStackRoot:(NSString*)commandId componentId:(NSString*)componentId children:(NSArray*)children resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler setStackRoot:componentId commandId:commandId children:children completion:^{
-		resolve(componentId);
-	} rejection:reject];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler setStackRoot:componentId commandId:commandId children:children completion:^{
+            resolve(componentId);
+        } rejection:reject];
+    });
 }
 
 RCT_EXPORT_METHOD(popTo:(NSString*)commandId componentId:(NSString*)componentId mergeOptions:(NSDictionary*)options resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler popTo:componentId commandId:commandId mergeOptions:options completion:^{
-		resolve(componentId);
-	} rejection:reject];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler popTo:componentId commandId:commandId mergeOptions:options completion:^{
+            resolve(componentId);
+        } rejection:reject];
+    });
 }
 
 RCT_EXPORT_METHOD(popToRoot:(NSString*)commandId componentId:(NSString*)componentId mergeOptions:(NSDictionary*)options resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler popToRoot:componentId commandId:commandId mergeOptions:options completion:^{
-		resolve(componentId);
-	} rejection:reject];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler popToRoot:componentId commandId:commandId mergeOptions:options completion:^{
+            resolve(componentId);
+        } rejection:reject];
+    });
 }
 
 RCT_EXPORT_METHOD(showModal:(NSString*)commandId layout:(NSDictionary*)layout resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler showModal:layout commandId:commandId completion:^(NSString *componentId) {
-		resolve(componentId);
-	}];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler showModal:layout commandId:commandId completion:^(NSString *componentId) {
+            resolve(componentId);
+        }];
+    });
 }
 
 RCT_EXPORT_METHOD(dismissModal:(NSString*)commandId componentId:(NSString*)componentId mergeOptions:(NSDictionary*)options resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler dismissModal:componentId commandId:commandId mergeOptions:options completion:^{
-		resolve(componentId);
-	} rejection:reject];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler dismissModal:componentId commandId:commandId mergeOptions:options completion:^{
+            resolve(componentId);
+        } rejection:reject];
+    });
 }
 
 RCT_EXPORT_METHOD(dismissAllModals:(NSString*)commandId mergeOptions:(NSDictionary*)options resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler dismissAllModals:options commandId:commandId completion:^{
-		resolve(nil);
-	}];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler dismissAllModals:options commandId:commandId completion:^{
+            resolve(nil);
+        }];
+    });
 }
 
 RCT_EXPORT_METHOD(showOverlay:(NSString*)commandId layout:(NSDictionary*)layout resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler showOverlay:layout commandId:commandId completion:^{
-		resolve(layout[@"id"]);
-	}];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler showOverlay:layout commandId:commandId completion:^{
+            resolve(layout[@"id"]);
+        }];
+    });
 }
 
 RCT_EXPORT_METHOD(dismissOverlay:(NSString*)commandId componentId:(NSString*)componentId resolve:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	[_commandsHandler dismissOverlay:componentId commandId:commandId completion:^{
-		resolve(@(1));
-	} rejection:reject];
+    RCTExecuteOnMainQueue(^{
+        [_commandsHandler dismissOverlay:componentId commandId:commandId completion:^{
+            resolve(@(1));
+        } rejection:reject];
+    });
 }
 
 RCT_EXPORT_METHOD(getLaunchArgs:(NSString*)commandId :(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	NSArray* args = [[NSProcessInfo processInfo] arguments];
-	resolve(args);
+    NSArray* args = [[NSProcessInfo processInfo] arguments];
+    resolve(args);
 }
 
 RCT_EXPORT_METHOD(getNavigationConstants:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
-	resolve([Constants getConstants]);
+    RCTExecuteOnMainQueue(^{
+        resolve([Constants getConstants]);
+    });
 }
 
 @end

lib/ios/RNNCommandsHandler.m

@@ -7,6 +7,7 @@
 #import "UIViewController+LayoutProtocol.h"
 #import "RNNLayoutManager.h"
 #import "UIViewController+Utils.h"
+#import "RNNAssert.h"
 
 static NSString* const setRoot	= @"setRoot";
 static NSString* const setStackRoot	= @"setStackRoot";
@@ -52,6 +53,7 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)setRoot:(NSDictionary*)layout commandId:(NSString*)commandId completion:(RNNTransitionCompletionBlock)completion {
 	[self assertReady];
+    RNNAssertMainQueue();
 	
 	if (@available(iOS 9, *)) {
 		if(_controllerFactory.defaultOptions.layout.direction.hasValue) {
@@ -85,6 +87,7 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)mergeOptions:(NSString*)componentId options:(NSDictionary*)mergeOptions completion:(RNNTransitionCompletionBlock)completion {
 	[self assertReady];
+    RNNAssertMainQueue();
 	
 	UIViewController<RNNLayoutProtocol>* vc = [RNNLayoutManager findComponentForId:componentId];
 	RNNNavigationOptions* newOptions = [[RNNNavigationOptions alloc] initWithDict:mergeOptions];
@@ -100,6 +103,8 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)setDefaultOptions:(NSDictionary*)optionsDict completion:(RNNTransitionCompletionBlock)completion {
 	[self assertReady];
+    RNNAssertMainQueue();
+    
 	RNNNavigationOptions* defaultOptions = [[RNNNavigationOptions alloc] initWithDict:optionsDict];
 	[_controllerFactory setDefaultOptions:defaultOptions];
 	
@@ -111,6 +116,7 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)push:(NSString*)componentId commandId:(NSString*)commandId layout:(NSDictionary*)layout completion:(RNNTransitionCompletionBlock)completion rejection:(RCTPromiseRejectBlock)rejection {
 	[self assertReady];
+    RNNAssertMainQueue();
 	
 	UIViewController *newVc = [_controllerFactory createLayout:layout];
 	UIViewController *fromVC = [RNNLayoutManager findComponentForId:componentId];
@@ -172,6 +178,7 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)setStackRoot:(NSString*)componentId commandId:(NSString*)commandId children:(NSArray*)children completion:(RNNTransitionCompletionBlock)completion rejection:(RCTPromiseRejectBlock)rejection {
 	[self assertReady];
+    RNNAssertMainQueue();
 	
 	NSArray<UIViewController *> *childViewControllers = [_controllerFactory createChildrenLayout:children];
 	for (UIViewController<RNNLayoutProtocol>* viewController in childViewControllers) {
@@ -197,7 +204,8 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)pop:(NSString*)componentId commandId:(NSString*)commandId mergeOptions:(NSDictionary*)mergeOptions completion:(RNNTransitionCompletionBlock)completion rejection:(RCTPromiseRejectBlock)rejection {
 	[self assertReady];
-	
+	RNNAssertMainQueue();
+    
 	RNNComponentViewController *vc = (RNNComponentViewController*)[RNNLayoutManager findComponentForId:componentId];
 	RNNNavigationOptions *options = [[RNNNavigationOptions alloc] initWithDict:mergeOptions];
 	[vc overrideOptions:options];
@@ -222,6 +230,8 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)popTo:(NSString*)componentId commandId:(NSString*)commandId mergeOptions:(NSDictionary *)mergeOptions completion:(RNNTransitionCompletionBlock)completion rejection:(RCTPromiseRejectBlock)rejection {
 	[self assertReady];
+    RNNAssertMainQueue();
+    
 	RNNComponentViewController *vc = (RNNComponentViewController*)[RNNLayoutManager findComponentForId:componentId];
 	RNNNavigationOptions *options = [[RNNNavigationOptions alloc] initWithDict:mergeOptions];
 	[vc overrideOptions:options];
@@ -234,6 +244,8 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)popToRoot:(NSString*)componentId commandId:(NSString*)commandId mergeOptions:(NSDictionary *)mergeOptions completion:(RNNTransitionCompletionBlock)completion rejection:(RCTPromiseRejectBlock)rejection {
 	[self assertReady];
+    RNNAssertMainQueue();
+    
 	RNNComponentViewController *vc = (RNNComponentViewController*)[RNNLayoutManager findComponentForId:componentId];
 	RNNNavigationOptions *options = [[RNNNavigationOptions alloc] initWithDict:mergeOptions];
 	[vc overrideOptions:options];
@@ -255,6 +267,7 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)showModal:(NSDictionary*)layout commandId:(NSString *)commandId completion:(RNNTransitionWithComponentIdCompletionBlock)completion {
 	[self assertReady];
+    RNNAssertMainQueue();
 	
 	UIViewController *newVc = [_controllerFactory createLayout:layout];
 	
@@ -270,6 +283,7 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)dismissModal:(NSString*)componentId commandId:(NSString*)commandId mergeOptions:(NSDictionary *)mergeOptions completion:(RNNTransitionCompletionBlock)completion rejection:(RNNTransitionRejectionBlock)reject {
 	[self assertReady];
+    RNNAssertMainQueue();
 	
 	UIViewController *modalToDismiss = (UIViewController *)[RNNLayoutManager findComponentForId:componentId];
 	
@@ -293,6 +307,7 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)dismissAllModals:(NSDictionary *)mergeOptions commandId:(NSString*)commandId completion:(RNNTransitionCompletionBlock)completion {
 	[self assertReady];
+    RNNAssertMainQueue();
 	
 	[CATransaction begin];
 	[CATransaction setCompletionBlock:^{
@@ -307,7 +322,8 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)showOverlay:(NSDictionary *)layout commandId:(NSString*)commandId completion:(RNNTransitionCompletionBlock)completion {
 	[self assertReady];
-	
+    RNNAssertMainQueue();
+    
 	UIViewController* overlayVC = [_controllerFactory createLayout:layout];
     [overlayVC setReactViewReadyCallback:^{UIWindow* overlayWindow = [[RNNOverlayWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
         overlayWindow.rootViewController = overlayVC;
@@ -327,6 +343,8 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)dismissOverlay:(NSString*)componentId commandId:(NSString*)commandId completion:(RNNTransitionCompletionBlock)completion rejection:(RNNTransitionRejectionBlock)reject {
 	[self assertReady];
+    RNNAssertMainQueue();
+    
 	UIViewController* viewController = [RNNLayoutManager findComponentForId:componentId];
 	if (viewController) {
 		[_overlayManager dismissOverlay:viewController];

lib/ios/RNNUtils.m

@@ -1,6 +1,7 @@
 #import "RNNUtils.h"
 
 @implementation RNNUtils
+
 +(double)getDoubleOrKey:(NSDictionary*)dict withKey:(NSString*)key withDefault:(double)defaultResult {
 	if ([dict objectForKey:key]) {
 		return [dict[key] doubleValue];
@@ -29,4 +30,15 @@
 	return [NSNumber numberWithLong:[[NSDate date] timeIntervalSince1970] * 1000];
 }
 
+
+BOOL RNNIsMainQueue() {
+  static void *mainQueueKey = &mainQueueKey;
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    dispatch_queue_set_specific(dispatch_get_main_queue(),
+                                mainQueueKey, mainQueueKey, NULL);
+  });
+  return dispatch_get_specific(mainQueueKey) == mainQueueKey;
+}
+
 @end

lib/ios/ReactNativeNavigation.xcodeproj/project.pbxproj

@@ -484,6 +484,7 @@
 		502F0E132178CF8200367CC3 /* UIViewController+RNNOptionsTest.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "UIViewController+RNNOptionsTest.m"; sourceTree = "<group>"; };
 		502F0E152178D09600367CC3 /* RNNBasePresenterTest.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = RNNBasePresenterTest.m; sourceTree = "<group>"; };
 		502F0E172179C39900367CC3 /* RNNTabBarPresenterTest.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = RNNTabBarPresenterTest.m; sourceTree = "<group>"; };
+		5030B62D23D60002008F1642 /* RNNAssert.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = RNNAssert.h; sourceTree = "<group>"; };
 		50344D2623A03DB4004B6A7C /* BottomTabsAttachMode.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BottomTabsAttachMode.h; sourceTree = "<group>"; };
 		50344D2723A03DB4004B6A7C /* BottomTabsAttachMode.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BottomTabsAttachMode.m; sourceTree = "<group>"; };
 		5038A372216CDDB6009280BC /* UIViewController+SideMenuController.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "UIViewController+SideMenuController.h"; sourceTree = "<group>"; };
@@ -1305,6 +1306,7 @@
 				E5F6C39E22DB4D0E0093C2CE /* UIViewController+Utils.m */,
 				50DE2E43238EA14E005CD5F4 /* NSArray+utils.h */,
 				50DE2E44238EA14E005CD5F4 /* NSArray+utils.m */,
+				5030B62D23D60002008F1642 /* RNNAssert.h */,
 			);
 			name = Utils;
 			sourceTree = "<group>";

playground/ios/NavigationTests/RNNCommandsHandlerTest.m

@@ -83,7 +83,7 @@
 	return [[RNNComponentViewController alloc] initWithLayoutInfo:layoutInfo rootViewCreator:_creator eventEmitter:nil presenter:[RNNComponentPresenter new] options:[[RNNNavigationOptions alloc] initWithDict:@{}] defaultOptions:nil];
 }
 
-- (void)testAssertReadyForEachMethodThrowsExceptoins {
+- (void)testAssertReadyForEachMethodThrowsExceptions {
 	NSArray* methods = [self getPublicMethodNamesForObject:self.uut];
 	[self.uut setReadyToReceiveCommands:false];
 	for (NSString* methodName in methods) {
@@ -94,7 +94,7 @@
 	}
 }
 
--(NSArray*) getPublicMethodNamesForObject:(NSObject*)obj{
+- (NSArray*)getPublicMethodNamesForObject:(NSObject*)obj {
 	NSMutableArray* skipMethods = [NSMutableArray new];
 	
 	[skipMethods addObject:@"initWithControllerFactory:eventEmitter:stackManager:modalManager:overlayManager:mainWindow:"];