A framework for building native applications using React
Go to file
Edmond Chui 8507204b53 fix /open-debugger failing after relaunching Metro/target app (#47623)
Summary:
Pull Request resolved: https://github.com/facebook/react-native/pull/47623

Changelog:
[iOS][Fixed] - "Reconnect DevTools" button not working sometimes

Hotfix for "Reconnect DevTools" button not working:

* T206141946 / [WP: Reconnecting dev tools does not work after restarting the app](https://fb.workplace.com/groups/rn.debugger.feedback/posts/1107620434125533)
* T206754760 / [WP: Can't launch DevTools from Metro sometimes](https://fb.workplace.com/groups/rn.debugger.feedback/posts/1112235073664069/)

Basically, this dialog will keep reappearing like a bad dream:

 {F1960030622}

# Repro

Part 1 (Fixed in base stack D65973309)
1. Do NOT have Metro ready.
1. Build and run RNTester/FB Wilde
1. They should be using the local bundled version. App may prompt you to start Metro.
1. Start Metro
1. Go to the device Dev Menu (rage shake) and select Reload
1. Press `r` or `d` in Metro

Expected: Reload and Dev Menu work accordingly
Actual: Metro fails with `No apps connected`:

 {F1960039703}

Part 2 (Fixed in this diff)
1. Open React Native DevTools via Metro `j` key or Dev Menu (rage shake)
1. Kill Metro
1. The RN DevTools should show the "disconnected" dialog
1. Start Metro
1. Click "Reconnect DevTools" in RN DevTools

Expected: reconnects
Actual: dialog reappears with an error in Metro:
{F1960043097}

Interestingly, the `r` and `d` keys from Metro works.

# Root cause(s)
Part 1: See D65973309
Part 2:
The error indicates the target/device failed to call `/inspector/device` to register itself. The subsequent calls to `/json/list` returns empty and `/open-debugger` throws.

1. But because `r` & `d` (heh) works, we can observe that there is some kind of auto-reconnect mechanism:

https://www.internalfb.com/code/fbsource/[cfe1706a60b2]/xplat/js/react-native-github/packages/react-native/Libraries/WebSocket/RCTReconnectingWebSocket.m?lines=77-82

1. We do have auto-reconnect for `j` too:

https://www.internalfb.com/code/fbsource/[cfe1706a60b2]/xplat/js/react-native-github/packages/react-native/ReactCommon/jsinspector-modern/InspectorPackagerConnection.cpp?lines=246-254

But unfortunately it only tries once. A long-term fix would be calling reconnect recursively like the Objective-C impl above, e.g.

Edit: the long-term fix ! See V3

```
  delegate_->scheduleCallback(
      [weakSelf = weak_from_this()] {
        auto strongSelf = weakSelf.lock();
        if (strongSelf && !strongSelf->closed_) {
          strongSelf->reconnectPending_ = false;
          strongSelf->connect();

          // Keep trying. Never. Give. Up.
          if (!strongSelf->isConnected()) {
            strongSelf->reconnect();
          }
        }
      },
      RECONNECT_DELAY);
```

Edit: I snuck in some time during React Native London Conf and got the long-term fix going! ✌️

{gif:7iyrns4l}

~~It appears that the current impl of `isConnected()` is not a true reflection of the web socket state. My time box for this task ran out, so we'll do a hot fix for the short-term: since we know `r` & `d` reliably reconnects, we'll piggy-back on its lifecycle to attempt reconnection. This works. I'm going on PTO for the year, so the follow-up task is up for grabs here: T207775935.~~

# PS

1. If you start the app with Metro running in step 1, this bug is not present. This is the reason why FB Wilde/Marketplace/Quantum engineers run into this more often (because its custom menu changes the JS URL after start up)
2. This auto-reconnect does not mean the RN DevTools frontend will dismiss the dialog automatically. This is only about the `Metro <> Device` in `Frontend <> Metro <> Device`.
    1. Current impl in Metro/Inspector Proxy means that whenever the `Metro <> Device` connection is terminated, the `Frontend <> Metro` connection is killed.
    1. This diff helps restore the `Metro <> Device` connection.
    1. The `Frontend <> Metro` connection does not currently get reconnected. We can make the Frontend do so, with consideration of preserving logs/states, etc.

Reviewed By: robhogan

Differential Revision: D65952134

fbshipit-source-id: 3abd16f6a7b7ed50e8acdb7c753cc4fbd3317236
2024-11-18 11:30:23 -08:00
.bundle
.circleci Remove CCI leftovers (#45589) 2024-07-23 06:40:08 -07:00
.github Only build ios in check nightlies (#47506) 2024-11-08 04:28:32 -08:00
flow-typed/npm add yargs#usage typing (#46983) 2024-10-11 11:27:09 -07:00
gradle/wrapper Gradle to 8.10.2 (#46656) 2024-09-27 00:43:25 -07:00
jest Filter out AppRegistry logs from output (#47658) 2024-11-18 04:38:43 -08:00
packages fix /open-debugger failing after relaunching Metro/target app (#47623) 2024-11-18 11:30:23 -08:00
scripts Add Flow typing for test runner for RN integration tests (#47612) 2024-11-15 03:00:17 -08:00
tools RN: Fix sort-imports Lint Configuration (#47104) 2024-10-17 17:06:20 -07:00
.babelrc
.clang-format
.editorconfig
.eslintignore
.eslintrc.js RN: Fix sort-imports Lint Configuration (#47104) 2024-10-17 17:06:20 -07:00
.flowconfig Enable ban_spread_key_props in xplat/js (#47636) 2024-11-15 14:18:51 -08:00
.gitignore Initial implementation of Jest test runner for RN integration tests (#47558) 2024-11-14 06:20:47 -08:00
.prettierignore Fixes enum codegen value cases (#44654) 2024-06-07 07:53:59 -07:00
.prettierrc Format code-workspace file, clarify use of .vscode/ dir (#44874) 2024-06-11 09:27:48 -07:00
build.gradle.kts Make build_android publish to the staging repositories (#45468) 2024-07-16 13:58:43 -07:00
CHANGELOG-pre-060.md
CHANGELOG-pre-070.md
CHANGELOG.md Add changelog for 0.76.2 (#47620) 2024-11-15 04:58:13 -08:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md
ECOSYSTEM.md
Gemfile Pin Xcodeproj to < 1.26.0 (#47237) 2024-10-28 04:20:31 -07:00
Gemfile.lock feat: add conditionals for iOS only code in RCTDeviceInfo.mm (#45176) 2024-06-28 06:02:38 -07:00
gradle.properties
gradlew Gradle to 8.9 (#45407) 2024-07-12 09:00:39 -07:00
gradlew.bat Gradle to 8.10 (#46369) 2024-09-06 09:28:13 -07:00
jest.config.js fix: running local tests (#46615) 2024-09-25 05:51:49 -07:00
LICENSE
LICENSE-docs
package.json Deploy 0.253.0 to xplat (#47622) 2024-11-14 14:05:17 -08:00
react-native.code-workspace Format code-workspace file, clarify use of .vscode/ dir (#44874) 2024-06-11 09:27:48 -07:00
README.md
runXcodeTests.sh
settings.gradle.kts Revert D59170923 (#45447) 2024-07-15 13:44:09 -07:00
yarn.lock Deploy 0.253.0 to xplat (#47622) 2024-11-14 14:05:17 -08:00

React Native

Learn once, write anywhere:
Build mobile apps with React.

React Native is released under the MIT license. Current CircleCI build status. Current npm package version. PRs welcome! Follow @reactnative

Getting Started · Learn the Basics · Showcase · Contribute · Community · Support

React Native brings React's declarative UI framework to iOS and Android. With React Native, you use native UI controls and have full access to the native platform.

  • Declarative. React makes it painless to create interactive UIs. Declarative views make your code more predictable and easier to debug.
  • Component-Based. Build encapsulated components that manage their state, then compose them to make complex UIs.
  • Developer Velocity. See local changes in seconds. Changes to JavaScript code can be live reloaded without rebuilding the native app.
  • Portability. Reuse code across iOS, Android, and other platforms.

React Native is developed and supported by many companies and individual core contributors. Find out more in our ecosystem overview.

Contents

📋 Requirements

React Native apps may target iOS 13.4 and Android 6.0 (API 23) or newer. You may use Windows, macOS, or Linux as your development operating system, though building and running iOS apps is limited to macOS. Tools like Expo can be used to work around this.

🎉 Building your first React Native app

Follow the Getting Started guide. The recommended way to install React Native depends on your project. Here you can find short guides for the most common scenarios:

📖 Documentation

The full documentation for React Native can be found on our website.

The React Native documentation discusses components, APIs, and topics that are specific to React Native. For further documentation on the React API that is shared between React Native and React DOM, refer to the React documentation.

The source for the React Native documentation and website is hosted on a separate repo, @facebook/react-native-website.

🚀 Upgrading

Upgrading to new versions of React Native may give you access to more APIs, views, developer tools, and other goodies. See the Upgrading Guide for instructions.

React Native releases are discussed in this discussion repo.

👏 How to Contribute

The main purpose of this repository is to continue evolving React Native core. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving React Native.

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to React Native.

Open Source Roadmap

You can learn more about our vision for React Native in the Roadmap.

Good First Issues

We have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

Discussions

Larger discussions and proposals are discussed in @react-native-community/discussions-and-proposals.

📄 License

React Native is MIT licensed, as found in the LICENSE file.

React Native documentation is Creative Commons licensed, as found in the LICENSE-docs file.