Skip to content

[iOS] Fabric: make built-in components recycle optional #42780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[iOS] Fabric: make built-in components recycle optional #42780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...Fabric/Mounting/ComponentViews/ActivityIndicator/RCTActivityIndicatorViewComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ - (void)updateProps:(const Props::Shared &)props oldProps:(const Props::Shared &
[super updateProps:props oldProps:oldProps];
}

RCTComponentViewShouldBeRecycled(true);

@end

Class<RCTComponentViewProtocol> RCTActivityIndicatorViewCls(void)
Expand Down
2 changes: 2 additions & 0 deletions ...React/Fabric/Mounting/ComponentViews/DebuggingOverlay/RCTDebuggingOverlayComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ + (ComponentDescriptorProvider)componentDescriptorProvider
return concreteComponentDescriptorProvider<DebuggingOverlayComponentDescriptor>();
}

RCTComponentViewShouldBeRecycled(true);

#pragma mark - Native commands

- (void)handleCommand:(const NSString *)commandName args:(const NSArray *)args
Expand Down
2 changes: 2 additions & 0 deletions packages/react-native/React/Fabric/Mounting/ComponentViews/Image/RCTImageComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ - (void)prepareForRecycle
_imageView.image = nil;
}

RCTComponentViewShouldBeRecycled(true);

#pragma mark - RCTImageResponseDelegate

- (void)didReceiveImage:(UIImage *)image metadata:(id)metadata fromObserver:(const void *)observer
Expand Down
2 changes: 2 additions & 0 deletions ...ive/React/Fabric/Mounting/ComponentViews/InputAccessory/RCTInputAccessoryComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@ - (void)prepareForRecycle
_textInput = nil;
}

RCTComponentViewShouldBeRecycled(true);

@end

Class<RCTComponentViewProtocol> RCTInputAccessoryCls(void)
Expand Down
2 changes: 2 additions & 0 deletions ...nting/ComponentViews/LegacyViewManagerInterop/RCTLegacyViewManagerInteropComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,8 @@ - (void)finalizeUpdates:(RNComponentViewUpdateMask)updateMask
updatePropsIfNeeded(updateMask);
}

RCTComponentViewShouldBeRecycled(true);

- (void)_setPropsWithUpdateMask:(RNComponentViewUpdateMask)updateMask
{
if (updateMask & RNComponentViewUpdateMaskProps) {
Expand Down
2 changes: 2 additions & 0 deletions .../react-native/React/Fabric/Mounting/ComponentViews/Modal/RCTModalHostViewComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,8 @@ - (void)unmountChildComponentView:(UIView<RCTComponentViewProtocol> *)childCompo
[childComponentView removeFromSuperview];
}

RCTComponentViewShouldBeRecycled(true);

@end

#ifdef __cplusplus
Expand Down
2 changes: 2 additions & 0 deletions packages/react-native/React/Fabric/Mounting/ComponentViews/Root/RCTRootComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,6 @@ + (ComponentDescriptorProvider)componentDescriptorProvider
return concreteComponentDescriptorProvider<RootComponentDescriptor>();
}

RCTComponentViewShouldBeRecycled(true);

@end
2 changes: 2 additions & 0 deletions ...-native/React/Fabric/Mounting/ComponentViews/SafeAreaView/RCTSafeAreaViewComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ - (void)prepareForRecycle
_state.reset();
}

RCTComponentViewShouldBeRecycled(true);

@end

Class<RCTComponentViewProtocol> RCTSafeAreaViewCls(void)
Expand Down
2 changes: 2 additions & 0 deletions ...tive/React/Fabric/Mounting/ComponentViews/ScrollView/RCTPullToRefreshViewComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ - (void)updateProps:(const Props::Shared &)props oldProps:(const Props::Shared &
[super updateProps:props oldProps:oldProps];
}

RCTComponentViewShouldBeRecycled(true);

#pragma mark -

- (void)handleUIControlEventValueChanged
Expand Down
2 changes: 2 additions & 0 deletions ...eact-native/React/Fabric/Mounting/ComponentViews/ScrollView/RCTScrollViewComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,8 @@ - (void)prepareForRecycle
[super prepareForRecycle];
}

RCTComponentViewShouldBeRecycled(true);

#pragma mark - UIScrollViewDelegate

- (BOOL)touchesShouldCancelInContentView:(__unused UIView *)view
Expand Down
2 changes: 2 additions & 0 deletions packages/react-native/React/Fabric/Mounting/ComponentViews/Switch/RCTSwitchComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ - (void)onChange:(UISwitch *)sender
.onChange(SwitchEventEmitter::OnChange{.value = static_cast<bool>(sender.on)});
}

RCTComponentViewShouldBeRecycled(true);

#pragma mark - Native Commands

- (void)handleCommand:(const NSString *)commandName args:(const NSArray *)args
Expand Down
2 changes: 2 additions & 0 deletions packages/react-native/React/Fabric/Mounting/ComponentViews/Text/RCTParagraphComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ - (void)prepareForRecycle
_accessibilityProvider = nil;
}

RCTComponentViewShouldBeRecycled(true);

- (void)drawRect:(CGRect)rect
{
if (!_state) {
Expand Down
2 changes: 2 additions & 0 deletions .../react-native/React/Fabric/Mounting/ComponentViews/TextInput/RCTTextInputComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,8 @@ - (void)prepareForRecycle
[_backedTextInputView resignFirstResponder];
}

RCTComponentViewShouldBeRecycled(true);

#pragma mark - RCTBackedTextInputDelegate

- (BOOL)textInputShouldBeginEditing
Expand Down
2 changes: 2 additions & 0 deletions ...ric/Mounting/ComponentViews/UnimplementedComponent/RCTUnimplementedNativeComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,6 @@ - (void)updateProps:(const Props::Shared &)props oldProps:(const Props::Shared &
[super updateProps:props oldProps:oldProps];
}

RCTComponentViewShouldBeRecycled(true);

@end
2 changes: 2 additions & 0 deletions ...act/Fabric/Mounting/ComponentViews/UnimplementedView/RCTUnimplementedViewComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ - (void)updateProps:(const Props::Shared &)props oldProps:(const Props::Shared &
[super updateProps:props oldProps:oldProps];
}

RCTComponentViewShouldBeRecycled(true);

@end

Class<RCTComponentViewProtocol> RCTUnimplementedNativeViewCls(void)
Expand Down
12 changes: 12 additions & 0 deletions packages/react-native/React/Fabric/Mounting/ComponentViews/View/RCTViewComponentView.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,18 @@

NS_ASSUME_NONNULL_BEGIN

#define RCTComponentViewShouldBeRecycled(recycled) \
static bool _shouldBeRecycled = recycled; \
+(bool)shouldBeRecycled \
{ \
return _shouldBeRecycled; \
} \
\
+(void)setShouldBeRecycled : (bool)shouldBeRecycled \
{ \
_shouldBeRecycled = shouldBeRecycled; \
}
Comment on lines +22 to +32
Copy link
Contributor

@cipolleschi cipolleschi Feb 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is the right approach because this is a static method. It means that it applies to ALL the components of a given type.
So, let's imagine that we set RCTComponentViewShouldBeRecycled(false) to RCTView, we are disabling the recyclability for ALL the RCTViews.
The possibility to be recycled or not should be a choice made instance per instance.

I should be able to say that my RCTImage x should not be recycled (perhaps it is a large image and I want to keep it i memory as a perf optimization, while my RCTImage y should not.

What do you think?

cc. @sammy-SC which knows this part of the Framework better than me.

Copy link
Contributor Author

@zhongwuzw zhongwuzw Feb 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I just follow the custom user components because it's class method implemented in

react-native/packages/react-native/React/Fabric/Mounting/RCTComponentViewFactory.mm

Line 99 in ebb55a7

.shouldBeRecycled = [viewClass respondsToSelector:@selector(shouldBeRecycled)]

Maybe we can expose some like a delegate to AppDelegate and give its instance to ask the user to decide whether to disable recycle?


/**
* UIView class for <View> component.
*/
Expand Down
2 changes: 2 additions & 0 deletions packages/react-native/React/Fabric/Mounting/ComponentViews/View/RCTViewComponentView.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ - (void)traitCollectionDidChange:(UITraitCollection *)previousTraitCollection
}
}

RCTComponentViewShouldBeRecycled(true);

#pragma mark - RCTComponentViewProtocol

+ (ComponentDescriptorProvider)componentDescriptorProvider
Expand Down
5 changes: 5 additions & 0 deletions packages/react-native/React/Fabric/Mounting/RCTComponentViewProtocol.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,11 @@ typedef NS_OPTIONS(NSInteger, RNComponentViewUpdateMask) {
- (void)setPropKeysManagedByAnimated_DO_NOT_USE_THIS_IS_BROKEN:(nullable NSSet<NSString *> *)props;
- (nullable NSSet<NSString *> *)propKeysManagedByAnimated_DO_NOT_USE_THIS_IS_BROKEN;

/*
* Mark component view should be recycled.
*/
+ (void)setShouldBeRecycled:(bool)shouldBeRecycled;

@end

NS_ASSUME_NONNULL_END
2 changes: 2 additions & 0 deletions packages/react-native/React/Fabric/Mounting/UIView+ComponentViewProtocol.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ NS_ASSUME_NONNULL_BEGIN

- (void)updateClippedSubviewsWithClipRect:(CGRect)clipRect relativeToView:(UIView *)clipView;

+ (void)setShouldBeRecycled:(bool)shouldBeRecycled;

@end

NS_ASSUME_NONNULL_END
5 changes: 5 additions & 0 deletions packages/react-native/React/Fabric/Mounting/UIView+ComponentViewProtocol.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,4 +168,9 @@ - (void)updateClippedSubviewsWithClipRect:(CGRect)clipRect relativeToView:(UIVie
}
}

+ (void)setShouldBeRecycled:(bool)shouldBeRecycled
{
// Default implementation does nothing.
}

@end