feat: coalesced event

Gregoirevda · Gregoirevda · commit ca99ca838739 · 2025-02-26T12:58:38.000+01:00
diff --git a/ios/RNCChangeEvent.h b/ios/RNCChangeEvent.h
@@ -0,0 +1,12 @@
+#import <Foundation/Foundation.h>
+#import <React/RCTEventDispatcherProtocol.h>
+
+@interface RNCChangeEvent : NSObject <RCTEvent>
+
+- (instancetype)initWithEventName:(NSString *)eventName
+                         reactTag:(NSNumber *)reactTag
+                           insets:(UIEdgeInsets)insets
+                            frame:(CGRect)frame
+                    coalescingKey:(uint16_t)coalescingKey NS_DESIGNATED_INITIALIZER;
+
+@end
diff --git a/ios/RNCChangeEvent.m b/ios/RNCChangeEvent.m
@@ -0,0 +1,87 @@
+#import "RNCChangeEvent.h"
+#import <React/RCTAssert.h>
+
+@implementation RNCChangeEvent {
+    UIEdgeInsets _insets;
+    CGRect _frame;
+    uint16_t _coalescingKey;
+}
+
+@synthesize eventName = _eventName;
+@synthesize viewTag = _viewTag;
+
+- (instancetype)initWithEventName:(NSString *)eventName
+                         reactTag:(NSNumber *)reactTag
+                           insets:(UIEdgeInsets)insets
+                            frame:(CGRect)frame
+                    coalescingKey:(uint16_t)coalescingKey
+{
+    RCTAssertParam(reactTag);
+    
+    if ((self = [super init])) {
+        _eventName = [eventName copy];
+        _viewTag = reactTag;
+        _frame = frame;
+        _insets = insets;
+        _coalescingKey = coalescingKey;
+    }
+    
+    return self;
+}
+
+RCT_NOT_IMPLEMENTED(-(instancetype)init)
+
+- (uint16_t)coalescingKey
+{
+    return _coalescingKey;
+}
+
+- (NSDictionary *)body
+{
+  NSDictionary *body = @{
+      @"insets" : @{
+        @"top" : @(_insets.top),
+        @"right" : @(_insets.right),
+        @"bottom" : @(_insets.bottom),
+        @"left" : @(_insets.left),
+      },
+      @"frame" : @{
+        @"x" : @(_frame.origin.x),
+        @"y" : @(_frame.origin.y),
+        @"width" : @(_frame.size.width),
+        @"height" : @(_frame.size.height),
+      },
+  };
+
+  return body;
+}
+
+- (BOOL)canCoalesce
+{
+  return YES;
+}
+
+- (RNCChangeEvent *)coalesceWithEvent:(RNCChangeEvent *)newEvent
+{
+  return newEvent;
+}
+
++ (NSString *)moduleDotMethod
+{
+  return @"RCTEventEmitter.receiveEvent";
+}
+
+- (NSArray *)arguments
+{
+  return @[ self.viewTag, RCTNormalizeInputEventName(self.eventName), [self body] ];
+}
+
+/*
+Not sure if this is needed as eventName is passed in arguments
+- (NSString *)eventName
+{
+  return _eventName;
+}
+*/
+ 
+@end
diff --git a/ios/RNCSafeAreaProvider.h b/ios/RNCSafeAreaProvider.h
@@ -4,12 +4,18 @@
 #import <AppKit/AppKit.h>
 #endif
 
+#import <React/RCTEventDispatcherProtocol.h>
 #import <React/RCTView.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
 @interface RNCSafeAreaProvider : RCTView
 
+- (instancetype)initWithEventDispatcher:(id<RCTEventDispatcherProtocol>)eventDispatcher NS_DESIGNATED_INITIALIZER;
+
+// NOTE: currently these event props are only declared so we can export the
+// event names to JS - we don't call the blocks directly because scroll events
+// need to be coalesced before sending, for performance reasons.
 @property (nonatomic, copy) RCTBubblingEventBlock onInsetsChange;
 
 @end
diff --git a/ios/RNCSafeAreaProvider.m b/ios/RNCSafeAreaProvider.m
@@ -1,19 +1,33 @@
 #import "RNCSafeAreaProvider.h"
 
+#import <React/RCTEventDispatcher.h>
 #import <React/RCTBridge.h>
 #import <React/RCTUIManager.h>
+#import "RCTUIManagerObserverCoordinator.h"
 #import "RNCSafeAreaUtils.h"
+#import "RNCChangeEvent.h"
+
+@interface RNCSafeAreaProvider () <RCTUIManagerObserver>
+
+@end
 
 @implementation RNCSafeAreaProvider {
+  id<RCTEventDispatcherProtocol> _eventDispatcher;
   UIEdgeInsets _currentSafeAreaInsets;
   CGRect _currentFrame;
   BOOL _initialInsetsSent;
+  uint16_t _coalescingKey;
 }
 
-- (instancetype)init
+- (instancetype)initWithEventDispatcher:(id<RCTEventDispatcherProtocol>)eventDispatcher
 {
-  if ((self = [super init])) {
-#if !TARGET_OS_TV && !TARGET_OS_OSX
+    RCTAssertParam(eventDispatcher);
+  
+    if ((self = [super initWithFrame:CGRectZero])) {
+#if !TARGET_OS_TV
+      
+    _eventDispatcher = eventDispatcher;
+
     [NSNotificationCenter.defaultCenter addObserver:self
                                            selector:@selector(invalidateSafeAreaInsets)
                                                name:UIKeyboardDidShowNotification
@@ -48,48 +62,31 @@ - (void)invalidateSafeAreaInsets
     return;
   }
 
-#if TARGET_OS_IPHONE
   UIEdgeInsets safeAreaInsets = self.safeAreaInsets;
-#elif TARGET_OS_OSX
-  NSEdgeInsets safeAreaInsets;
-  if (@available(macOS 11.0, *)) {
-    safeAreaInsets = self.safeAreaInsets;
-  } else {
-    safeAreaInsets = NSEdgeInsetsZero;
-  }
-#endif
   CGRect frame = [self convertRect:self.bounds toView:RNCParentViewController(self).view];
 
   if (_initialInsetsSent &&
-#if TARGET_OS_IPHONE
       UIEdgeInsetsEqualToEdgeInsetsWithThreshold(safeAreaInsets, _currentSafeAreaInsets, 1.0 / RCTScreenScale()) &&
-#elif TARGET_OS_OSX
-      NSEdgeInsetsEqualToEdgeInsetsWithThreshold(safeAreaInsets, _currentSafeAreaInsets, 1.0 / RCTScreenScale()) &&
-#endif
       CGRectEqualToRect(frame, _currentFrame)) {
     return;
   }
-
+  
   _initialInsetsSent = YES;
   _currentSafeAreaInsets = safeAreaInsets;
   _currentFrame = frame;
 
   [NSNotificationCenter.defaultCenter postNotificationName:RNCSafeAreaDidChange object:self userInfo:nil];
 
-  self.onInsetsChange(@{
-    @"insets" : @{
-      @"top" : @(safeAreaInsets.top),
-      @"right" : @(safeAreaInsets.right),
-      @"bottom" : @(safeAreaInsets.bottom),
-      @"left" : @(safeAreaInsets.left),
-    },
-    @"frame" : @{
-      @"x" : @(frame.origin.x),
-      @"y" : @(frame.origin.y),
-      @"width" : @(frame.size.width),
-      @"height" : @(frame.size.height),
-    },
-  });
+    // There's currently only 1 event name "change", so the _coalescingKey doesn't needs to be incremented
+    // Increment _coalescingKey if safeAreaInsets and frame are sent as separate events
+    RNCChangeEvent *changeEvent = [[RNCChangeEvent alloc] initWithEventName:@"onInsetsChange"
+                                                                   reactTag:self.reactTag
+                                                                     insets:safeAreaInsets
+                                                                      frame:frame
+                                                              coalescingKey:_coalescingKey];
+ 
+  
+  [_eventDispatcher sendEvent:changeEvent];
 }
 
 - (void)layoutSubviews
@@ -99,4 +96,13 @@ - (void)layoutSubviews
   [self invalidateSafeAreaInsets];
 }
 
+- (void)dealloc
+{
+  [_eventDispatcher.bridge.uiManager.observerCoordinator removeObserver:self];
+}
+
+
+RCT_NOT_IMPLEMENTED(-(instancetype)initWithFrame : (CGRect)frame)
+RCT_NOT_IMPLEMENTED(-(instancetype)initWithCoder : (NSCoder *)aDecoder)
+
 @end
diff --git a/ios/RNCSafeAreaProviderManager.m b/ios/RNCSafeAreaProviderManager.m
@@ -14,7 +14,7 @@ - (UIView *)view
 - (NSView *)view
 #endif
 {
-  return [RNCSafeAreaProvider new];
+  return [[RNCSafeAreaProvider alloc] initWithEventDispatcher:self.bridge.eventDispatcher];
 }
 
 @end
diff --git a/ios/RNSafeAreaContext.xcodeproj/project.pbxproj b/ios/RNSafeAreaContext.xcodeproj/project.pbxproj
@@ -19,6 +19,7 @@
 		0C7844F027C02D03001807FB /* RNCSafeAreaProvider.m in Sources */ = {isa = PBXBuildFile; fileRef = 0C7844ED27C02D03001807FB /* RNCSafeAreaProvider.m */; };
 		AA53A9EE2A321C01009AB3B2 /* RNCSafeAreaViewEdgeModes.m in Sources */ = {isa = PBXBuildFile; fileRef = AA53A9ED2A321C01009AB3B2 /* RNCSafeAreaViewEdgeModes.m */; };
 		C923EDBC220C2C1A00D3100F /* SystemConfiguration.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C923EDBB220C2C1A00D3100F /* SystemConfiguration.framework */; };
+		D697AA982D6F1D0A009C6433 /* RNCChangeEvent.m in Sources */ = {isa = PBXBuildFile; fileRef = D697AA972D6F1D08009C6433 /* RNCChangeEvent.m */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXCopyFilesBuildPhase section */
@@ -59,6 +60,8 @@
 		AA53A9EC2A321C01009AB3B2 /* RNCSafeAreaViewEdgeModes.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = RNCSafeAreaViewEdgeModes.h; sourceTree = "<group>"; };
 		AA53A9ED2A321C01009AB3B2 /* RNCSafeAreaViewEdgeModes.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = RNCSafeAreaViewEdgeModes.m; sourceTree = "<group>"; };
 		C923EDBB220C2C1A00D3100F /* SystemConfiguration.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SystemConfiguration.framework; path = System/Library/Frameworks/SystemConfiguration.framework; sourceTree = SDKROOT; };
+		D697AA962D6F1CE5009C6433 /* RNCChangeEvent.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = RNCChangeEvent.h; sourceTree = "<group>"; };
+		D697AA972D6F1D08009C6433 /* RNCChangeEvent.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = RNCChangeEvent.m; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -84,6 +87,8 @@
 		58B511D21A9E6C8500147676 = {
 			isa = PBXGroup;
 			children = (
+				D697AA972D6F1D08009C6433 /* RNCChangeEvent.m */,
+				D697AA962D6F1CE5009C6433 /* RNCChangeEvent.h */,
 				AA53A9EC2A321C01009AB3B2 /* RNCSafeAreaViewEdgeModes.h */,
 				AA53A9ED2A321C01009AB3B2 /* RNCSafeAreaViewEdgeModes.m */,
 				0C7844EE27C02D03001807FB /* Fabric */,
@@ -183,6 +188,7 @@
 				0C7844E827C02CEE001807FB /* RNCSafeAreaView.m in Sources */,
 				0C7844E627C02CEE001807FB /* RNCSafeAreaViewEdges.m in Sources */,
 				0C7844E527C02CEE001807FB /* RNCSafeAreaViewManager.m in Sources */,
+				D697AA982D6F1D0A009C6433 /* RNCChangeEvent.m in Sources */,
 				0C7844EF27C02D03001807FB /* RNCSafeAreaContext.mm in Sources */,
 				0C7844E127C02CEE001807FB /* RNCSafeAreaViewLocalData.m in Sources */,
 				0C7844E227C02CEE001807FB /* RNCSafeAreaViewMode.m in Sources */,
diff --git a/src/SafeAreaContext.tsx b/src/SafeAreaContext.tsx
@@ -58,6 +58,8 @@ export function SafeAreaProvider({
       nativeEvent: { frame: nextFrame, insets: nextInsets },
     } = event;
 
+    console.log('onInsetsChange', nextInsets);
+
     setFrame((curFrame) => {
       if (
         // Backwards compat with old native code that won't send frame.

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ - (UIView *)view`
`14`	`14`	`- (NSView *)view`
`15`	`15`	`#endif`
`16`	`16`	`{`
`17`		`- return [RNCSafeAreaProvider new];`
	`17`	`+ return [[RNCSafeAreaProvider alloc] initWithEventDispatcher:self.bridge.eventDispatcher];`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`@end`