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

🐛 Handle missing session #1456

Merged
merged 1 commit into from
Dec 3, 2024
Merged

🐛 Handle missing session #1456

merged 1 commit into from
Dec 3, 2024

Conversation

lukevella
Copy link
Owner

@lukevella lukevella commented Dec 3, 2024

Summary by CodeRabbit

  • New Features

    • Implemented session validation, redirecting users to the "/login" page if not authenticated.
  • Bug Fixes

    • Improved user experience by ensuring only authenticated users can access the main application layout.

Copy link

vercel bot commented Dec 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
app ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 3, 2024 2:41pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
landing ⬜️ Skipped (Inspect) Dec 3, 2024 2:41pm

Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Walkthrough

The changes involve the addition of a session validation mechanism in the Root function of the layout component. A new import statement for the redirect function from the next/navigation module is introduced. A conditional check is implemented to redirect users to the "/login" page if the session variable is falsy, thereby modifying the control flow to ensure that only authenticated users can access the main application layout.

Changes

File Path Change Summary
apps/web/src/app/[locale]/layout.tsx Added import for redirect function and implemented session validation with a conditional redirect to "/login" if the session is falsy.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant Session

    User->>App: Access Application
    App->>Session: Check Session
    alt Session is valid
        Session-->>App: Session exists
        App-->>User: Render Main Layout
    else Session is invalid
        Session-->>App: No session
        App-->>User: Redirect to /login
    end
Loading

🐇 "In the layout where users roam,
A check for sessions finds a home.
If no session is found in sight,
Off to login, they take flight!
With every hop, a path is clear,
Authentication brings us near!" 🐇


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)
apps/web/src/app/[locale]/layout.tsx (2)

36-38: Consider enhancing the session handling implementation.

While the basic session validation works, consider these improvements for a more robust implementation:

  1. Store the current URL when redirecting to login to enable redirect-back functionality
  2. Use environment variables for the login path instead of hardcoding
  3. Consider adding support for public routes that don't require authentication

Here's a suggested implementation:

+ const currentPath = headers().get("x-url") || "";
+ const isPublicRoute = ["/login", "/register"].includes(currentPath);

- if (!session) {
-   redirect("/login");
- }
+ if (!session && !isPublicRoute) {
+   const loginUrl = process.env.NEXT_PUBLIC_LOGIN_PATH || "/login";
+   const searchParams = new URLSearchParams({
+     callbackUrl: currentPath,
+   });
+   redirect(`${loginUrl}?${searchParams.toString()}`);
+ }

35-39: Strong security implementation at the layout level.

Implementing the session check in the root layout provides comprehensive protection for all child routes. This is a secure approach as it:

  1. Prevents unauthorized access to protected routes
  2. Ensures consistent authentication checks across the application
  3. Handles session validation before any rendering occurs

Consider documenting this security boundary in your architecture documentation to make it clear that all routes under this layout inherit authentication protection.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 983c6e2 and 91668d2.

📒 Files selected for processing (1)
  • apps/web/src/app/[locale]/layout.tsx (2 hunks)
🔇 Additional comments (1)
apps/web/src/app/[locale]/layout.tsx (1)

7-7: LGTM! Correct usage of Next.js redirect.

The import of redirect from next/navigation follows Next.js best practices for handling redirects in server components.

@lukevella lukevella merged commit 2b21121 into main Dec 3, 2024
9 checks passed
@lukevella lukevella deleted the missing-session branch December 3, 2024 18:48
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