Refactored modals (#3917)

* Refactored modals

* Added unit tests for modals

* fixes unknown modal dismissing and added tests

lib/ios/RNNCommandsHandler.m

@@ -24,6 +24,10 @@ static NSString* const dismissOverlay	= @"dismissOverlay";
 static NSString* const mergeOptions	= @"mergeOptions";
 static NSString* const setDefaultOptions	= @"setDefaultOptions";
 
+@interface RNNCommandsHandler() <RNNModalManagerDelegate>
+
+@end
+
 @implementation RNNCommandsHandler {
 	RNNControllerFactory *_controllerFactory;
 	RNNStore *_store;
@@ -38,7 +42,8 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 	_store = store;
 	_controllerFactory = controllerFactory;
 	_eventEmitter = eventEmitter;
-	_modalManager = [[RNNModalManager alloc] initWithStore:_store];
+	_modalManager = [[RNNModalManager alloc] init];
+	_modalManager.delegate = self;
 	_stackManager = [[RNNNavigationStackManager alloc] init];
 	_overlayManager = [[RNNOverlayManager alloc] init];
 	return self;
@@ -222,8 +227,8 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 	[CATransaction setCompletionBlock:^{
 		[_eventEmitter sendOnNavigationCommandCompletion:dismissModal params:@{@"componentId": componentId}];
 	}];
-	
-	[_modalManager dismissModal:componentId completion:completion];
+	UIViewController<RNNRootViewProtocol> *modalToDismiss = (UIViewController<RNNRootViewProtocol>*)[_store findComponentForId:componentId];
+	[_modalManager dismissModal:modalToDismiss completion:completion];
 	
 	[CATransaction commit];
 }
@@ -280,4 +285,16 @@ static NSString* const setDefaultOptions	= @"setDefaultOptions";
 	}
 }
 
+#pragma mark - RNNModalManagerDelegate
+
+- (void)dismissedModal:(UIViewController *)viewController {
+	[_eventEmitter sendModalsDismissedEvent:((RNNRootViewController *)viewController).componentId numberOfModalsDismissed:@(1)];
+}
+
+- (void)dismissedMultipleModals:(NSArray *)viewControllers {
+	if (viewControllers && viewControllers.count) {
+		[_eventEmitter sendModalsDismissedEvent:((RNNRootViewController *)viewControllers.lastObject).componentId numberOfModalsDismissed:@(viewControllers.count)];
+	}
+}
+
 @end

lib/ios/RNNEventEmitter.h

@@ -22,4 +22,6 @@
 
 -(void)sendOnSearchBarCancelPressed:(NSString *)componentId;
 
+- (void)sendModalsDismissedEvent:(NSString *)componentId numberOfModalsDismissed:(NSNumber *)modalsDismissed;
+
 @end

lib/ios/RNNEventEmitter.m

@@ -92,6 +92,13 @@ static NSString* const SearchBarCancelPressed 	= @"RNN.SearchBarCancelPressed";
 											}];
 }
 
+- (void)sendModalsDismissedEvent:(NSString *)componentId numberOfModalsDismissed:(NSNumber *)modalsDismissed {
+	[self send:ModalDismissed body:@{
+											 @"componentId": componentId,
+											 @"modalsDismissed": modalsDismissed
+											 }];
+}
+
 - (void)addListener:(NSString *)eventName {
 	[super addListener:eventName];
 	if ([eventName isEqualToString:AppLaunched]) {

lib/ios/RNNModalManager.h

@@ -2,13 +2,20 @@
 #import <UIKit/UIKit.h>
 #import "RNNStore.h"
 
+@protocol RNNModalManagerDelegate <NSObject>
+
+- (void)dismissedModal:(UIViewController *)viewController;
+- (void)dismissedMultipleModals:(NSArray *)viewControllers;
+
+@end
+
 @interface RNNModalManager : NSObject
 
 @property (nonatomic, strong) UIViewController<RNNRootViewProtocol>* toVC;
+@property (nonatomic, weak) id<RNNModalManagerDelegate> delegate;
 
-- (instancetype)initWithStore:(RNNStore*)store;
 - (void)showModal:(UIViewController*)viewController animated:(BOOL)animated completion:(RNNTransitionWithComponentIdCompletionBlock)completion;
-- (void)dismissModal:(NSString *)componentId completion:(RNNTransitionCompletionBlock)completion;
+- (void)dismissModal:(UIViewController *)viewController completion:(RNNTransitionCompletionBlock)completion;
 - (void)dismissAllModals;
 
 @end

lib/ios/RNNModalManager.m

@@ -2,14 +2,17 @@
 #import "RNNRootViewController.h"
 
 @implementation RNNModalManager {
-	RNNStore *_store;
 	RNNTransitionWithComponentIdCompletionBlock _completionBlock;
+	NSMutableArray* _pendingModalIdsToDismiss;
+	NSMutableArray* _presentedModals;
 }
 
 
--(instancetype)initWithStore:(RNNStore*)store {
+-(instancetype)init {
 	self = [super init];
-	_store = store;
+	_pendingModalIdsToDismiss = [[NSMutableArray alloc] init];
+	_presentedModals = [[NSMutableArray alloc] init];
+
 	return self;
 }
 
@@ -30,6 +33,9 @@
 			_completionBlock(self.toVC.getLeafViewController.componentId);
 			_completionBlock = nil;
 		}
+		
+		[_presentedModals addObject:self.toVC.getLeafViewController];
+		
 		self.toVC = nil;
 	}];
 }
@@ -55,23 +61,26 @@
 	}
 }
 
-- (void)dismissModal:(NSString *)componentId completion:(RNNTransitionCompletionBlock)completion {
-	[[_store pendingModalIdsToDismiss] addObject:componentId];
-	[self removePendingNextModalIfOnTop:completion];
+- (void)dismissModal:(UIViewController *)viewController completion:(RNNTransitionCompletionBlock)completion {
+	if (viewController) {
+		[_pendingModalIdsToDismiss addObject:viewController];
+		[self removePendingNextModalIfOnTop:completion];
+	}
 }
 
 -(void)dismissAllModals {
 	UIViewController *root = UIApplication.sharedApplication.delegate.window.rootViewController;
 	[root dismissViewControllerAnimated:YES completion:nil];
-	[[_store pendingModalIdsToDismiss] removeAllObjects];
+	[_delegate dismissedMultipleModals:_presentedModals];
+	[_pendingModalIdsToDismiss removeAllObjects];
+	[_presentedModals removeAllObjects];
 }
 
 #pragma mark - private
 
 
 -(void)removePendingNextModalIfOnTop:(RNNTransitionCompletionBlock)completion {
-	NSString *componentId = [[_store pendingModalIdsToDismiss] lastObject];
-	UIViewController<RNNRootViewProtocol> *modalToDismiss = (UIViewController<RNNRootViewProtocol>*)[_store findComponentForId:componentId];
+	UIViewController<RNNRootViewProtocol> *modalToDismiss = [_pendingModalIdsToDismiss lastObject];
 	RNNNavigationOptions* options = modalToDismiss.getLeafViewController.options;
 
 	if(!modalToDismiss) {
@@ -86,8 +95,10 @@
 
 	if (modalToDismiss == topPresentedVC || [[topPresentedVC childViewControllers] containsObject:modalToDismiss]) {
 		[modalToDismiss dismissViewControllerAnimated:options.animations.dismissModal.enable completion:^{
-			[[_store pendingModalIdsToDismiss] removeObject:componentId];
-			[_store removeComponent:componentId];
+			[_pendingModalIdsToDismiss removeObject:modalToDismiss];
+			if (modalToDismiss.view) {
+				[self dismissedModal:modalToDismiss];
+			}
 			
 			if (completion) {
 				completion();
@@ -98,12 +109,20 @@
 	} else {
 		[modalToDismiss.view removeFromSuperview];
 		modalToDismiss.view = nil;
+		modalToDismiss.getLeafViewController.options.animations.dismissModal.enable = NO;
+		[self dismissedModal:modalToDismiss];
+		
 		if (completion) {
 			completion();
 		}
 	}
 }
 
+- (void)dismissedModal:(UIViewController *)viewController {
+	[_presentedModals removeObject:viewController];
+	[_delegate dismissedModal:viewController];
+}
+
 -(UIViewController*)topPresentedVC {
 	UIViewController *root = UIApplication.sharedApplication.delegate.window.rootViewController;
 	while(root.presentedViewController) {

lib/ios/RNNStore.h

@@ -23,8 +23,6 @@ typedef void (^RNNTransitionRejectionBlock)(NSString *code, NSString *message, N
 -(void) setReadyToReceiveCommands:(BOOL)isReady;
 -(BOOL) isReadyToReceiveCommands;
 
--(NSMutableArray*) pendingModalIdsToDismiss;
-
 -(void) clean;
 
 @end

lib/ios/RNNStore.m

@@ -7,7 +7,6 @@
 
 @implementation RNNStore {
 	NSMapTable* _componentStore;
-	NSMutableArray* _pendingModalIdsToDismiss;
 	NSMutableDictionary* _externalComponentCreators;
 	BOOL _isReadyToReceiveCommands;
 }
@@ -16,7 +15,6 @@
 	self = [super init];
 	_isReadyToReceiveCommands = false;
 	_componentStore = [NSMapTable strongToWeakObjectsMapTable];
-	_pendingModalIdsToDismiss = [NSMutableArray new];
 	_externalComponentCreators = [NSMutableDictionary new];
 	return self;
 }
@@ -53,13 +51,8 @@
 	return _isReadyToReceiveCommands;
 }
 
--(NSMutableArray *)pendingModalIdsToDismiss {
-	return _pendingModalIdsToDismiss;
-}
-
 -(void)clean {
 	_isReadyToReceiveCommands = false;
-	[_pendingModalIdsToDismiss removeAllObjects];
 	[_componentStore removeAllObjects];
 }
 

lib/ios/ReactNativeNavigationTests/RNNCommandsHandlerTest.m

@@ -70,6 +70,8 @@
 	[skipMethods addObject:@"assertReady"];
 	[skipMethods addObject:@"removePopedViewControllers:"];
 	[skipMethods addObject:@".cxx_destruct"];
+	[skipMethods addObject:@"dismissedModal:"];
+	[skipMethods addObject:@"dismissedMultipleModals:"];
 
 	NSMutableArray* result = [NSMutableArray new];
 

lib/ios/ReactNativeNavigationTests/RNNModalManagerTest.m

@@ -1,22 +1,109 @@
 #import <XCTest/XCTest.h>
 #import "RNNModalManager.h"
 
-@interface RNNModalManagerTest : XCTestCase
+@interface MockViewController : UIViewController
+@end
+@implementation MockViewController
+
+- (void)presentViewController:(UIViewController *)viewControllerToPresent animated:(BOOL)flag completion:(void (^)(void))completion {
+	completion();
+}
+
+@end
+
+@interface MockModalManager : RNNModalManager
+@end
+@implementation MockModalManager
+
+-(UIViewController*)topPresentedVC {
+	MockViewController* vc = [MockViewController new];
+	return vc;
+}
 
 @end
 
-@implementation RNNModalManagerTest
+@interface RNNModalManagerTest : XCTestCase <RNNModalManagerDelegate> {
+	CGFloat _modalDismissedCount;
+}
+
+@end
+
+@implementation RNNModalManagerTest {
+	RNNRootViewController* _vc1;
+	RNNRootViewController* _vc2;
+	RNNRootViewController* _vc3;
+	MockModalManager* _modalManager;
+}
+
+- (void)setUp {
+	[super setUp];
+	_vc1 = [RNNRootViewController new];
+	_vc2 = [RNNRootViewController new];
+	_vc3 = [RNNRootViewController new];
+	_modalManager = [[MockModalManager alloc] init];
+}
+- (void)testDismissMultipleModalsInvokeDelegateWithCorrectParameters {
+	[_modalManager showModal:_vc1 animated:NO completion:nil];
+	[_modalManager showModal:_vc2 animated:NO completion:nil];
+	[_modalManager showModal:_vc3 animated:NO completion:nil];
+	
+	_modalManager.delegate = self;
+	[_modalManager dismissAllModals];
+	
+	XCTAssertTrue(_modalDismissedCount == 3);
+}
+
+- (void)testDismissModal_InvokeDelegateWithCorrectParameters {
+	[_modalManager showModal:_vc1 animated:NO completion:nil];
+	[_modalManager showModal:_vc2 animated:NO completion:nil];
+	[_modalManager showModal:_vc3 animated:NO completion:nil];
+	
+	_modalManager.delegate = self;
+	[_modalManager dismissModal:_vc3 completion:nil];
+	
+	XCTAssertTrue(_modalDismissedCount == 1);
+}
+
+- (void)testDismissPreviousModal_InvokeDelegateWithCorrectParameters {
+	[_modalManager showModal:_vc1 animated:NO completion:nil];
+	[_modalManager showModal:_vc2 animated:NO completion:nil];
+	[_modalManager showModal:_vc3 animated:NO completion:nil];
+	
+	_modalManager.delegate = self;
+	[_modalManager dismissModal:_vc2 completion:nil];
+	
+	XCTAssertTrue(_modalDismissedCount == 1);
+}
 
-- (void)testDismissAllModalsCleansPendingModalsToDismiss {
-	RNNStore *store = [RNNStore new];
-	[[store pendingModalIdsToDismiss] addObject:@"modal_id_1"];
-	[[store pendingModalIdsToDismiss] addObject:@"modal_id_2"];
-	[[store pendingModalIdsToDismiss] addObject:@"modal_id_3"];
+- (void)testDismissAllModalsAfterDismissingPreviousModal_InvokeDelegateWithCorrectParameters {
+	[_modalManager showModal:_vc1 animated:NO completion:nil];
+	[_modalManager showModal:_vc2 animated:NO completion:nil];
+	[_modalManager showModal:_vc3 animated:NO completion:nil];
 	
-	RNNModalManager *modalManager = [[RNNModalManager alloc] initWithStore:store];
-	[modalManager dismissAllModals];
+	_modalManager.delegate = self;
+	[_modalManager dismissModal:_vc2 completion:nil];
 	
-	XCTAssertTrue([[store pendingModalIdsToDismiss] count] == 0);
+	XCTAssertTrue(_modalDismissedCount == 1);
+	[_modalManager dismissAllModals];
+	XCTAssertTrue(_modalDismissedCount == 2);
+}
+
+- (void)testDismissNilModal_doesntCrash {
+	_modalManager.delegate = self;
+	[_modalManager dismissModal:nil completion:nil];
+	
+	XCTAssertTrue(_modalDismissedCount == 0);
+}
+
+
+#pragma mark RNNModalManagerDelegate
+
+- (void)dismissedMultipleModals:(NSArray *)viewControllers {
+	_modalDismissedCount = viewControllers.count;
+}
+
+- (void)dismissedModal:(UIViewController *)viewController {
+	_modalDismissedCount = 1;
 }
 
 @end

lib/ios/ReactNativeNavigationTests/RNNStoreTest.m

@@ -105,7 +105,6 @@
 
 -(void)testCleanStore {
 	[self.store clean];
-	XCTAssertFalse(self.store.pendingModalIdsToDismiss.count);
 	XCTAssertFalse(self.store.isReadyToReceiveCommands);
 }