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

Make sure that limited top-level exports are exposed from flipper-plugin

Browse Source 
Summary: This prefixes APIs of `flipper-plugin`, that are used by Flipper, but should not be used by plugins directly, with `_`. Also added tests to make sure we are always intentional when extending the exposed APIs

Reviewed By: passy

Differential Revision: D24991700

fbshipit-source-id: ed3700efa188fca7f5a14d5c68250598cf011e42
This commit is contained in:
Michel Weststrate
2020-11-16 13:08:05 -08:00
committed by Facebook GitHub Bot
parent cc438e60ad
commit 45db64f0d0
21 changed files with 156 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
desktop/app/src/reducers/__tests__/sandyplugins.node.tsx
View File

@@ -12,8 +12,8 @@ import {Store, Client} from '../../';
import {selectPlugin, starPlugin} from '../../reducers/connections';
import {registerPlugins} from '../../reducers/plugins';
import {
SandyPluginDefinition,
SandyPluginInstance,
_SandyPluginDefinition,
_SandyPluginInstance,
PluginClient,
TestUtils,
} from 'flipper-plugin';
@@ -49,7 +49,7 @@ function plugin(client: PluginClient<any, any>) {
messages,
};
}
const TestPlugin = new SandyPluginDefinition(pluginDetails, {
const TestPlugin = new _SandyPluginDefinition(pluginDetails, {
plugin: jest.fn().mockImplementation(plugin) as typeof plugin,
Component: jest.fn().mockImplementation(() => null),
});
@@ -82,7 +82,7 @@ test('it should initialize starred sandy plugins', async () => {
// already started, so initialized immediately
expect(initialized).toBe(true);
expect(client.sandyPluginStates.get(TestPlugin.id)).toBeInstanceOf(
SandyPluginInstance,
_SandyPluginInstance,
);
const instanceApi: PluginApi = client.sandyPluginStates.get(TestPlugin.id)!
.instanceApi;
@@ -132,7 +132,7 @@ test('it should cleanup if client is removed', async () => {
test('it should not initialize a sandy plugin if not enabled', async () => {
const {client, store} = await createMockFlipperWithPlugin(TestPlugin);
const Plugin2 = new SandyPluginDefinition(
const Plugin2 = new _SandyPluginDefinition(
TestUtils.createMockPluginDetails({
name: 'Plugin2',
id: 'Plugin2',
@@ -146,7 +146,7 @@ test('it should not initialize a sandy plugin if not enabled', async () => {
);
const pluginState1 = client.sandyPluginStates.get(TestPlugin.id);
expect(pluginState1).toBeInstanceOf(SandyPluginInstance);
expect(pluginState1).toBeInstanceOf(_SandyPluginInstance);
store.dispatch(registerPlugins([Plugin2]));
await client.refreshPlugins();
// not yet enabled, so not yet started
@@ -161,7 +161,7 @@ test('it should not initialize a sandy plugin if not enabled', async () => {
);
expect(client.sandyPluginStates.get(Plugin2.id)).toBeInstanceOf(
SandyPluginInstance,
_SandyPluginInstance,
);
const instance = client.sandyPluginStates.get(Plugin2.id)!
.instanceApi as PluginApi;
@@ -238,7 +238,7 @@ test('it can send messages from sandy clients', async () => {
test('it should initialize "Navigation" plugin if not enabled', async () => {
const {client, store} = await createMockFlipperWithPlugin(TestPlugin);
const Plugin2 = new SandyPluginDefinition(
const Plugin2 = new _SandyPluginDefinition(
TestUtils.createMockPluginDetails({
name: 'Plugin2',
id: 'Navigation',
@@ -252,7 +252,7 @@ test('it should initialize "Navigation" plugin if not enabled', async () => {
);
const pluginState1 = client.sandyPluginStates.get(TestPlugin.id);
expect(pluginState1).toBeInstanceOf(SandyPluginInstance);
expect(pluginState1).toBeInstanceOf(_SandyPluginInstance);
store.dispatch(registerPlugins([Plugin2]));
await client.refreshPlugins();
// not enabled, but Navigation is an exception, so we still get an instance