Show uncaughtException as an internal error and quit the app

[yuya-oc]

Before submitting, please confirm you've

• read and understood our Contributing Guidelines
• completed Mattermost Contributor Agreement
• executed npm run lint:js for proper code formatting

Please provide the following information:

Summary
When an uncaught error occurred, the error log is saved to AppData\Roaming\Mattermost\uncaughtException-*.txt. Then a dialog would pop up to notice it.

When the user click "Show detail", the file is opened in the default text editor.

Application: Mattermost 3.7.1
Platform: Windows_NT 10.0.15063 x64
Error: test error
    at Timeout.setTimeout [as _onTimeout] (C:\Users\yuya-oc\git\mattermost-desktop\src\main_bundle.js:7781:11)
    at ontimeout (timers.js:386:14)
    at tryOnTimeout (timers.js:250:5)
    at Timer.listOnTimeout (timers.js:214:5)

Usually the error is unrecoverable, so the application should finish soon.
https://nodejs.org/api/process.html#process_warning_using_uncaughtexception_correctly

Issue link
#625

Test Cases

• General use cases. The error should NOT appear.
• Check text messages.

Additional Notes
CircleCI is delaying...

[jasonblais]

@yuya-oc Do you want me to test something here? Also, do we currently show this error dialog, or is this adding it?

[yuya-oc]

@jasonblais Like Electron upgrading, please use for several days. The dialog should not appear frequently. https://circleci.com/gh/yuya-oc/desktop/438#artifacts

Currently the application shows such errors only in command line console. So users can't know them even when a critical error happens. Then the application continues to work at such bad situation without quitting.

[jasonblais]

Sounds good, I'll use the app and post here if there are any issues.

What, if any, can we change for the dialog design and text?

[yuya-oc]

We can change texts, button labels, icon and misc things (see dialog.showMessageBox()). The event handler must behave as a synchronous function. In this case, only dialog.showMessageBox() and dialog.showErrorBox() are applicable.

[MusikPolice]

Looks good to me, although I think we should make the visual design a little less windows-centric. Seeing as this is a cross platform application, we may have to design our own look and feel so that the dialog appears natural on all platforms.

[jasonblais]

@MusikPolice Yeah, we'll have Asaad's help with UI mockups for this, #609 and #611

[yuya-oc]

Thanks for reviewing. Electron's dialog.showMessageBox() uses native modal dialog for each platform. Samples are below.

macOS:

Ubuntu 16.04

[MusikPolice]

@yuya-oc the native modal looks perfect.

[yuya-oc]

@jasonblais Are there any feedback?

[jasonblais]

@yuya-oc is there a way for the user to reopen the app via this dialog? E.g. something like attached

[jasonblais]

@yuya-oc, here are the proposed text changes:

Title: Mattermost
Text: The Mattermost app quit unexpectedly. Click “Show Details” to learn more. \n\n Internal error: {error}
Buttons: “Show Details” / “OK”

where \n represents a new line

2. For Windows, can we have "Show Details" as a button next to "OK"?

3. What is the (O) on the Linux screenshot next to OK, is that standard?

4. Can the app be reopened via this dialog? (Not needed now, wondering if this can be accomplished later)

---

After the changes, it would be great to have a screenshot for Windows and Mac and I'll get final sign-off from our UI team.

[yuya-oc]

1. A whitespace exists after \n\n. Is it intended?
2. Yes.
3. (O) is added by Electron, so I think it's commonly used. I will check other apps.
4. Possible.

Unfortunately I found an important issue for this. On Windows, it seems the app can't show the dialog when a problem actually happens. However strangely, if the app is launched from command line, the dialog properly appears. So I couldn't notice the problem in dev mode. I need to inspect Electron.

[jasonblais]

@yuya-oc

1 - Unintentional. Should read The Mattermost app quit unexpectedly. Click “Show Details” to learn more.\n\n Internal error: {error}

4 - Let me know and I can create a ticket for later

Unfortunately I found an important issue for this. On Windows, it seems the app can't show the dialog when a problem actually happens. However strangely, if the app is launched from command line, the dialog properly appears. So I couldn't notice the problem in dev mode. I need to inspect Electron.

I see. We can also create a separate ticket for Windows for later.

[yuya-oc]

@jasonblais Updated texts. https://circleci.com/gh/yuya-oc/desktop/467#artifacts

3. I checked Gedit, the default text editor of Ubuntu desktop. It shows brackets for each button. Unfortunately Electron doesn't do that automatically.

4. It's easy by calling app.relaunch() when the button is pressed.

I didn't write in the previous comment though, the problem means that the app silently finishes if a problem actually happened. Is it acceptable? Of course, the report file is written in the data directory.

[jasonblais]

1/2: Great! Thanks Yuya
3: Okay. I think this is okay for now, since fewer people use Linux.
4: > It's easy by calling app.relaunch() when the button is pressed.

Is this something we want to consider for this PR, or do I create an improvement ticket for later?

---

I didn't write in the previous comment though, the problem means that the app silently finishes if a problem actually happened. Is it acceptable? Of course, the report file is written in the data directory.

Will the user see the dialog?

[yuya-oc]

@jasonblais
4. We can consider it in this PR. However in that case, we need to consider the order of buttons. For example, Show detail, OK, Reopen like macOS?

I didn't write in the previous comment though, the problem means that the app silently finishes if a problem actually happened. Is it acceptable? Of course, the report file is written in the data directory.

It was my misunderstanding. The actual problem was to call fs.writeFileSync(2). So I removed that statement. Now this PR works on all platforms.

[jasonblais]

@yuya-oc
4. Yeah, that would be great. Agree on order, let's have it Show Details / OK / Reopen. (Note that both words in Show Details should be capitalized.)

If we add it, propose we modify the text to The Mattermost app quit unexpectedly. Click “Show Details” to learn more or "Reopen" to open the application again.\n\n Internal error: {error}

[yuya-oc]

Updated: https://circleci.com/gh/yuya-oc/desktop/477#artifacts

Test build: https://circleci.com/gh/yuya-oc/desktop/480#artifacts This build shows a test error 10 seconds later.

macOS:

Ubuntu:

[jasonblais]

Looks great, thanks @yuya-oc! Good to merge