mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
39d67737c0
Summary:
If a NativeModule requires main queue setup, its `getConstants()` method must be executed on the main thead. The legacy NativeModule infra takes care of this for us. With TurboModules, however, all synchronous methods, including `getConstants()`, execute on the JS thread. Therefore, if a TurboModule requires main queue setup, and exports constants, we must execute its `getConstants()` method body on the main queue explicitly.
**Notes:**
- The changes in this diff should be a noop when TurboModules is off, because `RCTUnsafeExecuteOnMainQueueSync` synchronously execute its block on the current thread if the current thread is the main thread.
- If a NativeModule doens't have the `requiresMainQueueSetup` method, but has the `constantsToExport` method, both NativeModules and TurboModules assume that it requires main queue setup.
## Script
```
const exec = require("../lib/exec");
const abspath = require("../lib/abspath");
const relpath = require("../lib/relpath");
const readFile = (filename) => require("fs").readFileSync(filename, "utf8");
const writeFile = (filename, content) =>
require("fs").writeFileSync(filename, content);
function main() {
const tmFiles = exec("cd ~/fbsource && xbgs -n 10000 -l constantsToExport")
.split("\n")
.filter(Boolean);
const filesWithoutConstantsToExport = [];
const filesWithConstantsToExportButNotGetConstants = [];
const filesExplicitlyNotRequiringMainQueueSetup = [];
tmFiles
.filter((filename) => {
if (filename.includes("microsoft-fork-of-react-native")) {
return false;
}
return /\.mm?$/.test(filename);
})
.map(abspath)
.forEach((filename) => {
const code = readFile(filename);
const relFilename = relpath(filename);
if (!/constantsToExport\s*{/.test(code)) {
filesWithoutConstantsToExport.push(relFilename);
return;
}
if (!/getConstants\s*{/.test(code)) {
filesWithConstantsToExportButNotGetConstants.push(relFilename);
return;
}
if (/requiresMainQueueSetup\s*{/.test(code)) {
const requiresMainQueueSetupRegex = /requiresMainQueueSetup\s*{\s*return\s+(?<requiresMainQueueSetup>YES|NO)/;
const requiresMainQueueSetupRegexMatch = requiresMainQueueSetupRegex.exec(
code
);
if (!requiresMainQueueSetupRegexMatch) {
throw new Error(
"Detected requiresMainQueueSetup method in file " +
relFilename +
" but was unable to parse the method return value"
);
}
const {
requiresMainQueueSetup,
} = requiresMainQueueSetupRegexMatch.groups;
if (requiresMainQueueSetup == "NO") {
filesExplicitlyNotRequiringMainQueueSetup.push(relFilename);
return;
}
}
const getConstantsTypeRegex = () => /-\s*\((?<type>.*)\)getConstants\s*{/;
const getConstantsTypeRegexMatch = getConstantsTypeRegex().exec(code);
if (!getConstantsTypeRegexMatch) {
throw new Error(
`Failed to parse return type of getConstants method in file ${relFilename}`
);
}
const getConstantsType = getConstantsTypeRegexMatch.groups.type;
const getConstantsBody = code
.split(getConstantsTypeRegex())[2]
.split("\n}")[0];
const newGetConstantsBody = `
__block ${getConstantsType} constants;
RCTUnsafeExecuteOnMainQueueSync(^{${getConstantsBody
.replace(/\n/g, "\n ")
.replace(/_bridge/g, "self->_bridge")
.replace(/return /g, "constants = ")}
});
return constants;
`;
writeFile(
filename,
code
.replace(getConstantsBody, newGetConstantsBody)
.replace("#import", "#import <React/RCTUtils.h>\n#import")
);
});
console.log("Files without constantsToExport: ");
filesWithoutConstantsToExport.forEach((file) => console.log(file));
console.log();
console.log("Files with constantsToExport but no getConstants: ");
filesWithConstantsToExportButNotGetConstants.forEach((file) =>
console.log(file)
);
console.log();
console.log("Files with requiresMainQueueSetup = NO: ");
filesExplicitlyNotRequiringMainQueueSetup.forEach((file) =>
console.log(file)
);
}
if (!module.parent) {
main();
}
```
Changelog: [Internal]
Reviewed By: fkgozali
Differential Revision: D21797048
fbshipit-source-id: a822a858fecdbe976e6197f8339e509dc7cd917f
215 lines
6.4 KiB
Plaintext
215 lines
6.4 KiB
Plaintext
/*
|
|
* 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 "RCTDeviceInfo.h"
|
|
|
|
#import <FBReactNativeSpec/FBReactNativeSpec.h>
|
|
#import <React/RCTAccessibilityManager.h>
|
|
#import <React/RCTAssert.h>
|
|
#import <React/RCTConstants.h>
|
|
#import <React/RCTEventDispatcher.h>
|
|
#import <React/RCTUIUtils.h>
|
|
#import <React/RCTUtils.h>
|
|
|
|
#import "CoreModulesPlugins.h"
|
|
|
|
using namespace facebook::react;
|
|
|
|
@interface RCTDeviceInfo () <NativeDeviceInfoSpec>
|
|
@end
|
|
|
|
@implementation RCTDeviceInfo {
|
|
#if !TARGET_OS_TV
|
|
UIInterfaceOrientation _currentInterfaceOrientation;
|
|
NSDictionary *_currentInterfaceDimensions;
|
|
#endif
|
|
}
|
|
|
|
@synthesize bridge = _bridge;
|
|
|
|
RCT_EXPORT_MODULE()
|
|
|
|
+ (BOOL)requiresMainQueueSetup
|
|
{
|
|
return YES;
|
|
}
|
|
|
|
- (dispatch_queue_t)methodQueue
|
|
{
|
|
return dispatch_get_main_queue();
|
|
}
|
|
|
|
- (void)setBridge:(RCTBridge *)bridge
|
|
{
|
|
_bridge = bridge;
|
|
|
|
[[NSNotificationCenter defaultCenter] addObserver:self
|
|
selector:@selector(didReceiveNewContentSizeMultiplier)
|
|
name:RCTAccessibilityManagerDidUpdateMultiplierNotification
|
|
object:_bridge.accessibilityManager];
|
|
#if !TARGET_OS_TV
|
|
_currentInterfaceOrientation = [RCTSharedApplication() statusBarOrientation];
|
|
|
|
[[NSNotificationCenter defaultCenter] addObserver:self
|
|
selector:@selector(interfaceOrientationDidChange)
|
|
name:UIApplicationDidChangeStatusBarOrientationNotification
|
|
object:nil];
|
|
|
|
_currentInterfaceDimensions = RCTExportedDimensions(_bridge);
|
|
|
|
[[NSNotificationCenter defaultCenter] addObserver:self
|
|
selector:@selector(interfaceFrameDidChange)
|
|
name:UIApplicationDidBecomeActiveNotification
|
|
object:nil];
|
|
|
|
[[NSNotificationCenter defaultCenter] addObserver:self
|
|
selector:@selector(interfaceFrameDidChange)
|
|
name:RCTUserInterfaceStyleDidChangeNotification
|
|
object:nil];
|
|
|
|
#endif
|
|
}
|
|
|
|
static BOOL RCTIsIPhoneX()
|
|
{
|
|
static BOOL isIPhoneX = NO;
|
|
static dispatch_once_t onceToken;
|
|
|
|
dispatch_once(&onceToken, ^{
|
|
RCTAssertMainQueue();
|
|
|
|
CGSize screenSize = [UIScreen mainScreen].nativeBounds.size;
|
|
CGSize iPhoneXScreenSize = CGSizeMake(1125, 2436);
|
|
CGSize iPhoneXMaxScreenSize = CGSizeMake(1242, 2688);
|
|
CGSize iPhoneXRScreenSize = CGSizeMake(828, 1792);
|
|
|
|
isIPhoneX = CGSizeEqualToSize(screenSize, iPhoneXScreenSize) ||
|
|
CGSizeEqualToSize(screenSize, iPhoneXMaxScreenSize) || CGSizeEqualToSize(screenSize, iPhoneXRScreenSize);
|
|
});
|
|
|
|
return isIPhoneX;
|
|
}
|
|
|
|
static NSDictionary *RCTExportedDimensions(RCTBridge *bridge)
|
|
{
|
|
RCTAssertMainQueue();
|
|
RCTDimensions dimensions = RCTGetDimensions(bridge.accessibilityManager.multiplier);
|
|
__typeof(dimensions.window) window = dimensions.window;
|
|
NSDictionary<NSString *, NSNumber *> *dimsWindow = @{
|
|
@"width" : @(window.width),
|
|
@"height" : @(window.height),
|
|
@"scale" : @(window.scale),
|
|
@"fontScale" : @(window.fontScale)
|
|
};
|
|
__typeof(dimensions.screen) screen = dimensions.screen;
|
|
NSDictionary<NSString *, NSNumber *> *dimsScreen = @{
|
|
@"width" : @(screen.width),
|
|
@"height" : @(screen.height),
|
|
@"scale" : @(screen.scale),
|
|
@"fontScale" : @(screen.fontScale)
|
|
};
|
|
return @{@"window" : dimsWindow, @"screen" : dimsScreen};
|
|
}
|
|
|
|
- (NSDictionary<NSString *, id> *)constantsToExport
|
|
{
|
|
return [self getConstants];
|
|
}
|
|
|
|
- (NSDictionary<NSString *, id> *)getConstants
|
|
{
|
|
__block NSDictionary<NSString *, id> *constants;
|
|
RCTUnsafeExecuteOnMainQueueSync(^{
|
|
constants = @{
|
|
@"Dimensions" : RCTExportedDimensions(self->_bridge),
|
|
// Note:
|
|
// This prop is deprecated and will be removed in a future release.
|
|
// Please use this only for a quick and temporary solution.
|
|
// Use <SafeAreaView> instead.
|
|
@"isIPhoneX_deprecated" : @(RCTIsIPhoneX()),
|
|
};
|
|
});
|
|
|
|
return constants;
|
|
}
|
|
|
|
- (void)didReceiveNewContentSizeMultiplier
|
|
{
|
|
RCTBridge *bridge = _bridge;
|
|
RCTExecuteOnMainQueue(^{
|
|
// Report the event across the bridge.
|
|
#pragma clang diagnostic push
|
|
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
|
|
[bridge.eventDispatcher sendDeviceEventWithName:@"didUpdateDimensions" body:RCTExportedDimensions(bridge)];
|
|
#pragma clang diagnostic pop
|
|
});
|
|
}
|
|
|
|
#if !TARGET_OS_TV
|
|
|
|
- (void)interfaceOrientationDidChange
|
|
{
|
|
__weak __typeof(self) weakSelf = self;
|
|
RCTExecuteOnMainQueue(^{
|
|
[weakSelf _interfaceOrientationDidChange];
|
|
});
|
|
}
|
|
|
|
- (void)_interfaceOrientationDidChange
|
|
{
|
|
UIInterfaceOrientation nextOrientation = [RCTSharedApplication() statusBarOrientation];
|
|
|
|
// Update when we go from portrait to landscape, or landscape to portrait
|
|
if ((UIInterfaceOrientationIsPortrait(_currentInterfaceOrientation) &&
|
|
!UIInterfaceOrientationIsPortrait(nextOrientation)) ||
|
|
(UIInterfaceOrientationIsLandscape(_currentInterfaceOrientation) &&
|
|
!UIInterfaceOrientationIsLandscape(nextOrientation))) {
|
|
#pragma clang diagnostic push
|
|
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
|
|
[_bridge.eventDispatcher sendDeviceEventWithName:@"didUpdateDimensions" body:RCTExportedDimensions(_bridge)];
|
|
#pragma clang diagnostic pop
|
|
}
|
|
|
|
_currentInterfaceOrientation = nextOrientation;
|
|
}
|
|
|
|
- (void)interfaceFrameDidChange
|
|
{
|
|
__weak __typeof(self) weakSelf = self;
|
|
RCTExecuteOnMainQueue(^{
|
|
[weakSelf _interfaceFrameDidChange];
|
|
});
|
|
}
|
|
|
|
- (void)_interfaceFrameDidChange
|
|
{
|
|
NSDictionary *nextInterfaceDimensions = RCTExportedDimensions(_bridge);
|
|
|
|
if (!([nextInterfaceDimensions isEqual:_currentInterfaceDimensions])) {
|
|
#pragma clang diagnostic push
|
|
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
|
|
[_bridge.eventDispatcher sendDeviceEventWithName:@"didUpdateDimensions" body:nextInterfaceDimensions];
|
|
#pragma clang diagnostic pop
|
|
}
|
|
|
|
_currentInterfaceDimensions = nextInterfaceDimensions;
|
|
}
|
|
|
|
#endif // TARGET_OS_TV
|
|
|
|
- (std::shared_ptr<TurboModule>)getTurboModule:(const ObjCTurboModule::InitParams &)params
|
|
{
|
|
return std::make_shared<NativeDeviceInfoSpecJSI>(params);
|
|
}
|
|
|
|
@end
|
|
|
|
Class RCTDeviceInfoCls(void)
|
|
{
|
|
return RCTDeviceInfo.class;
|
|
}
|