159c0deaf1
Summary: `usePlugin(pluginFactory)` returns the current plugin instance's api that was exposed by the plugin directory. Passing `pluginFactory` is technically strictly not needed, but having the user pass it, we can make sure it is strongly typed Reviewed By: nikoant Differential Revision: D22286293 fbshipit-source-id: 4268b6849b8cd3d524103de7eadbd6c0a65c7a61
199 lines
4.9 KiB
TypeScript
199 lines
4.9 KiB
TypeScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
*/
|
|
|
|
import React, {useContext} from 'react';
|
|
import produce from 'immer';
|
|
import {FlipperPlugin} from '../plugin';
|
|
import {renderMockFlipperWithPlugin} from '../test-utils/createMockFlipperWithPlugin';
|
|
import {
|
|
SandyPluginContext,
|
|
SandyPluginDefinition,
|
|
FlipperClient,
|
|
TestUtils,
|
|
usePlugin,
|
|
} from 'flipper-plugin';
|
|
import {selectPlugin} from '../reducers/connections';
|
|
|
|
interface PersistedState {
|
|
count: 1;
|
|
}
|
|
|
|
class TestPlugin extends FlipperPlugin<any, any, any> {
|
|
static id = 'TestPlugin';
|
|
|
|
static defaultPersistedState = {
|
|
count: 0,
|
|
};
|
|
|
|
static persistedStateReducer(
|
|
persistedState: PersistedState,
|
|
method: string,
|
|
payload: {delta?: number},
|
|
) {
|
|
return produce(persistedState, (draft) => {
|
|
if (method === 'inc') {
|
|
draft.count += payload?.delta || 1;
|
|
}
|
|
});
|
|
}
|
|
|
|
render() {
|
|
return (
|
|
<h1>
|
|
Hello:{' '}
|
|
<span data-testid="counter">{this.props.persistedState.count}</span>
|
|
</h1>
|
|
);
|
|
}
|
|
}
|
|
|
|
test('Plugin container can render plugin and receive updates', async () => {
|
|
const {renderer, sendMessage, act} = await renderMockFlipperWithPlugin(
|
|
TestPlugin,
|
|
);
|
|
expect(renderer.baseElement).toMatchInlineSnapshot(`
|
|
<body>
|
|
<div>
|
|
<div
|
|
class="css-1orvm1g-View-FlexBox-FlexColumn"
|
|
>
|
|
<h1>
|
|
Hello:
|
|
|
|
<span
|
|
data-testid="counter"
|
|
>
|
|
0
|
|
</span>
|
|
</h1>
|
|
</div>
|
|
<div
|
|
class="css-bxcvv9-View-FlexBox-FlexRow"
|
|
id="detailsSidebar"
|
|
/>
|
|
</div>
|
|
</body>
|
|
`);
|
|
|
|
act(() => {
|
|
sendMessage('inc', {delta: 2});
|
|
});
|
|
|
|
expect((await renderer.findByTestId('counter')).textContent).toBe('2');
|
|
});
|
|
|
|
test('PluginContainer can render Sandy plugins', async () => {
|
|
let renders = 0;
|
|
|
|
function MySandyPlugin() {
|
|
renders++;
|
|
const sandyApi = usePlugin(plugin);
|
|
expect(Object.keys(sandyApi)).toEqual([
|
|
'connectedStub',
|
|
'disconnectedStub',
|
|
]);
|
|
expect(() => {
|
|
// eslint-disable-next-line
|
|
usePlugin(function bla() {
|
|
return {};
|
|
});
|
|
}).toThrowError(/didn't match the type of the requested plugin/);
|
|
return <div>Hello from Sandy</div>;
|
|
}
|
|
|
|
const plugin = (client: FlipperClient) => {
|
|
const connectedStub = jest.fn();
|
|
const disconnectedStub = jest.fn();
|
|
client.onConnect(connectedStub);
|
|
client.onDisconnect(disconnectedStub);
|
|
return {connectedStub, disconnectedStub};
|
|
};
|
|
|
|
const definition = new SandyPluginDefinition(
|
|
TestUtils.createMockPluginDetails(),
|
|
{
|
|
plugin,
|
|
Component: MySandyPlugin,
|
|
},
|
|
);
|
|
// any cast because this plugin is not enriched with the meta data that the plugin loader
|
|
// normally adds. Our further sandy plugin test infra won't need this, but
|
|
// for this test we do need to act a s a loaded plugin, to make sure PluginContainer itself can handle it
|
|
const {
|
|
renderer,
|
|
act,
|
|
sendMessage,
|
|
client,
|
|
store,
|
|
} = await renderMockFlipperWithPlugin(definition);
|
|
expect(renderer.baseElement).toMatchInlineSnapshot(`
|
|
<body>
|
|
<div>
|
|
<div
|
|
class="css-1orvm1g-View-FlexBox-FlexColumn"
|
|
>
|
|
<div>
|
|
Hello from Sandy
|
|
</div>
|
|
</div>
|
|
<div
|
|
class="css-bxcvv9-View-FlexBox-FlexRow"
|
|
id="detailsSidebar"
|
|
/>
|
|
</div>
|
|
</body>
|
|
`);
|
|
expect(renders).toBe(1);
|
|
|
|
// sending a new message doesn't cause a re-render
|
|
act(() => {
|
|
sendMessage('inc', {delta: 2});
|
|
});
|
|
expect(renders).toBe(1);
|
|
|
|
// make sure the plugin gets connected
|
|
const pluginInstance: ReturnType<typeof plugin> = client.sandyPluginStates.get(
|
|
definition.id,
|
|
)!.instanceApi;
|
|
expect(pluginInstance.connectedStub).toBeCalledTimes(1);
|
|
expect(pluginInstance.disconnectedStub).toBeCalledTimes(0);
|
|
|
|
// TODO: check that messages have arrived T68683442
|
|
|
|
// select non existing plugin
|
|
act(() => {
|
|
store.dispatch(
|
|
selectPlugin({
|
|
selectedPlugin: 'Logs',
|
|
deepLinkPayload: null,
|
|
}),
|
|
);
|
|
});
|
|
|
|
expect(renderer.baseElement).toMatchInlineSnapshot(`
|
|
<body>
|
|
<div />
|
|
</body>
|
|
`);
|
|
expect(pluginInstance.connectedStub).toBeCalledTimes(1);
|
|
expect(pluginInstance.disconnectedStub).toBeCalledTimes(1);
|
|
|
|
// go back
|
|
act(() => {
|
|
store.dispatch(
|
|
selectPlugin({
|
|
selectedPlugin: definition.id,
|
|
deepLinkPayload: null,
|
|
}),
|
|
);
|
|
});
|
|
expect(pluginInstance.connectedStub).toBeCalledTimes(2);
|
|
expect(pluginInstance.disconnectedStub).toBeCalledTimes(1);
|
|
});
|