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 issue where verification links would automatically get consumed by link checkers #1060

Merged
merged 2 commits into from Mar 15, 2024

Conversation

lukevella
Copy link
Owner

@lukevella lukevella commented Mar 15, 2024

Follows the advice in the next-auth docs for handling HEAD requests in the [...nextauth] route.

See: https://next-auth.js.org/tutorials/avoid-corporate-link-checking-email-provider

Avoid link checkers from accidentally consuming verification links and preventing users from logging in
Copy link

vercel bot commented Mar 15, 2024

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

Name Status Preview Comments Updated (UTC)
app 🔄 Building (Inspect) Visit Preview Mar 15, 2024 2:59am
landing ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 15, 2024 2:59am

Copy link

coderabbitai bot commented Mar 15, 2024

Walkthrough

The project has undergone modifications to enhance its authentication process. Specifically, the Next.js API route file now includes logic to handle HTTP requests more precisely, ensuring responses are method-specific. Additionally, the authentication utility has been streamlined by removing outdated dependencies and functions, indicating a move towards a more modern and simplified authentication setup.

Changes

File Path Change Summary
.../api/auth/[...nextauth].ts Updated to include logic for handling HTTP requests based on the method before proceeding with authentication.
.../utils/auth.ts Removed dependencies on cookie and iron-session, along with RequestInternal import and legacy session functions.

🐰✨
In the digital burrow, deep and wide,
Changes brew with thoughtful pride.
No more cookies, iron sealed tight,
Just sleek auth, in the moonlight bright.
Hop along, on code we ride,
To the future, side by side. 🌙🚀
🐰✨

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e891158 and a733346.
Files selected for processing (2)
  • apps/web/src/pages/api/auth/[...nextauth].ts (1 hunks)
  • apps/web/src/utils/auth.ts (2 hunks)
Additional comments: 1
apps/web/src/utils/auth.ts (1)
  • 10-10: The cleanup in apps/web/src/utils/auth.ts, including the removal of unused imports and legacy session management functions, contributes to a cleaner and more maintainable codebase. This aligns with modern authentication practices and simplifies the authentication utilities. Ensure that the removal of these elements does not impact other parts of the application that might still rely on them. It's good practice to search the codebase for any references to the removed entities to confirm their safe deletion.

Comment on lines +5 to +10
export default async function auth(req: NextApiRequest, res: NextApiResponse) {
if (req.method === "HEAD") {
return res.status(200).end();
}

return AuthApiRoute(req, res);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The addition of a check for the HEAD request method before proceeding with the AuthApiRoute function is a good practice for handling pre-fetching requests by browsers or link checkers. This ensures that verification links are not prematurely consumed by automated systems. However, consider adding a comment explaining the purpose of this check for future maintainability.

+    // Respond to HEAD requests to prevent link checkers from consuming verification links

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
export default async function auth(req: NextApiRequest, res: NextApiResponse) {
if (req.method === "HEAD") {
return res.status(200).end();
}
return AuthApiRoute(req, res);
export default async function auth(req: NextApiRequest, res: NextApiResponse) {
if (req.method === "HEAD") {
// Respond to HEAD requests to prevent link checkers from consuming verification links
return res.status(200).end();
}
return AuthApiRoute(req, res);

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

1 participant