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

Update the "Send a bug report" window to use GitHub #114

Open
SuzanneSoy opened this issue May 17, 2017 · 11 comments
Open

Update the "Send a bug report" window to use GitHub #114

SuzanneSoy opened this issue May 17, 2017 · 11 comments
Assignees

Comments

@SuzanneSoy
Copy link
Contributor

The "Send a bug report" window uses http://bugs.racket-lang.org/, which seems to be the old bug tracker (and GitHub is preferred nowadays).

The submit code should be updated to use GitHub instead.

It would be possible to either open https://github.com/racket/REPO/issues/new?title=foo&body=bar in the user's browser, or use the GitHub API to directly submit the bug (this would however likely require that the user has a GitHub account).

@bennn
Copy link
Contributor

bennn commented May 17, 2017

(this would however likely require that the user has a GitHub account)

I think we could make a "DrRacket User" account on GitHub, and Dr.Racket could store whatever auth keys GitHub requires.

@SuzanneSoy
Copy link
Contributor Author

Wouldn't this have a high risk of being hijacked and the account misused?

I'd say disclosing the account's OAuth token or other API key would be unwise, unless GitHub's permission system is fine-grained enough to get a token which only allows submitting bugs for a small set of repositories.

We could however have a minimal server which just accepts a title and body string, and posts it as an issue on one of the allowed repos on the user's behalf. The difference is that keys would be stored on the server and not disclosed. I'm just making guesses here, though.

@rfindler
Copy link
Member

I think that something inside DrRacket that directs someone to a relevant github page (and maybe a FAQ page about issues that we make on our wiki?) is sufficient.

@SuzanneSoy
Copy link
Contributor Author

SuzanneSoy commented May 17, 2017

GitHub's issue templates can also be used if we want to make sure some information is filled in by the template (like is done for the TR repo).

Although @samth said (racket/racket#1695 (comment)) that there is something in the works.

@samth
Copy link
Member

samth commented May 18, 2017 via email

@LeifAndersen
Copy link
Member

I think that something inside DrRacket that directs someone to a relevant github page (and maybe a FAQ page about issues that we make on our wiki?) is sufficient.

How many people using the submit a bug tool actually have github accounts though? And creating one may be a large barrier to entry for new users to submit a bug.

@rfindler
Copy link
Member

Yes, I agree this a concern. When compared with the alternatives, however, I think it is the best option we have.

The wiki page could also suggest posting on our mailing list, which has a lower barrier to entry, and helpful people who would, I expect, either submit issues or explain how to.

@LeifAndersen
Copy link
Member

Fair concern. What about using something like this?: https://gitreports.com/

Then we can have github issues without managing our own server or requiring users to log in.

@SuzanneSoy
Copy link
Contributor Author

@LeifAndersen https://gitreports.com/ looks like a great solution. Two minor itches:

  • The captcha is not accessible to ill-sighted & blind people (sigh)
  • gitreports needs full write access to all the user or organisation's repo. Given the perks (possibility to inject code into Rakcet and other projects), gitreports seems like a reasonably attractive target, so it makes me a bit weary. Granting gitreports access to an isues-only repo (in a separate organisation, say racket-issues) seems an option, but as @samth said on IRC, having an issues-only repo might not be a good fit for Racket.

@LeifAndersen
Copy link
Member

Regarding your first point...ugg...I didn't notice the captcha. I'll file a bug report with that repo, they realliy should have a low vision option.

@spdegabrielle
Copy link
Member

Hi,

I believe the current situation is worse than users having to create a GitHub account.

While a perfect solution is being developed, I have created an interim solution using the default 'submit bug report' template.

This required two actions
a) a bug report template for racket/racket. See PR for proposed template racket/racket#3031
b) change menu in DrRacket to link to new bug report e.g. https://github.com/spdegabrielle/racket/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D+

As there are already existing examples of this I believe (b) could be a good first issue for someone interested in DrRacket .

I note that the title is passed as a parameter - this is worth investigating to see if some environment details can be passed this way, as per the old bug report mechanism.

Kind regards,

Stephen


Current situation if user attempts to us the submit bug via the help screen;

User fills in form, presses submit, after a long wait the following error is returned;

ERROR:
tcp-connect: connection failed
address: bugs.racket-lang.org
port number: 80
system error: Operation timed out; errno=60
(http-conn-open!10 . #(struct:srcloc #pplications/Racket v7.5/collects/net/http-client.rkt> 67 0 1446 2166))
(#f . #(struct:srcloc #pplications/Racket v7.5/collects/net/http-client.rkt> 272 0 9123 269))
(#f . #(struct:srcloc #pplications/Racket v7.5/collects/racket/contract/private/arrow-val-first.rkt> 555 3 23822 3167))
(http://getpost-impure-port . #(struct:srcloc #pplications/Racket v7.5/collects/net/url.rkt> 201 0 7433 1092))
(getpost-pure-port . #(struct:srcloc #pplications/Racket v7.5/collects/net/url.rkt> 271 0 10246 1055))
(#f . #(struct:srcloc #pplications/Racket v7.5/collects/racket/contract/private/arrow-val-first.rkt> 555 3 23822 3167))
(.../more-scheme.rkt:261:28 . #f)

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

No branches or pull requests

6 participants