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

🐛 Forward callback url when signing in with sso provider #1543

Merged
merged 2 commits into from
Feb 3, 2025

Conversation

lukevella
Copy link
Owner

@lukevella lukevella commented Feb 3, 2025

Summary by CodeRabbit

  • New Features
    • Improved the sign-in experience by enabling dynamic redirection. Users who log in will now be seamlessly redirected to an optional URL specified in the browser’s address parameters if provided.
    • Enhanced the LoginWithOIDC functionality to support an optional callback URL for redirection after authentication.

Copy link

vercel bot commented Feb 3, 2025

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 Feb 3, 2025 0:24am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
landing ⬜️ Skipped (Inspect) Feb 3, 2025 0:24am

Copy link
Contributor

coderabbitai bot commented Feb 3, 2025

Walkthrough

The changes introduce an optional callbackUrl parameter to the SSOProvider, LoginWithOIDC, and LoginPage functions. This allows for redirection to a specified URL after sign-in. The signIn function is updated to include the callbackUrl, enhancing the login process across components. Additionally, the LoginWithOIDC function's import statement for Trans is modified to pull from a different module, and the properties of the Trans component have been adjusted.

Changes

File Path Summary of Changes
apps/web/src/app/[locale]/(auth)/login/components/sso-provider.tsx Updated SSOProvider function to accept callbackUrl as an optional parameter and modified the signIn call to include this parameter.
apps/web/src/app/[locale]/(auth)/login/components/login-with-oidc.tsx Modified LoginWithOIDC function to include callbackUrl, updated import for Trans, and adjusted Trans component properties.
apps/web/src/app/[locale]/(auth)/login/page.tsx Altered LoginPage function to accept searchParams, passing callbackUrl to LoginWithOIDC and SSOProvider components.

Possibly related PRs

  • ♻️ Clean up login page code #1525: The changes in the main PR and the retrieved PR are related as both modify the LoginWithOIDC function to include a callbackUrl parameter in their signatures and utilize it in the signIn function call.

Poem

I'm a bunny in the code garden, hopping with glee,
Adding search params for sign-in, as simple as can be.
URL magic in the mix, guiding users on their way,
With a callbackUrl hop, new paths light up the day.
Happy hops and merry bytes, our code now bright as May!
🐰✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 16e6ccf and c1dc2c2.

📒 Files selected for processing (3)
  • apps/web/src/app/[locale]/(auth)/login/components/login-with-oidc.tsx (1 hunks)
  • apps/web/src/app/[locale]/(auth)/login/components/sso-provider.tsx (2 hunks)
  • apps/web/src/app/[locale]/(auth)/login/page.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/web/src/app/[locale]/(auth)/login/components/sso-provider.tsx
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Unit tests
  • GitHub Check: Linting
  • GitHub Check: Integration tests
  • GitHub Check: Type check
🔇 Additional comments (4)
apps/web/src/app/[locale]/(auth)/login/components/login-with-oidc.tsx (2)

7-13: LGTM! Callback URL forwarding is properly implemented.

The optional callbackUrl parameter is correctly typed and properly forwarded to the next-auth signIn function.

Also applies to: 17-19


5-5: Verify the Trans component migration.

The component has been migrated from react-i18next/TransWithoutContext to a local @/components/trans implementation. Please ensure that:

  1. All required translation features are supported by the new component
  2. The removal of the ns prop is intentional

Also applies to: 23-27

apps/web/src/app/[locale]/(auth)/login/page.tsx (2)

21-27: LGTM! SearchParams are properly typed.

The optional searchParams parameter with callbackUrl is correctly typed using TypeScript interfaces.


58-63: LGTM! Callback URL is consistently forwarded.

The callbackUrl is properly forwarded to both LoginWithOIDC and SSOProvider components, ensuring consistent behavior across different authentication methods.

Also applies to: 67-72


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@lukevella lukevella enabled auto-merge (squash) February 3, 2025 12:05
@lukevella lukevella disabled auto-merge February 3, 2025 12:06
@vercel vercel bot temporarily deployed to Preview – landing February 3, 2025 12:19 Inactive
@lukevella lukevella merged commit c152702 into main Feb 3, 2025
10 checks passed
@lukevella lukevella deleted the redirect-sso branch February 3, 2025 12:28
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