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-3043]chore: removed guest assignees from issue filters #6402

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

mathalav55
Copy link
Collaborator

@mathalav55 mathalav55 commented Jan 15, 2025

Description

Removed guest users from issues filters.

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-3043

Summary by CodeRabbit

  • New Features

    • Enhanced project member filtering capabilities in issue assignment
    • Added project ID context to filter selection components
  • Improvements

    • Refined user permission handling for project members
    • Improved assignee selection logic to exclude guest users

The changes introduce more granular control over issue filtering and assignment within project contexts, providing a more tailored user experience.

Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request introduces a projectId property to the FilterSelection component across multiple files. This change enables more granular project-specific filtering, particularly focusing on managing user permissions and assignee selection. The modifications primarily enhance the component's ability to filter members and assignees based on project-specific contexts, with a specific emphasis on excluding guest users from certain operations.

Changes

File Change Summary
web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/views/(detail)/[viewId]/header.tsx Added projectId prop to FilterSelection component
web/core/components/issues/filters.tsx Introduced projectId: string prop to FilterSelection
web/core/components/issues/issue-layouts/filters/header/filters/filters-selection.tsx - Added projectId?: string to Props type
- Imported useMember and EUserPermissions
- Created assigneeIds filtering logic

Possibly related PRs

Suggested Labels

🐛bug

Suggested Reviewers

  • sriramveeraghanta
  • rahulramesha
  • SatishGandham

Poem

🐰 A rabbit's tale of code so bright,
Where projectId takes its flight,
Filtering members with gentle care,
Guests step back, permissions declare,
In lines of logic, clean and tight! 🔍


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.

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: 1

🧹 Nitpick comments (2)
web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/views/(detail)/[viewId]/header.tsx (2)

249-249: Consider adding null check for projectId.

While the current implementation works, it's good practice to add a null check for route parameters.

-projectId={projectId.toString()}
+projectId={projectId?.toString()}

Line range hint 75-83: Consider caching the filtered assignee list.

Since the filtering of guest users is performed on every render, consider memoizing the assigneeIds list using useMemo to optimize performance, especially for projects with many members.

+const assigneeIds = useMemo(() =>
   memberIds?.filter((id) => {
     if (projectId) {
       const memberDetails = getProjectMemberDetails(id, projectId);
       return memberDetails?.role !== EUserPermissions.GUEST;
     }
     return true;
   }),
+  [memberIds, projectId, getProjectMemberDetails]
+);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9d71568 and f6fca5d.

📒 Files selected for processing (3)
  • web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/views/(detail)/[viewId]/header.tsx (1 hunks)
  • web/core/components/issues/filters.tsx (1 hunks)
  • web/core/components/issues/issue-layouts/filters/header/filters/filters-selection.tsx (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
🔇 Additional comments (2)
web/core/components/issues/issue-layouts/filters/header/filters/filters-selection.tsx (1)

160-160: Verify the impact of filtering guest assignees.

The change to use assigneeIds instead of memberIds might affect existing issues that were already assigned to guest users.

✅ Verification successful

The change to use assigneeIds is a security improvement

The switch from memberIds to assigneeIds is actually implementing proper guest user filtering, ensuring that guest users cannot be assigned to issues. This aligns with the backend's existing guest user validation and improves access control. The change does not negatively impact existing issues but rather enforces proper security constraints.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any existing issues assigned to guest users
# that might be affected by this change

# Find all guest users in the project
echo "Checking for issues assigned to guest users..."
ast-grep --pattern 'assignees.includes($GUEST_ID)' 

Length of output: 155


Script:

#!/bin/bash
# Search for memberIds and assigneeIds usage
echo "Searching for memberIds usage..."
rg "memberIds" -A 2 -B 2

echo -e "\nSearching for assigneeIds usage..."
rg "assigneeIds" -A 2 -B 2

echo -e "\nSearching for guest user related code..."
rg -i "guest.*user|guest.*member" -A 2 -B 2

Length of output: 54566

web/core/components/issues/filters.tsx (1)

123-123: LGTM!

The projectId prop is correctly passed to the FilterSelection component.

Comment on lines +75 to +83
// filter guests from assignees
const assigneeIds = memberIds?.filter((id) => {
if (projectId) {
const memeberDetails = getProjectMemberDetails(id, projectId);
const isGuest = (memeberDetails?.role || EUserPermissions.GUEST) === EUserPermissions.GUEST;
if (isGuest && memeberDetails) return false;
}
return true;
});
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Fix typos and optimize the guest filtering logic.

The guest filtering implementation has a few issues:

  1. Typo in variable name memeberDetails -> memberDetails
  2. Redundant null check after using the variable
  3. The role access can be simplified
 const assigneeIds = memberIds?.filter((id) => {
   if (projectId) {
-    const memeberDetails = getProjectMemberDetails(id, projectId);
-    const isGuest = (memeberDetails?.role || EUserPermissions.GUEST) === EUserPermissions.GUEST;
-    if (isGuest && memeberDetails) return false;
+    const memberDetails = getProjectMemberDetails(id, projectId);
+    return memberDetails?.role !== EUserPermissions.GUEST;
   }
   return true;
 });
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// filter guests from assignees
const assigneeIds = memberIds?.filter((id) => {
if (projectId) {
const memeberDetails = getProjectMemberDetails(id, projectId);
const isGuest = (memeberDetails?.role || EUserPermissions.GUEST) === EUserPermissions.GUEST;
if (isGuest && memeberDetails) return false;
}
return true;
});
// filter guests from assignees
const assigneeIds = memberIds?.filter((id) => {
if (projectId) {
const memberDetails = getProjectMemberDetails(id, projectId);
return memberDetails?.role !== EUserPermissions.GUEST;
}
return true;
});

@pushya22 pushya22 merged commit 0345336 into preview Jan 15, 2025
12 of 14 checks passed
@pushya22 pushya22 deleted the chore-guest_assignees branch January 15, 2025 10:36
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.

3 participants