vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2025-10-16 12:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

REST API: add revisions endpoint for global styles.

Browse Source 
Adds an endpoint that returns revisions to the global styles custom post.

Props ramonopoly, peterwilsoncc, spacedmonkey, mukesh27, timothyblynjacobs.
Fixes #58524.


git-svn-id: https://develop.svn.wordpress.org/trunk@56082 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Isabel Brison 2023-06-28 03:33:23 +00:00
parent 36c819db7e
commit c345180c29
8 changed files with 1351 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
package-lock.json generated
View File

@ -12728,7 +12728,7 @@
"from2-string": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/from2-string/-/from2-string-1.1.0.tgz",
"integrity": "sha1-GCgrJ9CKJnyzAwzSuLSw8hKvdSo=",
"integrity": "sha512-m8vCh+KnXXXBtfF2VUbiYlQ+nczLcntB0BrtNgpmLkHylhObe9WF1b2LZjBBzrZzA6P4mkEla6ZYQoOUTG8cYA==",
"requires": {
"from2": "^2.0.3"
}
@ -21799,7 +21799,7 @@
"promise-polyfill": {
"version": "1.1.6",
"resolved": "https://registry.npmjs.org/promise-polyfill/-/promise-polyfill-1.1.6.tgz",
"integrity": "sha1-zQTv9G9clcOn0EVZHXm14+AfEtc="
"integrity": "sha512-7rrONfyLkDEc7OJ5QBkqa4KI4EBhCd340xRuIUPGCfu13znS+vx+VDdrT9ODAJHlXm7w4lbxN3DRjyv58EuzDg=="
},
"prompts": {
"version": "2.4.2",
@ -23986,7 +23986,7 @@
"stream-from-promise": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/stream-from-promise/-/stream-from-promise-1.0.0.tgz",
"integrity": "sha1-djaH9913fkyJT2QIMz/Gs/yKYbs="
"integrity": "sha512-j84KLkudt+gr8KJ21RB02btPLx61uGbrLnewsWz6QKmsz8/c4ZFqXw6mJh5+G4oRN7DgDxdbjPxnpySpg1mUig=="
},
"stream-to-string": {
"version": "1.2.0",
@ -25374,7 +25374,7 @@
"toposort": {
"version": "2.0.2",
"resolved": "https://registry.npmjs.org/toposort/-/toposort-2.0.2.tgz",
"integrity": "sha1-riF2gXXRVZ1IvvNUILL0li8JwzA="
"integrity": "sha512-0a5EOkAUp8D4moMi2W8ZF8jcga7BgZd91O/yabJCFY8az+XSzeGyTKs0Aoo897iV1Nj6guFq8orWDS96z91oGg=="
},
"totalist": {
"version": "1.1.0",

4
src/wp-includes/rest-api.php
View File

@ -317,6 +317,10 @@ function create_initial_rest_routes() {
$controller = new WP_REST_Block_Types_Controller();
$controller->register_routes();
// Global Styles revisions.
$controller = new WP_REST_Global_Styles_Revisions_Controller();
$controller->register_routes();
// Global Styles.
$controller = new WP_REST_Global_Styles_Controller();
$controller->register_routes();

11
src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php
View File

@ -420,6 +420,7 @@ class WP_REST_Global_Styles_Controller extends WP_REST_Controller {
* Prepares links for the request.
*
* @since 5.9.0
* @since 6.3.0 Adds revisions count and rest URL href to version-history.
*
* @param integer $id ID.
* @return array Links for the given post.
@ -433,6 +434,16 @@ class WP_REST_Global_Styles_Controller extends WP_REST_Controller {
),
);
if ( post_type_supports( $this->post_type, 'revisions' ) ) {
$revisions = wp_get_latest_revision_id_and_total_count( $id );
$revisions_count = ! is_wp_error( $revisions ) ? $revisions['count'] : 0;
$revisions_base = sprintf( '/%s/%d/revisions', $base, $id );
$links['version-history'] = array(
'href' => rest_url( $revisions_base ),
'count' => $revisions_count,
);
}
return $links;
}

474
src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-revisions-controller.php Normal file
View File

@ -0,0 +1,474 @@
<?php
/**
* REST API: WP_REST_Global_Styles_Revisions_Controller class
*
* @package WordPress
* @subpackage REST_API
* @since 6.3.0
*/
/**
* Core class used to access global styles revisions via the REST API.
*
* @since 6.3.0
*
* @see WP_REST_Controller
*/
class WP_REST_Global_Styles_Revisions_Controller extends WP_REST_Controller {
/**
* Parent post type.
*
* @since 6.3.0
* @var string
*/
private $parent_post_type;
/**
* The base of the parent controller's route.
*
* @since 6.3.0
* @var string
*/
private $parent_base;
/**
* Constructor.
*
* @since 6.3.0
*/
public function __construct() {
$this->parent_post_type = 'wp_global_styles';
$this->rest_base = 'revisions';
$this->parent_base = 'global-styles';
$this->namespace = 'wp/v2';
}
/**
* Registers the controller's routes.
*
* @since 6.3.0
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base,
array(
'args' => array(
'parent' => array(
'description' => __( 'The ID for the parent of the revision.' ),
'type' => 'integer',
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
'args' => $this->get_collection_params(),
),
'schema' => array( $this, 'get_public_item_schema' ),
)
);
}
/**
* Retrieves the query params for collections.
*
* Inherits from WP_REST_Controller::get_collection_params(),
* also reflects changes to return value WP_REST_Revisions_Controller::get_collection_params().
*
* @since 6.3.0
*
* @return array Collection parameters.
*/
public function get_collection_params() {
$collection_params = parent::get_collection_params();
$collection_params['context']['default'] = 'view';
$collection_params['offset'] = array(
'description' => __( 'Offset the result set by a specific number of items.' ),
'type' => 'integer',
);
unset( $collection_params['search'] );
unset( $collection_params['per_page']['default'] );
return $collection_params;
}
/**
* Returns decoded JSON from post content string,
* or a 404 if not found.
*
* @since 6.3.0
*
* @param string $raw_json Encoded JSON from global styles custom post content.
* @return Array|WP_Error
*/
private function get_decoded_global_styles_json( $raw_json ) {
$decoded_json = json_decode( $raw_json, true );
if ( is_array( $decoded_json ) && isset( $decoded_json['isGlobalStylesUserThemeJSON'] ) && true === $decoded_json['isGlobalStylesUserThemeJSON'] ) {
return $decoded_json;
}
return new WP_Error(
'rest_global_styles_not_found',
__( 'Cannot find user global styles revisions.' ),
array( 'status' => 404 )
);
}
/**
* Returns paginated revisions of the given global styles config custom post type.
*
* The bulk of the body is taken from WP_REST_Revisions_Controller->get_items,
* but global styles does not require as many parameters.
*
* @since 6.3.0
*
* @param WP_REST_Request $request The request instance.
* @return WP_REST_Response|WP_Error
*/
public function get_items( $request ) {
$parent = $this->get_parent( $request['parent'] );
if ( is_wp_error( $parent ) ) {
return $parent;
}
$global_styles_config = $this->get_decoded_global_styles_json( $parent->post_content );
if ( is_wp_error( $global_styles_config ) ) {
return $global_styles_config;
}
if ( wp_revisions_enabled( $parent ) ) {
$registered = $this->get_collection_params();
$query_args = array(
'post_parent' => $parent->ID,
'post_type' => 'revision',
'post_status' => 'inherit',
'posts_per_page' => -1,
'orderby' => 'date ID',
'order' => 'DESC',
);
$parameter_mappings = array(
'offset' => 'offset',
'page' => 'paged',
'per_page' => 'posts_per_page',
);
foreach ( $parameter_mappings as $api_param => $wp_param ) {
if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) {
$query_args[ $wp_param ] = $request[ $api_param ];
}
}
$revisions_query = new WP_Query();
$revisions = $revisions_query->query( $query_args );
$offset = isset( $query_args['offset'] ) ? (int) $query_args['offset'] : 0;
$page = (int) $query_args['paged'];
$total_revisions = $revisions_query->found_posts;
if ( $total_revisions < 1 ) {
// Out-of-bounds, run the query again without LIMIT for total count.
unset( $query_args['paged'], $query_args['offset'] );
$count_query = new WP_Query();
$count_query->query( $query_args );
$total_revisions = $count_query->found_posts;
}
if ( $revisions_query->query_vars['posts_per_page'] > 0 ) {
$max_pages = ceil( $total_revisions / (int) $revisions_query->query_vars['posts_per_page'] );
} else {
$max_pages = $total_revisions > 0 ? 1 : 0;
}
if ( $total_revisions > 0 ) {
if ( $offset >= $total_revisions ) {
return new WP_Error(
'rest_revision_invalid_offset_number',
__( 'The offset number requested is larger than or equal to the number of available revisions.' ),
array( 'status' => 400 )
);
} elseif ( ! $offset && $page > $max_pages ) {
return new WP_Error(
'rest_revision_invalid_page_number',
__( 'The page number requested is larger than the number of pages available.' ),
array( 'status' => 400 )
);
}
}
} else {
$revisions = array();
$total_revisions = 0;
$max_pages = 0;
$page = (int) $request['page'];
}
$response = array();
foreach ( $revisions as $revision ) {
$data = $this->prepare_item_for_response( $revision, $request );
$response[] = $this->prepare_response_for_collection( $data );
}
$response = rest_ensure_response( $response );
$response->header( 'X-WP-Total', (int) $total_revisions );
$response->header( 'X-WP-TotalPages', (int) $max_pages );
$request_params = $request->get_query_params();
$base_path = rest_url( sprintf( '%s/%s/%d/%s', $this->namespace, $this->parent_base, $request['parent'], $this->rest_base ) );
$base = add_query_arg( urlencode_deep( $request_params ), $base_path );
if ( $page > 1 ) {
$prev_page = $page - 1;
if ( $prev_page > $max_pages ) {
$prev_page = $max_pages;
}
$prev_link = add_query_arg( 'page', $prev_page, $base );
$response->link_header( 'prev', $prev_link );
}
if ( $max_pages > $page ) {
$next_page = $page + 1;
$next_link = add_query_arg( 'page', $next_page, $base );
$response->link_header( 'next', $next_link );
}
return $response;
}
/**
* Checks the post_date_gmt or modified_gmt and prepare any post or
* modified date for single post output.
*
* Duplicate of WP_REST_Revisions_Controller::prepare_date_response
*
* @since 6.3.0
*
* @param string $date_gmt GMT publication time.
* @param string|null $date Optional. Local publication time. Default null.
* @return string|null ISO8601/RFC3339 formatted datetime, otherwise null.
*/
protected function prepare_date_response( $date_gmt, $date = null ) {
if ( '0000-00-00 00:00:00' === $date_gmt ) {
return null;
}
if ( isset( $date ) ) {
return mysql_to_rfc3339( $date );
}
return mysql_to_rfc3339( $date_gmt );
}
/**
* Prepares the revision for the REST response.
*
* @since 6.3.0
*
* @param WP_Post $post Post revision object.
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response|WP_Error Response object.
*/
public function prepare_item_for_response( $post, $request ) {
$parent = $this->get_parent( $request['parent'] );
$global_styles_config = $this->get_decoded_global_styles_json( $post->post_content );
if ( is_wp_error( $global_styles_config ) ) {
return $global_styles_config;
}
$fields = $this->get_fields_for_response( $request );
$data = array();
if ( ! empty( $global_styles_config['styles'] ) || ! empty( $global_styles_config['settings'] ) ) {
$global_styles_config = ( new WP_Theme_JSON( $global_styles_config, 'custom' ) )->get_raw_data();
if ( rest_is_field_included( 'settings', $fields ) ) {
$data['settings'] = ! empty( $global_styles_config['settings'] ) ? $global_styles_config['settings'] : new stdClass();
}
if ( rest_is_field_included( 'styles', $fields ) ) {
$data['styles'] = ! empty( $global_styles_config['styles'] ) ? $global_styles_config['styles'] : new stdClass();
}
}
if ( rest_is_field_included( 'author', $fields ) ) {
$data['author'] = (int) $post->post_author;
}
if ( rest_is_field_included( 'date', $fields ) ) {
$data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date );
}
if ( rest_is_field_included( 'date_gmt', $fields ) ) {
$data['date_gmt'] = $this->prepare_date_response( $post->post_date_gmt );
}
if ( rest_is_field_included( 'id', $fields ) ) {
$data['id'] = (int) $post->ID;
}
if ( rest_is_field_included( 'modified', $fields ) ) {
$data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified );
}
if ( rest_is_field_included( 'modified_gmt', $fields ) ) {
$data['modified_gmt'] = $this->prepare_date_response( $post->post_modified_gmt );
}
if ( rest_is_field_included( 'parent', $fields ) ) {
$data['parent'] = (int) $parent->ID;
}
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request );
$data = $this->filter_response_by_context( $data, $context );
return rest_ensure_response( $data );
}
/**
* Retrieves the revision's schema, conforming to JSON Schema.
*
* @since 6.3.0
*
* @return array Item schema data.
*/
public function get_item_schema() {
if ( $this->schema ) {
return $this->add_additional_fields_schema( $this->schema );
}
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => "{$this->parent_post_type}-revision",
'type' => 'object',
// Base properties for every revision.
'properties' => array(
/*
* Adds settings and styles from the WP_REST_Revisions_Controller item fields.
* Leaves out GUID as global styles shouldn't be accessible via URL.
*/
'author' => array(
'description' => __( 'The ID for the author of the revision.' ),
'type' => 'integer',
'context' => array( 'view', 'edit', 'embed' ),
),
'date' => array(
'description' => __( "The date the revision was published, in the site's timezone." ),
'type' => 'string',
'format' => 'date-time',
'context' => array( 'view', 'edit', 'embed' ),
),
'date_gmt' => array(
'description' => __( 'The date the revision was published, as GMT.' ),
'type' => 'string',
'format' => 'date-time',
'context' => array( 'view', 'edit' ),
),
'id' => array(
'description' => __( 'Unique identifier for the revision.' ),
'type' => 'integer',
'context' => array( 'view', 'edit', 'embed' ),
),
'modified' => array(
'description' => __( "The date the revision was last modified, in the site's timezone." ),
'type' => 'string',
'format' => 'date-time',
'context' => array( 'view', 'edit' ),
),
'modified_gmt' => array(
'description' => __( 'The date the revision was last modified, as GMT.' ),
'type' => 'string',
'format' => 'date-time',
'context' => array( 'view', 'edit' ),
),
'parent' => array(
'description' => __( 'The ID for the parent of the revision.' ),
'type' => 'integer',
'context' => array( 'view', 'edit', 'embed' ),
),
// Adds settings and styles from the WP_REST_Global_Styles_Controller parent schema.
'styles' => array(
'description' => __( 'Global styles.' ),
'type' => array( 'object' ),
'context' => array( 'view', 'edit' ),
),
'settings' => array(
'description' => __( 'Global settings.' ),
'type' => array( 'object' ),
'context' => array( 'view', 'edit' ),
),
),
);
$this->schema = $schema;
return $this->add_additional_fields_schema( $this->schema );
}
/**
* Checks if a given request has access to read a single global style.
*
* @since 6.3.0
*
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has read access, WP_Error object otherwise.
*/
public function get_item_permissions_check( $request ) {
$post = $this->get_parent( $request['parent'] );
if ( is_wp_error( $post ) ) {
return $post;
}
/*
* The same check as WP_REST_Global_Styles_Controller::get_item_permissions_check.
*/
if ( ! current_user_can( 'read_post', $post->ID ) ) {
return new WP_Error(
'rest_cannot_view',
__( 'Sorry, you are not allowed to view revisions for this global style.' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Get the parent post, if the ID is valid.
*
* Duplicate of WP_REST_Revisions_Controller::get_parent
*
* @since 6.3.0
*
* @param int $parent_post_id Supplied ID.
* @return WP_Post|WP_Error Post object if ID is valid, WP_Error otherwise.
*/
protected function get_parent( $parent_post_id ) {
$error = new WP_Error(
'rest_post_invalid_parent',
__( 'Invalid post parent ID.' ),
array( 'status' => 404 )
);
if ( (int) $parent_post_id <= 0 ) {
return $error;
}
$parent_post = get_post( (int) $parent_post_id );
if ( empty( $parent_post ) || empty( $parent_post->ID )
|| $this->parent_post_type !== $parent_post->post_type
) {
return $error;
}
return $parent_post;
}
}

1
src/wp-settings.php
View File

@ -261,6 +261,7 @@ require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-controller.php';
require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-posts-controller.php';
require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-attachments-controller.php';
require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-global-styles-controller.php';
require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-global-styles-revisions-controller.php';
require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-post-types-controller.php';
require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-post-statuses-controller.php';
require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-revisions-controller.php';

806
tests/phpunit/tests/rest-api/rest-global-styles-revisions-controller.php Normal file
View File

@ -0,0 +1,806 @@
<?php
/**
* Unit tests covering WP_REST_Global_Styles_Revisions_Controller functionality.
*
* @package WordPress
* @subpackage REST API
*
* @covers WP_REST_Global_Styles_Revisions_Controller
*
* @group restapi-global-styles
* @group restapi
*/
class WP_REST_Global_Styles_Revisions_Controller_Test extends WP_Test_REST_Controller_Testcase {
/**
* @var int
*/
protected static $admin_id;
/**
* @var int
*/
protected static $second_admin_id;
/**
* @var int
*/
protected static $author_id;
/**
* @var int
*/
protected static $global_styles_id;
/**
* @var int
*/
private $total_revisions;
/**
* @var array
*/
private $revision_1;
/**
* @var int
*/
private $revision_1_id;
/**
* @var array
*/
private $revision_2;
/**
* @var int
*/
private $revision_2_id;
/**
* @var array
*/
private $revision_3;
/**
* @var int
*/
private $revision_3_id;
/**
* Create fake data before our tests run.
*
* @param WP_UnitTest_Factory $factory Helper that lets us create fake data.
*/
public static function wpSetupBeforeClass( $factory ) {
self::$admin_id = $factory->user->create(
array(
'role' => 'administrator',
)
);
self::$second_admin_id = $factory->user->create(
array(
'role' => 'administrator',
)
);
self::$author_id = $factory->user->create(
array(
'role' => 'author',
)
);
wp_set_current_user( self::$admin_id );
// This creates the global styles for the current theme.
self::$global_styles_id = $factory->post->create(
array(
'post_content' => '{"version": ' . WP_Theme_JSON::LATEST_SCHEMA . ', "isGlobalStylesUserThemeJSON": true }',
'post_status' => 'publish',
'post_title' => __( 'Custom Styles', 'default' ),
'post_type' => 'wp_global_styles',
'post_name' => 'wp-global-styles-tt1-blocks-revisions',
'tax_input' => array(
'wp_theme' => 'tt1-blocks',
),
)
);
// Update post to create a new revisions.
$new_styles_post = array(
'ID' => self::$global_styles_id,
'post_content' => wp_json_encode(
array(
'version' => WP_Theme_JSON::LATEST_SCHEMA,
'isGlobalStylesUserThemeJSON' => true,
'styles' => array(
'color' => array(
'background' => 'hotpink',
),
),
'settings' => array(
'color' => array(
'palette' => array(
'custom' => array(
array(
'name' => 'Ghost',
'slug' => 'ghost',
'color' => 'ghost',
),
),
),
),
),
)
),
);
wp_update_post( $new_styles_post, true, false );
$new_styles_post = array(
'ID' => self::$global_styles_id,
'post_content' => wp_json_encode(
array(
'version' => WP_Theme_JSON::LATEST_SCHEMA,
'isGlobalStylesUserThemeJSON' => true,
'styles' => array(
'color' => array(
'background' => 'lemonchiffon',
),
),
'settings' => array(
'color' => array(
'palette' => array(
'custom' => array(
array(
'name' => 'Gwanda',
'slug' => 'gwanda',
'color' => 'gwanda',
),
),
),
),
),
)
),
);
wp_update_post( $new_styles_post, true, false );
$new_styles_post = array(
'ID' => self::$global_styles_id,
'post_content' => wp_json_encode(
array(
'version' => WP_Theme_JSON::LATEST_SCHEMA,
'isGlobalStylesUserThemeJSON' => true,
'styles' => array(
'color' => array(
'background' => 'chocolate',
),
),
'settings' => array(
'color' => array(
'palette' => array(
'custom' => array(
array(
'name' => 'Stacy',
'slug' => 'stacy',
'color' => 'stacy',
),
),
),
),
),
)
),
);
wp_update_post( $new_styles_post, true, false );
wp_set_current_user( 0 );
}
/**
* Removes users after our tests run.
*/
public static function wpTearDownAfterClass() {
self::delete_user( self::$admin_id );
self::delete_user( self::$second_admin_id );
self::delete_user( self::$author_id );
}
/**
* Sets up before tests.
*/
public function set_up() {
parent::set_up();
switch_theme( 'tt1-blocks' );
$revisions = wp_get_post_revisions( self::$global_styles_id );
$this->total_revisions = count( $revisions );
$this->revision_1 = array_pop( $revisions );
$this->revision_1_id = $this->revision_1->ID;
$this->revision_2 = array_pop( $revisions );
$this->revision_2_id = $this->revision_2->ID;
$this->revision_3 = array_pop( $revisions );
$this->revision_3_id = $this->revision_3->ID;
}
/**
* @covers WP_REST_Global_Styles_Controller::register_routes
*
* @ticket 58524
*/
public function test_register_routes() {
$routes = rest_get_server()->get_routes();
$this->assertArrayHasKey(
'/wp/v2/global-styles/(?P<parent>[\d]+)/revisions',
$routes,
'Global style revisions based on the given parentID route does not exist.'
);
}
/**
* @covers WP_REST_Global_Styles_Controller::get_items
*
* @ticket 58524
*/
public function test_get_items_missing_parent() {
wp_set_current_user( self::$admin_id );
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER . '/revisions' );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_post_invalid_parent', $response, 404 );
}
/**
* Utility function to check the items in WP_REST_Global_Styles_Controller::get_items
* against the expected values.
*
* @ticket 58524
*/
protected function check_get_revision_response( $response_revision_item, $revision_expected_item ) {
$this->assertSame( (int) $revision_expected_item->post_author, $response_revision_item['author'], 'Check that the revision item `author` exists.' );
$this->assertSame( mysql_to_rfc3339( $revision_expected_item->post_date ), $response_revision_item['date'], 'Check that the revision item `date` exists.' );
$this->assertSame( mysql_to_rfc3339( $revision_expected_item->post_date_gmt ), $response_revision_item['date_gmt'], 'Check that the revision item `date_gmt` exists.' );
$this->assertSame( mysql_to_rfc3339( $revision_expected_item->post_modified ), $response_revision_item['modified'], 'Check that the revision item `modified` exists.' );
$this->assertSame( mysql_to_rfc3339( $revision_expected_item->post_modified_gmt ), $response_revision_item['modified_gmt'], 'Check that the revision item `modified_gmt` exists.' );
$this->assertSame( $revision_expected_item->post_parent, $response_revision_item['parent'], 'Check that an id for the parent exists.' );
// Global styles.
$config = ( new WP_Theme_JSON( json_decode( $revision_expected_item->post_content, true ), 'custom' ) )->get_raw_data();
$this->assertEquals(
$config['settings'],
$response_revision_item['settings'],
'Check that the revision settings exist in the response.'
);
$this->assertEquals(
$config['styles'],
$response_revision_item['styles'],
'Check that the revision styles match the updated styles.'
);
}
/**
* @covers WP_REST_Global_Styles_Controller::get_items
*
* @ticket 58524
*/
public function test_get_items() {
wp_set_current_user( self::$admin_id );
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertSame( 200, $response->get_status(), 'Response status is 200.' );
$this->assertCount( $this->total_revisions, $data, 'Check that correct number of revisions exists.' );
// Reverse chronology.
$this->assertSame( $this->revision_3_id, $data[0]['id'] );
$this->check_get_revision_response( $data[0], $this->revision_3 );
$this->assertSame( $this->revision_2_id, $data[1]['id'] );
$this->check_get_revision_response( $data[1], $this->revision_2 );
$this->assertSame( $this->revision_1_id, $data[2]['id'] );
$this->check_get_revision_response( $data[2], $this->revision_1 );
}
/**
* @covers WP_REST_Global_Styles_Controller::get_items
*
* @ticket 58524
*/
public function test_get_items_eligible_roles() {
wp_set_current_user( self::$second_admin_id );
$config = array(
'version' => WP_Theme_JSON::LATEST_SCHEMA,
'isGlobalStylesUserThemeJSON' => true,
'styles' => array(
'color' => array(
'background' => 'whitesmoke',
),
),
'settings' => array(),
);
$updated_styles_post = array(
'ID' => self::$global_styles_id,
'post_content' => wp_json_encode( $config ),
);
wp_update_post( $updated_styles_post, true, false );
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertCount( $this->total_revisions + 1, $data, 'Check that extra revision exist' );
$this->assertEquals( self::$second_admin_id, $data[0]['author'], 'Check that second author id returns expected value.' );
}
/**
* @covers WP_REST_Global_Styles_Controller::get_items with context arg.
*
* @ticket 58524
*/
public function test_get_item_embed_context() {
wp_set_current_user( self::$admin_id );
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_param( 'context', 'embed' );
$response = rest_get_server()->dispatch( $request );
$fields = array(
'author',
'date',
'id',
'parent',
);
$data = $response->get_data();
$this->assertSameSets( $fields, array_keys( $data[0] ) );
}
/**
* @covers WP_REST_Global_Styles_Controller::get_item_schema
*
* @ticket 58524
*/
public function test_get_item_schema() {
$request = new WP_REST_Request( 'OPTIONS', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$properties = $data['schema']['properties'];
$this->assertCount( 9, $properties, 'Schema properties array has exactly 9 elements.' );
$this->assertArrayHasKey( 'id', $properties, 'Schema properties array has "id" key.' );
$this->assertArrayHasKey( 'styles', $properties, 'Schema properties array has "styles" key.' );
$this->assertArrayHasKey( 'settings', $properties, 'Schema properties array has "settings" key.' );
$this->assertArrayHasKey( 'parent', $properties, 'Schema properties array has "parent" key.' );
$this->assertArrayHasKey( 'author', $properties, 'Schema properties array has "author" key.' );
$this->assertArrayHasKey( 'date', $properties, 'Schema properties array has "date" key.' );
$this->assertArrayHasKey( 'date_gmt', $properties, 'Schema properties array has "date_gmt" key.' );
$this->assertArrayHasKey( 'modified', $properties, 'Schema properties array has "modified" key.' );
$this->assertArrayHasKey( 'modified_gmt', $properties, 'Schema properties array has "modified_gmt" key.' );
}
/**
* @covers WP_REST_Global_Styles_Controller::get_item_permissions_check
*
* @ticket 58524
*/
public function test_get_item_permissions_check() {
wp_set_current_user( self::$author_id );
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_cannot_view', $response, 403 );
}
/**
* Tests the pagination header of the first page.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_pagination_header_of_the_first_page
*
* @ticket 58524
*/
public function test_get_items_pagination_header_of_the_first_page() {
wp_set_current_user( self::$admin_id );
$rest_route = '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions';
$per_page = 2;
$total_pages = (int) ceil( $this->total_revisions / $per_page );
$page = 1; // First page.
$request = new WP_REST_Request( 'GET', $rest_route );
$request->set_query_params(
array(
'per_page' => $per_page,
'page' => $page,
)
);
$response = rest_get_server()->dispatch( $request );
$headers = $response->get_headers();
$this->assertSame( $this->total_revisions, $headers['X-WP-Total'] );
$this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
$next_link = add_query_arg(
array(
'per_page' => $per_page,
'page' => $page + 1,
),
rest_url( $rest_route )
);
$this->assertStringNotContainsString( 'rel="prev"', $headers['Link'] );
$this->assertStringContainsString( '<' . $next_link . '>; rel="next"', $headers['Link'] );
}
/**
* Tests the pagination header of the last page.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_pagination_header_of_the_last_page
*
* @ticket 58524
*/
public function test_get_items_pagination_header_of_the_last_page() {
wp_set_current_user( self::$admin_id );
$rest_route = '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions';
$per_page = 2;
$total_pages = (int) ceil( $this->total_revisions / $per_page );
$page = 2; // Last page.
$request = new WP_REST_Request( 'GET', $rest_route );
$request->set_query_params(
array(
'per_page' => $per_page,
'page' => $page,
)
);
$response = rest_get_server()->dispatch( $request );
$headers = $response->get_headers();
$this->assertSame( $this->total_revisions, $headers['X-WP-Total'] );
$this->assertSame( $total_pages, $headers['X-WP-TotalPages'] );
$prev_link = add_query_arg(
array(
'per_page' => $per_page,
'page' => $page - 1,
),
rest_url( $rest_route )
);
$this->assertStringContainsString( '<' . $prev_link . '>; rel="prev"', $headers['Link'] );
}
/**
* Tests that invalid 'per_page' query should error.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_invalid_per_page_should_error
*
* @ticket 58524
*/
public function test_get_items_invalid_per_page_should_error() {
wp_set_current_user( self::$admin_id );
$per_page = -1; // Invalid number.
$expected_error = 'rest_invalid_param';
$expected_status = 400;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_param( 'per_page', $per_page );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( $expected_error, $response, $expected_status );
}
/**
* Tests that out of bounds 'page' query should error.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_out_of_bounds_page_should_error
*
* @ticket 58524
*/
public function test_get_items_out_of_bounds_page_should_error() {
wp_set_current_user( self::$admin_id );
$per_page = 2;
$total_pages = (int) ceil( $this->total_revisions / $per_page );
$page = $total_pages + 1; // Out of bound page.
$expected_error = 'rest_revision_invalid_page_number';
$expected_status = 400;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_query_params(
array(
'per_page' => $per_page,
'page' => $page,
)
);
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( $expected_error, $response, $expected_status );
}
/**
* Tests that impossibly high 'page' query should error.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_invalid_max_pages_should_error
*
* @ticket 58524
*/
public function test_get_items_invalid_max_pages_should_error() {
wp_set_current_user( self::$admin_id );
$per_page = 2;
$page = REST_TESTS_IMPOSSIBLY_HIGH_NUMBER; // Invalid number.
$expected_error = 'rest_revision_invalid_page_number';
$expected_status = 400;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_query_params(
array(
'per_page' => $per_page,
'page' => $page,
)
);
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( $expected_error, $response, $expected_status );
}
/**
* Tests that the default query should fetch all revisions.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_default_query_should_fetch_all_revisons
*
* @ticket 58524
*/
public function test_get_items_default_query_should_fetch_all_revisons() {
wp_set_current_user( self::$admin_id );
$expected_count = $this->total_revisions;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$response = rest_get_server()->dispatch( $request );
$this->assertCount( $expected_count, $response->get_data() );
}
/**
* Tests that 'offset' query shouldn't work without 'per_page' (fallback -1).
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_offset_should_not_work_without_per_page
*
* @ticket 58524
*/
public function test_get_items_offset_should_not_work_without_per_page() {
wp_set_current_user( self::$admin_id );
$offset = 1;
$expected_count = $this->total_revisions;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_param( 'offset', $offset );
$response = rest_get_server()->dispatch( $request );
$this->assertCount( $expected_count, $response->get_data() );
}
/**
* Tests that 'offset' query should work with 'per_page'.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_offset_should_work_with_per_page
*
* @ticket 58524
*/
public function test_get_items_offset_should_work_with_per_page() {
wp_set_current_user( self::$admin_id );
$per_page = 2;
$offset = 1;
$expected_count = 2;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_query_params(
array(
'offset' => $offset,
'per_page' => $per_page,
)
);
$response = rest_get_server()->dispatch( $request );
$this->assertCount( $expected_count, $response->get_data() );
}
/**
* Tests that 'offset' query should take priority over 'page'.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_offset_should_take_priority_over_page
*
* @ticket 58524
*/
public function test_get_items_offset_should_take_priority_over_page() {
wp_set_current_user( self::$admin_id );
$per_page = 2;
$offset = 1;
$page = 1;
$expected_count = 2;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_query_params(
array(
'offset' => $offset,
'per_page' => $per_page,
'page' => $page,
)
);
$response = rest_get_server()->dispatch( $request );
$this->assertCount( $expected_count, $response->get_data() );
}
/**
* Tests that 'offset' query, as the total revisions count, should return empty data.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_total_revisions_offset_should_return_empty_data
*
* @ticket 58524
*/
public function test_get_items_total_revisions_offset_should_return_empty_data() {
wp_set_current_user( self::$admin_id );
$per_page = 2;
$offset = $this->total_revisions;
$expected_error = 'rest_revision_invalid_offset_number';
$expected_status = 400;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_query_params(
array(
'offset' => $offset,
'per_page' => $per_page,
)
);
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( $expected_error, $response, $expected_status );
}
/**
* Tests that out of bound 'offset' query should error.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_out_of_bound_offset_should_error
*
* @ticket 58524
*/
public function test_get_items_out_of_bound_offset_should_error() {
wp_set_current_user( self::$admin_id );
$per_page = 2;
$offset = $this->total_revisions + 1;
$expected_error = 'rest_revision_invalid_offset_number';
$expected_status = 400;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_query_params(
array(
'offset' => $offset,
'per_page' => $per_page,
)
);
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( $expected_error, $response, $expected_status );
}
/**
* Tests that impossible high number for 'offset' query should error.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_impossible_high_number_offset_should_error
*
* @ticket 58524
*/
public function test_get_items_impossible_high_number_offset_should_error() {
wp_set_current_user( self::$admin_id );
$per_page = 2;
$offset = REST_TESTS_IMPOSSIBLY_HIGH_NUMBER;
$expected_error = 'rest_revision_invalid_offset_number';
$expected_status = 400;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_query_params(
array(
'offset' => $offset,
'per_page' => $per_page,
)
);
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( $expected_error, $response, $expected_status );
}
/**
* Tests that invalid 'offset' query should error.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_invalid_offset_should_error
*
* @ticket 58524
*/
public function test_get_items_invalid_offset_should_error() {
wp_set_current_user( self::$admin_id );
$per_page = 2;
$offset = 'moreplease';
$expected_error = 'rest_invalid_param';
$expected_status = 400;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_query_params(
array(
'offset' => $offset,
'per_page' => $per_page,
)
);
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( $expected_error, $response, $expected_status );
}
/**
* Tests that out of bounds 'page' query should not error when offset is provided,
* because it takes precedence.
*
* Duplicate of WP_Test_REST_Revisions_Controller::test_get_items_out_of_bounds_page_should_not_error_if_offset
*
* @ticket 58524
*/
public function test_get_items_out_of_bounds_page_should_not_error_if_offset() {
wp_set_current_user( self::$admin_id );
$per_page = 2;
$total_pages = (int) ceil( $this->total_revisions / $per_page );
$page = $total_pages + 1; // Out of bound page.
$expected_count = 2;
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_query_params(
array(
'offset' => 1,
'per_page' => $per_page,
'page' => $page,
)
);
$response = rest_get_server()->dispatch( $request );
$this->assertCount( $expected_count, $response->get_data() );
}
/**
* @doesNotPerformAssertions
*/
public function test_context_param() {
// Controller does not implement test_context_param().
}
/**
* @doesNotPerformAssertions
*/
public function test_get_item() {
// Controller does not implement get_item().
}
/**
* @doesNotPerformAssertions
*/
public function test_create_item() {
// Controller does not implement create_item().
}
/**
* @doesNotPerformAssertions
*/
public function test_delete_item() {
// Controller does not implement delete_item().
}
/**
* @doesNotPerformAssertions
*/
public function test_prepare_item() {
// Controller does not implement prepare_item().
}
/**
* @doesNotPerformAssertions
*/
public function test_update_item() {
// Controller does not implement update_item().
}
}

1
tests/phpunit/tests/rest-api/rest-schema-setup.php
View File

@ -134,6 +134,7 @@ class WP_Test_REST_Schema_Initialization extends WP_Test_REST_TestCase {
'/wp/v2/comments',
'/wp/v2/comments/(?P<id>[\\d]+)',
'/wp/v2/global-styles/(?P<id>[\/\w-]+)',
'/wp/v2/global-styles/(?P<parent>[\d]+)/revisions',
'/wp/v2/global-styles/themes/(?P<stylesheet>[\/\s%\w\.\(\)\[\]\@_\-]+)/variations',
'/wp/v2/global-styles/themes/(?P<stylesheet>[^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',
'/wp/v2/search',

50
tests/qunit/fixtures/wp-api-generated.js
View File

@ -9618,6 +9618,56 @@ mockedApiResponse.Schema = {
}
]
},
"/wp/v2/global-styles/(?P<parent>[\\d]+)/revisions": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"minimum": 1,
"maximum": 100,
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
}
}
}
]
},
"/wp/v2/global-styles/themes/(?P<stylesheet>[\\/\\s%\\w\\.\\(\\)\\[\\]\\@_\\-]+)/variations": {
"namespace": "wp/v2",
"methods": [