Refactor storage of validation errors to use taxonomy terms #1093

westonruter · 2018-04-21T05:46:00Z

This will include the plumbing to be able to achieve dynamically allowing AMP responses based on validation status (#1087). It should include the ability to acknowledge a certain validation error as being ignored (#1003, #1063).

Fixes #1003.
Fixes #1087.

westonruter · 2018-04-21T19:38:35Z

Current view of the new validation errors, with bulk actions for acknowledge/ignore and inline actions to do the same:

The URLs column indicates the number of URLs that have the error, which links to a new “Invalid Pages” screen (formerly Validation Status) with the URLs listed:

westonruter · 2018-04-21T21:41:28Z

There is also a new admin menu item for validation errors which is separate from the Invalid Pages screen:

westonruter · 2018-04-22T06:21:52Z

There is now filtering of the validation errors by their status (new, acknowledged, or ignored):

The admin menu item for the Validation Errors also now has a “moderation count” for the number of new validation errors that are present (which haven't been acknowledged or ignored yet):

westonruter · 2018-04-23T04:23:31Z

The “At a Glance” widget now shows the number of URLs that contain any new errors (which haven't yet been acknowledged or ignored):

Likewise, the number appearing with the “Invalid Pages” admin menu item also is now the number of invalid URLs which contain at least one new validation error.

You can also now filter Invalid Pages (URLs) by those which contain at least one new, acknowledged, or ignored error:

And lastly, when listing out the validation errors for a given invalid URL it will now show whether a given error has been acknowledged or ignored, or if it is new. If it is new then the error details are initially expanded. Otherwise, they are initially collapsed:

Next step here is to allow a user to switch the status of a given validation error inline when looking at the list of validation errors for a given invalid URL.

ThierryA · 2018-04-23T08:31:17Z

This is awesome @westonruter, such a great step forward! First round feedback:

It would be good to have a way to go back to the "blocking status". So for example a user might mark an issue as "Acknowledged" or "Ignored" but later realize there is still an issue in which case they might revert the status. Right now that status is called "New" but the naming could change.
It would be good to have a way to preview a page with validation error in AMP mode which would help to debug the issues reported.
What is the difference between "Acknowledged" and "Ignored" from a functional perspective?
4b34bdc breaks bulk actions, not only preventing the users from bulk deleting but also from doing any other bulk actions when validation errors still have associated invalid URLs.

westonruter · 2018-04-23T13:59:21Z

@ThierryA

It would be good to have a way to go back to the "blocking status". So for example a user might mark an issue as "Acknowledged" or "Ignored" but later realize there is still an issue in which case they might revert the status. Right now that status is called "New" but the naming could change.

What is the difference between "Acknowledged" and "Ignored" from a functional perspective?

Actually, “acknowledge” has the same effect as “new”: both are blockers. The difference is that “new” is like unread. The idea is that maybe a user would like to default the behavior of new validation errors to be ignored by default instead of acknowledged by default. I tried to initially explain what acknowledging means in aria-label attributes:

Acknowledge: Acknowledging an error marks it as read. AMP validation errors prevent a URL from being served as AMP.
Ignore: Ignoring an error prevents it from blocking a URL from being served as AMP.

I'm not totally sold on the naming of “acknowledge” and “ignore” but I couldn't think of anything better.

It would be good to have a way to preview a page with validation error in AMP mode which would help to debug the issues reported.

Agreed. I've got this jotted down as a todo item.

westonruter · 2018-04-23T14:02:31Z

4b34bdc breaks bulk actions, not only preventing the users from bulk deleting but also from doing any other bulk actions when validation errors still have associated invalid URLs.

You're right. Unfortunately WP_Terms_List_Table::column_cb() uses delete_term for whether to show the checkbox. Need to figure out an alternative.

Update: Fixed in ac8fd64 (via workaround).

westonruter · 2018-04-24T00:47:06Z

Validation errors are now sorted by creation date, with default being in descending order, with the creation date column being sortable in ascending order by clicking the header:

Validation errors are also sortable by frequency (the number of URLs that have the error occurring):

westonruter · 2018-04-24T05:37:00Z

Now see the error status at a glance in the list of invalid AMP URLs:

westonruter · 2018-04-24T06:12:20Z

In the same way that there are inline row actions to acknowledge or ignore a given validation error on the edit terms screen, so too there are now the same action links provided when listing the validation errors on a given invalid AMP URL post:

westonruter · 2018-04-24T06:44:31Z

The edit post screen for an Invalid AMP Page now displays its actual URL and as a link so you can visit the URL to review the post on the frontend. (The view URL will need to be getting an amp_forced query param when the auto-disable functionality is triggered due to a URL having new/acknowledged errors which block it from being served as AMP.) This screen also now features the counts for the various error types present on the URL:

The URL shown in the post list table is also now shortened to remove the scheme and host name:

DavidCramer · 2018-04-25T11:49:42Z

@westonruter I took some time today going over the whole validation system, and it's crazy cool!

Some feedback.
I was initially confused as @ThierryA pointed out, as to the functional differences between Acknowledged and Ignore. My first thought was ignore tells the AMP plugin to ignore it and leave the invalid markup on the page. Where is Acknowledged meant that you are acknowledging it being removed.
Now reading your explanation to @ThierryA's question on functionality, I understand the difference. I still think the confirmation message is a little confusing though.

A suggestion on terminology. It seams that Ignore and Acknowledge is similar. Perhaps Dismiss would be better with an option like Dismiss for 1 hour, 1 day, 1 week, indefinitely. Kinda like, saying "ye thanks, I'm still working on it, remind me later."

The confirmation messages also made me feel a little confused Ignored 1 error. It will no longer block related URLs from being served as AMP. to me this told me that the pages will now be AMP valid. but was confused when I checked the page and it was valid since the invalid markup was being stripped.

westonruter · 2018-04-25T14:34:59Z

includes/sanitizers/class-amp-base-sanitizer.php

 			$node->parentNode->removeChild( $node );
 		}
+		return $should_remove;


In canonical AMP, whenever $should_remove is false, then this needs to trigger dirty AMP mode, where amp attribute is removed from the html element.

* Add get_validation_error_count() method. * Add removable_query_args to prevent persisting on page

…statuses * Add recognition of amp_validation_error_status query var for amp_invalid_url post queries. * Indicate in the list of errors on a given invalid URL post which are new, ignored, or acknowledged.

…valid URL details

…nces

…deletion of non-zero-count terms

Add query vars to removable list

…ource comments * Introduce amp_preserve_source_comments query param. * Rename locate_sources arg to should_locate_sources. * Remove debug flag for preventing sanitization on all validation errors. * Rename add_validation_hooks method to add_validation_error_sourcing.

…esults

… when sanitization status changes

Fix additional static analysis issues

Allow passing nonce instead of auth cookie to with amp_validate requests.

westonruter · 2018-05-28T03:22:07Z

With 69055c0, it is now made explicit that accepting a validation error on one URL will apply to the same error that occurs on other URLs :

Let statuses be changed in bulk on invalid URL screen

westonruter · 2018-05-28T06:39:56Z

I've added the rudimentary ability to preview changes to the statuses of validation errors:

Clicking “Preview” takes you to a URL like:

https://example.com/2018/05/25/foo/?amp_validate=47cd785376&amp_validation_error_status%5Bddecaba254d1ffcd034c9ab7add5196f%5D=1

You can see how the URL behaves with any number of validation errors accepted (sanitized).

Again, the UI for the invalid URLs screen and validation errors screen needs to be completely redone. The UI code in place now should be considered a prototype. Ideally there would be REST API endpoints added for managing the validation error status and invalid URL posts, and the current screens for managing them should be refactored to use a JS-based interface, such as with React.

@ThierryA Given these known issues with the UI and the outstanding need to update unit tests (which will likely change greatly with changes to the UI) I suggest getting this merged sooner rather than later, and then we can follow up with additional PRs to iterate on what is included here.

* Use wp_json_encode() instead or serialize(). * Ensure window opened for previewing validation error term status changes to have consistent name. * Use VALIDATION_ERROR_TERM_STATUS_QUERY_VAR constant.

…r overrides

westonruter · 2018-05-29T03:31:32Z

I've updated the design of the Invalid AMP Page screen to work a lot more like a regular edit post screen, with buttons inside the normal side metabox:

…ction

kienstra

Approved

Hi @westonruter,
Great work here. This PR looks good, having done a sanity-check review. The UI for "Accepted" and "Rejected" also looks much better

There are a few points, but no blocker from my perspective.

kienstra · 2018-05-29T19:00:32Z

includes/class-amp-autoloader.php

@@ -89,7 +89,9 @@ class AMP_Autoloader {
 		'AMP_DOM_Utils'                               => 'includes/utils/class-amp-dom-utils',
 		'AMP_HTML_Utils'                              => 'includes/utils/class-amp-html-utils',
 		'AMP_Image_Dimension_Extractor'               => 'includes/utils/class-amp-image-dimension-extractor',
-		'AMP_Validation_Utils'                        => 'includes/utils/class-amp-validation-utils',
+		'AMP_Validation_Manager'                      => 'includes/validation/class-amp-validation-manager',


It's nice how this is now organized in the includes/validation/ directory.

kienstra · 2018-05-29T19:10:43Z

includes/sanitizers/class-amp-style-sanitizer.php

 		);

-		$cache_key = md5( $stylesheet . serialize( $cache_impacting_options ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize
+		$cache_key = md5( $stylesheet . wp_json_encode( $cache_impacting_options ) );


It's nice how using wp_json_encode() removes the need to ignore a phpcs violation.

kienstra · 2018-05-29T19:18:15Z

includes/validation/class-amp-invalid-url-post-type.php

+			$result[] = esc_html( sprintf(
+				/* translators: %s is count */
+				__( '&#x2753; New: %s', 'amp' ),
+				number_format_i18n( $counts[ AMP_Validation_Error_Taxonomy::VALIDATION_ERROR_NEW_STATUS ] )


Nice use of number_format_i18(), I didn't know about that.

kienstra · 2018-05-29T19:33:02Z

includes/validation/class-amp-invalid-url-post-type.php

+		// Guard against Kses from corrupting content by adding post_content after content_save_pre filter applies.
+		$insert_post_content = function( $post_data ) use ( $placeholder, $post_content ) {
+			$should_supply_post_content = (
+				isset( $post_data['post_content'] )


Maybe this line could also check $post_data['post_type'], instead of the isset( $post_data['post_type'] ) check 4 lines below:

isset( $post_data['post_content'], $post_data['post_type'] )

kienstra · 2018-05-29T19:35:41Z

tests/test-class-amp-validation-utils.php

@@ -1,12 +1,12 @@
 <?php


It might be good to eventually move these tests to separate files, like test-class-amp-validation-manager.php.

Yes, absolutely agree. We'll follow up with new PR to add/update the tests and also to polish the UI. 👍

…pdate/validation

westonruter · 2018-05-29T21:04:14Z

It seems there are networking connectivity issues being experienced by GitHub or Travis that are causing jobs to fail. I'm going to go ahead and merge this even though the build isn't finishing.

westonruter added this to the v1.0 milestone Apr 21, 2018

westonruter self-assigned this Apr 21, 2018

westonruter mentioned this pull request Apr 25, 2018

[WIP] Add dynamic handling of validation errors #1063

Closed

7 tasks

westonruter commented Apr 25, 2018

View reviewed changes

westonruter force-pushed the update/validation branch from 9a546b3 to 811d133 Compare April 26, 2018 03:26

westonruter mentioned this pull request Apr 26, 2018

Capture script tag contents in AMP validator errors #1031

Closed

westonruter force-pushed the update/validation branch 2 times, most recently from dd3f2ff to 9365a6b Compare April 26, 2018 03:52

westonruter added 10 commits April 30, 2018 13:09

Refactor storage of validation errors to use taxonomy terms

2d5a341

Add acknowledged/ignored statuses for validation errors

1105fe3

Add filtering of validation errors by status

36cf381

* Add get_validation_error_count() method. * Add removable_query_args to prevent persisting on page

Add views for filtering invalid URLs by which contain specific error …

044d3c2

…statuses * Add recognition of amp_validation_error_status query var for amp_invalid_url post queries. * Indicate in the list of errors on a given invalid URL post which are new, ignored, or acknowledged.

Update count with Invalid Pages admin menu to use count with new errors

95487df

Let non-new validation errors be collapsed by default when viewing in…

212171f

…valid URL details

Allow validation errors to be deleted which no longer have any occura…

65999ea

…nces

Ensure checkboxes for validation error terms are always shown; block …

c482b37

…deletion of non-zero-count terms

Add sorting of validation errors by creation date

a6d2f70

Hide irrelevant published status from invalid URL post list

546c163

Add query vars to removable list

westonruter added 9 commits May 26, 2018 10:44

Let parsed stylesheet caching be done invariably

c58f897

Include sanitization status with each error when getting validation r…

6cd5e7e

…esults

Add prepare_validation_error_taxonomy_term helper method

9d159d5

Prevent cached stylesheet validation errors from being reported twice…

7869b63

… when sanitization status changes

Fix static analysis complaints in AMP_Style_Sanitizer

1f315a8

Disable document.write() at DOM ready when serving dirty AMP

85a0585

Remove process_markup method from validation manager

7c0a02d

Fix additional static analysis issues

Eliminate cookie authentication requirement to do frontend validation

90eff4f

Allow passing nonce instead of auth cookie to with amp_validate requests.

westonruter force-pushed the update/validation branch from 41570b0 to 90eff4f Compare May 27, 2018 05:33

Make clear what it means to accept a validation error

69055c0

Add previewability to validation error status changes for invalid URL

f17df99

Let statuses be changed in bulk on invalid URL screen

westonruter changed the title ~~[WIP] Refactor storage of validation errors to use taxonomy terms~~ Refactor storage of validation errors to use taxonomy terms May 28, 2018

westonruter assigned ThierryA May 28, 2018

westonruter added 4 commits May 28, 2018 17:56

Vary parsed stylesheet cache by validation error status overrides

f960f62

* Use wp_json_encode() instead or serialize(). * Ensure window opened for previewing validation error term status changes to have consistent name. * Use VALIDATION_ERROR_TERM_STATUS_QUERY_VAR constant.

De-duplicate code with helper methods

439bca5

Move invalid URL post action buttons to publish metabox

f29eaa2

Vary CSS parse cache only when there are CSS-specific validation erro…

c3db57e

…r overrides

westonruter added 2 commits May 28, 2018 20:35

Show full invalid AMP URL on edit post screen

2b1985a

Always hide validation errors which lack any URLs; eliminate delete a…

a4312b4

…ction

westonruter force-pushed the update/validation branch from 5e12fa1 to a4312b4 Compare May 29, 2018 05:28

kienstra approved these changes May 29, 2018

View reviewed changes

westonruter added 2 commits May 29, 2018 12:43

Merge branch 'develop' of https://github.com/Automattic/amp-wp into u…

cfa8bf5

…pdate/validation

Combine isset() checks

543b935

westonruter merged commit 888ac10 into develop May 29, 2018

westonruter deleted the update/validation branch July 5, 2018 15:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor storage of validation errors to use taxonomy terms #1093

Refactor storage of validation errors to use taxonomy terms #1093

westonruter commented Apr 21, 2018 •

edited

Loading

westonruter commented Apr 21, 2018

westonruter commented Apr 21, 2018

westonruter commented Apr 22, 2018

westonruter commented Apr 23, 2018

ThierryA commented Apr 23, 2018 •

edited

Loading

westonruter commented Apr 23, 2018

westonruter commented Apr 23, 2018 •

edited

Loading

westonruter commented Apr 24, 2018

westonruter commented Apr 24, 2018

westonruter commented Apr 24, 2018

westonruter commented Apr 24, 2018

DavidCramer commented Apr 25, 2018

westonruter Apr 25, 2018

westonruter commented May 28, 2018

westonruter commented May 28, 2018

westonruter commented May 29, 2018

kienstra left a comment •

edited

Loading

kienstra May 29, 2018 •

edited

Loading

kienstra May 29, 2018

kienstra May 29, 2018

kienstra May 29, 2018

kienstra May 29, 2018 •

edited

Loading

westonruter May 29, 2018

westonruter commented May 29, 2018

Refactor storage of validation errors to use taxonomy terms #1093

Refactor storage of validation errors to use taxonomy terms #1093

Conversation

westonruter commented Apr 21, 2018 • edited Loading

westonruter commented Apr 21, 2018

westonruter commented Apr 21, 2018

westonruter commented Apr 22, 2018

westonruter commented Apr 23, 2018

ThierryA commented Apr 23, 2018 • edited Loading

westonruter commented Apr 23, 2018

westonruter commented Apr 23, 2018 • edited Loading

westonruter commented Apr 24, 2018

westonruter commented Apr 24, 2018

westonruter commented Apr 24, 2018

westonruter commented Apr 24, 2018

DavidCramer commented Apr 25, 2018

westonruter Apr 25, 2018

Choose a reason for hiding this comment

westonruter commented May 28, 2018

westonruter commented May 28, 2018

westonruter commented May 29, 2018

kienstra left a comment • edited Loading

Choose a reason for hiding this comment

kienstra May 29, 2018 • edited Loading

Choose a reason for hiding this comment

kienstra May 29, 2018

Choose a reason for hiding this comment

kienstra May 29, 2018

Choose a reason for hiding this comment

kienstra May 29, 2018

Choose a reason for hiding this comment

kienstra May 29, 2018 • edited Loading

Choose a reason for hiding this comment

westonruter May 29, 2018

Choose a reason for hiding this comment

westonruter commented May 29, 2018

westonruter commented Apr 21, 2018 •

edited

Loading

ThierryA commented Apr 23, 2018 •

edited

Loading

westonruter commented Apr 23, 2018 •

edited

Loading

kienstra left a comment •

edited

Loading

kienstra May 29, 2018 •

edited

Loading

kienstra May 29, 2018 •

edited

Loading