Website: Add error report modal #1102
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
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
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,182 @@ | ||
| import { useEffect, useState } from 'react'; | ||
| import Modal from '../modal'; | ||
| import { addFatalErrorListener, logger } from '@php-wasm/logger'; | ||
| import { Button, TextareaControl, TextControl } from '@wordpress/components'; | ||
|
|
||
| import css from './style.module.css'; | ||
|
|
||
| import { usePlaygroundContext } from '../../playground-context'; | ||
|
|
||
| export function ErrorReportModal() { | ||
| const { showErrorModal, setShowErrorModal } = usePlaygroundContext(); | ||
| const [loading, setLoading] = useState(false); | ||
| const [text, setText] = useState(''); | ||
| const [logs, setLogs] = useState(''); | ||
| const [url, setUrl] = useState(''); | ||
| const [submitted, setSubmitted] = useState(false); | ||
| const [submitError, setSubmitError] = useState(''); | ||
|
|
||
| useEffect(() => { | ||
| addFatalErrorListener(logger, (e) => { | ||
| const error = e as CustomEvent; | ||
| if (error.detail?.source === 'php-wasm') { | ||
| setShowErrorModal(true); | ||
| } | ||
| }); | ||
| }, [setShowErrorModal]); | ||
|
|
||
| useEffect(() => { | ||
| resetForm(); | ||
| if (showErrorModal) { | ||
| setLogs(logger.getLogs().join('')); | ||
| setUrl(window.location.href); | ||
| } | ||
| }, [showErrorModal, setShowErrorModal, logs, setLogs]); | ||
|
|
||
| function resetForm() { | ||
| setText(''); | ||
| setLogs(''); | ||
| setUrl(''); | ||
| } | ||
|
|
||
| function resetSubmission() { | ||
| setSubmitted(false); | ||
| setSubmitError(''); | ||
| } | ||
|
|
||
| function onClose() { | ||
| setShowErrorModal(false); | ||
| resetForm(); | ||
| resetSubmission(); | ||
| } | ||
|
|
||
| async function onSubmit() { | ||
| setLoading(true); | ||
| const formdata = new FormData(); | ||
| formdata.append('description', text); | ||
| if (logs) { | ||
| formdata.append('logs', logs); | ||
| } | ||
| if (url) { | ||
| formdata.append('url', url); | ||
| } | ||
| try { | ||
| const response = await fetch( | ||
| 'https://playground.wordpress.net/logger.php', | ||
| { | ||
| method: 'POST', | ||
| body: formdata, | ||
| } | ||
| ); | ||
| setSubmitted(true); | ||
|
|
||
| const body = await response.json(); | ||
| if (!body.ok) { | ||
| throw new Error(body.error); | ||
| } | ||
|
|
||
| setSubmitError(''); | ||
| resetForm(); | ||
| } catch (e) { | ||
| setSubmitError((e as Error).message); | ||
| } finally { | ||
| setLoading(false); | ||
| } | ||
| } | ||
|
|
||
| function getTitle() { | ||
| if (!submitted) { | ||
| return 'Report error'; | ||
| } else if (submitError) { | ||
| return 'Failed to report the error'; | ||
| } else { | ||
| return 'Thank you for reporting the error'; | ||
| } | ||
| } | ||
|
|
||
| function getContent() { | ||
| if (!submitted) { | ||
| return ( | ||
| <> | ||
| Playground crashed because of an error. You can help resolve | ||
| the issue by sharing the error details with us. | ||
| </> | ||
| ); | ||
| } else if (submitError) { | ||
| return ( | ||
| <> | ||
| We were unable to submit the error report. Please try again | ||
| or open an{' '} | ||
| <a href="https://github.com/WordPress/wordpress-playground/issues/"> | ||
| issue on GitHub. | ||
| </a> | ||
| </> | ||
| ); | ||
| } else { | ||
| return ( | ||
| <> | ||
| Your report has been submitted to the{' '} | ||
| <a href="https://wordpress.slack.com/archives/C06Q5DCKZ3L"> | ||
| Making WordPress #playground-logs Slack channel | ||
| </a>{' '} | ||
| and will be reviewed by the team. | ||
| </> | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Show the form if the error has not been submitted or if there was an error submitting it. | ||
| * | ||
| * @return {boolean} | ||
| */ | ||
| function showForm() { | ||
| return !submitted || submitError; | ||
| } | ||
|
|
||
| return ( | ||
| <Modal isOpen={showErrorModal} onRequestClose={onClose}> | ||
| <header className={css.errorReportModalHeader}> | ||
| <h2>{getTitle()}</h2> | ||
| <p>{getContent()}</p> | ||
| </header> | ||
| {showForm() && ( | ||
| <> | ||
| <main> | ||
| <TextareaControl | ||
| label="What happened?" | ||
| help="Describe what caused the error and how can we reproduce it." | ||
| value={text} | ||
| onChange={setText} | ||
| className={css.errorReportModalTextarea} | ||
| required={true} | ||
| /> | ||
| <TextareaControl | ||
| label="Logs" | ||
| value={logs} | ||
| onChange={setLogs} | ||
| className={css.errorReportModalTextarea} | ||
| /> | ||
|
|
||
| <TextControl | ||
| label="Url" | ||
| value={url} | ||
| onChange={setUrl} | ||
| /> | ||
| </main> | ||
| <footer className={css.errorReportModalFooter}> | ||
| <Button | ||
| variant="primary" | ||
| onClick={onSubmit} | ||
| isBusy={loading} | ||
| disabled={loading || !text} | ||
| > | ||
| Report error | ||
| </Button> | ||
| <Button onClick={onClose}>Cancel</Button> | ||
| </footer> | ||
| </> | ||
| )} | ||
| </Modal> | ||
| ); | ||
| } |
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,19 @@ | ||
| .error-report-modal__header h2 { | ||
| font-size: 20px; | ||
| } | ||
|
|
||
| .error-report-modal__header p { | ||
| font-size: 13px; | ||
| } | ||
|
|
||
| .error-report-modal__textarea textarea { | ||
| resize: vertical; | ||
| width: 100% !important; | ||
| } | ||
|
|
||
| .error-report-modal__footer { | ||
| margin-top: 20px; | ||
| } | ||
| .error-report-modal__error { | ||
| margin: 16px 0 0; | ||
| } |
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 |
|---|---|---|
|
|
@@ -20,5 +20,4 @@ | |
| padding: 15px; | ||
| text-align: left; | ||
| max-height: 90vh; | ||
| } | ||
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,23 @@ | ||
| import { MenuItem } from '@wordpress/components'; | ||
| import { bug } from '@wordpress/icons'; | ||
|
|
||
| import { usePlaygroundContext } from '../../playground-context'; | ||
|
|
||
| type Props = { onClose: () => void }; | ||
| export function ReportError({ onClose }: Props) { | ||
| const { setShowErrorModal } = usePlaygroundContext(); | ||
| return ( | ||
| <MenuItem | ||
| icon={bug} | ||
| iconPosition="left" | ||
| data-cy="report-error" | ||
| aria-label="Report an error in Playground" | ||
| onClick={() => { | ||
| setShowErrorModal(true); | ||
| onClose(); | ||
| }} | ||
| > | ||
| Report error | ||
| </MenuItem> | ||
| ); | ||
| } |
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.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this for Playground integrators?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is for localhost, but it's also required if we want to allow an integrator to send error reports.