Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plugins: Refactor the 'PluginArea' component to use the sync store #49220

Merged
merged 1 commit into from
Mar 24, 2023
Merged

Plugins: Refactor the 'PluginArea' component to use the sync store #49220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions packages/plugins/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ const Layout = () => (
);
```

_Parameters_

- _props_ `Object`:
- _props.scope_ `string|undefined`:
- _props.onError_ `Function|undefined`:

_Returns_

- `WPComponent`: The component to be rendered.
Expand Down
1 change: 1 addition & 0 deletions packages/plugins/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"@wordpress/element": "file:../element",
"@wordpress/hooks": "file:../hooks",
"@wordpress/icons": "file:../icons",
"@wordpress/is-shallow-equal": "file:../is-shallow-equal",
"memize": "^1.1.0"
},
"peerDependencies": {
Expand Down
125 changes: 56 additions & 69 deletions packages/plugins/src/components/plugin-area/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ import memoize from 'memize';
/**
* WordPress dependencies
*/
import { Component } from '@wordpress/element';
import { useMemo, useSyncExternalStore } from '@wordpress/element';
import { addAction, removeAction } from '@wordpress/hooks';
import isShallowEqual from '@wordpress/is-shallow-equal';

/**
* Internal dependencies
Expand All @@ -16,9 +17,14 @@ import { PluginContextProvider } from '../plugin-context';
import { PluginErrorBoundary } from '../plugin-error-boundary';
import { getPlugins } from '../../api';

const getPluginContext = memoize( ( icon, name ) => ( { icon, name } ) );

/**
* A component that renders all plugin fills in a hidden div.
*
* @param {Object} props
* @param {string|undefined} props.scope
* @param {Function|undefined} props.onError
* @example
* ```js
* // Using ES5 syntax
Expand Down Expand Up @@ -50,80 +56,61 @@ import { getPlugins } from '../../api';
*
* @return {WPComponent} The component to be rendered.
*/
class PluginArea extends Component {
constructor() {
super( ...arguments );

this.setPlugins = this.setPlugins.bind( this );
this.memoizedContext = memoize( ( name, icon ) => {
return {
name,
icon,
};
} );
this.state = this.getCurrentPluginsState();
}
function PluginArea( { scope, onError } ) {
const store = useMemo( () => {
let lastValue;

getCurrentPluginsState() {
return {
plugins: getPlugins( this.props.scope ).map(
( { icon, name, render } ) => {
return {
Plugin: render,
context: this.memoizedContext( name, icon ),
};
}
),
};
}
subscribe( listener ) {
addAction(
'plugins.pluginRegistered',
'core/plugins/plugin-area/plugins-registered',
listener
);
addAction(
'plugins.pluginUnregistered',
'core/plugins/plugin-area/plugins-unregistered',
listener
);
return () => {
removeAction(
'plugins.pluginRegistered',
'core/plugins/plugin-area/plugins-registered'
);
removeAction(
'plugins.pluginUnregistered',
'core/plugins/plugin-area/plugins-unregistered'
);
};
},
getValue() {
const nextValue = getPlugins( scope );

componentDidMount() {
addAction(
'plugins.pluginRegistered',
'core/plugins/plugin-area/plugins-registered',
this.setPlugins
);
addAction(
'plugins.pluginUnregistered',
'core/plugins/plugin-area/plugins-unregistered',
this.setPlugins
);
}
if ( ! isShallowEqual( lastValue, nextValue ) ) {
lastValue = nextValue;
}

componentWillUnmount() {
removeAction(
'plugins.pluginRegistered',
'core/plugins/plugin-area/plugins-registered'
);
removeAction(
'plugins.pluginUnregistered',
'core/plugins/plugin-area/plugins-unregistered'
);
}
return lastValue;
},
};
}, [ scope ] );

setPlugins() {
this.setState( this.getCurrentPluginsState );
}
const plugins = useSyncExternalStore( store.subscribe, store.getValue );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think plugins and store could be abstracted to their own usePluginsState hook. Not a huge deal of course, since it's used only in one place.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also thought about it. Let’s abstract when there’s another use for them.


render() {
return (
<div style={ { display: 'none' } }>
{ this.state.plugins.map( ( { context, Plugin } ) => (
<PluginContextProvider
key={ context.name }
value={ context }
>
<PluginErrorBoundary
name={ context.name }
onError={ this.props.onError }
>
<Plugin />
</PluginErrorBoundary>
</PluginContextProvider>
) ) }
</div>
);
}
return (
<div style={ { display: 'none' } }>
{ plugins.map( ( { icon, name, render: Plugin } ) => (
<PluginContextProvider
key={ name }
value={ getPluginContext( icon, name ) }
>
<PluginErrorBoundary name={ name } onError={ onError }>
<Plugin />
</PluginErrorBoundary>
</PluginContextProvider>
) ) }
</div>
);
}

export default PluginArea;
38 changes: 17 additions & 21 deletions packages/plugins/src/components/test/plugin-area.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,30 +92,26 @@ describe( 'PluginArea', () => {
expect( container ).toHaveTextContent( 'plugin: two.' );
} );

test.failing(
'does not rerender when a plugin is added to a different scope',
() => {
const ComponentSpy = jest.fn( ( { content } ) => {
return `plugin: ${ content }.`;
} );
test( 'does not rerender when a plugin is added to a different scope', () => {
const ComponentSpy = jest.fn( ( { content } ) => {
return `plugin: ${ content }.`;
} );

registerPlugin( 'scoped', {
render: () => <ComponentSpy content="scoped" />,
icon: 'smiley',
scope: 'my-app',
} );
registerPlugin( 'scoped', {
render: () => <ComponentSpy content="scoped" />,
icon: 'smiley',
scope: 'my-app',
} );

render( <PluginArea scope="my-app" /> );
render( <PluginArea scope="my-app" /> );

act( () => {
registerPlugin( 'unscoped', {
render: () => <TestComponent content="unscoped" />,
icon: 'smiley',
} );
act( () => {
registerPlugin( 'unscoped', {
render: () => <TestComponent content="unscoped" />,
icon: 'smiley',
} );
} );

// Any store update triggers setState and causes PluginArea to rerender.
expect( ComponentSpy ).toHaveBeenCalledTimes( 1 );
}
);
expect( ComponentSpy ).toHaveBeenCalledTimes( 1 );
} );
} );