Preload: fix multiple regressions around global styles (WordPress#66468)

Co-authored-by: ellatrix <[email protected]> Co-authored-by: ramonjd <[email protected]> Co-authored-by: aaronrobertshaw <[email protected]>
karthick-murugan · Nov 13, 2024 · d3606ad · d3606ad
1 parent 3975cff
commit d3606ad
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 6 deletions.
diff --git a/backport-changelog/6.8/7661.md b/backport-changelog/6.8/7661.md
@@ -0,0 +1,3 @@
+https://github.com/WordPress/wordpress-develop/pull/7661
+
+* https://github.com/WordPress/gutenberg/pull/66468
diff --git a/lib/compat/wordpress-6.8/preload.php b/lib/compat/wordpress-6.8/preload.php
@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * Preload theme and global styles paths to avoid flash of variation styles in
+ * post editor.
+ *
+ * @param array                   $paths REST API paths to preload.
+ * @param WP_Block_Editor_Context $context Current block editor context.
+ * @return array Filtered preload paths.
+ */
+function gutenberg_block_editor_preload_paths_6_8( $paths, $context ) {
+	$excluded_paths = array();
+	if ( 'core/edit-site' === $context->name || 'core/edit-post' === $context->name ) {
+		$stylesheet       = get_stylesheet();
+		$global_styles_id = WP_Theme_JSON_Resolver_Gutenberg::get_user_global_styles_post_id();
+		$paths[]          = '/wp/v2/global-styles/themes/' . $stylesheet . '?context=view';
+		$paths[]          = '/wp/v2/global-styles/themes/' . $stylesheet . '/variations?context=view';
+		$paths[]          = array( '/wp/v2/global-styles/' . $global_styles_id, 'OPTIONS' );
+		$excluded_paths[] = '/wp/v2/global-styles/themes/' . $stylesheet;
+		$excluded_paths[] = '/wp/v2/global-styles/' . $global_styles_id;
+	}
+	foreach ( $paths as $key => $path ) {
+		if ( in_array( $path, $excluded_paths, true ) ) {
+			unset( $paths[ $key ] );
+		}
+	}
+	return $paths;
+}
+add_filter( 'block_editor_rest_api_preload_paths', 'gutenberg_block_editor_preload_paths_6_8', 10, 2 );
diff --git a/lib/load.php b/lib/load.php
@@ -47,6 +47,7 @@ function gutenberg_is_experiment_enabled( $name ) {
 	require __DIR__ . '/compat/wordpress-6.7/rest-api.php';
 
 	// WordPress 6.8 compat.
+	require __DIR__ . '/compat/wordpress-6.8/preload.php';
 	require __DIR__ . '/compat/wordpress-6.8/remove-default-css.php';
 	require __DIR__ . '/compat/wordpress-6.8/block-comments.php';
 	require __DIR__ . '/compat/wordpress-6.8/class-gutenberg-rest-comment-controller-6-8.php';

diff --git a/packages/core-data/src/resolvers.js b/packages/core-data/src/resolvers.js
@@ -644,6 +644,7 @@ export const __experimentalGetCurrentThemeBaseGlobalStyles =
 	() =>
 	async ( { resolveSelect, dispatch } ) => {
 		const currentTheme = await resolveSelect.getCurrentTheme();
+		// Please adjust the preloaded requests if this changes!
 		const themeGlobalStyles = await apiFetch( {
 			path: `/wp/v2/global-styles/themes/${ currentTheme.stylesheet }?context=view`,
 		} );
@@ -657,6 +658,7 @@ export const __experimentalGetCurrentThemeGlobalStylesVariations =
 	() =>
 	async ( { resolveSelect, dispatch } ) => {
 		const currentTheme = await resolveSelect.getCurrentTheme();
+		// Please adjust the preloaded requests if this changes!
 		const variations = await apiFetch( {
 			path: `/wp/v2/global-styles/themes/${ currentTheme.stylesheet }/variations?context=view`,
 		} );

diff --git a/packages/editor/src/components/global-styles-provider/index.js b/packages/editor/src/components/global-styles-provider/index.js
@@ -56,13 +56,27 @@ function useGlobalStylesUserConfig() {
 				select( coreStore ).__experimentalGetCurrentGlobalStylesId();
 
 			let record;
-			const userCanEditGlobalStyles = canUser( 'update', {
-				kind: 'root',
-				name: 'globalStyles',
-				id: _globalStylesId,
-			} );
 
-			if ( _globalStylesId ) {
+			// We want the global styles ID request to finish before triggering
+			// the OPTIONS request for user capabilities, otherwise it will
+			// fetch `/wp/v2/global-styles` instead of
+			// `/wp/v2/global-styles/{id}`!
+			// Please adjust the preloaded requests if this changes!
+			const userCanEditGlobalStyles = _globalStylesId
+				? canUser( 'update', {
+						kind: 'root',
+						name: 'globalStyles',
+						id: _globalStylesId,
+				  } )
+				: null;
+
+			if (
+				_globalStylesId &&
+				// We want the OPTIONS request for user capabilities to finish
+				// before getting the records, otherwise we'll fetch both!
+				typeof userCanEditGlobalStyles === 'boolean'
+			) {
+				// Please adjust the preloaded requests if this changes!
 				if ( userCanEditGlobalStyles ) {
 					record = getEditedEntityRecord(
 						'root',
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		https://github.com/WordPress/wordpress-develop/pull/7661

		* https://github.com/WordPress/gutenberg/pull/66468