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
refactor(embedding): Convert SavedEntityPicker to TypeScript (#75061)
Andrei Chernykh6cd06168df58
diff --git a/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityList.tsx b/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityList.tsxindex fcd1f261480..340db9b2651 100644--- a/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityList.tsx+++ b/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityList.tsx@@ -10,16 +10,16 @@ import { useTranslateContent } from "metabase/i18n/hooks";import { PLUGIN_MODERATION } from "metabase/plugins";import { Box } from "metabase/ui";import { getQuestionVirtualTableId } from "metabase-lib/v1/metadata/utils/saved-questions";-import type { CardType, Collection, DatabaseId } from "metabase-types/api";+import type { CardType, CollectionId, DatabaseId } from "metabase-types/api";import SavedEntityListS from "./SavedEntityList.module.css";import { CARD_INFO } from "./constants";interface SavedEntityListProps {type: Extract<CardType, "model" | "question">;- selectedId: string;- databaseId: DatabaseId;- collection?: Collection;+ selectedId?: string;+ databaseId?: DatabaseId;+ collectionId?: CollectionId;onSelect: (tableOrModelId: string) => void;}@@ -27,7 +27,7 @@ const SavedEntityList = ({type,selectedId,databaseId,- collection,+ collectionId,onSelect,}: SavedEntityListProps): JSX.Element => {const tc = useTranslateContent();@@ -37,12 +37,12 @@ const SavedEntityList = ({</Box>);- const isVirtualCollection = collection?.id === PERSONAL_COLLECTIONS.id;+ const isVirtualCollection = collectionId === PERSONAL_COLLECTIONS.id;const { data, error, isFetching } = useListCollectionItemsQuery(- collection && !isVirtualCollection+ collectionId != null && !isVirtualCollection? {- id: collection.id,+ id: collectionId,models: [CARD_INFO[type].model],sort_column: "name",sort_direction: "asc",@@ -60,7 +60,7 @@ const SavedEntityList = ({<SelectList className={SavedEntityListS.SavedEntityListRoot}><LoadingAndErrorWrapperclassName={SavedEntityListS.LoadingWrapper}- loading={!collection || isFetching}+ loading={collectionId == null || isFetching}error={error}><Fragment>diff --git a/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.jsx b/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.tsxsimilarity index 59%rename from enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.jsxrename to enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.tsxindex 2b3697cc794..2d459d8db47 100644--- a/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.jsx+++ b/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.tsx@@ -1,4 +1,3 @@-import PropTypes from "prop-types";import { useCallback, useMemo, useState } from "react";import {@@ -6,6 +5,7 @@ import {useListCollectionsTreeQuery,} from "metabase/api";import { PERSONAL_COLLECTIONS } from "metabase/collections/constants";+import type { CollectionTreeItem } from "metabase/collections/utils";import {buildCollectionTree,currentUserPersonalCollections,@@ -13,71 +13,81 @@ import {nonPersonalOrArchivedCollection,} from "metabase/collections/utils";import { Tree } from "metabase/common/components/tree";+import type { ITreeNodeItem } from "metabase/common/components/tree/types";import CS from "metabase/css/core/index.css";import { useSelector } from "metabase/redux";import { getUser } from "metabase/selectors/user";import { Box, Icon } from "metabase/ui";+import type {+ CardType,+ Collection,+ CollectionId,+ DatabaseId,+ User,+} from "metabase-types/api";import SavedEntityList from "./SavedEntityList";import SavedEntityPickerS from "./SavedEntityPicker.module.css";import { CARD_INFO } from "./constants";import { findCollectionById } from "./utils";-const propTypes = {- type: PropTypes.string,- onSelect: PropTypes.func.isRequired,- onBack: PropTypes.func.isRequired,- databaseId: PropTypes.string,- tableId: PropTypes.string,- collectionId: PropTypes.number,-};--const getOurAnalyticsCollection = (collectionEntity) => {- return {- ...collectionEntity,- schemaName: "Everything else",- icon: "folder",- };-};+type SavedEntityType = Extract<CardType, "model" | "question">;+interface SavedEntityPickerProps {+ type: SavedEntityType;+ collectionId?: CollectionId;+ tableId?: string;+ databaseId?: DatabaseId;+ onSelect: (cardId: string) => void;+ onBack: () => void;+}++const getOurAnalyticsCollection = (+ collectionEntity: Collection,+): CollectionTreeItem => ({+ ...collectionEntity,+ // "Our analytics" is shown here as a flat clickable target; its real children+ // are already listed by buildCollectionTree below, so we explicitly empty+ // them to avoid duplicating the tree.+ children: [],+ schemaName: "Everything else",+ icon: "folder",+});++// A sentinel root node that buildCollectionTree special-cases by id; it isn't a+// real Collection, so we assert the type here rather than fabricate every field.const ALL_PERSONAL_COLLECTIONS_ROOT = {...PERSONAL_COLLECTIONS,-};--/**- * @typedef {import("metabase/embedding-sdk/types/components/data-picker").DataSourceSelectorProps} DataSourceSelectorProps- *- * @typedef {object} SavedEntityPickerOwnProps- * @property {DataSourceSelectorProps['selectedCollectionId']} collectionId- * @property {Extract<import("metabase-types/api").CardType, 'model' | 'question'>} type- * @property {string} tableId- * @property {DataSourceSelectorProps['selectedDatabaseId']} databaseId- * @property {(cardId: string) => void} onSelect- * @property {() => void} onBack- */--/**- * @param {SavedEntityPickerOwnProps} props- * @returns {JSX.Element | null}- */-export function SavedEntityPicker(props) {+} as Collection;++export function SavedEntityPicker(props: SavedEntityPickerProps) {const { data: collections } = useListCollectionsTreeQuery({"exclude-archived": true,namespaces: ["", "shared-tenant-collection", "tenant-specific"],});const { data: rootCollection } = useGetCollectionQuery({ id: "root" });- if (!collections) {+ const currentUser = useSelector(getUser);++ if (!collections || !currentUser) {return null;}+return (<InnerSavedEntityPicker{...props}collections={collections}rootCollection={rootCollection}+ currentUser={currentUser}/>);}+interface InnerSavedEntityPickerProps extends SavedEntityPickerProps {+ collections: Collection[];+ rootCollection?: Collection;+ currentUser: User;+}+function InnerSavedEntityPicker({collectionId,type,@@ -87,13 +97,12 @@ function InnerSavedEntityPicker({onBack,collections,rootCollection,-}) {- const currentUser = useSelector(getUser);-- const collectionTree = useMemo(() => {- const modelFilter = (model) => CARD_INFO[type].model === model;+ currentUser,+}: InnerSavedEntityPickerProps) {+ const collectionTree = useMemo<CollectionTreeItem[]>(() => {+ const modelFilter = (model: string) => CARD_INFO[type].model === model;- const preparedCollections = [];+ const preparedCollections: Collection[] = [];const userPersonalCollections = currentUserPersonalCollections(collections,currentUser.id,@@ -126,20 +135,25 @@ function InnerSavedEntityPicker({];}, [collections, rootCollection, currentUser, type]);- const initialCollection = useMemo(- () => findCollectionById(collectionTree, collectionId) ?? collectionTree[0],- // eslint-disable-next-line react-hooks/exhaustive-deps- [],- );-- const [selectedCollection, setSelectedCollection] =- useState(initialCollection);+ const [selectedCollectionId, setSelectedCollectionId] = useState<+ CollectionId | undefined+ >(() => {+ if (collectionId != null) {+ const collection = findCollectionById(collectionTree, collectionId);+ if (collection) {+ return collection.id;+ }+ }+ return collectionTree[0]?.id;+ });- const handleSelect = useCallback((collection) => {+ const handleSelect = useCallback((collection: ITreeNodeItem) => {if (collection.id === PERSONAL_COLLECTIONS.id) {return;}- setSelectedCollection(collection);+ // Tree erases node ids to string | number, but a selected collection+ // node's id is always a CollectionId.+ setSelectedCollectionId(collection.id as CollectionId);}, []);return (@@ -157,13 +171,13 @@ function InnerSavedEntityPicker({<Treedata={collectionTree}onSelect={handleSelect}- selectedId={selectedCollection?.id}+ selectedId={selectedCollectionId}/></Box></Box><SavedEntityListtype={type}- collection={selectedCollection}+ collectionId={selectedCollectionId}selectedId={tableId}databaseId={databaseId}onSelect={onSelect}@@ -171,10 +185,3 @@ function InnerSavedEntityPicker({</Box>);}--SavedEntityPicker.propTypes = propTypes;-InnerSavedEntityPicker.propTypes = {- ...propTypes,- collections: PropTypes.array.isRequired,- rootCollection: PropTypes.object,-};diff --git a/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.unit.spec.jsx b/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.unit.spec.tsxsimilarity index 92%rename from enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.unit.spec.jsxrename to enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.unit.spec.tsxindex 06d6137e71d..d3a66c012ee 100644--- a/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.unit.spec.jsx+++ b/enterprise/frontend/src/embedding/data-picker/saved-entity-picker/SavedEntityPicker.unit.spec.tsx@@ -34,15 +34,13 @@ const COLLECTIONS = {};function mockCollectionItemsEndpoint() {- fetchMock.get(- {- url: "path:/api/collection/root/items",- query: {- sort_column: "name",- sort_direction: "asc",- },+ fetchMock.get({+ url: "path:/api/collection/root/items",+ query: {+ sort_column: "name",+ sort_direction: "asc",},- {+ response: {total: 3,data: [createMockCollectionItem({@@ -62,7 +60,7 @@ function mockCollectionItemsEndpoint() {limit: null,offset: null,},- );+ });}async function setup() {