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
Take a metadata provider in the detail-view query helpers (#82151)
Romeo Van Snicke096a361d801
diff --git a/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.tsx b/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.tsxindex 232755549f9..582df6b5c65 100644--- a/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.tsx+++ b/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.tsx@@ -1,13 +1,11 @@import cx from "classnames";import { inflect } from "inflection";import { useMemo } from "react";-import { useLatest } from "react-use";import { t } from "ttag";import { skipToken, useGetAdhocQueryQuery } from "metabase/api";import { Link } from "metabase/common/components/Link";-import { getMetadata } from "metabase/metadata-store";-import { useSelector } from "metabase/redux";+import { useStore } from "metabase/redux";import { Loader, Stack, Text, rem } from "metabase/ui";import * as Lib from "metabase-lib";import type { ForeignKey } from "metabase-types/api";@@ -26,11 +24,12 @@ interface Props {}export const Relationship = ({ fk, rowId, onClick }: Props) => {- const metadata = useSelector(getMetadata);- const metadataRef = useLatest(metadata);+ // Read at build time rather than subscribed: the query feeds an ad-hoc+ // request, and rebuilding it on every metadata change would refetch.+ const store = useStore();const fkQuery = useMemo(- () => getForeignKeyQuery(fk, rowId, metadataRef.current),- [fk, rowId, metadataRef],+ () => getForeignKeyQuery(store.getState(), fk, rowId),+ [store, fk, rowId],);const fkCountQuery = useMemo(() => (fkQuery != null ? getForeignKeyCountQuery(fkQuery) : undefined),diff --git a/frontend/src/metabase/detail-view/components/Relationships/Relationship/utils.ts b/frontend/src/metabase/detail-view/components/Relationships/Relationship/utils.tsindex 91d8416b83e..70747295d6e 100644--- a/frontend/src/metabase/detail-view/components/Relationships/Relationship/utils.ts+++ b/frontend/src/metabase/detail-view/components/Relationships/Relationship/utils.ts@@ -1,8 +1,11 @@+import { createSelector } from "@reduxjs/toolkit";++import { selectMetadataProvider } from "metabase/metadata-store";+import type { State } from "metabase/redux/store";import * as Urls from "metabase/urls";import { parseNumber } from "metabase/utils/number";import * as Lib from "metabase-lib";import Question from "metabase-lib/v1/Question";-import type Metadata from "metabase-lib/v1/metadata/Metadata";import type { ForeignKey, RowValue } from "metabase-types/api";const STAGE_INDEX = 0;@@ -45,36 +48,36 @@ function getForeignKeyFilterClause(field: Lib.ColumnMetadata, rowId: RowValue) {}}-export function getForeignKeyQuery(- fk: ForeignKey,- rowId: RowValue,- metadata: Metadata,-) {- if (fk.origin == null || fk.origin.table == null) {- return;- }+export const getForeignKeyQuery = createSelector(+ [+ (state: State, fk: ForeignKey) =>+ selectMetadataProvider(state, fk.origin?.table?.db_id ?? null),+ (_state: State, fk: ForeignKey) => fk,+ (_state: State, _fk: ForeignKey, rowId: RowValue) => rowId,+ ],+ (metadataProvider, fk, rowId) => {+ if (fk.origin == null || fk.origin.table == null) {+ return;+ }- const metadataProvider = Lib.metadataProvider(- fk.origin.table.db_id,- metadata,- );- const table = Lib.tableOrCardMetadata(metadataProvider, fk.origin.table_id);- const field = Lib.fieldMetadata(metadataProvider, fk.origin_id);- if (table == null || field == null) {- return;- }+ const table = Lib.tableOrCardMetadata(metadataProvider, fk.origin.table_id);+ const field = Lib.fieldMetadata(metadataProvider, fk.origin_id);+ if (table == null || field == null) {+ return;+ }- const filter = getForeignKeyFilterClause(field, rowId);- if (filter == null) {- return;- }+ const filter = getForeignKeyFilterClause(field, rowId);+ if (filter == null) {+ return;+ }- return Lib.filter(- Lib.queryFromTableOrCardMetadata(metadataProvider, table),- STAGE_INDEX,- filter,- );-}+ return Lib.filter(+ Lib.queryFromTableOrCardMetadata(metadataProvider, table),+ STAGE_INDEX,+ filter,+ );+ },+);export function getForeignKeyCountQuery(fkQuery: Lib.Query) {return Lib.aggregateByCount(fkQuery, STAGE_INDEX);diff --git a/frontend/src/metabase/detail-view/pages/ModelDetailPage/ModelDetailPage.tsx b/frontend/src/metabase/detail-view/pages/ModelDetailPage/ModelDetailPage.tsxindex 596b68dc076..bbd484385bf 100644--- a/frontend/src/metabase/detail-view/pages/ModelDetailPage/ModelDetailPage.tsx+++ b/frontend/src/metabase/detail-view/pages/ModelDetailPage/ModelDetailPage.tsx@@ -12,7 +12,6 @@ import {getRowName,getTableQuery,} from "metabase/detail-view/utils";-import { getMetadata } from "metabase/metadata-store";import { useDispatch, useSelector } from "metabase/redux";import { closeNavbar, setDetailView } from "metabase/redux/app";import { useParams } from "metabase/router";@@ -49,11 +48,7 @@ export function ModelDetailPage() {virtualTableId != null? queryMetadata?.tables?.find((table) => table.id === virtualTableId): undefined;- const metadata = useSelector(getMetadata);- const tableQuery = useMemo(- () => getTableQuery(metadata, table),- [metadata, table],- );+ const tableQuery = useSelector((state) => getTableQuery(state, table));const objectQuery = useMemo(() => {return tableQuery && table? filterByPk(tableQuery, table.fields ?? [], rowId)diff --git a/frontend/src/metabase/detail-view/pages/TableDetailPage/TableDetailPage.tsx b/frontend/src/metabase/detail-view/pages/TableDetailPage/TableDetailPage.tsxindex 6ed49e23f2c..49f1c3efd72 100644--- a/frontend/src/metabase/detail-view/pages/TableDetailPage/TableDetailPage.tsx+++ b/frontend/src/metabase/detail-view/pages/TableDetailPage/TableDetailPage.tsx@@ -15,7 +15,6 @@ import {getRowName,getTableQuery,} from "metabase/detail-view/utils";-import { getMetadata } from "metabase/metadata-store";import { useDispatch, useSelector } from "metabase/redux";import { closeNavbar, setDetailView } from "metabase/redux/app";import { useParams } from "metabase/router";@@ -37,11 +36,7 @@ export function TableDetailPage() {} = useGetTableQueryMetadataQuery({ id: tableId });const { data: tableForeignKeys } = useListTableForeignKeysQuery(tableId);- const metadata = useSelector(getMetadata);- const tableQuery = useMemo(- () => getTableQuery(metadata, table),- [metadata, table],- );+ const tableQuery = useSelector((state) => getTableQuery(state, table));const objectQuery = useMemo(() => {return tableQuery && table? filterByPk(tableQuery, table.fields ?? [], rowId)diff --git a/frontend/src/metabase/detail-view/utils.ts b/frontend/src/metabase/detail-view/utils.tsindex 6d288b525b7..15b11fdf10a 100644--- a/frontend/src/metabase/detail-view/utils.ts+++ b/frontend/src/metabase/detail-view/utils.ts@@ -1,4 +1,8 @@+import { createSelector } from "@reduxjs/toolkit";+import type { ContentTranslationFunction } from "metabase/content-translation/types";+import { selectMetadataProvider } from "metabase/metadata-store";+import type { State } from "metabase/redux/store";import { formatValue } from "metabase/value-formatting";import {getComputedSettings,@@ -8,7 +12,6 @@ import {getTitleForColumn,} from "metabase/viz-core";import * as Lib from "metabase-lib";-import type Metadata from "metabase-lib/v1/metadata/Metadata";import {isAvatarURL,isEntityName,@@ -194,22 +197,25 @@ export const getEntityIcon = (entityType?: Table["entity_type"]) => {}};-export function getTableQuery(- metadata: Metadata,- table: Table | undefined,-): Lib.Query | undefined {- if (!table) {- return undefined;- }-- const metadataProvider = Lib.metadataProvider(table.db_id, metadata);- const tableMetadata = Lib.tableOrCardMetadata(metadataProvider, table.id);- if (tableMetadata == null) {- return undefined;- }-- return Lib.queryFromTableOrCardMetadata(metadataProvider, tableMetadata);-}+export const getTableQuery = createSelector(+ [+ (state: State, table: Table | undefined) =>+ selectMetadataProvider(state, table?.db_id ?? null),+ (_state: State, table: Table | undefined) => table,+ ],+ (metadataProvider, table): Lib.Query | undefined => {+ if (!table) {+ return undefined;+ }++ const tableMetadata = Lib.tableOrCardMetadata(metadataProvider, table.id);+ if (tableMetadata == null) {+ return undefined;+ }++ return Lib.queryFromTableOrCardMetadata(metadataProvider, tableMetadata);+ },+);export function filterByPk(query: Lib.Query,diff --git a/frontend/src/metabase/detail-view/utils.unit.spec.ts b/frontend/src/metabase/detail-view/utils.unit.spec.tsnew file mode 100644index 00000000000..b536ef720f2--- /dev/null+++ b/frontend/src/metabase/detail-view/utils.unit.spec.ts@@ -0,0 +1,28 @@+import { createMockState } from "__support__/state";+import { createMockEntitiesState } from "__support__/store";+import {+ createOrdersTable,+ createSampleDatabase,+} from "metabase-types/api/mocks/presets";++import { getTableQuery } from "./utils";++describe("getTableQuery", () => {+ const state = createMockState({+ entities: createMockEntitiesState({ databases: [createSampleDatabase()] }),+ });+ const table = createOrdersTable();++ // The memoisation is what keeps `useSelector` from handing the page a new+ // query on every store action.+ it("keeps one query reference per metadata", () => {+ const query = getTableQuery(state, table);+ // Guards the assertion below: two `undefined`s would also compare equal.+ expect(query).toBeDefined();+ expect(getTableQuery(state, table)).toBe(query);+ });++ it("returns nothing without a table", () => {+ expect(getTableQuery(state, undefined)).toBeUndefined();+ });+});