Replace the 'Settings saved' notice, only on changing the Template Mode #1443

kienstra · 2018-09-18T06:45:22Z

The copy can still change, but this now has the copy here for all 3 template modes
Once this displays, it never displays again

Todos include:

At the moment, this display on the first change of any setting on this page, even 'Automatically accept sanitization...'
It might be best to only display this message when one of the template modes changes.
On first activating the plugin, there probably won't be any validation errors (see Settings callout for "view your site as amp" after initial save #1399 (comment)). So the 'or Review errors' part of the notice might not apply. This could query for errors, and conditionally show that text.

Closes #1399

…ething The copy can still change, but this now has Leo's copy for all 3 template modes.

westonruter · 2018-09-18T18:50:27Z

It might be best to only display this message when one of the template modes changes.

👍

Once this displays, it never displays again

I don't think this should be the case necessarily. If it only shows when changing the template mode, then in reality it won't show very much.

On first activating the plugin, there probably won't be any validation errors (see Settings callout for "view your site as amp" after initial save #1399 (comment)). So the 'or Review errors' part of the notice might not apply. This could query for errors, and conditionally show that text.

This surfaces the discussion we had awhile ago about showing the validation status alongside each of the supportable templates.

When visiting the AMP settings screen, I think we need to make sure that there are some invalid URLs captured for us to show. This could be done server-side when switching the mode, or when visiting this settings screen there could be Ajax requests triggered to validate the latest URL of each supported template type.

That may be overkill to start with, so perhaps the best thing would be upon switching the mode to obtain the first post type that is supported by AMP, and obtain the first published post of that type that has AMP enabled, and then re-validate that URL. When the page then reloads there will be validation results available to show.

westonruter · 2018-09-18T18:51:26Z

includes/options/class-amp-options-menu.php

+				if ( isset( $message ) ) {
+					$wp_settings_errors[ $key ]['message'] = $message; // WPCS: Global override OK.
+					// Ensure that this notice does not display again.
+					update_user_meta( get_current_user_id(), $meta_key, true );


We can remove the user meta flag. The notice should be shown each time the user changes the mode.

Good point. 3a75250 removes the user meta as a condition of displaying this message.

westonruter · 2018-09-18T18:54:13Z

includes/options/class-amp-options-menu.php

+		}
+
+		foreach ( $wp_settings_errors as $key => $setting ) {
+			if ( 'general' === $setting['setting'] && 'settings_updated' === $setting['code'] ) {


If you call add_settings_error() inside the option sanitizer callback, where we can detect the mode change, then this will get stored in a transient to then automatically be displayed with the admin_notices when the page reloads.

What this won't do is hide the default settings updated notice.

Note that add_settings_error() has a $type parameter which can be "updated", so not an error at all.

Great idea. cc2e62f uses add_settings_error() in the sanitize_callback.

Though I'm not sure why, it seems like the default message doesn't display when this is added.

As Weston mentioned, it's not necessary to hide this after the first time it shows

Thanks to Weston's suggestion, add this in the sanitize_callback for the option. Now, updating other options like 'Serve all templates...' won't display this notice.

kienstra · 2018-09-19T00:13:53Z

Validating On Switching Template Modes

Hi @westonruter,

...perhaps the best thing would be upon switching the mode to obtain the first post type that is supported by AMP, and obtain the first published post of that type that has AMP enabled, and then re-validate that URL. When the page then reloads there will be validation results available to show.

Good idea, it would make sense to validate a URL on switching template modes.

Do you think this could reuse AMP_Validation_Manager:: validate_after_plugin_activation() to do this? If so, maybe we could rename it.
If by chance there's no error after validating that URL, should this still have the 'or Review Errors' text, with a link to an empty Invalid URLs page? Or should this possibly query for amp_invalid_url, and only show the message with 'or Review Errors' if an error exists?

westonruter · 2018-09-19T04:16:03Z

@kienstra using validate_after_plugin_activation isn't quite right because it sets that transient. Otherwise, it's right. Maybe most of the guts of that method should be moved to another method, like validate_latest_post() which would store the results and and return the ID for the amp_invalid_url post.

In reality, the $validation_errors should not be stored in the transient. Only the ID should be stored. The plugin can then read the ID and then fetch the validation errors from AMP_Invalid_URL_Post_Type::get_invalid_url_validation_errors() instead of from the transient.

And yes, if there are no unaccepted validation errors on the URL then that “Review Errors” link should be removed.

kienstra · 2018-09-20T15:25:57Z

Sorry For Delay, Will Apply Today

Hi @westonruter,
Sorry for the delay in applying your suggestions. If it's alright, I"m planning on applying them today.

…dd/1399-view-as-amp

westonruter · 2018-09-21T23:34:21Z

Here's where I'm going with the messages. They vary based on the mode switched to, and there are links to view either the validated URL on the site, and/or to view the validation errors for that URL.

Success message when activating native mode:

Message when enabling paired mode but there are validation errors blocking it:

When activating classic mode:

…ed post types and templates

Replace the 'Settings saved' notice the first time the user saves som…

05092d7

…ething The copy can still change, but this now has Leo's copy for all 3 template modes.

westonruter reviewed Sep 18, 2018

View reviewed changes

Remove the user meta as a condition for displaying this message

3a75250

As Weston mentioned, it's not necessary to hide this after the first time it shows

kienstra self-assigned this Sep 18, 2018

Only display a message if the Template Mode was changed

cc2e62f

Thanks to Weston's suggestion, add this in the sanitize_callback for the option. Now, updating other options like 'Serve all templates...' won't display this notice.

kienstra changed the title ~~[WIP] Replace the 'Settings saved' notice the first time the user saves a setting~~ [WIP] Replace the 'Settings saved' notice, only on changing the Template Mode Sep 18, 2018

westonruter assigned westonruter and unassigned kienstra Sep 21, 2018

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

faa85d9

…dd/1399-view-as-amp

Update amp_admin_get_preview_permalink to be more informed of support…

199436e

…ed post types and templates

westonruter changed the title ~~[WIP] Replace the 'Settings saved' notice, only on changing the Template Mode~~ Replace the 'Settings saved' notice, only on changing the Template Mode Sep 22, 2018

westonruter added this to the v1.0 milestone Sep 22, 2018

westonruter added the Compatability Tool label Sep 22, 2018

westonruter approved these changes Sep 22, 2018

View reviewed changes

Check validity when switching between template mode and show results

75e6905

westonruter force-pushed the add/1399-view-as-amp branch from 2c6d27a to 75e6905 Compare September 22, 2018 00:58

westonruter merged commit ee72fa9 into develop Sep 22, 2018

westonruter deleted the add/1399-view-as-amp branch September 22, 2018 01:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace the 'Settings saved' notice, only on changing the Template Mode #1443

Replace the 'Settings saved' notice, only on changing the Template Mode #1443

kienstra commented Sep 18, 2018 •

edited by westonruter

Loading

westonruter commented Sep 18, 2018

westonruter Sep 18, 2018

kienstra Sep 18, 2018

westonruter Sep 18, 2018

kienstra Sep 18, 2018

kienstra commented Sep 19, 2018 •

edited

Loading

westonruter commented Sep 19, 2018

kienstra commented Sep 20, 2018

westonruter commented Sep 21, 2018

Replace the 'Settings saved' notice, only on changing the Template Mode #1443

Replace the 'Settings saved' notice, only on changing the Template Mode #1443

Conversation

kienstra commented Sep 18, 2018 • edited by westonruter Loading

westonruter commented Sep 18, 2018

westonruter Sep 18, 2018

Choose a reason for hiding this comment

kienstra Sep 18, 2018

Choose a reason for hiding this comment

westonruter Sep 18, 2018

Choose a reason for hiding this comment

kienstra Sep 18, 2018

Choose a reason for hiding this comment

kienstra commented Sep 19, 2018 • edited Loading

westonruter commented Sep 19, 2018

kienstra commented Sep 20, 2018

westonruter commented Sep 21, 2018

Success message when activating native mode:

Message when enabling paired mode but there are validation errors blocking it:

When activating classic mode:

kienstra commented Sep 18, 2018 •

edited by westonruter

Loading

kienstra commented Sep 19, 2018 •

edited

Loading