Skip to content

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

GDGT-1252: Respect show mini bar chart setting in list view (#66012)

Stas Gavrylovce0232662d41
diff --git a/e2e/test/scenarios/models/models-list-view.cy.spec.js b/e2e/test/scenarios/models/models-list-view.cy.spec.js
index 9d2326e4cef..22d9d95c710 100644
--- a/e2e/test/scenarios/models/models-list-view.cy.spec.js
+++ b/e2e/test/scenarios/models/models-list-view.cy.spec.js
@@ -37,6 +37,16 @@ describe("scenarios > models list view", () => {
cy.log("Ensure List view is enabled");
cy.findByTestId("list-view").should("be.visible");
+ cy.log(
+ "Ensure that List View setting stays applied after switching between tabs",
+ );
+ cy.findByTestId("dataset-edit-bar").findByText("Columns").click();
+ cy.findByTestId("dataset-edit-bar").findByText("Settings").click();
+ cy.findByTestId("list-view").should("be.visible");
+ cy.findByTestId("sidebar-right").within(() => {
+ cy.findByLabelText("List").should("be.checked");
+ });
+
cy.findByTestId("dataset-edit-bar").button("Save changes").click();
cy.wait("@dataset");
@@ -258,7 +268,6 @@ describe("scenarios > models list view", () => {
{
name: "Native Model",
type: "model",
- display: "list",
native: {
query: "SELECT * FROM ORDERS LIMIT 5",
},
@@ -304,7 +313,6 @@ describe("scenarios > models list view", () => {
{
name: "Native Model",
type: "model",
- display: "list",
native: {
query: "SELECT * FROM ORDERS LIMIT 5",
},
@@ -336,5 +344,59 @@ describe("scenarios > models list view", () => {
H.undoToast().should("contain.text", "This is a question now");
cy.findByTestId("list-view").should("not.exist");
});
+
+ it("should consider mini bar chart setting for quantity/score columns", () => {
+ H.restore();
+ cy.signInAsAdmin();
+ cy.intercept("POST", "/api/dataset").as("dataset");
+
+ H.createNativeQuestion({
+ name: "Native Model",
+ type: "model",
+ native: {
+ query: "SELECT * FROM ORDERS LIMIT 5",
+ },
+ }).then(({ body: { id: nativeModelId } }) => {
+ cy.request("PUT", `/api/card/${nativeModelId}`, {
+ display: "list",
+ });
+ H.setModelMetadata(nativeModelId, (field) => {
+ if (field.display_name === "SUBTOTAL") {
+ return {
+ ...field,
+ semantic_type: "type/Quantity",
+ settings: {
+ show_mini_bar: true,
+ },
+ };
+ }
+ return field;
+ });
+ H.visitModel(nativeModelId);
+ });
+
+ cy.findByTestId("list-view").within(() => {
+ cy.findAllByTestId("mini-bar-container").should("be.visible");
+ });
+
+ H.openQuestionActions();
+
+ H.popover().findByTextEnsureVisible("Edit metadata").click();
+
+ cy.findByTestId("dataset-edit-bar").findByText("Columns").click();
+
+ H.tableHeaderClick(/Subtotal/i);
+
+ H.sidebar().findByRole("tab", { name: "Formatting" }).click();
+
+ H.sidebar()
+ .findByLabelText("Show a mini bar chart")
+ .click({ force: true });
+
+ cy.findByTestId("dataset-edit-bar").button("Save changes").click();
+ cy.wait("@dataset");
+
+ cy.findByTestId("mini-bar-container").should("not.exist");
+ });
});
});
diff --git a/frontend/src/metabase/list-view/components/ListView/ColumnValue.tsx b/frontend/src/metabase/list-view/components/ListView/ColumnValue.tsx
index 0cfbf6a115a..245fca2dfc7 100644
--- a/frontend/src/metabase/list-view/components/ListView/ColumnValue.tsx
+++ b/frontend/src/metabase/list-view/components/ListView/ColumnValue.tsx
@@ -190,6 +190,10 @@ export function ColumnValue({
);
case isQuantity(column):
case isScore(column): {
+ if (!column?.settings?.["show_mini_bar"]) {
+ return <Text fw="bold">{value}</Text>;
+ }
+
return (
<Flex direction="row" align="center" gap="sm">
<MiniBarCell
diff --git a/frontend/src/metabase/list-view/components/ListView/ListViewItem.unit.spec.tsx b/frontend/src/metabase/list-view/components/ListView/ListViewItem.unit.spec.tsx
index 4505ddf9bc3..99458f6d5d8 100644
--- a/frontend/src/metabase/list-view/components/ListView/ListViewItem.unit.spec.tsx
+++ b/frontend/src/metabase/list-view/components/ListView/ListViewItem.unit.spec.tsx
@@ -199,6 +199,9 @@ describe("ListViewItem - ColumnValue rendering", () => {
display_name: "Score",
semantic_type: "type/Quantity",
base_type: "type/Number",
+ settings: {
+ show_mini_bar: true,
+ },
});
const cols = [qtyCol];
const row = [75];
@@ -216,4 +219,34 @@ describe("ListViewItem - ColumnValue rendering", () => {
// Displayed value text (bold)
expect(screen.getByText(/75/)).toBeInTheDocument();
});
+
+ it("doesn't render minibar Quantity if setting is disabled or not present", () => {
+ const qtyCol = createMockColumn({
+ name: "score",
+ display_name: "Score",
+ semantic_type: "type/Quantity",
+ base_type: "type/Number",
+ settings: {
+ show_mini_bar: false,
+ },
+ });
+ const qtyColNoSetting = createMockColumn({
+ name: "score2",
+ display_name: "Score2",
+ semantic_type: "type/Quantity",
+ base_type: "type/Number",
+ });
+ const cols = [qtyCol, qtyColNoSetting];
+ const row = [0, 0];
+ const rows = [row];
+
+ const settings = makeSettings({
+ column: () => ({ number_style: "decimal" }),
+ });
+
+ renderItem({ row, rows, cols, settings, rightColumns: [qtyCol] });
+
+ const container = screen.queryByTestId("mini-bar-container");
+ expect(container).not.toBeInTheDocument();
+ });
});
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
index 66e4b61b675..24608c12e88 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
@@ -29,6 +29,7 @@ import { PLUGIN_DEPENDENCIES } from "metabase/plugins";
import {
setDatasetEditorTab,
setUIControls,
+ updateQuestion as updateQuestionAction,
} from "metabase/query_builder/actions";
import { calcInitialEditorHeight } from "metabase/query_builder/components/NativeQueryEditor/utils";
import QueryVisualization from "metabase/query_builder/components/QueryVisualization";
@@ -158,7 +159,6 @@ function getSidebar(
onFieldMetadataChange,
onMappedDatabaseColumnChange,
onUpdateModelSettings,
- modelSettings,
}: {
datasetEditorTab: DatasetEditorTab;
isQueryError?: unknown;
@@ -167,8 +167,9 @@ function getSidebar(
focusFirstField: () => void;
onFieldMetadataChange: (values: Partial<DatasetColumn>) => void;
onMappedDatabaseColumnChange: (value: number) => void;
- onUpdateModelSettings: (settings: Partial<ModelSettings>) => void;
- modelSettings: ModelSettings;
+ onUpdateModelSettings: (settings: {
+ display: ModelSettings["display"];
+ }) => void;
},
): ReactNode {
const {
@@ -216,23 +217,10 @@ function getSidebar(
return <div />;
}
- /**
- * If the model hasn't been saved with "list" view setting, but user has
- * just selected this option through UI, we use temporary `modelSettings`
- * to properly render the settings sidebar and its internal elements (list of unused columns)
- * As soon as we detect that question has been saved, we use proper settings
- * origin.
- */
- const questionSettings = question.settings();
- const listViewSettings: ComputedVisualizationSettings =
- "list.columns" in questionSettings
- ? questionSettings
- : modelSettings.visualizationSettings;
-
return (
<DatasetEditorSettingsSidebar
- display={modelSettings.display}
- visualizationSettings={listViewSettings}
+ display={question.display()}
+ visualizationSettings={question.settings()}
onUpdateModelSettings={onUpdateModelSettings}
/>
);
@@ -290,7 +278,7 @@ function getTempRawSeries(
] as RawSeries;
}
-function getTempVisualizationSettings(
+function getComputedVisualizationSettings(
series: Series | null,
): ComputedVisualizationSettings | null {
if (series == null) {
@@ -344,33 +332,26 @@ const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {
);
/**
- * tempModelSettings and tempRawSeries are introduced as a workaround to support new "list" display type for models.
- * - `tempModelSettings` stores local state for currently selected display and allows to switch between 'Columns'/'Settings' tabs
- * without triggering question changes detection, because otherwise updating `display` property would open LeaveConfirmationModal.
- * 'Columns' tab works only for "table" display type, so when user opens 'Settings' for Model saved with "list" display type,
- * and wants to see 'Columns' tab, we need to update `display` property to "table".
- * - `tempRawSeries` is introduced for the same reason. It patches `rawSeries` property inside nested `VisualizationResult` component,
- * so that it renders correct visualization for 'Columns' tab.
+ * `tempRawSeries` is a workaround to display "Columns" tab properly,
+ * because this view expects that the question has "table" display type.
+ * But when a question has "list" display, and we change it implicitly to "table"
+ * when switching to "Columns" tab, then can be incorrectly applied with field
+ * metadata changes.
+ * So instead we patch the card display property in the series object,
+ * without affecting the actual question.
*/
- const [tempModelSettings, setTempModelSettings] = useState<ModelSettings>(
- () => {
- return {
- display: question.display(),
- visualizationSettings:
- getTempVisualizationSettings(rawSeries) || question.settings(),
- };
- },
- );
const tempRawSeries = useMemo(() => {
- if (!rawSeries || !rawSeries.length || !tempModelSettings.display) {
+ if (!rawSeries || !rawSeries.length) {
return rawSeries;
}
- return getTempRawSeries(rawSeries, tempModelSettings.display);
- }, [tempModelSettings, rawSeries]);
+ return getTempRawSeries(
+ rawSeries,
+ datasetEditorTab === "columns" ? "table" : question.display(),
+ );
+ }, [rawSeries, datasetEditorTab, question]);
- const [isSettingsDirty, setSettingsDirty] = useState(false);
- const isDirty = isSettingsDirty || isModelQueryDirty || isMetadataDirty;
+ const isDirty = isModelQueryDirty || isMetadataDirty;
const { data: modelIndexes } = useListModelIndexesQuery(
{
@@ -468,44 +449,19 @@ const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {
(tab: DatasetEditorTab) => {
setDatasetEditorTab(tab);
setEditorHeight(tab === "query" ? initialEditorHeight : 0);
- /**
- * The only way to properly display interface for "Columns" tab is to
- * set model's display type to "table".
- * We use local `tempModelSettings` to store unsaved changes to avoid
- * affecting the `question` object in store, which triggers unwanted
- * `dirty` checks.
- */
- const display = question.display();
- const tempDisplay = tempModelSettings.display;
- const hasListViewSelected = display === "list" || tempDisplay === "list";
- if (hasListViewSelected) {
- if (tab !== "metadata") {
- setTempModelSettings(() => ({
- visualizationSettings: question.settings(),
- display: "table",
- }));
- }
- }
- if (tab === "metadata") {
- setTempModelSettings((prevSettings) => ({
- visualizationSettings:
- getTempVisualizationSettings(tempRawSeries) ||
- prevSettings.visualizationSettings,
- display: question.display(),
- }));
- }
- if (hasListViewSelected && isShowingListViewConfiguration) {
- dispatch(setUIControls({ isShowingListViewConfiguration: false }));
+ if (isShowingListViewConfiguration) {
+ dispatch(
+ setUIControls({
+ isShowingListViewConfiguration: false,
+ }),
+ );
}
},
[
initialEditorHeight,
setDatasetEditorTab,
- question,
dispatch,
isShowingListViewConfiguration,
- tempModelSettings,
- tempRawSeries,
],
);
@@ -553,17 +509,7 @@ const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {
const handleSave = useCallback(async () => {
const canBeDataset = checkCanBeModel(question);
const isBrandNewDataset = !question.id();
- let questionWithUpdatedSettings = question;
- if (
- !!tempModelSettings.display &&
- tempModelSettings.display !== question.display()
- ) {
- questionWithUpdatedSettings = question.setDisplay(
- tempModelSettings.display,
- );
- }
- const questionWithMetadata =
- questionWithUpdatedSettings.setResultMetadataDiff(metadataDiff);
+ const questionWithMetadata = question.setResultMetadataDiff(metadataDiff);
if (isShowingListViewConfiguration) {
dispatch(setUIControls({ isShowingListViewConfiguration: false }));
}
@@ -581,7 +527,6 @@ const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {
}
}, [
question,
- tempModelSettings.display,
metadataDiff,
isShowingListViewConfiguration,
dispatch,
@@ -709,20 +654,17 @@ const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {
onFieldMetadataChange,
onMappedDatabaseColumnChange,
onUpdateModelSettings: (settings) => {
- setSettingsDirty(settings.display !== question.display());
- if (settings.display !== undefined) {
- setTempModelSettings((prevSettings) => ({
- display: settings.display || prevSettings.display,
- visualizationSettings:
- settings.display === "list" && rawSeries != null
- ? getTempVisualizationSettings(
- getTempRawSeries(rawSeries, settings.display),
- ) || prevSettings.visualizationSettings
- : prevSettings.visualizationSettings,
- }));
- }
+ const nextQuestion = question.setDisplay(settings.display);
+ const nextSettings =
+ settings.display === "list" && rawSeries != null
+ ? getComputedVisualizationSettings(
+ getTempRawSeries(rawSeries, settings.display),
+ ) || question.settings()
+ : question.settings();
+ dispatch(
+ updateQuestionAction(nextQuestion.updateSettings(nextSettings)),
+ );
},
- modelSettings: tempModelSettings,
},
);
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorSettingsSidebar/DatasetEditorSettingsSidebar.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorSettingsSidebar/DatasetEditorSettingsSidebar.tsx
index eb2acb5d1f3..79c70482c4e 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorSettingsSidebar/DatasetEditorSettingsSidebar.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorSettingsSidebar/DatasetEditorSettingsSidebar.tsx
@@ -17,7 +17,7 @@ export type ModelSettings = {
visualizationSettings: ComputedVisualizationSettings;
};
type DatasetEditorSettingsSidebarProps = {
- onUpdateModelSettings: (settings: Partial<ModelSettings>) => void;
+ onUpdateModelSettings: (settings: { display: CardDisplayType }) => void;
visualizationSettings: ComputedVisualizationSettings;
display?: CardDisplayType;
};
diff --git a/frontend/src/metabase/query_builder/utils/index.ts b/frontend/src/metabase/query_builder/utils/index.ts
index 59ec03248bd..cea1344fb68 100644
--- a/frontend/src/metabase/query_builder/utils/index.ts
+++ b/frontend/src/metabase/query_builder/utils/index.ts
@@ -91,11 +91,12 @@ export const isNavigationAllowed = ({
if (question.type() === "model") {
const isRunningModel = pathname === "/model" && hash.length > 0;
const allowedPathnames = isNewQuestion
- ? ["/model/query", "/model/columns"]
+ ? ["/model/query", "/model/columns", "/model/metadata"]
: validSlugs.flatMap((slug) => [
`/model/${slug}/query`,
`/model/${slug}/columns`,
`/model/${slug}/notebook`,
+ `/model/${slug}/metadata`,
]);
return isRunningModel || allowedPathnames.includes(pathname);