[wp-trac] [WordPress Trac] #51351: Improve clarity of privacy error strings

[WordPress Trac]

#51351: Improve clarity of privacy error strings
-------------------------------------+-------------------------------------
 Reporter:  garrett-eclipse          |       Owner:  garrett-eclipse
     Type:  enhancement              |      Status:  assigned
 Priority:  normal                   |   Milestone:  Awaiting Review
Component:  Privacy                  |     Version:  4.9.6
 Severity:  normal                   |  Resolution:
 Keywords:  has-patch has-unit-      |     Focuses:  administration, ui-
  tests needs-testing                |  copy
-------------------------------------+-------------------------------------
Description changed by garrett-eclipse:

Old description:

> Branching off [https://core.trac.wordpress.org/ticket/46536#comment:4
> comment#4] of #46536 by @birgire this ticket strives to improve the error
> strings for privacy requests so they are more easily distinguished from
> other system actions/requests/exports/etc within logs.
>
> An initial overview of the update (new words are **bold**);
> {{{
> 'Sorry, you are not allowed to manage privacy on this site.' => 'Sorry,
> you are not allowed to manage **privacy** options on this site.'
> 'Sorry, you are not allowed to erase data on this site.' => 'Sorry, you
> are not allowed to erase **personal** data on this site.'
> 'Invalid request.' => 'Invalid **user privacy** request.'
> 'Invalid action.' => 'Invalid **user privacy** action.'
> 'Unable to initiate confirmation request.' => 'Unable to initiate **user
> privacy** confirmation request.'
> 'Unable to generate export file. ZipArchive not available.' => 'Unable to
> generate **user privacy** export file. ZipArchive not available.'
> 'Unable to open export file (archive) for writing.' => 'Unable to open
> **user privacy** export file (archive) for writing.'
> 'Invalid request ID when generating export file.' => 'Invalid request ID
> when generating **user privacy** export file.'
> 'Invalid email address when generating user privacy export file.' =>
> 'Invalid email address when generating **user privacy** export file.'
> 'Unable to create export folder.' => 'Unable to create **user privacy**
> export folder.'
> 'Unable to protect export folder from browsing.' => 'Unable to protect
> **user privacy** export folder from browsing.'
> 'Unable to open export file (JSON report) for writing.' => 'Unable to
> open **user privacy** export file (JSON report) for writing.'
> 'Unable to open export file (HTML report) for writing.' => 'Unable to
> open **user privacy** export file (HTML report) for writing.'
> 'Unable to add data to JSON file.' => 'Unable to add data to **user
> privacy export file (JSON format)**.'
> 'Unable to add data to HTML file.' => 'Unable to add data to user privacy
> export file (HTML format).'
> 'Unable to open export file (archive) for writing.' => 'Unable to open
> **user privacy** export file (archive) for writing.'
> 'Invalid request ID when merging exporter data.' => 'Invalid request ID
> when merging user privacy exporter data.'
> 'Invalid request ID when processing eraser data.' => 'Invalid request ID
> when processing **user privacy** eraser data.'
> 'An incomplete request for this email address already exists.' => 'An
> incomplete **user privacy** request for this email address already
> exists.'
> 'Invalid user request.' => 'Invalid user **privacy** request.' Note: This
> should merge strings with the one above.
> 'This link has expired.' => 'This **user privacy request** has expired.'
> 'Missing confirm key.' => '**This user privacy request is missing the
> confirmation key.**'
> 'Invalid key.' => 'Invalid **user privacy request**.' Note: Merging
> string as this error doesn't need to be unique it just indicates the
> request object is missing required data.
> 'Invalid action.' => 'Invalid **user privacy request**.' Note: Merging
> string as missing the request timestamp indicates the request object is
> invalid.
> 'Invalid key.' => 'This user privacy request confirmation key is
> invalid.' Note: This is unique from the other Invalid key as the previous
> indicated the request is broken while this one indicates the confirmation
> key is invalid.
> 'The confirmation email has expired.' => 'This user privacy request
> confirmation key has expired.'
> }}}
>
> Primarily this adds 'user privacy' to the strings for clarity from other
> system functions when these strings are found in logs.
>
> The above original strings were all checked for uniqueness against non-
> privacy uses and no correlation was found, confirming they weren't used
> outside of the privacy context.
>
> Note: By making the privacy request error strings more specific I don't
> think we really need to apply 'context' as we wouldn't be differentiating
> them in a way their verbiage isn't already doing.
>
> Feedback appreciated.

New description:

 Branching off [https://core.trac.wordpress.org/ticket/46536#comment:4
 comment#4] of #46536 by @birgire this ticket strives to improve the error
 strings for privacy requests so they are more easily distinguished from
 other system actions/requests/exports/etc within logs.

 An initial overview of the update (new words are **bold**);
 > 'Sorry, you are not allowed to manage privacy on this site.' => 'Sorry,
 you are not allowed to manage **privacy** options on this site.'
 > 'Sorry, you are not allowed to erase data on this site.' => 'Sorry, you
 are not allowed to erase **personal** data on this site.'
 > 'Invalid request.' => 'Invalid **user privacy** request.'
 > 'Invalid action.' => 'Invalid **user privacy** action.'
 > 'Unable to initiate confirmation request.' => 'Unable to initiate **user
 privacy** confirmation request.'
 > 'Unable to generate export file. ZipArchive not available.' => 'Unable
 to generate **user privacy** export file. ZipArchive not available.'
 > 'Unable to open export file (archive) for writing.' => 'Unable to open
 **user privacy** export file (archive) for writing.'
 > 'Invalid request ID when generating export file.' => 'Invalid request ID
 when generating **user privacy** export file.'
 > 'Invalid email address when generating user privacy export file.' =>
 'Invalid email address when generating **user privacy** export file.'
 > 'Unable to create export folder.' => 'Unable to create **user privacy**
 export folder.'
 > 'Unable to protect export folder from browsing.' => 'Unable to protect
 **user privacy** export folder from browsing.'
 > 'Unable to open export file (JSON report) for writing.' => 'Unable to
 open **user privacy** export file (JSON report) for writing.'
 > 'Unable to open export file (HTML report) for writing.' => 'Unable to
 open **user privacy** export file (HTML report) for writing.'
 > 'Unable to add data to JSON file.' => 'Unable to add data to **user
 privacy export file (JSON format)**.'
 > 'Unable to add data to HTML file.' => 'Unable to add data to user
 privacy export file (HTML format).'
 > 'Unable to open export file (archive) for writing.' => 'Unable to open
 **user privacy** export file (archive) for writing.'
 > 'Invalid request ID when merging exporter data.' => 'Invalid request ID
 when merging user privacy exporter data.'
 > 'Invalid request ID when processing eraser data.' => 'Invalid request ID
 when processing **user privacy** eraser data.'
 > 'An incomplete request for this email address already exists.' => 'An
 incomplete **user privacy** request for this email address already
 exists.'
 > 'Invalid user request.' => 'Invalid user **privacy** request.' Note:
 This should merge strings with the one above.
 > 'This link has expired.' => 'This **user privacy request** has expired.'
 > 'Missing confirm key.' => '**This user privacy request is missing the
 confirmation key.**'
 > 'Invalid key.' => 'Invalid **user privacy request**.' Note: Merging
 string as this error doesn't need to be unique it just indicates the
 request object is missing required data.
 > 'Invalid action.' => 'Invalid **user privacy request**.' Note: Merging
 string as missing the request timestamp indicates the request object is
 invalid.
 > 'Invalid key.' => 'This user privacy request confirmation key is
 invalid.' Note: This is unique from the other Invalid key as the previous
 indicated the request is broken while this one indicates the confirmation
 key is invalid.
 > 'The confirmation email has expired.' => 'This user privacy request
 confirmation key has expired.'

 Primarily this adds 'user privacy' to the strings for clarity from other
 system functions when these strings are found in logs.

 The above original strings were all checked for uniqueness against non-
 privacy uses and no correlation was found, confirming they weren't used
 outside of the privacy context.

 Note: By making the privacy request error strings more specific I don't
 think we really need to apply 'context' as we wouldn't be differentiating
 them in a way their verbiage isn't already doing.

 Feedback appreciated.

--

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/51351#comment:1>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform