-
Notifications
You must be signed in to change notification settings - Fork 292
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6322 from google/enhancement/4997-internal-errors
Add ReportErrorActions component
- Loading branch information
Showing
11 changed files
with
492 additions
and
341 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| /** | ||
| * ReportErrorActions component. | ||
| * | ||
| * Site Kit by Google, Copyright 2022 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * External dependencies | ||
| */ | ||
| import PropTypes from 'prop-types'; | ||
|
|
||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { | ||
| createInterpolateElement, | ||
| Fragment, | ||
| useCallback, | ||
| } from '@wordpress/element'; | ||
| import { __ } from '@wordpress/i18n'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import Data from 'googlesitekit-data'; | ||
| import { Button } from 'googlesitekit-components'; | ||
| import { CORE_SITE } from '../googlesitekit/datastore/site/constants'; | ||
| import { CORE_MODULES } from '../googlesitekit/modules/datastore/constants'; | ||
| import { | ||
| isErrorRetryable, | ||
| isInsufficientPermissionsError, | ||
| } from '../util/errors'; | ||
| import useViewOnly from '../hooks/useViewOnly'; | ||
| import Link from './Link'; | ||
|
|
||
| const { useSelect, useDispatch } = Data; | ||
|
|
||
| export default function ReportErrorActions( { moduleSlug, error } ) { | ||
| const isViewOnly = useViewOnly(); | ||
| const storeName = useSelect( ( select ) => | ||
| select( CORE_MODULES ).getModuleStoreName( moduleSlug ) | ||
| ); | ||
| const requestAccessURL = useSelect( ( select ) => | ||
| typeof select( storeName )?.getServiceEntityAccessURL === 'function' | ||
| ? select( storeName ).getServiceEntityAccessURL() | ||
| : null | ||
| ); | ||
|
|
||
| const errors = Array.isArray( error ) ? error : [ error ]; | ||
|
|
||
| const retryableErrors = errors.filter( | ||
| ( err ) => | ||
| isErrorRetryable( err, err.selectorData ) && | ||
| err.selectorData.name === 'getReport' | ||
| ); | ||
|
|
||
| const showRetry = !! retryableErrors.length && ! isViewOnly; | ||
|
|
||
| const errorTroubleshootingLinkURL = useSelect( ( select ) => { | ||
| const err = { | ||
| ...( showRetry ? retryableErrors[ 0 ] : errors[ 0 ] ), | ||
| }; | ||
|
|
||
| if ( isInsufficientPermissionsError( err ) ) { | ||
| err.code = `${ moduleSlug }_insufficient_permissions`; | ||
| } | ||
|
|
||
| return select( CORE_SITE ).getErrorTroubleshootingLinkURL( err ); | ||
| } ); | ||
|
|
||
| const dispatch = useDispatch(); | ||
|
|
||
| const hasInsufficientPermissionsError = errors.some( ( err ) => | ||
| isInsufficientPermissionsError( err ) | ||
| ); | ||
|
|
||
| const handleRetry = useCallback( () => { | ||
| retryableErrors.forEach( ( err ) => { | ||
| const { selectorData } = err; | ||
| dispatch( selectorData.storeName ).invalidateResolution( | ||
| selectorData.name, | ||
| selectorData.args | ||
| ); | ||
| } ); | ||
| }, [ dispatch, retryableErrors ] ); | ||
|
|
||
| const showRequestAccessURL = | ||
| requestAccessURL && hasInsufficientPermissionsError && ! isViewOnly; | ||
|
|
||
| return ( | ||
| <div className="googlesitekit-report-error-actions"> | ||
| { showRequestAccessURL && ( | ||
| <Button href={ requestAccessURL } target="_blank"> | ||
| { __( 'Request access', 'google-site-kit' ) } | ||
| </Button> | ||
| ) } | ||
| { showRetry ? ( | ||
| <Fragment> | ||
| <Button onClick={ handleRetry }> | ||
| { __( 'Retry', 'google-site-kit' ) } | ||
| </Button> | ||
| <span className="googlesitekit-error-retry-text"> | ||
| { createInterpolateElement( | ||
| __( | ||
| 'Retry didn’t work? <HelpLink />', | ||
| 'google-site-kit' | ||
| ), | ||
| { | ||
| HelpLink: ( | ||
| <Link | ||
| href={ errorTroubleshootingLinkURL } | ||
| external | ||
| > | ||
| { __( 'Get help', 'google-site-kit' ) } | ||
| </Link> | ||
| ), | ||
| } | ||
| ) } | ||
| </span> | ||
| </Fragment> | ||
| ) : ( | ||
| <Link href={ errorTroubleshootingLinkURL } external> | ||
| { __( 'Get help', 'google-site-kit' ) } | ||
| </Link> | ||
| ) } | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| ReportErrorActions.propTypes = { | ||
| moduleSlug: PropTypes.string.isRequired, | ||
| error: PropTypes.oneOfType( [ | ||
| PropTypes.arrayOf( PropTypes.object ), | ||
| PropTypes.object, | ||
| ] ).isRequired, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.