Plugin: Correctly classify functionality in the `lib` folder #39972

gziolo · 2022-04-01T09:23:01Z

What?

Part of #39889 that lists the changes to backport for the WordPress 6.0 release.

Related Site Editor core merge commit WordPress/wordpress-develop@f034bc8.
Related Trac ticket for the navigation editor https://core.trac.wordpress.org/ticket/50544.

Why?

We need to correctly classify added code changes so we know exactly whether they are still experimental, they were shipped in WordPress 5.9 or they should be backported to WordPress core as part of 6.0 major release.

How?

I moved files from the lib folder to subfolders after checking whether they are still experimental, were backported to WordPress 5.9 or I believe they should be backported to WordPress 6.0.

Experimental

WordPress 5.9

WordPress 6.0

Testing Instructions

No changes at all. The plugin should work as before.

adamziel · 2022-04-01T10:35:15Z

lib/compat/wordpress-5.9/rest-api.php

+ * @param WP_REST_Response $response Response data served by the WordPress REST index endpoint.
+ * @return WP_REST_Response
+ */
+function gutenberg_register_site_logo_to_rest_index( $response ) {


good call adding the gutenberg_prefix

adamziel

LGTM, I restarted the failing E2E test that, again, seems to be just flaky.

.github/CODEOWNERS

gziolo · 2022-04-01T12:01:39Z

@noisysocks, @talldan, and @anton-vlasenko, can you confirm whether all changes applied to navigation.php were fully backported for WordPress 5.9 release? I definitely can find some changes in this commit WordPress/wordpress-develop@f034bc8. The question is whether we still need to add some changes as part of WordPress 6.0.

I'd like also to confirm that all code in navigation-theme-opt-in.php is still experimental. Functions reference still open Trac ticker: https://core.trac.wordpress.org/ticket/50544, so I assumed it's still not part of WordPress core. The same question applies to navigation-page.php.

gziolo · 2022-04-04T06:18:16Z

I updated more code in 9bc946f:

lib/full-site-editing/edit-site-page.php moved to lib/compat/wordpress-5.9/edit-site-page.php after confirming with @Mamaduka in Standalone Gutenberg installation doesn't redirect/load the site editor #39639 (comment).
lib/compat.php moved to lib/compat/wordpress-5.9/block-gallery.php after confirming with @glendaviesnz. I moved gutenberg_safe_style_attrs to lib/compat/wordpress-5.9/blocks.php which has an explicit note about the minimal required version but isn't targeting the Gallery block only.

gziolo · 2022-04-04T08:23:25Z

I'm pretty happy about the current folder structure:

I tried removing pwa.php and service-worker.js in #39930 but there were some surprising e2e test errors so I reverted it. I will try again next week.

With bfa2120 I moved lib/style-engine to lib/experimental/style-engine.

With 7d631be I moved lib/rest-api.php to lib/experimental/rest-api.php and extracted and moved some code to lib/wordpress-5.9/rest-api.php.

I also renamed lib/wordpress-6.0/utils.php to lib/wordpress-6.0/functions.php to align with the final location in WordPress core.

youknowriad

Really cool PR :) Thanks for doing that.

For the edit-site-page.php I'm not sure whether we can just move it as is to 5.9 lib. It seems there's some changes in the "preloading" in 6.0. So I guess either we move the file to 6.0 or find a way to override the preloading stuff in 6.0 folder.

youknowriad · 2022-04-04T08:27:17Z

lib/client-assets.php

- *
- * @param WP_Scripts $scripts WP_Scripts instance.
- */
-function gutenberg_register_vendor_scripts( $scripts ) {


With React 18, we might need to move that to another folder, but it's a problem for later :)

I took that into account. It's probably fine to move it between WP versions. When SCRIPT_DEBUG is enabled I inject the dev scripts for React Fast Refresh so I will think how to add it to WP core so we don't have to include that every time we update the React version.

gziolo · 2022-04-04T08:37:35Z

For the edit-site-page.php I'm not sure whether we can just move it as is to 5.9 lib. It seems there's some changes in the "preloading" in 6.0. So I guess either we move the file to 6.0 or find a way to override the preloading stuff in 6.0 folder.

There is a hook that targets only the preloading functionality. I will land this PR to help coordinate backports to WordPress core and see how we can attack the preloading in a more granular way 💯

gziolo · 2022-04-04T15:17:10Z

For the edit-site-page.php I'm not sure whether we can just move it as is to 5.9 lib. It seems there's some changes in the "preloading" in 6.0. So I guess either we move the file to 6.0 or find a way to override the preloading stuff in 6.0 folder.

There is a hook that targets only the preloading functionality. I will land this PR to help coordinate backports to WordPress core and see how we can attack the preloading in a more granular way 💯

It looks like @jsnajdr has covered everything for WordPress 5.9 with this hook:

gutenberg/lib/compat/wordpress-6.0/edit-form-blocks.php

Lines 14 to 51 in 4bd51e1

    
           function optimize_preload_paths( $preload_paths ) { 
        
           	// remove preload of the `/` route. 
        
           	$root_index = array_search( '/', $preload_paths, true ); 
        
           	if ( false !== $root_index ) { 
        
           		array_splice( $preload_paths, $root_index, 1 ); 
        
           	} 
        
           	// change `/types` context from `edit` to `view` (requested in `loadPostTypeEntities`). 
        
           	$types_index = array_search( '/wp/v2/types?context=edit', $preload_paths, true ); 
        
           	if ( false !== $types_index ) { 
        
           		$preload_paths[ $types_index ] = '/wp/v2/types?context=view'; 
        
           	} 
        
           	// start preloading `/taxonomies` in `view` context (requested in `loadTaxonomyEntities`). 
        
           	$tax_index = array_search( '/wp/v2/taxonomies?per_page=-1&context=edit', $preload_paths, true ); 
        
           	if ( false === $tax_index ) { 
        
           		array_push( $preload_paths, '/wp/v2/taxonomies?context=view' ); 
        
           	} else { 
        
           		$preload_paths[ $tax_index ] = '/wp/v2/taxonomies?context=view'; 
        
           	} 
        
           	// start preloading `/settings`. 
        
           	$settings_index = array_search( '/wp/v2/settings', $preload_paths, true ); 
        
           	if ( false === $settings_index ) { 
        
           		array_push( $preload_paths, '/wp/v2/settings' ); 
        
           	} 
        
           	// modify the preload of `/users/me` to match the real request. 
        
           	foreach ( $preload_paths as $user_index => $user_path ) { 
        
           		if ( is_string( $user_path ) && 0 === strpos( $user_path, '/wp/v2/users/me' ) ) { 
        
           			$preload_paths[ $user_index ] = '/wp/v2/users/me'; 
        
           			break; 
        
           		} 
        
           	} 
        
           	return $preload_paths; 
        
           } 
        
           add_filter( 'block_editor_rest_api_preload_paths', 'optimize_preload_paths' );

jasmussen · 2022-04-04T16:05:15Z

I think this PR may have accidentally broken some of the Site Logo functionality. Before this PR, the W would be replaced by any site logo set, like so:

After this PR, that's broken:

Steps to reproduce:

Insert the site logo block
Add a site logo
Save and publish
Reload the editor

The W should be replaced by a round-rectangle site logo instead.

gziolo · 2022-04-04T18:04:00Z

lib/init.php

-function register_site_icon_url( $response ) {
-	$data                  = $response->data;
-	$data['site_icon_url'] = get_site_icon_url();
-	$response->set_data( $data );
-	return $response;
-}
-
-add_filter( 'rest_index', 'register_site_icon_url' );


@jasmussen, great catch. I accidentally removed this filter related to the Site Logo block 😱

I will open PR as the first thing in the morning.

Ready in #40041.

Regression introduced in the `lib` folder refactoring #39972.

* Site Logo: Fix adding the site icon Regression introduced in the `lib` folder refactoring #39972. * Fix formatting issues

gziolo requested review from TimothyBJacobs and spacedmonkey as code owners April 1, 2022 09:23

gziolo assigned adamziel and gziolo and unassigned adamziel Apr 1, 2022

gziolo requested review from noisysocks, hellofromtonya, adamziel and anton-vlasenko April 1, 2022 09:23

gziolo added Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts [Type] Code Quality Issues or PRs that relate to code quality [Status] In Progress Tracking issues with work in progress labels Apr 1, 2022

gziolo mentioned this pull request Apr 1, 2022

Plugin: Backport PHP changes for WordPress 6.0 release #39889

Closed

36 tasks

gziolo requested a review from oandregal as a code owner April 1, 2022 09:49

gziolo requested a review from jorgefilipecosta April 1, 2022 09:54

adamziel reviewed Apr 1, 2022

View reviewed changes

adamziel approved these changes Apr 1, 2022

View reviewed changes

gziolo commented Apr 1, 2022

View reviewed changes

.github/CODEOWNERS Outdated Show resolved Hide resolved

gziolo force-pushed the update/lib-triage branch from 1db15f0 to 0a8e9c9 Compare April 1, 2022 11:41

gziolo commented Apr 1, 2022

View reviewed changes

.github/CODEOWNERS Show resolved Hide resolved

gziolo force-pushed the update/lib-triage branch 3 times, most recently from 268dccd to 563e51a Compare April 1, 2022 11:46

gziolo removed the [Status] In Progress Tracking issues with work in progress label Apr 1, 2022

gziolo force-pushed the update/lib-triage branch from 563e51a to 9bc946f Compare April 4, 2022 06:13

gziolo added 3 commits April 4, 2022 09:40

Plugin: Correctly classify functionality in the lib folder

b8d88df

Move code that should be backported to WordPress core as part of 6.0

95b1326

Update CODEOWNERS file

547d8c7

gziolo added 3 commits April 4, 2022 09:40

Move global styles from 6.0 to 5.9 as kses.php

907f8d3

Move more files to the compat layer

8dc761a

Make the style engine class experimental

bfa2120

gziolo force-pushed the update/lib-triage branch from 9bc946f to bfa2120 Compare April 4, 2022 07:40

Move all the remaining code in lib

9d8938f

gziolo force-pushed the update/lib-triage branch from 7d631be to 9d8938f Compare April 4, 2022 08:25

youknowriad reviewed Apr 4, 2022

View reviewed changes

gziolo merged commit e102e3f into trunk Apr 4, 2022

gziolo deleted the update/lib-triage branch April 4, 2022 10:12

github-actions bot added this to the Gutenberg 13.0 milestone Apr 4, 2022

gziolo commented Apr 4, 2022

View reviewed changes

gziolo added a commit that referenced this pull request Apr 5, 2022

Site Logo: Fix adding the site icon

f36f982

Regression introduced in the `lib` folder refactoring #39972.

gziolo mentioned this pull request Apr 5, 2022

Site Logo: Fix adding the site icon #40041

Merged

gziolo added a commit that referenced this pull request Apr 5, 2022

Site Logo: Fix adding the site icon (#40041)

4a7ff78

* Site Logo: Fix adding the site icon Regression introduced in the `lib` folder refactoring #39972. * Fix formatting issues

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Plugin: Correctly classify functionality in the `lib` folder #39972

Plugin: Correctly classify functionality in the `lib` folder #39972

gziolo commented Apr 1, 2022 •

edited

Loading

adamziel Apr 1, 2022

adamziel left a comment

gziolo commented Apr 1, 2022 •

edited

Loading

gziolo commented Apr 4, 2022

gziolo commented Apr 4, 2022

youknowriad left a comment

youknowriad Apr 4, 2022

gziolo Apr 4, 2022

gziolo commented Apr 4, 2022

gziolo commented Apr 4, 2022

jasmussen commented Apr 4, 2022

gziolo Apr 4, 2022 •

edited

Loading

gziolo Apr 5, 2022

Plugin: Correctly classify functionality in the lib folder #39972

Plugin: Correctly classify functionality in the lib folder #39972

Conversation

gziolo commented Apr 1, 2022 • edited Loading

What?

Why?

How?

Experimental

WordPress 5.9

WordPress 6.0

Testing Instructions

adamziel Apr 1, 2022

Choose a reason for hiding this comment

adamziel left a comment

Choose a reason for hiding this comment

gziolo commented Apr 1, 2022 • edited Loading

gziolo commented Apr 4, 2022

gziolo commented Apr 4, 2022

youknowriad left a comment

Choose a reason for hiding this comment

youknowriad Apr 4, 2022

Choose a reason for hiding this comment

gziolo Apr 4, 2022

Choose a reason for hiding this comment

gziolo commented Apr 4, 2022

gziolo commented Apr 4, 2022

jasmussen commented Apr 4, 2022

gziolo Apr 4, 2022 • edited Loading

Choose a reason for hiding this comment

gziolo Apr 5, 2022

Choose a reason for hiding this comment

Plugin: Correctly classify functionality in the `lib` folder #39972

Plugin: Correctly classify functionality in the `lib` folder #39972

gziolo commented Apr 1, 2022 •

edited

Loading

gziolo commented Apr 1, 2022 •

edited

Loading

gziolo Apr 4, 2022 •

edited

Loading