Sunpy/opsu-dance
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

let users copy the whole error before reporting issue

Browse Source
This commit is contained in:
yugecin 2018-10-02 22:16:27 +02:00
parent a29b70c32c
commit 246b1274a6
No known key found for this signature in database
GPG Key ID: 2C5AC035A7068E44
1 changed files with 84 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
src/yugecin/opsudance/core/errorhandling/ErrorHandler.java
View File

@ -24,6 +24,11 @@ import yugecin.opsudance.utils.MiscUtils;
import javax.swing.*; import javax.swing.*;
import java.awt.Desktop; import java.awt.Desktop;
import java.awt.Dialog.ModalityType;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.Window;
import java.awt.Cursor; import java.awt.Cursor;
import java.awt.event.ActionEvent; import java.awt.event.ActionEvent;
import java.awt.event.ActionListener; import java.awt.event.ActionListener;
@ -94,31 +99,15 @@ public class ErrorHandler {
} }
JLabel message = new JLabel(messageText); JLabel message = new JLabel(messageText);
JTextArea textArea = new JTextArea(15, 100);
textArea.setEditable(false);
textArea.setBackground(UIManager.getColor("Panel.background"));
textArea.setCursor(Cursor.getPredefinedCursor(Cursor.TEXT_CURSOR));
textArea.setTabSize(2);
textArea.setLineWrap(false);
textArea.setWrapStyleWord(true);
textArea.setFont(message.getFont());
textArea.setText(messageBody);
ActionListener reportAction = new ActionListener() { ActionListener reportAction = new ActionListener() {
@Override @Override
public void actionPerformed(ActionEvent event) { public void actionPerformed(ActionEvent event) {
try { Window parent = SwingUtilities.getWindowAncestor(message);
URI url = createGithubIssueUrl(customMessage, cause, errorDump); showCreateIssueDialog(parent, errorDump, customMessage, cause);
Desktop.getDesktop().browse(url);
} catch (IOException e) {
Log.warn("Could not open browser to report issue", e);
JOptionPane.showMessageDialog(null, "whoops could not launch a browser",
"errorception", JOptionPane.ERROR_MESSAGE);
}
} }
}; };
Object[] messageComponents = new Object[] { message, new JScrollPane(textArea), createViewLogButton(), Object[] messageComponents = new Object[] { message, readonlyTextarea(messageBody), createViewLogButton(),
createReportButton(flags, reportAction) }; createReportButton(flags, reportAction) };
String[] buttons; String[] buttons;
@ -182,8 +171,71 @@ public class ErrorHandler {
button.setEnabled(false); button.setEnabled(false);
return button; return button;
} }
private static void showCreateIssueDialog(
Window parent,
String errorDump,
String customMessage,
Throwable cause)
{
final String dump = createIssueDump(customMessage, cause, errorDump);
private static URI createGithubIssueUrl(String customMessage, Throwable cause, String errorDump) { final String title = "report error";
JDialog d = new JDialog(parent, title, ModalityType.APPLICATION_MODAL);
d.setLayout(new GridBagLayout());
final GridBagConstraints c = new GridBagConstraints();
c.gridx = 1;
c.gridy = 1;
c.weightx = 1d;
c.weighty = 0d;
c.fill = GridBagConstraints.BOTH;
c.insets = new Insets(4, 8, 4, 8);
d.add(new JLabel(
"<html>Copy the text in the box below.<br/>"
+ "Then click the button below.<br/>"
+ "Your browser should open a page where you can report the issue.<br/>"
+ "Please paste the dump below in the issue box."
), c);
c.gridy++;
c.weighty = 1d;
d.add(readonlyTextarea(dump), c);
c.gridy++;
c.weighty = c.weightx = 0d;
c.fill = GridBagConstraints.NONE;
JButton btn = new JButton("Report");
btn.addActionListener(e -> {
try {
URI url = createGithubIssueUrl(customMessage, cause);
Desktop.getDesktop().browse(url);
d.dispose();
} catch (IOException t) {
Log.warn("Could not open browser to report issue", t);
JOptionPane.showMessageDialog(null, "whoops could not launch a browser",
"errorception", JOptionPane.ERROR_MESSAGE);
}
});
d.add(btn, c);
d.pack();
d.setLocationRelativeTo(parent);
d.setVisible(true);
}
private static URI createGithubIssueUrl(String customMessage, Throwable cause) {
String issueTitle = "";
String issueBody = "";
try {
issueTitle = URLEncoder.encode("*** Unhandled " + cause.getClass().getSimpleName() + ": " +
customMessage, "UTF-8");
issueBody = URLEncoder.encode("PASTE THE DUMP HERE", "UTF-8");
} catch (UnsupportedEncodingException e) {
Log.warn("URLEncoder failed to encode the auto-filled issue report URL.", e);
}
return URI.create(String.format(Constants.ISSUES_URL, issueTitle, issueBody));
}
private static String createIssueDump(String customMessage, Throwable cause, String errorDump) {
StringWriter dump = new StringWriter(); StringWriter dump = new StringWriter();
dump.append(customMessage).append("\n"); dump.append(customMessage).append("\n");
@ -204,25 +256,19 @@ public class ErrorHandler {
dump.append("**info dump**").append('\n'); dump.append("**info dump**").append('\n');
dump.append("```\n").append(errorDump).append("\n```\n\n"); dump.append("```\n").append(errorDump).append("\n```\n\n");
return dump.toString();
String issueTitle = "";
String issueBody = "";
try {
issueTitle = URLEncoder.encode("*** Unhandled " + cause.getClass().getSimpleName() + " " +
customMessage, "UTF-8");
issueBody = URLEncoder.encode(truncateGithubIssueBody(dump.toString()), "UTF-8");
} catch (UnsupportedEncodingException e) {
Log.warn("URLEncoder failed to encode the auto-filled issue report URL.", e);
}
return URI.create(String.format(Constants.ISSUES_URL, issueTitle, issueBody));
} }
private static String truncateGithubIssueBody(String body) { private static JComponent readonlyTextarea(String contents) {
if (body.replaceAll("[^a-zA-Z+-]", "").length() < 1750) { JTextArea textArea = new JTextArea(15, 100);
return body; textArea.setEditable(false);
} textArea.setBackground(UIManager.getColor("Panel.background"));
Log.warn("error dump too long to fit into github issue url, truncating"); textArea.setCursor(Cursor.getPredefinedCursor(Cursor.TEXT_CURSOR));
return body.substring(0, 1640) + "** TRUNCATED **\n```"; textArea.setTabSize(2);
textArea.setLineWrap(false);
textArea.setWrapStyleWord(true);
textArea.setFont(new JLabel().getFont());
textArea.setText(contents);
return new JScrollPane(textArea);
} }
} }