mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Ramanpreet Nara
d7ac21cec5
Summary: ## Context - If a NativeModule requires main queue setup, its `constantsToExport` method is executed on the main queue. - In the TurboModule system, `constantsToExport` or `getConstants` is treated like a regular synchronous NativeModule method. Therefore, it's always executed on the JS thread. This difference in behaviour is dangerous when we're A/B testing the TurboModule infra: One could write a NativeModule that requires main queue setup, and have it expose constants that access objects/state only accessible on the UI thread. This NativeModule would work fine in the legacy infra, which could be the case if the NativeModule author is testing locally. But once it ships to prod, it may run with the TurboModule system, and crash the application. To mitigate this risk, I'm removing this special main queue execution of `constantsToExport` from the legacy infrastructure. ## Consequences - If a NativeModule's `constantsToExport` method accesses objects/state only accessible on the UI thread, it must do so by explicitly scheduling work on the main thread. I wrote up a codemod to fix this for our OSS modules: D21797048. - Eagerly initialized NativeModules that required main queue setup had their constants calculated eagerly. After the changes in this diff, those NativeModules will have their constants calculated lazily. I don't think this is a big deal because only a handful of NativeModules are eagerly initialized, and eagerly initialized NativeModules are going away anyway. Changelog: [iOS][Removed] - Main queue execution of constantsToExport in NativeModules requiring main queue setup Reviewed By: fkgozali Differential Revision: D21829091 fbshipit-source-id: df21fd5fd2ef45a291c07400f360bba801ae290f
101 lines
3.3 KiB
Objective-C
101 lines
3.3 KiB
Objective-C
/*
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import <React/RCTInvalidating.h>
|
|
#import "RCTDefines.h"
|
|
|
|
@protocol RCTBridgeMethod;
|
|
@protocol RCTBridgeModule;
|
|
@class RCTBridge;
|
|
|
|
typedef id<RCTBridgeModule> (^RCTBridgeModuleProvider)(void);
|
|
|
|
@interface RCTModuleData : NSObject <RCTInvalidating>
|
|
|
|
- (instancetype)initWithModuleClass:(Class)moduleClass bridge:(RCTBridge *)bridge;
|
|
|
|
- (instancetype)initWithModuleClass:(Class)moduleClass
|
|
moduleProvider:(RCTBridgeModuleProvider)moduleProvider
|
|
bridge:(RCTBridge *)bridge NS_DESIGNATED_INITIALIZER;
|
|
|
|
- (instancetype)initWithModuleInstance:(id<RCTBridgeModule>)instance
|
|
bridge:(RCTBridge *)bridge NS_DESIGNATED_INITIALIZER;
|
|
|
|
/**
|
|
* Calls `constantsToExport` on the module and stores the result. Note that
|
|
* this will init the module if it has not already been created. This method
|
|
* can be called on any thread, but may block the main thread briefly if the
|
|
* module implements `constantsToExport`.
|
|
*/
|
|
- (void)gatherConstants;
|
|
|
|
@property (nonatomic, strong, readonly) Class moduleClass;
|
|
@property (nonatomic, copy, readonly) NSString *name;
|
|
|
|
/**
|
|
* Returns the module methods. Note that this will gather the methods the first
|
|
* time it is called and then memoize the results.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSArray<id<RCTBridgeMethod>> *methods;
|
|
|
|
/**
|
|
* Returns a map of the module methods. Note that this will gather the methods the first
|
|
* time it is called and then memoize the results.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSDictionary<NSString *, id<RCTBridgeMethod>> *methodsByName;
|
|
|
|
/**
|
|
* Returns the module's constants, if it exports any
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSDictionary<NSString *, id> *exportedConstants;
|
|
|
|
/**
|
|
* Returns YES if module instance has already been initialized; NO otherwise.
|
|
*/
|
|
@property (nonatomic, assign, readonly) BOOL hasInstance;
|
|
|
|
/**
|
|
* Returns YES if module instance must be created on the main thread.
|
|
*/
|
|
@property (nonatomic, assign) BOOL requiresMainQueueSetup;
|
|
|
|
/**
|
|
* Returns YES if module has constants to export.
|
|
*/
|
|
@property (nonatomic, assign, readonly) BOOL hasConstantsToExport;
|
|
|
|
/**
|
|
* Returns the current module instance. Note that this will init the instance
|
|
* if it has not already been created. To check if the module instance exists
|
|
* without causing it to be created, use `hasInstance` instead.
|
|
*/
|
|
@property (nonatomic, strong, readwrite) id<RCTBridgeModule> instance;
|
|
|
|
/**
|
|
* Returns the module method dispatch queue. Note that this will init both the
|
|
* queue and the module itself if they have not already been created.
|
|
*/
|
|
@property (nonatomic, strong, readonly) dispatch_queue_t methodQueue;
|
|
|
|
/**
|
|
* Whether the receiver has a valid `instance` which implements -batchDidComplete.
|
|
*/
|
|
@property (nonatomic, assign, readonly) BOOL implementsBatchDidComplete;
|
|
|
|
/**
|
|
* Whether the receiver has a valid `instance` which implements
|
|
* -partialBatchDidFlush.
|
|
*/
|
|
@property (nonatomic, assign, readonly) BOOL implementsPartialBatchDidFlush;
|
|
|
|
@end
|
|
|
|
RCT_EXTERN void RCTSetIsMainQueueExecutionOfConstantsToExportDisabled(BOOL val);
|
|
RCT_EXTERN BOOL RCTIsMainQueueExecutionOfConstantsToExportDisabled();
|