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.

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

feat: Add error submitter for user feedback #1429

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pablomxnl
Copy link

Closes #591

It uses an issue template form, on the yaml, projects list is optional.

error_reporting_dialog

When the user clicks the Create GitHub Issue button the browser is launched and takes away the focus of the IDE.

github_issue

@angelozerr
Copy link
Contributor

Thanks so much!

@fbricon what do you think?

@fbricon
Copy link
Contributor

fbricon commented Jan 23, 2025

I'm worried this will potentially generate plenty of duplicate issues as it won't force users to check for existing issues

@pablomxnl
Copy link
Author

I'm worried this will potentially generate plenty of duplicate issues as it won't force users to check for existing issues

Understandable, for my plugins I send these errors to sentry . Perhaps maybe it would be better to capture these errors through the telemetry plugin.

@angelozerr
Copy link
Contributor

I wonder if when the issue is created we could check that a similar issue (same title) exists?

@pablomxnl
Copy link
Author

I wonder if when the issue is created we could check that a similar issue (same title) exists?

Probably using the gh api, but then would have to deal with tokens in PasswordSafe, as far as I know there is no way to configure GitHub issue workflow to search while/before creating (GitLab does it this way)

this is how the issue form would look like btw

issue_form

this is how GitLab display similar issues on the issue creation screen:
GitLab-Similar-Issues

Another option could be use a webhook on issue opened and search for similar issues and mark duplicates

@fbricon
Copy link
Contributor

fbricon commented Jan 24, 2025

according to https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#primary-rate-limit-for-unauthenticated-users:

The primary rate limit for unauthenticated requests is 60 requests per hour.

That should be more than enough for error reporting, if you cache search results for a given problem, so no need to manage tokens

@pablomxnl
Copy link
Author

interesting!!, will take a look.
I see retrofit is available as transitive dependency from the telemetry plugin,
would be ok to use that or add the dependency explicitly ??

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement ErrorReportSubmitter for better user feedback
3 participants