Backport functions required by Comment Query Loop and related blocks #2543

DAreRodz · 2022-04-08T15:12:49Z

Backport changes from Gutenberg to add functions required by Comment Query Loop and related blocks.

From /lib/compat/wordpress-6.0/blocks.php:

build_comment_query_vars_from_block function
get_comments_pagination_arrow function
gutenberg_extend_block_editor_settings_with_discussion_settings filter's callback
gutenberg_rest_comment_set_children_as_embeddable filter's callback

Tests:

class-block-library-comment-template-test.php unit test

Also being tracked in WordPress/gutenberg#39889.

Trac ticket: https://core.trac.wordpress.org/ticket/55505 and https://core.trac.wordpress.org/ticket/55567

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

DAreRodz · 2022-04-08T15:15:59Z

tests/phpunit/tests/block-library/commentTemplate.php

+<?php
+/**
+ * Comment Template block tests
+ *
+ * @package WordPress
+ * @subpackage Block Library
+ * @since 6.0.0
+ */
+
+/**
+ * Tests for the Comment Template block.
+ *
+ * @since 6.0.0
+ *
+ * @group block-library
+ */
+class Test_Block_Library_CommentTemplate extends WP_UnitTestCase {


I've defined a new @subpackage and @group for this test, as this is the first one we have for a specific block (as far as I saw).

I've also modified the class name to follow the same format as the other test files.

Let me know if this file should be placed under a different folder/subpackage/etc. 🙂

It's fine as is. It's an implementation detail I can look at later.

DAreRodz · 2022-04-08T15:19:18Z

Uh, there's a missing function, I'm taking a look.

src/wp-includes/blocks.php

This reverts commit 2c0a02d.

DAreRodz · 2022-04-11T12:19:55Z

tests/phpunit/tests/block-library/commentTemplate.php

+		);
+	}
+
+	function test_build_comment_query_vars_from_block_with_context() {


I noticed this test is failing in my local environment. I'm taking a look into that. 👀

1) Test_Block_Library_CommentTemplate::test_build_comment_query_vars_from_block_with_context Failed asserting that two arrays are equal. --- Expected +++ Actual @@ @@ 'status' => 'approve' 'no_found_rows' => false 'update_comment_meta_cache' => false - 'post_id' => 4 'hierarchical' => 'threaded' 'number' => 5 'paged' => 1 )

I see the same error locally. It's really surprising.

For some reason, the block is not being instantiated here with context; it's empty.

wordpress-develop/tests/phpunit/tests/block-library/commentTemplate.php

Lines 57 to 62 in 537d272

$block = new WP_Block(

$parsed_blocks[0],

array(

'postId' => self::$custom_post->ID,

)

);

I see the same happening in all the tests where context is used. Could it be related to the block not included in WordPress core yet? 🤔

I think I know why, we need to have the block code first and we can then land the tests. All good then. Let's wait for #2564 and see how it looks afterwards. Good detective work 😄

gziolo · 2022-04-11T15:22:33Z

I committed all the changes but tests with https://core.trac.wordpress.org/changeset/53138 to unblock #2564.

gziolo · 2022-04-13T07:52:46Z

I backported 3 out of 5 unit tests to WordPress core with https://core.trac.wordpress.org/changeset/53172.

I had some issues with:

test_rendering_comment_template
test_rendering_comment_template_nested

I would appreciate some help. It can be another PR if that makes it easier.

DAreRodz · 2022-04-19T18:26:50Z

Hey, @gziolo, sure! Let me create a new PR for that. I think it would be easier as there are some changes already integrated into trunk.

DAreRodz · 2022-04-20T17:40:24Z

I had some issues with:

test_rendering_comment_template

test_rendering_comment_template_nested

The problem was using

render_block_core_comment_template( null, null, $block )

instead of

$block->render()

in the failing tests.

The second call returns (almost) the same output, but also updates ―among other things― WP_Block_Supports::$block_to_render, which should be not null when get_block_wrapper_attributes() is called. So, I guess render_block_core_comment_template() is not meant to be called directly.

The first call works in Gutenberg, though; I don't know why. 🤷

I've created a new PR here with the test fixes: #2613. I can close this one if you feel so. ☺️

cc: @gziolo

gziolo · 2022-04-20T18:23:15Z

I've created a new PR here with the test fixes: #2613. I can close this one if you feel so. ☺️

Awesome, thank you so much 💯

sybrew · 2024-03-17T21:15:35Z

src/wp-includes/blocks.php

+		// Set the `cpage` query var to ensure the previous and next pagination links are correct
+		// when inheriting the Discussion Settings.
+		if ( 0 === $page && isset( $comment_args['paged'] ) && $comment_args['paged'] > 0 ) {
+			set_query_var( 'cpage', $comment_args['paged'] );


Why write to a query variable here? It breaks everything else in WP. It should remain 0 on the first page, as it always had been.

Cross-referencing #6291, where this is now being discussed, and WordPress/gutenberg#39227, where it was originally introduced.

DAreRodz commented Apr 8, 2022

View reviewed changes

gziolo reviewed Apr 8, 2022

View reviewed changes

src/wp-includes/blocks.php Outdated Show resolved Hide resolved

gziolo reviewed Apr 8, 2022

View reviewed changes

src/wp-includes/blocks.php Outdated Show resolved Hide resolved

DAreRodz added 7 commits April 11, 2022 12:10

Backport functions needed by Comment blocks

65856f8

Backport Comment Template tests

6bd3464

Update package-lock

2c0a02d

Rename setUp to set_up

9226c03

Remove gutenberg prefix from render_block function

b8dbf88

Move experimental discussion settings to block-editor.php

17b5ebf

Set embedded true for comment children

269aef2

DAreRodz force-pushed the backport/blocks-comment-query-loop branch from b2d9654 to 269aef2 Compare April 11, 2022 11:54

DAreRodz added 2 commits April 11, 2022 14:05

Fix argument order in assertions

537d272

Revert "Update package-lock"

494d58f

This reverts commit 2c0a02d.

DAreRodz commented Apr 11, 2022

View reviewed changes

DAreRodz requested review from gziolo and TimothyBJacobs April 11, 2022 12:20

gziolo mentioned this pull request Apr 11, 2022

Plugin: Backport PHP changes for WordPress 6.0 release WordPress/gutenberg#39889

Closed

36 tasks

DAreRodz mentioned this pull request Apr 20, 2022

Add missing phpunit tests to renderCommentTemplate #2613

Closed

gziolo closed this Apr 20, 2022

DAreRodz deleted the backport/blocks-comment-query-loop branch April 20, 2022 18:45

sybrew reviewed Mar 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Backport functions required by Comment Query Loop and related blocks #2543

Backport functions required by Comment Query Loop and related blocks #2543

DAreRodz commented Apr 8, 2022 •

edited by gziolo

Loading

DAreRodz Apr 8, 2022

DAreRodz Apr 8, 2022

gziolo Apr 11, 2022

DAreRodz commented Apr 8, 2022

DAreRodz Apr 11, 2022

gziolo Apr 11, 2022

DAreRodz Apr 11, 2022

gziolo Apr 11, 2022

gziolo commented Apr 11, 2022

gziolo commented Apr 13, 2022

DAreRodz commented Apr 19, 2022

DAreRodz commented Apr 20, 2022 •

edited

Loading

gziolo commented Apr 20, 2022

sybrew Mar 17, 2024

ockham Jul 18, 2024

	$block = new WP_Block(
	$parsed_blocks[0],
	array(
	'postId' => self::$custom_post->ID,
	)
	);

Backport functions required by Comment Query Loop and related blocks #2543

Backport functions required by Comment Query Loop and related blocks #2543

Conversation

DAreRodz commented Apr 8, 2022 • edited by gziolo Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DAreRodz commented Apr 8, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gziolo commented Apr 11, 2022

gziolo commented Apr 13, 2022

DAreRodz commented Apr 19, 2022

DAreRodz commented Apr 20, 2022 • edited Loading

gziolo commented Apr 20, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DAreRodz commented Apr 8, 2022 •

edited by gziolo

Loading

DAreRodz commented Apr 20, 2022 •

edited

Loading