The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Remove `getName` object selector and use `getName` util instead (#73317)
Romeo Van Snick3f540c64f59f
diff --git a/frontend/src/metabase-types/entities/common.ts b/frontend/src/metabase-types/entities/common.tsindex a618a527891..bfe43333fba 100644--- a/frontend/src/metabase-types/entities/common.ts+++ b/frontend/src/metabase-types/entities/common.ts@@ -1,7 +1,6 @@import type { Collection } from "metabase-types/api";export type WrappedEntity<Entity> = {- getName: () => string;getCollection: () => Collection;setCollection: (collection: Collection) => void;setCollectionPreview: (isEnabled: boolean) => void;diff --git a/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsx b/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsxindex 2c5c8e6ef9f..acc83063bf6 100644--- a/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsx+++ b/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsx@@ -23,7 +23,13 @@ import { useDispatch, useSelector } from "metabase/redux";import { ActionIcon, Box, Flex, Icon, Tooltip } from "metabase/ui";import { DEFAULT_SEARCH_LIMIT } from "metabase/utils/constants";import { VisualizerModal } from "metabase/visualizer/components/VisualizerModal";-import type { CardId, CollectionId } from "metabase-types/api";+import type {+ CardId,+ CollectionId,+ CollectionItem,+ SearchResult,+} from "metabase-types/api";+import type { WrappedEntity } from "metabase-types/entities";import S from "./QuestionList.module.css";import { trackVisualizeAnotherWayClicked } from "./analytics";@@ -109,7 +115,7 @@ export function QuestionList({const error = isSearching ? searchError : itemsError;const isFetching = isSearching ? searchIsFetching : itemsIsFetching;const dispatch = useDispatch();- const list = useMemo(() => {+ const list: WrappedEntity<SearchResult | CollectionItem>[] = useMemo(() => {return data?.data?.map((item) => Search.wrapEntity(item, dispatch)) ?? [];}, [data, dispatch]);@@ -144,7 +150,7 @@ export function QuestionList({label: S.QuestionListItemLabel,}}className={S.QuestionListItem}- name={item.getName()}+ name={item.name}icon={{name: getIcon(item).name,size: item.model === "dataset" ? 18 : 16,diff --git a/frontend/src/metabase/entities/collections/collections.ts b/frontend/src/metabase/entities/collections/collections.tsindex 6a0886c8de0..f2e039ec93d 100644--- a/frontend/src/metabase/entities/collections/collections.ts+++ b/frontend/src/metabase/entities/collections/collections.ts@@ -123,10 +123,6 @@ export const Collections = createEntity({),},- objectSelectors: {- getName: (collection?: Collection) => collection?.name,- },-selectors: {getExpandedCollectionsById: createSelector([diff --git a/frontend/src/metabase/entities/containers/EntityName.tsx b/frontend/src/metabase/entities/containers/EntityName.tsxindex 9a456b6f07d..ce5a862b541 100644--- a/frontend/src/metabase/entities/containers/EntityName.tsx+++ b/frontend/src/metabase/entities/containers/EntityName.tsx@@ -1,6 +1,7 @@import { useMemo } from "react";import { useTranslateContent } from "metabase/i18n/hooks";+import { type ItemWithName, getName } from "metabase/utils/name";import type { EntityDefinition, EntityId, EntityType } from "./rtk-query";@@ -12,7 +13,7 @@ interface Props {/*** @deprecated use "metabase/api" instead*/-export const EntityName = <Entity, EntityWrapper>({+export const EntityName = <Entity extends ItemWithName, EntityWrapper>({entityType,entityId,}: Props) => {@@ -41,5 +42,5 @@ export const EntityName = <Entity, EntityWrapper>({return null;}- return <span>{tc(entityDefinition.objectSelectors.getName(entity))}</span>;+ return <span>{tc(getName(entity))}</span>;};diff --git a/frontend/src/metabase/entities/containers/rtk-query/types/entities.ts b/frontend/src/metabase/entities/containers/rtk-query/types/entities.tsindex 5d1dc6fde34..820a51a5d1c 100644--- a/frontend/src/metabase/entities/containers/rtk-query/types/entities.ts+++ b/frontend/src/metabase/entities/containers/rtk-query/types/entities.ts@@ -94,7 +94,6 @@ export interface EntityDefinition<Entity, EntityWrapper> {normalize: (object: unknown) => { object: unknown };normalizeList: (list: unknown) => { list: unknown };objectSelectors: {- getName: (entity: Entity | EntityWrapper) => string;getCollection: (entity: Entity | EntityWrapper) => Collection | undefined;};rtk: {diff --git a/frontend/src/metabase/entities/dashboards.js b/frontend/src/metabase/entities/dashboards.jsindex 7db8853e0a8..e18fe371035 100644--- a/frontend/src/metabase/entities/dashboards.js+++ b/frontend/src/metabase/entities/dashboards.js@@ -167,7 +167,6 @@ export const Dashboards = createEntity({},objectSelectors: {- getName: (dashboard) => dashboard && dashboard.name,getCollection: (dashboard) =>dashboard && normalizedCollection(dashboard.collection),},diff --git a/frontend/src/metabase/entities/databases.js b/frontend/src/metabase/entities/databases.jsindex d96dfdb44d8..5de62741894 100644--- a/frontend/src/metabase/entities/databases.js+++ b/frontend/src/metabase/entities/databases.js@@ -107,10 +107,6 @@ export const Databases = createEntity({),},- objectSelectors: {- getName: (db) => db && db.name,- },-selectors: {getObject: (state, { entityId }) => getMetadata(state).database(entityId),diff --git a/frontend/src/metabase/entities/documents.ts b/frontend/src/metabase/entities/documents.tsindex ae2531760c3..ca736ab88f0 100644--- a/frontend/src/metabase/entities/documents.ts+++ b/frontend/src/metabase/entities/documents.ts@@ -100,8 +100,4 @@ export const Documents = createEntity({return (result as { data: Document }).data;},},-- objectSelectors: {- getName: (document: Document) => document && document.name,- },});diff --git a/frontend/src/metabase/entities/measures.js b/frontend/src/metabase/entities/measures.jsindex ac5ce509ad7..a7f5c9607ef 100644--- a/frontend/src/metabase/entities/measures.js+++ b/frontend/src/metabase/entities/measures.js@@ -54,10 +54,6 @@ export const Measures = createEntity({selectors: {getObject: (state, { entityId }) => getMetadata(state).measure(entityId),},-- objectSelectors: {- getName: (measure) => measure && measure.name,- },});const useGetQuery = ({ id }, options) => {diff --git a/frontend/src/metabase/entities/metrics.js b/frontend/src/metabase/entities/metrics.jsindex 8a0c7346fdd..05b7cf62443 100644--- a/frontend/src/metabase/entities/metrics.js+++ b/frontend/src/metabase/entities/metrics.js@@ -42,10 +42,6 @@ export const Metrics = createEntity({selectors: {getObject: (state, { entityId }) => getMetadata(state).metric(entityId),},-- objectSelectors: {- getName: (metric) => metric && metric.name,- },});const useGetQuery = ({ id }, options) => {diff --git a/frontend/src/metabase/entities/pulses.js b/frontend/src/metabase/entities/pulses.jsindex a77d4347ee3..59bf60cee54 100644--- a/frontend/src/metabase/entities/pulses.js+++ b/frontend/src/metabase/entities/pulses.js@@ -52,10 +52,6 @@ export const Pulses = createEntity({},},- objectSelectors: {- getName: (pulse) => pulse && pulse.name,- },-getAnalyticsMetadata([object], { action }, getState) {const type = object && getCollectionType(object.collection_id, getState());return type && `collection=${type}`;diff --git a/frontend/src/metabase/entities/questions.js b/frontend/src/metabase/entities/questions.jsindex 44c5b43efac..7e61bc169f3 100644--- a/frontend/src/metabase/entities/questions.js+++ b/frontend/src/metabase/entities/questions.js@@ -152,7 +152,6 @@ export const Questions = createEntity({},objectSelectors: {- getName: (card) => card && card.name,getCollection: (card) => card && normalizedCollection(card.collection),},diff --git a/frontend/src/metabase/entities/search.js b/frontend/src/metabase/entities/search.jsindex 394ea993768..687bb3396b6 100644--- a/frontend/src/metabase/entities/search.js+++ b/frontend/src/metabase/entities/search.js@@ -141,13 +141,6 @@ export const Search = createEntity({null): warnEntityAndReturnObject(object);},-- getName: (object) => {- const entity = entityForObject(object);- return entity- ? (entity?.objectSelectors?.getName?.(object) ?? object?.name)- : warnEntityAndReturnObject(object);- },},// delegate to each entity's actionShouldInvalidateListsactionShouldInvalidateLists(action) {diff --git a/frontend/src/metabase/entities/segments.js b/frontend/src/metabase/entities/segments.jsindex aff3057840b..992238d4de0 100644--- a/frontend/src/metabase/entities/segments.js+++ b/frontend/src/metabase/entities/segments.js@@ -59,10 +59,6 @@ export const Segments = createEntity({selectors: {getObject: (state, { entityId }) => getMetadata(state).segment(entityId),},-- objectSelectors: {- getName: (segment) => segment && segment.name,- },});const useGetQuery = ({ id }, options) => {diff --git a/frontend/src/metabase/entities/transforms.ts b/frontend/src/metabase/entities/transforms.tsindex a5a87e58be4..c70d1a73cfe 100644--- a/frontend/src/metabase/entities/transforms.ts+++ b/frontend/src/metabase/entities/transforms.ts@@ -1,5 +1,4 @@import { TransformSchema } from "metabase/schema";-import type { Transform } from "metabase-types/api";import { createEntity } from "./utils";@@ -12,8 +11,4 @@ export const Transforms = createEntity({nameOne: "transform",path: "/api/transform",schema: TransformSchema,-- objectSelectors: {- getName: (transform: Transform) => transform && transform.name,- },});diff --git a/frontend/src/metabase/entities/utils.ts b/frontend/src/metabase/entities/utils.tsindex b2812a56f11..46dbbcad3b6 100644--- a/frontend/src/metabase/entities/utils.ts+++ b/frontend/src/metabase/entities/utils.ts@@ -802,9 +802,6 @@ export function createEntity(def: EntityDef): Entity {} as EntitySelectors;entity.objectSelectors = {- getName(object: EntityObject) {- return object.name;- },getIcon(_object: EntityObject) {return { name: "unknown" };},diff --git a/frontend/src/metabase/questions/components/CollectionBadge.tsx b/frontend/src/metabase/questions/components/CollectionBadge.tsxindex 9d4230004e0..4ff060f1a9c 100644--- a/frontend/src/metabase/questions/components/CollectionBadge.tsx+++ b/frontend/src/metabase/questions/components/CollectionBadge.tsx@@ -7,6 +7,7 @@ import { useTranslateContent } from "metabase/i18n/hooks";import { PLUGIN_COLLECTIONS } from "metabase/plugins";import type { State } from "metabase/redux/store";import { modelToUrl } from "metabase/urls/modelToUrl";+import { getName } from "metabase/utils/name";import type {CollectionId,Collection as CollectionType,@@ -59,7 +60,7 @@ const CollectionBadgeInner = ({isSingleLine={isSingleLine}{...clickActionProps}>- {tc(collection.getName())}+ {tc(getName(collection))}</Badge>);};diff --git a/frontend/src/metabase/utils/name.ts b/frontend/src/metabase/utils/name.tsindex 2bebfcd226d..3eac64f3bec 100644--- a/frontend/src/metabase/utils/name.ts+++ b/frontend/src/metabase/utils/name.ts@@ -1,8 +1,20 @@-type ItemWithName = {+export type ItemWithName = {name: string;display_name?: string;};-/** items may or may not have display names, but we should prefer displaying them when they do */-export const getName = (item: ItemWithName): string =>- item.display_name || item.name;+/**+ * items may or may not have display names, but we should prefer displaying them when they do.+ */+export function getName(item: ItemWithName): string;+export function getName(+ item: ItemWithName | null | undefined,+): string | undefined;+export function getName(+ item: ItemWithName | null | undefined,+): string | undefined {+ if (!item) {+ return undefined;+ }+ return item.display_name || item.name;+}