Changeset 50713

Timestamp:

04/14/2021 09:26:58 PM (4 years ago)

Author:

davidbaumwald

Message:

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.

Location:

trunk

Files:

• src/wp-admin/includes/privacy-tools.php (modified) (1 diff)
• tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportFile.php (modified) (1 diff)

trunk/src/wp-admin/includes/privacy-tools.php

@@ -414 +414 @@
     $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.

trunk/tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportFile.php

@@ -632 +632 @@
         );
     }
+
+    /**
+     * 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 );
+    }
 }