Run Gateway token renewers even if the auth token is empty. #1340
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
Prior to the `2.8.0` release, Gateway token renewers would be run regardless of the value of the initial auth token configured with the Gateway client. However, that initial value could potentially be `None`, and token renewers are not required to support that as a value for their `auth_token` parameter. This meant that token renewers might be called with a value they do not support. The `2.8.0` release fixed that issue by only calling token renewers if the `auth_token` value was truthy. However, this introduced a regression because the default value for auth tokens is the empty string, which is not truthy but which *is* a valid string value (and, as such, is expected to be supported by token renewers). This change fixes that by calling token renewers as long as the `auth_token` value is not `None`. This is a compromise between the pre-2.8.0 behavior and the 2.8.0 behavior, and is believed to be the least disruptive option. This fixes jupyter-server#1339
for more information, see https://pre-commit.ci
|
@Zsailer Here's the PR that we discussed at today's community meeting. |
kevin-bates
approved these changes
Oct 22, 2023
There was a problem hiding this comment.
Hey @ojarjur - These changes look good (and straightforward) to me. Thank you for dealing with this!
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.
Prior to the
2.8.0release, Gateway token renewers would be run regardless of the value of the initial auth token configured with the Gateway client.However, that initial value could potentially be
None, and token renewers are not required to support that as a value for theirauth_tokenparameter. This meant that token renewers might be called with a value they do not support.The
2.8.0release fixed that issue by only calling token renewers if theauth_tokenvalue was truthy. However, this introduced a regression because the default value for auth tokens is the empty string, which is not truthy but which is a valid string value (and, as such, is expected to be supported by token renewers).This change fixes that by calling token renewers as long as the
auth_tokenvalue is notNone. This is a compromise between the pre-2.8.0 behavior and the 2.8.0 behavior, and is believed to be the least disruptive option.This fixes #1339