bd92bb7faf
Summary: This diff includes minor changes to the pages within the Creating Plugins section of Flipper Docs. Reviewed By: passy Differential Revision: D41497503 fbshipit-source-id: 5c5718b63bfff18322b28b547724415ab40a1810
29 lines
1.9 KiB
Plaintext
29 lines
1.9 KiB
Plaintext
---
|
|
id: client-plugin-lifecycle
|
|
title: Client Plugin Lifecycle
|
|
---
|
|
import useBaseUrl from '@docusaurus/useBaseUrl';
|
|
|
|
There are two types of client plugin: [Regular](#regular-plugin-lifecycle) and [Background](#background-plugin-lifecycle). It's recommended you start off with a regular plugin and switch to a background plugin if necessary.
|
|
|
|
For both types of plugin, it's recommended you start work after the `onConnect` is called then terminate work after `onDisconnect`, when possible. This prevents wasted computation when Flipper isn't connected. If the plugin needs to keep track of events that occur before it gets connected (such as initial network requests on app startup), you should do so in the plugin constructor (or ideally in a separate class).
|
|
|
|
## Regular plugin Lifecycle
|
|
|
|
For regular plugins, `onConnect` and `onDisconnect` are triggered when the user opens the plugin in the Flipper UI, and when they switch to another plugin, respectively.
|
|
The process is illustrated in the following diagram.
|
|
|
|
<img height="300" alt="Regular Plugin Lifecycle diagram" src={useBaseUrl("img/regular-plugin-lifecycle.png")} />
|
|
|
|
## Background Plugin Lifecycle
|
|
|
|
For background plugins, `onConnect` is called when Flipper first connects, and `onDisconnect` when it disconnects. The user does not need to be viewing the plugin for it to send messages; they will be queued up until the next time the user opens the plugin where they will be processed.
|
|
|
|
Even for background plugins, `onDisconnect` and `onConnect` may be called on a plugin (such as if the user restarts Flipper). Plugins should handle this accordingly by making sure to resend any important data to the reconnected instance. The process is illustrated in the following diagram.
|
|
|
|
<img height="300" alt="Background Plugin Lifecycle diagram" src={useBaseUrl("img/bg-plugin-lifecycle.png")} />
|
|
|
|
:::warning
|
|
Note that a plugin must be enabled by the user for its messages to be queued up.
|
|
:::
|