feat: course team filters

Author: diana-villalvazo-wgu

src/app.scss

@@ -8,3 +8,7 @@
 .text-prewrap {
     white-space: pre-wrap;
 }
+
+.username .form-control::placeholder {
+    font-size: var(--pgn-typography-form-input-font-size-sm);
+}

src/components/UsernameFilter.test.tsx

@@ -0,0 +1,23 @@
+import { screen } from '@testing-library/react';
+import UsernameFilter from './UsernameFilter';
+import { renderWithIntl } from '../testUtils';
+import messages from './messages';
+
+describe('UsernameFilter', () => {
+  const setup = (filterValue = '', setFilter = jest.fn()) => {
+    renderWithIntl(
+      <UsernameFilter column={{ filterValue, setFilter }} />
+    );
+    return { setFilter };
+  };
+
+  it('shows the placeholder correctly', () => {
+    setup();
+    expect(screen.getByPlaceholderText(messages.searchPlaceholder.defaultMessage)).toBeInTheDocument();
+  });
+
+  it('shows the initial value correctly', () => {
+    setup('value');
+    expect(screen.getByDisplayValue('value')).toBeInTheDocument();
+  });
+});

src/components/UsernameFilter.tsx

@@ -0,0 +1,29 @@
+import { useIntl } from '@openedx/frontend-base';
+import { FormControl, Icon } from '@openedx/paragon';
+import { Search } from '@openedx/paragon/icons';
+import { useDebouncedFilter } from '@src/hooks/useDebouncedFilter';
+import messages from './messages';
+
+const UsernameFilter = ({ column: { filterValue, setFilter } }: { column: { filterValue: string, setFilter: (value: string) => void } }) => {
+  const intl = useIntl();
+  const { inputValue, handleChange } = useDebouncedFilter({
+    filterValue,
+    setFilter,
+  });
+
+  const handleInputChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+    handleChange(e.target.value);
+  };
+
+  return (
+    <FormControl
+      className="mb-0 username"
+      onChange={handleInputChange}
+      placeholder={intl.formatMessage(messages.searchPlaceholder)}
+      trailingElement={<Icon src={Search} />}
+      value={inputValue}
+    />
+  );
+};
+
+export default UsernameFilter;

src/components/messages.ts

@@ -116,6 +116,11 @@ const messages = defineMessages({
     defaultMessage: 'Could not find student matching identifier: {identifier}',
     description: 'Error message displayed when a learner cannot be found based on the provided identifier (email or username)',
   },
+  searchPlaceholder: {
+    id: 'instruct.usernameFilter.searchPlaceholder',
+    defaultMessage: 'Search By Username or Email',
+    description: 'Placeholder text for the username filter input',
+  }
 });
 
 export default messages;

src/courseInfo/components/EnrollmentSummary/EnrollmentSummary.test.tsx

@@ -46,7 +46,6 @@ describe('EnrollmentSummary', () => {
       isLoading: false,
     });
     renderWithIntl(<EnrollmentSummary />);
-    screen.debug();
 
     expect(screen.getByText(messages.allEnrollmentsLabel.defaultMessage)).toBeInTheDocument();
     expect(screen.getByText(formatNumberWithCommas(mockCounter.enrollmentCounts.total))).toBeInTheDocument();

src/courseTeam/components/MembersContent.test.tsx

@@ -1,14 +1,15 @@
 import { screen } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import { renderWithIntl } from '@src/testUtils';
-import { useTeamMembers } from '../data/apiHook';
+import { useRoles, useTeamMembers } from '../data/apiHook';
 import MembersContent from './MembersContent';
 import messages from '../messages';
 
 const courseId = 'course-v1:edX+DemoX+Demo_Course';
 
 jest.mock('../data/apiHook', () => ({
   useTeamMembers: jest.fn(),
+  useRoles: jest.fn(),
 }));
 
 jest.mock('react-router-dom', () => ({
@@ -21,11 +22,14 @@ const mockTeamMembers = [
   { username: 'user2', email: 'user2@example.com', role: 'Staff' },
 ];
 
+const mockRoles = { results: [{ role: 'Admin', displayName: 'Admin' }, { role: 'Staff', displayName: 'Staff' }] };
+
 const renderComponent = () => renderWithIntl(<MembersContent />);
 
 describe('MembersContent', () => {
   beforeEach(() => {
     jest.clearAllMocks();
+    (useRoles as jest.Mock).mockReturnValue({ data: mockRoles, isLoading: false });
   });
 
   it('renders loading state correctly', () => {
@@ -48,10 +52,10 @@ describe('MembersContent', () => {
 
     expect(screen.getByText(mockTeamMembers[0].username)).toBeInTheDocument();
     expect(screen.getByText(mockTeamMembers[0].email)).toBeInTheDocument();
-    expect(screen.getByText(mockTeamMembers[0].role)).toBeInTheDocument();
+    expect(screen.getByRole('cell', { name: mockTeamMembers[0].role })).toBeInTheDocument();
     expect(screen.getByText(mockTeamMembers[1].username)).toBeInTheDocument();
     expect(screen.getByText(mockTeamMembers[1].email)).toBeInTheDocument();
-    expect(screen.getByText(mockTeamMembers[1].role)).toBeInTheDocument();
+    expect(screen.getByRole('cell', { name: mockTeamMembers[1].role })).toBeInTheDocument();
   });
 
   it('renders empty state when no team members', () => {

src/courseTeam/components/MembersContent.tsx

@@ -1,22 +1,59 @@
-import { useState, useCallback, useMemo } from 'react';
+import { useState, useMemo } from 'react';
 import { useParams } from 'react-router-dom';
 import { useIntl } from '@openedx/frontend-base';
-import { Button, DataTable } from '@openedx/paragon';
+import { Button, DataTable, FormControl, Icon } from '@openedx/paragon';
 import messages from '../messages';
-import { useTeamMembers } from '../data/apiHook';
+import { useRoles, useTeamMembers } from '../data/apiHook';
+import UsernameFilter from '@src/components/UsernameFilter';
+import { FilterList } from '@openedx/paragon/icons';
+import { DataTableFetchDataProps } from '@src/types';
+import { Role } from '../types';
 
 const TEAM_MEMBERS_PAGE_SIZE = 25;
 
+const RoleFilter = ({ column: { filterValue, setFilter } }: { column: { filterValue: string, setFilter: (value: string) => void } }) => {
+  const intl = useIntl();
+  const { courseId = '' } = useParams<{ courseId: string }>();
+  const { data } = useRoles(courseId);
+
+  const handleSelectChange = (e: React.ChangeEvent<HTMLSelectElement>) => {
+    setFilter(e.target.value);
+  };
+
+  const roles = useMemo(() => {
+    return [{ value: '', label: intl.formatMessage(messages.allRoles) }, ...(data?.results || []).map((role: Role) => ({ value: role.role, label: role.displayName }))];
+  }, [data, intl]);
+
+  return (
+    <FormControl
+      as="select"
+      className="mb-0"
+      disabled={!data}
+      name="role"
+      size="md"
+      value={filterValue}
+      onChange={handleSelectChange}
+      leadingElement={<Icon src={FilterList} />}
+    >
+      {roles.map(role => (
+        <option key={role.value} value={role.value}>
+          {role.label}
+        </option>
+      ))}
+    </FormControl>
+  );
+};
+
 const MembersContent = () => {
   const intl = useIntl();
   const { courseId = '' } = useParams<{ courseId: string }>();
   const [filters, setFilters] = useState({ page: 0, emailOrUsername: '', role: '' });
   const { data: { results: teamMembers = [], numPages = 1, count = 0 } = {}, isLoading = false } = useTeamMembers(courseId, { ...filters, pageSize: TEAM_MEMBERS_PAGE_SIZE });
 
   const tableColumns = useMemo(() => [
-    { accessor: 'username', Header: intl.formatMessage(messages.username) },
-    { accessor: 'email', Header: intl.formatMessage(messages.email) },
-    { accessor: 'role', Header: intl.formatMessage(messages.role) },
+    { accessor: 'username', Header: intl.formatMessage(messages.username), Filter: UsernameFilter },
+    { accessor: 'email', Header: intl.formatMessage(messages.email), disableFilters: true },
+    { accessor: 'role', Header: intl.formatMessage(messages.role), Filter: RoleFilter },
   ], [intl]);
 
   const additionalColumns = useMemo(() => [{
@@ -29,17 +66,27 @@ const MembersContent = () => {
     )
   }], [intl]);
 
-  const handleFetchData = useCallback(({ pageIndex, filters: tableFilters }: { pageIndex: number, filters: { id: string, value: string }[] }) => {
-    // Filters will be handled in a future iteration, for now we will just update pagination
-    console.log(pageIndex, tableFilters);
-    if (pageIndex !== filters.page) {
-      setFilters(prevFilters => ({
+  const handleFetchData = (data: DataTableFetchDataProps) => {
+    const usernameFilter = data.filters?.find((f) => f.id === 'username');
+    const newEmailOrUsername = usernameFilter ? usernameFilter.value : '';
+    const rolesFilter = data.filters?.find((f) => f.id === 'role');
+    const newRole = rolesFilter ? rolesFilter.value : '';
+    const filtersChanged = (newEmailOrUsername !== filters.emailOrUsername) || (newRole !== filters.role);
+
+    if (filtersChanged) {
+      setFilters((prevFilters) => ({
         ...prevFilters,
-        page: pageIndex,
+        emailOrUsername: newEmailOrUsername,
+        role: newRole,
+        page: 0,
       }));
+      return;
+    }
+
+    if (data.pageIndex !== filters.page) {
+      setFilters((prevFilters) => ({ ...prevFilters, page: data.pageIndex }));
     }
-  // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, []);
+  };
 
   const tableState = useMemo(() => ({
     pageIndex: filters.page,
@@ -53,11 +100,13 @@ const MembersContent = () => {
       data={teamMembers}
       fetchData={handleFetchData}
       state={tableState}
+      isFilterable
       isLoading={isLoading}
       isPaginated
       itemCount={count}
       manualFilters
       manualPagination
+      numBreakoutFilters={2}
       pageSize={TEAM_MEMBERS_PAGE_SIZE}
       pageCount={numPages}
       RowStatusComponent={() => null}

src/courseTeam/messages.ts

@@ -51,6 +51,11 @@ const messages = defineMessages({
     defaultMessage: 'No team members found.',
     description: 'Message displayed when there are no team members',
   },
+  allRoles: {
+    id: 'instruct.courseTeam.allRoles',
+    defaultMessage: 'All Roles',
+    description: 'Option label for filtering by all roles',
+  },
 });
 
 export default messages;

src/dateExtensions/components/DateExtensionsList.test.tsx

@@ -86,7 +86,7 @@ describe('DateExtensionsList', () => {
     renderComponent({});
     const user = userEvent.setup();
 
-    const searchInput = screen.getByPlaceholderText(/search for a learner/i);
+    const searchInput = screen.getByPlaceholderText(/search by username or email/i);
     expect(searchInput).toBeInTheDocument();
 
     await user.type(searchInput, 'test_user');
@@ -106,7 +106,7 @@ describe('DateExtensionsList', () => {
     renderComponent({});
     const user = userEvent.setup();
 
-    const searchInput = screen.getByPlaceholderText(/search for a learner/i);
+    const searchInput = screen.getByPlaceholderText(/search by username or email/i);
 
     // Type multiple characters quickly
     await user.type(searchInput, 'test');
@@ -171,7 +171,7 @@ describe('DateExtensionsList', () => {
     }
 
     // Now apply a filter
-    const searchInput = screen.getByPlaceholderText(/search for a learner/i);
+    const searchInput = screen.getByPlaceholderText(/search by username or email/i);
     await user.type(searchInput, 'test');
 
     // Should reset to page 0 when filter changes
@@ -217,7 +217,7 @@ describe('DateExtensionsList', () => {
     const user = userEvent.setup();
 
     // Apply a filter first
-    const searchInput = screen.getByPlaceholderText(/search for a learner/i);
+    const searchInput = screen.getByPlaceholderText(/search by username or email/i);
     await user.type(searchInput, 'test');
 
     // Wait for the filter to be applied

src/dateExtensions/components/DateExtensionsList.tsx

@@ -1,14 +1,14 @@
 import { useState } from 'react';
 import { useParams } from 'react-router-dom';
 import { useIntl } from '@openedx/frontend-base';
-import { Button, DataTable, FormControl, Icon } from '@openedx/paragon';
+import { Button, DataTable } from '@openedx/paragon';
 import messages from '../messages';
 import { LearnerDateExtension } from '../types';
 import { useDateExtensions } from '../data/apiHook';
-import { Search } from '@openedx/paragon/icons';
 import SelectGradedSubsection from './SelectGradedSubsection';
 import { useDebouncedFilter } from '../../hooks/useDebouncedFilter';
 import { DataTableFetchDataProps } from '@src/types';
+import UsernameFilter from '@src/components/UsernameFilter';
 
 const DATE_EXTENSIONS_PAGE_SIZE = 25;
 
@@ -17,28 +17,6 @@ export interface DateExtensionListProps {
   onClickAdd?: () => void,
 }
 
-const UsernameFilter = ({ column: { filterValue, setFilter } }: { column: { filterValue: string, setFilter: (value: string) => void } }) => {
-  const intl = useIntl();
-  const { inputValue, handleChange } = useDebouncedFilter({
-    filterValue,
-    setFilter,
-  });
-
-  const handleInputChange = (e: React.ChangeEvent<HTMLInputElement>) => {
-    handleChange(e.target.value);
-  };
-
-  return (
-    <FormControl
-      className="mb-0"
-      onChange={handleInputChange}
-      placeholder={intl.formatMessage(messages.searchLearnerPlaceholder)}
-      trailingElement={<Icon src={Search} />}
-      value={inputValue}
-    />
-  );
-};
-
 const GradedSubsectionFilter = ({ column: { filterValue, setFilter } }: { column: { filterValue: string, setFilter: (value: string) => void } }) => {
   const intl = useIntl();
   const { inputValue, handleChange } = useDebouncedFilter({