Skip to content

fix(classes): reset user data when removing congregation #1646

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

Merged
merged 2 commits into from
Jun 1, 2025

Conversation

rhahao
Copy link
Member

@rhahao rhahao commented Jun 1, 2025

No description provided.

Copy link

coderabbitai bot commented Jun 1, 2025

Walkthrough

This update modifies the logic for removing a user from a congregation, introducing role-based handling. If the user's role is 'vip', their congregation and related data are cleared; if the role is 'pocket', the user is deleted entirely. Additional cleanup steps are added to the congregation removal process.

Changes

File(s) Change Summary
src/v3/classes/User.ts Enhanced removeCongregation to clear user settings, sessions, and reports after congregation removal.
src/v3/controllers/admin_controller.ts
src/v3/controllers/congregation_admin_controller.ts
Updated user removal logic to handle 'vip' and 'pocket' roles differently: 'vip' triggers congregation removal, 'pocket' triggers user deletion.

Sequence Diagram(s)

sequenceDiagram
    participant AdminController
    participant User
    participant UsersList
    participant Congregation

    AdminController->>User: get user by ID
    alt user.role == 'vip'
        AdminController->>User: removeCongregation()
        User->>User: Clear congregation, settings, sessions, reports
        User->>Congregation: reloadMembers()
    else user.role == 'pocket'
        AdminController->>UsersList: delete(user.id)
    end
    AdminController->>Congregation: reloadMembers()
    AdminController-->>AdminController: return updated user list
Loading

Possibly related PRs

  • feat(routes): add remove user from congregation for admin #1645: The main PR extends the existing userRemoveCongregation controller function by adding role-based conditional logic and enhances the removeCongregation method with additional cleanup steps, building directly on the functionality introduced in the retrieved PR.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-01T19_30_26_240Z-debug-0.log

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

sonarqubecloud bot commented Jun 1, 2025

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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/v3/controllers/admin_controller.ts (1)

859-865: Consistent role-based logic maintained across controllers.

The implementation matches the logic in congregation_admin_controller.ts exactly, ensuring consistent behavior regardless of which admin interface is used to remove users. This consistency is crucial for maintaining predictable system behavior.

Consider extracting this role-based removal logic into a shared utility function to reduce code duplication:

// utils/user_removal_utils.ts
export async function removeUserBasedOnRole(user: User) {
  if (user.profile.role === 'vip') {
    await user.removeCongregation();
  }
  
  if (user.profile.role === 'pocket') {
    await UsersList.delete(user.id);
  }
}

This would centralize the logic and make future changes easier to maintain.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b88dc9d and ab27228.

📒 Files selected for processing (3)
  • src/v3/classes/User.ts (1 hunks)
  • src/v3/controllers/admin_controller.ts (1 hunks)
  • src/v3/controllers/congregation_admin_controller.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
src/v3/controllers/congregation_admin_controller.ts (1)
src/v3/classes/Users.ts (1)
  • UsersList (139-139)
src/v3/controllers/admin_controller.ts (1)
src/v3/classes/Users.ts (1)
  • UsersList (139-139)
🔇 Additional comments (2)
src/v3/classes/User.ts (1)

306-320: Comprehensive data cleanup implementation looks good.

The enhanced removeCongregation method now performs thorough cleanup by:

  • Resetting all user settings to empty strings
  • Clearing all active sessions (good security practice)
  • Removing all user-specific data (reports, studies, delegated reports)

This ensures users have a clean slate when removed from a congregation, which aligns with the PR objective to "reset user data when removing congregation."

src/v3/controllers/congregation_admin_controller.ts (1)

729-735: Role-based user removal logic implemented correctly.

The conditional approach is well-designed:

  • vip users: Calls removeCongregation() which performs comprehensive cleanup while preserving the user account
  • pocket users: Completely removes the user from the system

This differentiation makes sense for different user account types and aligns with the enhanced cleanup logic in the User class.

@rhahao rhahao merged commit e2e1736 into sws2apps:main Jun 1, 2025
12 checks passed
@rhahao
Copy link
Member Author

rhahao commented Jun 2, 2025

🎉 This PR is included in version 3.27.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@rhahao rhahao added the released label Jun 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant