Skip to content

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

Read the reference segment pages from their own requests (#82475)

Romeo Van Snick4b5f24e0a9b9
diff --git a/frontend/src/metabase/reference/segments/SegmentDetail.tsx b/frontend/src/metabase/reference/segments/SegmentDetail.tsx
index b57a115b0cc..577af747629 100644
--- a/frontend/src/metabase/reference/segments/SegmentDetail.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentDetail.tsx
@@ -18,23 +18,12 @@ import UsefulQuestions from "metabase/reference/components/UsefulQuestions";
import * as actions from "metabase/reference/reference";
import { updateSegment } from "metabase/reference/update-actions";
import type * as Lib from "metabase-lib";
-import type { User } from "metabase-types/api";
+import type { Segment, Table, User } from "metabase-types/api";
import S from "../components/Detail.module.css";
import type { ReferenceRouteProps, StateWithReference } from "../selectors";
-import {
- getIsEditing,
- getIsFormulaExpanded,
- getSegment,
- getTable,
- getUser,
-} from "../selectors";
-import type {
- BaseDetailFormFields,
- ReferenceLoadingProps,
- StubbedSegment,
- StubbedTable,
-} from "../types";
+import { getIsEditing, getIsFormulaExpanded, getUser } from "../selectors";
+import type { BaseDetailFormFields, ReferenceLoadingProps } from "../types";
import { getQuestionUrl } from "../utils";
interface SegmentDetailFormFields extends BaseDetailFormFields {
@@ -42,8 +31,8 @@ interface SegmentDetailFormFields extends BaseDetailFormFields {
}
const interestingQuestions = (
- table: StubbedTable,
- segment: StubbedSegment,
+ table: Table,
+ segment: Segment,
metadataProvider: Lib.MetadataProvider,
) => {
return [
@@ -71,17 +60,10 @@ const interestingQuestions = (
const mapStateToProps = (
state: StateWithReference,
- props: ReferenceRouteProps,
+ props: Pick<SegmentDetailProps, "table">,
) => {
- const entity = getSegment(state, props) || {};
-
return {
- entity,
- table: getTable(state, props),
- metadataProvider: selectMetadataProvider(
- state,
- getTable(state, props)?.db_id ?? null,
- ),
+ metadataProvider: selectMetadataProvider(state, props.table?.db_id ?? null),
user: getUser(state),
isEditing: getIsEditing(state),
isFormulaExpanded: getIsFormulaExpanded(state),
@@ -101,8 +83,8 @@ const validate = (values: SegmentDetailFormFields) =>
interface SegmentDetailProps {
style: React.CSSProperties;
- entity: StubbedSegment;
- table: StubbedTable | undefined;
+ segment: Segment | undefined;
+ table: Table | undefined;
user: User;
isEditing?: boolean;
startEditing: () => void;
@@ -120,7 +102,7 @@ interface SegmentDetailProps {
const SegmentDetail = (props: SegmentDetailProps) => {
const {
style,
- entity,
+ segment: entity,
table,
metadataProvider,
loadingError,
@@ -180,11 +162,15 @@ const SegmentDetail = (props: SegmentDetailProps) => {
entity={entity}
type="segment"
headerIcon={modelIconMap.segment}
- headerLink={getQuestionUrl({
- tableId: entity.table_id!,
- segmentId: entity.id,
- metadataProvider: metadataProvider,
- })}
+ headerLink={
+ table && entity
+ ? getQuestionUrl({
+ tableId: table.id,
+ segmentId: entity.id,
+ metadataProvider,
+ })
+ : undefined
+ }
name={t`Details`}
user={user}
isEditing={isEditing}
@@ -244,7 +230,7 @@ const SegmentDetail = (props: SegmentDetailProps) => {
<li className={CS.relative}>
<Detail
name={t`Description`}
- description={entity.description}
+ description={entity?.description}
placeholder={t`No description yet`}
isEditing={isEditing}
field={getFormField("description")}
@@ -253,7 +239,7 @@ const SegmentDetail = (props: SegmentDetailProps) => {
<li className={CS.relative}>
<Detail
name={t`Why this Segment is interesting`}
- description={entity.points_of_interest}
+ description={entity?.points_of_interest}
placeholder={t`Nothing interesting yet`}
isEditing={isEditing}
field={getFormField("points_of_interest")}
@@ -262,13 +248,13 @@ const SegmentDetail = (props: SegmentDetailProps) => {
<li className={CS.relative}>
<Detail
name={t`Things to be aware of about this Segment`}
- description={entity.caveats}
+ description={entity?.caveats}
placeholder={t`Nothing to be aware of yet`}
isEditing={isEditing}
field={getFormField("caveats")}
/>
</li>
- {!isEditing && table && (
+ {!isEditing && table && entity && (
<li className={CS.relative}>
<UsefulQuestions
questions={interestingQuestions(
@@ -281,7 +267,7 @@ const SegmentDetail = (props: SegmentDetailProps) => {
)}
{table &&
!isEditing &&
- entity.definition &&
+ entity?.definition &&
entity.table_id != null && (
<li className={cx(CS.relative, CS.mb4)}>
<Formula
@@ -313,6 +299,8 @@ export default connect(
// props, because the `actions` spread in `mapDispatchToProps` is untyped.
// The cast restores the props a caller actually passes.
SegmentDetail as unknown as React.ComponentType<
- ReferenceRouteProps & ReferenceLoadingProps
+ ReferenceRouteProps &
+ ReferenceLoadingProps &
+ Pick<SegmentDetailProps, "segment" | "table">
>,
);
diff --git a/frontend/src/metabase/reference/segments/SegmentDetailContainer.tsx b/frontend/src/metabase/reference/segments/SegmentDetailContainer.tsx
index fe17cc8ff1a..79d6eee94eb 100644
--- a/frontend/src/metabase/reference/segments/SegmentDetailContainer.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentDetailContainer.tsx
@@ -15,12 +15,12 @@ import type { ClearStateProps } from "../reference";
import {
type ReferenceRouteParams,
getIsEditing,
- getSegment,
getSegmentId,
getUser,
} from "../selectors";
import SegmentSidebar from "./SegmentSidebar";
+import { useSegmentPage } from "./use-segment-page";
const mapDispatchToProps = {
...actions,
@@ -35,9 +35,9 @@ function SegmentDetailContainer(props: SegmentDetailContainerProps) {
const params = useParams<ReferenceRouteParams>();
const user = useSelector(getUser);
- const segment = useSelector((state) => getSegment(state, { params }));
const segmentId = useSelector((state) => getSegmentId(state, { params }));
const isEditing = useSelector(getIsEditing);
+ const { segment, table } = useSegmentPage(segmentId);
const { loading, loadingError } = useReferenceFetch(() =>
fetchSegmentDetailData(dispatch, segmentId),
@@ -55,10 +55,18 @@ function SegmentDetailContainer(props: SegmentDetailContainerProps) {
<SidebarLayout
className={cx(CS.flexFull, CS.relative)}
style={isEditing ? { paddingTop: "43px" } : {}}
- sidebar={<SegmentSidebar segment={segment} user={user} />}
+ sidebar={
+ <SegmentSidebar
+ segmentId={segmentId}
+ segmentName={segment?.name}
+ user={user}
+ />
+ }
>
<SegmentDetail
params={params}
+ segment={segment}
+ table={table}
loading={loading}
loadingError={loadingError}
/>
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldDetail.tsx b/frontend/src/metabase/reference/segments/SegmentFieldDetail.tsx
index bb627d1876d..217d014b3c9 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldDetail.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldDetail.tsx
@@ -5,10 +5,7 @@ import { t } from "ttag";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import CS from "metabase/css/core/index.css";
-import {
- getShallowFields,
- selectMetadataProvider,
-} from "metabase/metadata-store";
+import { selectMetadataProvider } from "metabase/metadata-store";
import { connect } from "metabase/redux";
import S from "metabase/reference/Reference.module.css";
import Detail from "metabase/reference/components/Detail";
@@ -20,23 +17,14 @@ import UsefulQuestions from "metabase/reference/components/UsefulQuestions";
import * as actions from "metabase/reference/reference";
import { updateField } from "metabase/reference/update-actions";
import type * as Lib from "metabase-lib";
-import type { NormalizedField, User } from "metabase-types/api";
+import type { Field, Table, User } from "metabase-types/api";
import type { ReferenceRouteProps, StateWithReference } from "../selectors";
-import {
- getFieldBySegment,
- getFieldId,
- getIsEditing,
- getIsFormulaExpanded,
- getTable,
- getUser,
-} from "../selectors";
+import { getIsEditing, getIsFormulaExpanded, getUser } from "../selectors";
import type {
BaseDetailFormFields,
FieldFormFieldsValues,
ReferenceLoadingProps,
- StubbedField,
- StubbedTable,
} from "../types";
import { getQuestionUrl } from "../utils";
@@ -46,10 +34,9 @@ interface SegmentFieldDetailFormFields
}
const interestingQuestions = (
- table: StubbedTable,
- field: StubbedField,
+ table: Table,
+ field: Field,
metadataProvider: Lib.MetadataProvider,
- breakoutField: NormalizedField | undefined,
) => {
return [
{
@@ -59,7 +46,7 @@ const interestingQuestions = (
icon: "number" as const,
link: getQuestionUrl({
tableId: table.id,
- breakoutField,
+ breakoutField: field,
getCount: true,
metadataProvider: metadataProvider,
}),
@@ -69,7 +56,7 @@ const interestingQuestions = (
icon: "table2" as const,
link: getQuestionUrl({
tableId: table.id,
- breakoutField,
+ breakoutField: field,
metadataProvider: metadataProvider,
}),
},
@@ -78,23 +65,13 @@ const interestingQuestions = (
const mapStateToProps = (
state: StateWithReference,
- props: ReferenceRouteProps,
+ props: Pick<SegmentFieldDetailProps, "table">,
) => {
- const entity = getFieldBySegment(state, props) || {};
-
return {
- entity,
- table: getTable(state, props),
user: getUser(state),
isEditing: getIsEditing(state),
isFormulaExpanded: getIsFormulaExpanded(state),
- metadataProvider: selectMetadataProvider(
- state,
- getTable(state, props)?.db_id ?? null,
- ),
- // `getFieldBySegment` falls back to a stub with only an id, which cannot
- // describe a column, so the breakout takes the loaded field or nothing
- breakoutField: getShallowFields(state)?.[getFieldId(state, props)],
+ metadataProvider: selectMetadataProvider(state, props.table?.db_id ?? null),
};
};
@@ -106,8 +83,8 @@ const mapDispatchToProps = {
interface SegmentFieldDetailProps {
style: React.CSSProperties;
- entity: StubbedField;
- table: StubbedTable;
+ field: Field | undefined;
+ table: Table | undefined;
user: User;
isEditing?: boolean;
startEditing: () => void;
@@ -115,7 +92,6 @@ interface SegmentFieldDetailProps {
loading?: boolean;
loadingError?: unknown;
metadataProvider: Lib.MetadataProvider;
- breakoutField: NormalizedField | undefined;
onSubmit: (fields: SegmentFieldDetailFormFields, props: any) => Promise<void>;
}
@@ -123,10 +99,9 @@ interface SegmentFieldDetailProps {
const SegmentFieldDetail = (props: SegmentFieldDetailProps) => {
const {
style,
- entity,
+ field: entity,
table,
metadataProvider,
- breakoutField,
loadingError,
loading,
user,
@@ -191,83 +166,84 @@ const SegmentFieldDetail = (props: SegmentFieldDetailProps) => {
loading={!loadingError && !saveError && (loading || isSubmitting)}
error={saveError ?? loadingError}
>
- {() => (
- <div className={CS.wrapper}>
- <div
- className={cx(CS.pl3, CS.py2, CS.mb4, CS.bgWhite, CS.bordered)}
- >
- <List>
- <li className={CS.relative}>
- <Detail
- name={t`Description`}
- description={entity.description}
- placeholder={t`No description yet`}
- isEditing={isEditing}
- field={getFormField("description")}
- />
- </li>
- {!isEditing && (
+ {() =>
+ entity == null || table == null ? null : (
+ <div className={CS.wrapper}>
+ <div
+ className={cx(CS.pl3, CS.py2, CS.mb4, CS.bgWhite, CS.bordered)}
+ >
+ <List>
<li className={CS.relative}>
<Detail
- name={t`Actual name in database`}
- description={entity.name}
- subtitleClass={S.tableActualName}
+ name={t`Description`}
+ description={entity.description}
+ placeholder={t`No description yet`}
+ isEditing={isEditing}
+ field={getFormField("description")}
/>
</li>
- )}
- <li className={CS.relative}>
- <Detail
- name={t`Why this field is interesting`}
- description={entity.points_of_interest}
- placeholder={t`Nothing interesting yet`}
- isEditing={isEditing}
- field={getFormField("points_of_interest")}
- />
- </li>
- <li className={CS.relative}>
- <Detail
- name={t`Things to be aware of about this field`}
- description={entity.caveats}
- placeholder={t`Nothing to be aware of yet`}
- isEditing={isEditing}
- field={getFormField("caveats")}
- />
- </li>
-
- {!isEditing && (
+ {!isEditing && (
+ <li className={CS.relative}>
+ <Detail
+ name={t`Actual name in database`}
+ description={entity.name}
+ subtitleClass={S.tableActualName}
+ />
+ </li>
+ )}
<li className={CS.relative}>
<Detail
- name={t`Data type`}
- description={entity.database_type}
+ name={t`Why this field is interesting`}
+ description={entity.points_of_interest}
+ placeholder={t`Nothing interesting yet`}
+ isEditing={isEditing}
+ field={getFormField("points_of_interest")}
/>
</li>
- )}
- <li className={CS.relative}>
- <FieldTypeDetail
- databaseId={table.db_id!}
- field={entity}
- fieldTypeFormField={getFormField("semantic_type")}
- foreignKeyFormField={getFormField("fk_target_field_id")}
- fieldSettingsFormField={getFormField("settings")}
- isEditing={Boolean(isEditing)}
- />
- </li>
- {!isEditing && (
<li className={CS.relative}>
- <UsefulQuestions
- questions={interestingQuestions(
- table,
- entity,
- metadataProvider,
- breakoutField,
- )}
+ <Detail
+ name={t`Things to be aware of about this field`}
+ description={entity.caveats}
+ placeholder={t`Nothing to be aware of yet`}
+ isEditing={isEditing}
+ field={getFormField("caveats")}
+ />
+ </li>
+
+ {!isEditing && (
+ <li className={CS.relative}>
+ <Detail
+ name={t`Data type`}
+ description={entity.database_type}
+ />
+ </li>
+ )}
+ <li className={CS.relative}>
+ <FieldTypeDetail
+ databaseId={table.db_id}
+ field={entity}
+ fieldTypeFormField={getFormField("semantic_type")}
+ foreignKeyFormField={getFormField("fk_target_field_id")}
+ fieldSettingsFormField={getFormField("settings")}
+ isEditing={Boolean(isEditing)}
/>
</li>
- )}
- </List>
+ {!isEditing && (
+ <li className={CS.relative}>
+ <UsefulQuestions
+ questions={interestingQuestions(
+ table,
+ entity,
+ metadataProvider,
+ )}
+ />
+ </li>
+ )}
+ </List>
+ </div>
</div>
- </div>
- )}
+ )
+ }
</LoadingAndErrorWrapper>
</form>
);
@@ -283,6 +259,8 @@ export default connect(
// props, because the `actions` spread in `mapDispatchToProps` is untyped.
// The cast restores the props a caller actually passes.
SegmentFieldDetail as unknown as React.ComponentType<
- ReferenceRouteProps & ReferenceLoadingProps
+ ReferenceRouteProps &
+ ReferenceLoadingProps &
+ Pick<SegmentFieldDetailProps, "field" | "table">
>,
);
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldDetailContainer.tsx b/frontend/src/metabase/reference/segments/SegmentFieldDetailContainer.tsx
index 4804547af5f..75c1b68cba9 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldDetailContainer.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldDetailContainer.tsx
@@ -14,13 +14,13 @@ import { useLocation, useParams } from "metabase/router";
import type { ClearStateProps } from "../reference";
import {
type ReferenceRouteParams,
- getField,
+ getFieldId,
getIsEditing,
- getSegment,
getSegmentId,
} from "../selectors";
import SegmentFieldSidebar from "./SegmentFieldSidebar";
+import { useSegmentPage } from "./use-segment-page";
const mapDispatchToProps = {
...actions,
@@ -34,10 +34,11 @@ function SegmentFieldDetailContainer(props: SegmentFieldDetailContainerProps) {
const dispatch = useDispatch();
const params = useParams<ReferenceRouteParams>();
- const segment = useSelector((state) => getSegment(state, { params }));
const segmentId = useSelector((state) => getSegmentId(state, { params }));
- const field = useSelector((state) => getField(state, { params }));
+ const fieldId = useSelector((state) => getFieldId(state, { params }));
const isEditing = useSelector(getIsEditing);
+ const { segment, table } = useSegmentPage(segmentId);
+ const field = table?.fields?.find(({ id }) => id === fieldId);
const { loading, loadingError } = useReferenceFetch(() =>
fetchSegmentFieldsData(dispatch, segmentId),
@@ -55,10 +56,19 @@ function SegmentFieldDetailContainer(props: SegmentFieldDetailContainerProps) {
<SidebarLayout
className={cx(CS.flexFull, CS.relative)}
style={isEditing ? { paddingTop: "43px" } : {}}
- sidebar={<SegmentFieldSidebar segment={segment} field={field} />}
+ sidebar={
+ <SegmentFieldSidebar
+ segmentId={segmentId}
+ segmentName={segment?.name}
+ fieldId={fieldId}
+ fieldName={field?.name}
+ />
+ }
>
<SegmentFieldDetail
params={params}
+ field={field}
+ table={table}
loading={loading}
loadingError={loadingError}
/>
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldList.tsx b/frontend/src/metabase/reference/segments/SegmentFieldList.tsx
index 26192ba6aca..afb815072e2 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldList.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldList.tsx
@@ -1,6 +1,6 @@
import cx from "classnames";
import { useFormik } from "formik";
-import { useState } from "react";
+import { useMemo, useState } from "react";
import { t } from "ttag";
import { EmptyState } from "metabase/common/components/EmptyState";
@@ -19,24 +19,17 @@ import * as actions from "metabase/reference/reference";
import { updateField } from "metabase/reference/update-actions";
import { getIconForField } from "metabase-lib/v1/metadata/utils/fields";
import type {
+ Field as ApiField,
FieldId,
IconName,
- NormalizedField,
+ Segment,
+ Table,
User,
} from "metabase-types/api";
-import type { ReferenceRouteProps, StateWithReference } from "../selectors";
-import {
- getFieldsBySegment,
- getIsEditing,
- getSegment,
- getUser,
-} from "../selectors";
-import type {
- FieldFormFieldsValues,
- StubbedSegment,
- StubbedTable,
-} from "../types";
+import type { StateWithReference } from "../selectors";
+import { getIsEditing, getUser } from "../selectors";
+import type { FieldFormFieldsValues } from "../types";
type SegmentFieldListFormFields = Record<string, FieldFormFieldsValues>;
@@ -47,18 +40,10 @@ const emptyStateData = {
icon: "fields" as const,
};
-const mapStateToProps = (
- state: StateWithReference,
- props: ReferenceRouteProps,
-) => {
- const data = getFieldsBySegment(state, props);
- return {
- segment: getSegment(state, props),
- entities: data,
- user: getUser(state),
- isEditing: getIsEditing(state),
- };
-};
+const mapStateToProps = (state: StateWithReference) => ({
+ user: getUser(state),
+ isEditing: getIsEditing(state),
+});
const mapDispatchToProps = {
updateField,
@@ -67,19 +52,18 @@ const mapDispatchToProps = {
};
interface SegmentFieldListProps {
- segment: StubbedSegment;
+ segment: Segment | undefined;
style: React.CSSProperties;
- entities: Record<string, NormalizedField>;
isEditing?: boolean;
startEditing: () => void;
endEditing: () => void;
user: User | null;
- table: StubbedTable;
+ table: Table | undefined;
loading?: boolean;
loadingError?: unknown;
// The action handler in reference.ts types its own props parameter.
onSubmit?: (
- entities: Record<string, NormalizedField>,
+ entities: Record<string, ApiField>,
fields: SegmentFieldListFormFields,
props: any,
) => void;
@@ -89,7 +73,6 @@ const SegmentFieldList = (props: SegmentFieldListProps) => {
const {
segment,
style,
- entities,
loadingError,
loading,
user,
@@ -102,6 +85,15 @@ const SegmentFieldList = (props: SegmentFieldListProps) => {
const [saveError, setSaveError] = useState<unknown>(null);
+ // `rUpdateFields` looks each edited field up by id.
+ const entities = useMemo(
+ () =>
+ Object.fromEntries(
+ (table?.fields ?? []).map((field) => [String(field.id), field]),
+ ),
+ [table],
+ );
+
const {
isSubmitting,
getFieldProps,
@@ -150,7 +142,7 @@ const SegmentFieldList = (props: SegmentFieldListProps) => {
<EditableReferenceHeader
type="segment"
headerIcon={modelIconMap.segment}
- name={t`Fields in ${segment.name}`}
+ name={t`Fields in ${segment?.name}`}
user={user}
isEditing={isEditing}
startEditing={startEditing}
@@ -160,7 +152,7 @@ const SegmentFieldList = (props: SegmentFieldListProps) => {
error={saveError ?? loadingError}
>
{() =>
- Object.keys(entities).length > 0 ? (
+ table != null && Object.keys(entities).length > 0 ? (
<div className={CS.wrapper}>
<div
className={cx(
@@ -193,9 +185,9 @@ const SegmentFieldList = (props: SegmentFieldListProps) => {
entity.name && (
<li className={CS.relative} key={String(entity.id)}>
<Field
- databaseId={table.db_id!}
+ databaseId={table.db_id}
field={entity}
- url={`/reference/segments/${segment.id}/fields/${entity.id}`}
+ url={`/reference/segments/${segment?.id}/fields/${entity.id}`}
// Unjustified type cast. FIXME
icon={getIconForField(entity) as IconName}
isEditing={isEditing}
@@ -219,11 +211,10 @@ const SegmentFieldList = (props: SegmentFieldListProps) => {
);
};
-// What the container has to supply: `params` feeds `mapStateToProps`, and
-// `table` is read here but selected by the container. Naming it keeps that
-// contract type-checked.
-type SegmentFieldListOwnProps = ReferenceRouteProps &
- Pick<SegmentFieldListProps, "table" | "loading" | "loadingError">;
+type SegmentFieldListOwnProps = Pick<
+ SegmentFieldListProps,
+ "segment" | "table" | "loading" | "loadingError"
+>;
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default connect(
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldListContainer.tsx b/frontend/src/metabase/reference/segments/SegmentFieldListContainer.tsx
index 24a9762cf77..1e104fd807e 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldListContainer.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldListContainer.tsx
@@ -15,13 +15,12 @@ import type { ClearStateProps } from "../reference";
import {
type ReferenceRouteParams,
getIsEditing,
- getSegment,
getSegmentId,
- getTable,
getUser,
} from "../selectors";
import SegmentSidebar from "./SegmentSidebar";
+import { useSegmentPage } from "./use-segment-page";
const mapDispatchToProps = {
...actions,
@@ -36,11 +35,9 @@ function SegmentFieldListContainer(props: SegmentFieldListContainerProps) {
const params = useParams<ReferenceRouteParams>();
const user = useSelector(getUser);
- const segment = useSelector((state) => getSegment(state, { params }));
const segmentId = useSelector((state) => getSegmentId(state, { params }));
const isEditing = useSelector(getIsEditing);
- // `SegmentFieldList` reads `table.db_id` but doesn't select the table itself.
- const table = useSelector((state) => getTable(state, { params }));
+ const { segment, table } = useSegmentPage(segmentId);
const { loading, loadingError } = useReferenceFetch(() =>
fetchSegmentFieldsData(dispatch, segmentId),
@@ -58,10 +55,16 @@ function SegmentFieldListContainer(props: SegmentFieldListContainerProps) {
<SidebarLayout
className={cx(CS.flexFull, CS.relative)}
style={isEditing ? { paddingTop: "43px" } : {}}
- sidebar={<SegmentSidebar segment={segment} user={user} />}
+ sidebar={
+ <SegmentSidebar
+ segmentId={segmentId}
+ segmentName={segment?.name}
+ user={user}
+ />
+ }
>
<SegmentFieldList
- params={params}
+ segment={segment}
table={table}
loading={loading}
loadingError={loadingError}
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldSidebar.tsx b/frontend/src/metabase/reference/segments/SegmentFieldSidebar.tsx
index 5ca71d5c66f..7400a0c1b09 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldSidebar.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldSidebar.tsx
@@ -5,15 +5,21 @@ import { Breadcrumbs } from "metabase/common/components/Breadcrumbs";
import CS from "metabase/css/core/index.css";
import S from "metabase/reference/components/Sidebar.module.css";
import { SidebarItem } from "metabase/reference/components/SidebarItem";
-
-import type { StubbedField, StubbedSegment } from "../types";
+import type { FieldId, SegmentId } from "metabase-types/api";
interface SegmentFieldSidebarProps {
- segment: StubbedSegment;
- field: StubbedField;
+ segmentId: SegmentId;
+ segmentName?: string;
+ fieldId: FieldId;
+ fieldName?: string;
}
-const SegmentFieldSidebar = ({ segment, field }: SegmentFieldSidebarProps) => (
+const SegmentFieldSidebar = ({
+ segmentId,
+ segmentName,
+ fieldId,
+ fieldName,
+}: SegmentFieldSidebarProps) => (
<div className={S.sidebar}>
<ul className={CS.mx3}>
<div>
@@ -21,16 +27,16 @@ const SegmentFieldSidebar = ({ segment, field }: SegmentFieldSidebarProps) => (
className={CS.py4}
crumbs={[
[t`Segments`, "/reference/segments"],
- [segment.name, `/reference/segments/${segment.id}`],
- [field.name],
+ [segmentName, `/reference/segments/${segmentId}`],
+ [fieldName],
]}
inSidebar={true}
placeholder={t`Data Reference`}
/>
</div>
<SidebarItem
- key={`/reference/segments/${segment.id}/fields/${field.id}`}
- href={`/reference/segments/${segment.id}/fields/${field.id}`}
+ key={`/reference/segments/${segmentId}/fields/${fieldId}`}
+ href={`/reference/segments/${segmentId}/fields/${fieldId}`}
icon="document"
name={t`Details`}
/>
diff --git a/frontend/src/metabase/reference/segments/SegmentQuestions.tsx b/frontend/src/metabase/reference/segments/SegmentQuestions.tsx
index 14451b9d312..13d88560926 100644
--- a/frontend/src/metabase/reference/segments/SegmentQuestions.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentQuestions.tsx
@@ -1,29 +1,27 @@
import cx from "classnames";
import { t } from "ttag";
-import { useListCardsQuery } from "metabase/api";
+import { skipToken, useListCardsQuery } from "metabase/api";
import { AdminAwareEmptyState } from "metabase/common/components/AdminAwareEmptyState";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { modelIconMap } from "metabase/common/utils/icon";
import CS from "metabase/css/core/index.css";
import { selectMetadataProvider } from "metabase/metadata-store";
-import { connect } from "metabase/redux";
+import { useSelector } from "metabase/redux";
import { List } from "metabase/reference/components/List";
import S from "metabase/reference/components/List/List.module.css";
import { ListItem } from "metabase/reference/components/ListItem";
import * as Urls from "metabase/urls";
import { visualizations } from "metabase/viz-core";
import type * as Lib from "metabase-lib";
+import type { Segment, Table } from "metabase-types/api";
import ReferenceHeader from "../components/ReferenceHeader";
-import type { ReferenceRouteProps, StateWithReference } from "../selectors";
-import { getSegment, getTableBySegment } from "../selectors";
-import type { StubbedSegment, StubbedTable } from "../types";
import { getDescription, getQuestionUrl } from "../utils";
const emptyStateData = (
- table: StubbedTable,
- segment: StubbedSegment,
+ table: Table,
+ segment: Segment,
metadataProvider: Lib.MetadataProvider,
) => {
return {
@@ -31,48 +29,39 @@ const emptyStateData = (
icon: "folder" as const,
action: t`Ask a question`,
link: getQuestionUrl({
- tableId: segment.table_id!,
+ tableId: table.id,
segmentId: segment.id,
metadataProvider: metadataProvider,
}),
};
};
-const mapStateToProps = (
- state: StateWithReference,
- props: ReferenceRouteProps,
-) => ({
- segment: getSegment(state, props),
- table: getTableBySegment(state, props),
- metadataProvider: selectMetadataProvider(
- state,
- getTableBySegment(state, props)?.db_id ?? null,
- ),
-});
-
-interface SegmentQuestionsInnerProps {
- style: React.CSSProperties;
- table: StubbedTable;
- segment: StubbedSegment;
- metadataProvider: Lib.MetadataProvider;
+interface SegmentQuestionsProps {
+ style?: React.CSSProperties;
+ table: Table | undefined;
+ segment: Segment | undefined;
}
-const SegmentQuestionsInner = ({
+export const SegmentQuestions = ({
style,
table,
segment,
- metadataProvider,
-}: SegmentQuestionsInnerProps) => {
+}: SegmentQuestionsProps) => {
+ const metadataProvider = useSelector((state) =>
+ selectMetadataProvider(state, table?.db_id ?? null),
+ );
const {
data: cards = [],
isLoading,
error,
- } = useListCardsQuery({ f: "using_segment", model_id: segment.id });
+ } = useListCardsQuery(
+ segment != null ? { f: "using_segment", model_id: segment.id } : skipToken,
+ );
return (
<div style={style} className={CS.full}>
<ReferenceHeader
- name={t`Questions about ${segment.name}`}
+ name={t`Questions about ${segment?.name}`}
headerIcon={modelIconMap.segment}
/>
<LoadingAndErrorWrapper loading={!error && isLoading} error={error}>
@@ -109,8 +98,3 @@ const SegmentQuestionsInner = ({
</div>
);
};
-
-export const SegmentQuestions = connect(
- mapStateToProps,
- // Unjustified type cast. FIXME
-)(SegmentQuestionsInner as unknown as React.ComponentType);
diff --git a/frontend/src/metabase/reference/segments/SegmentQuestionsContainer.tsx b/frontend/src/metabase/reference/segments/SegmentQuestionsContainer.tsx
index bed71679d9b..a2547287a57 100644
--- a/frontend/src/metabase/reference/segments/SegmentQuestionsContainer.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentQuestionsContainer.tsx
@@ -18,12 +18,12 @@ import type { ClearStateProps } from "../reference";
import {
type ReferenceRouteParams,
getIsEditing,
- getSegment,
getSegmentId,
getUser,
} from "../selectors";
import SegmentSidebar from "./SegmentSidebar";
+import { useSegmentPage } from "./use-segment-page";
const mapDispatchToProps = {
fetchQuestions: () => (dispatch: Dispatch) =>
@@ -42,9 +42,9 @@ function SegmentQuestionsContainer(props: SegmentQuestionsContainerProps) {
const params = useParams<ReferenceRouteParams>();
const user = useSelector(getUser);
- const segment = useSelector((state) => getSegment(state, { params }));
const segmentId = useSelector((state) => getSegmentId(state, { params }));
const isEditing = useSelector(getIsEditing);
+ const { segment, table } = useSegmentPage(segmentId);
useReferenceFetch(() => fetchSegmentQuestionsData(dispatch, segmentId));
@@ -60,9 +60,15 @@ function SegmentQuestionsContainer(props: SegmentQuestionsContainerProps) {
<SidebarLayout
className={cx(CS.flexFull, CS.relative)}
style={isEditing ? { paddingTop: "43px" } : {}}
- sidebar={<SegmentSidebar segment={segment} user={user} />}
+ sidebar={
+ <SegmentSidebar
+ segmentId={segmentId}
+ segmentName={segment?.name}
+ user={user}
+ />
+ }
>
- <SegmentQuestions params={params} />
+ <SegmentQuestions segment={segment} table={table} />
</SidebarLayout>
);
}
diff --git a/frontend/src/metabase/reference/segments/SegmentRevisions.tsx b/frontend/src/metabase/reference/segments/SegmentRevisions.tsx
index 0b5793a498f..e72591257a1 100644
--- a/frontend/src/metabase/reference/segments/SegmentRevisions.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentRevisions.tsx
@@ -7,21 +7,21 @@ import { EmptyState } from "metabase/common/components/EmptyState";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { modelIconMap } from "metabase/common/utils/icon";
import CS from "metabase/css/core/index.css";
-import { getShallowTables as getTables } from "metabase/metadata-store";
import { connect } from "metabase/redux";
import S from "metabase/reference/components/List/List.module.css";
import { Revision } from "metabase/segments";
import { assignUserColors } from "metabase/ui/colors/formatting-colors";
import type {
- NormalizedTable,
Revision as RevisionData,
+ Segment,
+ Table,
User,
} from "metabase-types/api";
import ReferenceHeader from "../components/ReferenceHeader";
import type { ReferenceRouteProps, StateWithReference } from "../selectors";
-import { getSegment, getSegmentRevisions, getUser } from "../selectors";
-import type { ReferenceLoadingProps, StubbedSegment } from "../types";
+import { getSegmentRevisions, getUser } from "../selectors";
+import type { ReferenceLoadingProps } from "../types";
const emptyStateData = {
get message() {
@@ -35,8 +35,6 @@ const mapStateToProps = (
) => {
return {
revisions: getSegmentRevisions(state, props),
- segment: getSegment(state, props),
- tables: getTables(state),
user: getUser(state),
};
};
@@ -44,8 +42,8 @@ const mapStateToProps = (
interface SegmentRevisionsProps {
style: React.CSSProperties;
revisions: Record<string, RevisionData>;
- segment: StubbedSegment;
- tables: Record<string, NormalizedTable>;
+ segment: Segment | undefined;
+ table: Table | undefined;
user: User;
loading?: boolean;
loadingError?: unknown;
@@ -53,11 +51,9 @@ interface SegmentRevisionsProps {
class SegmentRevisions extends Component<SegmentRevisionsProps> {
render() {
- const { style, revisions, segment, tables, user, loading, loadingError } =
+ const { style, revisions, segment, table, user, loading, loadingError } =
this.props;
- const entity = segment;
-
const userColorAssignments: Record<string | number, string> =
user && Object.keys(revisions).length > 0
? assignUserColors(
@@ -71,7 +67,7 @@ class SegmentRevisions extends Component<SegmentRevisionsProps> {
return (
<div style={style} className={CS.full} data-testid="segment-revisions">
<ReferenceHeader
- name={t`Revision history for ${this.props.segment.name}`}
+ name={t`Revision history for ${segment?.name}`}
headerIcon={modelIconMap.segment}
/>
<LoadingAndErrorWrapper
@@ -79,9 +75,7 @@ class SegmentRevisions extends Component<SegmentRevisionsProps> {
error={loadingError}
>
{() =>
- Object.keys(revisions).length > 0 &&
- entity.table_id != null &&
- tables[entity.table_id] ? (
+ Object.keys(revisions).length > 0 && table != null ? (
<div className={CS.wrapper}>
<div
className={cx(
@@ -99,8 +93,8 @@ class SegmentRevisions extends Component<SegmentRevisionsProps> {
<Revision
key={revision.id}
revision={revision || {}}
- tableId={entity.table_id!}
- objectName={entity.name!}
+ tableId={table.id}
+ objectName={segment?.name ?? ""}
currentUser={user || {}}
userColor={
userColorAssignments[
@@ -136,6 +130,10 @@ export default connect(
// props, because the `actions` spread in `mapDispatchToProps` is untyped.
// The cast restores the props a caller actually passes.
SegmentRevisions as unknown as React.ComponentType<
- ReferenceRouteProps & ReferenceLoadingProps
+ ReferenceRouteProps &
+ ReferenceLoadingProps & {
+ segment: Segment | undefined;
+ table: Table | undefined;
+ }
>,
);
diff --git a/frontend/src/metabase/reference/segments/SegmentRevisionsContainer.tsx b/frontend/src/metabase/reference/segments/SegmentRevisionsContainer.tsx
index 5629e533c52..1208ef39840 100644
--- a/frontend/src/metabase/reference/segments/SegmentRevisionsContainer.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentRevisionsContainer.tsx
@@ -15,12 +15,12 @@ import type { ClearStateProps } from "../reference";
import {
type ReferenceRouteParams,
getIsEditing,
- getSegment,
getSegmentId,
getUser,
} from "../selectors";
import SegmentSidebar from "./SegmentSidebar";
+import { useSegmentPage } from "./use-segment-page";
const mapDispatchToProps = {
...actions,
@@ -35,9 +35,9 @@ function SegmentRevisionsContainer(props: SegmentRevisionsContainerProps) {
const params = useParams<ReferenceRouteParams>();
const user = useSelector(getUser);
- const segment = useSelector((state) => getSegment(state, { params }));
const segmentId = useSelector((state) => getSegmentId(state, { params }));
const isEditing = useSelector(getIsEditing);
+ const { segment, table } = useSegmentPage(segmentId);
const { loading, loadingError } = useReferenceFetch(() =>
fetchSegmentRevisionsData(dispatch, segmentId),
@@ -55,10 +55,18 @@ function SegmentRevisionsContainer(props: SegmentRevisionsContainerProps) {
<SidebarLayout
className={cx(CS.flexFull, CS.relative)}
style={isEditing ? { paddingTop: "43px" } : {}}
- sidebar={<SegmentSidebar segment={segment} user={user} />}
+ sidebar={
+ <SegmentSidebar
+ segmentId={segmentId}
+ segmentName={segment?.name}
+ user={user}
+ />
+ }
>
<SegmentRevisions
params={params}
+ segment={segment}
+ table={table}
loading={loading}
loadingError={loadingError}
/>
diff --git a/frontend/src/metabase/reference/segments/SegmentSidebar.tsx b/frontend/src/metabase/reference/segments/SegmentSidebar.tsx
index b53a8ca687b..ee3a5bd60ff 100644
--- a/frontend/src/metabase/reference/segments/SegmentSidebar.tsx
+++ b/frontend/src/metabase/reference/segments/SegmentSidebar.tsx
@@ -7,50 +7,54 @@ import CS from "metabase/css/core/index.css";
import S from "metabase/reference/components/Sidebar.module.css";
import { SidebarItem } from "metabase/reference/components/SidebarItem";
import MetabaseSettings from "metabase/utils/settings";
-import type { User } from "metabase-types/api";
+import type { SegmentId, User } from "metabase-types/api";
import { trackReferenceXRayClicked } from "../analytics";
-import type { StubbedSegment } from "../types";
interface SegmentSidebarProps {
- segment: StubbedSegment;
+ segmentId: SegmentId;
+ segmentName?: string;
user?: User | null;
}
-const SegmentSidebar = ({ segment, user }: SegmentSidebarProps) => (
+const SegmentSidebar = ({
+ segmentId,
+ segmentName,
+ user,
+}: SegmentSidebarProps) => (
<div className={S.sidebar}>
<ul>
<div>
<Breadcrumbs
className={cx(CS.py4, CS.ml3)}
- crumbs={[[t`Segments`, "/reference/segments"], [segment.name]]}
+ crumbs={[[t`Segments`, "/reference/segments"], [segmentName]]}
inSidebar={true}
placeholder={t`Data Reference`}
/>
</div>
<ol className={CS.mx3}>
<SidebarItem
- key={`/reference/segments/${segment.id}`}
- href={`/reference/segments/${segment.id}`}
+ key={`/reference/segments/${segmentId}`}
+ href={`/reference/segments/${segmentId}`}
icon="document"
name={t`Details`}
/>
<SidebarItem
- key={`/reference/segments/${segment.id}/fields`}
- href={`/reference/segments/${segment.id}/fields`}
+ key={`/reference/segments/${segmentId}/fields`}
+ href={`/reference/segments/${segmentId}/fields`}
icon="field"
name={t`Fields in this segment`}
/>
<SidebarItem
- key={`/reference/segments/${segment.id}/questions`}
- href={`/reference/segments/${segment.id}/questions`}
+ key={`/reference/segments/${segmentId}/questions`}
+ href={`/reference/segments/${segmentId}/questions`}
icon="folder"
name={t`Questions about this segment`}
/>
{MetabaseSettings.get("enable-xrays") && (
<SidebarItem
- key={`/auto/dashboard/segment/${segment.id}`}
- href={`/auto/dashboard/segment/${segment.id}`}
+ key={`/auto/dashboard/segment/${segmentId}`}
+ href={`/auto/dashboard/segment/${segmentId}`}
icon="bolt"
name={t`X-ray this segment`}
onClick={() => trackReferenceXRayClicked("segment")}
@@ -58,8 +62,8 @@ const SegmentSidebar = ({ segment, user }: SegmentSidebarProps) => (
)}
{user && user.is_superuser && (
<SidebarItem
- key={`/reference/segments/${segment.id}/revisions`}
- href={`/reference/segments/${segment.id}/revisions`}
+ key={`/reference/segments/${segmentId}/revisions`}
+ href={`/reference/segments/${segmentId}/revisions`}
icon="history"
name={t`Revision history`}
/>
diff --git a/frontend/src/metabase/reference/segments/use-segment-page.ts b/frontend/src/metabase/reference/segments/use-segment-page.ts
new file mode 100644
index 00000000000..4e0fbc15f21
--- /dev/null
+++ b/frontend/src/metabase/reference/segments/use-segment-page.ts
@@ -0,0 +1,36 @@
+import {
+ skipToken,
+ useGetTableQueryMetadataQuery,
+ useListSegmentsQuery,
+} from "metabase/api";
+import type { SegmentId } from "metabase-types/api";
+
+/**
+ * The segment and the table it filters, which every reference segment page
+ * needs to name itself and to describe the segment's definition.
+ *
+ * The segment comes from the list rather than `GET /api/segment/:id`, which is
+ * the request the pages already make to resolve the segment's table.
+ */
+export function useSegmentPage(segmentId: SegmentId) {
+ const {
+ data: segments,
+ isLoading: isLoadingSegments,
+ error: segmentsError,
+ } = useListSegmentsQuery();
+
+ const segment = segments?.find(({ id }) => id === segmentId);
+
+ const { data: table, error: tableError } = useGetTableQueryMetadataQuery(
+ segment?.table_id != null ? { id: segment.table_id } : skipToken,
+ );
+
+ return {
+ segment,
+ table,
+ isLoading:
+ isLoadingSegments ||
+ (segment != null && table == null && tableError == null),
+ error: segmentsError ?? tableError,
+ };
+}
diff --git a/frontend/src/metabase/reference/selectors.ts b/frontend/src/metabase/reference/selectors.ts
index 27f9cc011f2..da38ba9a39b 100644
--- a/frontend/src/metabase/reference/selectors.ts
+++ b/frontend/src/metabase/reference/selectors.ts
@@ -4,18 +4,12 @@ import { getIn } from "icepick";
import {
getShallowDatabases as getDatabases,
getShallowFields as getFields,
- getShallowSegments as getSegments,
getShallowTables as getTables,
} from "metabase/metadata-store";
import type { State } from "metabase/redux/store";
import type { Card } from "metabase-types/api";
-import type {
- StubbedDatabase,
- StubbedField,
- StubbedSegment,
- StubbedTable,
-} from "./types";
+import type { StubbedDatabase, StubbedField, StubbedTable } from "./types";
import { idsToObjectMap } from "./utils";
// A `type`, not an `interface`, so `useParams<ReferenceRouteParams>()` accepts
@@ -49,12 +43,6 @@ export { getUser } from "metabase/current-user";
export const getSegmentId = (_state: State, props: ReferenceRouteProps) =>
Number.parseInt(props.params.segmentId ?? "");
-export const getSegment = createSelector(
- [getSegmentId, getSegments],
- (segmentId, segments): StubbedSegment =>
- segments?.[segmentId] || { id: segmentId },
-);
-
export const getDatabaseId = (_state: State, props: ReferenceRouteProps) =>
Number.parseInt(props.params.databaseId ?? "");
@@ -72,21 +60,10 @@ export const getTablesByDatabase = createSelector(
(tables, database) =>
tables && database.tables ? idsToObjectMap(database.tables, tables) : {},
);
-export const getTableBySegment = createSelector(
- [getSegment, getTables],
- (segment, tables): StubbedTable =>
- segment.table_id && tables?.[segment.table_id]
- ? tables[segment.table_id]
- : { id: 0 },
-);
export const getTable = createSelector(
- [getTableId, getTables, getSegmentId, getTableBySegment],
- (tableId, tables, segmentId, tableBySegment): StubbedTable =>
- tableId
- ? tables?.[tableId] || { id: tableId }
- : segmentId
- ? tableBySegment
- : { id: 0 },
+ [getTableId, getTables],
+ (tableId, tables): StubbedTable =>
+ tableId ? tables?.[tableId] || { id: tableId } : { id: 0 },
);
export const getFieldId = (_state: State, props: ReferenceRouteProps) =>
@@ -95,18 +72,10 @@ export const getFieldsByTable = createSelector(
[getTable, getFields],
(table, fields) => (table.fields ? idsToObjectMap(table.fields, fields) : {}),
);
-export const getFieldsBySegment = createSelector(
- [getTableBySegment, getFields],
- (table, fields) => (table.fields ? idsToObjectMap(table.fields, fields) : {}),
-);
export const getField = createSelector(
[getFieldId, getFields],
(fieldId, fields): StubbedField => fields?.[fieldId] || { id: fieldId },
);
-export const getFieldBySegment = createSelector(
- [getFieldId, getFieldsBySegment],
- (fieldId, fields): StubbedField => fields[fieldId] || { id: fieldId },
-);
const getQuestions = (state: State) =>
getIn(state, ["entities", "questions"]) || {};