Improve EOF error messaging during CLI login flows #1093
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chris-janidlo
requested review from
aaschaer,
ada-globus,
derek-globus,
kurtmckee,
m1yag1,
MaxTueckeGlobus and
sirosen
as code owners
chris-janidlo
force-pushed
the
command-line-login-flow-manager-catch-eof
branch
from
749c51e to
001e3f5
Compare
sirosen
reviewed
Oct 24, 2024
There was a problem hiding this comment.
I actually don't recall the original use-case which we discussed that well.
I'm perfectly happy for us to wrap EOFErrors like this if it makes external consumption easier -- it makes the error specific to the SDK, so it has at least some utility.
However, I want to make sure we're clear about what the interface we're defining is, so I've left some questions with a soft suggestion for some rearrangement.
Motivated by observed issues in Compute - users can set up working Compute endpoints, change their setups slightly around access to STDIN, and then see cryptic EOF errors when they eventually need to re-auth. NB: as of the time of this commit, Compute handles this by raising an error before running login flows if the current environment does not appear to be an interactive terminal. The goal of this commit is to move that behavior to a more centralized location.
chris-janidlo
force-pushed
the
command-line-login-flow-manager-catch-eof
branch
from
001e3f5 to
9cc6d09
Compare
derek-globus
approved these changes
Oct 25, 2024
sirosen
approved these changes
Oct 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivated by observed issues in Compute - users can set up working Compute endpoints, change their setups slightly around access to STDIN, and then see cryptic EOF errors when they eventually need to re-auth.
NB: as of the time of this commit, Compute handles this by raising an error before running login flows if the current environment does not appear to be an interactive terminal. The goal of this commit is to move that behavior to a more centralized location.
📚 Documentation preview 📚: https://globus-sdk-python--1093.org.readthedocs.build/en/1093/