diff --git a/src/authz-module/components/TableControlBar/MultipleChoiceFilter.test.tsx b/src/authz-module/components/TableControlBar/MultipleChoiceFilter.test.tsx
index bce91585..72e25d4a 100644
--- a/src/authz-module/components/TableControlBar/MultipleChoiceFilter.test.tsx
+++ b/src/authz-module/components/TableControlBar/MultipleChoiceFilter.test.tsx
@@ -79,6 +79,29 @@ describe('MultipleChoiceFilter', () => {
);
});
+ it.each([false, true])('preserves focus when duplicate display names are filtered (grouped: %s)', async (isGrouped) => {
+ const user = userEvent.setup();
+ const filterChoices = ['first', 'second', 'third'].map((value) => ({
+ displayName: 'Same name', value, groupName: 'Group A',
+ }));
+ const props = { ...defaultProps, filterChoices, filterValue: ['second'], isGrouped };
+ const { rerender } = renderWrapper();
+ await user.click(screen.getByRole('button', { name: 'Test Filter (1)' }));
+ await user.tab();
+ await user.tab();
+ const selectedCheckbox = screen.getByRole('checkbox', { checked: true });
+ expect(selectedCheckbox).toHaveFocus();
+
+ rerender();
+
+ const checkboxes = screen.getAllByRole('checkbox');
+ expect(checkboxes).toHaveLength(1);
+ expect(checkboxes[0]).toBe(selectedCheckbox);
+ expect(checkboxes[0]).toHaveAttribute('value', 'second');
+ expect(checkboxes[0]).toBeChecked();
+ expect(checkboxes[0]).toHaveFocus();
+ });
+
it('calls setFilter when option is selected', async () => {
const user = userEvent.setup();
const mockSetFilter = jest.fn();
diff --git a/src/authz-module/components/TableControlBar/MultipleChoiceFilter.tsx b/src/authz-module/components/TableControlBar/MultipleChoiceFilter.tsx
index abdd9949..9834a8fb 100644
--- a/src/authz-module/components/TableControlBar/MultipleChoiceFilter.tsx
+++ b/src/authz-module/components/TableControlBar/MultipleChoiceFilter.tsx
@@ -1,5 +1,5 @@
import {
- Dropdown, Form, Icon, Stack,
+ Alert, Dropdown, Form, Icon, Stack,
} from '@openedx/paragon';
import { useIntl } from '@openedx/frontend-base';
import { FilterList, Info, Search } from '@openedx/paragon/icons';
@@ -18,6 +18,7 @@ const MultipleChoiceFilter = ({
onSearchChange,
iconSrc,
disabled = false,
+ errorMessage,
size = 'sm',
}: MultipleChoiceFilterProps) => {
const [searchValue, setSearchValue] = useState(undefined);
@@ -87,15 +88,21 @@ const MultipleChoiceFilter = ({
aria-label={filterButtonText}
value={checkedBoxes}
>
-
- {formatMessage(messages['authz.table.controlbar.filters.items.showing'], { current: filterChoices.length, total: filterChoices.length })}
-
+ {errorMessage ? (
+
+ {errorMessage}
+
+ ) : (
+
+ {formatMessage(messages['authz.table.controlbar.filters.items.showing'], { current: filterChoices.length, total: filterChoices.length })}
+
+ )}
{!isGrouped ? filterChoices.map(({
displayName, value, description,
}) => (
handleClickCheckbox(value, displayName)}
@@ -117,7 +124,7 @@ const MultipleChoiceFilter = ({
{options.map(({ displayName, value, description }) => (
handleClickCheckbox(value, displayName)}
disabled={checkedBoxes.includes(value) ? false : disabled}
diff --git a/src/authz-module/components/TableControlBar/RolesFilter.test.tsx b/src/authz-module/components/TableControlBar/RolesFilter.test.tsx
index 022fe43a..6dd85d89 100644
--- a/src/authz-module/components/TableControlBar/RolesFilter.test.tsx
+++ b/src/authz-module/components/TableControlBar/RolesFilter.test.tsx
@@ -1,27 +1,22 @@
import { screen, within } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
-import { renderWrapper } from '@src/testUtils';
-import { useValidateUserPermissionsNonSuspense } from '@src/data/hooks';
+import { renderWithAllProviders } from '@src/testUtils';
+import { SCOPE_TYPES } from '@src/authz-module/constants';
+import { authzCatalog, mockAuthzCatalog } from '@src/authz-module/catalog/testUtils';
+import { getScopeCatalog } from '@src/authz-module/catalog/utils';
import { useCourseAuthoringFlag } from '@src/authz-module/hooks/useCourseAuthoringFlag';
-import { CONTENT_COURSE_PERMISSIONS, CONTENT_LIBRARY_PERMISSIONS } from '@src/authz-module/roles-permissions';
import RolesFilter from './RolesFilter';
-jest.mock('@src/data/hooks', () => ({
- useValidateUserPermissionsNonSuspense: jest.fn(),
+jest.mock('@src/authz-module/catalog/data/hooks', () => ({
+ useAuthzCatalog: jest.fn(),
}));
jest.mock('@src/authz-module/hooks/useCourseAuthoringFlag', () => ({
useCourseAuthoringFlag: jest.fn(),
}));
-const mockUsePermissions = useValidateUserPermissionsNonSuspense as jest.Mock;
const mockUseCourseAuthoringFlag = useCourseAuthoringFlag as jest.Mock;
-const permissionsData = ({ library, course }: { library?: boolean; course?: boolean }) => [
- { action: CONTENT_LIBRARY_PERMISSIONS.VIEW_LIBRARY_TEAM, allowed: !!library },
- { action: CONTENT_COURSE_PERMISSIONS.VIEW_COURSE_TEAM, allowed: !!course },
-];
-
describe('RolesFilter', () => {
const defaultProps = {
filterButtonText: 'Roles',
@@ -37,7 +32,7 @@ describe('RolesFilter', () => {
beforeEach(() => {
jest.clearAllMocks();
- mockUsePermissions.mockReturnValue({ data: permissionsData({ library: true, course: true }) });
+ mockAuthzCatalog();
mockUseCourseAuthoringFlag.mockReturnValue({
isCourseAuthoringEnabled: true,
isCourseEnabled: () => true,
@@ -46,67 +41,114 @@ describe('RolesFilter', () => {
});
it('renders the filter toggle', () => {
- renderWrapper();
+ renderWithAllProviders();
expect(screen.getByText('Roles')).toBeInTheDocument();
});
it('handles disabled state', () => {
- renderWrapper();
+ renderWithAllProviders();
expect(screen.getByText('Roles')).toBeInTheDocument();
});
it('displays filter button text', () => {
- renderWrapper();
+ renderWithAllProviders();
expect(screen.getByText('Select Roles')).toBeInTheDocument();
});
it('calls setFilter with the selected role when a role is checked', async () => {
const user = userEvent.setup();
const setFilter = jest.fn();
- renderWrapper();
+ renderWithAllProviders();
const menu = await openDropdown(user);
- await user.click(menu.getByLabelText('Course Admin'));
+ await user.click(await menu.findByLabelText('Course Admin'));
expect(setFilter).toHaveBeenCalledWith(
['course_admin'],
expect.objectContaining({ value: 'course_admin', displayName: 'Course Admin' }),
);
});
- it('shows only library roles when the user can view the library scope only', async () => {
+ it('shows only the roles of the scope types the user can view', async () => {
const user = userEvent.setup();
- mockUsePermissions.mockReturnValue({ data: permissionsData({ library: true }) });
- renderWrapper();
+ // The catalog only returns the metadata of the scope types the user can view, so a user who
+ // can only view library teams gets only the library roles.
+ mockAuthzCatalog({ scopeTypes: [SCOPE_TYPES.LIBRARY] });
+ renderWithAllProviders();
const menu = await openDropdown(user);
- expect(menu.getByText('Libraries')).toBeInTheDocument();
- expect(menu.getByLabelText('Library Admin')).toBeInTheDocument();
+ expect(await menu.findByText('Libraries')).toBeInTheDocument();
expect(menu.queryByText('Courses')).not.toBeInTheDocument();
- expect(menu.queryByLabelText('Course Admin')).not.toBeInTheDocument();
+
+ getScopeCatalog(authzCatalog, SCOPE_TYPES.LIBRARY).roles.forEach(({ displayName }) => {
+ expect(menu.getByLabelText(displayName)).toBeInTheDocument();
+ });
+ getScopeCatalog(authzCatalog, SCOPE_TYPES.COURSE).roles.forEach(({ displayName }) => {
+ expect(menu.queryByLabelText(displayName)).not.toBeInTheDocument();
+ });
});
it('shows both course and library roles when the user can view both scopes', async () => {
const user = userEvent.setup();
- renderWrapper();
+ renderWithAllProviders();
const menu = await openDropdown(user);
- expect(menu.getByText('Courses')).toBeInTheDocument();
+ expect(await menu.findByText('Courses')).toBeInTheDocument();
expect(menu.getByText('Libraries')).toBeInTheDocument();
});
+ it('lists the roles of each scope type in the catalog order', async () => {
+ const user = userEvent.setup();
+ mockAuthzCatalog({ scopeTypes: [SCOPE_TYPES.LIBRARY] });
+ renderWithAllProviders();
+ const menu = await openDropdown(user);
+ await menu.findByLabelText('Library Admin');
+
+ const catalogRoles = getScopeCatalog(authzCatalog, SCOPE_TYPES.LIBRARY).roles;
+ expect(menu.getAllByRole('checkbox').map((checkbox) => checkbox.getAttribute('aria-label')))
+ .toEqual(catalogRoles.map(({ displayName }) => displayName));
+ });
+
it('shows no role options when the user cannot view any scope', async () => {
const user = userEvent.setup();
- mockUsePermissions.mockReturnValue({ data: permissionsData({}) });
- renderWrapper();
+ mockAuthzCatalog({ scopeTypes: [] });
+ renderWithAllProviders();
const menu = await openDropdown(user);
expect(menu.queryByText('Courses')).not.toBeInTheDocument();
expect(menu.queryByText('Libraries')).not.toBeInTheDocument();
+ expect(screen.queryByRole('alert')).not.toBeInTheDocument();
});
- it('shows no role options while permissions are still loading', async () => {
+ it('shows no role options while the catalog is still loading', async () => {
const user = userEvent.setup();
- mockUsePermissions.mockReturnValue({ data: undefined, isLoading: true });
- renderWrapper();
+ mockAuthzCatalog({ isLoading: true });
+ renderWithAllProviders();
const menu = await openDropdown(user);
expect(menu.queryByText('Courses')).not.toBeInTheDocument();
expect(menu.queryByText('Libraries')).not.toBeInTheDocument();
+ expect(screen.queryByRole('alert')).not.toBeInTheDocument();
+ });
+
+ it('explains a catalog failure instead of showing an empty list', async () => {
+ const user = userEvent.setup();
+ mockAuthzCatalog({ isError: true });
+ renderWithAllProviders();
+ await user.click(screen.getByRole('button', { name: 'Roles' }));
+
+ expect(screen.getByRole('alert')).toHaveTextContent('Roles could not be loaded. Please try again later.');
+ expect(screen.queryByText('Showing 0 of 0.')).not.toBeInTheDocument();
+ expect(screen.queryByRole('checkbox')).not.toBeInTheDocument();
+ });
+
+ it('restores the selected roles when the catalog recovers', async () => {
+ const user = userEvent.setup();
+ const props = { ...defaultProps, filterValue: ['library_admin'] };
+ mockAuthzCatalog({ isError: true });
+ const { rerender } = renderWithAllProviders();
+ await user.click(screen.getByRole('button', { name: 'Roles (1)' }));
+ expect(screen.getByRole('alert')).toBeInTheDocument();
+
+ mockAuthzCatalog();
+ rerender();
+
+ expect(screen.queryByRole('alert')).not.toBeInTheDocument();
+ expect(screen.getByRole('checkbox', { name: 'Library Admin' })).toBeChecked();
});
it('hides course roles when the course-authoring flag is disabled', async () => {
@@ -116,9 +158,9 @@ describe('RolesFilter', () => {
isCourseEnabled: () => false,
isLoading: false,
});
- renderWrapper();
+ renderWithAllProviders();
const menu = await openDropdown(user);
- expect(menu.getByText('Libraries')).toBeInTheDocument();
+ expect(await menu.findByText('Libraries')).toBeInTheDocument();
expect(menu.queryByText('Courses')).not.toBeInTheDocument();
expect(menu.queryByLabelText('Course Admin')).not.toBeInTheDocument();
});
@@ -130,7 +172,7 @@ describe('RolesFilter', () => {
isCourseEnabled: () => false,
isLoading: true,
});
- renderWrapper();
+ renderWithAllProviders();
const menu = await openDropdown(user);
expect(menu.queryByText('Courses')).not.toBeInTheDocument();
expect(menu.queryByText('Libraries')).not.toBeInTheDocument();
diff --git a/src/authz-module/components/TableControlBar/RolesFilter.tsx b/src/authz-module/components/TableControlBar/RolesFilter.tsx
index d627dcec..ed42e594 100644
--- a/src/authz-module/components/TableControlBar/RolesFilter.tsx
+++ b/src/authz-module/components/TableControlBar/RolesFilter.tsx
@@ -1,31 +1,50 @@
-import { useMemo } from 'react';
+import { ComponentType, useMemo } from 'react';
import { useIntl } from '@openedx/frontend-base';
+import type { MessageDescriptor } from '@openedx/frontend-base';
import { Person } from '@openedx/paragon/icons';
-import { useViewTeamPermissions } from '@src/authz-module/hooks/useViewTeamPermissions';
import { useCourseAuthoringFlag } from '@src/authz-module/hooks/useCourseAuthoringFlag';
-import { CONTEXT_TYPES } from '@src/authz-module/constants';
+import { SCOPE_TYPES } from '@src/authz-module/constants';
+import { useAuthzCatalog } from '@src/authz-module/catalog';
+import { RESOURCE_ICONS } from '@src/authz-module/components/constants';
+import messages from '@src/authz-module/components/messages';
import MultipleChoiceFilter from './MultipleChoiceFilter';
-import { MultipleChoiceFilterProps } from './types';
-import { getRolesFiltersOptions } from '@src/authz-module/components/constants';
+import { FilterChoice, MultipleChoiceFilterProps } from './types';
-type RolesFilterProps = Omit;
+type RolesFilterProps = Omit;
+
+// Group shown for the roles of each scope type.
+const SCOPE_TYPE_GROUPS: Partial> = {
+ [SCOPE_TYPES.COURSE]: { message: messages['authz.team.members.table.group.courses'], icon: RESOURCE_ICONS.COURSE },
+ [SCOPE_TYPES.LIBRARY]: { message: messages['authz.team.members.table.group.libraries'], icon: RESOURCE_ICONS.LIBRARY },
+};
const RolesFilter = ({
filterButtonText, filterValue, setFilter, disabled,
}: RolesFilterProps) => {
const intl = useIntl();
- const { isCourseViewAllowed, isLibraryViewAllowed, isLoading } = useViewTeamPermissions();
+ // The catalog only holds the scope types the user can view.
+ const {
+ scopeTypes, getScopeCatalog, isLoading, isError,
+ } = useAuthzCatalog();
const { isCourseAuthoringEnabled, isLoading: isFlagLoading } = useCourseAuthoringFlag();
- const rolesOptions = useMemo(() => {
+ const rolesOptions = useMemo(() => {
if (isLoading || isFlagLoading) return [];
- return getRolesFiltersOptions(intl).filter((option) => {
- // Authoring (course) roles require both view permission and the course-authoring flag.
- if (option.contextType === CONTEXT_TYPES.COURSE) return isCourseViewAllowed && isCourseAuthoringEnabled;
- if (option.contextType === CONTEXT_TYPES.LIBRARY) return isLibraryViewAllowed;
- return false;
- });
- }, [intl, isCourseViewAllowed, isLibraryViewAllowed, isCourseAuthoringEnabled, isLoading, isFlagLoading]);
+ return scopeTypes
+ // Authoring (course) roles also require the course-authoring flag.
+ .filter((scopeType) => scopeType !== SCOPE_TYPES.COURSE || isCourseAuthoringEnabled)
+ .flatMap((scopeType) => {
+ const group = SCOPE_TYPE_GROUPS[scopeType];
+ const groupName = group ? intl.formatMessage(group.message) : scopeType;
+ return (getScopeCatalog(scopeType)?.roles ?? []).map((role) => ({
+ groupName,
+ groupIcon: group?.icon,
+ displayName: role.displayName,
+ value: role.role,
+ }));
+ });
+ }, [intl, scopeTypes, getScopeCatalog, isCourseAuthoringEnabled, isLoading, isFlagLoading]);
+
return (
);
};
diff --git a/src/authz-module/components/TableControlBar/TableControlBar.test.tsx b/src/authz-module/components/TableControlBar/TableControlBar.test.tsx
index b12235c8..7cb09ea9 100644
--- a/src/authz-module/components/TableControlBar/TableControlBar.test.tsx
+++ b/src/authz-module/components/TableControlBar/TableControlBar.test.tsx
@@ -1,5 +1,6 @@
import { screen } from '@testing-library/react';
-import { renderWrapper } from '@src/testUtils';
+import { renderWithAllProviders } from '@src/testUtils';
+import { mockAuthzCatalog } from '@src/authz-module/catalog/testUtils';
import { DataTableContext, TextFilter } from '@openedx/paragon';
import userEvent from '@testing-library/user-event';
import TableControlBar from './TableControlBar';
@@ -34,6 +35,10 @@ const mockState = {
],
};
+jest.mock('@src/authz-module/catalog/data/hooks', () => ({
+ useAuthzCatalog: jest.fn(),
+}));
+
jest.mock('@src/authz-module/hooks/useCourseAuthoringFlag', () => ({
useCourseAuthoringFlag: () => ({
isCourseAuthoringEnabled: true,
@@ -51,8 +56,8 @@ jest.mock('@src/authz-module/data/hooks', () => ({
useScopes: () => ({ data: { results: [] } }),
}));
-// RolesFilter validates view-team permissions to decide which role groups to show.
-// Grant both so the full course/library role set renders for these wiring tests.
+// ScopesFilter and OrgFilter read the view-team permissions to decide what to show.
+// Grant both so the full course/library filters render for these wiring tests.
jest.mock('@src/data/hooks', () => {
const { CONTENT_COURSE_PERMISSIONS, CONTENT_LIBRARY_PERMISSIONS } = jest.requireActual('@src/authz-module/roles-permissions');
return {
@@ -74,7 +79,7 @@ describe('TableControlBar', () => {
const renderWithContext = (component, contextOverride = {}) => {
const context = { ...mockDataTableContext, ...contextOverride };
- return renderWrapper(
+ return renderWithAllProviders(
{component}
,
@@ -83,6 +88,7 @@ describe('TableControlBar', () => {
beforeEach(() => {
jest.clearAllMocks();
+ mockAuthzCatalog();
mockSetAllFilters.mockClear();
mockOnFilterChange.mockClear();
});
diff --git a/src/authz-module/components/TableControlBar/types.ts b/src/authz-module/components/TableControlBar/types.ts
index 8f626e7f..a5dd3c45 100644
--- a/src/authz-module/components/TableControlBar/types.ts
+++ b/src/authz-module/components/TableControlBar/types.ts
@@ -16,5 +16,6 @@ export interface MultipleChoiceFilterProps {
onSearchChange?: (value: string) => void;
iconSrc?: React.ComponentType | undefined;
disabled?: boolean;
+ errorMessage?: string;
size?: 'sm' | 'md' | 'lg' | 'inline';
}
diff --git a/src/authz-module/components/constants.ts b/src/authz-module/components/constants.ts
index 757a9787..e5380a57 100644
--- a/src/authz-module/components/constants.ts
+++ b/src/authz-module/components/constants.ts
@@ -1,81 +1,4 @@
-import type { IntlShape } from '@openedx/frontend-base';
import { AccountBalance, Language, LibraryBooks, School } from '@openedx/paragon/icons';
-import messages from './messages';
-
-export const getRolesFiltersOptions = (intl: IntlShape) => [
- {
- groupName: intl.formatMessage(messages['authz.team.members.table.group.global']),
- groupIcon: Language,
- displayName: 'Super Admin',
- value: 'super_admin',
- contextType: 'global',
- },
- {
- groupName: intl.formatMessage(messages['authz.team.members.table.group.global']),
- groupIcon: Language,
- displayName: 'Global Staff',
- value: 'global_staff',
- contextType: 'global',
- },
-
- {
- groupName: intl.formatMessage(messages['authz.team.members.table.group.courses']),
- groupIcon: School,
- displayName: 'Course Admin',
- value: 'course_admin',
- contextType: 'course',
- },
- {
- groupName: intl.formatMessage(messages['authz.team.members.table.group.courses']),
- groupIcon: School,
- displayName: 'Course Staff',
- value: 'course_staff',
- contextType: 'course',
- },
- {
- groupName: intl.formatMessage(messages['authz.team.members.table.group.courses']),
- groupIcon: School,
- displayName: 'Course Editor',
- value: 'course_editor',
- contextType: 'course',
- },
- {
- groupName: intl.formatMessage(messages['authz.team.members.table.group.courses']),
- groupIcon: School,
- displayName: 'Course Auditor',
- value: 'course_auditor',
- contextType: 'course',
- },
-
- {
- groupName: intl.formatMessage(messages['authz.team.members.table.group.libraries']),
- groupIcon: LibraryBooks,
- displayName: 'Library Admin',
- value: 'library_admin',
- contextType: 'library',
- },
- {
- groupName: intl.formatMessage(messages['authz.team.members.table.group.libraries']),
- groupIcon: LibraryBooks,
- displayName: 'Library Author',
- value: 'library_author',
- contextType: 'library',
- },
- {
- groupName: intl.formatMessage(messages['authz.team.members.table.group.libraries']),
- groupIcon: LibraryBooks,
- displayName: 'Library Contributor',
- value: 'library_contributor',
- contextType: 'library',
- },
- {
- groupName: intl.formatMessage(messages['authz.team.members.table.group.libraries']),
- groupIcon: LibraryBooks,
- displayName: 'Library User',
- value: 'library_user',
- contextType: 'library',
- },
-];
export const RESOURCE_ICONS = {
COURSE: School,
diff --git a/src/authz-module/components/messages.ts b/src/authz-module/components/messages.ts
index 3a87ea59..6d81cbea 100644
--- a/src/authz-module/components/messages.ts
+++ b/src/authz-module/components/messages.ts
@@ -31,6 +31,11 @@ const messages = defineMessages({
defaultMessage: 'Search',
description: 'Search placeholder for two specific fields',
},
+ 'authz.table.controlbar.roles.error': {
+ id: 'authz.table.controlbar.roles.error',
+ defaultMessage: 'Roles could not be loaded. Please try again later.',
+ description: 'Error displayed in the roles filter when the authorization catalog cannot be loaded',
+ },
'authz.table.controlbar.search.by.fields': {
id: 'authz.table.controlbar.search.by.fields',
defaultMessage: 'Search by {firstField} or {secondField}',
@@ -92,11 +97,6 @@ const messages = defineMessages({
defaultMessage: 'Libraries',
description: 'Label for the "Libraries" group in the team members table filters',
},
- 'authz.team.members.table.group.global': {
- id: 'authz.team.members.table.group.global',
- defaultMessage: 'Global',
- description: 'Label for the "Global" group in the team members table filters',
- },
'authz.table.controlbar.filters.more.results': {
id: 'authz.table.controlbar.filters.more.results',
defaultMessage: 'Search to show more',