vsch / idea-multimarkdown

Markdown language support for IntelliJ IDEA.
https://plugins.jetbrains.com/plugin/7896-markdown-navigator
Apache License 2.0
812 stars 129 forks source link

Document parts in bug reports #852

Open xloggr opened 4 years ago

xloggr commented 4 years ago

Hi Vladimir, thank you for a great plugin!

I have a question about bug report submission from the IDE. I use PyCharm 2020.1.1, the plugin version is 3.0.201.99.

Occasionally, an error occurs in your plugin and a message appears, prompting to submit it to the plugin author. Usually I go ahead and do it, but sometimes the stack traces contain significant parts of the document I am working on. In such cases I have to clear the error, without submitting it, as my documents are confidential.

I know you have no control on how the bug reporting feature works in the IDE, but maybe it is possible to sanitize the text in the exception object before throwing it?

Thank you!

vsch commented 4 years ago

@xloggr, thank you.

Are you referring to the optional attachments in a bug report or Markdown source printed along with the stack trace?

The former is not sent if the attachment is not checked in the list. The latter is actually added to help figure out what Markdown content is causing the exception. However, this is a few dozen characters on each side of the caret position to provide content and context.

The exception to this is IDE exception when the parse tree and the document are not in sync for injected language elements. I do not have control over this since it is an IDE generated exception and content to help identify what and where for the exception.

In most cases, it is not possible to reproduce the bug or even understand under what condition it has occurred without the Markdown source to help reproduce it.

However, I understand that sometimes it is not possible to include proprietary information. In this cases I would recommend just not sending the exception.

Removing the source in all exceptions would make sending exception reports a ritual without benefit since they will not do much good in the majority of the cases.