The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
GDGT-1185: Columns appear twice in model list view until action taken (#65412)
Stas Gavrylove65f73716ca9
diff --git a/e2e/test/scenarios/models/models-list-view.cy.spec.js b/e2e/test/scenarios/models/models-list-view.cy.spec.jsindex 9f9d07378cf..9d2326e4cef 100644--- a/e2e/test/scenarios/models/models-list-view.cy.spec.js+++ b/e2e/test/scenarios/models/models-list-view.cy.spec.js@@ -206,6 +206,9 @@ describe("scenarios > models list view", () => {cy.findByTestId("list-view-preview").as("listPreview");cy.findByTestId("sidebar-right").as("sidebarRight");+ cy.log("Check that used column is not present in unused columns list.");+ cy.get("@sidebarRight").findByText("PRODUCT_ID").should("not.exist");+cy.get("@rightColumns").within(() => {cy.get("input").type("{Backspace}{Backspace}");});@@ -213,6 +216,7 @@ describe("scenarios > models list view", () => {cy.log("Find a draggable element with 'SUBTOTAL' text in sidebarRight panel and drag it into @rightColumns input",);+cy.get("@sidebarRight").within(() => {cy.findByText("SUBTOTAL").should("be.visible");});diff --git a/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx b/frontend/src/metabase/list-view/components/ListViz/ListViz.tsxindex 419569a7e76..beefc05978a 100644--- a/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx+++ b/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx@@ -11,6 +11,7 @@ import {getQuestion,} from "metabase/query_builder/selectors";import { Box, type IconName } from "metabase/ui";+import { color } from "metabase/ui/utils/colors";import ChartSettingLinkUrlInput from "metabase/visualizations/components/settings/ChartSettingLinkUrlInput";import { columnSettings } from "metabase/visualizations/lib/settings/column";import {@@ -55,7 +56,7 @@ const vizDefinition = {default: null,},"list.entity_icon_color": {- default: "text-primary",+ default: color("text-primary"),},"list.entity_icon_enabled": {default: true,diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsxindex fabbfad1593..7cad9ff4dac 100644--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsx+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsx@@ -38,7 +38,7 @@ const mockUnsavedCard = createMockUnsavedCard();const noop = () => {};const defaultDatasetEditorProps = {datasetEditorTab: "query",- rawSeries: [],+ rawSeries: null,visualizationSettings: {},isDirty: false,isMetadataDirty: false,diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsxindex e6fde575450..66e4b61b675 100644--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx@@ -49,6 +49,12 @@ import {import { getWritableColumnProperties } from "metabase/query_builder/utils";import { getMetadata } from "metabase/selectors/metadata";import { Box, Flex, Icon, Tooltip } from "metabase/ui";+import {+ extractRemappings,+ getVisualizationTransformed,+} from "metabase/visualizations";+import { getComputedSettingsForSeries } from "metabase/visualizations/lib/settings/visualization";+import type { ComputedVisualizationSettings } from "metabase/visualizations/types";import * as Lib from "metabase-lib";import type Question from "metabase-lib/v1/Question";import type Metadata from "metabase-lib/v1/metadata/Metadata";@@ -62,6 +68,8 @@ import type {Field,RawSeries,ResultsMetadata,+ Series,+ VisualizationDisplay,VisualizationSettings,} from "metabase-types/api";import type { DatasetEditorTab, QueryBuilderMode } from "metabase-types/store";@@ -75,7 +83,6 @@ import DatasetFieldMetadataSidebar from "./DatasetFieldMetadataSidebar";import DatasetQueryEditor from "./DatasetQueryEditor";import { EditorTabs } from "./EditorTabs";import { EDITOR_TAB_INDEXES } from "./constants";-type MetadataDiff = Record<string, Partial<Field>>;export type DatasetEditorInnerProps = {@@ -160,7 +167,7 @@ function getSidebar(focusFirstField: () => void;onFieldMetadataChange: (values: Partial<DatasetColumn>) => void;onMappedDatabaseColumnChange: (value: number) => void;- onUpdateModelSettings: (settings: ModelSettings) => void;+ onUpdateModelSettings: (settings: Partial<ModelSettings>) => void;modelSettings: ModelSettings;},): ReactNode {@@ -203,14 +210,29 @@ function getSidebar(if (isQueryError || !props.rawSeries) {return null;}+if (!focusedField) {// Returning a div, so the sidebar is visible while the data is loading.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 (<DatasetEditorSettingsSidebardisplay={modelSettings.display}- visualizationSettings={question.settings()}+ visualizationSettings={listViewSettings}onUpdateModelSettings={onUpdateModelSettings}/>);@@ -252,6 +274,34 @@ function getColumnTabIndex(columnIndex: number, focusedFieldIndex: number) {);}+function getTempRawSeries(+ rawSeries: RawSeries,+ display: VisualizationDisplay,+): RawSeries {+ if (!rawSeries || !rawSeries.length) {+ return rawSeries;+ }++ return [+ {+ ...rawSeries[0],+ card: { ...rawSeries[0].card, display },+ },+ ] as RawSeries;+}++function getTempVisualizationSettings(+ series: Series | null,+): ComputedVisualizationSettings | null {+ if (series == null) {+ return series;+ }++ return getComputedSettingsForSeries(+ getVisualizationTransformed(extractRemappings(series)).series,+ ) as ComputedVisualizationSettings;+}+const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {const {question,@@ -306,20 +356,17 @@ const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {() => {return {display: question.display(),+ visualizationSettings:+ getTempVisualizationSettings(rawSeries) || question.settings(),};},);const tempRawSeries = useMemo(() => {- if (!rawSeries || !rawSeries.length) {+ if (!rawSeries || !rawSeries.length || !tempModelSettings.display) {return rawSeries;}- return [- {- ...rawSeries[0],- card: { ...rawSeries[0].card, display: tempModelSettings.display },- },- ];+ return getTempRawSeries(rawSeries, tempModelSettings.display);}, [tempModelSettings, rawSeries]);const [isSettingsDirty, setSettingsDirty] = useState(false);@@ -433,15 +480,19 @@ const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {const hasListViewSelected = display === "list" || tempDisplay === "list";if (hasListViewSelected) {if (tab !== "metadata") {- setTempModelSettings({+ setTempModelSettings(() => ({+ visualizationSettings: question.settings(),display: "table",- });+ }));}}if (tab === "metadata") {- setTempModelSettings({+ setTempModelSettings((prevSettings) => ({+ visualizationSettings:+ getTempVisualizationSettings(tempRawSeries) ||+ prevSettings.visualizationSettings,display: question.display(),- });+ }));}if (hasListViewSelected && isShowingListViewConfiguration) {dispatch(setUIControls({ isShowingListViewConfiguration: false }));@@ -454,6 +505,7 @@ const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {dispatch,isShowingListViewConfiguration,tempModelSettings,+ tempRawSeries,],);@@ -502,7 +554,10 @@ const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {const canBeDataset = checkCanBeModel(question);const isBrandNewDataset = !question.id();let questionWithUpdatedSettings = question;- if (tempModelSettings?.display !== question.display()) {+ if (+ !!tempModelSettings.display &&+ tempModelSettings.display !== question.display()+ ) {questionWithUpdatedSettings = question.setDisplay(tempModelSettings.display,);@@ -653,10 +708,18 @@ const _DatasetEditorInner = (props: DatasetEditorInnerProps) => {focusFirstField,onFieldMetadataChange,onMappedDatabaseColumnChange,- onUpdateModelSettings: (settings: ModelSettings) => {+ onUpdateModelSettings: (settings) => {setSettingsDirty(settings.display !== question.display());- if (settings.display) {- setTempModelSettings({ display: settings.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,+ }));}},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.tsxindex 58795493b6d..eb2acb5d1f3 100644--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorSettingsSidebar/DatasetEditorSettingsSidebar.tsx+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorSettingsSidebar/DatasetEditorSettingsSidebar.tsx@@ -14,11 +14,12 @@ import { ListViewColumnsSidebar } from "./ListViewColumnsSidebar";export type ModelSettings = {display: CardDisplayType;+ visualizationSettings: ComputedVisualizationSettings;};type DatasetEditorSettingsSidebarProps = {- onUpdateModelSettings: (settings: ModelSettings) => void;+ onUpdateModelSettings: (settings: Partial<ModelSettings>) => void;visualizationSettings: ComputedVisualizationSettings;- display: CardDisplayType;+ display?: CardDisplayType;};export const DatasetEditorSettingsSidebar = ({onUpdateModelSettings: onUpdateSettings,