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

fix: get id token (await getSessionItem) #234

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

peterphanouvong
Copy link
Collaborator

@peterphanouvong peterphanouvong commented Nov 5, 2024

Explain your changes

  • fix getIdToken bug where getSessionItem wasn't being awaited

Checklist

🛟 If you need help, consider asking for advice over in the Kinde community.

Copy link
Contributor

coderabbitai bot commented Nov 5, 2024

Walkthrough

The changes in this pull request involve a modification to the getIdTokenFactory function located in src/session/getIdToken.js. The update alters the invocation of the sessionManager function to ensure that its promise is fully resolved before accessing the session item for the 'id_token'. This adjustment introduces an additional layer of awaiting, while the error handling mechanism remains unchanged.

Changes

File Change Summary
src/session/getIdToken.js Modified getIdTokenFactory to await sessionManager(req, res) before accessing getSessionItem('id_token'). Error handling remains unchanged.

Possibly related PRs

  • Next 15 support #226: The changes in this PR involve modifying the createKindeManagementAPIClient function to use an awaited call for sessionManager(req, res), which is similar to the changes made in the getIdTokenFactory function in the main PR.

Suggested reviewers

  • DaveOrDead

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
src/session/getIdToken.js (2)

21-21: LGTM! Consider improving readability.

The fix correctly ensures that both promises are properly awaited. However, the nested awaits could be more readable using an intermediate variable.

Consider this more readable alternative:

-      await (await sessionManager(req, res)).getSessionItem('id_token')
+      const session = await sessionManager(req, res);
+      await session.getSessionItem('id_token')

Line range hint 23-27: Consider enhancing error handling.

The current error handling catches all errors and returns null, which might mask specific issues. Consider differentiating between session initialization errors and token retrieval errors.

Here's a suggested improvement:

   try {
-    return jwtDecoder(
-      await (await sessionManager(req, res)).getSessionItem('id_token')
-    );
+    const session = await sessionManager(req, res);
+    const idToken = await session.getSessionItem('id_token');
+    return jwtDecoder(idToken);
   } catch (err) {
     if (config.isDebugMode) {
-      console.error(err);
+      console.error('Failed to get ID token:', {
+        error: err instanceof Error ? err.message : String(err),
+        type: err instanceof Error ? err.name : typeof err
+      });
     }
     return null;
   }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 64a28e2 and 3e19d41.

📒 Files selected for processing (1)
  • src/session/getIdToken.js (1 hunks)

@DanielRivers DanielRivers merged commit e7166b1 into main Nov 5, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants