[ReactNative] Use a single DisplayLink held by the bridge

tadeuzagallo · tadeuzagallo · commit 75e4e124fa51 · 2015-04-15T07:07:48.000-08:00
diff --git a/React/Base/RCTBridge.h b/React/Base/RCTBridge.h
@@ -10,6 +10,7 @@
 #import <UIKit/UIKit.h>
 
 #import "RCTBridgeModule.h"
+#import "RCTFrameUpdate.h"
 #import "RCTInvalidating.h"
 #import "RCTJavaScriptExecutor.h"
 
@@ -122,4 +123,14 @@ static const char *__rct_import_##module##_##method##__ = #module"."#method;
  */
 - (void)reload;
 
+/**
+ * Add a new observer that will be called on every screen refresh
+ */
+- (void)addFrameUpdateObserver:(id<RCTFrameUpdateObserver>)observer;
+
+/**
+ * Stop receiving screen refresh updates for the given observer
+ */
+- (void)removeFrameUpdateObserver:(id<RCTFrameUpdateObserver>)observer;
+
 @end
diff --git a/React/Base/RCTBridge.m b/React/Base/RCTBridge.m
@@ -677,6 +677,73 @@ - (NSString *)description
   return localModules;
 }
 
+@interface RCTDisplayLink : NSObject <RCTInvalidating>
+
+- (instancetype)initWithBridge:(RCTBridge *)bridge NS_DESIGNATED_INITIALIZER;
+
+@end
+
+@interface RCTBridge (RCTDisplayLink)
+
+- (void)_update:(CADisplayLink *)displayLink;
+
+@end
+
+@implementation RCTDisplayLink
+{
+  __weak RCTBridge *_bridge;
+  CADisplayLink *_displayLink;
+}
+
+- (instancetype)initWithBridge:(RCTBridge *)bridge
+{
+  if ((self = [super init])) {
+    _bridge = bridge;
+    _displayLink = [CADisplayLink displayLinkWithTarget:self selector:@selector(_update:)];
+    [_displayLink addToRunLoop:[NSRunLoop mainRunLoop] forMode:NSRunLoopCommonModes];
+  }
+  return self;
+}
+
+- (BOOL)isValid
+{
+  return _displayLink != nil;
+}
+
+- (void)invalidate
+{
+  if (self.isValid) {
+    [_displayLink invalidate];
+    _displayLink = nil;
+  }
+}
+
+- (void)_update:(CADisplayLink *)displayLink
+{
+  [_bridge _update:displayLink];
+}
+
+@end
+
+@interface RCTFrameUpdate (Private)
+
+- (instancetype)initWithDisplayLink:(CADisplayLink *)displayLink;
+
+@end
+
+@implementation RCTFrameUpdate
+
+- (instancetype)initWithDisplayLink:(CADisplayLink *)displayLink
+{
+  if ((self = [super init])) {
+    _timestamp = displayLink.timestamp;
+    _deltaTime = displayLink.duration;
+  }
+  return self;
+}
+
+@end
+
 @implementation RCTBridge
 {
   RCTSparseArray *_modulesByID;
@@ -685,6 +752,8 @@ @implementation RCTBridge
   Class _executorClass;
   NSURL *_bundleURL;
   RCTBridgeModuleProviderBlock _moduleProvider;
+  RCTDisplayLink *_displayLink;
+  NSMutableSet *_frameUpdateObservers;
   BOOL _loading;
 }
 
@@ -711,6 +780,8 @@ - (void)setUp
   _latestJSExecutor = _javaScriptExecutor;
   _eventDispatcher = [[RCTEventDispatcher alloc] initWithBridge:self];
   _shadowQueue = dispatch_queue_create("com.facebook.React.ShadowQueue", DISPATCH_QUEUE_SERIAL);
+  _displayLink = [[RCTDisplayLink alloc] initWithBridge:self];
+  _frameUpdateObservers = [[NSMutableSet alloc] init];
 
   // Register passed-in module instances
   NSMutableDictionary *preregisteredModules = [[NSMutableDictionary alloc] init];
@@ -891,6 +962,9 @@ - (void)invalidate
   [_javaScriptExecutor invalidate];
   _javaScriptExecutor = nil;
 
+  [_displayLink invalidate];
+  _frameUpdateObservers = nil;
+
   // Invalidate modules
   for (id target in _modulesByID.allObjects) {
     if ([target respondsToSelector:@selector(invalidate)]) {
@@ -1075,6 +1149,26 @@ - (BOOL)_handleRequestNumber:(NSUInteger)i
   return YES;
 }
 
+- (void)_update:(CADisplayLink *)displayLink
+{
+  RCTFrameUpdate *frameUpdate = [[RCTFrameUpdate alloc] initWithDisplayLink:displayLink];
+  for (id<RCTFrameUpdateObserver> observer in _frameUpdateObservers) {
+    if (![observer respondsToSelector:@selector(isPaused)] || ![observer isPaused]) {
+      [observer didUpdateFrame:frameUpdate];
+    }
+  }
+}
+
+- (void)addFrameUpdateObserver:(id<RCTFrameUpdateObserver>)observer
+{
+  [_frameUpdateObservers addObject:observer];
+}
+
+- (void)removeFrameUpdateObserver:(id<RCTFrameUpdateObserver>)observer
+{
+  [_frameUpdateObservers removeObject:observer];
+}
+
 - (void)reload
 {
   if (!_loading) {
diff --git a/React/Base/RCTFrameUpdate.h b/React/Base/RCTFrameUpdate.h
@@ -0,0 +1,44 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+/**
+ * Interface containing the information about the last screen refresh.
+ */
+@interface RCTFrameUpdate : NSObject
+
+/**
+ * Timestamp for the actual screen refresh
+ */
+@property (nonatomic, readonly) NSTimeInterval timestamp;
+
+/**
+ * Time since the last frame update ( >= 16.6ms )
+ */
+@property (nonatomic, readonly) NSTimeInterval deltaTime;
+
+@end
+
+/**
+ * Protocol that must be implemented for subscribing to display refreshes (DisplayLink updates)
+ */
+@protocol RCTFrameUpdateObserver <NSObject>
+
+/**
+ * Method called on every screen refresh (if paused != YES)
+ */
+- (void)didUpdateFrame:(RCTFrameUpdate *)update;
+
+@optional
+
+/**
+ * Synthesize and set to true to pause the calls to -[didUpdateFrame:]
+ */
+@property (nonatomic, assign, getter=isPaused) BOOL paused;
+
+@end
diff --git a/React/Modules/RCTTiming.h b/React/Modules/RCTTiming.h
@@ -10,8 +10,9 @@
 #import <Foundation/Foundation.h>
 
 #import "RCTBridgeModule.h"
+#import "RCTFrameUpdate.h"
 #import "RCTInvalidating.h"
 
-@interface RCTTiming : NSObject <RCTBridgeModule, RCTInvalidating>
+@interface RCTTiming : NSObject <RCTBridgeModule, RCTInvalidating, RCTFrameUpdateObserver>
 
 @end
diff --git a/React/Modules/RCTTiming.m b/React/Modules/RCTTiming.m
@@ -58,7 +58,6 @@ - (BOOL)updateFoundNeedsJSUpdate
 @implementation RCTTiming
 {
   RCTSparseArray *_timers;
-  id _updateTimer;
 }
 
 @synthesize bridge = _bridge;
@@ -113,32 +112,21 @@ - (void)invalidate
 
 - (void)stopTimers
 {
-  [_updateTimer invalidate];
-  _updateTimer = nil;
+  [_bridge removeFrameUpdateObserver:self];
 }
 
 - (void)startTimers
 {
   RCTAssertMainThread();
 
-  if (![self isValid] || _updateTimer != nil || _timers.count == 0) {
+  if (![self isValid] || _timers.count == 0) {
     return;
   }
 
-  _updateTimer = [CADisplayLink displayLinkWithTarget:self selector:@selector(update)];
-  if (_updateTimer) {
-    [_updateTimer addToRunLoop:[NSRunLoop mainRunLoop] forMode:NSDefaultRunLoopMode];
-  } else {
-    RCTLogWarn(@"Failed to create a display link (probably on buildbot) - using an NSTimer for AppEngine instead.");
-    _updateTimer = [NSTimer scheduledTimerWithTimeInterval:(1.0 / 60)
-                                                    target:self
-                                                  selector:@selector(update)
-                                                  userInfo:nil
-                                                   repeats:YES];
-  }
+  [_bridge addFrameUpdateObserver:self];
 }
 
-- (void)update
+- (void)didUpdateFrame:(RCTFrameUpdate *)update
 {
   RCTAssertMainThread();
 
diff --git a/React/React.xcodeproj/project.pbxproj b/React/React.xcodeproj/project.pbxproj
@@ -154,6 +154,7 @@
 		13E067541A70F44B002CDEE1 /* UIView+React.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "UIView+React.m"; sourceTree = "<group>"; };
 		14200DA81AC179B3008EE6BA /* RCTJavaScriptLoader.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = RCTJavaScriptLoader.h; sourceTree = "<group>"; };
 		14200DA91AC179B3008EE6BA /* RCTJavaScriptLoader.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTJavaScriptLoader.m; sourceTree = "<group>"; };
+		1436DD071ADE7AA000A5ED7D /* RCTFrameUpdate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = RCTFrameUpdate.h; sourceTree = "<group>"; };
 		14435CE11AAC4AE100FC20F4 /* RCTMap.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = RCTMap.h; sourceTree = "<group>"; };
 		14435CE21AAC4AE100FC20F4 /* RCTMap.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTMap.m; sourceTree = "<group>"; };
 		14435CE31AAC4AE100FC20F4 /* RCTMapManager.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = RCTMapManager.h; sourceTree = "<group>"; };
@@ -391,6 +392,7 @@
 				83CBBA971A6020BB00E9B192 /* RCTTouchHandler.m */,
 				83CBBA4F1A601E3B00E9B192 /* RCTUtils.h */,
 				83CBBA501A601E3B00E9B192 /* RCTUtils.m */,
+				1436DD071ADE7AA000A5ED7D /* RCTFrameUpdate.h */,
 			);
 			path = Base;
 			sourceTree = "<group>";
diff --git a/React/Views/RCTNavigator.h b/React/Views/RCTNavigator.h
@@ -9,16 +9,17 @@
 
 #import <UIKit/UIKit.h>
 
+#import "RCTFrameUpdate.h"
 #import "RCTInvalidating.h"
 
-@class RCTEventDispatcher;
+@class RCTBridge;
 
-@interface RCTNavigator : UIView <RCTInvalidating>
+@interface RCTNavigator : UIView <RCTFrameUpdateObserver>
 
 @property (nonatomic, strong) UIView *reactNavSuperviewLink;
 @property (nonatomic, assign) NSInteger requestedTopOfStack;
 
-- (instancetype)initWithEventDispatcher:(RCTEventDispatcher *)eventDispatcher NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithBridge:(RCTBridge *)bridge NS_DESIGNATED_INITIALIZER;
 
 /**
  * Schedules a JavaScript navigation and prevents `UIKit` from navigating until
diff --git a/React/Views/RCTNavigator.m b/React/Views/RCTNavigator.m
diff --git a/React/Views/RCTNavigatorManager.m b/React/Views/RCTNavigatorManager.m

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,6 @@ - (BOOL)updateFoundNeedsJSUpdate`
`58`	`58`	`@implementation RCTTiming`
`59`	`59`	`{`
`60`	`60`	`RCTSparseArray *_timers;`
`61`		`- id _updateTimer;`
`62`	`61`	`}`
`63`	`62`
`64`	`63`	`@synthesize bridge = _bridge;`
`@@ -113,32 +112,21 @@ - (void)invalidate`
`113`	`112`
`114`	`113`	`- (void)stopTimers`
`115`	`114`	`{`
`116`		`- [_updateTimer invalidate];`
`117`		`- _updateTimer = nil;`
	`115`	`+ [_bridge removeFrameUpdateObserver:self];`
`118`	`116`	`}`
`119`	`117`
`120`	`118`	`- (void)startTimers`
`121`	`119`	`{`
`122`	`120`	`RCTAssertMainThread();`
`123`	`121`
`124`		`- if (![self isValid] \|\| _updateTimer != nil \|\| _timers.count == 0) {`
	`122`	`+ if (![self isValid] \|\| _timers.count == 0) {`
`125`	`123`	`return;`
`126`	`124`	`}`
`127`	`125`
`128`		`- _updateTimer = [CADisplayLink displayLinkWithTarget:self selector:@selector(update)];`
`129`		`- if (_updateTimer) {`
`130`		`- [_updateTimer addToRunLoop:[NSRunLoop mainRunLoop] forMode:NSDefaultRunLoopMode];`
`131`		`- } else {`
`132`		`- RCTLogWarn(@"Failed to create a display link (probably on buildbot) - using an NSTimer for AppEngine instead.");`
`133`		`- _updateTimer = [NSTimer scheduledTimerWithTimeInterval:(1.0 / 60)`
`134`		`- target:self`
`135`		`- selector:@selector(update)`
`136`		`- userInfo:nil`
`137`		`- repeats:YES];`
`138`		`- }`
	`126`	`+ [_bridge addFrameUpdateObserver:self];`
`139`	`127`	`}`
`140`	`128`
`141`		`-- (void)update`
	`129`	`+- (void)didUpdateFrame:(RCTFrameUpdate *)update`
`142`	`130`	`{`
`143`	`131`	`RCTAssertMainThread();`
`144`	`132`