Allow for custom revision / autosave endpoints classes. #3533

spacedmonkey · 2022-10-27T18:12:39Z

TODO

Unit tests for Post type class.
Unit tests for template revisions rest api endpoint
Unit tests for template autosave rest api endpoint

Trac ticket: https://core.trac.wordpress.org/ticket/56922

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.

TimothyBJacobs · 2023-02-03T20:03:55Z

What would the autosaves / revisions controllers look like when they need to be custom for templates/template parts.

src/wp-includes/class-wp-post-type.php

tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController.php

…are_item test method.

…item_schema test method.

kadamwhite

Takes a lot of code to do this, doesn't it! Thanks for fleshing out the unit tests more, @spacedmonkey .

I am fine with the overall approach, and mostly want to encourage a full once-over of all docblocks to make sure they're not strictly copy-pasted from the base controller when more specific wording might help us in the future.

src/wp-includes/block-template-utils.php

src/wp-includes/class-wp-post-type.php

src/wp-includes/rest-api/endpoints/class-wp-rest-template-autosaves-controller.php

src/wp-includes/rest-api/endpoints/class-wp-rest-template-revisions-controller.php

spacedmonkey · 2023-10-09T12:52:39Z

@kadamwhite I 100% agree, we need to do a full pass on the docs. But can be done after commit / RC stage. I will review docs again, but I don't want docs to be the reason we miss WP 6.4, this change has been punted 3 times already.

Co-authored-by: K Adam White <[email protected]>

costdev

Thanks @spacedmonkey!

Some minor feedback then this is good from my perspective. 🙂

src/wp-includes/rest-api/endpoints/class-wp-rest-template-autosaves-controller.php

src/wp-includes/rest-api/endpoints/class-wp-rest-template-revisions-controller.php

src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php

tests/phpunit/tests/post/wpPostType.php

tests/phpunit/tests/rest-api/wpRestTemplateAutosavesController.php

tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController.php

src/wp-includes/class-wp-post-type.php

Co-authored-by: Colin Stewart <[email protected]>

costdev

Just the ! empty() conversation and these two typo corrections left. Pre-approving as I'll be AFK for a bit. 🙂

tests/phpunit/tests/rest-api/wpRestTemplateAutosavesController.php

kadamwhite

Fair point, @spacedmonkey , so long as we do come back to the docs before release. Thank you for addressing the top issues I flagged—approving from my end to unblock moving forward.

…troller.php

….php Co-authored-by: Colin Stewart <[email protected]>

mukeshpanchal27

Thanks @spacedmonkey for the PR. Left some minor feedback. Do we need the changes from tests/qunit/fixtures/wp-api-generated.js file?

src/wp-includes/block-template-utils.php

src/wp-includes/class-wp-post-type.php

src/wp-includes/post.php

tests/phpunit/tests/post/wpPostType.php

Co-authored-by: Mukesh Panchal <[email protected]>

src/wp-includes/post.php

spacedmonkey · 2023-10-10T10:54:15Z

Thanks @spacedmonkey for the PR. Left some minor feedback. Do we need the changes from tests/qunit/fixtures/wp-api-generated.js file?

Yes, it is needed. All updates to the rest api need this update. See this example 4f56c3d

anton-vlasenko

Explanation of why these changes are needed:

Additionally, the rest-schema-setup.php and wp-api-generated.js files will need to be updated too.

anton-vlasenko · 2023-10-10T11:12:15Z

src/wp-includes/rest-api/endpoints/class-wp-rest-template-autosaves-controller.php

+				 * Matches theme's directory: `/themes/<subdirectory>/<theme>/` or `/themes/<theme>/`.
+				 * Excludes invalid directory name characters: `/:<>*?"|`.
+				 */
+				'([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',


Suggested change

'([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',

'([^\/:<>\*\?"\|]+\/\/?[^\/:<>\*\?"\|]+)',

anton-vlasenko · 2023-10-10T11:13:07Z

src/wp-includes/rest-api/endpoints/class-wp-rest-template-autosaves-controller.php

+				 * Matches theme's directory: `/themes/<subdirectory>/<theme>/` or `/themes/<theme>/`.
+				 * Excludes invalid directory name characters: `/:<>*?"|`.
+				 */
+				'([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',


Suggested change

'([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',

'([^\/:<>\*\?"\|]+\/\/?[^\/:<>\*\?"\|]+)',

anton-vlasenko · 2023-10-10T11:13:32Z

src/wp-includes/rest-api/endpoints/class-wp-rest-template-revisions-controller.php

+				 * Matches theme's directory: `/themes/<subdirectory>/<theme>/` or `/themes/<theme>/`.
+				 * Excludes invalid directory name characters: `/:<>*?"|`.
+				 */
+				'([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',


Suggested change

'([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',

'([^\/:<>\*\?"\|]+\/\/?[^\/:<>\*\?"\|]+)',

anton-vlasenko · 2023-10-10T11:14:09Z

src/wp-includes/rest-api/endpoints/class-wp-rest-template-revisions-controller.php

+				 * Matches theme's directory: `/themes/<subdirectory>/<theme>/` or `/themes/<theme>/`.
+				 * Excludes invalid directory name characters: `/:<>*?"|`.
+				 */
+				'([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',


Suggested change

'([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',

'([^\/:<>\*\?"\|]+\/\/?[^\/:<>\*\?"\|]+)',

anton-vlasenko · 2023-10-10T11:15:41Z

tests/phpunit/tests/rest-api/wpRestTemplateAutosavesController.php

+	public function test_register_routes() {
+		$routes = rest_get_server()->get_routes();
+		$this->assertArrayHasKey(
+			'/wp/v2/templates/(?P<id>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves',


Suggested change

'/wp/v2/templates/(?P<id>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves',

'/wp/v2/templates/(?P<id>([^\/:<>\*\?"\|]+\/\/?[^\/:<>\*\?"\|]+)[\/\w%-]+)/autosaves',

anton-vlasenko · 2023-10-10T11:17:06Z

tests/phpunit/tests/rest-api/wpRestTemplateAutosavesController.php

+			'Template part autosaves route does not exist.'
+		);
+		$this->assertArrayHasKey(
+			'/wp/v2/template-parts/(?P<parent>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves/(?P<id>[\d]+)',


Suggested change

'/wp/v2/template-parts/(?P<parent>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves/(?P<id>[\d]+)',

'/wp/v2/template-parts/(?P<parent>([^\/:<>\*\?"\|]+\/\/?[^\/:<>\*\?"\|]+)[\/\w%-]+)/autosaves/(?P<id>[\d]+)',

anton-vlasenko · 2023-10-10T11:17:55Z

tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController.php

+	public function test_register_routes() {
+		$routes = rest_get_server()->get_routes();
+		$this->assertArrayHasKey(
+			'/wp/v2/templates/(?P<parent>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions',


Suggested change

'/wp/v2/templates/(?P<parent>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions',

'/wp/v2/templates/(?P<parent>([^\/:<>\*\?"\|]+\/\/?[^\/:<>\*\?"\|]+)[\/\w%-]+)/revisions',

anton-vlasenko · 2023-10-10T11:18:11Z

tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController.php

+			'Template revisions route does not exist.'
+		);
+		$this->assertArrayHasKey(
+			'/wp/v2/templates/(?P<parent>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions/(?P<id>[\d]+)',


Suggested change

'/wp/v2/templates/(?P<parent>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions/(?P<id>[\d]+)',

'/wp/v2/templates/(?P<parent>([^\/:<>\*\?"\|]+\/\/?[^\/:<>\*\?"\|]+)[\/\w%-]+)/revisions/(?P<id>[\d]+)',

anton-vlasenko · 2023-10-10T11:18:35Z

tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController.php

+			'Single template revision based on the given ID route does not exist.'
+		);
+		$this->assertArrayHasKey(
+			'/wp/v2/template-parts/(?P<parent>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions',


Suggested change

'/wp/v2/template-parts/(?P<parent>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions',

'/wp/v2/template-parts/(?P<parent>([^\/:<>\*\?"\|]+\/\/?[^\/:<>\*\?"\|]+)[\/\w%-]+)/revisions',

anton-vlasenko · 2023-10-10T11:19:05Z

tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController.php

+			'Template part revisions route does not exist.'
+		);
+		$this->assertArrayHasKey(
+			'/wp/v2/template-parts/(?P<parent>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions/(?P<id>[\d]+)',


Suggested change

'/wp/v2/template-parts/(?P<parent>([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions/(?P<id>[\d]+)',

'/wp/v2/template-parts/(?P<parent>([^\/:<>\*\?"\|]+\/\/?[^\/:<>\*\?"\|]+)[\/\w%-]+)/revisions/(?P<id>[\d]+)',

spacedmonkey · 2023-10-10T14:03:45Z

Committed https://core.trac.wordpress.org/changeset/56819

Allow for custom revision / autosave endpoints classes.

800d074

spacedmonkey added 5 commits September 25, 2023 15:07

Merge branch 'trunk' into fix/custom-endpoints-revisions

e6601cb

Improvements.

13789c1

Fix endpoints.

c8f0cc9

Fix lints

987d796

Better logic.

97d9faf

spacedmonkey commented Sep 26, 2023

View reviewed changes

src/wp-includes/class-wp-post-type.php Outdated Show resolved Hide resolved

spacedmonkey commented Sep 26, 2023

View reviewed changes

src/wp-includes/class-wp-post-type.php Outdated Show resolved Hide resolved

spacedmonkey and others added 8 commits September 26, 2023 10:56

Apply suggestions from code review

dff4f3c

Add links.

b69f359

Fix links.

c31b9e2

Tweaks.

572924b

Tweaks again.

99166d0

Tweaks again.

86fbb30

Add comment.

fe3640f

Update schema

e31904c

anton-vlasenko mentioned this pull request Sep 29, 2023

Fix route conflicts for the auto-save and revisions endpoints of the wp_template and wp_template_part post types #5194

Closed

anton-vlasenko added 2 commits September 29, 2023 12:37

Cherry pick the test from WordPress#5332

a92f8ec

Mark test for CREATE and UPDATE operations as skipped.

f80a74f

spacedmonkey commented Sep 29, 2023

View reviewed changes

tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController.php Outdated Show resolved Hide resolved

spacedmonkey commented Sep 29, 2023

View reviewed changes

tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController.php Outdated Show resolved Hide resolved

spacedmonkey commented Sep 29, 2023

View reviewed changes

tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController.php Outdated Show resolved Hide resolved

spacedmonkey and others added 7 commits September 29, 2023 13:38

Fix autosave endpoint.

649145a

Implement a unit test for deleting a single template revision.

46cabc9

Repeated code.

7d85c9b

Implement the Tests_REST_wpRestTemplateRevisionsController::test_prep…

88d753c

…are_item test method.

Implement the Tests_REST_wpRestTemplateRevisionsController::test_get_…

d768cfb

…item_schema test method.

Add dots to the failure messages.

554cb7c

Fix CS error.

05c9cb3

spacedmonkey requested review from felixarntz and hellofromtonya October 9, 2023 09:54

kadamwhite requested changes Oct 9, 2023

View reviewed changes

spacedmonkey and others added 3 commits October 9, 2023 13:58

Update some docs.

f0cfb31

Update some docs again.

dc75bed

Apply suggestions from code review

49c0dc6

Co-authored-by: K Adam White <[email protected]>

spacedmonkey requested a review from costdev October 9, 2023 13:36

costdev requested changes Oct 9, 2023

View reviewed changes

spacedmonkey and others added 3 commits October 9, 2023 15:13

Apply suggestions from code review

24f50b2

Co-authored-by: Colin Stewart <[email protected]>

Add missing message.

1368354

Update src/wp-includes/class-wp-post-type.php

2401506

Co-authored-by: Colin Stewart <[email protected]>

costdev approved these changes Oct 9, 2023

View reviewed changes

tests/phpunit/tests/rest-api/wpRestTemplateAutosavesController.php Outdated Show resolved Hide resolved

tests/phpunit/tests/rest-api/wpRestTemplateAutosavesController.php Outdated Show resolved Hide resolved

kadamwhite approved these changes Oct 9, 2023

View reviewed changes

spacedmonkey and others added 4 commits October 9, 2023 21:55

Update src/wp-includes/rest-api/endpoints/class-wp-rest-templates-con…

8d89067

…troller.php

Update tests/phpunit/tests/rest-api/wpRestTemplateAutosavesController…

0b67eaf

….php Co-authored-by: Colin Stewart <[email protected]>

Update tests/phpunit/tests/rest-api/wpRestTemplateAutosavesController…

4e3151e

….php Co-authored-by: Colin Stewart <[email protected]>

Update tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController…

c01c0fc

….php Co-authored-by: Colin Stewart <[email protected]>

mukeshpanchal27 reviewed Oct 10, 2023

View reviewed changes

Apply suggestions from code review

7fa0627

Co-authored-by: Mukesh Panchal <[email protected]>

spacedmonkey commented Oct 10, 2023

View reviewed changes

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

Apply suggestions from code review

300d102

spacedmonkey requested a review from mukeshpanchal27 October 10, 2023 10:14

mukeshpanchal27 approved these changes Oct 10, 2023

View reviewed changes

anton-vlasenko reviewed Oct 10, 2023

View reviewed changes

Merge branch 'trunk' into fix/custom-endpoints-revisions

4e6d9c3

spacedmonkey closed this Oct 10, 2023

ockham mentioned this pull request Mar 18, 2024

Block Hooks API: Create helper function for creating WP_Block_Template object for $context #6278

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow for custom revision / autosave endpoints classes. #3533

Allow for custom revision / autosave endpoints classes. #3533

spacedmonkey commented Oct 27, 2022 •

edited

Loading

TimothyBJacobs commented Feb 3, 2023

kadamwhite left a comment

spacedmonkey commented Oct 9, 2023

costdev left a comment

costdev left a comment

kadamwhite left a comment

mukeshpanchal27 left a comment

spacedmonkey commented Oct 10, 2023

anton-vlasenko left a comment •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

spacedmonkey commented Oct 10, 2023

	'([^\/:<>\\?"\\|]+(?:\/[^\/:<>\\?"\\|]+)?)',
	'([^\/:<>\\?"\\|]+\/\/?[^\/:<>\\?"\\|]+)',

	'/wp/v2/templates/(?P<id>([^\/:<>\\?"\\|]+(?:\/[^\/:<>\\?"\\|]+)?)[\/\w%-]+)/autosaves',
	'/wp/v2/templates/(?P<id>([^\/:<>\\?"\\|]+\/\/?[^\/:<>\\?"\\|]+)[\/\w%-]+)/autosaves',

	'/wp/v2/template-parts/(?P<parent>([^\/:<>\\?"\\|]+(?:\/[^\/:<>\\?"\\|]+)?)[\/\w%-]+)/autosaves/(?P<id>[\d]+)',
	'/wp/v2/template-parts/(?P<parent>([^\/:<>\\?"\\|]+\/\/?[^\/:<>\\?"\\|]+)[\/\w%-]+)/autosaves/(?P<id>[\d]+)',

	'/wp/v2/templates/(?P<parent>([^\/:<>\\?"\\|]+(?:\/[^\/:<>\\?"\\|]+)?)[\/\w%-]+)/revisions',
	'/wp/v2/templates/(?P<parent>([^\/:<>\\?"\\|]+\/\/?[^\/:<>\\?"\\|]+)[\/\w%-]+)/revisions',

Allow for custom revision / autosave endpoints classes. #3533

Allow for custom revision / autosave endpoints classes. #3533

Conversation

spacedmonkey commented Oct 27, 2022 • edited Loading

TODO

Trac ticket: https://core.trac.wordpress.org/ticket/56922

TimothyBJacobs commented Feb 3, 2023

kadamwhite left a comment

Choose a reason for hiding this comment

spacedmonkey commented Oct 9, 2023

costdev left a comment

Choose a reason for hiding this comment

costdev left a comment

Choose a reason for hiding this comment

kadamwhite left a comment

Choose a reason for hiding this comment

mukeshpanchal27 left a comment

Choose a reason for hiding this comment

spacedmonkey commented Oct 10, 2023

anton-vlasenko left a comment • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

anton-vlasenko Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

spacedmonkey commented Oct 10, 2023

spacedmonkey commented Oct 27, 2022 •

edited

Loading

anton-vlasenko left a comment •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading

anton-vlasenko Oct 10, 2023 •

edited

Loading