jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Expose Immer's produce from Flipper

Browse Source 
Summary: Diff preparing for optimizing GraphQL (and other) plugins, and simplifying writing reducers by others

Reviewed By: nikoant

Differential Revision: D18930858

fbshipit-source-id: 91d176d77543978d65ea50635d4ed380690b1fa2
This commit is contained in:
Michel Weststrate
2019-12-13 07:07:48 -08:00
committed by Facebook Github Bot
parent 334e0dd2d9
commit 8da2c8868b
4 changed files with 30 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/extending/js-plugin-api.md
View File

@@ -68,7 +68,8 @@ Informs the plugin whether or not the client is archived, and therefore not curr
Sometimes it's desirable for a plugin to be able to process incoming messages from the client even when inactive.
To do this, define a static `persistedStateReducer` function in the plugin class:
```
```typescript
static persistedStateReducer<PersistedState>(
persistedState: PersistedState,
method: string,
@@ -78,6 +79,26 @@ static persistedStateReducer<PersistedState>(
The job of the `persistedStateReducer` is to merge incoming data into the state, so that next time the plugin is activated, the persisted state will be ready.
The data that is produced from `persistedStateReducer` should be immutable, but also structurally sharing unchanged parts of the state with the previous state to avoid performance hiccups. To simplify this process we recommend using the [Immer](https://immerjs.github.io/immer/docs/introduction) package.
Immer makes it possible to keep the reducer concise by directly supporting "writing" to the current state, and keeping track of that in the background.
Also it will guarantee that there are no accidental data manipulations by freezing the produced state.
You can directly `import {produce} from "flipper"` so there is no need to add Immer as additional dependency.
A quick example:
```typescript
static persistedStateReducer(persistedState, method, data) {
return produce(persistedState, draft => {
if (method.name === "newRecord") {
draft.lastRecordReceived = Date.now();
draft.records.push(data);
}
});
}
```
## Notifications
Plugins can publish system notifications to alert the user of something. This is particularly useful when the plugin isn't the current active plugin. All notifications are aggregated in Flipper's notifications pane, accessible from the sidebar.