Block Bindings: Bootstrap sources defined in the server (#63470)

* Move bindings registration to editor provider

* Remove sources from editor provider

* Create `registerCoreBlockBindingsSources` function

* Add `updateBlockBindingsSource` action

* Bootstrap sources defined in the server

* Change registration to allow server bootstrap

* Remove label from post meta and pattern overrides

* Remove `updateBlockBindingsSource`

* Use `bootstrapBlockBindingsSource` instead

* Wrap server registration in the same function

* Ensure label is provided when source is not bootstrapped

* Remove old import

* Add compat filter to expose server sources

* Add e2e test

* Check if the sources are already added

* Change how label is managed

* Remove type from object

* Use blockBindingsSources name

* Fixes from rebase

* Add return back and warning

* Add backport

* Improve comments

* Fix getValues/setValues after rebase

* Adapt reducer and fixes

* Revert args used in `addBlockBindingsSource`

Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org>
Co-authored-by: gziolo <gziolo@git.wordpress.org>
Co-authored-by: artemiomorales <artemiosans@git.wordpress.org>

Author: 3 people

backport-changelog/6.7/7020.md

@@ -0,0 +1,3 @@
+https://github.com/WordPress/wordpress-develop/pull/7020
+
+* https://github.com/WordPress/gutenberg/pull/63470

lib/compat/wordpress-6.7/block-bindings.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Temporary compatibility code for new functionalitites/changes related to block bindings APIs present in Gutenberg.
+ *
+ * @package gutenberg
+ */
+
+/**
+ * Adds the block bindings sources registered in the server to the editor settings.
+ *
+ * This allows them to be bootstrapped in the editor.
+ *
+ * @param array $settings The block editor settings from the `block_editor_settings_all` filter.
+ * @return array The editor settings including the block bindings sources.
+ */
+function gutenberg_add_server_block_bindings_sources_to_editor_settings( $editor_settings ) {
+	// Check if the sources are already exposed in the editor settings.
+	if ( isset( $editor_settings['blockBindingsSources'] ) ) {
+		return $editor_settings;
+	}
+
+	$registered_block_bindings_sources = get_all_registered_block_bindings_sources();
+	if ( ! empty( $registered_block_bindings_sources ) ) {
+		// Initialize array.
+		$editor_settings['blockBindingsSources'] = array();
+		foreach ( $registered_block_bindings_sources as $source_name => $source_properties ) {
+			// Add source with the label to editor settings.
+			$editor_settings['blockBindingsSources'][ $source_name ] = array(
+				'label' => $source_properties->label,
+			);
+			// Add `usesContext` property if exists.
+			if ( ! empty( $source_properties->uses_context ) ) {
+				$editor_settings['blockBindingsSources'][ $source_name ]['usesContext'] = $source_properties->uses_context;
+			}
+		}
+	}
+	return $editor_settings;
+}
+
+add_filter( 'block_editor_settings_all', 'gutenberg_add_server_block_bindings_sources_to_editor_settings', 10 );

lib/load.php

@@ -169,6 +169,7 @@ function gutenberg_is_experiment_enabled( $name ) {
 
 // WordPress 6.7 compat.
 require __DIR__ . '/compat/wordpress-6.7/blocks.php';
+require __DIR__ . '/compat/wordpress-6.7/block-bindings.php';
 
 // Experimental features.
 require __DIR__ . '/experimental/block-editor-settings-mobile.php';

packages/blocks/src/api/registration.js

@@ -769,7 +769,7 @@ export const unregisterBlockVariation = ( blockName, variationName ) => {
  *
  * @param {Object}   source                    Properties of the source to be registered.
  * @param {string}   source.name               The unique and machine-readable name.
- * @param {string}   source.label              Human-readable label.
+ * @param {string}   [source.label]            Human-readable label.
  * @param {Function} [source.getValues]        Function to get the values from the source.
  * @param {Function} [source.setValues]        Function to update multiple values connected to the source.
  * @param {Function} [source.getPlaceholder]   Function to get the placeholder when the value is undefined.
@@ -800,11 +800,15 @@ export const registerBlockBindingsSource = ( source ) => {
 		canUserEditValue,
 	} = source;
 
-	// Check if the source is already registered.
 	const existingSource = unlock(
 		select( blocksStore )
 	).getBlockBindingsSource( name );
-	if ( existingSource ) {
+
+	/*
+	 * Check if the source has been already registered on the client.
+	 * If the `getValues` property is defined, it could be assumed the source is already registered.
+	 */
+	if ( existingSource?.getValues ) {
 		warning(
 			'Block bindings source "' + name + '" is already registered.'
 		);
@@ -844,12 +848,21 @@ export const registerBlockBindingsSource = ( source ) => {
 	}
 
 	// Check the `label` property is correct.
-	if ( ! label ) {
+	if ( label && existingSource?.label ) {
+		warning(
+			'Block bindings "' +
+				name +
+				'" source label is already defined in the server.'
+		);
+		return;
+	}
+
+	if ( ! label && ! existingSource?.label ) {
 		warning( 'Block bindings source must contain a label.' );
 		return;
 	}
 
-	if ( typeof label !== 'string' ) {
+	if ( label && typeof label !== 'string' ) {
 		warning( 'Block bindings source label must be a string.' );
 		return;
 	}

packages/blocks/src/api/test/registration.js

@@ -1512,6 +1512,22 @@ describe( 'blocks', () => {
 			expect( getBlockBindingsSource( 'core/testing' ) ).toBeUndefined();
 		} );
 
+		it( 'should not override label from the server', () => {
+			// Simulate bootstrapping a source from the server registration.
+			registerBlockBindingsSource( {
+				name: 'core/server',
+				label: 'Server label',
+			} );
+			// Override the source with a different label in the client.
+			registerBlockBindingsSource( {
+				name: 'core/server',
+				label: 'Client label',
+			} );
+			expect( console ).toHaveWarnedWith(
+				'Block bindings "core/server" source label is already defined in the server.'
+			);
+		} );
+
 		// Check the `getValues` callback is correct.
 		it( 'should reject invalid getValues callback', () => {
 			registerBlockBindingsSource( {
@@ -1600,6 +1616,7 @@ describe( 'blocks', () => {
 			const source = {
 				name: 'core/test-source',
 				label: 'Test Source',
+				getValues: () => 'value',
 			};
 			registerBlockBindingsSource( source );
 			registerBlockBindingsSource( source );

packages/blocks/src/store/private-actions.js

@@ -69,3 +69,17 @@ export function removeBlockBindingsSource( name ) {
 		name,
 	};
 }
+
+/**
+ * Add bootstrapped block bindings sources, usually initialized from the server.
+ *
+ * @param {string} source Name of the source to bootstrap.
+ */
+export function addBootstrappedBlockBindingsSource( source ) {
+	return {
+		type: 'ADD_BOOTSTRAPPED_BLOCK_BINDINGS_SOURCE',
+		name: source.name,
+		label: source.label,
+		usesContext: source.usesContext,
+	};
+}

packages/blocks/src/store/reducer.js

@@ -377,13 +377,22 @@ export function blockBindingsSources( state = {}, action ) {
 			return {
 				...state,
 				[ action.name ]: {
-					label: action.label,
+					// Don't override the label if it's already set.
+					label: state[ action.name ]?.label || action.label,
 					getValues: action.getValues,
 					setValues: action.setValues,
 					getPlaceholder: action.getPlaceholder,
 					canUserEditValue: action.canUserEditValue,
 				},
 			};
+		case 'ADD_BOOTSTRAPPED_BLOCK_BINDINGS_SOURCE':
+			return {
+				...state,
+				[ action.name ]: {
+					label: action.label,
+					usesContext: action.usesContext,
+				},
+			};
 		case 'REMOVE_BLOCK_BINDINGS_SOURCE':
 			return omit( state, action.name );
 	}

packages/e2e-tests/plugins/block-bindings.php

@@ -8,9 +8,19 @@
  */
 
 /**
-* Register custom fields.
+* Register custom fields and custom block bindings sources.
 */
-function gutenberg_test_block_bindings_register_custom_fields() {
+function gutenberg_test_block_bindings_registration() {
+	// Register custom block bindings sources.
+	register_block_bindings_source(
+		'core/server-source',
+		array(
+			'label'              => 'Server Source',
+			'get_value_callback' => function () {},
+		)
+	);
+
+	// Register custom fields.
 	register_meta(
 		'post',
 		'text_custom_field',
@@ -51,4 +61,4 @@ function gutenberg_test_block_bindings_register_custom_fields() {
 		)
 	);
 }
-add_action( 'init', 'gutenberg_test_block_bindings_register_custom_fields' );
+add_action( 'init', 'gutenberg_test_block_bindings_registration' );

packages/edit-post/src/index.js

@@ -29,6 +29,7 @@ const {
 	BackButton: __experimentalMainDashboardButton,
 	registerDefaultActions,
 	registerCoreBlockBindingsSources,
+	bootstrapBlockBindingsSourcesFromServer,
 } = unlock( editorPrivateApis );
 
 /**
@@ -87,6 +88,7 @@ export function initializeEditor(
 	}
 
 	registerCoreBlocks();
+	bootstrapBlockBindingsSourcesFromServer( settings?.blockBindingsSources );
 	registerCoreBlockBindingsSources();
 	registerLegacyWidgetBlock( { inserter: false } );
 	registerWidgetGroupBlock( { inserter: false } );

packages/edit-site/src/index.js

@@ -28,8 +28,11 @@ import { store as editSiteStore } from './store';
 import { unlock } from './lock-unlock';
 import App from './components/app';
 
-const { registerDefaultActions, registerCoreBlockBindingsSources } =
-	unlock( editorPrivateApis );
+const {
+	registerDefaultActions,
+	registerCoreBlockBindingsSources,
+	bootstrapBlockBindingsSourcesFromServer,
+} = unlock( editorPrivateApis );
 
 /**
  * Initializes the site editor screen.
@@ -46,6 +49,7 @@ export function initializeEditor( id, settings ) {
 		( { name } ) => name !== 'core/freeform'
 	);
 	registerCoreBlocks( coreBlocks );
+	bootstrapBlockBindingsSourcesFromServer( settings?.blockBindingsSources );
 	registerCoreBlockBindingsSources();
 	dispatch( blocksStore ).setFreeformFallbackBlockName( 'core/html' );
 	registerLegacyWidgetBlock( { inserter: false } );

packages/editor/src/bindings/api.js

@@ -1,7 +1,11 @@
 /**
  * WordPress dependencies
  */
-import { privateApis as blocksPrivateApis } from '@wordpress/blocks';
+import {
+	privateApis as blocksPrivateApis,
+	store as blocksStore,
+} from '@wordpress/blocks';
+import { dispatch } from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -25,3 +29,29 @@ export function registerCoreBlockBindingsSources() {
 	registerBlockBindingsSource( patternOverrides );
 	registerBlockBindingsSource( postMeta );
 }
+
+/**
+ * Function to bootstrap core block bindings sources defined in the server.
+ *
+ * @param {Object} sources Object containing the sources to bootstrap.
+ *
+ * @example
+ * ```js
+ * import { bootstrapBlockBindingsSourcesFromServer } from '@wordpress/editor';
+ *
+ * bootstrapBlockBindingsSourcesFromServer( sources );
+ * ```
+ */
+export function bootstrapBlockBindingsSourcesFromServer( sources ) {
+	if ( sources ) {
+		const { addBootstrappedBlockBindingsSource } = unlock(
+			dispatch( blocksStore )
+		);
+		for ( const [ name, args ] of Object.entries( sources ) ) {
+			addBootstrappedBlockBindingsSource( {
+				name,
+				...args,
+			} );
+		}
+	}
+}

packages/editor/src/bindings/pattern-overrides.js

@@ -1,14 +1,12 @@
 /**
  * WordPress dependencies
  */
-import { _x } from '@wordpress/i18n';
 import { store as blockEditorStore } from '@wordpress/block-editor';
 
 const CONTENT = 'content';
 
 export default {
 	name: 'core/pattern-overrides',
-	label: _x( 'Pattern Overrides', 'block bindings source' ),
 	getValues( { registry, clientId, context, bindings } ) {
 		const patternOverridesContent = context[ 'pattern/overrides' ];
 		const { getBlockAttributes } = registry.select( blockEditorStore );

packages/editor/src/bindings/post-meta.js

@@ -2,7 +2,6 @@
  * WordPress dependencies
  */
 import { store as coreDataStore } from '@wordpress/core-data';
-import { _x } from '@wordpress/i18n';
 
 /**
  * Internal dependencies
@@ -11,7 +10,6 @@ import { store as editorStore } from '../store';
 
 export default {
 	name: 'core/post-meta',
-	label: _x( 'Post Meta', 'block bindings source' ),
 	getPlaceholder( { args } ) {
 		return args.key;
 	},

packages/editor/src/private-apis.js

@@ -24,7 +24,10 @@ import {
 	GlobalStylesProvider,
 } from './components/global-styles-provider';
 import registerDefaultActions from './dataviews/actions';
-import { registerCoreBlockBindingsSources } from './bindings/api';
+import {
+	registerCoreBlockBindingsSources,
+	bootstrapBlockBindingsSourcesFromServer,
+} from './bindings/api';
 
 const { store: interfaceStore, ...remainingInterfaceApis } = interfaceApis;
 
@@ -45,6 +48,7 @@ lock( privateApis, {
 	ResizableEditor,
 	registerDefaultActions,
 	registerCoreBlockBindingsSources,
+	bootstrapBlockBindingsSourcesFromServer,
 
 	// This is a temporary private API while we're updating the site editor to use EditorProvider.
 	useBlockEditorSettings,

test/e2e/specs/editor/various/block-bindings.spec.js

@@ -2172,4 +2172,33 @@ test.describe( 'Block bindings', () => {
 			} );
 		} );
 	} );
+
+	test.describe( 'Sources registration', () => {
+		test.beforeEach( async ( { admin } ) => {
+			await admin.createNewPost( { title: 'Test bindings' } );
+		} );
+
+		test( 'should show the label of a source only registered in the server', async ( {
+			editor,
+			page,
+		} ) => {
+			await editor.insertBlock( {
+				name: 'core/paragraph',
+				attributes: {
+					metadata: {
+						bindings: {
+							content: {
+								source: 'core/server-source',
+							},
+						},
+					},
+				},
+			} );
+
+			const bindingLabel = page.locator(
+				'.components-item__block-bindings-source'
+			);
+			await expect( bindingLabel ).toHaveText( 'Server Source' );
+		} );
+	} );
 } );