Fix commands handling on overlays (#4239)

lib/ios/RNNBridgeManager.m

@@ -23,7 +23,6 @@
 	RCTBridge* _bridge;
 
 	RNNStore* _store;
-	RNNStore* _overlayStore;
 
 	RNNCommandsHandler* _commandsHandler;
 }
@@ -35,7 +34,6 @@
 		_delegate = delegate;
 		
 		_store = [RNNStore new];
-		_overlayStore = [RNNStore new];
 		_bridge = [[RCTBridge alloc] initWithDelegate:self launchOptions:_launchOptions];
 
 		[[NSNotificationCenter defaultCenter] addObserver:self
@@ -78,7 +76,7 @@
 	id<RNNRootViewCreator> rootViewCreator = [[RNNReactRootViewCreator alloc] initWithBridge:bridge];
 	RNNControllerFactory *controllerFactory = [[RNNControllerFactory alloc] initWithRootViewCreator:rootViewCreator eventEmitter:eventEmitter andBridge:bridge];
 	
-	_commandsHandler = [[RNNCommandsHandler alloc] initWithStore:_store overlayStore:_overlayStore controllerFactory:controllerFactory eventEmitter:eventEmitter stackManager:[RNNNavigationStackManager new] modalManager:[RNNModalManager new] overlayManager:[RNNOverlayManager new]];
+	_commandsHandler = [[RNNCommandsHandler alloc] initWithStore:_store controllerFactory:controllerFactory eventEmitter:eventEmitter stackManager:[RNNNavigationStackManager new] modalManager:[RNNModalManager new] overlayManager:[RNNOverlayManager new]];
 	RNNBridgeModule *bridgeModule = [[RNNBridgeModule alloc] initWithCommandsHandler:_commandsHandler];
 
 	return [@[bridgeModule,eventEmitter] arrayByAddingObjectsFromArray:[self extraModulesFromDelegate]];
@@ -88,12 +86,10 @@
 
 - (void)onJavaScriptWillLoad {
 	[_store clean];
-	[_overlayStore clean];
 }
 
 - (void)onJavaScriptLoaded {
 	[_store setReadyToReceiveCommands:true];
-	[_overlayStore setReadyToReceiveCommands:true];
 	[[_bridge moduleForClass:[RNNEventEmitter class]] sendOnAppLaunched];
 }
 

lib/ios/RNNCommandsHandler.h

@@ -9,7 +9,7 @@
 
 @interface RNNCommandsHandler : NSObject
 
-- (instancetype)initWithStore:(RNNStore*)store overlayStore:(RNNStore*)overlayStore controllerFactory:(RNNControllerFactory*)controllerFactory eventEmitter:(RNNEventEmitter *)eventEmitter stackManager:(RNNNavigationStackManager *)stackManager modalManager:(RNNModalManager *)modalManager overlayManager:(RNNOverlayManager *)overlayManager;
+- (instancetype)initWithStore:(RNNStore*)store controllerFactory:(RNNControllerFactory*)controllerFactory eventEmitter:(RNNEventEmitter *)eventEmitter stackManager:(RNNNavigationStackManager *)stackManager modalManager:(RNNModalManager *)modalManager overlayManager:(RNNOverlayManager *)overlayManager;
 
 - (void)setRoot:(NSDictionary*)layout completion:(RNNTransitionCompletionBlock)completion;
 

lib/ios/RNNCommandsHandler.m

@@ -30,17 +30,15 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 @implementation RNNCommandsHandler {
 	RNNControllerFactory *_controllerFactory;
 	RNNStore *_store;
-	RNNStore *_overlayStore;
 	RNNModalManager* _modalManager;
 	RNNOverlayManager* _overlayManager;
 	RNNNavigationStackManager* _stackManager;
 	RNNEventEmitter* _eventEmitter;
 }
 
-- (instancetype)initWithStore:(RNNStore*)store overlayStore:(RNNStore*)overlayStore controllerFactory:(RNNControllerFactory*)controllerFactory eventEmitter:(RNNEventEmitter *)eventEmitter stackManager:(RNNNavigationStackManager *)stackManager modalManager:(RNNModalManager *)modalManager overlayManager:(RNNOverlayManager *)overlayManager {
+- (instancetype)initWithStore:(RNNStore*)store controllerFactory:(RNNControllerFactory*)controllerFactory eventEmitter:(RNNEventEmitter *)eventEmitter stackManager:(RNNNavigationStackManager *)stackManager modalManager:(RNNModalManager *)modalManager overlayManager:(RNNOverlayManager *)overlayManager {
 	self = [super init];
 	_store = store;
-	_overlayStore = overlayStore;
 	_controllerFactory = controllerFactory;
 	_eventEmitter = eventEmitter;
 	_modalManager = modalManager;
@@ -56,7 +54,7 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 	[self assertReady];
 	
 	[_modalManager dismissAllModalsAnimated:NO];
-	[_store removeAllComponents];
+	[_store removeAllComponentsFromWindow:UIApplication.sharedApplication.delegate.window];
 	
 	UIViewController *vc = [_controllerFactory createLayout:layout[@"root"] saveToStore:_store];
 	
@@ -280,7 +278,7 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 - (void)showOverlay:(NSDictionary *)layout completion:(RNNTransitionCompletionBlock)completion {
 	[self assertReady];
 	
-	UIViewController<RNNParentProtocol>* overlayVC = [_controllerFactory createLayout:layout saveToStore:_overlayStore];
+	UIViewController<RNNParentProtocol>* overlayVC = [_controllerFactory createLayout:layout saveToStore:_store];
 	[_overlayManager showOverlay:overlayVC];
 	[_eventEmitter sendOnNavigationCommandCompletion:showOverlay params:@{@"layout": layout}];
 	completion();
@@ -288,7 +286,7 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
 - (void)dismissOverlay:(NSString*)componentId completion:(RNNTransitionCompletionBlock)completion rejection:(RNNTransitionRejectionBlock)reject {
 	[self assertReady];
-	UIViewController* viewController = [_overlayStore findComponentForId:componentId];
+	UIViewController* viewController = [_store findComponentForId:componentId];
 	if (viewController) {
 		[_overlayManager dismissOverlay:viewController];
 		[_eventEmitter sendOnNavigationCommandCompletion:dismissOverlay params:@{@"componentId": componentId}];

lib/ios/RNNStore.h

@@ -15,7 +15,7 @@ typedef void (^RNNTransitionRejectionBlock)(NSString *code, NSString *message, N
 - (void)removeComponent:(NSString*)componentId;
 - (void)removeComponentByViewControllerInstance:(UIViewController*)componentInstance;
 - (void)removeAllComponents;
-
+- (void)removeAllComponentsFromWindow:(UIWindow *)window;
 - (void)registerExternalComponent:(NSString *)name callback:(RNNExternalViewCreator)callback;
 - (UIViewController *)getExternalComponent:(RNNLayoutInfo *)layoutInfo bridge:(RCTBridge *)bridge;
 

lib/ios/RNNStore.m

@@ -1,4 +1,3 @@
-
 #import "RNNStore.h"
 
 @interface RNNStore ()
@@ -47,6 +46,23 @@
 	[_componentStore removeAllObjects];
 }
 
+- (void)removeAllComponentsFromWindow:(UIWindow *)window {
+	for (NSString *key in [self componentsForWindow:window]) {
+		[_componentStore removeObjectForKey:key];
+	}
+}
+
+- (NSArray *)componentsForWindow:(UIWindow *)window {
+	NSMutableArray* keyWindowComponents = [NSMutableArray new];
+	for (NSString* key in _componentStore) {
+		UIViewController *component = [_componentStore objectForKey:key];
+		if (component.view.window == window) {
+			[keyWindowComponents addObject:key];
+		}
+	}
+	
+	return keyWindowComponents;
+}
 
 -(void)setReadyToReceiveCommands:(BOOL)isReady {
 	_isReadyToReceiveCommands = isReady;

lib/ios/ReactNativeNavigationTests/RNNCommandsHandlerTest.m

@@ -26,8 +26,7 @@
 
 @interface RNNCommandsHandlerTest : XCTestCase
 
-@property (nonatomic, strong) RNNStore* store;
-@property (nonatomic, strong) id overlayStore;
+@property (nonatomic, strong) id store;
 @property (nonatomic, strong) RNNCommandsHandler* uut;
 @property (nonatomic, strong) RNNRootViewController* vc1;
 @property (nonatomic, strong) RNNRootViewController* vc2;
@@ -43,13 +42,11 @@
 
 - (void)setUp {
 	[super setUp];
-//	[self.store setReadyToReceiveCommands:true];
-	self.store = [[RNNStore alloc] init];
-	self.overlayStore = [OCMockObject partialMockForObject:[[RNNStore alloc] init]];
+	self.store = [OCMockObject partialMockForObject:[[RNNStore alloc] init]];
 	self.eventEmmiter = [OCMockObject partialMockForObject:[RNNEventEmitter new]];
 	self.overlayManager = [OCMockObject partialMockForObject:[RNNOverlayManager new]];
 	self.controllerFactory = [OCMockObject partialMockForObject:[[RNNControllerFactory alloc] initWithRootViewCreator:nil eventEmitter:self.eventEmmiter andBridge:nil]];
-	self.uut = [[RNNCommandsHandler alloc] initWithStore:self.store overlayStore:self.overlayStore controllerFactory:self.controllerFactory eventEmitter:self.eventEmmiter stackManager:[RNNNavigationStackManager new] modalManager:[RNNModalManager new] overlayManager:self.overlayManager];
+	self.uut = [[RNNCommandsHandler alloc] initWithStore:self.store controllerFactory:self.controllerFactory eventEmitter:self.eventEmmiter stackManager:[RNNNavigationStackManager new] modalManager:[RNNModalManager new] overlayManager:self.overlayManager];
 	self.vc1 = [RNNRootViewController new];
 	self.vc2 = [RNNRootViewController new];
 	self.vc3 = [RNNRootViewController new];
@@ -76,7 +73,7 @@
 -(NSArray*) getPublicMethodNamesForObject:(NSObject*)obj{
 	NSMutableArray* skipMethods = [NSMutableArray new];
 
-	[skipMethods addObject:@"initWithStore:overlayStore:controllerFactory:eventEmitter:stackManager:modalManager:overlayManager:"];
+	[skipMethods addObject:@"initWithStore:controllerFactory:eventEmitter:stackManager:modalManager:overlayManager:"];
 	[skipMethods addObject:@"assertReady"];
 	[skipMethods addObject:@"removePopedViewControllers:"];
 	[skipMethods addObject:@".cxx_destruct"];
@@ -198,17 +195,17 @@
 	OCMStub([self.overlayManager showOverlay:[OCMArg any]]);
 	NSDictionary* layout = @{};
 	
-	[[self.controllerFactory expect] createLayout:layout saveToStore:self.overlayStore];
+	[[self.controllerFactory expect] createLayout:layout saveToStore:self.store];
 	[self.uut showOverlay:layout completion:^{}];
 	[self.controllerFactory verify];
 }
 
-- (void)testShowOverlay_saveToOverlayStore {
+- (void)testShowOverlay_saveToStore {
 	[self.store setReadyToReceiveCommands:true];
 	OCMStub([self.overlayManager showOverlay:[OCMArg any]]);
 	OCMStub([self.controllerFactory createLayout:[OCMArg any] saveToStore:[OCMArg any]]);
 	
-	[[self.controllerFactory expect] createLayout:[OCMArg any] saveToStore:self.overlayStore];
+	[[self.controllerFactory expect] createLayout:[OCMArg any] saveToStore:self.store];
 	[self.uut showOverlay:@{} completion:^{}];
 	[self.overlayManager verify];
 }
@@ -235,19 +232,19 @@
 	[self.eventEmmiter verify];
 }
 
-- (void)testDismissOverlay_findComponentFromOverlayStore {
+- (void)testDismissOverlay_findComponentFromStore {
 	[self.store setReadyToReceiveCommands:true];
 	NSString* componentId = @"componentId";
-	[[self.overlayStore expect] findComponentForId:componentId];
+	[[self.store expect] findComponentForId:componentId];
 	[self.uut dismissOverlay:componentId completion:^{} rejection:^(NSString *code, NSString *message, NSError *error) {}];
-	[self.overlayStore verify];
+	[self.store verify];
 }
 
 - (void)testDismissOverlay_dismissReturnedViewController {
 	[self.store setReadyToReceiveCommands:true];
 	NSString* componentId = @"componentId";
 	UIViewController* returnedView = [UIViewController new];
-	OCMStub([self.overlayStore findComponentForId:componentId]).andReturn(returnedView);
+	OCMStub([self.store findComponentForId:componentId]).andReturn(returnedView);
 	
 	[[self.overlayManager expect] dismissOverlay:returnedView];
 	[self.uut dismissOverlay:componentId completion:^{} rejection:^(NSString *code, NSString *message, NSError *error) {}];
@@ -267,7 +264,7 @@
 - (void)testDismissOverlay_invokeNavigationCommandEvent {
 	[self.store setReadyToReceiveCommands:true];
 	NSString* componentId = @"componentId";
-	OCMStub([self.overlayStore findComponentForId:componentId]).andReturn([UIViewController new]);
+	OCMStub([self.store findComponentForId:componentId]).andReturn([UIViewController new]);
 	
 	[[self.eventEmmiter expect] sendOnNavigationCommandCompletion:@"dismissOverlay" params:[OCMArg any]];
 	[self.uut dismissOverlay:componentId completion:^{

lib/ios/ReactNativeNavigationTests/RNNStoreTest.m

@@ -1,5 +1,6 @@
 
 #import <XCTest/XCTest.h>
+#import <OCMock/OCMock.h>
 #import "RNNStore.h"
 
 @interface RNNStoreTest : XCTestCase
@@ -67,7 +68,7 @@
 	XCTAssertNil([self.store findComponentForId:componentId1]);
 }
 
--(void)testPopWillRemoveVcFromStore {
+- (void)testPopWillRemoveVcFromStore {
 	NSString *vcId = @"cnt_vc_2";
 	
 	[self setComponentAndRelease:vcId];
@@ -77,7 +78,7 @@
 }
 
 
--(void)testRemoveComponentByInstance {
+- (void)testRemoveComponentByInstance {
 	NSString *componentId1 = @"cntId1";
 	UIViewController *vc1 = [UIViewController new];
 	
@@ -87,6 +88,29 @@
 	XCTAssertNil([self.store findComponentForId:@"cntId1"]);
 }
 
+- (void)testRemoveAllComponentsFromWindowShouldRemoveComponentsInWindow {
+	UIViewController* overlayVC = [self createMockedViewControllerWithWindow:[UIWindow new]];
+	
+	NSString* overlayId = @"overlayId";
+	[self.store setComponent:overlayVC componentId:overlayId];
+	[self.store removeAllComponentsFromWindow:overlayVC.view.window];
+	XCTAssertNil([self.store findComponentForId:overlayId]);
+}
+
+- (void)testRemoveAllComponentsFromWindowShouldNotRemoveComponentsInOtherWindows {
+	UIViewController* overlayVC = [self createMockedViewControllerWithWindow:[UIWindow new]];
+	UIViewController* componentVC = [self createMockedViewControllerWithWindow:[UIWindow new]];
+	
+	NSString* componentId = @"componentId";
+	NSString* overlayId = @"overlayId";
+	[self.store setComponent:overlayVC componentId:overlayId];
+	[self.store setComponent:componentVC componentId:componentId];
+	
+	[self.store removeAllComponentsFromWindow:componentVC.view.window];
+	XCTAssertNil([self.store findComponentForId:componentId]);
+	XCTAssertNotNil([self.store findComponentForId:overlayId]);
+}
+
 - (void)testGetExternalComponentShouldRetrunSavedComponent {
 	UIViewController* testVC = [UIViewController new];
 	RNNLayoutInfo* layoutInfo = [[RNNLayoutInfo alloc] init];
@@ -104,7 +128,7 @@
 	XCTAssertNil(result);
 }
 
--(void)testCleanStore {
+- (void)testCleanStore {
 	[self.store clean];
 	XCTAssertFalse(self.store.isReadyToReceiveCommands);
 }
@@ -121,6 +145,14 @@
 	}
 }
 
+- (UIViewController *)createMockedViewControllerWithWindow:(UIWindow *)window {
+	UIWindow* overlayWindow = [UIWindow new];
+	id mockedViewController = [OCMockObject partialMockForObject:[UIViewController new]];
+	id mockedView = [OCMockObject partialMockForObject:[UIView new]];
+	OCMStub([mockedView window]).andReturn(overlayWindow);
+	OCMStub([mockedViewController view]).andReturn(mockedView);
+	return mockedViewController;
+}
 
 
 @end

playground/src/screens/CustomDialog.js

@@ -19,6 +19,7 @@ class CustomDialog extends PureComponent {
         <Text style={styles.h1} testID={testIDs.DIALOG_HEADER}>Test view</Text>
         <Button title='OK' testID={testIDs.OK_BUTTON} onPress={() => this.onCLickOk()} />
         <Button title='Set Root' testID={testIDs.SET_ROOT_BUTTON} onPress={() => this.onCLickSetRoot()} />
+        <Button title='Set Intercept touch' testID={testIDs.SET_INTERCEPT_TOUCH} onPress={() => this.onCLickSetInterceptTouch()} />
       </View>
     );
   }
@@ -42,6 +43,14 @@ class CustomDialog extends PureComponent {
       }
     });
   }
+
+  onCLickSetInterceptTouch() {
+    Navigation.mergeOptions(this.props.componentId, {
+      overlay: {
+        interceptTouchOutside: false
+      }
+    });
+  }
 }
 
 const styles = {

playground/src/testIDs.js

@@ -76,6 +76,7 @@ module.exports = {
   SIDE_MENU_LAYOUT_INSIDE_BOTTOM_TAB: `SIDE_MENU_LAYOUT_INSIDE_BOTTOM_TAB`,
   OPEN_SIDE_MENU: `OPEN_SIDE_MENU`,
   SET_ROOT_BUTTON: `SET_ROOT_BUTTON`,
+  SET_INTERCEPT_TOUCH: `SET_INTERCEPT_TOUCH`,
   PUSH_BOTTOM_TABS_BUTTON: `PUSH_BOTTOM_TABS_BUTTON`,
   
   // Elements