Fix: Blocking background OIDC token refresh #33
Merged
Conversation
This file contains hidden or 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
dirkkul
reviewed
Apr 4, 2023
| basedOnProperties: this.basedOnProperties, | ||
| }); | ||
|
|
||
| pollForCompletion = (id: any): Promise<Classification> => { |
There was a problem hiding this comment.
Why does classifcation have its own timeout check?
There was a problem hiding this comment.
This has been in the client for a long time. This is the implementation of an option which tells the client to block until classification is complete.
src/connection/auth.ts
Outdated
| this.clientSecret = creds.clientSecret; | ||
| this.scopes = creds.scopes; | ||
| // Silent token refresh by default | ||
| if (creds.silentRefresh === undefined) { |
There was a problem hiding this comment.
just to be sure:
This means that this parameter is not required and this is not a breaking change?
There was a problem hiding this comment.
Right, if silentRefresh is not provided, the behavior is unchanged, in that silent refresh will run in the background
…escript-client into fix/oidc-background-refresh
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.
A
setIntervalis used to run a background OIDC token refresh, but ends up blocking a script from exiting due to the interval never being cleared.This PR adds two changes to surmount this issue:
client.oidcAuth?.stopTokenRefresh()method which should be used whenever a script is expected to exit, or it is otherwise determined that token refresh is no longer neededsilentRefresh?: booleanargument to each of the OIDC credential inputs, includingAuthClientCredentials,AuthUserPasswordCredentials, andAuthAccessTokenCredentials. This currently defaults totrueif not set, as this is likely the expected behavior for most users.Closes #30