Ticket #44500: 44500.2.diff

src/wp-admin/includes/user.php

@@ -771 +771 @@
         $request_ids = $requests_query->posts;
 
         foreach ( $request_ids as $request_id ) {
-                wp_update_post( array(
-                        'ID'            => $request_id,
-                        'post_status'   => 'request-failed',
-                        'post_password' => '',
-                ) );
+                wp_mark_user_request_failed( $request_id );
         }
 }
 
@@ -1132 +1128 @@
          * Get an associative array ( id => link ) with the list of views available on this table.
          *
          * @since 4.9.6
-         *
+         *he specified post is not a user_requ
          * @return array Associative array of views in the format of $view_name => $view_markup.
          */
         protected function get_views() {

src/wp-includes/user.php

@@ -3491 +3491 @@
 /**
  * Validate a user request by comparing the key with the request's key.
  *
+ * If determined that the request is expired, it will be transitioned to the `request-failed` status.
+ *
  * @since 4.9.6
  *
  * @param string $request_id ID of the request being confirmed.
@@ -3508 +3510 @@
         }
 
         if ( ! in_array( $request->status, array( 'request-pending', 'request-failed' ), true ) ) {
-                return __( 'This link has expired.' );
+                return new WP_Error( 'expired_link', __( 'This link has expired.' ) );
         }
 
         if ( empty( $key ) ) {
@@ -3546 +3548 @@
         }
 
         if ( ! $expiration_time || time() > $expiration_time ) {
+                wp_mark_user_request_failed( $request_id );
                 return new WP_Error( 'expired_key', __( 'The confirmation email has expired.' ) );
         }
 
@@ -3572 +3575 @@
 }
 
 /**
+ * Marks a user_request post as failed.
+ *
+ * @since 4.9.9
+ *
+ * @param int $request_id User request ID.
+ * @return int|WP_Error Post ID when updated successfully, WP_Error on failure.
+ */
+function wp_mark_user_request_failed( $request_id ) {
+        $post = get_post( $request_id );
+
+        if ( ! $post ) {
+                return new WP_Error( 'invalid_request_id',  __( 'Invalid request ID.' ) );
+        } elseif ('user_request' !== $post->post_type ) {
+                return new WP_Error( 'invalid_post_type', __( 'The specified post is not a user_request post.' ) );
+        }
+
+        if ( 'request-completed' === $post->post_status ) {
+                return new WP_Error( 'already_completed', __( 'The request has already been completed.' ) );
+        }
+
+        return wp_update_post(
+                array(
+                        'ID'            => $request_id,
+                        'post_status'   => 'request-failed',
+                        'post_password' => '',
+                ),
+                true
+        );
+}
+
+/**
  * WP_User_Request class.
  *
  * Represents user request data loaded from a WP_Post object.

tests/phpunit/tests/privacy/wpPersonalDataCleanupRequests.php

@@ +1 @@
+<?php
+/**
+ * Test the `_wp_personal_data_cleanup_requests()` function.
+ *
+ * @package WordPress
+ * @subpackage UnitTests
+ * @since 4.9.9
+ */
+
+/**
+ * Tests_WpPersonalDataCleanupRequests class.
+ *
+ * @group privacy
+ * @covers wp_mark_user_request_failed
+ *
+ * @since 4.9.9
+ */
+class Tests_WpPersonalDataCleanupRequests extends WP_UnitTestCase {
+
+        /**
+         * Utility method for creating user requests.
+         *
+         * @since 4.9.9
+         *
+         * @param int   $number Number of posts to create. Default is 4.
+         * @param array $args   Post arguments. Default is none. @see wp_insert_post().
+         */
+        public function _create_requests( $number = 4, $args = array() ) {
+                $defaults = array(
+                        'post_type'   => 'user_request',
+                        'post_name'   => 'export_personal_data',
+                        'post_status' => 'request-pending',
+                );
+                $args     = wp_parse_args( $args, $defaults );
+                $this->factory->post->create_many( $number, $args );
+        }
+
+        /**
+         * Utility method for getting a list of request IDs with a given status.
+         *
+         * @param string $status Request status to query. Default is pending.
+         * @return array List of request post IDs.
+         */
+        public function _get_request_ids( $status = 'request-pending' ) {
+                $failed_requests = new WP_Query(
+                        array(
+                                'post_type'      => 'user_request',
+                                'post_status'    => $status,
+                                'fields'         => 'ids',
+                                'posts_per_page' => 100,
+                        )
+                );
+
+                return $failed_requests->posts;
+        }
+
+        /**
+         * The function should not mark unexpired requests as failed.
+         *
+         * @since 4.9.9
+         */
+        public function test_function_does_not_move_pending_requests_with_time_remaining() {
+                $this->_create_requests();
+
+                _wp_personal_data_cleanup_requests();
+
+                $this->assertSame( 4, count( $this->_get_request_ids() ) );
+                $this->assertSame( 0, count( $this->_get_request_ids( 'request-failed' ) ) );
+        }
+
+        /**
+         * The function should mark all unexpired requests as failed.
+         *
+         * @since 4.9.9
+         */
+        public function test_function_moves_all_expired_pending_requests() {
+                $this->_create_requests( 4, array(
+                        'post_date' => date( 'Y-m-d H:i:s', strtotime( '4 days ago' ) ),
+                ) );
+
+                _wp_personal_data_cleanup_requests();
+
+                $this->assertSame( 0, count( $this->_get_request_ids() ) );
+                $this->assertSame( 4, count( $this->_get_request_ids( 'request-failed' ) ) );
+        }
+
+        /**
+         * The function should only mark expired requests as failed when there is a mix, even if requests with other
+         * statuses would be considered expired.
+         *
+         * @since 4.9.9
+         */
+        public function test_function_udpates_correct_requests_with_mixed_status_requests() {
+                $this->_create_requests( 2 );
+                $this->_create_requests( 2, array(
+                        'post_date'   => date( 'Y-m-d H:i:s', strtotime( '5 days ago' ) ),
+                        'post_status' => 'request-completed',
+                ) );
+                $this->_create_requests( 2, array(
+                        'post_date' => date( 'Y-m-d H:i:s', strtotime( '4 days ago' ) ),
+                ) );
+
+                _wp_personal_data_cleanup_requests();
+
+                $this->assertSame( 2, count( $this->_get_request_ids() ) );
+                $this->assertSame( 2, count( $this->_get_request_ids( 'request-completed' ) ) );
+                $this->assertSame( 2, count( $this->_get_request_ids( 'request-failed' ) ) );
+        }
+
+        /**
+         * The function should mark only expired requests as failed, even when there are export and erase requests mixed.
+         *
+         * @since 4.9.9
+         */
+        public function test_function_updates_correct_requests_with_mixed_export_erase() {
+                $this->_create_requests( 2 );
+                $this->_create_requests( 2, array(
+                        'post_name' => 'remove_personal_data',
+                ) );
+                $this->_create_requests( 2, array(
+                        'post_date' => date( 'Y-m-d H:i:s', strtotime( '2 days ago' ) ),
+                ) );
+                $this->_create_requests( 2, array(
+                        'post_name' => 'remove_personal_data',
+                        'post_date' => date( 'Y-m-d H:i:s', strtotime( '2 days ago' ) ),
+                ) );
+
+                add_filter( 'user_request_key_expiration', array( $this, 'filter_request_expiration_time' ) );
+                _wp_personal_data_cleanup_requests();
+
+                $this->assertSame( 4, count( $this->_get_request_ids() ) );
+                $this->assertSame( 4, count( $this->_get_request_ids( 'request-failed' ) ) );
+        }
+
+        /**
+         * The function should mark only expired requests as failed when the expiration time is filtered.
+         *
+         * @since 4.9.9
+         */
+        public function test_function_updates_correct_requests_with_filtered_expiration() {
+                $this->_create_requests( 2 );
+                $this->_create_requests( 2, array(
+                        'post_status' => 'request-completed',
+                        'post_date'   => date( 'Y-m-d H:i:s', strtotime( '2 days ago' ) ),
+                ) );
+                $this->_create_requests( 2, array(
+                        'post_date' => date( 'Y-m-d H:i:s', strtotime( '2 days ago' ) ),
+                ) );
+
+                add_filter( 'user_request_key_expiration', array( $this, 'filter_request_expiration_time' ) );
+                _wp_personal_data_cleanup_requests();
+
+                $this->assertSame( 2, count( $this->_get_request_ids() ) );
+                $this->assertSame( 2, count( $this->_get_request_ids( 'request-completed' ) ) );
+                $this->assertSame( 2, count( $this->_get_request_ids( 'request-failed' ) ) );
+        }
+
+        /**
+         * Filter the privacy data request expiration time.
+         *
+         * @since 4.9.9
+         *
+         * @return int Expiration time in seconds
+         */
+        public function filter_request_expiration_time() {
+                return DAY_IN_SECONDS * 1;
+        }
+}

tests/phpunit/tests/user/wpMarkUserRequestFailed.php

@@ +1 @@
+<?php
+/**
+ * Test the `wp_mark_user_request_failed()` function.
+ *
+ * @package WordPress
+ * @subpackage UnitTests
+ * @since 4.9.9
+ */
+
+/**
+ * Tests_WpMarkUserRequestFailed class.
+ *
+ * @group privacy
+ * @ticket 44500
+
+ * @covers wp_mark_user_request_failed
+ *
+ * @since 4.9.9
+ */
+class Tests_WpMarkUserRequestFailed extends WP_UnitTestCase {
+        /**
+         * Current test request ID.
+         *
+         * @since 4.9.9
+         *
+         * @var int $request_id
+         */
+        protected static $request_id;
+
+        /**
+         * Create fixtures.
+         *
+         * @since 4.9.9
+         */
+        public function setUp() {
+                parent::setUp();
+
+                self::$request_id = wp_create_user_request( 'requester@example.com', 'export_personal_data' );
+        }
+
+        /**
+         * The function should return an error when an invalid request post ID is passed.
+         *
+         * @since 4.9.9
+         */
+        public function test_function_throws_error_when_invalid_request_id() {
+                $actual = wp_mark_user_request_failed( null );
+
+                $this->assertWPError( $actual );
+                $this->assertSame( 'Invalid request ID.', $actual->get_error_message() );
+        }
+
+        /**
+         * The function should return an error when an invalid request post ID is passed.
+         *
+         * @since 4.9.9
+         */
+        public function test_function_throws_error_when_invalid_request_type() {
+                $non_request_post_id = $this->factory->post->create(
+                        array(
+                                'post_type' => 'post',
+                        )
+                );
+
+                $actual = wp_mark_user_request_failed( $non_request_post_id );
+
+                $this->assertWPError( $actual );
+                $this->assertSame( 'The specified post is not a user_request post.', $actual->get_error_message() );
+        }
+
+        /**
+         * The function should return an error when the request has already been completed.
+         *
+         * @since 4.9.9
+         */
+        public function test_function_throws_error_when_request_already_completed() {
+                wp_update_post(
+                        array(
+                                'ID'          => self::$request_id,
+                                'post_status' => 'request-completed',
+                        )
+                );
+
+                $actual = wp_mark_user_request_failed( self::$request_id );
+
+                $this->assertWPError( $actual );
+                $this->assertSame( 'The request has already been completed.', $actual->get_error_message() );
+        }
+
+        /**
+         * The function should return an error when an invalid request post ID is passed.
+         *
+         * @since 4.9.9
+         */
+        public function test_function_succeeds() {
+                $actual = wp_mark_user_request_failed( self::$request_id );
+
+                $this->assertSame( self::$request_id, $actual );
+                $this->assertSame( 'request-failed', get_post_status( self::$request_id ) );
+        }
+}