Edited error message #13507

d3vl0p · 2019-09-21T11:59:39Z

Fixes #13115

Changes proposed in this Pull Request:

edited error message to include a link to the debug and contact page

Testing instructions:

This fixes the following issue: Error message should tell user how to get to debugging page #13115

Proposed changelog entry for your changes:

No changelog entry needed

jetpackbot · 2019-09-21T12:02:09Z

Thank you for the great PR description!

When this PR is ready for review, please apply the [Status] Needs Review label. If you are an a11n, please have someone from your team review the code if possible. The Jetpack team will also review this PR and merge it to be included in the next Jetpack release.

Scheduled Jetpack release: November 5, 2019.
Scheduled code freeze: October 29, 2019

Generated by 🚫 dangerJS against 710ea1d

jeherve

I would recommend linking to the Debug page with the site URL already filled in. I think you could also remove the comment at the end of the line now.

d3vl0p · 2019-09-25T17:28:00Z

@jeherve made the change. The debug link will now include site_url() at the end of it.

jeherve

The backticks aren't going to work well here. I'd recommend building the string using sprintf and wp_kses to ensure that translators cannot break the string while translating.

d3vl0p · 2019-09-26T13:22:57Z

@jeherve That's great advice. While I knew a little bit about this in theory, I learned so much more in practice while making changes and getting this to work. What do you think about the latest commit?

mdawaffe · 2019-09-26T17:36:45Z

_inc/lib/debugger/class-jetpack-cxn-tests.php

+			sprintf(
+				/* translators: 1st placeholder is a link to Jetpack debug page, 2nd one fetches current site URL. */
+				__(
+					'<a href="%1$s%2$s">Visit the Jetpack.com debug page</a> for more information or <a href="https://jetpack.com/contact-support/">contact support</a>.',


We should be able to do this with just one placeholder.

mdawaffe · 2019-09-26T17:44:57Z

_inc/lib/debugger/class-jetpack-cxn-tests.php

+					'<a href="%1$s%2$s">Visit the Jetpack.com debug page</a> for more information or <a href="https://jetpack.com/contact-support/">contact support</a>.',
+					'jetpack'
+				),
+				'https://jetpack.com/support/debug/?url=',


If we do just the one place holder, we condense these two into arguments (the debug URL and the site URL) into one:

esc_url( add_query_arg( 'url', urlencode( site_url() ), 'https://jetpack.com/support/debug/' ) )

This also ensures we're using the right escaping functions (esc_url() for the whole URL, urlencode() for the query string parameter) in the right places.

Oh! didn't think of that. Also add_query_arg is a TIL for me. Thanks. Made the change now.

jeherve

This looks good. However, while it works well under Tools > Site Health, we can't really display links in Jetpack > Debug right now:

You'd need to ensure that the output there allows for links, maybe using wp_kses as well:

jetpack/_inc/lib/debugger/class-jetpack-debugger.php

Line 116 in fcd387a

    
           echo '<p class="jetpack-test-details">' . esc_html( $fail['resolution'] ) . '</p>';

d3vl0p · 2019-09-27T15:12:01Z

@jeherve Good point. Thanks for testing. Made the change (also resolved the conflict with the master branch) and this looks good to go!

jeherve

This looks good to me. It should be good to merge. I only wonder if it may be best to have those links open in a new tab, since they direct you out of wp-admin.

wigglemuff · 2019-09-30T09:34:33Z

@jeherve You're right, opening the link in a new tab makes sense. Let me make that change..
(sorry to flip between two diff accounts, I accidentally used my personal account omkarbhagat93 for this PR and will continue to use that only for this PR. Will switch back to codestor4 A8C account for all future PRs).

d3vl0p · 2019-10-03T10:57:25Z

@jeherve All done. Ready to merge 👍

jeherve

Good addition. I'd have 2 remarks:

Now that you've added a new attribute to that HTML tag (target), you'll want to update the list of attributes you're allowing in wp_kses. If you don't, wp_kses will strip them for you.
When you are adding a target="_blank" attribute, you also want to add a rel="noopener noreferrer" attribute to avoid the problems listed here: https://www.jitbit.com/alexblog/256-targetblank---the-most-underestimated-vulnerability-ever/ https://stackoverflow.com/a/50709760/1045686

wigglemuff · 2019-10-04T10:45:34Z

Latest commit includes noopener noreferrer and wp_kses updated to include rel and target attributes. Thanks for including links for context. I love that I'm getting to learn so much more by working on a PR :)

cc: @jeherve

jeherve

This looks good to me. Merging.

Changes were made to address this.

kraftbj · 2019-10-04T19:42:16Z

One thing I'd want to check is the wp jetpack status output of a site in a broken state.

Ideally, in the PR description and testing instructions, there would be enough detail to recreate the error state so it can be tested without figuring out how to break JP.

kraftbj · 2019-10-04T19:57:02Z

It looks good. I have a vague memory of not including a link for some CLI reason, but that seems to be outdated info.

wigglemuff · 2019-10-05T00:53:30Z

Ideally, in the PR description and testing instructions, there would be enough detail to recreate the error state so it can be tested without figuring out how to break JP.

Noted. I'm still learning but I'll remember this for the next time. I wanted to recreate the error message to test things and Jeremy suggested the simplest way is to put it outside of if/else block. That's what I did. I don't know if there is a better way to recreate the error. Can you share some details on how you did it? @kraftbj

Edit: Wait I think you did it via wp jetpack status and if that's the case then disregard my question (disappears)..

* 7.9: Changelog * Update version number * Update stable tag and tested up to * Changelog: add #13530 * changelog: add #13578 * Changelog: add #13598 * Changelog: add entry for numerous block preview changes * Changelog: add #13599 * changelog: add #13541 * Changelog: add #13542 * Changelog: add #13331 * Changelog: add #13558 * Changelog: add #13409 * Changelog: add #13582 * Changelog: add #13600 * Changelog: add #13601 * Changelog: add #13595 * Changelog: add #12695 * Changelog: add #13009 * Changelog: add #13649 * Changelog: add #13450 * Changelog: add #13507 * Changelog: add #13658 * Changelog: add #13687 * changelog: add #13683 * Changelog: add #9323 * Changelog: add #13681 * Fix typos in readme * Add link to WordPress Beta Tester plugin * Changelog: add #13630 * Changelog: add #13695 * Changelog: add #13659 * Changelog: add #13716 * Changelog: add #13664 * Changelog: add #13682 * Changelog: add #13362 * Changelog: add #13563 * Add testing list for #13563 * Changelog: add #13735 * Changelog: add #13752 * Changelog: add #13624 * Changelog: add #13756 * Changelog: add #13745 * Changelog: add #13728 * Changelog: add #13779 * Changelog: add #13699 * Changelog: add #13804 * Changelog: add #13761 * Changelog: add #13637 * Changelog: add #13517 * Changelog: add #13521 * Changelog: add #13729 * Testing list: add testing instructions for #13729 * Changelog: add sync changes * Changelog: add #13807 * Changelog: add #13654 * Changelog: add #13795 * Changelog: add #13801 * Changelog: add #13818 * Changelog: add #13725 * Changelog: add #13831 * Changelog: add #13516 * Testing list: add Twenty Twenty instructions * Changelog: add #13799 * Changelog: add #13805 * Changelog: add #13688 * Changelog: add #13830

edited error msg

d84c29c

d3vl0p requested a review from a team as a code owner September 21, 2019 11:59

wigglemuff added [Status] In Progress [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Sep 21, 2019

jeherve added the General label Sep 23, 2019

jeherve requested changes Sep 23, 2019

View reviewed changes

jeherve added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] In Progress [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Sep 23, 2019

error msg debug link includes site url now

41fa35c

jeherve requested changes Sep 26, 2019

View reviewed changes

error msg using wp_kses and sprintf

24352a1

mdawaffe previously requested changes Sep 26, 2019

View reviewed changes

single placeholder with esc_url and add_query_arg

4ecafc9

d3vl0p requested a review from mdawaffe September 27, 2019 06:07

jeherve requested changes Sep 27, 2019

View reviewed changes

jeherve assigned d3vl0p Sep 27, 2019

Omkar Bhagat and others added 2 commits September 27, 2019 18:48

wp_kses for error msg on debugger.php page

a35f024

Merge branch 'master' into fix/error-msg

e4c40c8

d3vl0p requested a review from jeherve September 27, 2019 15:05

jeherve added this to the 7.9 milestone Sep 30, 2019

jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Sep 30, 2019

jeherve previously approved these changes Sep 30, 2019

View reviewed changes

jeherve removed the [Status] Ready to Merge Go ahead, you can push that green button! label Sep 30, 2019

jeherve added the [Status] In Progress label Sep 30, 2019

open urls in a new tab

865f8ea

d3vl0p dismissed jeherve’s stale review via 865f8ea October 3, 2019 10:55

d3vl0p requested a review from jeherve October 3, 2019 10:56

wigglemuff added the [Status] Needs Review To request a review from Crew. Label will be renamed soon. label Oct 3, 2019

jeherve requested changes Oct 3, 2019

View reviewed changes

jeherve added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] In Progress [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Oct 3, 2019

added noopener noreferrer for links

710ea1d

wigglemuff requested a review from jeherve October 4, 2019 10:45

wigglemuff added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Oct 4, 2019

jeherve approved these changes Oct 4, 2019

View reviewed changes

jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Oct 4, 2019

jeherve merged commit fe3c46e into Automattic:master Oct 4, 2019

matticbot added [Status] Needs Changelog and removed [Status] Ready to Merge Go ahead, you can push that green button! labels Oct 4, 2019

jeherve added [Status] Has Changelog and removed [Status] Needs Changelog labels Oct 17, 2019

jeherve added a commit that referenced this pull request Oct 23, 2019

Changelog: add #13507

a30be04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Edited error message #13507

Edited error message #13507

d3vl0p commented Sep 21, 2019

jetpackbot commented Sep 21, 2019 •

edited

Loading

jeherve left a comment

d3vl0p commented Sep 25, 2019

jeherve left a comment

d3vl0p commented Sep 26, 2019

mdawaffe Sep 26, 2019

mdawaffe Sep 26, 2019

d3vl0p Sep 27, 2019

jeherve left a comment

d3vl0p commented Sep 27, 2019

jeherve left a comment

wigglemuff commented Sep 30, 2019 •

edited

Loading

d3vl0p commented Oct 3, 2019

jeherve left a comment

wigglemuff commented Oct 4, 2019

jeherve left a comment

kraftbj commented Oct 4, 2019

kraftbj commented Oct 4, 2019

wigglemuff commented Oct 5, 2019 •

edited

Loading

Edited error message #13507

Edited error message #13507

Conversation

d3vl0p commented Sep 21, 2019

Changes proposed in this Pull Request:

Testing instructions:

Proposed changelog entry for your changes:

jetpackbot commented Sep 21, 2019 • edited Loading

jeherve left a comment

Choose a reason for hiding this comment

d3vl0p commented Sep 25, 2019

jeherve left a comment

Choose a reason for hiding this comment

d3vl0p commented Sep 26, 2019

mdawaffe Sep 26, 2019

Choose a reason for hiding this comment

mdawaffe Sep 26, 2019

Choose a reason for hiding this comment

d3vl0p Sep 27, 2019

Choose a reason for hiding this comment

jeherve left a comment

Choose a reason for hiding this comment

d3vl0p commented Sep 27, 2019

jeherve left a comment

Choose a reason for hiding this comment

wigglemuff commented Sep 30, 2019 • edited Loading

d3vl0p commented Oct 3, 2019

jeherve left a comment

Choose a reason for hiding this comment

wigglemuff commented Oct 4, 2019

jeherve left a comment

Choose a reason for hiding this comment

kraftbj commented Oct 4, 2019

kraftbj commented Oct 4, 2019

wigglemuff commented Oct 5, 2019 • edited Loading

jetpackbot commented Sep 21, 2019 •

edited

Loading

wigglemuff commented Sep 30, 2019 •

edited

Loading

wigglemuff commented Oct 5, 2019 •

edited

Loading