Skip to content

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

Build the new metric page's queries from the store's builder (#82153)

Romeo Van Snick97d871c78ad0
diff --git a/frontend/src/metabase/metrics/pages/NewMetricPage/NewMetricPage.tsx b/frontend/src/metabase/metrics/pages/NewMetricPage/NewMetricPage.tsx
index 360f8b75546..5014a14dabd 100644
--- a/frontend/src/metabase/metrics/pages/NewMetricPage/NewMetricPage.tsx
+++ b/frontend/src/metabase/metrics/pages/NewMetricPage/NewMetricPage.tsx
@@ -12,7 +12,6 @@ import {
} from "metabase/common/data-studio/components/PaneHeader";
import { getResultMetadata } from "metabase/common/data-studio/utils/get-result-metadata";
import type { MetricUrls } from "metabase/common/metrics/types";
-import { getMetadata } from "metabase/metadata-store";
import { MetricQueryEditor } from "metabase/metrics/components/MetricQueryEditor";
import { NAME_MAX_LENGTH } from "metabase/metrics/constants";
import { getInitialUiState } from "metabase/querying/editor/components/QueryEditor";
@@ -43,10 +42,10 @@ export function NewMetricPage({
triggeredFrom = "main_app",
}: NewMetricPageProps) {
const location = useLocation();
- const metadata = useSelector(getMetadata);
+ const initialQuery = useSelector(getInitialQuery);
const [name, setName] = useState("");
const [datasetQuery, setDatasetQuery] = useState(() =>
- Lib.toJsQuery(getInitialQuery(metadata)),
+ Lib.toJsQuery(initialQuery),
);
const [uiState, setUiState] = useState(getInitialUiState);
const [isModalOpened, { open: openModal, close: closeModal }] =
@@ -57,10 +56,7 @@ export function NewMetricPage({
const defaultCollectionId = useGetDefaultCollectionId();
const navigate = useNavigate();
- const query = useMemo(
- () => getQuery(datasetQuery, metadata),
- [datasetQuery, metadata],
- );
+ const query = useSelector((state) => getQuery(state, datasetQuery));
const resultMetadata = useMemo(() => {
return getResultMetadata(
diff --git a/frontend/src/metabase/metrics/pages/NewMetricPage/utils.ts b/frontend/src/metabase/metrics/pages/NewMetricPage/utils.ts
index 3ddb2db5489..0eb4e341793 100644
--- a/frontend/src/metabase/metrics/pages/NewMetricPage/utils.ts
+++ b/frontend/src/metabase/metrics/pages/NewMetricPage/utils.ts
@@ -1,14 +1,22 @@
-import Question from "metabase-lib/v1/Question";
-import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import { createSelector } from "@reduxjs/toolkit";
+
+import { selectQuestionFromOptsBuilder } from "metabase/metadata-store";
+import type { State } from "metabase/redux/store";
import type { DatasetQuery } from "metabase-types/api";
-export function getQuery(datasetQuery: DatasetQuery, metadata: Metadata) {
- return Question.create({ dataset_query: datasetQuery, metadata }).query();
-}
+// Memoised on the builder, which is itself memoised on the metadata, so the
+// query keeps one reference for as long as the metadata behind it does.
+export const getInitialQuery = createSelector(
+ [selectQuestionFromOptsBuilder],
+ (buildQuestion) =>
+ buildQuestion({ DEPRECATED_RAW_MBQL_type: "query" }).query(),
+);
-export function getInitialQuery(metadata: Metadata) {
- return Question.create({
- DEPRECATED_RAW_MBQL_type: "query",
- metadata,
- }).query();
-}
+export const getQuery = createSelector(
+ [
+ selectQuestionFromOptsBuilder,
+ (_state: State, datasetQuery: DatasetQuery) => datasetQuery,
+ ],
+ (buildQuestion, datasetQuery) =>
+ buildQuestion({ dataset_query: datasetQuery }).query(),
+);
diff --git a/frontend/src/metabase/metrics/pages/NewMetricPage/utils.unit.spec.ts b/frontend/src/metabase/metrics/pages/NewMetricPage/utils.unit.spec.ts
new file mode 100644
index 00000000000..588e6fb21ce
--- /dev/null
+++ b/frontend/src/metabase/metrics/pages/NewMetricPage/utils.unit.spec.ts
@@ -0,0 +1,27 @@
+import { createMockState } from "__support__/state";
+import { createMockEntitiesState } from "__support__/store";
+import { createMockStructuredDatasetQuery } from "metabase-types/api/mocks";
+import {
+ ORDERS_ID,
+ SAMPLE_DB_ID,
+ createSampleDatabase,
+} from "metabase-types/api/mocks/presets";
+
+import { getInitialQuery, getQuery } from "./utils";
+
+describe("NewMetricPage query selectors", () => {
+ const state = createMockState({
+ entities: createMockEntitiesState({ databases: [createSampleDatabase()] }),
+ });
+ const datasetQuery = createMockStructuredDatasetQuery({
+ database: SAMPLE_DB_ID,
+ query: { "source-table": ORDERS_ID },
+ });
+
+ // Each call builds a fresh Question, so without memoisation these would
+ // hand `useSelector` a new query on every store action.
+ it("keeps one query reference per metadata", () => {
+ expect(getInitialQuery(state)).toBe(getInitialQuery(state));
+ expect(getQuery(state, datasetQuery)).toBe(getQuery(state, datasetQuery));
+ });
+});