Privacy: Ensure "Export Personal Data" does not generate invalid JSON.

Previously, when exporting personal data, if the JSON encoding of the data failed, the invalid JSON was still written to `export.json`.  This change captures the JSON encoding failure and adds a notice to the UI.  

Props hellofromTonya, jrf, SergeyBiryukov.
Fixes #52892.

git-svn-id: https://develop.svn.wordpress.org/trunk@50713 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
David Baumwald 2021-04-14 21:26:58 +00:00
parent d60ad57e47
commit f7799b9455
2 changed files with 52 additions and 0 deletions

View File

@ -413,6 +413,16 @@ function wp_privacy_generate_personal_data_export_file( $request_id ) {
// Convert the groups to JSON format.
$groups_json = wp_json_encode( $groups );
if ( false === $groups_json ) {
$error_message = sprintf(
/* translators: %s: Error message. */
__( 'Unable to encode the personal data for export. Error: %s' ),
json_last_error_msg()
);
wp_send_json_error( $error_message );
}
/*
* Handle the JSON export.
*/

View File

@ -631,4 +631,46 @@ class Tests_Privacy_WpPrivacyGeneratePersonalDataExportFile extends WP_UnitTestC
),
);
}
/**
* Test should generate JSON error when JSON encoding fails.
*
* @ticket 52892
*/
public function test_should_generate_json_error_when_json_encoding_fails() {
add_filter( 'get_post_metadata', array( $this, 'filter_export_data_grouped_metadata' ), 10, 3 );
// Validate JSON encoding fails and returns `false`.
$metadata = get_post_meta( self::$export_request_id, '_export_data_grouped', true );
$this->assertFalse( wp_json_encode( $metadata ) );
$this->expectException( 'WPDieException' );
$this->expectOutputString( '{"success":false,"data":"Unable to encode the personal data for export. Error: Type is not supported"}' );
wp_privacy_generate_personal_data_export_file( self::$export_request_id );
}
public function filter_export_data_grouped_metadata( $value, $object_id, $meta_key ) {
if ( $object_id !== self::$export_request_id ) {
return $value;
}
if ( '_export_data_grouped' !== $meta_key ) {
return $value;
}
$file = fopen( __FILE__, 'r' );
$value = array(
'user' => array(
'group_label' => 'User',
'group_description' => 'User’s profile data.',
'items' => array(),
'resource' => $file,
),
);
fclose( $file );
return array( $value );
}
}