Skip to content

47676: Add support for If-Unmodified-Since header to make a conditional request when updating posts via REST API (for offline and collaborative editing) #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
westonruter wants to merge 2 commits into
base: master
Choose a base branch
from
Open

47676: Add support for If-Unmodified-Since header to make a conditional request when updating posts via REST API (for offline and collaborative editing) #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fda160
Add support for If-Unmodified-Since request header when updating post…
westonruter Jul 11, 2019
5feaae0
Fix phpcs issues
westonruter Jul 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -662,6 +662,12 @@ public function update_item_permissions_check( $request ) {
return new WP_Error( 'rest_cannot_assign_term', __( 'Sorry, you are not allowed to assign the provided terms.' ), array( 'status' => rest_authorization_required_code() ) );
}

// Allow a client to guard against overwriting changes to a post by sending the If-Unmodified-Since request header.
$if_unmodified_since = $request->get_header( 'If-Unmodified-Since' );
if ( $if_unmodified_since && mysql2date( 'U', $post->post_modified_gmt ) > strtotime( $if_unmodified_since ) ) {
return new WP_Error( 'rest_precondition_failed', __( 'Sorry, the post has been modified on the server since you started editing it. Conflict resolution is required.' ), array( 'status' => 412 ) );
}

return true;
}

Expand Down
66 changes: 66 additions & 0 deletions tests/phpunit/tests/rest-api/rest-posts-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3244,6 +3244,72 @@ public function test_update_item_with_same_template_that_no_longer_exists() {
$this->assertEquals( 'post-my-invalid-template.php', $data['template'] );
}

/**
* Format MySQL date string as RFC.
*
* @param string $date Date string (YYYY-MM-DD HH:MM:SS).
* @param int $seconds_offset Number of seconds to add/subtract from the date.
* @return string Date formatted as RFC.
*/
protected function format_gmt_date_as_rfc( $date_str, $seconds_offset = 0 ) {
$timestamp = mysql2date( 'U', $date_str );
$timestamp += $seconds_offset;
return str_replace( '+0000', 'GMT', gmdate( 'r', $timestamp ) );
}

/**
* Test If-Unmodified-Since request header when updating posts.
*
* @covers WP_REST_Posts_Controller::update_item_permissions_check()
* @ticket 47676
*/
public function test_update_item_with_if_unmodified_since_precondition() {
wp_set_current_user( self::$editor_id );

// Test updating post with If-Unmodified-Since header matching the post_modified_gmt.
$request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
$request->add_header( 'content-type', 'application/json' );
$title1 = 'Same as last modified';
$request->set_body( wp_json_encode( $this->set_post_data( array( 'title' => $title1 ) ) ) );
$request->set_header(
'If-Unmodified-Since',
$this->format_gmt_date_as_rfc( get_post( self::$post_id )->post_modified_gmt )
);
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$new_data = $response->get_data();
$this->assertSame( $title1, $new_data['title']['raw'] );
$this->assertSame( $title1, get_post( self::$post_id )->post_title );

// Test updating post with If-Unmodified-Since header being in the future of post_modified_gmt.
$request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
$request->add_header( 'content-type', 'application/json' );
$title2 = '1 second after last modified';
$request->set_body( wp_json_encode( $this->set_post_data( array( 'title' => $title2 ) ) ) );
$request->set_header(
'If-Unmodified-Since',
$this->format_gmt_date_as_rfc( get_post( self::$post_id )->post_modified_gmt, 1 )
);
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$new_data = $response->get_data();
$this->assertSame( $title2, $new_data['title']['raw'] );
$this->assertSame( $title2, get_post( self::$post_id )->post_title );

// Test updating post with If-Unmodified-Since header being in the past of post_modified_gmt, thus failing the precondition.
$request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
$request->add_header( 'content-type', 'application/json' );
$title3 = '1 second before last modified';
$request->set_body( wp_json_encode( $this->set_post_data( array( 'title' => $title3 ) ) ) );
$request->set_header(
'If-Unmodified-Since',
$this->format_gmt_date_as_rfc( get_post( self::$post_id )->post_modified_gmt, -1 )
);
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 412, $response->get_status() );
$this->assertSame( $title2, get_post( self::$post_id )->post_title, 'Expected third title to not update due to failed precondition.' );
}

public function verify_post_roundtrip( $input = array(), $expected_output = array() ) {
// Create the post
$request = new WP_REST_Request( 'POST', '/wp/v2/posts' );
Expand Down