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: project join for admin and members #6097

Merged
merged 2 commits into from
Nov 26, 2024

Conversation

pablohashescobar
Copy link
Collaborator

@pablohashescobar pablohashescobar commented Nov 26, 2024

Description

Update project join check to use enum values for ADMIN and MEMBER roles.

Summary by CodeRabbit

  • New Features
    • Expanded permission criteria for project invitations to include both Admin and Member roles.
    • Enhanced error handling for invalid email addresses during the invitation process.
    • Improved validation for email acceptance in project join requests, ensuring only intended recipients can accept invitations.

These changes collectively enhance the user experience by making project invitations more accessible and secure.

Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

Walkthrough

The pull request introduces modifications to the invitation and project joining processes within the application. It updates the permission checks for workspace members to allow both ROLE.ADMIN and ROLE.MEMBER. Additionally, error handling for invalid email addresses is added in the invitation creation process, enhancing validation. The project joining method now includes a check for the email parameter to ensure it matches the invitation, improving security. These changes collectively enhance the robustness and security of the invitation and project joining functionalities.

Changes

File Path Change Summary
apiserver/plane/app/views/project/invite.py - Updated create method in UserProjectInvitationsViewset to allow ROLE.MEMBER for permissions.
- Updated create method in ProjectInvitationsViewset to add error handling for invalid emails.
- Updated post method in ProjectJoinEndpoint to validate the email parameter against the invitation email.

Possibly related PRs

Suggested labels

🐛bug

Suggested reviewers

  • rahulramesha
  • sriramveeraghanta

🐰 In the land of code where rabbits play,
New checks and balances brighten the day.
With emails validated and roles now clear,
Invitations sent without any fear!
Hopping through changes, we celebrate right,
A project so secure, it shines so bright! 🌟


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
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 (2)
apiserver/plane/app/views/project/invite.py (2)

Line range hint 67-85: Add token expiration validation

The JWT token generation includes a timestamp, but there's no validation of token expiration during usage. This could lead to security issues with indefinitely valid invitation links.

Consider adding expiration validation:

+                        expiry = datetime.now() + timedelta(days=7)  # Configure as needed
                         token=jwt.encode(
-                            {"email": email, "timestamp": datetime.now().timestamp()},
+                            {
+                                "email": email,
+                                "timestamp": datetime.now().timestamp(),
+                                "exp": expiry.timestamp()
+                            },
                             settings.SECRET_KEY,
                             algorithm="HS256",
                         ),

Line range hint 191-236: Add transaction management for bulk operations

The creation of ProjectMember and IssueUserProperty should be atomic to maintain data consistency.

Consider wrapping the bulk operations in a transaction:

+        from django.db import transaction
+
+        with transaction.atomic():
             ProjectMember.objects.bulk_create(...)
             IssueUserProperty.objects.bulk_create(...)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c4a5c59 and 14a7ddc.

📒 Files selected for processing (1)
  • apiserver/plane/app/views/project/invite.py (1 hunks)
🔇 Additional comments (1)
apiserver/plane/app/views/project/invite.py (1)

139-139: Verify role enum value comparisons

The role check has been updated to allow both ADMIN and MEMBER roles, which aligns with the PR objectives. However, let's verify the enum value comparisons are consistent across the codebase.

Consider using a more explicit role validation approach:

-        if workspace_member.role not in [ROLE.ADMIN.value, ROLE.MEMBER.value]:
+        allowed_roles = {ROLE.ADMIN.value, ROLE.MEMBER.value}
+        if workspace_member.role not in allowed_roles:

This makes the allowed roles more maintainable and reusable across the codebase.

✅ Verification successful

Based on the search results, I can now generate the final response since we have found:

  1. The ROLE enum definition in apiserver/plane/app/permissions/base.py showing it's properly defined
  2. Consistent imports of ROLE across the codebase
  3. The role check pattern being used consistently in other files

Role check implementation is correct

The role validation using role not in [ROLE.ADMIN.value, ROLE.MEMBER.value] is implemented correctly and follows the codebase's patterns. The ROLE enum is properly defined in permissions/base.py with ADMIN = 20 and MEMBER = 15, and the .value comparison is the correct way to check enum values.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for consistent role value comparisons in the codebase

# Search for role value comparisons
rg -A 2 "role.*in.*\[.*ROLE\." 

# Search for direct role value comparisons
rg -A 2 "role.*==.*ROLE\."

# Search for ROLE enum definition to verify values
ast-grep --pattern 'class ROLE:
  $$$
'

Length of output: 420


Script:

#!/bin/bash
# Let's search for the ROLE enum definition and its usage more broadly

# Find files containing ROLE definition
rg -l "class ROLE"

# Search for any ROLE enum usage patterns
rg -A 2 "ROLE\." 

# Search for role-related validations or checks
rg -A 2 "role.*=|role.*in"

Length of output: 140866


Script:

#!/bin/bash
# Let's search for the ROLE enum definition and its usage in permissions

# Find ROLE enum definition
ast-grep --pattern 'class ROLE:
  $$$
'

# Search for role-related imports and definitions
rg -A 2 "from.*ROLE|class.*ROLE"

# Search for role value comparisons specifically in permissions context
rg -A 2 "role.*in.*\[.*ROLE\.|role.*==.*ROLE\." apiserver/plane/app/permissions/

Length of output: 9002

@sriramveeraghanta sriramveeraghanta merged commit 76fe136 into preview Nov 26, 2024
13 of 15 checks passed
@sriramveeraghanta sriramveeraghanta deleted the fix-enum-role-comparison branch November 26, 2024 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants