38c81ca159
Summary: Pull Request resolved: https://github.com/facebook/flipper/pull/3473 This diff is the first one which addresses https://github.com/facebook/flipper/issues/3320. In this diff we are making a part of the code used for internal Flipper plugin distribution in Meta also available publicly for re-using in other orgs. Some explanation on how plugin installation and updates is designed now: 1) We periodically poll for plugins available for download. API for retrieving available plugins list is abstracted and will be different between public and fb versions, however all other logic is re-used. 2) In addition to "Enabled" and "Disabled" plugins in the left panel Flipper shows "Detected in App" list. Plugins in this list are those which are known compatible with the currently selected device/app, but not yet installed. 3) User can install any of "Detected in App" plugins by clicking to "Download and install" button near them in the left panel similarly to enabling plugins in "Disabled" list. 4) If we detect that for some installed plugin we have a newer version available for download - we download it silently and store on disk. 5) If the plugin for which we have new downloaded version is disabled - we update it silently without any notifications by loading new version from the disk and unloading the previous version from cache. 6) If the plugin for which we have new downloaded version is enabled then we avoid updating it automatically (because we need to reset plugin state in such case) and instead show notification on top of the plugin and ask user to reload it to apply new version. On reloading we reset the plugin state. 7) On Flipper startup we always update all plugins to their latest versions available on the disk. Reviewed By: aigoncharov Differential Revision: D34380308 fbshipit-source-id: a94d724e42aa5ef78445af266fcd4c424226a703
Flipper
Flipper (formerly Sonar) is a platform for debugging mobile apps on iOS and Android and, recently, even JS apps in your browser or in Node.js. Visualize, inspect, and control your apps from a simple desktop interface. Use Flipper as is or extend it using the plugin API.
Table of Contents
Mobile development
Flipper aims to be your number one companion for mobile app development on iOS and Android. Therefore, we provide a bunch of useful tools, including a log viewer, interactive layout inspector, and network inspector.
Extending Flipper
Flipper is built as a platform. In addition to using the tools already included, you can create your own plugins to visualize and debug data from your mobile apps. Flipper takes care of sending data back and forth, calling functions, and listening for events on the mobile app.
Contributing to Flipper
Both Flipper's desktop app, native mobile SDKs, JS SDKs are open-source and MIT licensed. This enables you to see and understand how we are building plugins, and of course, join the community and help to improve Flipper. We are excited to see what you will build on this platform.
In this repo
This repository includes all parts of Flipper. This includes:
- Flipper's desktop app built using Electron
(
/desktop) - native Flipper SDKs for iOS (
/iOS) - native Flipper SDKs for Android (
/android) - React Native Flipper SDK (
/react-native) - JS Flipper SDK (
/js) - Plugins:
- Logs (
/desktop/plugins/public/logs) - Layout inspector (
/desktop/plugins/public/layout) - Network inspector (
/desktop/plugins/public/network) - Shared Preferences/NSUserDefaults inspector
(
/desktop/plugins/public/shared_preferences)
- Logs (
- website and documentation (
/website//docs)
Getting started
Please refer to our
Getting Started guide to set
up Flipper.
Or, (still experimental) run npx flipper-server for a browser based version of Flipper.
Requirements
- node >= 8
- yarn >= 1.5
- iOS developer tools (for developing iOS plugins)
- Android SDK and adb
Building from Source
Desktop
Running from source
git clone https://github.com/facebook/flipper.git
cd flipper/desktop
yarn
yarn start
NOTE: If you're on Windows, you need to use Yarn 1.5.1 until this issue is resolved.
Building standalone application
Provide either --mac, --win, --linux or any combination of them to
yarn build to build a release zip file for the given platform(s). E.g.
yarn build --mac --version $buildNumber
You can find the resulting artifact in the dist/ folder.
iOS SDK + Sample App
cd iOS/Sample
rm -f Podfile.lock
pod install --repo-update
open Sample.xcworkspace
<Run app from xcode>
You can omit --repo-update to speed up the installation, but watch out as you
may be building against outdated dependencies.
Android SDK + Sample app
Start up an android emulator and run the following in the project root:
./gradlew :sample:installDebug
React Native SDK + Sample app
cd react-native/ReactNativeFlipperExample
yarn
yarn android
Note that the first 2 steps need to be done only once.
Alternatively, the app can be started on iOS by running yarn ios.
If this is the first time running, you will also need to run
pod install --repo-update from the
react-native/ReactNativeFlipperExample/ios folder.
JS SDK + Sample React app
cd js/react-flipper-example
yarn
yarn start
Troubleshooting
Older yarn versions might show an error / hang with the message 'Waiting for the
other yarn instance to finish'. If that happens, run the command yarn first
separately in the directory react-native/react-native-flipper.
Documentation
Find the full documentation for this project at fbflipper.com.
Our documentation is built with Docusaurus. You can build it locally by running this:
cd website
yarn
yarn start
Contributing
See the CONTRIBUTING file for how to help out.
License
Flipper is MIT licensed, as found in the LICENSE file.