Do not dispose dialogs on close

[tsmaeder]

What it does

Fixes #12093

The about dialog in Theia is reopened and must no be disposed on close. This PR overrides the onCloseRequest method from BaseWidget to not invoke dispose(). In order to minimize impact for clients of the API, I've added an optional parameter to the open() method that controls whether the dialog is disposed when it is closed.
This change might be breaking in the case where clients reuse dialog instances and do not rely on open() to show the dialog. In that case, they will have to dispose the dialog themselves now. That should be a very rare case, though.

Contributed on behalf of STMicroelectronics

How to test

• Open and close the about dialog at least three times. Make sure there are not messages and exceptions in the browser log.
• Test behavior of both dismissing and accepting dialogs, for example
  • ConfirmationDialog: I used the "Clear editor history" commnand
  • Add a function breapoint in the "breakpoints" view
  • Make an editor dirty and close it: there is a dialog asking whether to save
    Ensure these scenarios work correctly in the browser and Electron case.

Follow-ups

• Refactor BaseWidget lifecycle #14455

Review checklist

• As an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

• As a reviewer, I agree to behave in accordance with the review guidelines

[sdirix]

Thanks for the changes.

I tested all mentioned scenarios in the browser. There I could not see any errors.

I also tested all mentioned scenarios in Electron. There I was able to reproduce the following error when opening the about dialog multiple times: ERROR Warning: You are calling ReactDOMClient.createRoot() on a container that has already been passed to createRoot() before. Instead, call root.render() on the existing root instead if you want to update it. The other test scenarios did not produce any errors.

[tsmaeder]

@sdirix I just opened and closed (Esc) the AboutDialog in Electron 5 times in a row with now messages in the log. Where's the difference?

[sdirix]

@sdirix I just opened and closed (Esc) the AboutDialog in Electron 5 times in a row with now messages in the log. Where's the difference?

I retested and could no longer reproduce the issue. Not sure what I did different than the first time. As it could be a mistake on my side, I don't see this as a blocker no more.

---

A question before we merge the current state: Do you think it's really worth it to overwrite the close behavior of ReactDialog to satisfy this one dialog which does not behave as the others?

As an alternative we could adapt the AboutDialog to not be a singleton and then call the widgetManager.getOrCreateWidget whenever we want to show it. This would have the benefit that the AboutDialog is not preconstructed/injected when it's never even shown.

[tsmaeder]

It's not about that one dialog: by having that dialog, we're communicating that it's O.K. to reopen dialogs. The documented contract for Widget says the same thing. For clients not reopening the dialog nothing changes, since they will get the auto-dispose behaviour from the show() method. Clients reusing dialogs are already broken by the double-dispose issue. What changes is that we give clients the opportunity to correctly implement dispose if they reuse dialogs.