Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Use virtualized table for data perms (#70343)

John Swanson05567456f202
diff --git a/frontend/src/metabase/admin/permissions/components/PermissionsEditor/PermissionsEditorContent.styled.tsx b/frontend/src/metabase/admin/permissions/components/PermissionsEditor/PermissionsEditorContent.styled.tsx
index 4e5a55800fb..61804f70831 100644
--- a/frontend/src/metabase/admin/permissions/components/PermissionsEditor/PermissionsEditorContent.styled.tsx
+++ b/frontend/src/metabase/admin/permissions/components/PermissionsEditor/PermissionsEditorContent.styled.tsx
@@ -18,8 +18,8 @@ export const EditorEmptyStateContainer = styled.div`
`;
export const PermissionTableWrapper = styled.div`
- position: relative;
flex: 1;
- overflow-x: auto;
+ min-height: 0;
+ overflow: auto;
padding-bottom: 2rem;
`;
diff --git a/frontend/src/metabase/admin/permissions/components/PermissionsEditor/PermissionsEditorContent.tsx b/frontend/src/metabase/admin/permissions/components/PermissionsEditor/PermissionsEditorContent.tsx
index cbebe6e293a..aee6d54301b 100644
--- a/frontend/src/metabase/admin/permissions/components/PermissionsEditor/PermissionsEditorContent.tsx
+++ b/frontend/src/metabase/admin/permissions/components/PermissionsEditor/PermissionsEditorContent.tsx
@@ -47,6 +47,11 @@ export function PermissionsEditorContent({
preHeaderContent: PreHeaderContent = () => null,
}: PermissionsEditorContentProps) {
const [filter, setFilter] = useState("");
+ //this needs to be state to trigger a rerender when it's set
+ const [scrollElement, setScrollElement] = useState<HTMLDivElement | null>(
+ null,
+ );
+
const debouncedFilter = useDebouncedValue(filter, SEARCH_DEBOUNCE_DURATION);
const filteredEntities = useMemo(() => {
@@ -92,13 +97,14 @@ export function PermissionsEditorContent({
/>
</EditorFilterContainer>
- <PermissionTableWrapper>
+ <PermissionTableWrapper ref={setScrollElement}>
<PermissionsTable
entities={filteredEntities || entities}
columns={columns}
onSelect={onSelect}
onChange={onChange}
onAction={onAction}
+ scrollElement={scrollElement}
emptyState={
<EditorEmptyStateContainer>
<EmptyState message={t`Nothing here`} icon="folder" />
diff --git a/frontend/src/metabase/admin/permissions/components/PermissionsSelect/PermissionsSelect.tsx b/frontend/src/metabase/admin/permissions/components/PermissionsSelect/PermissionsSelect.tsx
index 69a0ea769a9..e4171fbbbbd 100644
--- a/frontend/src/metabase/admin/permissions/components/PermissionsSelect/PermissionsSelect.tsx
+++ b/frontend/src/metabase/admin/permissions/components/PermissionsSelect/PermissionsSelect.tsx
@@ -69,41 +69,47 @@ export const PermissionsSelect = memo(function PermissionsSelect({
const actionsForCurrentValue = actions?.[selectedOption.value] || [];
const hasActions = actionsForCurrentValue.length > 0;
- return (
- <Popover opened={opened} onChange={setOpened} disabled={isDisabled}>
- <Popover.Target>
- <PermissionsSelectRoot
- isDisabled={isDisabled}
- aria-haspopup="listbox"
- data-testid="permissions-select"
- aria-disabled={isDisabled}
- onClick={isDisabled ? undefined : () => setOpened((o) => !o)}
- >
- {isDisabled ? (
- <DisabledPermissionOption
- {...selectedOption}
- isHighlighted={isHighlighted ?? false}
- hint={disabledTooltip}
- iconColor="text-tertiary"
- />
- ) : (
- <SelectedOption {...selectedOption} />
- )}
+ const triggerContent = (
+ <PermissionsSelectRoot
+ isDisabled={isDisabled}
+ aria-haspopup="listbox"
+ data-testid="permissions-select"
+ aria-disabled={isDisabled}
+ onClick={isDisabled ? undefined : () => setOpened((o) => !o)}
+ >
+ {isDisabled ? (
+ <DisabledPermissionOption
+ {...selectedOption}
+ isHighlighted={isHighlighted ?? false}
+ hint={disabledTooltip}
+ iconColor="text-tertiary"
+ />
+ ) : (
+ <SelectedOption {...selectedOption} />
+ )}
- {warning && (
- <Tooltip label={warning}>
- <WarningIcon />
- </Tooltip>
- )}
+ {warning && (
+ <Tooltip label={warning}>
+ <WarningIcon />
+ </Tooltip>
+ )}
+
+ <Icon
+ style={{ visibility: isDisabled ? "hidden" : "visible" }}
+ name="chevrondown"
+ size={16}
+ c="text-tertiary"
+ />
+ </PermissionsSelectRoot>
+ );
+
+ if (!opened) {
+ return triggerContent;
+ }
- <Icon
- style={{ visibility: isDisabled ? "hidden" : "visible" }}
- name="chevrondown"
- size={16}
- c="text-tertiary"
- />
- </PermissionsSelectRoot>
- </Popover.Target>
+ return (
+ <Popover opened onChange={setOpened}>
+ <Popover.Target>{triggerContent}</Popover.Target>
<Popover.Dropdown>
<Fragment>
<OptionsList role="listbox">
diff --git a/frontend/src/metabase/admin/permissions/components/PermissionsTable/PermissionsTable.tsx b/frontend/src/metabase/admin/permissions/components/PermissionsTable/PermissionsTable.tsx
index ba713d525b2..f613f031b7f 100644
--- a/frontend/src/metabase/admin/permissions/components/PermissionsTable/PermissionsTable.tsx
+++ b/frontend/src/metabase/admin/permissions/components/PermissionsTable/PermissionsTable.tsx
@@ -1,5 +1,6 @@
+import { useVirtualizer } from "@tanstack/react-virtual";
import cx from "classnames";
-import { useRef, useState } from "react";
+import { memo, useCallback, useRef, useState } from "react";
import { ConfirmModal } from "metabase/common/components/ConfirmModal";
import { Ellipsified } from "metabase/common/components/Ellipsified";
@@ -38,15 +39,20 @@ export type PermissionsTableProps = Pick<
value: DataPermissionValue,
toggleState: boolean | null,
) => void;
+ scrollElement?: HTMLDivElement | null;
emptyState?: React.ReactNode;
};
+const ROW_HEIGHT = 40;
+const VIRTUALIZATION_THRESHOLD = 100;
+
export function PermissionsTable({
entities,
columns,
onSelect,
onAction,
onChange,
+ scrollElement,
emptyState = null,
}: PermissionsTableProps) {
const [confirmations, setConfirmations] = useState<
@@ -54,25 +60,28 @@ export function PermissionsTable({
>([]);
const confirmActionRef = useRef<(() => void) | null>(null);
- const handleChange = (
- value: DataPermissionValue,
- toggleState: boolean | null,
- entity: PermissionEditorEntity,
- permission: PermissionSectionConfig,
- ) => {
- const confirmAction = () =>
- onChange(entity, permission, value, toggleState);
-
- const confirmations =
- permission.confirmations?.(value).filter((c) => c !== undefined) || [];
-
- if (confirmations.length > 0) {
- setConfirmations(confirmations);
- confirmActionRef.current = confirmAction;
- } else {
- confirmAction();
- }
- };
+ const handleChange = useCallback(
+ (
+ value: DataPermissionValue,
+ toggleState: boolean | null,
+ entity: PermissionEditorEntity,
+ permission: PermissionSectionConfig,
+ ) => {
+ const confirmAction = () =>
+ onChange(entity, permission, value, toggleState);
+
+ const confirmations =
+ permission.confirmations?.(value).filter((c) => c !== undefined) || [];
+
+ if (confirmations.length > 0) {
+ setConfirmations(confirmations);
+ confirmActionRef.current = confirmAction;
+ } else {
+ confirmAction();
+ }
+ },
+ [onChange],
+ );
const handleConfirm = () => {
setConfirmations((prev) => prev.slice(1));
@@ -87,8 +96,72 @@ export function PermissionsTable({
confirmActionRef.current = null;
};
+ // this is weird, but: we *would* virtualize if we have enough entities. But on page load, we may not YET have
+ // a non-null `scrollElement`, because the DOM doesn't exist yet.
+ const wouldVirtualize = entities.length > VIRTUALIZATION_THRESHOLD;
+ const canVirtualize = scrollElement != null && wouldVirtualize;
+
+ const virtualizer = useVirtualizer({
+ count: entities.length,
+ getScrollElement: () => scrollElement ?? null,
+ estimateSize: () => ROW_HEIGHT,
+ overscan: 20,
+ enabled: canVirtualize,
+ });
+
const hasItems = entities.length > 0;
+ const virtualItems = virtualizer.getVirtualItems();
+ const totalSize = virtualizer.getTotalSize();
+
+ const tableContent =
+ wouldVirtualize && !canVirtualize ? (
+ <tbody />
+ ) : canVirtualize ? (
+ <tbody>
+ {virtualItems.length > 0 && (
+ <tr>
+ <td
+ style={{ height: virtualItems[0].start, padding: 0 }}
+ colSpan={columns.length}
+ />
+ </tr>
+ )}
+ {virtualItems.map((virtualItem) => (
+ <EntityRow
+ key={entities[virtualItem.index].id}
+ entity={entities[virtualItem.index]}
+ onChange={handleChange}
+ onSelect={onSelect}
+ onAction={onAction}
+ />
+ ))}
+ {virtualItems.length > 0 && (
+ <tr>
+ <td
+ style={{
+ height: totalSize - virtualItems[virtualItems.length - 1].end,
+ padding: 0,
+ }}
+ colSpan={columns.length}
+ />
+ </tr>
+ )}
+ </tbody>
+ ) : (
+ <tbody>
+ {entities.map((entity) => (
+ <EntityRow
+ key={entity.id}
+ entity={entity}
+ onChange={handleChange}
+ onSelect={onSelect}
+ onAction={onAction}
+ />
+ ))}
+ </tbody>
+ );
+
return (
<>
<PermissionsTableRoot data-testid="permission-table">
@@ -114,61 +187,7 @@ export function PermissionsTable({
})}
</tr>
</thead>
- <tbody>
- {entities.map((entity) => {
- const entityName = (
- <span className={cx(CS.flex, CS.alignCenter)}>
- <Ellipsified>{entity.name}</Ellipsified>
- {typeof entity.hint === "string" && (
- <Tooltip label={entity.hint}>
- <HintIcon />
- </Tooltip>
- )}
- </span>
- );
- return (
- <PermissionsTableRow
- key={entity.id}
- aria-label={`${entity.name} permissions`}
- >
- <PermissionsTableCell>
- {entity.canSelect ? (
- // @ts-expect-error - Link expects a `to` prop, but we don't have one. maybe this should be a button?
- <EntityNameLink //force line break so we can type check next line
- onClick={() => onSelect?.(entity)}
- >
- {entityName}
- </EntityNameLink>
- ) : (
- <Flex gap="xs" fw="bold">
- {entityName}
- {entity.icon}
- </Flex>
- )}
- {entity.callout && (
- <Text c="text-secondary">{entity.callout}</Text>
- )}
- </PermissionsTableCell>
-
- {entity.permissions?.map((permission, index) => {
- return (
- <PermissionsTableCell
- key={permission.type ?? String(index)}
- >
- <PermissionsSelect
- {...permission}
- onChange={(value, toggleState) =>
- handleChange(value, toggleState, entity, permission)
- }
- onAction={(action) => onAction?.(action, entity)}
- />
- </PermissionsTableCell>
- );
- })}
- </PermissionsTableRow>
- );
- })}
- </tbody>
+ {tableContent}
</PermissionsTableRoot>
{!hasItems && emptyState}
<ConfirmModal
@@ -180,3 +199,67 @@ export function PermissionsTable({
</>
);
}
+
+type EntityRowProps = {
+ entity: PermissionEditorEntity;
+ onChange: (
+ value: DataPermissionValue,
+ toggleState: boolean | null,
+ entity: PermissionEditorEntity,
+ permission: PermissionSectionConfig,
+ ) => void;
+ onSelect?: (entity: PermissionEditorEntity) => void;
+ onAction?: (action: PermissionAction, entity: PermissionEditorEntity) => void;
+};
+
+const EntityRow = memo(function EntityRow({
+ entity,
+ onChange,
+ onSelect,
+ onAction,
+}: EntityRowProps) {
+ const entityName = (
+ <span className={cx(CS.flex, CS.alignCenter)}>
+ <Ellipsified>{entity.name}</Ellipsified>
+ {typeof entity.hint === "string" && (
+ <Tooltip label={entity.hint}>
+ <HintIcon />
+ </Tooltip>
+ )}
+ </span>
+ );
+ return (
+ <PermissionsTableRow aria-label={`${entity.name} permissions`}>
+ <PermissionsTableCell>
+ {entity.canSelect ? (
+ // @ts-expect-error - Link expects a `to` prop, but we don't have one. maybe this should be a button?
+ <EntityNameLink //force line break so we can type check next line
+ onClick={() => onSelect?.(entity)}
+ >
+ {entityName}
+ </EntityNameLink>
+ ) : (
+ <Flex gap="xs" fw="bold">
+ {entityName}
+ {entity.icon}
+ </Flex>
+ )}
+ {entity.callout && <Text c="text-secondary">{entity.callout}</Text>}
+ </PermissionsTableCell>
+
+ {entity.permissions?.map((permission, index) => {
+ return (
+ <PermissionsTableCell key={permission.type ?? String(index)}>
+ <PermissionsSelect
+ {...permission}
+ onChange={(value, toggleState) =>
+ onChange(value, toggleState, entity, permission)
+ }
+ onAction={(action) => onAction?.(action, entity)}
+ />
+ </PermissionsTableCell>
+ );
+ })}
+ </PermissionsTableRow>
+ );
+});
diff --git a/frontend/src/metabase/admin/permissions/selectors/data-permissions/permission-editor.tsx b/frontend/src/metabase/admin/permissions/selectors/data-permissions/permission-editor.tsx
index 4eccb473ccb..041e1654f47 100644
--- a/frontend/src/metabase/admin/permissions/selectors/data-permissions/permission-editor.tsx
+++ b/frontend/src/metabase/admin/permissions/selectors/data-permissions/permission-editor.tsx
@@ -29,11 +29,7 @@ import type {
RawGroupRouteParams,
SpecialGroupType,
} from "../../types";
-import {
- DataPermission,
- DataPermissionValue,
- parseGroupRouteParams,
-} from "../../types";
+import { DataPermission, DataPermissionValue } from "../../types";
import {
getDatabaseEntityId,
getSchemaEntityId,
@@ -88,17 +84,18 @@ type RouteParamsSelectorParameters = {
params: DataRouteParams;
};
-const getRouteParams = (
- _state: State,
- props: RouteParamsSelectorParameters,
-) => {
- const { databaseId, schemaName, tableId } = props.params;
- return {
+const getRouteParams = createSelector(
+ (_state: State, props: RouteParamsSelectorParameters) =>
+ props.params.databaseId,
+ (_state: State, props: RouteParamsSelectorParameters) =>
+ props.params.schemaName,
+ (_state: State, props: RouteParamsSelectorParameters) => props.params.tableId,
+ (databaseId, schemaName, tableId) => ({
databaseId,
schemaName,
tableId,
- };
-};
+ }),
+);
export const getDataPermissions = (state: State) =>
state.admin.permissions.dataPermissions;
@@ -106,12 +103,19 @@ export const getDataPermissions = (state: State) =>
const getOriginalDataPermissions = (state: State) =>
state.admin.permissions.originalDataPermissions;
-const getGroupRouteParams = (
- _state: State,
- props: { params: RawGroupRouteParams },
-) => {
- return parseGroupRouteParams(props.params);
-};
+const getGroupRouteParams = createSelector(
+ (_state: State, props: { params: RawGroupRouteParams }) =>
+ props.params.groupId,
+ (_state: State, props: { params: RawGroupRouteParams }) =>
+ props.params.databaseId,
+ (_state: State, props: { params: RawGroupRouteParams }) =>
+ props.params.schemaName,
+ (groupId, databaseId, schemaName) => ({
+ groupId: groupId != null ? parseInt(groupId) : undefined,
+ databaseId: databaseId != null ? parseInt(databaseId) : undefined,
+ schemaName,
+ }),
+);
const getEditorEntityName = (
{ databaseId, schemaName }: DataRouteParams,