Backport functions required by Comment Query Loop and related blocks #2543
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| <?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 { | ||
|
Comment on lines
+1
to
+17
There was a problem hiding this comment. I've defined a new I've also modified the class name to follow the same format as the other test files. There was a problem hiding this comment. Let me know if this file should be placed under a different folder/subpackage/etc. 🙂 There was a problem hiding this comment. It's fine as is. It's an implementation detail I can look at later. |
||
|
|
||
| private static $custom_post; | ||
| private static $comment_ids; | ||
| private static $per_page = 5; | ||
|
|
||
| public function set_up() { | ||
| parent::set_up(); | ||
|
|
||
| update_option( 'page_comments', true ); | ||
| update_option( 'comments_per_page', self::$per_page ); | ||
| update_option( 'comment_order', 'ASC' ); | ||
|
|
||
| self::$custom_post = self::factory()->post->create_and_get( | ||
| array( | ||
| 'post_type' => 'dogs', | ||
| 'post_status' => 'publish', | ||
| 'post_name' => 'metaldog', | ||
| 'post_title' => 'Metal Dog', | ||
| 'post_content' => 'Metal Dog content', | ||
| 'post_excerpt' => 'Metal Dog', | ||
| ) | ||
| ); | ||
|
|
||
| self::$comment_ids = self::factory()->comment->create_post_comments( | ||
| self::$custom_post->ID, | ||
| 1, | ||
| array( | ||
| 'comment_author' => 'Test', | ||
| 'comment_author_email' => '[email protected]', | ||
| 'comment_content' => 'Hello world', | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| function test_build_comment_query_vars_from_block_with_context() { | ||
|
There was a problem hiding this comment. I noticed this test is failing in my local environment. I'm taking a look into that. 👀 There was a problem hiding this comment. I see the same error locally. It's really surprising. There was a problem hiding this comment. For some reason, the block is not being instantiated here with context; it's empty. 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? 🤔 There was a problem hiding this comment. 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 😄 |
||
| $parsed_blocks = parse_blocks( | ||
| '<!-- wp:comment-template --><!-- wp:comment-author-name /--><!-- wp:comment-content /--><!-- /wp:comment-template -->' | ||
| ); | ||
|
|
||
| $block = new WP_Block( | ||
| $parsed_blocks[0], | ||
| array( | ||
| 'postId' => self::$custom_post->ID, | ||
| ) | ||
| ); | ||
|
|
||
| $this->assertEquals( | ||
| array( | ||
| 'orderby' => 'comment_date_gmt', | ||
| 'order' => 'ASC', | ||
| 'status' => 'approve', | ||
| 'no_found_rows' => false, | ||
| 'update_comment_meta_cache' => false, | ||
| 'post_id' => self::$custom_post->ID, | ||
| 'hierarchical' => 'threaded', | ||
| 'number' => 5, | ||
| 'paged' => 1, | ||
| ), | ||
| build_comment_query_vars_from_block( $block ) | ||
| ); | ||
| } | ||
|
|
||
| function test_build_comment_query_vars_from_block_no_context() { | ||
| $parsed_blocks = parse_blocks( | ||
| '<!-- wp:comment-template --><!-- wp:comment-author-name /--><!-- wp:comment-content /--><!-- /wp:comment-template -->' | ||
| ); | ||
|
|
||
| $block = new WP_Block( $parsed_blocks[0] ); | ||
|
|
||
| $this->assertEquals( | ||
| array( | ||
| 'orderby' => 'comment_date_gmt', | ||
| 'order' => 'ASC', | ||
| 'status' => 'approve', | ||
| 'no_found_rows' => false, | ||
| 'update_comment_meta_cache' => false, | ||
| 'hierarchical' => 'threaded', | ||
| 'number' => 5, | ||
| 'paged' => 1, | ||
| ), | ||
| build_comment_query_vars_from_block( $block ) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Test rendering a single comment | ||
| */ | ||
| function test_rendering_comment_template() { | ||
| $parsed_blocks = parse_blocks( | ||
| '<!-- wp:comment-template --><!-- wp:comment-author-name /--><!-- wp:comment-content /--><!-- /wp:comment-template -->' | ||
| ); | ||
|
|
||
| $block = new WP_Block( | ||
| $parsed_blocks[0], | ||
| array( | ||
| 'postId' => self::$custom_post->ID, | ||
| ) | ||
| ); | ||
|
|
||
| // Here we use the function prefixed with 'gutenberg_*' because it's added | ||
| // in the build step. | ||
| $this->assertEquals( | ||
| '<ol ><li><div class="wp-block-comment-author-name">Test</div><div class="wp-block-comment-content">Hello world</div></li></ol>', | ||
| render_block_core_comment_template( null, null, $block ) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Test rendering 3 nested comments: | ||
| * | ||
| * └─ comment 1 | ||
| * └─ comment 2 | ||
| * └─ comment 3 | ||
| */ | ||
| function test_rendering_comment_template_nested() { | ||
| $nested_comment_ids = self::factory()->comment->create_post_comments( | ||
| self::$custom_post->ID, | ||
| 1, | ||
| array( | ||
| 'comment_parent' => self::$comment_ids[0], | ||
| 'comment_author' => 'Test', | ||
| 'comment_author_email' => '[email protected]', | ||
| 'comment_content' => 'Hello world', | ||
| ) | ||
| ); | ||
|
|
||
| self::factory()->comment->create_post_comments( | ||
| self::$custom_post->ID, | ||
| 1, | ||
| array( | ||
| 'comment_parent' => $nested_comment_ids[0], | ||
| 'comment_author' => 'Test', | ||
| 'comment_author_email' => '[email protected]', | ||
| 'comment_content' => 'Hello world', | ||
| ) | ||
| ); | ||
|
|
||
| $parsed_blocks = parse_blocks( | ||
| '<!-- wp:comment-template --><!-- wp:comment-author-name /--><!-- wp:comment-content /--><!-- /wp:comment-template -->' | ||
| ); | ||
|
|
||
| $block = new WP_Block( | ||
| $parsed_blocks[0], | ||
| array( | ||
| 'postId' => self::$custom_post->ID, | ||
| ) | ||
| ); | ||
|
|
||
| $this->assertEquals( | ||
| '<ol ><li><div class="wp-block-comment-author-name">Test</div><div class="wp-block-comment-content">Hello world</div><ol><li><div class="wp-block-comment-author-name">Test</div><div class="wp-block-comment-content">Hello world</div><ol><li><div class="wp-block-comment-author-name">Test</div><div class="wp-block-comment-content">Hello world</div></li></ol></li></ol></li></ol>', | ||
| render_block_core_comment_template( null, null, $block ) | ||
| ); | ||
| } | ||
| /** | ||
| * Test that both "Older Comments" and "Newer Comments" are displayed in the correct order | ||
| * inside the Comment Query Loop when we enable pagination on Discussion Settings. | ||
| * In order to do that, it should exist a query var 'cpage' set with the $comment_args['paged'] value. | ||
| */ | ||
| function test_build_comment_query_vars_from_block_sets_cpage_var() { | ||
|
|
||
| // This could be any number, we set a fixed one instead of a random for better performance. | ||
| $comment_query_max_num_pages = 5; | ||
| // We substract 1 because we created 1 comment at the beggining. | ||
| $post_comments_numbers = ( self::$per_page * $comment_query_max_num_pages ) - 1; | ||
| self::factory()->comment->create_post_comments( | ||
| self::$custom_post->ID, | ||
| $post_comments_numbers, | ||
| array( | ||
| 'comment_author' => 'Test', | ||
| 'comment_author_email' => '[email protected]', | ||
| 'comment_content' => 'Hello world', | ||
| ) | ||
| ); | ||
| $parsed_blocks = parse_blocks( | ||
| '<!-- wp:comment-template --><!-- wp:comment-author-name /--><!-- wp:comment-content /--><!-- /wp:comment-template -->' | ||
| ); | ||
|
|
||
| $block = new WP_Block( | ||
| $parsed_blocks[0], | ||
| array( | ||
| 'postId' => self::$custom_post->ID, | ||
| 'comments/inherit' => true, | ||
| ) | ||
| ); | ||
| $actual = build_comment_query_vars_from_block( $block ); | ||
| $this->assertEquals( $comment_query_max_num_pages, $actual['paged'] ); | ||
| $this->assertEquals( $comment_query_max_num_pages, get_query_var( 'cpage' ) ); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why write to a query variable here? It breaks everything else in WP. It should remain
0on the first page, as it always had been.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cross-referencing #6291, where this is now being discussed, and WordPress/gutenberg#39227, where it was originally introduced.