|
| 1 | +/* |
| 2 | + * Copyright (c) Meta Platforms, Inc. and affiliates. |
| 3 | + * |
| 4 | + * This source code is licensed under the MIT license found in the |
| 5 | + * LICENSE file in the root directory of this source tree. |
| 6 | + */ |
| 7 | + |
| 8 | +#import <CoreFoundation/CoreFoundation.h> |
| 9 | +#import <XCTest/XCTest.h> |
| 10 | + |
| 11 | +#import <React/RCTSurfacePresenter.h> |
| 12 | +#import <ReactCommon/RCTInstance.h> |
| 13 | + |
| 14 | +@interface RCTSchedulerLifetimeProbe : NSObject |
| 15 | +@property (nonatomic, weak) id delegate; |
| 16 | +@property (nonatomic, copy) void (^onDealloc)(BOOL onMainThread); |
| 17 | +@property (nonatomic, copy) void (^onStopObserving)(BOOL onMainThread); |
| 18 | +@property (nonatomic, copy) dispatch_block_t onTick; |
| 19 | +- (void)startObserving; |
| 20 | +- (void)stopObservingLayoutAnimations; |
| 21 | +@end |
| 22 | + |
| 23 | +@implementation RCTSchedulerLifetimeProbe { |
| 24 | + CFRunLoopObserverRef _observer; |
| 25 | +} |
| 26 | + |
| 27 | +- (void)startObserving |
| 28 | +{ |
| 29 | + void *unretainedSelf = (__bridge void *)self; |
| 30 | + _observer = CFRunLoopObserverCreateWithHandler( |
| 31 | + kCFAllocatorDefault, kCFRunLoopBeforeWaiting, true, 0, ^(CFRunLoopObserverRef, CFRunLoopActivity) { |
| 32 | + __unsafe_unretained RCTSchedulerLifetimeProbe *probe = (__bridge RCTSchedulerLifetimeProbe *)unretainedSelf; |
| 33 | + dispatch_block_t tick = probe.onTick; |
| 34 | + if (tick) { |
| 35 | + tick(); |
| 36 | + } |
| 37 | + }); |
| 38 | + CFRunLoopAddObserver(CFRunLoopGetMain(), _observer, kCFRunLoopCommonModes); |
| 39 | +} |
| 40 | + |
| 41 | +- (void)stopObservingLayoutAnimations |
| 42 | +{ |
| 43 | + if (_observer) { |
| 44 | + CFRunLoopRemoveObserver(CFRunLoopGetMain(), _observer, kCFRunLoopCommonModes); |
| 45 | + CFRelease(_observer); |
| 46 | + _observer = nullptr; |
| 47 | + } |
| 48 | + if (_onStopObserving) { |
| 49 | + _onStopObserving([NSThread isMainThread]); |
| 50 | + } |
| 51 | +} |
| 52 | + |
| 53 | +- (void)dealloc |
| 54 | +{ |
| 55 | + if (_observer) { |
| 56 | + CFRunLoopRemoveObserver(CFRunLoopGetMain(), _observer, kCFRunLoopCommonModes); |
| 57 | + CFRelease(_observer); |
| 58 | + } |
| 59 | + if (_onDealloc) { |
| 60 | + _onDealloc([NSThread isMainThread]); |
| 61 | + } |
| 62 | +} |
| 63 | +@end |
| 64 | + |
| 65 | +@interface RCTJSThreadManagerStub : NSObject |
| 66 | +@property (nonatomic, copy) dispatch_block_t pendingWork; |
| 67 | +@end |
| 68 | + |
| 69 | +@implementation RCTJSThreadManagerStub |
| 70 | +- (void)dispatchToJSThread:(dispatch_block_t)work |
| 71 | +{ |
| 72 | + self.pendingWork = work; |
| 73 | +} |
| 74 | +@end |
| 75 | + |
| 76 | +@interface RCTInstanceInvalidationTests : XCTestCase |
| 77 | +@end |
| 78 | + |
| 79 | +@implementation RCTInstanceInvalidationTests |
| 80 | + |
| 81 | +- (void)runJSWork:(dispatch_block_t)work |
| 82 | +{ |
| 83 | + dispatch_semaphore_t finished = dispatch_semaphore_create(0); |
| 84 | + dispatch_async(dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0), ^{ |
| 85 | + @autoreleasepool { |
| 86 | + work(); |
| 87 | + } |
| 88 | + dispatch_semaphore_signal(finished); |
| 89 | + }); |
| 90 | + XCTAssertEqual(dispatch_semaphore_wait(finished, dispatch_time(DISPATCH_TIME_NOW, 3 * NSEC_PER_SEC)), 0); |
| 91 | +} |
| 92 | + |
| 93 | +- (void)testInvalidateStopsObserverOnMainAndReleasesSchedulerDuringJSCleanup |
| 94 | +{ |
| 95 | + XCTAssertTrue([NSThread isMainThread]); |
| 96 | + RCTSurfacePresenter *presenter = [RCTSurfacePresenter new]; |
| 97 | + RCTJSThreadManagerStub *jsThreadManager = [RCTJSThreadManagerStub new]; |
| 98 | + RCTInstance *instance = [RCTInstance new]; |
| 99 | + [instance setValue:presenter forKey:@"surfacePresenter"]; |
| 100 | + [instance setValue:jsThreadManager forKey:@"jsThreadManager"]; |
| 101 | + |
| 102 | + XCTestExpectation *released = [self expectationWithDescription:@"Scheduler released during JS cleanup"]; |
| 103 | + __block BOOL observerStoppedOnMain = NO; |
| 104 | + __block BOOL releasedBeforeJSThreadCleanup = NO; |
| 105 | + __weak RCTInstance *weakInstance = instance; |
| 106 | + __weak RCTSchedulerLifetimeProbe *weakScheduler; |
| 107 | + @autoreleasepool { |
| 108 | + RCTSchedulerLifetimeProbe *scheduler = [RCTSchedulerLifetimeProbe new]; |
| 109 | + scheduler.delegate = presenter; |
| 110 | + scheduler.onStopObserving = ^(BOOL onMainThread) { |
| 111 | + observerStoppedOnMain = onMainThread; |
| 112 | + }; |
| 113 | + scheduler.onDealloc = ^(BOOL) { |
| 114 | + releasedBeforeJSThreadCleanup = [weakInstance valueForKey:@"jsThreadManager"] != nil; |
| 115 | + [released fulfill]; |
| 116 | + }; |
| 117 | + weakScheduler = scheduler; |
| 118 | + // Exercise real instance invalidation and presenter suspension without a JS VM. |
| 119 | + [presenter setValue:scheduler forKey:@"scheduler"]; |
| 120 | + } |
| 121 | + |
| 122 | + @autoreleasepool { |
| 123 | + [instance invalidate]; |
| 124 | + XCTAssertNil(presenter.scheduler); |
| 125 | + XCTAssertNotNil(weakScheduler); |
| 126 | + XCTAssertNil(weakScheduler.delegate); |
| 127 | + XCTAssertNotNil(jsThreadManager.pendingWork); |
| 128 | + XCTAssertTrue(observerStoppedOnMain); |
| 129 | + } |
| 130 | + |
| 131 | + dispatch_block_t drainWork = jsThreadManager.pendingWork; |
| 132 | + [self runJSWork:drainWork]; |
| 133 | + |
| 134 | + [self waitForExpectations:@[ released ] timeout:3]; |
| 135 | + XCTAssertTrue(releasedBeforeJSThreadCleanup); |
| 136 | + // Keeping the cleanup block itself must not keep the scheduler alive. |
| 137 | + XCTAssertNil(weakScheduler); |
| 138 | + XCTAssertNil([instance valueForKey:@"jsThreadManager"]); |
| 139 | + jsThreadManager.pendingWork = nil; |
| 140 | +} |
| 141 | + |
| 142 | +- (void)testStoppedObserverDoesNotRunWhileWaitingForJSCleanup |
| 143 | +{ |
| 144 | + XCTAssertTrue([NSThread isMainThread]); |
| 145 | + RCTSurfacePresenter *presenter = [RCTSurfacePresenter new]; |
| 146 | + RCTJSThreadManagerStub *jsThreadManager = [RCTJSThreadManagerStub new]; |
| 147 | + RCTInstance *instance = [RCTInstance new]; |
| 148 | + [instance setValue:presenter forKey:@"surfacePresenter"]; |
| 149 | + [instance setValue:jsThreadManager forKey:@"jsThreadManager"]; |
| 150 | + |
| 151 | + XCTestExpectation *noTick = [self expectationWithDescription:@"Stopped observer must not run"]; |
| 152 | + noTick.inverted = YES; |
| 153 | + XCTestExpectation *released = [self expectationWithDescription:@"Scheduler released during JS cleanup"]; |
| 154 | + __weak RCTSchedulerLifetimeProbe *weakScheduler; |
| 155 | + @autoreleasepool { |
| 156 | + RCTSchedulerLifetimeProbe *scheduler = [RCTSchedulerLifetimeProbe new]; |
| 157 | + weakScheduler = scheduler; |
| 158 | + scheduler.onDealloc = ^(BOOL) { |
| 159 | + [released fulfill]; |
| 160 | + }; |
| 161 | + scheduler.onTick = ^{ |
| 162 | + [noTick fulfill]; |
| 163 | + }; |
| 164 | + [presenter setValue:scheduler forKey:@"scheduler"]; |
| 165 | + [scheduler startObserving]; |
| 166 | + } |
| 167 | + |
| 168 | + @autoreleasepool { |
| 169 | + [instance invalidate]; |
| 170 | + } |
| 171 | + [self waitForExpectations:@[ noTick ] timeout:0.05]; |
| 172 | + XCTAssertNotNil(weakScheduler); |
| 173 | + [self runJSWork:jsThreadManager.pendingWork]; |
| 174 | + [self waitForExpectations:@[ released ] timeout:3]; |
| 175 | + XCTAssertNil(weakScheduler); |
| 176 | + XCTAssertNil([instance valueForKey:@"jsThreadManager"]); |
| 177 | + jsThreadManager.pendingWork = nil; |
| 178 | +} |
| 179 | + |
| 180 | +- (void)testInvalidateWithoutSchedulerCompletesJSThreadCleanup |
| 181 | +{ |
| 182 | + RCTSurfacePresenter *presenter = [RCTSurfacePresenter new]; |
| 183 | + RCTJSThreadManagerStub *jsThreadManager = [RCTJSThreadManagerStub new]; |
| 184 | + RCTInstance *instance = [RCTInstance new]; |
| 185 | + [instance setValue:presenter forKey:@"surfacePresenter"]; |
| 186 | + [instance setValue:jsThreadManager forKey:@"jsThreadManager"]; |
| 187 | + |
| 188 | + [instance invalidate]; |
| 189 | + XCTAssertNotNil(jsThreadManager.pendingWork); |
| 190 | + jsThreadManager.pendingWork(); |
| 191 | + XCTAssertNil(presenter.scheduler); |
| 192 | + XCTAssertNil([instance valueForKey:@"jsThreadManager"]); |
| 193 | + jsThreadManager.pendingWork = nil; |
| 194 | +} |
| 195 | + |
| 196 | +@end |
0 commit comments