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 callback getting appended to the url when signin button is clicked on login page #1178

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

IdrisGit
Copy link

✨ Codu Pull Request πŸ’»

Fixes #777

Pull Request details

  • NextAuth.js singin() method redirects to the login page and appends the current page URL to the callback.
  • Added guard clause to prevent the navbar sign in button from calling the signin() method.

Any Breaking changes

  • None

Associated Screenshots

  • None

IdrisGit and others added 2 commits October 26, 2024 00:01
Added guard clause to prevent signin() method from being called on login page as it tries to navigate to login page and causing callback url getting appended in the url bar issue.

Signed-off-by: idrisGit <idris.gadi01@gmail.com>
@IdrisGit IdrisGit requested a review from a team as a code owner October 25, 2024 18:44
Copy link

vercel bot commented Oct 25, 2024

@CarolinaCobo is attempting to deploy a commit to the CodΓΊ Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

Walkthrough

The pull request includes modifications to three components: ArticleMenu, ArticlePreview, and Nav. Changes focus on improving UI behavior and functionality, particularly around class name management for icons and enhancing user interaction with the sign-in process. The Nav component introduces a pathname check to prevent repeated URL appending during sign-in attempts, while both ArticleMenu and ArticlePreview ensure consistent styling for icons.

Changes

File Change Summary
components/ArticleMenu/ArticleMenu.tsx Updated className attributes for HeartIcon and BookmarkIcon for consistent styling; refined handleCopyToClipboard function; adjusted useEffect for copyToClipboard state; added error handling comments in likePost and bookmarkPost.
components/ArticlePreview/ArticlePreview.tsx Adjusted className for BookmarkIcon to ensure proper spacing between class names.
components/Nav/Nav.tsx Added usePathname import; introduced handleSignInPageNavigation function to manage sign-in navigation and prevent URL appending on multiple clicks.

Assessment against linked issues

Objective Addressed Explanation
Prevent repeated URL appending when clicking Sign In button (#[777]) βœ…

Possibly related PRs

  • Fix class to show bookmarks coloursΒ #1177: This PR modifies the className properties for the HeartIcon and BookmarkIcon components in ArticleMenu.tsx, which is directly related to the changes made in the main PR that also updates the className for these icons in ArticleMenu.tsx.

Suggested labels

hacktoberfest-accepted, hacktoberfest

Suggested reviewers

  • NiallJoeMaher
  • John-Paul-Larkin

Poem

In the land of code, where icons play,
A rabbit hops, making changes today.
With a click of a button, the path stays clear,
No more appending, let's give a cheer!
For every heart and bookmark, styled just right,
Our UI shines, oh what a delight! πŸ‡βœ¨


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

Hello @IdrisGit, thanks for opening your first Pull Request. The maintainers will review this Pull Request and provide feedback as soon as possible. Keep up the great work!

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 (3)
components/ArticleMenu/ArticleMenu.tsx (2)

Line range hint 138-141: Consider preventing like action for unauthenticated users.

The current implementation attempts the like action before checking authentication, which could lead to unnecessary API calls. Consider checking authentication first:

 onClick={() => {
-  if (data?.currentUserLiked) return likePost(postId, false);
-  likePost(postId);
   if (!session) {
-    signIn();
+    return signIn();
   }
+  if (data?.currentUserLiked) {
+    return likePost(postId, false);
+  }
+  likePost(postId);
 }}

Line range hint 161-164: Consider preventing bookmark action for unauthenticated users.

Similar to the like button, the current implementation attempts the bookmark action before checking authentication. Consider checking authentication first:

 onClick={() => {
   if (!session) {
-    signIn();
+    return signIn();
   }
   if (data?.currentUserBookmarked)
     return bookmarkPost(postId, false);
   bookmarkPost(postId);
 }}
components/Nav/Nav.tsx (1)

61-71: LGTM: Effective solution with room for minor improvement.

The guard clause effectively prevents the callback URL from being appended multiple times. The implementation is clean and the comments clearly explain the NextAuth.js behavior being addressed.

Consider extracting the path string to a constant to improve maintainability:

+const LOGIN_PAGE_PATH = "/get-started";
+
 const handleSignInPageNavigation = () => {
-  if (pathname === "/get-started") {
+  if (pathname === LOGIN_PAGE_PATH) {
     return;
   }
   signIn();
 };
πŸ“œ Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

πŸ“₯ Commits

Files that changed from the base of the PR and between 871253f and aa097b7.

πŸ“’ Files selected for processing (3)
  • components/ArticleMenu/ArticleMenu.tsx (2 hunks)
  • components/ArticlePreview/ArticlePreview.tsx (1 hunks)
  • components/Nav/Nav.tsx (4 hunks)
βœ… Files skipped from review due to trivial changes (1)
  • components/ArticlePreview/ArticlePreview.tsx
πŸ”‡ Additional comments (5)
components/ArticleMenu/ArticleMenu.tsx (3)

Line range hint 142-147: LGTM! Proper spacing in className template literal.

The addition of space in the className template literal ensures reliable class concatenation.


Line range hint 165-170: LGTM! Proper spacing in className template literal.

The addition of space in the className template literal ensures reliable class concatenation.


Line range hint 138-164: Verify consistent sign-in behavior across components.

While this component uses NextAuth's signIn(), ensure that the fix for URL callback appending in the Nav component (PR #1178) is consistently applied here if needed.

components/Nav/Nav.tsx (2)

3-3: LGTM: Clean hook implementation.

The usePathname hook is correctly imported and implemented to access the current route.

Also applies to: 44-45


135-138: LGTM: Consistent implementation across authentication buttons.

Both sign-in and sign-up buttons now use the same handler, ensuring consistent behavior and preventing the callback URL issue.

Let's verify there are no other direct signIn() calls that might need similar protection:

Also applies to: 143-143

βœ… Verification successful

The previous command failed because the file type was not recognized. Let's try with file extension patterns instead to find all signIn calls and their context.


All signIn() calls appear to be properly guarded or have callback URLs

The search results show that all signIn() calls in the codebase fall into three categories:

  • Protected with session checks (e.g., in ReportModal, CommentsArea)
  • Used with proper callback URLs (in get-started/_client.tsx)
  • Server-side auth handling (in server/auth.ts)

The changes in Nav.tsx align with existing patterns, and no other components need similar protection.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other direct signIn() calls that might need the same guard clause
rg "signIn\(" --type ts --type tsx

Length of output: 64


Script:

#!/bin/bash
# Search for signIn calls with ripgrep, using just file extensions
rg "signIn\(" -g "*.ts" -g "*.tsx" -A 2

Length of output: 4409

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.

Appending callback to url when hitting Sign in button on Nav
2 participants