Navigation: Load the raw property on the navigation fallback

[scruffian]

What?

When loading the navigation fallback with an embed context we need to add the raw property of the title so that we have the response in the format expected by the frontend.

Why?

Without the raw property, the data resolver treats the data differently which causes errors like #52680 and #52691

How?

Updates the schema to include the raw property.

Testing Instructions

1. Open the site editor at the root level
2. Open the patterns section
3. Open the headers section
4. Click on a header
5. Add a navigation block to the header, making sure you have two navigation blocks in the template
6. Make sure that the two navigation blocks use different wp_navigation CPTs
7. In trunk you should see an error, on this branch you should not.

Note

I tried adding an end to end test for this change, but it's not possible to navigate directly to the root of the site editor in the test environment - not sure why.

[github-actions]

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files

❔ lib/compat/wordpress-6.3/navigation-fallback.php
❔ phpunit/class-gutenberg-rest-navigation-fallback-controller-test.php

[getdave]

The change itself is solid. The precedent is set by the same changes to the content field which already got approval from REST API maintainers in WP Core.

I would add a PHPUnit test that asserts that making a call to the endpoint returns both rendered and raw fields.

We already have the tests so it's just a case of adding one more. These should assert on the presence of fields in the response that aren't typically included in _embed responses:

• content
• title.raw

We could even use the test_context_param test which is currently disabled.

Once done let's spin up that Core patch asap.

[github-actions]

Flaky tests detected in 2e561dc.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5616469576
📝 Reported issues:

• [Flaky Test] zoom animation #52381 in /test/e2e/specs/editor/blocks/image.spec.js

[t-hamano]

I have tested this PR and can confirm that the issue reported in #52691 has been resolved.

[getdave]

For the test I suggest that because we can't work with embedded results in Test setup, we instead just call the linked endpoint directly in the test with context set to embed to simulate the exact same thing.

Something like this:

public function test_adds_correct_fields() {
	$request  = new WP_REST_Request( 'GET', '/wp-block-editor/v1/navigation-fallback' );
	$response = rest_get_server()->dispatch( $request );
	$data     = $response->get_data();

	$navigation_post_id = $data['id'];

	$links = $response->get_links();
        
    // Manually request embedded data due to this issue - https://core.trac.wordpress.org/ticket/55961.
	$embeddable_post_rest_url = str_replace( 'http://localhost:8889/index.php?rest_route=', '', $links['self'][0]['href'] );

	$request  = new WP_REST_Request( 'GET', $embeddable_post_rest_url );
	$request->set_param( 'context', 'embed' );
	$response = rest_get_server()->dispatch( $request );
	$data     = $response->get_data();

    // Assertions here to test for correct fields being included.
	echo '<pre>';
	var_dump( $data );
	echo '</pre>';
}

Ideally we’d not hard code this part http://localhost:8889/index.php?rest_route=. Ideally that would be dynamically created.

[getdave]

Nit: can we collocate the subfield checks for fields of the same type (e.g. content, title...etc)?

[getdave]

Looks good on the test. A few tweaks required 🙏

[getdave]

LGTM. I don't think test failures are relevant.

[getdave]

I've forced merged this after consulting other contributors and confirming these tests are failing for all PRs. They are unrelated to this PR and holding up an important bug fix that can crash the editor.

[ramonjd]

This PR needs a backport. Added label

[ramonjd]

RC2 for WordPress 6.3 will be cut in the next few hours. If folks don't have time, I can get one ready

[tellthemachines]

I just cherry-picked this PR to the update/packages-RC2 branch to get it included in the next release: c98607b