Add a "Get Help" link or link within the existing text for users who encounter the google_api_connection_fail error

[jamesozzie]

Bug Description

For users who encounter the google_api_connection_fail error, there is no immediate "Get Help" link as there are for other compatibility check errors (example).

As we have new documentation making it's way through to the website, and an infrastructure change (#7864) with mini plugin that will allow users who are stuck based on IPv6 blocks, consider changing the following or similar:

Reference in codebase

- To get more help, ask a question on our [support forum](https://wordpress.org/support/plugin/google-site-kit/) and include the text of the original error message:
+ [Click here](https://sitekit.withgoogle.com/documentation/troubleshooting/setup/#google_api_connection_fail) for more information, or o get more help, ask a question on our [support forum](https://wordpress.org/support/plugin/google-site-kit/) and include the text of the original error message:

An alternate to the above would be have a standard "Get help' button with the google_api_connection_fail error code, as we have for the AMP or REST API compatibility checks. (AMP Get Help button | REST related Get Help button)

Note: There is a placeholder error code for this in our MVP error mapping sheet. This will be updated to point to the new guide making it's way through documentation.

@aaemnnosttv @adamdunnage @bethanylang

---

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

• A "Get Help" link should appear when the google_api_connection_fail error case is encountered in the Compatibility Errors. See the component for similar links.
• The "Get Help" link should go to https://sitekit.withgoogle.com/documentation/troubleshooting/setup/#google_api_connection_fail

Implementation Brief

• Add a <GetHelpLink errorCode={ error } /> to the google_api_connection_fail error case in assets/js/components/setup/CompatibilityChecks/CompatibilityErrorNotice.js (using createInterpolateElement, similar to other cases in that file).
• Update the Proxy support link URL service to point the Proxy Support Link URL output by

  site-kit-wp/assets/js/googlesitekit/datastore/site/urls.js

  Lines 141 to 163 in 72bf365

  	getErrorTroubleshootingLinkURL: createRegistrySelector(
  	( select ) => ( state, error ) => {
  	invariant( error, 'An error is required.' );
  	const proxySupportLink =
  	select( CORE_SITE ).getProxySupportLinkURL();
  	if ( error.id && ! isNumeric( error.id ) ) {
  	return `${ proxySupportLink }?error_id=${ encodeURIComponent(
  	error.id
  	) }`;
  	}
  	if ( error.code && ! isNumeric( error.code ) ) {
  	return `${ proxySupportLink }?error_id=${ encodeURIComponent(
  	error.code
  	) }`;
  	}
  	return `${ proxySupportLink }?error=${ encodeURIComponent(
  	error.message
  	) }`;
  	}

  error=google_api_connection_fail to https://sitekit.withgoogle.com/documentation/troubleshooting/setup/#google_api_connection_fail (Will require a Service Engineering task.)

Test Coverage

• No new tests needed.

QA Brief

• Install Site Kit on a fresh installation.
• In the Site Kit setup screen, open the "Network" tab of your Chrome browser developer tools.
• Right click on the request made to /wp-json/google-site-kit/v1/core/site/data/health-checks and select Override content.
• Follow this guide to override the response of this endpoint. The response should be updated to:

{
    "checks": {
        "googleAPI": {
            "pass": false,
            "errorMsg": ""
        },
        "skService": {
            "pass": true,
            "errorMsg": ""
        }
    }
}

• Now, reload the page and notice that the error message described in the issue appears.
• Verify that the "Get help" link points to this URL: https://sitekit.withgoogle.com/support?error_id=google_api_connection_fail

Changelog entry

• Add a "Get Help" link when google_api_connection_fail error occurs in Site Kit compatibility check.

[bethanylang]

Noting that the longer-term goal would be to implement #7986 to block users from proceeding with setup in this case. This would be a shorter-term solution prompting them to get help in order to proceed.

[bethanylang]

Per discussion with @aaemnnosttv, this should be a small change to update this specific case, and we'll need to determine if this error ID needs to be added to the related sheet. Moving to AC.

[techanvil]

IB ✅

@eugene-manuilov, tagging you as a heads up re. the IB point about this needing a Service Engineering task.

Update: Looks like this is already covered on Slack.

[wpdarren]

QA Update: ❌

@nfmohit I have two observations that I'd like to raise.

1. I see the message highlighted in the initial ticket description on the latest release. When I switch to the develop branch, though, a different message appears. Looks like your site is having a technical issue with requesting data from Google services The AC doesn't refer to a change in the message so wanted to check.

2. The URL on the "Get Help" link points to the URL in the AC, but when I click the link, I am redirected to the support forum. Is that expected right now? This issue is expected until the updates are in production. I have created an Asana task to check this as part of my post-release testing.

[nfmohit]

Hi @wpdarren, thank you for sharing your observations.

1. I see the message highlighted in the initial ticket description on the latest release. When I switch to the develop branch, though, a different message appears. Looks like your site is having a technical issue with requesting data from Google services The AC doesn't refer to a change in the message so wanted to check.

The part that I removed ("To get more help, ask a question on our support forum and include the text of the original error message: google_api_connection_fail") is already covered in the linked documentation, so I don't think there's much point in including that again in the message. Also, this follows the pattern of other similar error messages in this context which also have a "Get help" link.

@tofumatt As you had authored the ACs here, just to confirm, do you think it is still necessary to include this part in the error message?

Thank you!

[tofumatt]

As mentioned in Slack: let's keep that message in there 😄

[nfmohit]

Thank you folks! I've opened a follow-up PR #8028 that restores this text. Thanks!

[wpdarren]

QA Update: ❌

@nfmohit I apologize in advance for being picky, but as QA, it is what I do. 😄

Could we have the google_api_connection_fail text on the same line above, next to message:

It just looks a bit odd underneath.

Also, I noticed a difference in the URLs.

On the AC. https://sitekit.withgoogle.com/documentation/troubleshooting/setup/#google_api_connection_fail
On my test site: https://sitekit.withgoogle.com/support?error_id=google_api_connection_fail
It's worth noting the QAB states https://sitekit.withgoogle.com/support?error_id=google_api_connection_fail

Have I missed something here?

[nfmohit]

Hi @wpdarren.
Thank you for sharing your observation.

Could we have the google_api_connection_fail text on the same line above, next to message:

It just looks a bit odd underneath.

I understand, however, this is the pre-existing structure of error messages like these. This issue doesn't change the structure of the message but adds to it. Here is a similar error message:

For consistency, do you think it would be nicer to change all of them in a different issue?

Also, I noticed a difference in the URLs.

On the AC. https://sitekit.withgoogle.com/documentation/troubleshooting/setup/#google_api_connection_fail On my test site: https://sitekit.withgoogle.com/support?error_id=google_api_connection_fail It's worth noting the QAB states https://sitekit.withgoogle.com/support?error_id=google_api_connection_fail

https://sitekit.withgoogle.com/documentation/troubleshooting/setup/#google_api_connection_fail is the actual URL for the documentation.

https://sitekit.withgoogle.com/support?error_id=google_api_connection_fail is our proxy URL which will ultimately redirect the user to the actual documentation once the updates in the service side are pushed to production (see point #2 of this comment).

Please let me know what you think, thanks!

[wpdarren]

QA Update: ✅

Thanks, @nfmohit, that all makes sense.

For consistency, do you think it would be nicer to change all of them in a different issue?

Yes, I will create a new ticket for all of these messages.

Your example has bad formatting, so we should look to tidy it up, but it is a low priority in the scheme of things!

Verified:

• The error message described in the issue appears.
• The "Get help" link points to this URL: https://sitekit.withgoogle.com/support?error_id=google_api_connection_fail