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

Peter/fix/istokenvalid check audience #189

Merged
merged 3 commits into from
Jul 22, 2024

Conversation

peterphanouvong
Copy link
Collaborator

@peterphanouvong peterphanouvong commented Jul 11, 2024

Explain your changes

  • fix isTokenValid audience check which was breaking when audience was an array and middleware was being used
  • include middleware in playground
  • update the type of KindeAccessToken to include exp

Checklist

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

Copy link
Contributor

coderabbitai bot commented Jul 11, 2024

Walkthrough

The recent changes include adjustments to the import statements, string formatting, and property assignments in various files. The middleware.ts file was streamlined to import only withAuth, and string values in the config object now use single quotes. The audience property in src/config/index.js was modified to split based on space if a value exists, enhancing flexibility and handling. Additionally, the isTokenValid function was updated to use the spread operator for audience validation, and the KindeAccessToken type received a new exp field.

Changes

File Change Summary
playground/src/middleware.ts Imported only withAuth and switched string values in config to single quotes.
src/config/index.js Modified audience property to split KINDE_AUDIENCE by space if it exists, otherwise empty.
src/utils/pageRouter/isTokenValid.js Updated the isTokenValid function to use the spread operator for audience validation.
types.d.ts Added exp field of type number to the KindeAccessToken type.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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, codebase verification and nitpick comments (1)
src/utils/pageRouter/isTokenValid.js (1)

14-14: LGTM! But consider using optional chaining for safety.

The change correctly uses the spread operator to handle audience checks when config.audience is an array. However, using optional chaining can make the code more robust.

- accessTokenPayload.aud.includes(...config.audience);
+ accessTokenPayload.aud?.includes(...config.audience);
Tools
Biome

[error] 13-14: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 999dda6 and 8d0332f.

Files selected for processing (4)
  • playground/src/middleware.ts (1 hunks)
  • src/config/index.js (1 hunks)
  • src/utils/pageRouter/isTokenValid.js (1 hunks)
  • types.d.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • playground/src/middleware.ts
Additional context used
Biome
src/utils/pageRouter/isTokenValid.js

[error] 13-14: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

Additional comments not posted (2)
src/config/index.js (1)

72-72: LGTM!

The change ensures that the audience property is correctly set as an array of strings when KINDE_AUDIENCE is a space-separated string. This improves the flexibility and robustness of the configuration.

types.d.ts (1)

15-15: LGTM!

The addition of the exp property to the KindeAccessToken type is appropriate and ensures that the type accurately reflects the structure of the access token.

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.

1 participant