Skip to content

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

Fixes viz settins for details-only columns (#64113)

Alexander Polyankinc63dff0d7bfe
diff --git a/e2e/test/scenarios/models/reproductions.cy.spec.js b/e2e/test/scenarios/models/reproductions.cy.spec.js
index 655398c6fe5..ff88ff5aedf 100644
--- a/e2e/test/scenarios/models/reproductions.cy.spec.js
+++ b/e2e/test/scenarios/models/reproductions.cy.spec.js
@@ -689,7 +689,7 @@ describe("issue 23421", () => {
type: "model",
};
- const hiddenColumnsQuestionDetails = {
+ const hiddenColumnsModelDetails = {
native: {
query,
},
@@ -734,16 +734,17 @@ describe("issue 23421", () => {
});
it("`visualization_settings` with hidden columns should not break UI (metabase#23421)", () => {
- H.createNativeQuestion(hiddenColumnsQuestionDetails, {
+ H.createNativeQuestion(hiddenColumnsModelDetails, {
visitQuestion: true,
});
H.openQuestionActions();
H.popover().findByText("Edit query definition").click();
H.NativeEditor.get().should("be.visible").and("contain", query);
- cy.findByTestId("visualization-root")
- .findByText("Every field is hidden right now")
- .should("be.visible");
+ H.tableInteractiveHeader().within(() => {
+ cy.findByText("id").should("be.visible");
+ cy.findByText("created_at").should("be.visible");
+ });
cy.button("Save changes").should("be.disabled");
});
});
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
index 5c2ed246a1b..e8e0aa53dd3 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
@@ -723,7 +723,7 @@ const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {
noHeader
queryBuilderMode="dataset"
onHeaderColumnReorder={handleHeaderColumnReorder}
- isShowingDetailsOnlyColumns={datasetEditorTab === "columns"}
+ isShowingDetailsOnlyColumns={datasetEditorTab !== "metadata"}
hasMetadataPopovers={false}
handleVisualizationClick={handleTableElementClick}
tableHeaderHeight={isEditingColumns && TABLE_HEADER_HEIGHT}
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx
index 72dbe944b67..7850a478d8a 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx
@@ -18,7 +18,7 @@ interface ChartSettingTableColumnsProps {
value: TableColumnOrderSetting[];
columns: DatasetColumn[];
question?: Question;
- isDashboard?: boolean;
+ isShowingDetailsOnlyColumns: boolean;
getColumnName: (column: DatasetColumn) => string;
onChange: (value: TableColumnOrderSetting[], question?: Question) => void;
onShowWidget: (config: EditWidgetData, targetElement: HTMLElement) => void;
@@ -28,6 +28,7 @@ export const ChartSettingTableColumns = ({
value,
columns,
question,
+ isShowingDetailsOnlyColumns,
getColumnName,
onChange,
onShowWidget,
@@ -62,6 +63,7 @@ export const ChartSettingTableColumns = ({
<TableColumnPanel
columns={columns}
columnSettings={value}
+ isShowingDetailsOnlyColumns={isShowingDetailsOnlyColumns}
getColumnName={getColumnName}
onChange={onChange}
onShowWidget={onShowWidget}
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.tsx
index b5c1ccbe73f..0bfb3e4209b 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.tsx
@@ -22,6 +22,7 @@ import {
interface TableColumnPanelProps {
columns: DatasetColumn[];
columnSettings: TableColumnOrderSetting[];
+ isShowingDetailsOnlyColumns: boolean;
getColumnName: (column: DatasetColumn) => string;
onChange: (value: TableColumnOrderSetting[]) => void;
onShowWidget: (config: EditWidgetData, targetElement: HTMLElement) => void;
@@ -31,13 +32,19 @@ export const TableColumnPanel = ({
columns,
columnSettings,
getColumnName,
+ isShowingDetailsOnlyColumns,
onChange,
onShowWidget,
}: TableColumnPanelProps) => {
const tc = useTranslateContent();
const columnItems = useMemo(() => {
- return getColumnItems(columns, columnSettings, tc);
- }, [columns, columnSettings, tc]);
+ return getColumnItems(
+ columns,
+ columnSettings,
+ tc,
+ isShowingDetailsOnlyColumns,
+ );
+ }, [columns, columnSettings, tc, isShowingDetailsOnlyColumns]);
const getItemName = useCallback(
(columnItem: ColumnItem) => {
@@ -48,16 +55,16 @@ export const TableColumnPanel = ({
const handleEnableColumn = useCallback(
(columnItem: ColumnItem) => {
- onChange(toggleColumnInSettings(columnItem, columnItems, true));
+ onChange(toggleColumnInSettings(columnSettings, columnItem, true));
},
- [onChange, columnItems],
+ [columnSettings, onChange],
);
const handleDisableColumn = useCallback(
(columnItem: ColumnItem) => {
- onChange(toggleColumnInSettings(columnItem, columnItems, false));
+ onChange(toggleColumnInSettings(columnSettings, columnItem, false));
},
- [onChange, columnItems],
+ [columnSettings, onChange],
);
const handleDragColumn = useCallback(
@@ -66,9 +73,11 @@ export const TableColumnPanel = ({
(columnItem) => getId(columnItem) === id,
);
- onChange(moveColumnInSettings(columnItems, oldIndex, newIndex));
+ onChange(
+ moveColumnInSettings(columnSettings, columnItems, oldIndex, newIndex),
+ );
},
- [columnItems, onChange],
+ [columnSettings, columnItems, onChange],
);
const handleEditColumn = useCallback(
@@ -80,7 +89,7 @@ export const TableColumnPanel = ({
return (
<Box role="list" data-testid="chart-settings-table-columns">
- {columns.length > 0 && (
+ {columnItems.length > 0 && (
<Box role="group" data-testid="visible-columns">
<ChartSettingOrderedItems
getId={getId}
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.unit.spec.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.unit.spec.tsx
index d8695ba71ad..2b7b7884d81 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.unit.spec.tsx
@@ -62,12 +62,14 @@ const COLUMN_SETTINGS = [
interface SetupOpts {
columns?: DatasetColumn[];
columnSettings?: TableColumnOrderSetting[];
+ isShowingDetailsOnlyColumns?: boolean;
getColumnName?: (column: DatasetColumn) => string;
}
function setup({
columns = COLUMNS,
columnSettings = COLUMN_SETTINGS,
+ isShowingDetailsOnlyColumns = false,
getColumnName = (column) => column.display_name,
}: SetupOpts = {}) {
const onChange = jest.fn();
@@ -77,6 +79,7 @@ function setup({
<TableColumnPanel
columns={columns}
columnSettings={columnSettings}
+ isShowingDetailsOnlyColumns={isShowingDetailsOnlyColumns}
getColumnName={getColumnName}
onChange={onChange}
onShowWidget={onShowWidget}
@@ -118,6 +121,63 @@ describe("DatasetColumnSelector", () => {
newSettings[columnIndex] = { ...newSettings[columnIndex], enabled: false };
expect(onChange).toHaveBeenCalledWith(newSettings);
});
+
+ it("should not show columns that are 'details-only' by default", () => {
+ setup({
+ columns: [
+ COLUMNS[0],
+ COLUMNS[1],
+ { ...COLUMNS[2], visibility_type: "details-only" },
+ COLUMNS[3],
+ ],
+ columnSettings: COLUMN_SETTINGS,
+ });
+
+ const items = screen.getAllByTestId(/draggable-item/);
+ expect(items).toHaveLength(3);
+ expect(items[0]).toHaveTextContent("Total");
+ expect(items[1]).toHaveTextContent("ID");
+ expect(items[2]).toHaveTextContent("Subtotal");
+ });
+
+ it("should be able to disable columns when 'details-only' columns are hidden", async () => {
+ const { onChange } = setup({
+ columns: [
+ COLUMNS[0],
+ COLUMNS[1],
+ { ...COLUMNS[2], visibility_type: "details-only" },
+ COLUMNS[3],
+ ],
+ columnSettings: COLUMN_SETTINGS,
+ });
+
+ await disableColumn("ID");
+
+ const columnIndex = findColumnIndex("ID", COLUMN_SETTINGS);
+ const newSettings = [...COLUMN_SETTINGS];
+ newSettings[columnIndex] = { ...newSettings[columnIndex], enabled: false };
+ expect(onChange).toHaveBeenCalledWith(newSettings);
+ });
+
+ it("should show columns that are 'details-only' if enabled", () => {
+ setup({
+ columns: [
+ COLUMNS[0],
+ COLUMNS[1],
+ { ...COLUMNS[2], visibility_type: "details-only" },
+ COLUMNS[3],
+ ],
+ columnSettings: COLUMN_SETTINGS,
+ isShowingDetailsOnlyColumns: true,
+ });
+
+ const items = screen.getAllByTestId(/draggable-item/);
+ expect(items).toHaveLength(4);
+ expect(items[0]).toHaveTextContent("Total");
+ expect(items[1]).toHaveTextContent("ID");
+ expect(items[2]).toHaveTextContent("Tax");
+ expect(items[3]).toHaveTextContent("Subtotal");
+ });
});
async function enableColumn(columnName: string) {
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/types.ts b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/types.ts
index 67d3eac2ef7..d5764e4d600 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/types.ts
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/types.ts
@@ -1,19 +1,10 @@
import type { IconName } from "metabase/ui";
-import type {
- DatasetColumn,
- TableColumnOrderSetting,
-} from "metabase-types/api";
+import type { DatasetColumn } from "metabase-types/api";
export type ColumnItem = {
name: string;
enabled: boolean;
- index: number;
icon: IconName;
column: DatasetColumn;
- columnSetting: TableColumnOrderSetting;
-};
-
-export type DragColumnProps = {
- oldIndex: number;
- newIndex: number;
+ columnSettingIndex: number;
};
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/utils.ts b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/utils.ts
index 5b428ad214d..97ab02656af 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/utils.ts
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/utils.ts
@@ -1,8 +1,6 @@
-import _ from "underscore";
-
+import { getColumnIcon } from "metabase/common/utils/columns";
import type { ContentTranslationFunction } from "metabase/i18n/types";
-import type { IconName } from "metabase/ui";
-import { getIconForField } from "metabase-lib/v1/metadata/utils/fields";
+import * as Lib from "metabase-lib";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
import { findColumnIndexesForColumnSettings } from "metabase-lib/v1/queries/utils/dataset";
import type {
@@ -17,46 +15,67 @@ import type { ColumnItem } from "./types";
export function getColumnItems(
columns: DatasetColumn[],
columnSettings: TableColumnOrderSetting[],
- tc: ContentTranslationFunction = _.identity,
+ tc: ContentTranslationFunction,
+ isShowingDetailsOnlyColumns: boolean,
): ColumnItem[] {
const columnIndexes = findColumnIndexesForColumnSettings(
columns,
columnSettings,
);
- return columnSettings.map((columnSetting, columnSettingIndex) => {
- const columnIndex = columnIndexes[columnSettingIndex];
- const column = columns[columnIndex];
+ return columnSettings.reduce(
+ (columnItems: ColumnItem[], columnSetting, columnSettingIndex) => {
+ const columnIndex = columnIndexes[columnSettingIndex];
+ const column = columns[columnIndex];
+
+ if (
+ isShowingDetailsOnlyColumns ||
+ column.visibility_type !== "details-only"
+ ) {
+ columnItems.push({
+ name: column.name,
+ enabled: columnSetting.enabled,
+ icon: getColumnIcon(Lib.legacyColumnTypeInfo(column)),
+ column: { ...column, display_name: tc(column.display_name) },
+ columnSettingIndex,
+ });
+ }
- return {
- name: column.name,
- enabled: columnSetting.enabled,
- index: columnSettingIndex,
- icon: getIconForField(column) as IconName,
- column: { ...column, display_name: tc(column.display_name) },
- columnSetting,
- };
- });
+ return columnItems;
+ },
+ [],
+ );
}
export function toggleColumnInSettings(
- { index, columnSetting }: ColumnItem,
- columnItems: ColumnItem[],
+ columnSettings: TableColumnOrderSetting[],
+ { columnSettingIndex }: ColumnItem,
isEnabled: boolean,
): TableColumnOrderSetting[] {
- const newSettings = columnItems.map(({ columnSetting }) => columnSetting);
- newSettings[index] = { ...columnSetting, enabled: isEnabled };
+ const newSettings = [...columnSettings];
+ newSettings[columnSettingIndex] = {
+ ...columnSettings[columnSettingIndex],
+ enabled: isEnabled,
+ };
return newSettings;
}
export const moveColumnInSettings = (
+ columnSettings: TableColumnOrderSetting[],
columnItems: ColumnItem[],
oldIndex: number,
newIndex: number,
) => {
+ const oldSettingIndex = columnItems[oldIndex].columnSettingIndex;
+ const newSettingIndex = columnItems[newIndex].columnSettingIndex;
+
// delete a setting from the old index and put it to the new index, shifting all elements
- const newSettings = columnItems.map(({ columnSetting }) => columnSetting);
- newSettings.splice(newIndex, 0, newSettings.splice(oldIndex, 1)[0]);
+ const newSettings = [...columnSettings];
+ newSettings.splice(
+ newSettingIndex,
+ 0,
+ newSettings.splice(oldSettingIndex, 1)[0],
+ );
return newSettings;
};
diff --git a/frontend/src/metabase/visualizations/lib/settings/column.js b/frontend/src/metabase/visualizations/lib/settings/column.js
index 1295bbb0297..9fad3d2acc2 100644
--- a/frontend/src/metabase/visualizations/lib/settings/column.js
+++ b/frontend/src/metabase/visualizations/lib/settings/column.js
@@ -496,56 +496,59 @@ export const getTitleForColumn = (column, series, settings) => {
}
};
-export const tableColumnSettings = {
- // NOTE: table column settings may be identified by fieldRef (possible not normalized) or column name:
- // { name: "COLUMN_NAME", enabled: true }
- // { fieldRef: ["field", 2, {"source-field": 1}], enabled: true }
- "table.columns": {
- get section() {
- return t`Columns`;
- },
- // title: t`Columns`,
- widget: ChartSettingTableColumns,
- getHidden: (series, vizSettings) => vizSettings["table.pivot"],
- getValue: ([{ data }], vizSettings) => {
- const { cols } = data;
- const settings = vizSettings["table.columns"] ?? [];
- const uniqColumnSettings = getDeduplicatedTableColumnSettings(settings);
+export function tableColumnSettings({
+ isShowingDetailsOnlyColumns = false,
+} = {}) {
+ return {
+ "table.columns": {
+ get section() {
+ return t`Columns`;
+ },
+ // title: t`Columns`,
+ widget: ChartSettingTableColumns,
+ getHidden: (series, vizSettings) => vizSettings["table.pivot"],
+ getValue: ([{ data }], vizSettings) => {
+ const { cols } = data;
+ const settings = vizSettings["table.columns"] ?? [];
+ const uniqColumnSettings = getDeduplicatedTableColumnSettings(settings);
- const columnIndexes = findColumnIndexesForColumnSettings(
- cols,
- uniqColumnSettings,
- );
- const settingIndexes = findColumnSettingIndexesForColumns(
- cols,
- uniqColumnSettings,
- );
+ const columnIndexes = findColumnIndexesForColumnSettings(
+ cols,
+ uniqColumnSettings,
+ );
+ const settingIndexes = findColumnSettingIndexesForColumns(
+ cols,
+ uniqColumnSettings,
+ );
- return [
- // retain settings with matching columns only
- ...uniqColumnSettings.filter(
- (_, settingIndex) => columnIndexes[settingIndex] >= 0,
- ),
- // add columns that do not have matching settings to the end
- ...cols
- .filter((_, columnIndex) => settingIndexes[columnIndex] < 0)
- .map((column) => ({
- name: column.name,
- enabled: true,
- })),
- ];
- },
- getProps: (series, settings) => {
- const [
- {
- data: { cols },
- },
- ] = series;
+ return [
+ // retain settings with matching columns only
+ ...uniqColumnSettings.filter(
+ (_, settingIndex) => columnIndexes[settingIndex] >= 0,
+ ),
+ // add columns that do not have matching settings to the end
+ ...cols
+ .filter((_, columnIndex) => settingIndexes[columnIndex] < 0)
+ .map((column) => ({
+ name: column.name,
+ enabled: true,
+ })),
+ ];
+ },
+ getProps: (series, settings) => {
+ const [
+ {
+ data: { cols },
+ },
+ ] = series;
- return {
- columns: cols,
- getColumnName: (column) => getTitleForColumn(column, series, settings),
- };
+ return {
+ columns: cols,
+ isShowingDetailsOnlyColumns,
+ getColumnName: (column) =>
+ getTitleForColumn(column, series, settings),
+ };
+ },
},
- },
-};
+ };
+}
diff --git a/frontend/src/metabase/visualizations/visualizations/ObjectDetail.jsx b/frontend/src/metabase/visualizations/visualizations/ObjectDetail.jsx
index 0e14d2eede9..136fe6436e3 100644
--- a/frontend/src/metabase/visualizations/visualizations/ObjectDetail.jsx
+++ b/frontend/src/metabase/visualizations/visualizations/ObjectDetail.jsx
@@ -27,7 +27,7 @@ const ObjectDetailProperties = {
disableClickBehavior: true,
settings: {
...columnSettings({ hidden: true }),
- ...tableColumnSettings,
+ ...tableColumnSettings({ isShowingDetailsOnlyColumns: true }),
},
columnSettings: (column) => {
const settings = {
diff --git a/frontend/src/metabase/visualizations/visualizations/Table/Table.tsx b/frontend/src/metabase/visualizations/visualizations/Table/Table.tsx
index 4df69cfd9af..00ac3d34b14 100644
--- a/frontend/src/metabase/visualizations/visualizations/Table/Table.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Table/Table.tsx
@@ -201,7 +201,7 @@ class Table extends Component<TableProps, TableState> {
readDependencies: ["table.pivot", "table.pivot_column"],
persistDefault: true,
},
- ...tableColumnSettings,
+ ...tableColumnSettings({ isShowingDetailsOnlyColumns: false }),
"table.column_widths": {},
[DataGrid.COLUMN_FORMATTING_SETTING]: {
get section() {
@@ -395,16 +395,23 @@ class Table extends Component<TableProps, TableState> {
this._updateData(this.props);
}
- UNSAFE_componentWillReceiveProps(newProps: VisualizationProps) {
+ UNSAFE_componentWillReceiveProps(newProps: TableProps) {
if (
newProps.series !== this.props.series ||
- !_.isEqual(newProps.settings, this.props.settings)
+ !_.isEqual(newProps.settings, this.props.settings) ||
+ newProps.isShowingDetailsOnlyColumns !==
+ this.props.isShowingDetailsOnlyColumns
) {
this._updateData(newProps);
}
}
- _updateData({ series, settings, metadata }: VisualizationProps) {
+ _updateData({
+ series,
+ settings,
+ metadata,
+ isShowingDetailsOnlyColumns,
+ }: TableProps) {
const [{ card, data }] = series;
// construct a Question that is in-sync with query results
const question = new Question(card, metadata);
@@ -435,7 +442,7 @@ class Table extends Component<TableProps, TableState> {
).filter(
(columnIndex, settingIndex) =>
columnIndex >= 0 &&
- (this.props.isShowingDetailsOnlyColumns ||
+ (isShowingDetailsOnlyColumns ||
(cols[columnIndex].visibility_type !== "details-only" &&
columnSettings[settingIndex].enabled)),
);