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

BA-2084: Multiple Profiles - Search Bar #183

Merged
merged 6 commits into from
Jan 21, 2025

Conversation

luisguareschi
Copy link
Collaborator

@luisguareschi luisguareschi commented Jan 14, 2025

As a user, on the BaseApp Profile,I would like to use a searc bar, In order to find invited and current members on the member list.

Original Story:
Acceptance Criteria
Context
In this story we want to implement the search bar in the Members List page.

Business Rules - Search Bar - 3

Users should be able to use a search bar to locate a member:

The search should be case-insensitive, so typing “john” should return results for “John” or “john.”
**The search should support partial matches, meaning typing part of a contact's name (e.g., “Jo” for “John Doe”) should filter the list to show all matching results.

The search bar should include a clear button (e.g., an “X” icon) that, when clicked, clears the search input and restores the full members list

Searchbar component should already be done, so re use it.

Current behavior

Expected behavior

Code Snippet

Design Link: https://www.figma.com/design/XRD6wSl1m8Kz6XUcAy5CLp/BaseApp---WEB?node-id=3660-64822&node-type=frame&t=IBg7GNDkZEpy2W77-0

Approvd
https://app.approvd.io/projects/BA/stories/35054

Summary by CodeRabbit

Release Notes

  • New Features

    • Added search functionality for the members list.
    • Introduced a search bar for filtering members by first name, last name, and email.
    • Enhanced member items to support filtering based on search queries.
    • Updated member list items to utilize search queries for improved filtering.
  • Improvements

    • Enhanced member list with dynamic search capabilities.
    • Implemented state management for search queries across components.
  • Technical Updates

    • Updated GraphQL queries to support search filtering.
    • Modified type definitions to clarify interface properties.

@luisguareschi luisguareschi self-assigned this Jan 14, 2025
Copy link

changeset-bot bot commented Jan 14, 2025

⚠️ No Changeset found

Latest commit: 42d83d1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

coderabbitai bot commented Jan 14, 2025

Walkthrough

The pull request introduces a search functionality for the Members component across multiple files. Enhancements include the addition of a searchQuery prop to various components, updates to GraphQL queries to support filtering based on this query, and the integration of a Searchbar component. The modifications span the component structure, type definitions, and query configurations, providing a comprehensive implementation of search capabilities in the members list.

Changes

File Change Summary
packages/components/modules/profiles/Members/MembersList/index.tsx Enhanced to incorporate search functionality; added handleSearch, handleSearchClear methods, and integrated Searchbar component. Modified usePaginationFragment to return refetch function.
packages/components/modules/profiles/Members/index.tsx Minor formatting adjustments in MembersSuspended component, including import statement alignment and JSX fragment syntax change.
packages/components/modules/profiles/Members/types.ts Updated UserMembersProps interface to include an empty block after extending MemberListProps.
packages/components/modules/profiles/graphql/queries/UserMembersList.ts Introduced new variable $q in UserMembersListPaginationQuery and UserMembersListFragment for enhanced filtering capabilities.
packages/components/modules/profiles/Members/MemberItem/index.tsx Introduced a new prop searchQuery for filtering member profiles; added early return logic based on searchQuery.
packages/components/modules/profiles/Members/MemberItem/types.ts Added optional property searchQuery?: string to MemberItemProps interface.
packages/components/modules/profiles/Members/MemberListItem/index.tsx Added searchQuery prop to MemberListItem; utilized it in rendering MemberItemComponent.
packages/components/modules/profiles/Members/MemberListItem/types.ts Added optional property searchQuery?: string to MemberListItemProps interface.

Possibly related PRs

  • BA-1777: multiple profiles member list #135: The MembersList component in the main PR has been enhanced with search functionality, which relates to the changes in the MemberItem component in this PR that also involves rendering member information, potentially affected by search queries.
  • Ba 1839 fe multiple profiles edit member role #143: The modifications to the MemberItem component in this PR include new props for managing member roles, which could interact with the search functionality in the MembersList component by filtering members based on their roles.
  • BA-2070 Fix chatroom search #177: The changes in the ChatRoomsList component to improve search functionality are directly related to the enhancements made in the MembersList component, as both involve refining how search inputs affect displayed lists.

Suggested reviewers

  • Hercilio1
  • anicioalexandre
  • Ronan-Fernandes

Poem

🐰 Searching members, hop hop hooray!
A query so swift, it brightens the day
Filters dancing, results so clean
Technology's magic, a rabbit's dream
Search on, brave users, with glee! 🔍


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 475d53c4a26d54eb8dab3b6d99b0a3641d6643f0 and 42d83d1.

⛔ Files ignored due to path filters (78)
  • packages/components/__generated__/ActivityLogsFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ActivityLogsPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ActivityLogsQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/AddProfilePopoverUserQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/AllProfilesListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/AllProfilesListPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ArchiveChatRoomMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/BlockToggleFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/BlockToggleMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ChangeUserRoleMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ChatRoomMessagesListPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ChatRoomParticipantsPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ChatRoomQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ChatRoomsQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentCreateMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentDeleteMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentItemRefetchQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentItemWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentItem_comment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentItem_target.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentPinMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentUpdateMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsForTestingQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsListPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsListWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsList_comments.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsRefetchQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsSubscription.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsUpdateWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CreateChatRoomMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/FollowToggleMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/FollowToggleUpdatableFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/GroupDetailsQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/GroupTitleFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/LastMessageFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/MemberItemFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/MembersListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/MessageItemFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/MessagesListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationItemFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationItemWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationUserMenuFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationsListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationsListQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationsMarkAllAsReadMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationsMarkAsReadMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationsPopoverQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/OrganizationCreateMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ProfileComponentFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ProfileItemFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ProfileUpdateMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ProfilesListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ProfilesListQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ReactionButtonMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ReactionButtonWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ReactionButton_target.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ReadMessagesMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/RoomFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/RoomTitleFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/RoomsListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/SendMessageMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/TitleFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UnreadChatMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UnreadMessagesCountFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UpdateChatRoomMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UserMembersListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UserMembersListPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UserProfileQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/chatRoomsPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/notificationsListRefetchable.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/profilesListRefetchable.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/useMessageCountUpdateSubscription.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/useMessagesListSubscription.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/useNotificationsSubscription.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/useRoomListSubscription.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/userMembersListPaginationRefetchable.graphql.ts is excluded by !**/__generated__/**
📒 Files selected for processing (1)
  • packages/components/CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/components/CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Component Test Applications and Packages
  • GitHub Check: Lint

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

@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)
packages/components/modules/profiles/Members/index.tsx (1)

62-70: Consider handling loading state in Searchbar.

The isPending prop is hardcoded to false. Consider reflecting the actual loading state when search is in progress.

 <Searchbar 
   variant="outlined" 
   size="small" 
-  isPending={false} 
+  isPending={isLoadingNext} 
   onChange={(e) => setSearchQuery(e.target.value)} 
   onClear={() => setSearchQuery('')} 
   value={searchQuery} 
   sx={{ mb: 4 }} 
 />
packages/components/modules/profiles/Members/MembersList/index.tsx (2)

30-32: Consider debouncing search queries.

The current implementation triggers a refetch on every search query change. Consider debouncing the search to reduce unnecessary API calls.

+import { useCallback } from 'react'
+import debounce from 'lodash/debounce'

 const MembersList: FC<MemberListProps> = ({
   // ...props
 }) => {
+  const debouncedRefetch = useCallback(
+    debounce((query: string) => {
+      refetch({ q: query })
+    }, 300),
+    [refetch]
+  )
+
   useEffect(() => {
-    refetch({ q: searchQuery })
+    debouncedRefetch(searchQuery)
+    return () => {
+      debouncedRefetch.cancel()
+    }
   }, [searchQuery])

25-25: Consider handling loading state during search.

The isLoadingNext is only used for pagination loading. Consider tracking the loading state during search refetch to improve user experience.

-const { data, loadNext, hasNext, isLoadingNext, refetch } = usePaginationFragment(
+const { data, loadNext, hasNext, isLoadingNext, refetch, isRefetching } = usePaginationFragment(
   UserMembersListFragment,
   userRef,
 )
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2692120 and d1d56f716b7d3aeb097853661b7f6868585d13ed.

📒 Files selected for processing (4)
  • packages/components/modules/profiles/Members/MembersList/index.tsx (2 hunks)
  • packages/components/modules/profiles/Members/index.tsx (4 hunks)
  • packages/components/modules/profiles/Members/types.ts (2 hunks)
  • packages/components/modules/profiles/graphql/queries/UserMembersList.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (4)
packages/components/modules/profiles/Members/types.ts (1)

15-15: LGTM! Type definitions are well-structured.

The optional searchQuery prop is correctly typed as string and appropriately added to both interfaces, maintaining backward compatibility.

Also applies to: 28-30

packages/components/modules/profiles/graphql/queries/UserMembersList.ts (2)

29-30: LGTM! Connection configuration is properly set up.

The @connection directive correctly includes the search query in filters, ensuring proper cache updates when the search query changes.


9-9: Verify case-insensitive search handling.

The GraphQL query includes the search parameter, but we need to ensure the backend handles case-insensitive search as per requirements.

Also applies to: 13-13

packages/components/modules/profiles/Members/index.tsx (1)

53-53: LGTM! Search state management is well implemented.

The search functionality is properly implemented with state management and the search query is correctly passed down to the Members component.

Also applies to: 73-73

@luisguareschi luisguareschi force-pushed the BA-2084-Multiple-Profiles-Search-Bar branch from d1d56f7 to 46c7611 Compare January 16, 2025 14:47
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: 1

🔭 Outside diff range comments (1)
packages/components/modules/profiles/Members/MembersList/index.tsx (1)

Line range hint 57-65: Add specific empty state for search results.

The current implementation doesn't distinguish between having no members and having no search results. Consider adding a specific message for when the search returns no results.

   if (members.length === 0) {
+    if (searchQuery) {
+      return (
+        <Typography variant="body1" align="center" sx={{ py: 4 }}>
+          No members found matching "{searchQuery}"
+        </Typography>
+      )
+    }
     return (
       <>
         <Typography variant="subtitle2" mb={4}>
🧹 Nitpick comments (3)
packages/components/modules/profiles/Members/index.tsx (2)

Line range hint 16-40: Consider adding searchQuery to the initial query parameters.

While the searchQuery prop is correctly passed to MembersList, consider including it in the initial useLazyLoadQuery parameters to avoid unnecessary refetches.

 const data = useLazyLoadQuery<IUserMembersListPaginationQuery>(UserMembersListPaginationQuery, {
   profileId: currentProfile?.id || '',
   count: NUMBER_OF_MEMBERS_ON_FIRST_LOAD,
   orderBy: 'status',
+  q: searchQuery,
 })

62-70: Consider adding placeholder text and aria-label for better accessibility.

The Searchbar implementation looks good but could benefit from additional accessibility improvements.

 <Searchbar 
   variant="outlined" 
   size="small" 
   isPending={false} 
   onChange={(e) => setSearchQuery(e.target.value)} 
   onClear={() => setSearchQuery('')} 
   value={searchQuery} 
   sx={{ mb: 4 }} 
+  placeholder="Search members..."
+  aria-label="Search members"
 />
packages/components/modules/profiles/Members/MembersList/index.tsx (1)

Line range hint 77-91: Consider preserving scroll position during search.

The Virtuoso implementation looks good, but consider preserving the scroll position when performing a search to improve user experience.

 <Virtuoso
   style={{ height: membersContainerHeight }}
   data={members}
   itemContent={(_index, member) => member && renderMemberItem(member, _index)}
+  restoreStateFrom={searchQuery ? undefined : 'members-list'}
+  saveStateOnUpdate={!searchQuery}
   components={{
     Footer: renderLoadingState,
   }}
   // ... rest of the props
 />
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d1d56f716b7d3aeb097853661b7f6868585d13ed and 46c7611d4169ab6f9bf09797da97b4de891c2479.

📒 Files selected for processing (4)
  • packages/components/modules/profiles/Members/MembersList/index.tsx (2 hunks)
  • packages/components/modules/profiles/Members/index.tsx (4 hunks)
  • packages/components/modules/profiles/Members/types.ts (2 hunks)
  • packages/components/modules/profiles/graphql/queries/UserMembersList.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/components/modules/profiles/Members/types.ts
  • packages/components/modules/profiles/graphql/queries/UserMembersList.ts
🔇 Additional comments (1)
packages/components/modules/profiles/Members/index.tsx (1)

1-1: LGTM: Import statements are properly organized.

The necessary imports for useState and Searchbar components are correctly added.

Also applies to: 4-4

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 (3)
packages/components/modules/profiles/Members/MembersList/index.tsx (3)

27-27: Fix formatting in destructuring assignment.

Remove the extra space before refetch in the destructuring assignment.

-  const { data, loadNext, hasNext, isLoadingNext , refetch} = usePaginationFragment(
+  const { data, loadNext, hasNext, isLoadingNext, refetch } = usePaginationFragment(

38-43: Optimize handleSearchClear implementation.

The current implementation makes two state transitions: one for reset and one for search. These can be combined into a single transition for better performance.

 const handleSearchClear = () => {
   startTransition(() => {
     reset()
-    handleSearch('')
+    refetch({ q: '' })
   })
 }

76-85: Extract duplicated Searchbar component.

The Searchbar component is duplicated with identical props. Consider extracting it into a separate component or variable to improve maintainability.

+  const searchBar = (
+    <Searchbar 
+      variant="outlined" 
+      size="small" 
+      isPending={isPending} 
+      onChange={(e) => handleSearch(e.target.value)} 
+      onClear={() => handleSearchClear()} 
+      name="search"
+      control={control}
+      sx={{ mb: 4 }} 
+    />
+  )

   if (members.length === 0) {
     return (
       <>
-        <Searchbar 
-          variant="outlined" 
-          size="small" 
-          isPending={isPending} 
-          onChange={(e) => handleSearch(e.target.value)} 
-          onClear={() => handleSearchClear()} 
-          name="search"
-          control={control}
-          sx={{ mb: 4 }} 
-        />
+        {searchBar}
         // ... rest of the code
       </>
     )
   }

   return (
     <>
-      <Searchbar 
-        variant="outlined" 
-        size="small" 
-        isPending={isPending} 
-        onChange={(e) => handleSearch(e.target.value)} 
-        onClear={() => handleSearchClear()} 
-        name="search"
-        control={control}
-        sx={{ mb: 4 }} 
-      />
+      {searchBar}
       // ... rest of the code
     </>
   )

Also applies to: 96-105

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 46c7611d4169ab6f9bf09797da97b4de891c2479 and 1e57cb34729fa538a7dde63219e12509ba6a089b.

📒 Files selected for processing (3)
  • packages/components/modules/profiles/Members/MembersList/index.tsx (4 hunks)
  • packages/components/modules/profiles/Members/index.tsx (3 hunks)
  • packages/components/modules/profiles/Members/types.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/components/modules/profiles/Members/types.ts
  • packages/components/modules/profiles/Members/index.tsx
🔇 Additional comments (2)
packages/components/modules/profiles/Members/MembersList/index.tsx (2)

1-9: LGTM! Appropriate imports for search functionality.

The added imports support the search feature requirements with React's useTransition for smooth state updates and the reusable Searchbar component as specified in the PR objectives.


25-27: Add debouncing to search refetch and loading state.

The current implementation triggers a refetch on every searchQuery change, which could lead to performance issues.

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

🧹 Nitpick comments (1)
packages/components/modules/profiles/Members/MembersList/index.tsx (1)

84-93: Extract duplicated Searchbar component.

The Searchbar component configuration is duplicated. Consider extracting it into a separate component or variable to maintain DRY principles.

+const SearchbarComponent = () => (
+  <Searchbar 
+    variant="outlined" 
+    size="small" 
+    isPending={isPending} 
+    onChange={(e) => handleSearch(e.target.value)} 
+    onClear={() => handleSearchClear()} 
+    name="search"
+    control={control}
+    sx={{ mb: 4 }} 
+  />
+)

 if (members.length === 0) {
   return (
     <>
-      <Searchbar {...} />
+      <SearchbarComponent />
       ...
     </>
   )
 }

 return (
   <>
-    <Searchbar {...} />
+    <SearchbarComponent />
     ...
   </>
 )

Also applies to: 104-113

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1e57cb34729fa538a7dde63219e12509ba6a089b and eed60a9f6059a0861691de42f17a2ccbc9015d3f.

📒 Files selected for processing (5)
  • packages/components/modules/profiles/Members/MemberItem/index.tsx (2 hunks)
  • packages/components/modules/profiles/Members/MemberItem/types.ts (1 hunks)
  • packages/components/modules/profiles/Members/MemberListItem/index.tsx (3 hunks)
  • packages/components/modules/profiles/Members/MemberListItem/types.ts (1 hunks)
  • packages/components/modules/profiles/Members/MembersList/index.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Component Test Applications and Packages
  • GitHub Check: Lint
🔇 Additional comments (4)
packages/components/modules/profiles/Members/MemberItem/types.ts (1)

19-19: LGTM! Type definition is correct.

The optional searchQuery prop is properly typed as string.

packages/components/modules/profiles/Members/MemberListItem/types.ts (1)

14-14: LGTM! Consistent type definition.

The searchQuery prop type matches the MemberItemProps interface, maintaining consistency.

packages/components/modules/profiles/Members/MembersList/index.tsx (2)

27-29: Add debouncing to search refetch and loading state.

The current implementation triggers a refetch on every searchQuery change, which could lead to performance issues.


77-77: Implementation successfully meets search requirements!

The search functionality correctly implements:

  • Case-insensitive search through the relay refetch
  • Clear button functionality
  • Search query propagation to child components

Also applies to: 97-97

@luisguareschi luisguareschi force-pushed the BA-2084-Multiple-Profiles-Search-Bar branch from 2b72a02 to 44a1393 Compare January 21, 2025 10:04
@luisguareschi luisguareschi force-pushed the BA-2084-Multiple-Profiles-Search-Bar branch from 6bc9062 to b85a8ac Compare January 21, 2025 14:22
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)
packages/components/CHANGELOG.md (1)

7-7: Enhance the changelog entry for clarity and completeness.

Consider revising the changelog entry to be more specific and grammatically correct:

- Added search bar to members list. User can search for members by first name, last name and email.
+ Added search bar to the members' list, allowing users to perform case-insensitive searches by members' first name, last name, and email address. The search supports partial matches and includes a clear button to reset results.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~7-~7: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...## Patch Changes - Added search bar to members list. User can search for members by fi...

(AI_HYDRA_LEO_APOSTROPHE_S_XS)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eed60a9f6059a0861691de42f17a2ccbc9015d3f and 5295e9eb93381c8e8d7a4f76b2cc573ca2aba8ca.

⛔ Files ignored due to path filters (78)
  • packages/components/__generated__/ActivityLogsFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ActivityLogsPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ActivityLogsQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/AddProfilePopoverUserQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/AllProfilesListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/AllProfilesListPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ArchiveChatRoomMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/BlockToggleFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/BlockToggleMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ChangeUserRoleMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ChatRoomMessagesListPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ChatRoomParticipantsPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ChatRoomQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ChatRoomsQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentCreateMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentDeleteMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentItemRefetchQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentItemWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentItem_comment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentItem_target.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentPinMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentUpdateMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsForTestingQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsListPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsListWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsList_comments.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsRefetchQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsSubscription.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsUpdateWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CommentsWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/CreateChatRoomMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/FollowToggleMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/FollowToggleUpdatableFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/GroupDetailsQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/GroupTitleFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/LastMessageFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/MemberItemFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/MembersListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/MessageItemFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/MessagesListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationItemFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationItemWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationUserMenuFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationsListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationsListQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationsMarkAllAsReadMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationsMarkAsReadMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/NotificationsPopoverQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/OrganizationCreateMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ProfileComponentFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ProfileItemFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ProfileUpdateMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ProfilesListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ProfilesListQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ReactionButtonMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ReactionButtonWithQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ReactionButton_target.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/ReadMessagesMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/RoomFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/RoomTitleFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/RoomsListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/SendMessageMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/TitleFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UnreadChatMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UnreadMessagesCountFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UpdateChatRoomMutation.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UserMembersListFragment.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UserMembersListPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/UserProfileQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/chatRoomsPaginationQuery.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/notificationsListRefetchable.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/profilesListRefetchable.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/useMessageCountUpdateSubscription.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/useMessagesListSubscription.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/useNotificationsSubscription.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/useRoomListSubscription.graphql.ts is excluded by !**/__generated__/**
  • packages/components/__generated__/userMembersListPaginationRefetchable.graphql.ts is excluded by !**/__generated__/**
📒 Files selected for processing (1)
  • packages/components/CHANGELOG.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/components/CHANGELOG.md

[uncategorized] ~7-~7: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...## Patch Changes - Added search bar to members list. User can search for members by fi...

(AI_HYDRA_LEO_APOSTROPHE_S_XS)

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Unit Test Applications and Packages
  • GitHub Check: Component Test Applications and Packages
  • GitHub Check: Lint
🔇 Additional comments (1)
packages/components/CHANGELOG.md (1)

3-4: LGTM! Version and change type are appropriate.

The version increment (0.0.51) and classification as a patch change are appropriate for this feature addition, as it enhances functionality without breaking changes.

@luisguareschi luisguareschi force-pushed the BA-2084-Multiple-Profiles-Search-Bar branch 2 times, most recently from a823c3d to 475d53c Compare January 21, 2025 17:03
luisguareschi and others added 6 commits January 21, 2025 18:05
- Added a search bar to filter members in the MembersSuspended component.
- Introduced `searchQuery` prop in Members and UserMembersProps interfaces.
- Updated the UserMembersList GraphQL query to accept a search query parameter.
- Refactored MembersList to refetch data based on the search query input.

Signed-off-by: luisguareschi <lg@tsl.io>
Signed-off-by: luisguareschi <luisguareschi@hotmail.com>
Signed-off-by: luisguareschi <lg@tsl.io>
Signed-off-by: luisguareschi <luisguareschi@hotmail.com>
Signed-off-by: luisguareschi <lg@tsl.io>
Signed-off-by: luisguareschi <luisguareschi@hotmail.com>
Signed-off-by: luisguareschi <lg@tsl.io>
Signed-off-by: luisguareschi <luisguareschi@hotmail.com>
Signed-off-by: luisguareschi <lg@tsl.io>
Signed-off-by: luisguareschi <luisguareschi@hotmail.com>
Signed-off-by: luisguareschi <lg@tsl.io>
Signed-off-by: luisguareschi <luisguareschi@hotmail.com>
@luisguareschi luisguareschi force-pushed the BA-2084-Multiple-Profiles-Search-Bar branch from 475d53c to 42d83d1 Compare January 21, 2025 17:05
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
60.3% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

@luisguareschi luisguareschi merged commit 8732aa9 into master Jan 21, 2025
8 of 9 checks passed
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.

3 participants