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

Feature Added: An option for users to leave the Organization (Fixes PalisadoesFoundation/talawa-admin#1873) #2753

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

raggettii
Copy link

@raggettii raggettii commented Dec 10, 2024

What kind of change does this PR introduce?
This PR adds API functionality for allowing users to leave organizations without requiring admin permissions.

Issue Number: PalisadoesFoundation/talawa-admin#1873

Fixes PalisadoesFoundation/talawa-admin#1873

Did you add tests for your changes?
Yes, unit tests have been added to ensure that:
-The user can remove themselves from the organization without requiring admin privileges.
-The mutation correctly handles the leave organization functionality.

Snapshots/Videos:
Snapshots for the admin PR have been added; these are relevant to the backend functionality of the "Leave Organization" feature.

If relevant, did you update the documentation?

Summary
This change removes the requirement for admin privileges when a user tries to leave an organization, allowing users to leave without needing admin approval. This feature improves user autonomy and ensures that they can manage their membership within organizations. Additionally, tests have been added to verify that this functionality works as expected.

Does this PR introduce a breaking change?
No, this change does not introduce a breaking change. Existing functionality where an admin is required to remove users from an organization is preserved.

Other information

Have you read the contributing guide?
Yes

Summary by CodeRabbit

  • Bug Fixes

    • Streamlined the member removal process by removing checks for the current user attempting to remove themselves and admin verification.
    • Updated error handling for organization existence checks.
  • Tests

    • Removed test case for unauthorized access when a non-admin user attempts to remove a member.
    • Updated remaining tests to focus on organization and user existence errors.

Copy link

coderabbitai bot commented Dec 10, 2024

Walkthrough

The changes made in this pull request involve modifications to the removeMember function in the src/resolvers/Mutation/removeMember.ts file, specifically removing checks related to the current user attempting to remove themselves and the requirement for the user to be an admin. The associated test suite in tests/resolvers/Mutation/removeMember.spec.ts has also been updated, removing a test case for unauthorized access by non-admin users and adjusting error handling for organization existence scenarios.

Changes

File Path Change Summary
src/resolvers/Mutation/removeMember.ts Removed checks for current user removing themselves and admin verification; retained organization/user checks.
tests/resolvers/Mutation/removeMember.spec.ts Removed test for unauthorized admin removal; updated error handling for organization existence.

Assessment against linked issues

Objective Addressed Explanation
Feature: An option for users to leave the Organization (#1873) The current changes do not implement a leave option for users.

🐰 In the meadow, we hop and play,
Removing members in a brand-new way!
No checks for the self, just a simple cheer,
For every bunny, their path is clear!
With tests refined, we dance with glee,
In our organization, we feel so free! 🌼


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. (Experiment)
  • @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.

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

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

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

🧹 Outside diff range and nitpick comments (1)
tests/resolvers/Mutation/removeMember.spec.ts (1)

Line range hint 1-400: Critical: Missing test coverage for new "Leave Organization" functionality.

The test suite is missing essential test cases for the new feature that allows users to leave organizations without admin permissions. Please add test cases to cover:

  1. A regular user successfully leaving an organization
  2. Error cases specific to the leave organization functionality (e.g., attempting to leave an organization they're not part of)
  3. Edge cases (e.g., last member leaving an organization)

This is particularly important as it's the core functionality being added in PR #2753 (PalisadoesFoundation/talawa-admin#1873).

Would you like me to help generate the missing test cases? Here's a suggested structure:

it("should allow a regular user to leave an organization", async () => {
  const args: MutationRemoveMemberArgs = {
    data: {
      organizationId: testOrganization?.id,
      userId: testUsers[2]?._id, // Regular member
    },
  };

  const context = {
    userId: testUsers[2]?.id, // Same user (leaving themselves)
  };

  // ... test implementation
});

it("should throw error when user attempts to leave an organization they're not part of", async () => {
  // ... test implementation
});

it("should handle edge case when the last member leaves an organization", async () => {
  // ... test implementation
});
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 740ca31 and 56e8b5b.

📒 Files selected for processing (2)
  • src/resolvers/Mutation/removeMember.ts (0 hunks)
  • tests/resolvers/Mutation/removeMember.spec.ts (1 hunks)
💤 Files with no reviewable changes (1)
  • src/resolvers/Mutation/removeMember.ts
🔇 Additional comments (2)
tests/resolvers/Mutation/removeMember.spec.ts (2)

145-145: LGTM: Error message translation looks correct.

The error message translation for organization not found error is properly implemented.


Line range hint 219-247: Critical: Test case contradicts new feature requirements.

The test case "should throw admin cannot remove self error" contradicts the PR objective of allowing users to leave organizations. This test enforces that users cannot remove themselves, which is exactly what the new feature should allow.

This test case should either be:

  1. Removed if self-removal is now allowed for all users, or
  2. Modified to specifically test admin-specific scenarios if there are special cases for admins leaving organizations

Please clarify the intended behavior and update the test accordingly.

Let's verify the implementation in the resolver:

@Cioppolo14
Copy link
Contributor

@raggettii Please fix the failing tests.

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.

2 participants