feat: add jwks caching

[DanielRivers]

Explain your changes

feat: adds caching to so doesn't need to over request the JWSK from the well knowns

Checklist

• I have read the “Pull requests” section in the contributing guidelines.
• I agree to the terms within the code of conduct.

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

[coderabbitai]

Warning

Rate limit exceeded

@DanielRivers has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 50 minutes and 18 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 93bac2e and 5be5858.

Walkthrough

The changes introduce enhanced JWT verification by incorporating a cache for JSON Web Key Sets (JWKS). This involves fetching and caching JWKS to optimize verification processes and optionally forcing JWKS fetches. The tests have been updated to validate this caching mechanism and ensure proper functionality.

Changes

Files	Change Summary
lib/main.test.ts	Added import for utils, utilized a spy on getJWKS, validated token verification, and JWKS cache.
lib/main.ts	Enhanced JWT verification with optional JWKS fetch and caching, added types and utility functions.
lib/utils.ts	Introduced functionality to handle JWKS retrieval and caching.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant Main
    participant Utils
    participant JWKSProvider

    Client->>Main: verifyJwt(token, domain, forceJWKSFetch)
    alt forceJWKSFetch is true or JWKS not cached
        Main->>Utils: getJWKS(domain)
        Utils->>JWKSProvider: Fetch JWKS
        JWKSProvider-->>Utils: Return JWKS
        Utils-->>Main: Return JWKS
        Main->>Main: Cache JWKS
    else JWKS cached
        Main->>Main: Retrieve JWKS from cache
    end
    Main->>Main: Verify token using JWKS
    Main-->>Client: jwtValidationResponse

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[coderabbitai]

Actionable comments posted: 1

Outside diff range and nitpick comments (2)

lib/main.ts (1)

12-30: The implementation of verifyJwt function with caching and force fetching is correct. Consider adding comments to explain the caching logic and the recursive call mechanism for better maintainability.

lib/main.test.ts (1)

85-106: The test case for caching JWKS correctly sets up the scenario and verifies the behavior. Consider adding assertions to ensure that the correct JWKS is used from the cache during the validation process.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 86ecc87 and 93bac2e.

Files ignored due to path filters (1)

• package.json is excluded by !**/*.json

Files selected for processing (3)

• lib/main.test.ts (2 hunks)
• lib/main.ts (2 hunks)
• lib/utils.ts (1 hunks)

Additional comments not posted (3)

lib/utils.ts (1)

5-7: The implementation of getJWKS function looks correct and efficient.

lib/main.ts (2)

1-2: The imports and type declarations are correctly implemented and necessary for JWT verification functionality.

---

Line range hint 32-50: The validateToken function is well-implemented, handling edge cases for missing token or domain effectively.

[codecov]

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️