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: add optional chainings to handleMiddleware function to avoid raising a TypeError #166

Conversation

Seagull29
Copy link
Contributor

Adding optional chainings to avoid raising a TypeError

Since the commit 817d1b3 that was uploaded a day ago, a TypeError appeared with a simple setup of a Nextjs project and this library, specifically, by using the withAuth middleware which is used to protect routes.

The error was the following:
image

By seeing the changes made, it seems the redirectURLBase is indeed being read from an object that may be undefined; therefore, it only raises that error by using the middleware, at least, with a simple setup and use of withAuth middleware. The variable option is not always passed to the handleMiddleware, so that is why and where the error happens.

While these changes can fix the issue, perhaps other features were trying to be implemented with the usage of the variable options, so I'm not sure whether the variable options is mandatory across the global context of the project. However, since prior commits do not have that variable, I believe adding the optional chainings is enough to solve the issue as they are properly written on the same function on the lines that use the variable options.

For the record, within the handleMiddleware function, the optional chainings were missing on both return statements.

Checklist

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

…sing a TypeError
Copy link
Contributor

coderabbitai bot commented May 16, 2024

Walkthrough

The recent update enhances the robustness of the handleMiddleware function in the authMiddleware.js file. By incorporating optional chaining (?.), the code now safely accesses the redirectURLBase property within the options object. This prevents potential errors when options is undefined or null, ensuring smoother execution and more reliable URL redirection logic.

Changes

Files Change Summary
src/.../authMiddleware.js Updated to use optional chaining (?.) when accessing redirectURLBase in the handleMiddleware function.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 20cc7fe and f94bccc.
Files selected for processing (1)
  • src/authMiddleware/authMiddleware.js (2 hunks)
Additional comments not posted (5)
src/authMiddleware/authMiddleware.js (5)

Line range hint 38-38: Optional chaining added to options?.isReturnToCurrentPage.

This change ensures that the code handles cases where options might be undefined or null, preventing potential runtime errors.


Line range hint 39-39: Optional chaining added to options?.loginPage.

This change ensures that the code handles cases where options might be undefined or null, preventing potential runtime errors.


Line range hint 43-45: Optional chaining added to options?.publicPaths.

This change ensures that the code handles cases where options might be undefined or null, preventing potential runtime errors.


58-58: Optional chaining added to options?.redirectURLBase.

This change ensures that the code handles cases where options might be undefined or null, preventing potential runtime errors.


88-88: Optional chaining added to options?.redirectURLBase.

This change ensures that the code handles cases where options might be undefined or null, preventing potential runtime errors.

@oliwerhelsen
Copy link

Oh, need this 🙏

@DanielRivers DanielRivers merged commit 04adaf3 into kinde-oss:main May 17, 2024
1 check passed
peterphanouvong pushed a commit that referenced this pull request Aug 19, 2024
…gs-to-middleware

fix: add optional chainings to handleMiddleware function to avoid raising a TypeError
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.

None yet

3 participants