@wordpress/edit-post 8.43.1-next.v.202604091042.0 → 8.45.0

package/src/components/meta-boxes/test/use-meta-box-initialization.js

@@ -0,0 +1,191 @@
+/**
+ * External dependencies
+ */
+import { render } from '@testing-library/react';
+
+/**
+ * WordPress dependencies
+ */
+import { RegistryProvider, createRegistry } from '@wordpress/data';
+
+/**
+ * Internal dependencies
+ */
+import { useMetaBoxInitialization } from '../use-meta-box-initialization';
+import { STORE_NAME } from '../../../store/constants';
+
+// Mock unlock to be an identity function so private actions are directly accessible.
+jest.mock( '../../../lock-unlock', () => ( {
+	unlock: ( value ) => value,
+} ) );
+
+const storeConfig = {
+	actions: {
+		forceUpdate: jest.fn( () => ( { type: 'FORCE_UPDATE' } ) ),
+	},
+	reducer: ( state = {}, action ) =>
+		action.type === 'FORCE_UPDATE' ? { ...state } : state,
+};
+
+const setCollaborationSupported = jest.fn( () => ( {
+	type: 'SET_COLLABORATION_SUPPORTED',
+} ) );
+
+const initializeMetaBoxes = jest.fn( () => ( {
+	type: 'META_BOXES_INITIALIZED',
+} ) );
+
+function createMockStores( {
+	isEditorReady = true,
+	isCollaborationEnabled = true,
+	metaBoxes = [],
+} = {} ) {
+	return {
+		'core/editor': {
+			...storeConfig,
+			selectors: {
+				__unstableIsEditorReady: jest.fn( () => isEditorReady ),
+				isCollaborationEnabledForCurrentPost: jest.fn(
+					() => isCollaborationEnabled
+				),
+			},
+		},
+		core: {
+			...storeConfig,
+			actions: {
+				...storeConfig.actions,
+				setCollaborationSupported,
+			},
+		},
+		[ STORE_NAME ]: {
+			...storeConfig,
+			actions: {
+				...storeConfig.actions,
+				initializeMetaBoxes,
+			},
+			selectors: {
+				getAllMetaBoxes: jest.fn( () => metaBoxes ),
+				hasMetaBoxes: jest.fn( () => metaBoxes.length > 0 ),
+				getActiveMetaBoxLocations: jest.fn( () =>
+					metaBoxes.length > 0 ? [ 'normal' ] : []
+				),
+			},
+		},
+	};
+}
+
+function TestComponent( { enabled } ) {
+	useMetaBoxInitialization( enabled );
+	return null;
+}
+
+function renderHook( registry, enabled = true ) {
+	return render(
+		<RegistryProvider value={ registry }>
+			<TestComponent enabled={ enabled } />
+		</RegistryProvider>
+	);
+}
+
+describe( 'useMetaBoxInitialization', () => {
+	afterEach( () => {
+		setCollaborationSupported.mockClear();
+		initializeMetaBoxes.mockClear();
+	} );
+
+	it( 'disables collaboration when metaboxes are present', () => {
+		const mockStores = createMockStores( {
+			metaBoxes: [
+				{ id: 'my-metabox', title: 'My Meta Box' },
+				{ id: 'another-metabox', title: 'Another' },
+			],
+		} );
+		const registry = createRegistry( mockStores );
+
+		renderHook( registry );
+
+		expect( initializeMetaBoxes ).toHaveBeenCalled();
+		expect( setCollaborationSupported ).toHaveBeenCalledWith( false );
+	} );
+
+	it( 'does not disable collaboration when all metaboxes are rtcCompatible', () => {
+		const mockStores = createMockStores( {
+			metaBoxes: [
+				{
+					id: 'my-metabox',
+					title: 'My Meta Box',
+					__rtc_compatible: true,
+				},
+				{
+					id: 'another-metabox',
+					title: 'Another',
+					__rtc_compatible: true,
+				},
+			],
+		} );
+		const registry = createRegistry( mockStores );
+
+		renderHook( registry );
+
+		expect( initializeMetaBoxes ).toHaveBeenCalled();
+		expect( setCollaborationSupported ).not.toHaveBeenCalled();
+	} );
+
+	it( 'disables collaboration when some metaboxes lack rtcCompatible', () => {
+		const mockStores = createMockStores( {
+			metaBoxes: [
+				{
+					id: 'compatible-metabox',
+					title: 'Compatible',
+					__rtc_compatible: true,
+				},
+				{ id: 'incompatible-metabox', title: 'Incompatible' },
+			],
+		} );
+		const registry = createRegistry( mockStores );
+
+		renderHook( registry );
+
+		expect( setCollaborationSupported ).toHaveBeenCalledWith( false );
+	} );
+
+	it( 'does not disable collaboration when the only metabox is rtcCompatible', () => {
+		const mockStores = createMockStores( {
+			metaBoxes: [
+				{
+					id: 'compatible-metabox',
+					title: 'Compatible',
+					__rtc_compatible: true,
+				},
+			],
+		} );
+		const registry = createRegistry( mockStores );
+
+		renderHook( registry );
+
+		expect( setCollaborationSupported ).not.toHaveBeenCalled();
+	} );
+
+	it( 'does not disable collaboration when there are no metaboxes', () => {
+		const mockStores = createMockStores( {
+			metaBoxes: [],
+		} );
+		const registry = createRegistry( mockStores );
+
+		renderHook( registry );
+
+		expect( setCollaborationSupported ).not.toHaveBeenCalled();
+	} );
+
+	it( 'does not disable collaboration when collaboration is not enabled', () => {
+		const mockStores = createMockStores( {
+			isCollaborationEnabled: false,
+			metaBoxes: [ { id: 'my-metabox', title: 'My Meta Box' } ],
+		} );
+		const registry = createRegistry( mockStores );
+
+		renderHook( registry );
+
+		expect( setCollaborationSupported ).not.toHaveBeenCalled();
+	} );
+} );

package/src/components/meta-boxes/use-meta-box-initialization.js

@@ -18,26 +18,35 @@ import { unlock } from '../../lock-unlock';
  * @param { boolean } enabled
  */
 export const useMetaBoxInitialization = ( enabled ) => {
-	const { isEnabledAndEditorReady, isCollaborationEnabled } = useSelect(
+	const {
+		isEnabledAndEditorReady,
+		isCollaborationEnabled,
+		hasIncompatibleMetaBoxes,
+	} = useSelect(
 		( select ) => ( {
 			isEnabledAndEditorReady:
 				enabled && select( editorStore ).__unstableIsEditorReady(),
 			isCollaborationEnabled:
 				select( editorStore ).isCollaborationEnabledForCurrentPost(),
+			hasIncompatibleMetaBoxes: enabled
+				? select( editPostStore )
+						.getAllMetaBoxes()
+						.some( ( metaBox ) => ! metaBox.__rtc_compatible )
+				: false,
 		} ),
 		[ enabled ]
 	);
 	const { setCollaborationSupported } = unlock( useDispatch( coreStore ) );
-
 	const { initializeMetaBoxes } = useDispatch( editPostStore );
+
 	// The effect has to rerun when the editor is ready because initializeMetaBoxes
 	// will noop until then.
 	useEffect( () => {
 		if ( isEnabledAndEditorReady ) {
 			initializeMetaBoxes();
 
-			// Disable real-time collaboration when legacy meta boxes are detected.
-			if ( isCollaborationEnabled ) {
+			// Disable real-time collaboration when incompatible meta boxes are detected.
+			if ( isCollaborationEnabled && hasIncompatibleMetaBoxes ) {
 				setCollaborationSupported( false );
 			}
 		}
@@ -46,5 +55,6 @@ export const useMetaBoxInitialization = ( enabled ) => {
 		initializeMetaBoxes,
 		isCollaborationEnabled,
 		setCollaborationSupported,
+		hasIncompatibleMetaBoxes,
 	] );
 };

package/src/store/reducer.js

@@ -32,7 +32,10 @@ function mergeMetaboxes( metaboxes = [], newMetaboxes ) {
 			( box ) => box.id === metabox.id
 		);
 		if ( existing !== -1 ) {
-			mergedMetaboxes[ existing ] = metabox;
+			mergedMetaboxes[ existing ] = {
+				...mergedMetaboxes[ existing ],
+				...metabox,
+			};
 		} else {
 			mergedMetaboxes.push( metabox );
 		}

package/src/style.scss

@@ -1,7 +1,6 @@
 @use "@wordpress/base-styles/default-custom-properties";
 @use "@wordpress/base-styles/mixins" as *;
 @use "@wordpress/base-styles/variables" as *;
-@use "@wordpress/admin-ui/build-style/style.css" as *;
 @use "./components/back-button/style.scss" as *;
 @use "./components/layout/style.scss" as *;
 @use "./components/meta-boxes/meta-boxes-area/style.scss" as *;