WordPress.org

Make WordPress Core

Opened 10 months ago

Closed 2 months ago

#45491 closed feature request (fixed)

Personal Data Report - item descriptions

Reported by: Venutius Owned by: garrett-eclipse
Milestone: 5.3 Priority: normal
Severity: normal Version: 4.9.6
Component: Privacy Keywords: has-patch needs-testing has-unit-tests
Focuses: administration Cc:
PR Number:

Description

Regarding the personal data report, I'm finding it a bit impersonal and uninformative as to what each section means to the end user, It would be good to have an option to add a description for each section.

As I see it, it would be another option with included suggested text from the developer.

Attachments (5)

45491.diff (4.0 KB) - added by garrett-eclipse 6 months ago.
Introduces Group Descriptions to the Exporters and Export Email
index 7.html (2.2 KB) - added by garrett-eclipse 6 months ago.
Sample export w/ Descriptions
45491.2.diff (4.0 KB) - added by garrett-eclipse 6 months ago.
Add missing period from the About description
Screen Shot 2019-04-06 at 4.34.56 AM.png (321.4 KB) - added by garrett-eclipse 6 months ago.
Screen illustrating group descriptions on data export
45491.3.diff (4.8 KB) - added by garrett-eclipse 6 months ago.
Updated w/ fixed tests and added array_key_exists checks

Download all attachments as: .zip

Change History (13)

#1 @lonelyvegan
10 months ago

  • Milestone changed from Awaiting Review to Future Release

#2 @garrett-eclipse
9 months ago

  • Milestone Future Release deleted
  • Resolution set to duplicate
  • Status changed from new to closed

Thanks @Venutius for opening this.

I followed you creating #45492 which expands on your concept and provides a path forward with a proposed filter on wp_privacy_generate_personal_data_export_group_html which would enable developers to included suggested text among other things. As such I'm closing this in favour of #45492 as I've taken ownership of it there and will be working on the functionality through that ticket. Feel free to watch that ticket and help with review/testing.

Cheers

@garrett-eclipse
6 months ago

Introduces Group Descriptions to the Exporters and Export Email

@garrett-eclipse
6 months ago

Sample export w/ Descriptions

@garrett-eclipse
6 months ago

Add missing period from the About description

@garrett-eclipse
6 months ago

Screen illustrating group descriptions on data export

#3 @garrett-eclipse
6 months ago

  • Focuses administration added
  • Keywords has-patch needs-testing needs-design-feedback added
  • Milestone set to 5.3
  • Resolution duplicate deleted
  • Status changed from closed to reopened
  • Version changed from 5.0 to 4.9.6

Hi @Venutius after feedback from @xkon on #45492 indicating that direction can lead to bad parties scrubbing data from the exports I've moved back to simply introducing the descriptions to the exporter groups.
Comment Reference - https://core.trac.wordpress.org/ticket/45492#comment:12

Attached 45491.diff to introduce support for exporter descriptions as well as provided default descriptions for core exporters as follows;
About - Overview of export report.
User - User profile data.
Comments - Users comment data.
Media - Users media data.
*Adding needs-design-feedback to get thoughts on the verbiage.

Attached example export of default data - https://core.trac.wordpress.org/attachment/ticket/45491/index%207.html

On potential improvement on this initial patch would be to provide ways to filter to label and description but it should be noted the rest of the data should be unfiltered and preserved as is.

#4 @garrett-eclipse
6 months ago

  • Owner set to garrett-eclipse
  • Status changed from reopened to assigned

@garrett-eclipse
6 months ago

Updated w/ fixed tests and added array_key_exists checks

#5 @garrett-eclipse
6 months ago

  • Keywords has-unit-tests added

I uploaded 45491.3.diff to introduce more checks as most plugins won't have group_description available. As well fixed unit tests as I found the following errors while running them;

There were 4 errors:

1) Tests_Privacy_WpPrivacyProcessPersonalDataExportPage::test_raw_data_post_meta with data set #0 (true)
Undefined index: group_description

/Users/garretthyder/WordPress/45492-descriptions-exporter/build/wp-admin/includes/file.php:2519
/Users/garretthyder/WordPress/45492-descriptions-exporter/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php:428

2) Tests_Privacy_WpPrivacyProcessPersonalDataExportPage::test_raw_data_post_meta with data set #1 (false)
Undefined index: group_description

/Users/garretthyder/WordPress/45492-descriptions-exporter/build/wp-admin/includes/file.php:2519
/Users/garretthyder/WordPress/45492-descriptions-exporter/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php:428

3) Tests_Privacy_WpPrivacyProcessPersonalDataExportPage::test_add_post_meta_with_groups_data_only_available_when_export_file_generated with data set #0 (true)
Undefined index: group_description

/Users/garretthyder/WordPress/45492-descriptions-exporter/build/wp-admin/includes/file.php:2519
/Users/garretthyder/WordPress/45492-descriptions-exporter/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php:467

4) Tests_Privacy_WpPrivacyProcessPersonalDataExportPage::test_add_post_meta_with_groups_data_only_available_when_export_file_generated with data set #1 (false)
Undefined index: group_description

/Users/garretthyder/WordPress/45492-descriptions-exporter/build/wp-admin/includes/file.php:2519
/Users/garretthyder/WordPress/45492-descriptions-exporter/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php:467

--

This ticket was mentioned in Slack in #core-privacy by garrett-eclipse. View the logs.


3 months ago

#7 @karmatosed
3 months ago

  • Keywords needs-design-feedback removed

Thanks for asking for design feedback, based on the screenshot here: https://core.trac.wordpress.org/attachment/ticket/45491/Screen%20Shot%202019-04-06%20at%204.34.56%20AM.png, I would say that is good. I think there are some visual adjustments could be done to report but as only adding the descriptions is in this tickets focus, let's keep to that.

#8 @SergeyBiryukov
2 months ago

  • Resolution set to fixed
  • Status changed from assigned to closed

In 45825:

Privacy: Add descriptions for sections in a personal data export file.

Props garrett-eclipse, Venutius, karmatosed.
Fixes #45491.

Note: See TracTickets for help on using tickets.