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: ensure username input retains value on page refresh #2202

Closed

Conversation

Vardhaman619
Copy link
Contributor

@Vardhaman619 Vardhaman619 commented Oct 5, 2024

What does this PR do?

This PR addresses the issue where the username input field on the user account settings page becomes blank after refreshing the page.

Fixes #2201

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

To verify the changes, please perform the following steps:

  1. Navigate to the Workspace -> Settings -> User.
  2. Ensure the username input field is populated with the current username.
  3. Refresh the page.
  4. Confirm that the username input field retains its value.

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features
    • Enhanced user experience by resetting the username field in the settings form when the user object updates.
    • Introduced logic to disable the submit button based on form loading state and validity.

Copy link

changeset-bot bot commented Oct 5, 2024

⚠️ No Changeset found

Latest commit: d54cd36

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Oct 5, 2024

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

Name Status Preview Comments Updated (UTC)
engineering ❌ Failed (Inspect) Oct 5, 2024 10:55am

Copy link

vercel bot commented Oct 5, 2024

@Vardhaman619 is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

github-actions bot commented Oct 5, 2024

Thank you for following the naming conventions for pull request titles! 🙏

Copy link
Contributor

coderabbitai bot commented Oct 5, 2024

📝 Walkthrough

Walkthrough

The changes introduce a new useEffect hook in the UpdateUserName component to reset the username field of the form whenever the user object is updated. This ensures that the form reflects the current username when the user changes. Additionally, a variable isDisabled is added to manage the state of the submit button based on the loading state and validity of the form.

Changes

File Path Change Summary
apps/dashboard/app/(app)/settings/user/update-user-name.tsx Added useEffect to reset username field on user change; introduced isDisabled for submit button state.

Assessment against linked issues

Objective Addressed Explanation
Username input field retains value after page refresh (#2201)

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.

@github-actions github-actions bot added Bug Something isn't working Needs Approval Needs approval from Unkey labels Oct 5, 2024
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 (1)
apps/dashboard/app/(app)/settings/user/update-user-name.tsx (1)

46-50: Approve useEffect implementation with a suggestion

The new useEffect hook successfully addresses the issue of the username becoming blank on page refresh. It ensures that the form's username field is always in sync with the user object.

However, there's a minor improvement we can make:

Consider replacing the non-null assertion (user.username!) with a null check to improve type safety:

 useEffect(() => {
   if (user) {
-    form.reset({ username: user.username! });
+    form.reset({ username: user.username ?? "" });
   }
 }, [user?.username]);

This change ensures that even if user.username is unexpectedly null or undefined, the form will still reset with an empty string, preventing potential runtime errors.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 34a6fb7 and d54cd36.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/settings/user/update-user-name.tsx (3 hunks)
🔇 Additional comments (3)
apps/dashboard/app/(app)/settings/user/update-user-name.tsx (3)

21-21: LGTM: Import statement for useEffect

The addition of the useEffect import is appropriate for implementing the new effect hook in the component. This change supports the PR objective of fixing the username retention issue on page refresh.


60-60: Approve isDisabled implementation and usage

The introduction of the isDisabled variable and its usage in the submit button's properties is a good improvement:

  1. It centralizes the logic for determining when the button should be disabled.
  2. It ensures consistency between the button's visual state (variant) and its functional state (disabled prop).
  3. It enhances user experience by providing clear visual feedback on form validity and submission state.

This change contributes to a more robust and user-friendly interface.

Also applies to: 108-112


Line range hint 1-114: Summary: PR objectives successfully addressed

This implementation effectively solves the issue of the username input becoming blank on page refresh, as outlined in the PR objectives. The changes include:

  1. Adding a useEffect hook to reset the form with the current username when the user object changes.
  2. Introducing an isDisabled variable to manage the submit button's state consistently.

These changes ensure that the username input retains its value after a page refresh, improving the user experience on the account settings page. The implementation adheres to React best practices and effectively addresses the bug reported in issue #2201.

To fully verify the fix:

These verification steps will help ensure that the fix is comprehensive and doesn't conflict with other parts of the codebase.

✅ Verification successful

✅ Verification Successful: No Conflicts Found

The implemented changes effectively address the issue of the username input resetting on page refresh. The verification steps confirmed that:

  • No conflicting setUsername("") resets exist in the codebase.
  • Consistent use of useEffect ensures reliable username state management.
  • Proper usage of form.reset in update-user-name.tsx aligns with the PR objectives.

These findings confirm that the fix is comprehensive and does not introduce any new issues. The PR successfully resolves the reported bug in issue #2201.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the username is properly handled throughout the codebase

# Test 1: Check for any hardcoded username resets that might interfere with the fix
echo "Checking for potential conflicting username resets:"
rg --type typescript --type javascript 'setUsername\(""\)' || echo "No conflicting resets found."

# Test 2: Ensure the useEffect hook is used consistently for username-related state management
echo "Checking for consistent use of useEffect for username state management:"
rg --type typescript --type javascript 'useEffect.*username' -C 3

# Test 3: Verify that the form reset is used consistently across components
echo "Checking for consistent use of form reset with username:"
rg --type typescript --type javascript 'form\.reset.*username' -C 3

Length of output: 759


Script:

#!/bin/bash
# Description: Verify that the username is properly handled throughout the codebase

# Test 1: Check for any hardcoded username resets that might interfere with the fix
echo "Checking for potential conflicting username resets:"
rg --glob "*.ts" --glob "*.tsx" 'setUsername\("")' || echo "No conflicting resets found."

# Test 2: Ensure the useEffect hook is used consistently for username-related state management
echo "Checking for consistent use of useEffect for username state management:"
rg --glob "*.ts" --glob "*.tsx" 'useEffect.*username' -C 3

# Test 3: Verify that the form reset is used consistently across components
echo "Checking for consistent use of form reset with username:"
rg --glob "*.ts" --glob "*.tsx" 'form\.reset.*username' -C 3

Length of output: 1253


Script:

#!/bin/bash
# Description: Verify that the username is properly handled throughout the codebase

# Test 1: Check for any hardcoded username resets that might interfere with the fix
echo "Checking for potential conflicting username resets:"
rg --glob "*.ts" --glob "*.tsx" 'setUsername\("")' || echo "No conflicting resets found."

# Test 2: Ensure the useEffect hook is used consistently for username-related state management
echo "Checking for consistent use of useEffect for username state management:"
rg --glob "*.ts" --glob "*.tsx" 'useEffect.*username' -C 3

# Test 3: Verify that the form reset is used consistently across components
echo "Checking for consistent use of form reset with username:"
rg --glob "*.ts" --glob "*.tsx" 'form\.reset.*username' -C 3

Length of output: 1253


Script:

#!/bin/bash
# Description: Verify that the username is properly handled throughout the codebase

# Test 1: Check for any hardcoded username resets that might interfere with the fix
echo "Checking for potential conflicting username resets:"
rg --glob "*.ts" --glob "*.tsx" 'setUsername\(""\)' || echo "No conflicting resets found."

# Test 2: Ensure the useEffect hook is used consistently for username-related state management
echo "Checking for consistent use of useEffect for username state management:"
rg --glob "*.ts" --glob "*.tsx" 'useEffect.*username' -C 3

# Test 3: Verify that the form reset is used consistently across components
echo "Checking for consistent use of form reset with username:"
rg --glob "*.ts" --glob "*.tsx" 'form\.reset.*username' -C 3

Length of output: 1171

@chronark
Copy link
Collaborator

chronark commented Oct 5, 2024

As mentioned in the issue, we won't fix this right now
#2201 (comment)

@chronark chronark closed this Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Needs Approval Needs approval from Unkey
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Username Input Field is Blank on Page Refresh
2 participants