Skip to content

Commit

Permalink
Fix a AppLifecycleTest present time race between the animation and th…
Browse files Browse the repository at this point in the history 
…e rest of the test (flutter#21107)
  • Loading branch information
@xster
xster authored Sep 14, 2020
1 parent 5602b7b commit 257eba9
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 87 deletions.
4 changes: 2 additions & 2 deletions testing/scenario_app/ios/Scenarios/Scenarios/ScreenBeforeFlutter.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

@interface ScreenBeforeFlutter : UIViewController

- (id)initWithEngineRunCompletion:(void (^)(void))engineRunCompletion;
- (FlutterViewController*)showFlutter;
- (id)initWithEngineRunCompletion:(dispatch_block_t)engineRunCompletion;
- (FlutterViewController*)showFlutter:(dispatch_block_t)showCompletion;

@property(nonatomic, readonly) FlutterEngine* engine;

Expand Down
8 changes: 4 additions & 4 deletions testing/scenario_app/ios/Scenarios/Scenarios/ScreenBeforeFlutter.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ @implementation ScreenBeforeFlutter

@synthesize engine = _engine;

- (id)initWithEngineRunCompletion:(void (^)(void))engineRunCompletion {
- (id)initWithEngineRunCompletion:(dispatch_block_t)engineRunCompletion {
self = [super init];
_engine = [[FlutterEngine alloc] initWithScenario:@"poppable_screen"
withCompletion:engineRunCompletion];
Expand All @@ -27,7 +27,7 @@ - (void)viewDidLoad {
showFlutterButton.tintColor = UIColor.whiteColor;
showFlutterButton.clipsToBounds = YES;
[showFlutterButton addTarget:self
action:@selector(showFlutter)
action:@selector(showFlutter:)
forControlEvents:UIControlEventTouchUpInside];

[self.view addSubview:showFlutterButton];
Expand All @@ -39,11 +39,11 @@ - (void)viewDidLoad {
[_engine runWithEntrypoint:nil];
}

- (FlutterViewController*)showFlutter {
- (FlutterViewController*)showFlutter:(dispatch_block_t)showCompletion {
FlutterViewController* flutterVC = [[FlutterViewController alloc] initWithEngine:_engine
nibName:nil
bundle:nil];
[self presentViewController:flutterVC animated:NO completion:nil];
[self presentViewController:flutterVC animated:NO completion:showCompletion];
return flutterVC;
}

Expand Down
174 changes: 93 additions & 81 deletions testing/scenario_app/ios/Scenarios/ScenariosTests/AppLifecycleTests.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,34 @@ - (void)setUp {
self.continueAfterFailure = NO;
}

// TODO(cbracken): re-enable this test by removing the skip_ prefix once the source of its flakiness
// has been identified. https://github.com/flutter/flutter/issues/61620
- (void)skip_testDismissedFlutterViewControllerNotRespondingToApplicationLifecycle {
XCTestExpectation* engineStartedExpectation = [self expectationWithDescription:@"Engine started"];
- (NSArray*)initialPresentLifecycles {
NSMutableArray* expectations =
[NSMutableArray arrayWithObject:[[XCAppLifecycleTestExpectation alloc]
initForLifecycle:@"AppLifecycleState.inactive"
forStep:@"showing a FlutterViewController"]];

// If the test is the very first test to run in the test target, the UIApplication may
// be in inactive state. Haven't found a good way to force it to go to active state.
// So just account for it in the initial lifecycle events with an extra resumed since
// the FlutterViewController tracks all view controller and application lifecycle events.
if ([UIApplication sharedApplication].applicationState != UIApplicationStateActive) {
[expectations addObject:[[XCAppLifecycleTestExpectation alloc]
initForLifecycle:@"AppLifecycleState.resumed"
forStep:@"showing a FlutterViewController"]];
}
[expectations addObject:[[XCAppLifecycleTestExpectation alloc]
initForLifecycle:@"AppLifecycleState.resumed"
forStep:@"showing a FlutterViewController"]];
return expectations;
}

- (void)testDismissedFlutterViewControllerNotRespondingToApplicationLifecycle {
XCTestExpectation* engineStartedExpectation = [self expectationWithDescription:@"Engine started"];
// Let the engine finish booting (at the end of which the channels are properly set-up) before
// moving onto the next step of showing the next view controller.
ScreenBeforeFlutter* rootVC = [[ScreenBeforeFlutter alloc] initWithEngineRunCompletion:^void() {
[engineStartedExpectation fulfill];
}];

[self waitForExpectationsWithTimeout:5 handler:nil];

UIApplication* application = UIApplication.sharedApplication;
Expand All @@ -61,36 +78,34 @@ - (void)skip_testDismissedFlutterViewControllerNotRespondingToApplicationLifecyc
NSMutableArray* lifecycleExpectations = [NSMutableArray arrayWithCapacity:10];

// Expected sequence from showing the FlutterViewController is inactive and resumed.
[lifecycleExpectations addObjectsFromArray:@[
[[XCAppLifecycleTestExpectation alloc] initForLifecycle:@"AppLifecycleState.inactive"
forStep:@"showing a FlutterViewController"],
[[XCAppLifecycleTestExpectation alloc] initForLifecycle:@"AppLifecycleState.resumed"
forStep:@"showing a FlutterViewController"]
]];
[lifecycleExpectations addObjectsFromArray:[self initialPresentLifecycles]];

[engine.lifecycleChannel setMessageHandler:^(id message, FlutterReply callback) {
if (lifecycleExpectations.count == 0) {
XCTFail(@"Unexpected lifecycle transition: %@", message);
return;
}
XCAppLifecycleTestExpectation* nextExpectation = [lifecycleExpectations objectAtIndex:0];
if (![[nextExpectation expectedLifecycle] isEqualToString:message]) {
XCTFail(@"Expected lifecycle %@ but instead received %@", [nextExpectation expectedLifecycle],
message);
return;
}

[nextExpectation fulfill];
[lifecycleExpectations removeObjectAtIndex:0];
}];

FlutterViewController* flutterVC;
@autoreleasepool {
// Holding onto this FlutterViewController is consequential here. Since a released
// FlutterViewController wouldn't keep listening to the application lifecycle events and produce
// false positives for the application lifecycle tests further below.
flutterVC = [rootVC showFlutter];
NSLog(@"FlutterViewController instance %@ created", flutterVC);
[engine.lifecycleChannel setMessageHandler:^(id message, FlutterReply callback) {
if (lifecycleExpectations.count == 0) {
XCTFail(@"Unexpected lifecycle transition: %@", message);
return;
}
XCAppLifecycleTestExpectation* nextExpectation = [lifecycleExpectations objectAtIndex:0];
if (![[nextExpectation expectedLifecycle] isEqualToString:message]) {
XCTFail(@"Expected lifecycle %@ but instead received %@",
[nextExpectation expectedLifecycle], message);
return;
}

[nextExpectation fulfill];
[lifecycleExpectations removeObjectAtIndex:0];
XCTestExpectation* vcShown = [self expectationWithDescription:@"present"];
flutterVC = [rootVC showFlutter:^{
[vcShown fulfill];
}];

[self waitForExpectationsWithTimeout:5.0 handler:nil];
// The expectations list isn't dequeued by the message handler yet.
[self waitForExpectations:lifecycleExpectations timeout:5 enforceOrder:YES];

Expand Down Expand Up @@ -150,7 +165,11 @@ - (void)skip_testDismissedFlutterViewControllerNotRespondingToApplicationLifecyc
]];

@autoreleasepool {
flutterVC = [rootVC showFlutter];
XCTestExpectation* vcShown = [self expectationWithDescription:@"present"];
flutterVC = [rootVC showFlutter:^{
[vcShown fulfill];
}];
[self waitForExpectationsWithTimeout:5.0 handler:nil];
NSLog(@"FlutterViewController instance %@ created", flutterVC);
[self waitForExpectations:lifecycleExpectations timeout:5 enforceOrder:YES];

Expand Down Expand Up @@ -178,9 +197,7 @@ - (void)skip_testDismissedFlutterViewControllerNotRespondingToApplicationLifecyc
[engine destroyContext];
}

// TODO(cbracken): re-enable this test by removing the skip_ prefix once the source of its flakiness
// has been identified. https://github.com/flutter/flutter/issues/61620
- (void)skip_testVisibleFlutterViewControllerRespondsToApplicationLifecycle {
- (void)testVisibleFlutterViewControllerRespondsToApplicationLifecycle {
XCTestExpectation* engineStartedExpectation = [self expectationWithDescription:@"Engine started"];

// Let the engine finish booting (at the end of which the channels are properly set-up) before
Expand All @@ -198,33 +215,31 @@ - (void)skip_testVisibleFlutterViewControllerRespondsToApplicationLifecycle {
NSMutableArray* lifecycleExpectations = [NSMutableArray arrayWithCapacity:10];

// Expected sequence from showing the FlutterViewController is inactive and resumed.
[lifecycleExpectations addObjectsFromArray:@[
[[XCAppLifecycleTestExpectation alloc] initForLifecycle:@"AppLifecycleState.inactive"
forStep:@"showing a FlutterViewController"],
[[XCAppLifecycleTestExpectation alloc] initForLifecycle:@"AppLifecycleState.resumed"
forStep:@"showing a FlutterViewController"]
]];
[lifecycleExpectations addObjectsFromArray:[self initialPresentLifecycles]];

[engine.lifecycleChannel setMessageHandler:^(id message, FlutterReply callback) {
if (lifecycleExpectations.count == 0) {
XCTFail(@"Unexpected lifecycle transition: %@", message);
return;
}
XCAppLifecycleTestExpectation* nextExpectation = [lifecycleExpectations objectAtIndex:0];
if (![[nextExpectation expectedLifecycle] isEqualToString:message]) {
XCTFail(@"Expected lifecycle %@ but instead received %@", [nextExpectation expectedLifecycle],
message);
return;
}

[nextExpectation fulfill];
[lifecycleExpectations removeObjectAtIndex:0];
}];

FlutterViewController* flutterVC;
@autoreleasepool {
flutterVC = [rootVC showFlutter];
NSLog(@"FlutterViewController instance %@ created", flutterVC);
[engine.lifecycleChannel setMessageHandler:^(id message, FlutterReply callback) {
if (lifecycleExpectations.count == 0) {
XCTFail(@"Unexpected lifecycle transition: %@", message);
return;
}
XCAppLifecycleTestExpectation* nextExpectation = [lifecycleExpectations objectAtIndex:0];
if (![[nextExpectation expectedLifecycle] isEqualToString:message]) {
XCTFail(@"Expected lifecycle %@ but instead received %@",
[nextExpectation expectedLifecycle], message);
return;
}

[nextExpectation fulfill];
[lifecycleExpectations removeObjectAtIndex:0];
XCTestExpectation* vcShown = [self expectationWithDescription:@"present"];
flutterVC = [rootVC showFlutter:^{
[vcShown fulfill];
}];

[self waitForExpectationsWithTimeout:5.0 handler:nil];
[self waitForExpectations:lifecycleExpectations timeout:5];

// Now put the FlutterViewController into background.
Expand Down Expand Up @@ -285,9 +300,7 @@ - (void)skip_testVisibleFlutterViewControllerRespondsToApplicationLifecycle {
[engine destroyContext];
}

// TODO(cbracken): re-enable this test by removing the skip_ prefix once the source of its flakiness
// has been identified. https://github.com/flutter/flutter/issues/61620
- (void)skip_testFlutterViewControllerDetachingSendsApplicationLifecycle {
- (void)testFlutterViewControllerDetachingSendsApplicationLifecycle {
XCTestExpectation* engineStartedExpectation = [self expectationWithDescription:@"Engine started"];

// Let the engine finish booting (at the end of which the channels are properly set-up) before
Expand All @@ -305,34 +318,33 @@ - (void)skip_testFlutterViewControllerDetachingSendsApplicationLifecycle {
NSMutableArray* lifecycleExpectations = [NSMutableArray arrayWithCapacity:10];

// Expected sequence from showing the FlutterViewController is inactive and resumed.
[lifecycleExpectations addObjectsFromArray:@[
[[XCAppLifecycleTestExpectation alloc] initForLifecycle:@"AppLifecycleState.inactive"
forStep:@"showing a FlutterViewController"],
[[XCAppLifecycleTestExpectation alloc] initForLifecycle:@"AppLifecycleState.resumed"
forStep:@"showing a FlutterViewController"]
]];
[lifecycleExpectations addObjectsFromArray:[self initialPresentLifecycles]];

[engine.lifecycleChannel setMessageHandler:^(id message, FlutterReply callback) {
if (lifecycleExpectations.count == 0) {
XCTFail(@"Unexpected lifecycle transition: %@", message);
return;
}
XCAppLifecycleTestExpectation* nextExpectation = [lifecycleExpectations objectAtIndex:0];
if (![[nextExpectation expectedLifecycle] isEqualToString:message]) {
XCTFail(@"Expected lifecycle %@ but instead received %@", [nextExpectation expectedLifecycle],
message);
return;
}

[nextExpectation fulfill];
[lifecycleExpectations removeObjectAtIndex:0];
}];

// At the end of Flutter VC, we want to make sure it deallocs and sends detached signal.
// Using autoreleasepool will guarantee that.
FlutterViewController* flutterVC;
@autoreleasepool {
flutterVC = [rootVC showFlutter];
NSLog(@"FlutterViewController instance %@ created", flutterVC);
[engine.lifecycleChannel setMessageHandler:^(id message, FlutterReply callback) {
if (lifecycleExpectations.count == 0) {
XCTFail(@"Unexpected lifecycle transition: %@", message);
return;
}
XCAppLifecycleTestExpectation* nextExpectation = [lifecycleExpectations objectAtIndex:0];
if (![[nextExpectation expectedLifecycle] isEqualToString:message]) {
XCTFail(@"Expected lifecycle %@ but instead received %@",
[nextExpectation expectedLifecycle], message);
return;
}

[nextExpectation fulfill];
[lifecycleExpectations removeObjectAtIndex:0];
XCTestExpectation* vcShown = [self expectationWithDescription:@"present"];
flutterVC = [rootVC showFlutter:^{
[vcShown fulfill];
}];

[self waitForExpectationsWithTimeout:5.0 handler:nil];
[self waitForExpectations:lifecycleExpectations timeout:5];

// Starts dealloc flutter VC.
Expand Down

0 comments on commit 257eba9

Please sign in to comment.