Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import MultipleChoiceFilter from './MultipleChoiceFilter';

describe('MultipleChoiceFilter', () => {
const defaultProps = {
filterId: 'test-column',
filterButtonText: 'Test Filter',
filterChoices: [
{ displayName: 'Option 1', value: 'option1' },
Expand Down Expand Up @@ -72,7 +73,7 @@ describe('MultipleChoiceFilter', () => {
expect(defaultProps.setFilter).toHaveBeenCalledWith(
['groupA1'],
{
groupName: 'test filter',
groupName: 'test-column',
value: 'groupA1',
displayName: 'Group A Option',
},
Expand Down Expand Up @@ -101,7 +102,7 @@ describe('MultipleChoiceFilter', () => {
expect(mockSetFilter).toHaveBeenCalledWith(
['option1'],
{
groupName: 'test filter',
groupName: 'test-column',
value: 'option1',
displayName: 'Option 1',
},
Expand All @@ -119,7 +120,7 @@ describe('MultipleChoiceFilter', () => {
expect(mockSetFilter).toHaveBeenCalledWith(
[],
{
groupName: 'test filter',
groupName: 'test-column',
value: 'option1',
displayName: 'Option 1',
},
Expand All @@ -137,7 +138,7 @@ describe('MultipleChoiceFilter', () => {
expect(mockSetFilter).toHaveBeenCalledWith(
['option1', 'option2'],
{
groupName: 'test filter',
groupName: 'test-column',
value: 'option2',
displayName: 'Option 2',
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ import {
} from '@openedx/paragon';
import { useIntl } from '@edx/frontend-platform/i18n';
import { FilterList, Info, Search } from '@openedx/paragon/icons';
import { useState } from 'react';
import { useState, useMemo } from 'react';
import messages from '../messages';
import { FilterChoice, MultipleChoiceFilterProps } from './types';

const MultipleChoiceFilter = ({
filterId,
filterButtonText,
filterChoices,
filterValue,
Expand All @@ -22,9 +23,9 @@ const MultipleChoiceFilter = ({
const { formatMessage } = useIntl();

const checkedBoxes = filterValue || [];
const handleClickCheckbox = (value, displayName) => {
const handleClickCheckbox = (value: string, displayName: string) => {
const newValue = {
groupName: filterButtonText?.toLocaleLowerCase() || '',
groupName: filterId,
value,
displayName,
};
Expand All @@ -36,7 +37,7 @@ const MultipleChoiceFilter = ({
return setFilter(newCheckedBoxes, newValue);
};

const getGroupedChoices = () => {
const groupedChoices = useMemo(() => {
const groupedFilterChoices = filterChoices.reduce((groups, choice) => {
const groupName = choice.groupName || 'Ungrouped';
const icon = choice.groupIcon || undefined;
Expand All @@ -49,9 +50,9 @@ const MultipleChoiceFilter = ({
description: choice.description,
});
return groups;
}, new Map<string, { groupName: string; options: Array<FilterChoice>; icon?: any }>());
}, new Map<string, { groupName: string; options: Array<FilterChoice>; icon?: React.ComponentType<{}> }>());
return Array.from(groupedFilterChoices.values());
};
}, [filterChoices]);

return (
<Dropdown className="no-caret-dropdown filters">
Expand Down Expand Up @@ -105,7 +106,7 @@ const MultipleChoiceFilter = ({
</div>
</Form.Checkbox>
))
: getGroupedChoices().map(({ groupName, icon, options }) => (
: groupedChoices.map(({ groupName, icon, options }) => (
<div key={groupName}>
<div className="pgn__dropdown-filter-group-name text-info-700 d-flex align-items-center small m-2 ml-0">
{icon && <Icon color="primary" src={icon} className="mr-2" size="xs" />}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ jest.mock('@src/authz-module/data/hooks', () => ({

describe('OrgFilter', () => {
const defaultProps = {
filterId: 'org',
filterButtonText: 'Organizations',
filterValue: [],
setFilter: jest.fn(),
Expand Down
3 changes: 2 additions & 1 deletion src/authz-module/components/TableControlBar/OrgFilter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import MultipleChoiceFilter from './MultipleChoiceFilter';
type OrgFilterProps = Omit<MultipleChoiceFilterProps, 'filterChoices' | 'isSearchable' | 'onSearchChange'>;

const OrgFilter = ({
filterButtonText, filterValue, setFilter, disabled,
filterId, filterButtonText, filterValue, setFilter, disabled,
}: OrgFilterProps) => {
const [searchValue, setSearchValue] = React.useState<string | undefined>(undefined);
const {
Expand All @@ -27,6 +27,7 @@ const OrgFilter = ({

return (
<MultipleChoiceFilter
filterId={filterId}
filterButtonText={filterButtonText}
filterChoices={filterChoices}
filterValue={filterValue}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import RolesFilter from './RolesFilter';

describe('RolesFilter', () => {
const defaultProps = {
filterId: 'role',
filterButtonText: 'Roles',
filterValue: [],
setFilter: jest.fn(),
Expand Down
3 changes: 2 additions & 1 deletion src/authz-module/components/TableControlBar/RolesFilter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ import { getRolesFiltersOptions } from '../constants';
type RolesFilterProps = Omit<MultipleChoiceFilterProps, 'filterChoices' | 'isSearchable' | 'onSearchChange'>;

const RolesFilter = ({
filterButtonText, filterValue, setFilter, disabled,
filterId, filterButtonText, filterValue, setFilter, disabled,
}: RolesFilterProps) => {
const intl = useIntl();
const rolesOptions = useMemo(() => getRolesFiltersOptions(intl), [intl]);
return (
<MultipleChoiceFilter
filterId={filterId}
filterButtonText={filterButtonText}
filterChoices={rolesOptions}
filterValue={filterValue}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ jest.mock('@src/authz-module/data/hooks', () => ({

describe('ScopesFilter', () => {
const defaultProps = {
filterId: 'scope',
filterButtonText: 'Scopes',
filterValue: [],
setFilter: jest.fn(),
Expand Down
17 changes: 8 additions & 9 deletions src/authz-module/components/TableControlBar/ScopesFilter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import { useIntl } from '@edx/frontend-platform/i18n';
import { LocationOn } from '@openedx/paragon/icons';
import { useScopes } from '@src/authz-module/data/hooks';
import { DEFAULT_FILTER_PAGE_SIZE } from '@src/authz-module/constants';
import { DEFAULT_FILTER_PAGE_SIZE, getScopeContextType } from '@src/authz-module/constants';

Check failure on line 5 in src/authz-module/components/TableControlBar/ScopesFilter.tsx

View workflow job for this annotation

GitHub Actions / test

Module '"@src/authz-module/constants"' has no exported member 'getScopeContextType'.
import { MultipleChoiceFilterProps } from './types';
import MultipleChoiceFilter from './MultipleChoiceFilter';
import { RESOURCE_ICONS } from '../constants';
Expand All @@ -11,24 +11,22 @@
type ScopesFilterProps = Omit<MultipleChoiceFilterProps, 'filterChoices' | 'isSearchable' | 'onSearchChange'>;

const ScopesFilter = ({
filterButtonText, filterValue, setFilter, disabled,
filterId, filterButtonText, filterValue, setFilter, disabled,
}: ScopesFilterProps) => {
const { formatMessage } = useIntl();
const [searchValue, setSearchValue] = useState<string | undefined>(undefined);
const { data: scopesData } = useScopes({ search: searchValue, pageSize: DEFAULT_FILTER_PAGE_SIZE });

const filterChoices = useMemo(() => (scopesData?.pages?.flatMap((p) => p.results) ?? []).map((scope) => {
const scopeIcon = scope.externalKey?.startsWith('lib') ? RESOURCE_ICONS.LIBRARY : RESOURCE_ICONS.COURSE;
let groupName = formatMessage(messages['authz.team.members.table.group.courses']);
if (scope.externalKey?.startsWith('lib')) {
groupName = formatMessage(messages['authz.team.members.table.group.libraries']);
}
const isLibrary = getScopeContextType(scope.externalKey ?? '') === 'library';
return {
displayName: scope.displayName,
value: scope.externalKey,
description: scope.org?.shortName,
groupName,
groupIcon: scopeIcon,
groupName: formatMessage(messages[isLibrary
? 'authz.team.members.table.group.libraries'
: 'authz.team.members.table.group.courses']),
groupIcon: isLibrary ? RESOURCE_ICONS.LIBRARY : RESOURCE_ICONS.COURSE,
};
}), [scopesData?.pages, formatMessage]);

Expand All @@ -38,6 +36,7 @@

return (
<MultipleChoiceFilter
filterId={filterId}
filterButtonText={filterButtonText}
filterChoices={filterChoices}
filterValue={filterValue}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { Search } from '@openedx/paragon/icons';

interface SearchFilterProps {
filterValue: string;
setFilter: (value: string) => void;
setFilter: (value: string | undefined) => void;
placeholder: string;
}

Expand Down
24 changes: 12 additions & 12 deletions src/authz-module/components/TableControlBar/TableControlBar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,13 @@ import OrgFilter from './OrgFilter';
import ScopesFilter from './ScopesFilter';
import { FilterChoice } from './types';

// Keyed by column id, which is what FilterChoice.groupName carries.
const FILTER_CHIPS_ICONS = {
role: Person,
organization: Business,
org: Business,
scope: LocationOn,
};

const FILTER_GROUP_TO_ID = {
role: 'role',
organization: 'org',
scope: 'scope',
};

interface TableControlBarProps {
onFilterChange?: (filters: string[]) => void;
}
Expand Down Expand Up @@ -82,16 +77,17 @@ const TableControlBar = ({ onFilterChange }: TableControlBarProps) => {
secondField: columnTextFilterHeaders[1] || '',
});

const handleCloseFilter = (filterName, filterValue) => {
const actualFilterId = FILTER_GROUP_TO_ID[filterName] || filterName;
const filterGroup = state.filters.find((filter) => filter.id === actualFilterId);
const handleCloseFilter = (filterId, filterValue) => {
const filterGroup = state.filters.find((filter) => filter.id === filterId);
const newFilterValue = filterGroup?.value.filter(item => item !== filterValue) || [];
setAllFilters(state.filters.map(item => (
item.id !== actualFilterId ? item : { id: item.id, value: newFilterValue })));
item.id !== filterId ? item : { id: item.id, value: newFilterValue })));
setChronologicalFilters((prevFilters) => prevFilters.filter((filter) => filter.value !== filterValue));
};

const handleSetFilters = (setFilter) => (allFilters: string[], newFilter: FilterChoice) => {
const handleSetFilters = (
setFilter: (filters: string[]) => void,
) => (allFilters: string[], newFilter: FilterChoice) => {
setFilter(allFilters);
setChronologicalFilters((prevFilters) => {
if (!prevFilters.find((filter) => filter.value === newFilter.value)) {
Expand All @@ -115,6 +111,7 @@ const TableControlBar = ({ onFilterChange }: TableControlBarProps) => {
<RolesFilter
key={column.id || column.accessor}
{...column}
filterId={column.id || column.accessor}
setFilter={handleSetFilters(column.setFilter)}
disabled={filtersLimitReached}
/>
Expand All @@ -125,6 +122,7 @@ const TableControlBar = ({ onFilterChange }: TableControlBarProps) => {
<OrgFilter
key={column.id || column.accessor}
{...column}
filterId={column.id || column.accessor}
setFilter={handleSetFilters(column.setFilter)}
disabled={filtersLimitReached}
/>
Expand All @@ -135,6 +133,7 @@ const TableControlBar = ({ onFilterChange }: TableControlBarProps) => {
<MultipleChoiceFilter
key={column.id || column.accessor}
{...column}
filterId={column.id || column.accessor}
setFilter={handleSetFilters(column.setFilter)}
disabled={filtersLimitReached}
/>
Expand All @@ -145,6 +144,7 @@ const TableControlBar = ({ onFilterChange }: TableControlBarProps) => {
<ScopesFilter
key={column.id || column.accessor}
{...column}
filterId={column.id || column.accessor}
setFilter={handleSetFilters(column.setFilter)}
disabled={filtersLimitReached}
filterValue={state.filters.find(filter => filter.id === 'scope')?.value || null}
Expand Down
3 changes: 3 additions & 0 deletions src/authz-module/components/TableControlBar/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ export type FilterChoice = {
};

export interface MultipleChoiceFilterProps {
/** Column id of the filtered column. Used (not the localized label) to
* identify the filter group on chips and when removing applied filters. */
filterId: string;
filterButtonText: string;
filterChoices: Array<FilterChoice>;
filterValue: string[] | undefined;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ const ScopeFilterBar = ({
</div>

<OrgFilter
filterId="org"
filterButtonText={intl.formatMessage(messages['wizard.step2.filter.org.label'])}
filterValue={selectedOrgs}
setFilter={onOrgsChange}
Expand Down
Loading