feat: expose refreshTokens method #56
Conversation
WalkthroughThe recent update enhances token management by allowing token refreshing through the newly added Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (5)
- lib/sdk/clients/browser/authcode-with-pkce.ts (2 hunks)
- lib/sdk/clients/server/authorization-code.ts (2 hunks)
- lib/sdk/oauth2-flows/AuthCodeAbstract.ts (1 hunks)
- lib/sdk/oauth2-flows/AuthCodeWithPKCE.ts (1 hunks)
- lib/sdk/oauth2-flows/AuthorizationCode.ts (1 hunks)
Additional comments: 3
lib/sdk/oauth2-flows/AuthorizationCode.ts (1)
- 59-59: Making the
refreshTokensmethod public enables external access for token refreshing. Consider adding documentation to clarify its usage and any potential implications for security or design.lib/sdk/oauth2-flows/AuthCodeWithPKCE.ts (1)
- 74-74: Making the
refreshTokensmethod public enables external access for token refreshing. Consider adding documentation to clarify its usage and any potential implications for security or design.lib/sdk/oauth2-flows/AuthCodeAbstract.ts (1)
- 78-78: Making the
refreshTokensmethod public inAuthCodeAbstractenables subclasses to expose token refreshing functionality. Consider adding documentation to clarify its usage and any potential implications for security or design.
| /** | ||
| * Method makes user of the `refreshTokens` method of the `AuthCodeAbstract` client | ||
| * to use the refresh token to get new tokens | ||
| * @param {SessionManager} sessionManager | ||
| * @returns {Promise<OAuth2CodeExchangeResponse>} | ||
| */ | ||
| const refreshTokens = async (sessionManager: SessionManager): Promise<string> => { | ||
| return await client.refreshTokens(sessionManager); | ||
| }; |
There was a problem hiding this comment.
The return type of the refreshTokens method is incorrectly documented as Promise<string> when it should be Promise<OAuth2CodeExchangeResponse> to match the expected return type of the AuthCodeAbstract client's refreshTokens method.
- const refreshTokens = async (sessionManager: SessionManager): Promise<string> => {
+ const refreshTokens = async (sessionManager: SessionManager): Promise<OAuth2CodeExchangeResponse> => {Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| /** | |
| * Method makes user of the `refreshTokens` method of the `AuthCodeAbstract` client | |
| * to use the refresh token to get new tokens | |
| * @param {SessionManager} sessionManager | |
| * @returns {Promise<OAuth2CodeExchangeResponse>} | |
| */ | |
| const refreshTokens = async (sessionManager: SessionManager): Promise<string> => { | |
| return await client.refreshTokens(sessionManager); | |
| }; | |
| /** | |
| * Method makes user of the `refreshTokens` method of the `AuthCodeAbstract` client | |
| * to use the refresh token to get new tokens | |
| * @param {SessionManager} sessionManager | |
| * @returns {Promise<OAuth2CodeExchangeResponse>} | |
| */ | |
| const refreshTokens = async (sessionManager: SessionManager): Promise<OAuth2CodeExchangeResponse> => { | |
| return await client.refreshTokens(sessionManager); | |
| }; |
|
|
||
| /** | ||
| * Method makes user of the `refreshTokens` method of the `AuthCodeWithPKCE` client | ||
| * to use the refresh token to get new tokens | ||
| * @param {SessionManager} sessionManager | ||
| * @returns {Promise<OAuth2CodeExchangeResponse>} | ||
| */ | ||
| const refreshTokens = async (sessionManager: SessionManager): Promise<string> => { | ||
| return await client.refreshTokens(sessionManager); | ||
| }; |
There was a problem hiding this comment.
The return type of the refreshTokens method is incorrectly documented as Promise<string> when it should be Promise<OAuth2CodeExchangeResponse> to match the expected return type of the AuthCodeWithPKCE client's refreshTokens method.
- const refreshTokens = async (sessionManager: SessionManager): Promise<string> => {
+ const refreshTokens = async (sessionManager: SessionManager): Promise<OAuth2CodeExchangeResponse> => {Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| /** | |
| * Method makes user of the `refreshTokens` method of the `AuthCodeWithPKCE` client | |
| * to use the refresh token to get new tokens | |
| * @param {SessionManager} sessionManager | |
| * @returns {Promise<OAuth2CodeExchangeResponse>} | |
| */ | |
| const refreshTokens = async (sessionManager: SessionManager): Promise<string> => { | |
| return await client.refreshTokens(sessionManager); | |
| }; | |
| /** | |
| * Method makes user of the `refreshTokens` method of the `AuthCodeWithPKCE` client | |
| * to use the refresh token to get new tokens | |
| * @param {SessionManager} sessionManager | |
| * @returns {Promise<OAuth2CodeExchangeResponse>} | |
| */ | |
| const refreshTokens = async (sessionManager: SessionManager): Promise<OAuth2CodeExchangeResponse> => { | |
| return await client.refreshTokens(sessionManager); | |
| }; |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (2)
- lib/sdk/clients/browser/authcode-with-pkce.ts (3 hunks)
- lib/sdk/clients/server/authorization-code.ts (3 hunks)
Additional comments: 2
lib/sdk/clients/server/authorization-code.ts (1)
- 137-145: The
refreshTokensmethod is correctly implemented, making use of therefreshTokensmethod from theAuthCodeAbstractclient. This aligns with the PR objectives to expose therefreshTokensmethod for improved token management.However, ensure that error handling is robust around this method call, especially considering token refresh scenarios can often fail due to various reasons such as network issues or expired refresh tokens.
lib/sdk/clients/browser/authcode-with-pkce.ts (1)
- 272-279: The
refreshTokensmethod is correctly implemented, making use of therefreshTokensmethod from theAuthCodeWithPKCEclient. This aligns with the PR objectives to expose therefreshTokensmethod for improved token management.However, ensure that error handling is robust around this method call, especially considering token refresh scenarios can often fail due to various reasons such as network issues or expired refresh tokens.
|
@coderabbitai review |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (2)
- lib/sdk/clients/browser/authcode-with-pkce.ts (3 hunks)
- lib/sdk/clients/server/authorization-code.ts (3 hunks)
Files skipped from review as they are similar to previous changes (2)
- lib/sdk/clients/browser/authcode-with-pkce.ts
- lib/sdk/clients/server/authorization-code.ts
coel
dismissed
coderabbitai[bot]’s stale review
Request changes were resolved, but seemingly not automatically re-reviewed.
Explain your changes
refreshTokensmethodSuppose there is a related issue with enough detail for a reviewer to understand your changes fully. In that case, you can omit an explanation and instead include either “Fixes #XX” or “Updates #XX” where “XX” is the issue number.
Checklist
🛟 If you need help, consider asking for advice over in the Kinde community.
Summary by CodeRabbit