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

[WEB-2857]fix: updating user role in profile #6278

Merged
merged 1 commit into from
Dec 26, 2024
Merged

Conversation

vamsikrishnamathala
Copy link
Collaborator

@vamsikrishnamathala vamsikrishnamathala commented Dec 26, 2024

Description

This update ensures that the user's role is properly updated when the profile is submitted.
The updateUserProfile function is now included in the Promise.all call within the onSubmit function to handle role updates.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

References

WEB-2857

Summary by CodeRabbit

  • New Features

    • Enhanced profile settings page with improved user profile management.
    • Added functionality to update user profiles alongside current user data.
  • Bug Fixes

    • Adjusted form reset to reflect the latest user profile information.
  • Improvements

    • Streamlined the submission process for user profile updates, improving efficiency.

Copy link
Contributor

coderabbitai bot commented Dec 26, 2024

Walkthrough

The pull request introduces modifications to the ProfileSettingsPage component in the web/app/profile/page.tsx file. The changes enhance user profile management by extending the useUser hook with useUserProfile, allowing more comprehensive user data handling. The component's form submission process is updated to handle user and profile updates more efficiently, with improved payload creation and parallel update processing.

Changes

File Change Summary
web/app/profile/page.tsx - Added TUserProfile type import
- Extended useUser hook to include useUserProfile
- Updated useEffect to reset form with user and profile data
- Modified onSubmit to create separate user profile payload
- Implemented parallel updates using Promise.all

Sequence Diagram

sequenceDiagram
    participant User
    participant ProfilePage
    participant UserHook
    participant ProfileHook
    participant API

    User->>ProfilePage: Update Profile
    ProfilePage->>UserHook: Get Current User
    ProfilePage->>ProfileHook: Get User Profile
    ProfilePage->>ProfilePage: Prepare Payloads
    ProfilePage->>API: Update User (Parallel)
    ProfilePage->>API: Update Profile
    API-->>ProfilePage: Update Confirmation
    ProfilePage->>User: Show Success Message
Loading

Possibly related PRs

Suggested reviewers

  • sriramveeraghanta
  • SatishGandham
  • rahulramesha

Poem

🐰 A Profile's Tale of Code Delight
Hooks dancing, data taking flight
User and Profile, hand in hand
Updating smoothly across the land
Efficiency blooms, errors take flight! 🚀


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.

@vamsikrishnamathala vamsikrishnamathala marked this pull request as draft December 26, 2024 11:35
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

🧹 Nitpick comments (3)
web/app/profile/page.tsx (3)

30-30: Validate the combined usage of useUser and useUserProfile.

While splitting user data and user profile data can improve semantic clarity, confirm that this separation won't introduce race conditions or partial updates. If these updates are meant to be atomic, consider consolidating them.


62-62: Check naming consistency and clarity.

The variable currentUserProfile closely parallels currentUser. Consider consistently naming them (e.g., userProfile vs. currentUserProfile) for clarity across the codebase.


77-79: Use optional chaining carefully.

formData.role ?? undefined works, but confirm that returning undefined is the intended behavior when role is absent, rather than preserving a default role or skipping the field entirely.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a5c1282 and 55afca3.

📒 Files selected for processing (1)
  • web/app/profile/page.tsx (3 hunks)
🔇 Additional comments (5)
web/app/profile/page.tsx (5)

8-8: Use the newly imported TUserProfile judiciously.

Importing TUserProfile is good for typing your user profile data. Ensure that it's used consistently across the file and that the shape of the user profile in the store/context aligns with this new type.


65-65: Ensure correct priority during form reset.

Combining defaultValues, currentUser, and currentUserProfile is helpful for a comprehensive reset. Verify that merging these objects does not accidentally overwrite fields from the other sources.


70-70: Confirm completeness of the user payload.

You might also consider including role in the userPayload if a user’s role in the user entity must always mirror the profile’s role. If this is intentional, disregard.


82-83: Cover image logic might cause confusion.

If formData.cover_image_url starts with http, the logic sets cover_image but clears cover_image_asset. Confirm that all references to cover images consistently read from cover_image or cover_image_asset. Mismatches can lead to unexpected display behavior.


86-89: Parallel updates look good.

The Promise.all usage to update both the user and user profile is efficient. The success and error handling flow is clearly defined. Great job!

@vamsikrishnamathala vamsikrishnamathala marked this pull request as ready for review December 26, 2024 11:39
@pushya22 pushya22 merged commit 36b3328 into preview Dec 26, 2024
21 of 22 checks passed
@pushya22 pushya22 deleted the fix-user_role_update branch December 26, 2024 11:49
@coderabbitai coderabbitai bot mentioned this pull request Dec 30, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛bug Something isn't working 🌐frontend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants