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

ResolutionTooDeep error message #8380

Closed
ei8fdb opened this issue Jun 2, 2020 · 12 comments
Closed

ResolutionTooDeep error message #8380

ei8fdb opened this issue Jun 2, 2020 · 12 comments
Assignees
Labels
UX User experience related

Comments

@ei8fdb
Copy link
Contributor

ei8fdb commented Jun 2, 2020

Work-in-progress.

What's the problem this feature will solve?

Describe the solution you'd like

First solution will be:

  • write short message to include a link adding "please report this to the pip issue tracker" prompt to the error message"

Alternative Solutions

Additional context

Real life cases of ResolutionTooDeep - #8204, #8316, #8314, #8290,

@triage-new-issues triage-new-issues bot added the S: needs triage Issues/PRs that need to be triaged label Jun 2, 2020
@ei8fdb ei8fdb added the UX User experience related label Jun 3, 2020
@triage-new-issues triage-new-issues bot removed the S: needs triage Issues/PRs that need to be triaged label Jun 3, 2020
@ei8fdb
Copy link
Contributor Author

ei8fdb commented Jun 11, 2020

Due to parameter changes, the priority coming up with a ResolutionTooDeep error message has been reduced. I'm going to keep this on the back-burner and will get back to it.

@nlhkabu
Copy link
Member

nlhkabu commented Jun 17, 2020

I'm thinking something like this might work:

Error: ResolutionTooDeep
Pip has timed out while trying to install your package dependencies. Please open an issue on the pip issue tracker to report this error: https://github.com/pypa/pip/issues/

Would be nice here to link to the resolver error message template, but the URL is very long:
https://github.com/pypa/pip/issues/new?labels%5B%5D=K%3A+UX&labels%5B%5D=K%3A+crash&labels%5B%5D=C%3A+new+resolver&labels%5B%5D=C%3A+dependency+resolution&template=resolver-failure.md

@ei8fdb suggested that we might be able to use GitHub's URL shortener, but we'd want to check that users trust it.

fyi @uranusjr

@uranusjr
Copy link
Member

uranusjr commented Jun 17, 2020

The message looks good to me in general, except “timed out” could potentially be misleading since it sounds like a networking term to me. Maybe change it to something more vague like pip has spent too long while…?

It seems that this URL also points to the error message template. Would it be short enough? Or maybe we can set up some kind of URL shortener service for this. https://github.com/pypa/pip/issues/new?template=resolver-failure.md

@pradyunsg
Copy link
Member

pradyunsg commented Jun 17, 2020

GitHub's URL shortener

https://git.io/


One point I'd flag is "Timed out" and "Too long" seems to imply time is the factor for determining when to stop, whereas I think we should say something like "tried too many package versions" instead.

@nlhkabu
Copy link
Member

nlhkabu commented Jun 17, 2020

🤔 A few options:

Error: ResolutionTooDeep
Pip has tried too many package versions while trying to install your package dependencies. Please open an issue on the pip issue tracker to report this error: https://git.io/Jfdrd

Error: ResolutionTooDeep
Pip has spent too much computing power while trying to install your package dependencies. Please open an issue on the pip issue tracker to report this error: https://git.io/Jfdrd

Error: ResolutionTooDeep
Pip has tried and failed too many times while trying to install your package dependencies. Please open an issue on the pip issue tracker to report this error: https://git.io/Jfdrd

Error: ResolutionTooDeep
Pip has failed too many times while trying to install compatible versions of your package dependencies. Please open an issue on the pip issue tracker to report this error: https://git.io/Jfdrd

I think the last one is probably most accurate. what do you think?

@uranusjr
Copy link
Member

All of the options sound good to me.

@nlhkabu
Copy link
Member

nlhkabu commented Jun 21, 2020

@ei8fdb do you have a preference here?

@pradyunsg
Copy link
Member

First and last work well for me. OK with the third. :)

@nlhkabu
Copy link
Member

nlhkabu commented Jun 22, 2020

Taking an executive decision here. If there are no strong objections, we will go with a more concise edit of version 4:

Error: ResolutionTooDeep
Pip has failed too many times while trying to install compatible package versions. Please open an issue on the pip issue tracker to report this error: https://git.io/Jfdrd

Next steps:

  • Make PR
  • UX team to test message with users to make sure they trust the link shortener

@ei8fdb
Copy link
Contributor Author

ei8fdb commented Jun 24, 2020

UX team to test message with users to make sure they trust the link shortener

I'll do some research on this. I hope to get initial answers by end of week (26th June).

@brainwane
Copy link
Contributor

Per a meeting earlier this month, we've now improved the error message and the current behavior is acceptable for the pip 20.3 release. There's still room for improvement, so I'm leaving the issue open, but I've removed it from the list of blockers for pip 20.3.

@pradyunsg
Copy link
Member

Closing this out, since we don't see any more user reports of people hitting this.

I think we've made significant improvements to the resolver since we had this, and this is no longer a concern. If we see users hitting this in the future, I think it'd be useful to look at this again with the details of the situation from an actual user hitting this.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
UX User experience related
Projects
None yet
Development

No branches or pull requests

5 participants