Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extension: add report error button #944

Merged
merged 6 commits into from
Nov 16, 2016
Merged

Extension: add report error button #944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5f5f9f7
add report error button
olingern Nov 15, 2016
0a3bdaf
update text to textContext, rearrange conditional
olingern Nov 16, 2016
286af63
Add stacktrace, chrome and lighthouse version to link.
olingern Nov 16, 2016
33015d2
conditional styling for feedback area
olingern Nov 16, 2016
9029182
Place stack trace in code block. Add error message
olingern Nov 16, 2016
e78062d
fix Lighthouse function casing
olingern Nov 16, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 39 additions & 2 deletions lighthouse-extension/app/src/popup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,33 @@ document.addEventListener('DOMContentLoaded', _ => {
const optionsList = document.body.querySelector('.options__list');
const okButton = document.getElementById('ok');

function getLighthouseVersion() {
return chrome.runtime.getManifest().version;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice find!

}

function getChromeVersion() {
return /Chrome\/([0-9.]+)/.exec(navigator.userAgent)[1];
}

function buildReportErrorLink(err) {
const reportErrorEl = document.createElement('a');
reportErrorEl.className = 'button button--report-error';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have @robdodson in my head saying "just use a button" here. Should this be just a button? Alternatively we could make the link more link-like.

I don't want to bikeshed here too much, we can always change it up later if we don't get it exactly right at first. @ebidel for a quick opinion.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A button would be consistent with the existing HTML buttons, but would have a few small hoops to jump through, i.e. storing the link on a data-issue-link attribute and binding an onclick function to the button. Nothing too crazy, but a link was easiest 😄

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in general buttons are for actions and links are for navigation. Not sure what the intent of this control is but happy to take a look in-person if that's any help

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, my point was more styling. It's a link acting like a link, but somewhat styled like a button :)

However, it works and we've talked about reworking the popup as it keeps getting more crowded anyways, so we can address this at that point if need be. I'd like to get this landed now to help users out.


let qsBody = '**Lighthouse Version**: ' + getLighthouseVersion() + '\n';
qsBody += '**Chrome Version**: ' + getChromeVersion() + '\n';
qsBody += '**Error Message**: ' + err.message + '\n';
qsBody += '**Stack Trace**:\n ```' + err.stack + '```';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL the user was running LH against would also be helpful to add to the bug report.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about that, but is thought it could be considered invasive. Thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could have a placeholder for them to fill in?

**URL:\n**: <Enter the URL that caused this error>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, it could be invasive. Most of the extension issues we've seen with an actual caught error (as opposed to something more subtle, like -1 in FMP) have been tracked down without the URL. We can add the optional prompt for it later if we find ourselves asking for it more often than not


const base = 'https://github.com/googlechrome/lighthouse/issues/new?';
const title = encodeURI('title=Lighthouse Extension Error');
const body = '&body=' + encodeURI(qsBody);

reportErrorEl.href = base + title + body;
reportErrorEl.textContent = 'Report Error';
reportErrorEl.target = '_blank';
return reportErrorEl;
}

let spinnerAnimation;

function startSpinner() {
Expand Down Expand Up @@ -132,16 +159,26 @@ document.addEventListener('DOMContentLoaded', _ => {
})
.catch(err => {
let message = err.message;
if (message.toLowerCase().startsWith('another debugger')) {

const debuggerExists = message.toLowerCase().startsWith('another debugger');
const multipleTabs = message.toLowerCase().includes('multiple tabs');

if (debuggerExists) {
message = 'You probably have DevTools open.' +
' Close DevTools to use lighthouse';
}
if (message.toLowerCase().includes('multiple tabs')) {
if (multipleTabs) {
message = 'You probably have multiple tabs open to the same origin.' +
' Close the other tabs to use lighthouse.';
}

feedbackEl.textContent = message;

if (!multipleTabs && !debuggerExists) {
feedbackEl.className = 'feedback-error';
feedbackEl.appendChild(buildReportErrorLink(err));
}

stopSpinner();
background.console.error(err);
});
Expand Down
20 changes: 20 additions & 0 deletions lighthouse-extension/app/styles/lighthouse.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,16 @@ body {
margin: 0 auto;
}

.button--report-error {
background: rgba(239, 83, 80, 0.81);
text-decoration: none;
padding: 3px 5px;
font-size: .8em;
text-align: center;
display: inline;
margin-left: 5px;
}

.subpage {
position: fixed;
top: 0;
Expand Down Expand Up @@ -192,6 +202,16 @@ body {
line-height: 1.45;
}

.feedback-error {
background: #49525F;
position: absolute;
bottom: 10px;
left: 16px;
width: 180px;
line-height: 1.45;
font-size: .9em;
}

/* 1. scrollbar when extension is too small */
.options {
overflow: auto; /* [1] */
Expand Down