From fafd00ab1ad8e78fb0b992f5ce1b35211d4089ee Mon Sep 17 00:00:00 2001 From: Ramanpreet Nara Date: Sat, 3 Feb 2024 13:12:10 -0800 Subject: [PATCH] UIManagerJSInterface: Make reactTags non-nullable (#42208) Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/42208 I went through the [android](https://github.com/facebook/react-native/blob/main/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/uimanager/UIManagerModule.java?fbclid=IwAR29Xk1KiGsxg7O2Fc7F2k4uKFmqqAbcMtsEEdaBalcGjJK7xuyYDo6X1Z8) and [ios](https://github.com/facebook/react-native/blob/main/packages/react-native/React/Modules/RCTUIManager.m?fbclid=IwAR2axOTNVuvGbnGw0_1wlnRhftx4W6K-ptTm_DtQ-eSOLFtnrYwzbjPyeYA) implementations of UIManagerModule. It turns out, the reactTag is always nonnull in all methods! This diff updates UIManagerJSInterface accordingly. Changelog: [General][Changed] - UIManagerModule: Make reactTags required Reviewed By: sammy-SC Differential Revision: D52627087 fbshipit-source-id: e79650f539fa2fbc00654a1ecce4fae2da8ae11a --- .../ReactNative/BridgelessUIManager.js | 84 ++++--------------- .../Libraries/ReactNative/PaperUIManager.js | 2 +- .../private/specs/modules/NativeUIManager.js | 26 +++--- .../js/MyLegacyViewNativeComponent.js | 23 ++++- 4 files changed, 51 insertions(+), 84 deletions(-) diff --git a/packages/react-native/Libraries/ReactNative/BridgelessUIManager.js b/packages/react-native/Libraries/ReactNative/BridgelessUIManager.js index 4113e0e1548..ee428d47e33 100644 --- a/packages/react-native/Libraries/ReactNative/BridgelessUIManager.js +++ b/packages/react-native/Libraries/ReactNative/BridgelessUIManager.js @@ -65,7 +65,7 @@ const getDefaultEventTypesCached = (function () { */ const UIManagerJSOverridenAPIs = { measure: ( - reactTag: ?number, + reactTag: number, callback: ( left: number, top: number, @@ -78,14 +78,14 @@ const UIManagerJSOverridenAPIs = { raiseSoftError('measure'); }, measureInWindow: ( - reactTag: ?number, + reactTag: number, callback: (x: number, y: number, width: number, height: number) => void, ): void => { raiseSoftError('measureInWindow'); }, measureLayout: ( - reactTag: ?number, - ancestorReactTag: ?number, + reactTag: number, + ancestorReactTag: number, errorCallback: (error: Object) => void, callback: ( left: number, @@ -97,7 +97,7 @@ const UIManagerJSOverridenAPIs = { raiseSoftError('measureLayout'); }, measureLayoutRelativeToParent: ( - reactTag: ?number, + reactTag: number, errorCallback: (error: Object) => void, callback: ( left: number, @@ -109,7 +109,7 @@ const UIManagerJSOverridenAPIs = { raiseSoftError('measureLayoutRelativeToParent'); }, dispatchViewManagerCommand: ( - reactTag: ?number, + reactTag: number, commandID: number, commandArgs: ?Array, ): void => { @@ -124,7 +124,7 @@ const UIManagerJSOverridenAPIs = { */ const UIManagerJSUnusedInNewArchAPIs = { createView: ( - reactTag: ?number, + reactTag: number, viewName: string, rootTag: RootTag, props: Object, @@ -134,11 +134,11 @@ const UIManagerJSUnusedInNewArchAPIs = { updateView: (reactTag: number, viewName: string, props: Object): void => { raiseSoftError('updateView'); }, - setChildren: (containerTag: ?number, reactTags: Array): void => { + setChildren: (containerTag: number, reactTags: Array): void => { raiseSoftError('setChildren'); }, manageChildren: ( - containerTag: ?number, + containerTag: number, moveFromIndices: Array, moveToIndices: Array, addChildReactTags: Array, @@ -147,7 +147,7 @@ const UIManagerJSUnusedInNewArchAPIs = { ): void => { raiseSoftError('manageChildren'); }, - setJSResponder: (reactTag: ?number, blockNativeResponder: boolean): void => { + setJSResponder: (reactTag: number, blockNativeResponder: boolean): void => { raiseSoftError('setJSResponder'); }, clearJSResponder: (): void => { @@ -163,7 +163,7 @@ const UIManagerJSDeprecatedPlatformAPIs = Platform.select({ android: { // TODO(T175424986): Remove UIManager.showPopupMenu() in React Native v0.75. showPopupMenu: ( - reactTag: ?number, + reactTag: number, items: Array, error: (error: Object) => void, success: (event: string, selected?: number) => void, @@ -213,16 +213,7 @@ const UIManagerJSPlatformAPIs = Platform.select({ ); } }, - sendAccessibilityEvent: (reactTag: ?number, eventType: number): void => { - if (reactTag == null) { - console.error( - `sendAccessibilityEvent() dropping event: Cannot be called with ${String( - reactTag, - )} reactTag`, - ); - return; - } - + sendAccessibilityEvent: (reactTag: number, eventType: number): void => { // Keep this in sync with java:FabricUIManager.sendAccessibilityEventFromJS // and legacySendAccessibilityEvent.android.js const AccessibilityEvent = { @@ -271,14 +262,7 @@ const UIManagerJSPlatformAPIs = Platform.select({ raiseSoftError('lazilyLoadView'); return {}; }, - focus: (reactTag: ?number): void => { - if (reactTag == null) { - console.error( - `focus() noop: Cannot be called with ${String(reactTag)} reactTag`, - ); - return; - } - + focus: (reactTag: number): void => { const FabricUIManager = nullthrows(getFabricUIManager()); const shadowNode = FabricUIManager.findShadowNodeByTag_DEPRECATED(reactTag); @@ -288,14 +272,7 @@ const UIManagerJSPlatformAPIs = Platform.select({ } FabricUIManager.dispatchCommand(shadowNode, 'focus', []); }, - blur: (reactTag: ?number): void => { - if (reactTag == null) { - console.error( - `blur() noop: Cannot be called with ${String(reactTag)} reactTag`, - ); - return; - } - + blur: (reactTag: number): void => { const FabricUIManager = nullthrows(getFabricUIManager()); const shadowNode = FabricUIManager.findShadowNodeByTag_DEPRECATED(reactTag); @@ -344,7 +321,7 @@ const UIManagerJS: UIManagerJSInterface & {[string]: any} = { } }, findSubviewIn: ( - reactTag: ?number, + reactTag: number, point: Array, callback: ( nativeViewTag: number, @@ -354,15 +331,6 @@ const UIManagerJS: UIManagerJSInterface & {[string]: any} = { height: number, ) => void, ): void => { - if (reactTag == null) { - console.error( - `findSubviewIn() noop: Cannot be called with ${String( - reactTag, - )} reactTag`, - ); - return; - } - const FabricUIManager = nullthrows(getFabricUIManager()); const shadowNode = FabricUIManager.findShadowNodeByTag_DEPRECATED(reactTag); @@ -404,19 +372,10 @@ const UIManagerJS: UIManagerJSInterface & {[string]: any} = { ); }, viewIsDescendantOf: ( - reactTag: ?number, - ancestorReactTag: ?number, + reactTag: number, + ancestorReactTag: number, callback: (result: Array) => void, ): void => { - if (reactTag == null) { - console.error( - `viewIsDescendantOf() noop: Cannot be called with ${String( - reactTag, - )} reactTag`, - ); - return; - } - const FabricUIManager = nullthrows(getFabricUIManager()); const shadowNode = FabricUIManager.findShadowNodeByTag_DEPRECATED(reactTag); if (!shadowNode) { @@ -426,15 +385,6 @@ const UIManagerJS: UIManagerJSInterface & {[string]: any} = { return; } - if (ancestorReactTag == null) { - console.error( - `viewIsDescendantOf() noop: Cannot be called with ${String( - ancestorReactTag, - )} ancestorReactTag`, - ); - return; - } - const ancestorShadowNode = FabricUIManager.findShadowNodeByTag_DEPRECATED(ancestorReactTag); if (!ancestorShadowNode) { diff --git a/packages/react-native/Libraries/ReactNative/PaperUIManager.js b/packages/react-native/Libraries/ReactNative/PaperUIManager.js index e5ad5a9aeb2..abdf455fabd 100644 --- a/packages/react-native/Libraries/ReactNative/PaperUIManager.js +++ b/packages/react-native/Libraries/ReactNative/PaperUIManager.js @@ -83,7 +83,7 @@ function getViewManagerConfig(viewManagerName: string): any { const UIManagerJS: UIManagerJSInterface = { ...NativeUIManager, createView( - reactTag: ?number, + reactTag: number, viewName: string, rootTag: RootTag, props: Object, diff --git a/packages/react-native/src/private/specs/modules/NativeUIManager.js b/packages/react-native/src/private/specs/modules/NativeUIManager.js index 1555b1dcab1..3bdb0254a93 100644 --- a/packages/react-native/src/private/specs/modules/NativeUIManager.js +++ b/packages/react-native/src/private/specs/modules/NativeUIManager.js @@ -16,14 +16,14 @@ import * as TurboModuleRegistry from '../../../../Libraries/TurboModule/TurboMod export interface Spec extends TurboModule { +getConstants: () => Object; +createView: ( - reactTag: ?number, + reactTag: number, viewName: string, rootTag: RootTag, props: Object, ) => void; +updateView: (reactTag: number, viewName: string, props: Object) => void; +findSubviewIn: ( - reactTag: ?number, + reactTag: number, point: Array, callback: ( nativeViewTag: number, @@ -34,8 +34,8 @@ export interface Spec extends TurboModule { ) => void, ) => void; +dispatchViewManagerCommand: ( - reactTag: ?number, - commandID: number, + reactTag: number, + commandID: number, // number || string commandArgs: ?Array, ) => void; +measure: ( @@ -54,8 +54,8 @@ export interface Spec extends TurboModule { callback: (x: number, y: number, width: number, height: number) => void, ) => void; +viewIsDescendantOf: ( - reactTag: ?number, - ancestorReactTag: ?number, + reactTag: number, + ancestorReactTag: number, callback: (result: Array) => void, ) => void; +measureLayout: ( @@ -79,16 +79,16 @@ export interface Spec extends TurboModule { height: number, ) => void, ) => void; - +setJSResponder: (reactTag: ?number, blockNativeResponder: boolean) => void; + +setJSResponder: (reactTag: number, blockNativeResponder: boolean) => void; +clearJSResponder: () => void; +configureNextLayoutAnimation: ( config: Object, callback: () => void, // check what is returned here errorCallback: (error: Object) => void, ) => void; - +setChildren: (containerTag: ?number, reactTags: Array) => void; + +setChildren: (containerTag: number, reactTags: Array) => void; +manageChildren: ( - containerTag: ?number, + containerTag: number, moveFromIndices: Array, moveToIndices: Array, addChildReactTags: Array, @@ -100,9 +100,9 @@ export interface Spec extends TurboModule { +getConstantsForViewManager?: (viewManagerName: string) => ?Object; +getDefaultEventTypes?: () => Array; +setLayoutAnimationEnabledExperimental?: (enabled: boolean) => void; - +sendAccessibilityEvent?: (reactTag: ?number, eventType: number) => void; + +sendAccessibilityEvent?: (reactTag: number, eventType: number) => void; +showPopupMenu?: ( - reactTag: ?number, + reactTag: number, items: Array, error: (error: Object) => void, success: (event: string, selected?: number) => void, @@ -111,8 +111,8 @@ export interface Spec extends TurboModule { // ios only +lazilyLoadView?: (name: string) => Object; // revisit return - +focus?: (reactTag: ?number) => void; - +blur?: (reactTag: ?number) => void; + +focus?: (reactTag: number) => void; + +blur?: (reactTag: number) => void; } export default (TurboModuleRegistry.getEnforcing('UIManager'): Spec); diff --git a/packages/rn-tester/NativeComponentExample/js/MyLegacyViewNativeComponent.js b/packages/rn-tester/NativeComponentExample/js/MyLegacyViewNativeComponent.js index d4c7d33e0c9..e895d46bb05 100644 --- a/packages/rn-tester/NativeComponentExample/js/MyLegacyViewNativeComponent.js +++ b/packages/rn-tester/NativeComponentExample/js/MyLegacyViewNativeComponent.js @@ -43,8 +43,13 @@ export function callNativeMethodToChangeBackgroundColor( console.log('viewRef is null'); return; } + const reactTag = ReactNative.findNodeHandle(viewRef); + if (reactTag == null) { + console.log('reactTag is null'); + return; + } UIManager.dispatchViewManagerCommand( - ReactNative.findNodeHandle(viewRef), + reactTag, UIManager.getViewManagerConfig( 'RNTMyLegacyNativeView', ).Commands.changeBackgroundColor.toString(), @@ -60,8 +65,14 @@ export function callNativeMethodToAddOverlays( console.log('viewRef is null'); return; } + const reactTag = ReactNative.findNodeHandle(viewRef); + if (reactTag == null) { + console.log('reactTag is null'); + return; + } + UIManager.dispatchViewManagerCommand( - ReactNative.findNodeHandle(viewRef), + reactTag, UIManager.getViewManagerConfig( 'RNTMyLegacyNativeView', ).Commands.addOverlays.toString(), @@ -76,8 +87,14 @@ export function callNativeMethodToRemoveOverlays( console.log('viewRef is null'); return; } + const reactTag = ReactNative.findNodeHandle(viewRef); + if (reactTag == null) { + console.log('reactTag is null'); + return; + } + UIManager.dispatchViewManagerCommand( - ReactNative.findNodeHandle(viewRef), + reactTag, UIManager.getViewManagerConfig( 'RNTMyLegacyNativeView', ).Commands.removeOverlays.toString(),