Skip to content

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

Decouple ObjectDetail from QB (#72845)

Fraser0a5e7eec56a8
diff --git a/e2e/test/scenarios/dashboard-cards/dashboard-drill.cy.spec.js b/e2e/test/scenarios/dashboard-cards/dashboard-drill.cy.spec.js
index 3a85f7d715e..c2baf163d69 100644
--- a/e2e/test/scenarios/dashboard-cards/dashboard-drill.cy.spec.js
+++ b/e2e/test/scenarios/dashboard-cards/dashboard-drill.cy.spec.js
@@ -554,7 +554,7 @@ describe("scenarios > dashboard > dashboard drill", () => {
});
cy.findByTestId("object-detail")
.findAllByText("Fantastic Wool Shirt")
- .should("have.length", 2)
+ .should("have.length", 3)
.and("be.visible");
});
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjs
index 61f280146d0..fd53a9f3097 100644
--- a/frontend/lint/module-boundaries.mjs
+++ b/frontend/lint/module-boundaries.mjs
@@ -58,7 +58,11 @@ const elements = [
createElement({ type: "shared", name: "common", enforceOutgoing: true }),
createElement({ type: "shared", name: "palette", enforceOutgoing: true }),
createElement({ type: "shared", name: "querying" }),
- createElement({ type: "shared", name: "visualizations" }),
+ createElement({
+ type: "shared",
+ name: "visualizations",
+ enforceOutgoing: true,
+ }),
createElement({ type: "shared", name: "visualizer", enforceOutgoing: true }),
createElement({ type: "shared", name: "account", enforceOutgoing: true }),
createElement({ type: "shared", name: "archive", enforceOutgoing: true }),
diff --git a/frontend/src/metabase/list-view/components/ListView/ListView.tsx b/frontend/src/metabase/list-view/components/ListView/ListView.tsx
index 6821fe9ef73..a1812046b52 100644
--- a/frontend/src/metabase/list-view/components/ListView/ListView.tsx
+++ b/frontend/src/metabase/list-view/components/ListView/ListView.tsx
@@ -3,7 +3,6 @@ import cx from "classnames";
import { type CSSProperties, useMemo, useRef } from "react";
import { Icon, Stack, Text } from "metabase/ui";
-import { useObjectDetail } from "metabase/visualizations/components/TableInteractive/hooks/use-object-detail";
import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
import * as Lib from "metabase-lib";
import type {
@@ -25,6 +24,7 @@ export interface ListViewProps {
entityType?: string;
isInteractive?: boolean;
className?: string;
+ onZoomRow?: (rowIndex: number) => void;
}
export function ListView({
@@ -36,6 +36,7 @@ export function ListView({
entityType,
isInteractive,
className,
+ onZoomRow,
}: ListViewProps) {
const { cols, rows } = data;
@@ -53,8 +54,6 @@ export function ListView({
settings?.["list.columns"],
);
- const openObjectDetail = useObjectDetail(data);
-
// Get the appropriate icon based on entity type
const entityIcon =
settings?.["list.entity_icon"] || getEntityIcon(entityType);
@@ -137,7 +136,7 @@ export function ListView({
}
titleColumn={titleColumn}
rightColumns={rightColumns}
- onClick={() => isInteractive && openObjectDetail(index)}
+ onClick={() => isInteractive && onZoomRow?.(index)}
className={styles.listItemVirtualized}
style={{
transform: `translateY(${start}px)`,
diff --git a/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx b/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx
index b0325b4ebb0..d3150df80e8 100644
--- a/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx
+++ b/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx
@@ -21,6 +21,7 @@ import {
import type {
ColumnSettingDefinition,
VisualizationDefinition,
+ VisualizationPassThroughProps,
VisualizationProps,
} from "metabase/visualizations/types";
import * as Lib from "metabase-lib";
@@ -263,7 +264,8 @@ export const ListViz = ({
onVisualizationClick,
queryBuilderMode,
isDashboard,
-}: VisualizationProps) => {
+ onZoomRow,
+}: VisualizationProps & VisualizationPassThroughProps) => {
const dispatch = useDispatch();
const question = useSelector(getQuestion);
const isShowingListViewConfiguration = useSelector(
@@ -385,6 +387,7 @@ export const ListViz = ({
onSortClick={handleSort}
entityType={entityType}
isInteractive={queryBuilderMode !== "dataset"}
+ onZoomRow={onZoomRow}
/>
)}
</Box>
diff --git a/frontend/src/metabase/query_builder/components/ObjectDetailSidesheet.tsx b/frontend/src/metabase/query_builder/components/ObjectDetailSidesheet.tsx
new file mode 100644
index 00000000000..b65551b6064
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/ObjectDetailSidesheet.tsx
@@ -0,0 +1,141 @@
+import { useCallback, useMemo } from "react";
+
+import { skipToken, useListTableForeignKeysQuery } from "metabase/api";
+import { DetailViewSidesheet } from "metabase/detail-view/components";
+import { filterByPk } from "metabase/detail-view/utils";
+import { useDispatch, useSelector } from "metabase/redux";
+import {
+ getApiTable,
+ getIdValue,
+ getRowUrl,
+ getSingleResultsRow,
+} from "metabase/visualizations/components/ObjectDetail/utils";
+import { getComputedSettingsForSeries } from "metabase/visualizations/lib/settings/visualization";
+import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
+
+import {
+ closeObjectDetail,
+ runQuestionQuery,
+ viewNextObjectDetail,
+ viewPreviousObjectDetail,
+} from "../actions";
+import {
+ getCanZoomNextRow,
+ getCanZoomPreviousRow,
+ getQuestion,
+ getRawSeries,
+ getTableMetadata,
+ getZoomRow,
+ getZoomedObjectId,
+} from "../selectors";
+import { getIsObjectDetail } from "../selectors/mode";
+
+export function ObjectDetailSidesheet() {
+ const isObjectDetail = useSelector(getIsObjectDetail);
+
+ if (!isObjectDetail) {
+ return null;
+ }
+
+ return <ObjectDetailSidesheetInner />;
+}
+
+function ObjectDetailSidesheetInner() {
+ const dispatch = useDispatch();
+ const rawSeries = useSelector(getRawSeries);
+ const question = useSelector(getQuestion);
+ const table = useSelector(getTableMetadata);
+ const zoomedObjectId = useSelector(getZoomedObjectId);
+ const zoomRow = useSelector(getZoomRow);
+ const canZoomPreviousRow = useSelector(getCanZoomPreviousRow);
+ const canZoomNextRow = useSelector(getCanZoomNextRow);
+
+ const { data: tableForeignKeys } = useListTableForeignKeysQuery(
+ table ? table.id : skipToken,
+ );
+
+ const data = useMemo(() => {
+ const first = rawSeries?.[0];
+ if (!first) {
+ return undefined;
+ }
+ // Force "object" display so settings resolve the object-detail column config.
+ const series = [
+ { ...first, card: { ...first.card, display: "object" as const } },
+ ];
+ return { series, settings: getComputedSettingsForSeries(series) };
+ }, [rawSeries]);
+
+ const datasetData = data?.series[0].data;
+ const columns = datasetData?.cols;
+ const isZooming = zoomedObjectId != null;
+ const zoomedRowID = isZooming
+ ? zoomedObjectId
+ : datasetData
+ ? getIdValue({ data: datasetData, tableId: table?.id })
+ : null;
+
+ const filteredQuery = useMemo(() => {
+ if (columns == null || zoomedRowID == null || question == null) {
+ return undefined;
+ }
+ return filterByPk(question.query(), columns, zoomedRowID);
+ }, [columns, zoomedRowID, question]);
+
+ const onViewPrevious = useCallback(
+ () => dispatch(viewPreviousObjectDetail()),
+ [dispatch],
+ );
+ const onViewNext = useCallback(
+ () => dispatch(viewNextObjectDetail()),
+ [dispatch],
+ );
+ const onClose = useCallback(() => dispatch(closeObjectDetail()), [dispatch]);
+ const onActionSuccess = useCallback(
+ () => dispatch(runQuestionQuery()),
+ [dispatch],
+ );
+
+ if (
+ data == null ||
+ datasetData == null ||
+ columns == null ||
+ zoomedRowID == null ||
+ question == null
+ ) {
+ return null;
+ }
+
+ const { settings } = data;
+ const zoomedRow = isZooming ? zoomRow : getSingleResultsRow(datasetData);
+ const canZoom = isZooming && !!zoomedRow;
+ const apiTable = getApiTable(table);
+ const columnsSettings = columns.map(
+ (column) => settings?.column_settings?.[getColumnKey(column)],
+ );
+ const showImplicitActions = Boolean(
+ question.canWrite() &&
+ question.type() === "model" &&
+ question.supportsImplicitActions(),
+ );
+
+ return (
+ <DetailViewSidesheet
+ columnSettings={settings?.["table.columns"]}
+ columns={columns}
+ columnsSettings={columnsSettings}
+ query={filteredQuery}
+ row={zoomedRow}
+ rowId={zoomedRowID}
+ showImplicitActions={showImplicitActions}
+ showNav={Boolean(canZoom && (canZoomNextRow || canZoomPreviousRow))}
+ table={apiTable}
+ tableForeignKeys={tableForeignKeys}
+ url={getRowUrl(question, columns, apiTable, zoomedRowID)}
+ onActionSuccess={onActionSuccess}
+ onClose={onClose}
+ onNextClick={canZoomNextRow ? onViewNext : undefined}
+ onPreviousClick={canZoomPreviousRow ? onViewPrevious : undefined}
+ />
+ );
+}
diff --git a/frontend/src/metabase/query_builder/components/ObjectDetailSidesheet.unit.spec.tsx b/frontend/src/metabase/query_builder/components/ObjectDetailSidesheet.unit.spec.tsx
new file mode 100644
index 00000000000..c071ab6c4d6
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/ObjectDetailSidesheet.unit.spec.tsx
@@ -0,0 +1,176 @@
+import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
+
+import {
+ setupActionsEndpoints,
+ setupDatabasesEndpoints,
+ setupTableEndpoints,
+} from "__support__/server-mocks";
+import { createMockEntitiesState } from "__support__/store";
+import { testDataset } from "__support__/testDataset";
+import {
+ getBrokenUpTextMatcher,
+ renderWithProviders,
+ screen,
+ waitFor,
+ waitForLoaderToBeRemoved,
+} from "__support__/ui";
+import { ObjectDetailSidesheet } from "metabase/query_builder/components/ObjectDetailSidesheet";
+import {
+ createMockQueryBuilderState,
+ createMockState,
+} from "metabase/redux/store/mocks";
+import { checkNotNull } from "metabase/utils/types";
+import registerVisualizations from "metabase/visualizations/register";
+import type { Field } from "metabase-types/api";
+import { createMockCard, createMockDataset } from "metabase-types/api/mocks";
+import {
+ PRODUCTS_ID,
+ SAMPLE_DB_ID,
+ createOrdersTable,
+ createProductsTable,
+ createReviewsTable,
+} from "metabase-types/api/mocks/presets";
+
+registerVisualizations();
+
+const PRODUCTS_TABLE = createProductsTable();
+const ORDERS_TABLE = createOrdersTable();
+const HIDDEN_ORDERS_TABLE = createOrdersTable({
+ visibility_type: "hidden",
+});
+const REVIEWS_TABLE = createReviewsTable();
+
+const FK_RECORDS_COUNT = 93;
+
+interface SetupOpts {
+ hideOrdersTable?: boolean;
+}
+
+function setup({ hideOrdersTable = false }: SetupOpts = {}) {
+ setupDatabasesEndpoints([]);
+ setupActionsEndpoints([]);
+ const productsId = checkNotNull(findField(PRODUCTS_TABLE.fields, "ID"));
+ const ordersProductId = {
+ ...checkNotNull(findField(ORDERS_TABLE.fields, "PRODUCT_ID")),
+ table: ORDERS_TABLE,
+ };
+ const reviewsProductId = {
+ ...checkNotNull(findField(REVIEWS_TABLE.fields, "PRODUCT_ID")),
+ table: REVIEWS_TABLE,
+ };
+ setupTableEndpoints(PRODUCTS_TABLE, [
+ {
+ origin: ordersProductId,
+ origin_id: ordersProductId.id as number,
+ destination: productsId,
+ destination_id: productsId.id as number,
+ relationship: "Mt1",
+ },
+ {
+ origin: reviewsProductId,
+ origin_id: reviewsProductId.id as number,
+ destination: productsId,
+ destination_id: productsId.id as number,
+ relationship: "Mt1",
+ },
+ ]);
+ setupForeignKeyCountQueryEndpoints();
+
+ const ROW_ID_INDEX = 0;
+ const state = createMockState({
+ entities: createMockEntitiesState({
+ tables: [
+ PRODUCTS_TABLE,
+ hideOrdersTable ? HIDDEN_ORDERS_TABLE : ORDERS_TABLE,
+ REVIEWS_TABLE,
+ ],
+ }),
+ qb: createMockQueryBuilderState({
+ card: createMockCard({
+ dataset_query: {
+ database: SAMPLE_DB_ID,
+ type: "query",
+ query: {
+ "source-table": PRODUCTS_ID,
+ },
+ },
+ }),
+ zoomedRowObjectId: testDataset.rows[0][ROW_ID_INDEX] as string,
+ queryResults: [
+ createMockDataset({
+ data: testDataset,
+ }),
+ ],
+ }),
+ });
+ renderWithProviders(<ObjectDetailSidesheet />, {
+ storeInitialState: state,
+ });
+}
+
+function setupForeignKeyCountQueryEndpoints() {
+ fetchMock.post({
+ name: "ordersCountQuery",
+ url: "path:/api/dataset",
+ response: createMockDataset({
+ status: "completed",
+ data: {
+ rows: [[FK_RECORDS_COUNT]],
+ },
+ }),
+ });
+}
+
+function findField(fields: Field[] | undefined, name: string) {
+ return fields?.find((field) => field.name === name);
+}
+
+describe("ObjectDetailSidesheet", () => {
+ it("should render foreign key count when no table is hidden", async () => {
+ setup();
+
+ await waitFor(() => {
+ expect(screen.getAllByTestId("loading-indicator")).toHaveLength(2);
+ });
+ await waitForLoaderToBeRemoved();
+
+ expect(
+ await screen.findByText(
+ getBrokenUpTextMatcher([FK_RECORDS_COUNT, "Reviews"].join("")),
+ ),
+ ).toBeInTheDocument();
+ expect(
+ await screen.findByText(
+ getBrokenUpTextMatcher([FK_RECORDS_COUNT, "Orders"].join("")),
+ ),
+ ).toBeInTheDocument();
+ });
+
+ it("should render related objects count only for foreign keys referencing non-hidden tables (metabase#32654)", async () => {
+ setup({ hideOrdersTable: true });
+
+ await waitFor(() => {
+ expect(screen.getAllByTestId("loading-indicator")).toHaveLength(2);
+ });
+ await waitForLoaderToBeRemoved();
+
+ expect(
+ await screen.findByText(
+ getBrokenUpTextMatcher([FK_RECORDS_COUNT, "Reviews"].join("")),
+ ),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByText([FK_RECORDS_COUNT, "Orders"].join("")),
+ ).not.toBeInTheDocument();
+ });
+
+ it("moves focus into the object detail sidesheet when opened", async () => {
+ setup();
+ await screen.findByTestId("object-detail");
+ await waitForLoaderToBeRemoved();
+
+ await userEvent.tab();
+ expect(screen.getByLabelText("Copy link to this record")).toHaveFocus();
+ });
+});
diff --git a/frontend/src/metabase/query_builder/components/view/View/ViewMainContainer/ViewMainContainer.tsx b/frontend/src/metabase/query_builder/components/view/View/ViewMainContainer/ViewMainContainer.tsx
index e3de3c49753..4e1727ea792 100644
--- a/frontend/src/metabase/query_builder/components/view/View/ViewMainContainer/ViewMainContainer.tsx
+++ b/frontend/src/metabase/query_builder/components/view/View/ViewMainContainer/ViewMainContainer.tsx
@@ -4,6 +4,7 @@ import type { ResizableBoxProps } from "react-resizable";
import { DebouncedFrame } from "metabase/common/components/DebouncedFrame";
import CS from "metabase/css/core/index.css";
+import { ObjectDetailSidesheet } from "metabase/query_builder/components/ObjectDetailSidesheet";
import { SyncedParametersList } from "metabase/query_builder/components/SyncedParametersList";
import { QueryVisualization } from "metabase/querying/components/QueryVisualization";
import type { QueryModalType } from "metabase/querying/constants";
@@ -154,6 +155,7 @@ export const ViewMainContainer = (props: ViewMainContainerProps) => {
onUpdateQuestion={updateQuestion}
/>
</DebouncedFrame>
+ <ObjectDetailSidesheet />
<Box ref={footerRef} className={ViewMainContainerS.Footer}>
<TimeseriesChrome question={question} updateQuestion={updateQuestion} />
<ViewFooter className={CS.flexNoShrink} />
diff --git a/frontend/src/metabase/query_builder/selectors.ts b/frontend/src/metabase/query_builder/selectors.ts
index d143e9db214..31cbdf12df9 100644
--- a/frontend/src/metabase/query_builder/selectors.ts
+++ b/frontend/src/metabase/query_builder/selectors.ts
@@ -594,7 +594,11 @@ export const getCanZoomPreviousRow = createSelector(
export const getCanZoomNextRow = createSelector(
[getQueryResults, getZoomedObjectRowIndex],
(queryResults, rowIndex) => {
- if (!Array.isArray(queryResults) || !queryResults.length) {
+ if (
+ !Array.isArray(queryResults) ||
+ !queryResults.length ||
+ !queryResults[0].data
+ ) {
return;
}
const rowCount = queryResults[0].data.rows.length;
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.jsx b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.jsx
index 685bcb96332..e7d16efb6df 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.jsx
+++ b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.jsx
@@ -1,6 +1,6 @@
/* eslint-disable react/prop-types */
import cx from "classnames";
-import { Component } from "react";
+import { Component, useCallback } from "react";
import { jt, t } from "ttag";
import _ from "underscore";
@@ -10,12 +10,14 @@ import CS from "metabase/css/core/index.css";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import { CreateOrEditQuestionAlertModalWithQuestion } from "metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal";
import { ALERT_TYPE_ROWS, getAlertType } from "metabase/notifications/utils";
-import { zoomInRow } from "metabase/query_builder/actions";
+import { resetRowZoom, zoomInRow } from "metabase/query_builder/actions";
import {
getIsShowingRawTable,
+ getRowIndexToPKMap,
getUiControls,
+ getZoomedObjectId,
} from "metabase/query_builder/selectors";
-import { useSelector } from "metabase/redux";
+import { useDispatch, useSelector } from "metabase/redux";
import Visualization from "metabase/visualizations/components/Visualization";
import * as Lib from "metabase-lib";
import { datasetContainsNoResults } from "metabase-lib/v1/queries/utils/dataset";
@@ -36,15 +38,30 @@ const ALLOWED_VISUALIZATION_PROPS = [
];
export function VisualizationResult(props) {
+ const dispatch = useDispatch();
const isRawTable = useSelector(getIsShowingRawTable);
const scrollToLastColumn = useSelector(
(state) => getUiControls(state)?.scrollToLastColumn ?? false,
);
+ const rowIndexToPkMap = useSelector(getRowIndexToPKMap);
+ const zoomedObjectId = useSelector(getZoomedObjectId);
+ const onZoomRow = useCallback(
+ (rowIndex) => {
+ const objectId = rowIndexToPkMap?.[rowIndex] ?? rowIndex;
+ if (objectId === zoomedObjectId) {
+ dispatch(resetRowZoom());
+ } else {
+ dispatch(zoomInRow({ objectId }));
+ }
+ },
+ [dispatch, rowIndexToPkMap, zoomedObjectId],
+ );
return (
<VisualizationResultInner
{...props}
isRawTable={isRawTable}
scrollToLastColumn={scrollToLastColumn}
+ onZoomRow={onZoomRow}
/>
);
}
@@ -62,15 +79,6 @@ class VisualizationResultInner extends Component {
this.setState({ showCreateAlertModal: false });
};
- getObjectDetailData = (series) => {
- return [
- {
- ...series[0],
- card: { ...series[0].card, display: "object" },
- },
- ];
- };
-
render() {
const {
question,
@@ -176,6 +184,7 @@ class VisualizationResultInner extends Component {
token={token}
selectedTimelineEventIds={selectedTimelineEventIds}
getExtraDataForClick={() => ({ zoomInRow })}
+ onZoomRow={this.props.onZoomRow}
handleVisualizationClick={this.props.handleVisualizationClick}
onOpenTimelines={this.props.onOpenTimelines}
onSelectTimelineEvents={this.props.selectTimelineEvents}
@@ -190,12 +199,6 @@ class VisualizationResultInner extends Component {
onVisualizationRendered={this.props.onVisualizationRendered}
{...vizSpecificProps}
/>
- {this.props.isObjectDetail && (
- <Visualization
- isObjectDetail={true}
- rawSeries={this.getObjectDetailData(rawSeries)}
- />
- )}
</>
);
}
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailWrapper.module.css b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.module.css
similarity index 100%
rename from frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailWrapper.module.css
rename to frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.module.css
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.tsx
index fd4da299bf3..3d8de356969 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.tsx
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.tsx
@@ -1,89 +1,61 @@
-import {
- closeObjectDetail,
- followForeignKey,
- loadObjectDetailFKReferences,
- runQuestionQuery,
- viewNextObjectDetail,
- viewPreviousObjectDetail,
-} from "metabase/query_builder/actions";
-import {
- getCanZoomNextRow,
- getCanZoomPreviousRow,
- getQuestion,
- getTableForeignKeyReferences,
- getTableForeignKeys,
- getTableMetadata,
- getZoomRow,
- getZoomedObjectId,
-} from "metabase/query_builder/selectors";
-import { connect } from "metabase/redux";
-import type { State } from "metabase/redux/store";
-import { fetchTableForeignKeys } from "metabase/redux/tables";
-import { getUser } from "metabase/selectors/user";
-import type ForeignKey from "metabase-lib/v1/metadata/ForeignKey";
-
-import { ObjectDetailWrapper } from "./ObjectDetailWrapper";
-import type { ObjectDetailProps, ObjectId } from "./types";
-import { getIdValue, getSingleResultsRow } from "./utils";
-
-const mapStateToProps = (state: State, { data }: ObjectDetailProps) => {
- const isLoggedIn = !!getUser(state);
-
- if (!isLoggedIn) {
- return {};
- }
+import { useEffect, useState } from "react";
- const table = getTableMetadata(state);
- let zoomedRowID = getZoomedObjectId(state);
- const isZooming = zoomedRowID != null;
+import Question from "metabase-lib/v1/Question";
- if (!isZooming) {
- zoomedRowID = getIdValue({ data, tableId: table?.id });
- }
+import { PaginationFooter } from "../PaginationFooter/PaginationFooter";
- const zoomedRow = isZooming ? getZoomRow(state) : getSingleResultsRow(data);
- const canZoomPreviousRow = isZooming ? getCanZoomPreviousRow(state) : false;
- const canZoomNextRow = isZooming ? Boolean(getCanZoomNextRow(state)) : false;
+import S from "./ObjectDetail.module.css";
+import { ObjectDetailPanel } from "./ObjectDetailPanel";
+import type { ObjectDetailProps } from "./types";
- return {
- question: getQuestion(state),
- table,
- tableForeignKeys: getTableForeignKeys(state),
- tableForeignKeyReferences: getTableForeignKeyReferences(state) ?? undefined,
- zoomedRowID: zoomedRowID ?? undefined,
- zoomedRow,
- canZoom: isZooming && !!zoomedRow,
- canZoomPreviousRow,
- canZoomNextRow,
- };
-};
-type MapStateProps = ReturnType<typeof mapStateToProps>;
-
-// ugh, using function form of mapDispatchToProps here due to circlular dependency with actions
-const mapDispatchToProps = (dispatch: any) => ({
- fetchTableFks: (id: number) => dispatch(fetchTableForeignKeys({ id })),
- loadObjectDetailFKReferences: (args: any) =>
- dispatch(loadObjectDetailFKReferences(args)),
- followForeignKey: ({
- objectId,
- fk,
- }: {
- objectId: ObjectId;
- fk: ForeignKey;
- }) => dispatch(followForeignKey({ objectId, fk })),
- viewPreviousObjectDetail: () => dispatch(viewPreviousObjectDetail()),
- viewNextObjectDetail: () => dispatch(viewNextObjectDetail()),
- closeObjectDetail: () => dispatch(closeObjectDetail()),
- onActionSuccess: () => dispatch(runQuestionQuery()),
-});
-type MapDispatchProps = ReturnType<typeof mapDispatchToProps>;
-
-type OwnProps = Omit<
- ObjectDetailProps,
- keyof MapStateProps | keyof MapDispatchProps
->;
-
-export const ObjectDetail = connect(
- mapStateToProps,
- mapDispatchToProps,
-)(ObjectDetailWrapper) as unknown as React.ComponentType<OwnProps>;
+export function ObjectDetail({
+ question,
+ isDataApp,
+ data,
+ closeObjectDetail,
+ card,
+ dashcard,
+ onActionSuccess,
+ ...rest
+}: ObjectDetailProps) {
+ const [currentObjectIndex, setCurrentObjectIndex] = useState(0);
+
+ useEffect(() => {
+ if (data.rows.length <= currentObjectIndex) {
+ setCurrentObjectIndex(0);
+ }
+ }, [data.rows, currentObjectIndex]);
+
+ const hasPagination = data?.rows?.length > 1;
+ const resolvedQuestion =
+ question ??
+ (card && rest.metadata ? new Question(card, rest.metadata) : undefined);
+
+ return (
+ <>
+ <ObjectDetailPanel
+ {...rest}
+ zoomedRow={data.rows[currentObjectIndex]}
+ data={data}
+ question={resolvedQuestion}
+ showHeader={rest.settings["detail.showHeader"]}
+ showControls={false}
+ showRelations={false}
+ closeObjectDetail={closeObjectDetail}
+ isDataApp={isDataApp}
+ />
+ {hasPagination && (
+ <PaginationFooter
+ className={S.pagination}
+ data-testid="pagination-footer"
+ start={currentObjectIndex}
+ end={currentObjectIndex}
+ total={data.rows.length}
+ onNextPage={() => setCurrentObjectIndex((prev) => prev + 1)}
+ onPreviousPage={() => setCurrentObjectIndex((prev) => prev - 1)}
+ singleItem
+ />
+ )}
+ </>
+ );
+}
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
index ec72b16609d..5a177cf46a2 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
@@ -1,177 +1,106 @@
-import fetchMock from "fetch-mock";
-
-import {
- setupActionsEndpoints,
- setupDatabasesEndpoints,
- setupTableEndpoints,
-} from "__support__/server-mocks";
+import { setupTableEndpoints } from "__support__/server-mocks";
import { createMockEntitiesState } from "__support__/store";
import { testDataset } from "__support__/testDataset";
import {
- getBrokenUpTextMatcher,
renderWithProviders,
screen,
- waitFor,
waitForLoaderToBeRemoved,
} from "__support__/ui";
import {
createMockQueryBuilderState,
createMockState,
} from "metabase/redux/store/mocks";
+import { getMetadata } from "metabase/selectors/metadata";
import { checkNotNull } from "metabase/utils/types";
+import { ObjectDetail } from "metabase/visualizations/components/ObjectDetail/ObjectDetail";
+import type { ObjectDetailProps } from "metabase/visualizations/components/ObjectDetail/types";
import registerVisualizations from "metabase/visualizations/register";
-import type { Field } from "metabase-types/api";
-import { createMockCard, createMockDataset } from "metabase-types/api/mocks";
-import {
- PRODUCTS_ID,
- SAMPLE_DB_ID,
- createOrdersTable,
- createProductsTable,
- createReviewsTable,
-} from "metabase-types/api/mocks/presets";
-
-import { ObjectDetail } from "./ObjectDetail";
+import { createMockCard } from "metabase-types/api/mocks";
+import { createProductsTable } from "metabase-types/api/mocks/presets";
registerVisualizations();
-const PRODUCTS_TABLE = createProductsTable();
-const ORDERS_TABLE = createOrdersTable();
-const HIDDEN_ORDERS_TABLE = createOrdersTable({
- visibility_type: "hidden",
-});
-const REVIEWS_TABLE = createReviewsTable();
-
-const FK_RECORDS_COUNT = 93;
+const DATABASE_ID = 1;
-interface SetupOpts {
- hideOrdersTable?: boolean;
-}
+const MOCK_TABLE = createProductsTable();
-function setup({ hideOrdersTable = false }: SetupOpts = {}) {
- setupDatabasesEndpoints([]);
- setupActionsEndpoints([]);
- const productsId = checkNotNull(findField(PRODUCTS_TABLE.fields, "ID"));
- const ordersProductId = {
- ...checkNotNull(findField(ORDERS_TABLE.fields, "PRODUCT_ID")),
- table: ORDERS_TABLE,
- };
- const reviewsProductId = {
- ...checkNotNull(findField(REVIEWS_TABLE.fields, "PRODUCT_ID")),
- table: REVIEWS_TABLE,
- };
- setupTableEndpoints(PRODUCTS_TABLE, [
- {
- origin: ordersProductId,
- origin_id: ordersProductId.id as number,
- destination: productsId,
- destination_id: productsId.id as number,
- relationship: "Mt1",
+const MOCK_CARD = createMockCard({
+ dataset_query: {
+ type: "query",
+ database: DATABASE_ID,
+ query: {
+ "source-table": MOCK_TABLE.id,
},
- {
- origin: reviewsProductId,
- origin_id: reviewsProductId.id as number,
- destination: productsId,
- destination_id: productsId.id as number,
- relationship: "Mt1",
- },
- ]);
- setupForeignKeyCountQueryEndpoints();
+ },
+});
+
+async function setup(options?: Partial<ObjectDetailProps>) {
+ setupTableEndpoints(MOCK_TABLE);
- const ROW_ID_INDEX = 0;
const state = createMockState({
entities: createMockEntitiesState({
- tables: [
- PRODUCTS_TABLE,
- hideOrdersTable ? HIDDEN_ORDERS_TABLE : ORDERS_TABLE,
- REVIEWS_TABLE,
- ],
- }),
- qb: createMockQueryBuilderState({
- card: createMockCard({
- dataset_query: {
- database: SAMPLE_DB_ID,
- type: "query",
- query: {
- "source-table": PRODUCTS_ID,
- },
- },
- }),
- zoomedRowObjectId: testDataset.rows[0][ROW_ID_INDEX] as string,
- queryResults: [
- createMockDataset({
- data: testDataset,
- }),
- ],
+ questions: [MOCK_CARD],
+ tables: [MOCK_TABLE],
}),
+ qb: createMockQueryBuilderState({ card: MOCK_CARD }),
});
+ const metadata = getMetadata(state);
+
+ const question = checkNotNull(metadata.question(MOCK_CARD.id));
+ const table = checkNotNull(metadata.table(MOCK_TABLE.id));
+
renderWithProviders(
<ObjectDetail
data={testDataset}
- settings={{}}
- isObjectDetail
- onVisualizationClick={jest.fn()}
- visualizationIsClickable={jest.fn()}
+ question={question}
+ table={table}
+ zoomedRow={testDataset.rows[0]}
+ zoomedRowID={0}
+ tableForeignKeys={table.fks}
+ settings={{
+ column: () => null,
+ }}
+ showHeader
+ canZoom={true}
+ canZoomPreviousRow={false}
+ canZoomNextRow={false}
+ onVisualizationClick={() => null}
+ visualizationIsClickable={() => false}
isDashboard={false}
+ {...options}
/>,
- {
- storeInitialState: state,
- },
+ { storeInitialState: state },
);
-}
-
-function setupForeignKeyCountQueryEndpoints() {
- fetchMock.post({
- name: "ordersCountQuery",
- url: "path:/api/dataset",
- response: createMockDataset({
- status: "completed",
- data: {
- rows: [[FK_RECORDS_COUNT]],
- },
- }),
- });
-}
-function findField(fields: Field[] | undefined, name: string) {
- return fields?.find((field) => field.name === name);
+ await waitForLoaderToBeRemoved();
}
describe("ObjectDetail", () => {
- it("should render foreign key count when no table is hidden", async () => {
- setup();
+ it("renders an object detail with a paginator", async () => {
+ await setup();
+
+ expect(screen.getByText(/Item 1 of 10/i)).toBeInTheDocument();
+ });
- await waitFor(() => {
- expect(screen.getAllByTestId("loading-indicator")).toHaveLength(2);
+ it("shows object detail header", async () => {
+ await setup({
+ settings: {
+ "detail.showHeader": true,
+ },
+ showHeader: false,
});
- await waitForLoaderToBeRemoved();
- expect(
- await screen.findByText(
- getBrokenUpTextMatcher([FK_RECORDS_COUNT, "Reviews"].join("")),
- ),
- ).toBeInTheDocument();
- expect(
- await screen.findByText(
- getBrokenUpTextMatcher([FK_RECORDS_COUNT, "Orders"].join("")),
- ),
- ).toBeInTheDocument();
+ expect(screen.getByText(/Product/i)).toBeInTheDocument();
});
- it("should render related objects count only for foreign keys referencing non-hidden tables (metabase#32654)", async () => {
- setup({ hideOrdersTable: true });
-
- await waitFor(() => {
- expect(screen.getAllByTestId("loading-indicator")).toHaveLength(2);
+ it("hides object detail header", async () => {
+ await setup({
+ settings: {
+ "detail.showHeader": false,
+ },
+ showHeader: false,
});
- await waitForLoaderToBeRemoved();
- expect(
- await screen.findByText(
- getBrokenUpTextMatcher([FK_RECORDS_COUNT, "Reviews"].join("")),
- ),
- ).toBeInTheDocument();
- expect(
- screen.queryByText([FK_RECORDS_COUNT, "Orders"].join("")),
- ).not.toBeInTheDocument();
+ expect(screen.queryByText(/Product/i)).not.toBeInTheDocument();
});
});
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailHeader.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailHeader.tsx
index 1d2584a736a..754b4197d62 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailHeader.tsx
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailHeader.tsx
@@ -22,9 +22,9 @@ export interface ObjectDetailHeaderProps {
canZoomPreviousRow: boolean;
canZoomNextRow?: boolean;
showControls?: boolean;
- viewPreviousObjectDetail: () => void;
- viewNextObjectDetail: () => void;
- closeObjectDetail: () => void;
+ viewPreviousObjectDetail?: () => void;
+ viewNextObjectDetail?: () => void;
+ closeObjectDetail?: () => void;
}
export function ObjectDetailHeader({
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailView.styled.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailPanel.styled.tsx
similarity index 90%
rename from frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailView.styled.tsx
rename to frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailPanel.styled.tsx
index ab90777b965..5790553354b 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailView.styled.tsx
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailPanel.styled.tsx
@@ -10,7 +10,7 @@ export const ObjectDetailContainer = styled.div<ObjectDetailContainerProps>`
height: 100%;
`;
-export const ObjectDetailWrapperDiv = styled.div`
+export const ObjectDetailLayout = styled.div`
height: 100%;
display: flex;
flex-direction: column;
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailView.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailPanel.tsx
similarity index 92%
rename from frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailView.tsx
rename to frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailPanel.tsx
index e691a534b6f..849e680fe6e 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailView.tsx
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailPanel.tsx
@@ -9,7 +9,6 @@ import { NotFound } from "metabase/common/components/ErrorPages";
import { LoadingSpinner } from "metabase/common/components/LoadingSpinner";
import { useDatabaseListQuery } from "metabase/common/hooks";
import { entityCompatibleQuery } from "metabase/entities/utils";
-import { runQuestionQuery } from "metabase/query_builder/actions";
import { useDispatch } from "metabase/redux";
import { ActionsApi } from "metabase/services";
import { Modal } from "metabase/ui";
@@ -29,8 +28,8 @@ import { ObjectDetailHeader } from "./ObjectDetailHeader";
import {
ErrorWrapper,
ObjectDetailContainer,
- ObjectDetailWrapperDiv,
-} from "./ObjectDetailView.styled";
+ ObjectDetailLayout,
+} from "./ObjectDetailPanel.styled";
import type { ObjectDetailProps, ObjectId } from "./types";
import {
getActionItems,
@@ -67,7 +66,7 @@ function filterByPk(
return Lib.filter(query, stageIndex, filterClause);
}
-export function ObjectDetailView({
+export function ObjectDetailPanel({
data: passedData,
question,
table,
@@ -88,6 +87,7 @@ export function ObjectDetailView({
viewPreviousObjectDetail,
viewNextObjectDetail,
closeObjectDetail,
+ onActionSuccess,
className,
isDashboard,
}: ObjectDetailProps): JSX.Element | null {
@@ -109,7 +109,7 @@ export function ObjectDetailView({
const hasFks = !_.isEmpty(tableForeignKeys);
const hasRelationships = showRelations && hasFks && hasPk;
- const isObjectDetailModal = question?.display() !== "object";
+ const isDrillThroughDetail = question?.display() !== "object";
const handleExecuteModalClose = () => {
setActionId(undefined);
@@ -141,7 +141,7 @@ export function ObjectDetailView({
const loadFKReferences = useCallback(() => {
if (zoomedRowID) {
- loadObjectDetailFKReferences({ objectId: zoomedRowID });
+ loadObjectDetailFKReferences?.({ objectId: zoomedRowID });
}
}, [zoomedRowID, loadObjectDetailFKReferences]);
@@ -154,12 +154,12 @@ export function ObjectDetailView({
}
if (
- isObjectDetailModal &&
+ isDrillThroughDetail &&
table &&
_.isEmpty(table.fks) &&
!isVirtualCardId(table.id)
) {
- fetchTableFks(table.id as ConcreteTableId);
+ fetchTableFks?.(table.id as ConcreteTableId);
}
});
@@ -169,15 +169,16 @@ export function ObjectDetailView({
}
const onKeyDown = (event: KeyboardEvent) => {
- const capturedKeys: Record<string, () => void> = {
+ const capturedKeys: Record<string, (() => void) | undefined> = {
ArrowUp: viewPreviousObjectDetail,
ArrowDown: viewNextObjectDetail,
Escape: closeObjectDetail,
};
- if (capturedKeys[event.key] && !isModalOpen) {
+ const handler = capturedKeys[event.key];
+ if (handler && !isModalOpen) {
event.preventDefault();
- capturedKeys[event.key]();
+ handler();
}
};
@@ -295,14 +296,10 @@ export function ObjectDetailView({
[zoomedRowID],
);
- const handleActionSuccess = useCallback(() => {
- dispatch(runQuestionQuery());
- }, [dispatch]);
-
const handleDeleteSuccess = useCallback(() => {
- handleActionSuccess();
- closeObjectDetail();
- }, [closeObjectDetail, handleActionSuccess]);
+ onActionSuccess?.();
+ closeObjectDetail?.();
+ }, [closeObjectDetail, onActionSuccess]);
if (!data) {
return null;
@@ -334,7 +331,7 @@ export function ObjectDetailView({
<NotFound message={t`We couldn't find that record`} />
</ErrorWrapper>
) : (
- <ObjectDetailWrapperDiv
+ <ObjectDetailLayout
className="ObjectDetail"
data-testid="object-detail"
>
@@ -362,7 +359,7 @@ export function ObjectDetailView({
visualizationIsClickable={visualizationIsClickable}
isDashboard={isDashboard}
/>
- </ObjectDetailWrapperDiv>
+ </ObjectDetailLayout>
)}
</ObjectDetailContainer>
@@ -373,7 +370,7 @@ export function ObjectDetailView({
fetchInitialValues={fetchInitialValues}
shouldPrefetch
onClose={handleExecuteModalClose}
- onSuccess={handleActionSuccess}
+ onSuccess={onActionSuccess}
/>
<Modal opened={isDeleteModalOpen} onClose={handleDeleteModalClose}>
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailView.unit.spec.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailPanel.unit.spec.tsx
similarity index 99%
rename from frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailView.unit.spec.tsx
rename to frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailPanel.unit.spec.tsx
index 524c77b5b0c..c5c034a2031 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailView.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailPanel.unit.spec.tsx
@@ -26,7 +26,7 @@ import {
createSampleDatabase,
} from "metabase-types/api/mocks/presets";
-import { ObjectDetailView } from "./ObjectDetailView";
+import { ObjectDetailPanel } from "./ObjectDetailPanel";
import type { ObjectDetailProps } from "./types";
const mockCard = createMockCard({
@@ -245,7 +245,7 @@ function setup(
const fetchTableFks = jest.fn();
renderWithProviders(
- <ObjectDetailView
+ <ObjectDetailPanel
data={testDataset}
zoomedRow={testDataset.rows[0]}
zoomedRowID={0}
@@ -276,7 +276,7 @@ function setup(
};
}
-describe("ObjectDetailView", () => {
+describe("ObjectDetailPanel", () => {
it("renders an object detail component", () => {
setup({ question: mockQuestion });
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailWrapper.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailWrapper.tsx
deleted file mode 100644
index f2654f8aaa2..00000000000
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailWrapper.tsx
+++ /dev/null
@@ -1,131 +0,0 @@
-import { useEffect, useMemo, useState } from "react";
-
-import { skipToken, useListTableForeignKeysQuery } from "metabase/api";
-import { DetailViewSidesheet } from "metabase/detail-view/components";
-import { filterByPk } from "metabase/detail-view/utils";
-import Question from "metabase-lib/v1/Question";
-import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
-
-import { PaginationFooter } from "../PaginationFooter/PaginationFooter";
-
-import { ObjectDetailView } from "./ObjectDetailView";
-import S from "./ObjectDetailWrapper.module.css";
-import type { ObjectDetailProps } from "./types";
-import { getApiTable, getRowUrl } from "./utils";
-
-export function ObjectDetailWrapper({
- question,
- isDataApp,
- data,
- closeObjectDetail,
- card,
- dashcard,
- isObjectDetail,
- onActionSuccess,
- ...rest
-}: ObjectDetailProps) {
- const [currentObjectIndex, setCurrentObjectIndex] = useState(0);
-
- useEffect(() => {
- if (data.rows.length <= currentObjectIndex) {
- setCurrentObjectIndex(0);
- }
- }, [data.rows, currentObjectIndex]);
-
- // only show modal if this object detail was triggered via an object detail zoom action
- const shouldShowModal = isObjectDetail;
- const getFallbackQuestion = () =>
- card && rest.metadata ? new Question(card, rest.metadata) : undefined;
-
- const { data: tableForeignKeys } = useListTableForeignKeysQuery(
- shouldShowModal && rest.table ? rest.table.id : skipToken,
- );
-
- const areImplicitActionsEnabled = Boolean(
- question &&
- question.canWrite() &&
- question.type() === "model" &&
- question.supportsImplicitActions(),
- );
-
- const {
- canZoom,
- canZoomNextRow,
- canZoomPreviousRow,
- settings,
- table: tableWrapper,
- viewNextObjectDetail,
- viewPreviousObjectDetail,
- zoomedRow,
- zoomedRowID,
- } = rest;
- const table = getApiTable(tableWrapper);
- const columns = data?.cols;
-
- const filteredQuery = useMemo(() => {
- if (columns == null || zoomedRowID == null || question == null) {
- return undefined;
- }
- return filterByPk(question.query(), columns, zoomedRowID);
- }, [columns, zoomedRowID, question]);
-
- if (shouldShowModal) {
- if (columns != null && zoomedRowID != null && question != null) {
- const columnsSettings = columns.map((column) => {
- return settings?.column_settings?.[getColumnKey(column)];
- });
-
- return (
- <DetailViewSidesheet
- columnSettings={settings?.["table.columns"]}
- columns={columns}
- columnsSettings={columnsSettings}
- query={filteredQuery}
- row={zoomedRow}
- rowId={zoomedRowID}
- showImplicitActions={areImplicitActionsEnabled}
- showNav={Boolean(canZoom && (canZoomNextRow || canZoomPreviousRow))}
- table={table}
- tableForeignKeys={tableForeignKeys}
- url={getRowUrl(question, columns, table, zoomedRowID)}
- onActionSuccess={onActionSuccess}
- onClose={closeObjectDetail}
- onNextClick={canZoomNextRow ? viewNextObjectDetail : undefined}
- onPreviousClick={
- canZoomPreviousRow ? viewPreviousObjectDetail : undefined
- }
- />
- );
- }
- }
-
- const hasPagination = data?.rows?.length > 1;
-
- return (
- <>
- <ObjectDetailView
- {...rest}
- zoomedRow={data.rows[currentObjectIndex]}
- data={data}
- question={question ?? getFallbackQuestion()}
- showHeader={rest.settings["detail.showHeader"]}
- showControls={false}
- showRelations={false}
- closeObjectDetail={closeObjectDetail}
- isDataApp={isDataApp}
- />
- {hasPagination && (
- <PaginationFooter
- className={S.pagination}
- data-testid="pagination-footer"
- start={currentObjectIndex}
- end={currentObjectIndex}
- total={data.rows.length}
- onNextPage={() => setCurrentObjectIndex((prev) => prev + 1)}
- onPreviousPage={() => setCurrentObjectIndex((prev) => prev - 1)}
- singleItem
- />
- )}
- </>
- );
-}
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailWrapper.unit.spec.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailWrapper.unit.spec.tsx
deleted file mode 100644
index 2cb4bbb00a6..00000000000
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetailWrapper.unit.spec.tsx
+++ /dev/null
@@ -1,132 +0,0 @@
-import userEvent from "@testing-library/user-event";
-
-import { setupTableEndpoints } from "__support__/server-mocks";
-import { createMockEntitiesState } from "__support__/store";
-import { testDataset } from "__support__/testDataset";
-import {
- renderWithProviders,
- screen,
- waitForLoaderToBeRemoved,
-} from "__support__/ui";
-import {
- createMockQueryBuilderState,
- createMockState,
-} from "metabase/redux/store/mocks";
-import { getMetadata } from "metabase/selectors/metadata";
-import { checkNotNull } from "metabase/utils/types";
-import { ObjectDetailWrapper } from "metabase/visualizations/components/ObjectDetail/ObjectDetailWrapper";
-import type { ObjectDetailProps } from "metabase/visualizations/components/ObjectDetail/types";
-import registerVisualizations from "metabase/visualizations/register";
-import { createMockCard } from "metabase-types/api/mocks";
-import { createProductsTable } from "metabase-types/api/mocks/presets";
-
-registerVisualizations();
-
-const DATABASE_ID = 1;
-
-const MOCK_TABLE = createProductsTable();
-
-const MOCK_CARD = createMockCard({
- dataset_query: {
- type: "query",
- database: DATABASE_ID,
- query: {
- "source-table": MOCK_TABLE.id,
- },
- },
-});
-
-async function setup(options?: Partial<ObjectDetailProps>) {
- setupTableEndpoints(MOCK_TABLE);
-
- const state = createMockState({
- entities: createMockEntitiesState({
- questions: [MOCK_CARD],
- tables: [MOCK_TABLE],
- }),
- qb: createMockQueryBuilderState({ card: MOCK_CARD }),
- });
- const metadata = getMetadata(state);
-
- const question = checkNotNull(metadata.question(MOCK_CARD.id));
- const table = checkNotNull(metadata.table(MOCK_TABLE.id));
-
- renderWithProviders(
- <ObjectDetailWrapper
- data={testDataset}
- question={question}
- table={table}
- zoomedRow={testDataset.rows[0]}
- zoomedRowID={0}
- tableForeignKeys={table.fks}
- settings={{
- column: () => null,
- }}
- showHeader
- canZoom={true}
- canZoomPreviousRow={false}
- canZoomNextRow={false}
- followForeignKey={() => null}
- onVisualizationClick={() => null}
- visualizationIsClickable={() => false}
- fetchTableFks={() => null}
- loadObjectDetailFKReferences={() => null}
- viewPreviousObjectDetail={() => null}
- viewNextObjectDetail={() => null}
- closeObjectDetail={() => null}
- isDashboard={false}
- {...options}
- />,
- { storeInitialState: state },
- );
-
- await waitForLoaderToBeRemoved();
-}
-
-describe("Object Detail Wrapper", () => {
- it("renders an object detail with a paginator", async () => {
- await setup();
-
- expect(screen.getByText(/Item 1 of 10/i)).toBeInTheDocument();
- });
-
- it("shows object detail header", async () => {
- await setup({
- settings: {
- "detail.showHeader": true,
- },
- showHeader: false,
- });
-
- expect(screen.getByText(/Product/i)).toBeInTheDocument();
- });
-
- it("hides object detail header", async () => {
- await setup({
- settings: {
- "detail.showHeader": false,
- },
- showHeader: false,
- });
-
- expect(screen.queryByText(/Product/i)).not.toBeInTheDocument();
- });
-
- it("traps focus in the object detail modal when opened", async () => {
- await setup({
- isObjectDetail: true,
- });
-
- await screen.findByTestId("object-detail");
-
- // first tab should focus on the close button, since there's only
- // one element to show here.
- await userEvent.tab();
- expect(screen.getByLabelText("Close")).toHaveFocus();
-
- // second tab should *keep* focus inside the modal, not go
- // to the body
- await userEvent.tab();
- expect(screen.getByLabelText("Copy link to this record")).toHaveFocus();
- });
-});
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/types.ts b/frontend/src/metabase/visualizations/components/ObjectDetail/types.ts
index a8dfb96f9e9..bfc90ada638 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/types.ts
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/types.ts
@@ -47,12 +47,14 @@ export interface ObjectDetailProps {
showHeader?: boolean;
onVisualizationClick: OnVisualizationClickType;
visualizationIsClickable: (clicked: any) => boolean;
- fetchTableFks: (id: number) => void;
- loadObjectDetailFKReferences: (opts: { objectId: ObjectId }) => void;
- followForeignKey: (opts: { objectId: ObjectId; fk: ForeignKey }) => void;
- viewPreviousObjectDetail: () => void;
- viewNextObjectDetail: () => void;
- closeObjectDetail: () => void;
+ // Host-injected (query builder modal path). Omitted on dashboards/embedding,
+ // where the registered "object" viz is purely presentational.
+ fetchTableFks?: (id: number) => void;
+ loadObjectDetailFKReferences?: (opts: { objectId: ObjectId }) => void;
+ followForeignKey?: (opts: { objectId: ObjectId; fk: ForeignKey }) => void;
+ viewPreviousObjectDetail?: () => void;
+ viewNextObjectDetail?: () => void;
+ closeObjectDetail?: () => void;
onActionSuccess?: () => void;
className?: string;
isDashboard: boolean;
diff --git a/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx b/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx
index 31f38b18bd5..3d37a5bfb8b 100644
--- a/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx
+++ b/frontend/src/metabase/visualizations/components/TableInteractive/TableInteractive.tsx
@@ -77,7 +77,6 @@ import {
type HeaderCellWithColumnInfoProps,
} from "./cells/HeaderCellWithColumnInfo";
import { MiniBarCell } from "./cells/MiniBarCell";
-import { useObjectDetail } from "./hooks/use-object-detail";
import { useResetWidthsOnColumnsChange } from "./hooks/use-reset-widths-on-columns-change";
import { getInfoPopoversDisabled } from "./utils/get-info-popovers-disabled";
import { tableThemeToDataGridTheme } from "./utils/table-theme-to-data-grid-theme";
@@ -118,7 +117,7 @@ interface TableProps extends VisualizationProps {
getColumnSortDirection: (columnIndex: number) => OrderByDirection | undefined;
renderTableHeader: HeaderCellWithColumnInfoProps["renderTableHeader"];
onUpdateVisualizationSettings: (settings: VisualizationSettings) => void;
- onZoomRow?: (objectId: number | string) => void;
+ onZoomRow?: (rowIndex: number) => void;
tableFooterExtraButtons?: React.ReactNode;
}
@@ -177,6 +176,7 @@ export const TableInteractiveInner = forwardRef(function TableInteractiveInner(
onVisualizationClick,
onUpdateVisualizationSettings,
zoomedRowIndex,
+ onZoomRow,
tableFooterExtraButtons,
}: TableProps,
ref: Ref<HTMLDivElement>,
@@ -216,8 +216,6 @@ export const TableInteractiveInner = forwardRef(function TableInteractiveInner(
return getColumnSizing(cols, columnWidths);
}, [cols, columnWidths]);
- const onOpenObjectDetail = useObjectDetail(data);
-
const getIsCellClickable = useMemoizedCallback(
(clicked: ClickObject) => {
return visualizationIsClickable(clicked);
@@ -302,7 +300,7 @@ export const TableInteractiveInner = forwardRef(function TableInteractiveInner(
) => {
if (columnId === ROW_ID_COLUMN_ID) {
if (!isDashboard) {
- onOpenObjectDetail(rowIndex);
+ onZoomRow?.(rowIndex);
}
return;
}
@@ -334,7 +332,7 @@ export const TableInteractiveInner = forwardRef(function TableInteractiveInner(
columnFormatters,
getIsCellClickable,
getCellClickedObject,
- onOpenObjectDetail,
+ onZoomRow,
onVisualizationClick,
],
);
diff --git a/frontend/src/metabase/visualizations/components/TableInteractive/hooks/use-object-detail.ts b/frontend/src/metabase/visualizations/components/TableInteractive/hooks/use-object-detail.ts
deleted file mode 100644
index 03942202c1a..00000000000
--- a/frontend/src/metabase/visualizations/components/TableInteractive/hooks/use-object-detail.ts
+++ /dev/null
@@ -1,64 +0,0 @@
-import { useCallback, useMemo } from "react";
-
-import { resetRowZoom, zoomInRow } from "metabase/query_builder/actions";
-import {
- getRowIndexToPKMap,
- getZoomedObjectId,
-} from "metabase/query_builder/selectors";
-import { useDispatch, useSelector } from "metabase/redux";
-import type { State } from "metabase/redux/store";
-import type { ObjectId } from "metabase/visualizations/components/ObjectDetail/types";
-import type { ColumnDescriptor } from "metabase/visualizations/lib/graph/columns";
-import { isPK } from "metabase-lib/v1/types/utils/isa";
-import type { DatasetData } from "metabase-types/api";
-
-const getZoomedObjectIdSafe = (state: State) => {
- return state.qb ? getZoomedObjectId(state) : undefined;
-};
-
-export const useObjectDetail = ({ rows, cols }: DatasetData) => {
- const dispatch = useDispatch();
- const zoomedObjectId = useSelector(getZoomedObjectIdSafe);
- const rowIndexToPkMap: Record<number, ObjectId> = useSelector((state) =>
- state.qb != null ? getRowIndexToPKMap(state) : {},
- );
-
- const primaryKeyColumn: ColumnDescriptor | null = useMemo(() => {
- const primaryKeyColumns = cols.filter(isPK);
-
- if (primaryKeyColumns.length !== 1) {
- return null;
- }
- const primaryKeyColumn = primaryKeyColumns[0];
-
- return {
- column: primaryKeyColumn,
- index: cols.indexOf(primaryKeyColumn),
- };
- }, [cols]);
-
- const onOpenObjectDetail = useCallback(
- (rowIndex: number) => {
- let objectId: number | string;
-
- if (primaryKeyColumn) {
- const value = rows[rowIndex][primaryKeyColumn.index];
- objectId =
- typeof value === "number" || typeof value === "string"
- ? value
- : rowIndex;
- } else {
- objectId = rowIndexToPkMap?.[rowIndex] ?? rowIndex;
- }
-
- if (objectId === zoomedObjectId) {
- dispatch(resetRowZoom());
- } else {
- dispatch(zoomInRow({ objectId }));
- }
- },
- [dispatch, primaryKeyColumn, rowIndexToPkMap, rows, zoomedObjectId],
- );
-
- return onOpenObjectDetail;
-};
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
index 935f16c457d..d3300976d7e 100644
--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
@@ -172,6 +172,7 @@ type VisualizationOwnProps = {
timelineEvents?: TimelineEvent[];
tc?: ContentTranslationFunction;
zoomedRowIndex?: number;
+ onZoomRow?: (rowIndex: number) => void;
onOpenChartSettings?: (data: {
initialChartSettings?: { section: string };
showSidebarTitle?: boolean;
@@ -723,6 +724,7 @@ class Visualization extends PureComponent<
onUpdateWarnings,
titleMenuItems,
zoomedRowIndex,
+ onZoomRow,
tableFooterExtraButtons,
} = this.props;
const { width, height } = this.getNormalizedSizes();
@@ -978,6 +980,7 @@ class Visualization extends PureComponent<
visualizationIsClickable={this.visualizationIsClickable}
width={rawWidth}
zoomedRowIndex={zoomedRowIndex}
+ onZoomRow={onZoomRow}
onActionDismissal={this.hideActions}
onChangeCardAndRun={
this.props.onChangeCardAndRun
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index 95b163e6a83..621a8097d66 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -229,6 +229,7 @@ export type VisualizationPassThroughProps = {
isQueryBuilder?: boolean;
queryBuilderMode?: QueryBuilderMode;
zoomedRowIndex?: number;
+ onZoomRow?: (rowIndex: number) => void;
onDeselectTimelineEvents?: () => void;
onOpenTimelines?: () => void;
onSelectTimelineEvents?: (timelineEvents: TimelineEvent[]) => void;