Skip to content
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.

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

fix: Replace calling internal React Native scripts for launching Metro with CLI's script #1812

Merged
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ build/
.watchmanconfig
coverage
!packages/cli-platform-ios/src/config/__fixtures__/native_modules/node_modules
*.env
1 change: 1 addition & 0 deletions packages/cli-platform-android/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
],
"devDependencies": {
"@react-native-community/cli-types": "^11.0.0-alpha.2",
"@react-native-community/cli-plugin-metro": "^11.0.0-alpha.2",
"@types/execa": "^0.9.0",
"@types/fs-extra": "^8.1.0",
"@types/glob": "^7.1.1"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,14 @@ export async function runPackager(args: BuildFlags, config: Config) {
} else {
// result == 'not_running'
logger.info('Starting JS server...');

try {
startServerInNewWindow(args.port, args.terminal, config.reactNativePath);
startServerInNewWindow(
args.port,
args.terminal,
config.root,
config.reactNativePath,
);
} catch (error) {
logger.warn(
`Failed to automatically start the packager server. Please run "react-native start" manually. Error details: ${error.message}`,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,49 +1,75 @@
import path from 'path';
import fs from 'fs';
import execa from 'execa';
import {logger} from '@react-native-community/cli-tools';
import {
CLIError,
logger,
resolveNodeModuleDir,
} from '@react-native-community/cli-tools';

export function startServerInNewWindow(
port: number,
terminal: string,
projectRoot: string,
reactNativePath: string,
) {
/**
* Set up OS-specific filenames and commands
*/
const isWindows = /^win/.test(process.platform);
const scriptFile = isWindows
? 'launchPackager.bat'
: 'launchPackager.command';
const scriptFile = isWindows ? 'launchPackager.bat' : 'launchPackager.sh';
const packagerEnvFilename = isWindows ? '.packager.bat' : '.packager.env';
const portExportContent = isWindows
? `set RCT_METRO_PORT=${port}`
: `export RCT_METRO_PORT=${port}`;
const packagerEnvFileExportContent = isWindows
? `set RCT_METRO_PORT=${port}\nset PROJECT_ROOT=${projectRoot}\nset REACT_NATIVE_PATH=${reactNativePath}`
: `export RCT_METRO_PORT=${port}\nexport PROJECT_ROOT=${projectRoot}\nexport REACT_NATIVE_PATH=${reactNativePath}`;
const nodeModulesPath = resolveNodeModuleDir(projectRoot, '.bin');
const cliPluginMetroPath = path.dirname(
require.resolve('@react-native-community/cli-plugin-metro/package.json'),
);

/**
* Set up the `.packager.(env|bat)` file to ensure the packager starts on the right port.
* Set up the `.packager.(env|bat)` file to ensure the packager starts on the right port and in right directory.
*/
const launchPackagerScript = path.join(
reactNativePath,
`scripts/${scriptFile}`,
);
const packagerEnvFile = path.join(nodeModulesPath, `${packagerEnvFilename}`);

/**
* Set up the `launchpackager.(command|bat)` file.
* Set up the `launchPackager.(command|bat)` file.
* It lives next to `.packager.(bat|env)`
*/
const scriptsDir = path.dirname(launchPackagerScript);
const packagerEnvFile = path.join(scriptsDir, packagerEnvFilename);
const procConfig: execa.SyncOptions = {cwd: scriptsDir};
const launchPackagerScript = path.join(nodeModulesPath, scriptFile);
const procConfig: execa.SyncOptions = {cwd: path.dirname(packagerEnvFile)};

/**
* Ensure we overwrite file by passing the `w` flag
*/
fs.writeFileSync(packagerEnvFile, portExportContent, {
fs.writeFileSync(packagerEnvFile, packagerEnvFileExportContent, {
encoding: 'utf8',
flag: 'w',
});

/**
* Copy files into `node_modules/.bin`.
*/

try {
if (isWindows) {
fs.copyFileSync(
path.join(cliPluginMetroPath, 'launchPackager.bat'),
path.join(nodeModulesPath, 'launchPackager.bat'),
);
} else {
fs.copyFileSync(
path.join(cliPluginMetroPath, 'launchPackager.sh'),
path.join(nodeModulesPath, 'launchPackager.sh'),
);
}
} catch (error) {
return new CLIError(
`Couldn't copy the script for running bundler. Please check if the "${scriptFile}" file exists in the "node_modules/@react-native-community/cli-plugin-metro" folder and try again.`,
error as any,
);
}

if (process.platform === 'darwin') {
try {
return execa.sync(
Expand All @@ -66,7 +92,7 @@ export function startServerInNewWindow(
return execa.sync('sh', [launchPackagerScript], procConfig);
}
}
if (/^win/.test(process.platform)) {
if (isWindows) {
// Awaiting this causes the CLI to hang indefinitely, so this must execute without await.
return execa('cmd.exe', ['/C', launchPackagerScript], {
...procConfig,
Expand Down
7 changes: 7 additions & 0 deletions packages/cli-plugin-metro/launchPackager.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
@echo off
title Metro
call .packager.bat
cd "%PROJECT_ROOT%"
node "%REACT_NATIVE_PATH%/cli.js" start
pause
exit
9 changes: 9 additions & 0 deletions packages/cli-plugin-metro/launchPackager.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
THIS_DIR=$(cd -P "$(dirname "$(readlink "${BASH_SOURCE[0]}" || echo "${BASH_SOURCE[0]}")")" && pwd)
source "$THIS_DIR/.packager.env"
cd $PROJECT_ROOT
$REACT_NATIVE_PATH/cli.js start

if [[ -z "$CI" ]]; then
echo "Process terminated. Press <enter> to close the window"
read -r
fi