Skip to content

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

Migrate DataSelector to TypeScript (#76861)

Romeo Van Snick3aa548b96629
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonTransformTopBar/PythonTransformTopBar.tsx b/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonTransformTopBar/PythonTransformTopBar.tsx
index de3c0575301..b7b382569a4 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonTransformTopBar/PythonTransformTopBar.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonTransformTopBar/PythonTransformTopBar.tsx
@@ -10,6 +10,7 @@ import { EditDefinitionButton } from "metabase/transforms/components/TransformEd
import { doesDatabaseSupportTransforms } from "metabase/transforms/utils";
import { Flex } from "metabase/ui";
import { getIsRemoteSyncReadOnly } from "metabase-enterprise/remote_sync/selectors";
+import type MetadataDatabase from "metabase-lib/v1/metadata/Database";
import type { Database, DatabaseId, Transform } from "metabase-types/api";
import S from "./PythonTransformTopBar.module.css";
@@ -40,9 +41,8 @@ export function PythonTransformTopBar({
);
const { data: databases } = useListDatabasesQuery();
- const handleDatabaseChange = (value: string | null) => {
- const newDatabaseId = value ? parseInt(value) : undefined;
- if (newDatabaseId != null && newDatabaseId !== databaseId) {
+ const handleDatabaseChange = (newDatabaseId: DatabaseId) => {
+ if (newDatabaseId !== databaseId) {
onDatabaseChange?.(newDatabaseId);
}
};
@@ -60,11 +60,22 @@ export function PythonTransformTopBar({
className={S.databaseSelector}
selectedDatabaseId={databaseId}
setDatabaseFn={handleDatabaseChange}
- databases={databases?.data ?? []}
+ // DataSelector is typed against metabase-lib entities; here we feed
+ // it plain API databases, which carry the fields it actually reads.
+ // TODO(dataselector-api-vs-metabase-lib-casts): remove this cast once
+ // DataSelector's entity props use structural interfaces.
+ databases={(databases?.data ?? []) as unknown as MetadataDatabase[]}
readOnly={!isEditMode}
- databaseIsDisabled={(database: Database) =>
- !doesDatabaseSupportTransforms(database) ||
- !hasFeature(database, "transforms/python")
+ databaseIsDisabled={
+ // DataSelector types this callback against metabase-lib databases;
+ // the predicate only reads plain API database fields.
+ // TODO(dataselector-api-vs-metabase-lib-casts): remove this cast
+ // once DataSelector's entity props use structural interfaces.
+ ((database: Database) =>
+ !doesDatabaseSupportTransforms(database) ||
+ !hasFeature(database, "transforms/python")) as unknown as (
+ database: MetadataDatabase,
+ ) => boolean
}
/>
</Flex>
diff --git a/frontend/src/metabase/admin/datamodel/hoc/FilteredToUrlTable.tsx b/frontend/src/metabase/admin/datamodel/hoc/FilteredToUrlTable.tsx
index fb3b95bc8d6..bd569edd3d1 100644
--- a/frontend/src/metabase/admin/datamodel/hoc/FilteredToUrlTable.tsx
+++ b/frontend/src/metabase/admin/datamodel/hoc/FilteredToUrlTable.tsx
@@ -95,7 +95,9 @@ function TableSelector({ tableId, setTableId }: TableSelectorProps) {
<div className={CS.p2} style={{ width: 200 }}>
<DatabaseSchemaAndTableDataSelector
selectedTableId={tableId}
- setSourceTableFn={setTableId}
+ setSourceTableFn={(newTableId) =>
+ setTableId(typeof newTableId === "number" ? newTableId : null)
+ }
triggerElement={
<span
className={cx(
diff --git a/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx b/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx
index 41741ac7ec0..923d083f33e 100644
--- a/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx
+++ b/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx
@@ -25,6 +25,8 @@ import {
Stack,
rem,
} from "metabase/ui";
+import type MetadataDatabase from "metabase-lib/v1/metadata/Database";
+import type MetadataTable from "metabase-lib/v1/metadata/Table";
import type { Database, Field, FieldId } from "metabase-types/api";
import {
@@ -274,16 +276,19 @@ export const RemappingPicker = ({
*/}
{fkTargetTable && (
<FieldDataSelector
- databases={[database]}
+ // DataSelector is typed against metabase-lib entities; here we
+ // feed it plain API entities, which carry the fields it reads.
+ // TODO(dataselector-api-vs-metabase-lib-casts): remove these casts
+ // once DataSelector's entity props use structural interfaces.
+ databases={[database] as unknown as MetadataDatabase[]}
isInitiallyOpen={isChoosingInitialFkTarget}
- selectedDatabase={database}
selectedDatabaseId={database.id}
- selectedField={fkRemappingField}
selectedFieldId={fkRemappingField?.id}
- selectedTable={fkTargetTable}
selectedTableId={fkTargetTable?.id}
setFieldFn={handleFkRemappingFieldChange}
- tables={tables}
+ // TODO(dataselector-api-vs-metabase-lib-casts): remove this cast
+ // once DataSelector's entity props use structural interfaces.
+ tables={tables as unknown as MetadataTable[]}
triggerElement={
<Select
data={[
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/MappedFieldPicker/MappedFieldPicker.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/MappedFieldPicker/MappedFieldPicker.tsx
index 1035fbe3c04..de4b485e4f4 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/MappedFieldPicker/MappedFieldPicker.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/MappedFieldPicker/MappedFieldPicker.tsx
@@ -115,7 +115,6 @@ export function MappedFieldPicker({
selectedFieldId={selectedFieldId}
getTriggerElementContent={renderTriggerElement}
hasTriggerExpandControl={false}
- triggerTabIndex={tabIndex}
setFieldFn={onFieldChange}
onClose={focusSelectButton}
/>
diff --git a/frontend/src/metabase/query_builder/components/SavedQuestionHeaderButton/SavedQuestionHeaderButton.unit.spec.js b/frontend/src/metabase/query_builder/components/SavedQuestionHeaderButton/SavedQuestionHeaderButton.unit.spec.tsx
similarity index 89%
rename from frontend/src/metabase/query_builder/components/SavedQuestionHeaderButton/SavedQuestionHeaderButton.unit.spec.js
rename to frontend/src/metabase/query_builder/components/SavedQuestionHeaderButton/SavedQuestionHeaderButton.unit.spec.tsx
index 382db3c8282..84501af1f69 100644
--- a/frontend/src/metabase/query_builder/components/SavedQuestionHeaderButton/SavedQuestionHeaderButton.unit.spec.js
+++ b/frontend/src/metabase/query_builder/components/SavedQuestionHeaderButton/SavedQuestionHeaderButton.unit.spec.tsx
@@ -1,11 +1,13 @@
import userEvent from "@testing-library/user-event";
import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";
+import type { ENTERPRISE_PLUGIN_NAME } from "__support__/enterprise-typed";
import { createMockMetadata } from "__support__/metadata";
import { mockSettings } from "__support__/settings";
import { act, getIcon, renderWithProviders, screen } from "__support__/ui";
import { createMockState } from "metabase/redux/store/mocks";
import Question from "metabase-lib/v1/Question";
+import type { TokenFeatures } from "metabase-types/api";
import {
createMockCollection,
createMockTokenFeatures,
@@ -18,7 +20,13 @@ const metadata = createMockMetadata({
databases: [createSampleDatabase()],
});
-function setup({ question, tokenFeatures = {}, enterprisePlugins }) {
+interface SetupOpts {
+ question: Question;
+ tokenFeatures?: Partial<TokenFeatures>;
+ enterprisePlugins?: ENTERPRISE_PLUGIN_NAME[];
+}
+
+function setup({ question, tokenFeatures = {}, enterprisePlugins }: SetupOpts) {
const onSave = jest.fn();
const state = createMockState({
@@ -105,7 +113,7 @@ describe("SavedQuestionHeaderButton", () => {
tokenFeatures: {
content_verification: true,
},
- enterprisePlugins: ["content-verification", "moderation"],
+ enterprisePlugins: ["content_verification", "moderation"],
});
expect(getIcon("verified")).toBeInTheDocument();
});
@@ -127,7 +135,7 @@ describe("SavedQuestionHeaderButton", () => {
setup({
question,
tokenFeatures: { audit_app: true },
- enterprisePlugins: ["collections", "audit-app"],
+ enterprisePlugins: ["collections", "audit_app"],
});
expect(getIcon("audit")).toBeInTheDocument();
});
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.jsx b/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.tsx
similarity index 63%
rename from frontend/src/metabase/querying/common/components/DataSelector/DataSelector.jsx
rename to frontend/src/metabase/querying/common/components/DataSelector/DataSelector.tsx
index b8d48e8b695..7cc7499f808 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.jsx
+++ b/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.tsx
@@ -1,6 +1,5 @@
-/* eslint-disable react/prop-types */
import cx from "classnames";
-import PropTypes from "prop-types";
+import type { CSSProperties, ComponentType, ReactNode } from "react";
import { Component, useCallback } from "react";
import { t } from "ttag";
import _ from "underscore";
@@ -18,17 +17,36 @@ import { EmptyState } from "metabase/common/components/EmptyState";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import CS from "metabase/css/core/index.css";
import { connect } from "metabase/redux";
+import type { Dispatch, State } from "metabase/redux/store";
import { fetchTableMetadata } from "metabase/redux/tables";
import { getMetadata } from "metabase/selectors/metadata";
import { getSetting } from "metabase/selectors/settings";
import { canUserCreateQueries } from "metabase/selectors/user";
import { Box, Popover } from "metabase/ui";
+import type Question from "metabase-lib/v1/Question";
+import type Database from "metabase-lib/v1/metadata/Database";
+import type Field from "metabase-lib/v1/metadata/Field";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type Schema from "metabase-lib/v1/metadata/Schema";
+import type Table from "metabase-lib/v1/metadata/Table";
import {
SAVED_QUESTIONS_VIRTUAL_DB_ID,
getQuestionIdFromVirtualTableId,
isVirtualCardId,
} from "metabase-lib/v1/metadata/utils/saved-questions";
import { parseSchemaId } from "metabase-lib/v1/metadata/utils/schema";
+import type {
+ CardType,
+ CollectionId,
+ DatabaseId,
+ FieldId,
+ FieldReference,
+ ListDatabasesRequest,
+ SchemaId,
+ SearchModel,
+ SearchResponse,
+ TableId,
+} from "metabase-types/api";
import { DataSelectorDataBucketPicker } from "./DataSelectorDataBucketPicker";
import { DataSelectorDatabasePicker } from "./DataSelectorDatabasePicker";
@@ -41,9 +59,11 @@ import {
FieldTrigger,
TableTrigger,
Trigger,
+ type TriggerComponentProps,
} from "./TriggerComponents";
import { CONTAINER_WIDTH, DATA_BUCKET } from "./constants";
import { SavedEntityPicker } from "./saved-entity-picker/SavedEntityPicker";
+import type { DataPickerDataType } from "./types";
import { getDataTypes } from "./utils";
// chooses a data source bucket (datasets / raw data (tables) / saved questions)
@@ -57,7 +77,138 @@ const TABLE_STEP = "TABLE";
// chooses a table field (table has already been selected)
const FIELD_STEP = "FIELD";
-export function DataSourceSelector(props) {
+type DataSelectorStep =
+ | typeof DATA_BUCKET_STEP
+ | typeof DATABASE_STEP
+ | typeof SCHEMA_STEP
+ | typeof TABLE_STEP
+ | typeof FIELD_STEP;
+
+// The trimmed search response withAvailableModels hands to connect; only its
+// `available_models` field is read, but it carries the rest of the payload.
+type AvailableModelsResult = Omit<SearchResponse, "data">;
+
+export interface DataSelectorOwnProps {
+ steps: DataSelectorStep[];
+ combineDatabaseSchemaSteps?: boolean;
+ getTriggerElementContent?: ComponentType<TriggerComponentProps>;
+ triggerElement?: ReactNode;
+ triggerIconSize?: number;
+ triggerClasses?: string;
+ containerClassName?: string;
+ className?: string;
+ style?: CSSProperties;
+ isMantine?: boolean;
+ isPopover?: boolean;
+ isInitiallyOpen?: boolean;
+ isOpen?: boolean;
+ readOnly?: boolean;
+ onClose?: () => void;
+ hasTriggerExpandControl?: boolean;
+
+ selectedDataBucketId?: DataPickerDataType | null;
+ selectedDatabaseId?: DatabaseId | null;
+ selectedSchemaId?: SchemaId | null;
+ selectedTableId?: TableId | null;
+ selectedFieldId?: FieldId | FieldReference | null;
+ selectedCollectionId?: CollectionId;
+
+ databaseQuery?: ListDatabasesRequest;
+ // TODO(dataselector-api-vs-metabase-lib-casts): these entity props are typed
+ // as metabase-lib classes, but some consumers pass plain metabase-types/api
+ // entities and cast. Replace with minimal structural interfaces (threaded
+ // through the pickers) so both representations type-check without casts.
+ databases?: Database[];
+ schemas?: Schema[];
+ tables?: Table[];
+ fields?: Field[];
+
+ setDatabaseFn?: (databaseId: DatabaseId) => void;
+ setFieldFn?: (fieldId: FieldId) => void;
+ setSourceTableFn?: (tableId: TableId, databaseId?: DatabaseId) => void;
+ tableFilter?: (table: Table) => boolean;
+ fieldFilter?: (field: Field) => boolean;
+ databaseIsDisabled?: (database: Database) => boolean;
+ databaseDisabledTooltip?: (database: Database) => string | undefined;
+
+ canChangeDatabase?: boolean;
+ canSelectModel?: boolean;
+ canSelectTable?: boolean;
+ canSelectMetric?: boolean;
+ canSelectSavedQuestion?: boolean;
+ useOnlyAvailableDatabase?: boolean;
+ useOnlyAvailableSchema?: boolean;
+}
+
+interface DataSelectorStateProps {
+ availableModels: SearchModel[];
+ metadata: Metadata;
+ databases: Database[];
+ hasLoadedDatabasesWithTablesSaved: boolean;
+ hasLoadedDatabasesWithSaved: boolean;
+ hasLoadedDatabasesWithTables: boolean;
+ hasDataAccess: boolean;
+ hasNestedQueriesEnabled: boolean;
+ selectedQuestion: Question | null;
+}
+
+interface DataSelectorDispatchProps {
+ fetchDatabases: (databaseQuery?: ListDatabasesRequest) => Promise<unknown>;
+ fetchFields: (tableId: TableId) => Promise<unknown>;
+ fetchQuestion: (id: TableId) => Promise<unknown>;
+}
+
+interface SchemaFetchersProps {
+ fetchSchemas: (databaseId: DatabaseId) => Promise<unknown>;
+ fetchSchemaTables: (schemaId: SchemaId) => Promise<unknown>;
+}
+
+interface AvailableModelsInjectedProps {
+ loading: boolean;
+ loaded: boolean;
+ allLoading: boolean;
+}
+
+type DataSelectorProps = DataSelectorOwnProps &
+ DataSelectorStateProps &
+ DataSelectorDispatchProps &
+ SchemaFetchersProps &
+ AvailableModelsInjectedProps;
+
+interface ComputedDataSelectorState {
+ databases: Database[];
+ selectedDatabase: Database | null;
+ schemas: Schema[];
+ selectedSchema: Schema | null;
+ tables: Table[];
+ selectedTable: Table | null;
+ fields: Field[];
+ selectedField: Field | null;
+}
+
+interface DataSelectorState extends ComputedDataSelectorState {
+ activeStep: DataSelectorStep | null;
+ isLoading: boolean;
+ isError: boolean;
+ isPopoverOpen: boolean;
+ isSavedEntityPickerShown: boolean;
+ savedEntityType: CardType | null;
+ selectedDataBucketId: DataPickerDataType | null;
+ selectedDatabaseId: DatabaseId | null;
+ selectedSchemaId: SchemaId | null;
+ selectedTableId: TableId | null;
+ selectedFieldId: FieldId | FieldReference | null;
+}
+
+type SelectedIdsState = Pick<
+ DataSelectorState,
+ | "selectedDatabaseId"
+ | "selectedSchemaId"
+ | "selectedTableId"
+ | "selectedFieldId"
+>;
+
+export function DataSourceSelector(props: Omit<DataSelectorOwnProps, "steps">) {
return (
<DataSelector
steps={[DATA_BUCKET_STEP, DATABASE_STEP, SCHEMA_STEP, TABLE_STEP]}
@@ -68,7 +219,9 @@ export function DataSourceSelector(props) {
);
}
-export function DatabaseDataSelector(props) {
+export function DatabaseDataSelector(
+ props: Omit<DataSelectorOwnProps, "steps">,
+) {
return (
<DataSelector
steps={[DATABASE_STEP]}
@@ -78,7 +231,9 @@ export function DatabaseDataSelector(props) {
);
}
-export function DatabaseSchemaAndTableDataSelector(props) {
+export function DatabaseSchemaAndTableDataSelector(
+ props: Omit<DataSelectorOwnProps, "steps">,
+) {
return (
<DataSelector
steps={[DATABASE_STEP, SCHEMA_STEP, TABLE_STEP]}
@@ -89,7 +244,9 @@ export function DatabaseSchemaAndTableDataSelector(props) {
);
}
-export function SchemaAndTableDataSelector(props) {
+export function SchemaAndTableDataSelector(
+ props: Omit<DataSelectorOwnProps, "steps">,
+) {
return (
<DataSelector
steps={[SCHEMA_STEP, TABLE_STEP]}
@@ -99,7 +256,9 @@ export function SchemaAndTableDataSelector(props) {
);
}
-export function SchemaTableAndFieldDataSelector(props) {
+export function SchemaTableAndFieldDataSelector(
+ props: Omit<DataSelectorOwnProps, "steps">,
+) {
return (
<DataSelector
steps={[SCHEMA_STEP, TABLE_STEP, FIELD_STEP]}
@@ -111,7 +270,7 @@ export function SchemaTableAndFieldDataSelector(props) {
);
}
-export function FieldDataSelector(props) {
+export function FieldDataSelector(props: Omit<DataSelectorOwnProps, "steps">) {
return (
<DataSelector
steps={[FIELD_STEP]}
@@ -121,78 +280,14 @@ export function FieldDataSelector(props) {
);
}
-export class UnconnectedDataSelector extends Component {
- constructor(props) {
- super();
-
- const state = {
- selectedDataBucketId: props.selectedDataBucketId,
- selectedDatabaseId: props.selectedDatabaseId,
- selectedSchemaId: props.selectedSchemaId,
- selectedTableId: props.selectedTableId,
- selectedFieldId: props.selectedFieldId,
- isSavedEntityPickerShown: false,
- savedEntityType: null,
- isPopoverOpen: props.isInitiallyOpen && !props.readOnly,
- };
- const computedState = this._getComputedState(props, state);
- this.state = {
- activeStep: null,
- isLoading: false,
- isError: false,
- ...state,
- ...computedState,
- };
- }
-
- static propTypes = {
- selectedDataBucketId: PropTypes.string,
- selectedDatabaseId: PropTypes.number,
- selectedSchemaId: PropTypes.string,
- selectedTableId: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
- selectedFieldId: PropTypes.number,
- databases: PropTypes.array.isRequired,
- setDatabaseFn: PropTypes.func,
- setFieldFn: PropTypes.func,
- setSourceTableFn: PropTypes.func,
- hideSingleSchema: PropTypes.bool,
- hideSingleDatabase: PropTypes.bool,
- useOnlyAvailableDatabase: PropTypes.bool,
- useOnlyAvailableSchema: PropTypes.bool,
- isInitiallyOpen: PropTypes.bool,
- tableFilter: PropTypes.func,
- fieldFilter: PropTypes.func,
- canChangeDatabase: PropTypes.bool,
- containerClassName: PropTypes.string,
- canSelectModel: PropTypes.bool,
- canSelectTable: PropTypes.bool,
- canSelectMetric: PropTypes.bool,
- canSelectSavedQuestion: PropTypes.bool,
- databaseIsDisabled: PropTypes.func,
- databaseDisabledTooltip: PropTypes.func,
-
- // from search entity list loader
- allError: PropTypes.bool,
- allFetched: PropTypes.bool,
- allLoaded: PropTypes.bool,
- allLoading: PropTypes.bool,
- loaded: PropTypes.bool,
- loading: PropTypes.bool,
- fetched: PropTypes.bool,
- fetch: PropTypes.func,
- create: PropTypes.func,
- update: PropTypes.func,
- delete: PropTypes.func,
- reload: PropTypes.func,
- list: PropTypes.arrayOf(PropTypes.object),
- };
-
+export class UnconnectedDataSelector extends Component<
+ DataSelectorProps,
+ DataSelectorState
+> {
static defaultProps = {
isInitiallyOpen: false,
useOnlyAvailableDatabase: true,
useOnlyAvailableSchema: true,
- hideSingleSchema: true,
- hideSingleDatabase: false,
canChangeDatabase: true,
hasTriggerExpandControl: true,
isPopover: true,
@@ -203,6 +298,34 @@ export class UnconnectedDataSelector extends Component {
canSelectSavedQuestion: true,
};
+ constructor(props: DataSelectorProps) {
+ super(props);
+
+ const state: SelectedIdsState & {
+ selectedDataBucketId: DataPickerDataType | null;
+ isSavedEntityPickerShown: boolean;
+ savedEntityType: CardType | null;
+ isPopoverOpen: boolean;
+ } = {
+ selectedDataBucketId: props.selectedDataBucketId ?? null,
+ selectedDatabaseId: props.selectedDatabaseId ?? null,
+ selectedSchemaId: props.selectedSchemaId ?? null,
+ selectedTableId: props.selectedTableId ?? null,
+ selectedFieldId: props.selectedFieldId ?? null,
+ isSavedEntityPickerShown: false,
+ savedEntityType: null,
+ isPopoverOpen: Boolean(props.isInitiallyOpen && !props.readOnly),
+ };
+ const computedState = this._getComputedState(props, state);
+ this.state = {
+ activeStep: null,
+ isLoading: false,
+ isError: false,
+ ...state,
+ ...computedState,
+ };
+ }
+
isPopoverOpen() {
// If the isOpen prop is passed in, use the controlled value.
if (typeof this.props.isOpen === "boolean") {
@@ -225,7 +348,10 @@ export class UnconnectedDataSelector extends Component {
// each time rather than storing the object itself in case new metadata is
// asynchronously loaded
//
- _getComputedState(props, state) {
+ _getComputedState(
+ props: DataSelectorProps,
+ state: SelectedIdsState,
+ ): ComputedDataSelectorState {
const { metadata, tableFilter, fieldFilter } = props;
const {
selectedDatabaseId,
@@ -235,67 +361,68 @@ export class UnconnectedDataSelector extends Component {
} = state;
let { databases, schemas, tables, fields } = props;
- let selectedDatabase = null,
- selectedSchema = null,
- selectedTable = null,
- selectedField = null;
+ let selectedDatabase: Database | null = null;
+ let selectedSchema: Schema | null = null;
+ let selectedTable: Table | null = null;
+ let selectedField: Field | null = null;
- const getDatabase = (id) =>
+ const getDatabase = (id: DatabaseId) =>
_.findWhere(databases, { id }) || metadata.database(id);
- const getSchema = (id) =>
- _.findWhere(schemas, { id }) || metadata.schema(id);
- const getTable = (id) => _.findWhere(tables, { id }) || metadata.table(id);
- const getField = (id) => _.findWhere(fields, { id }) || metadata.field(id);
-
- function setSelectedDatabase(database) {
- selectedDatabase = database;
+ const getSchema = (id: SchemaId) =>
+ _.findWhere(schemas ?? [], { id }) || metadata.schema(id);
+ const getTable = (id: TableId) =>
+ _.findWhere(tables ?? [], { id }) || metadata.table(id);
+ const getField = (id: FieldId | FieldReference) =>
+ _.findWhere(fields ?? [], { id }) || metadata.field(id);
+
+ const deriveFromDatabase = (database: Database | null) => {
if (!schemas && database) {
schemas = database.schemas;
}
if (!tables && Array.isArray(schemas) && schemas.length === 1) {
tables = schemas[0].tables;
}
- }
+ };
- function setSelectedSchema(schema) {
- selectedSchema = schema;
+ const deriveFromSchema = (schema: Schema | null) => {
if (!tables && schema) {
tables = schema.tables;
}
- }
+ };
- function setSelectedTable(table) {
- selectedTable = table;
+ const deriveFromTable = (table: Table | null) => {
if (!fields && table) {
fields = table.fields;
}
- }
-
- function setSelectedField(field) {
- selectedField = field;
- }
+ };
if (selectedDatabaseId != null) {
- setSelectedDatabase(getDatabase(selectedDatabaseId));
+ selectedDatabase = getDatabase(selectedDatabaseId) ?? null;
+ deriveFromDatabase(selectedDatabase);
}
if (selectedSchemaId != null && selectedDatabaseId) {
- setSelectedSchema(getSchema(selectedSchemaId));
+ selectedSchema = getSchema(selectedSchemaId) ?? null;
+ deriveFromSchema(selectedSchema);
}
if (selectedTableId != null) {
- setSelectedTable(getTable(selectedTableId));
+ selectedTable = getTable(selectedTableId) ?? null;
+ deriveFromTable(selectedTable);
}
if (selectedFieldId != null) {
- setSelectedField(getField(selectedFieldId));
+ selectedField = getField(selectedFieldId) ?? null;
}
// now do it in in reverse to propagate it back up
if (!selectedTable && selectedField) {
- setSelectedTable(selectedField.table);
+ selectedTable = selectedField.table ?? null;
+ deriveFromTable(selectedTable);
}
if (!selectedSchema && selectedTable) {
- setSelectedSchema(selectedTable.schema);
+ selectedSchema = selectedTable.schema ?? null;
+ deriveFromSchema(selectedSchema);
}
if (!selectedDatabase && selectedSchema) {
- setSelectedDatabase(selectedSchema.database);
+ selectedDatabase = selectedSchema.database ?? null;
+ deriveFromDatabase(selectedDatabase);
}
if (tables && tableFilter) {
@@ -308,42 +435,59 @@ export class UnconnectedDataSelector extends Component {
return {
databases: databases || [],
- selectedDatabase: selectedDatabase,
+ selectedDatabase: selectedDatabase ?? null,
schemas: schemas || [],
- selectedSchema: selectedSchema,
+ selectedSchema: selectedSchema ?? null,
tables: tables || [],
- selectedTable: selectedTable,
+ selectedTable: selectedTable ?? null,
fields: fields || [],
- selectedField: selectedField,
+ selectedField: selectedField ?? null,
};
}
// Like setState, but automatically adds computed state so we don't have to recalculate
// repeatedly. Also returns a promise resolves after state is updated
- setStateWithComputedState(newState, newProps = this.props) {
+ setStateWithComputedState(
+ newState: Partial<DataSelectorState>,
+ newProps: DataSelectorProps = this.props,
+ ): Promise<void> {
return new Promise((resolve) => {
const computedState = this._getComputedState(newProps, {
...this.state,
...newState,
});
- this.setState({ ...newState, ...computedState }, resolve);
+ this.setState(
+ (prevState) => ({ ...prevState, ...newState, ...computedState }),
+ resolve,
+ );
});
}
- UNSAFE_componentWillReceiveProps(nextProps) {
- const newState = {};
- for (const propName of [
- "selectedDatabaseId",
- "selectedSchemaId",
- "selectedTableId",
- "selectedFieldId",
- ]) {
- if (
- nextProps[propName] !== this.props[propName] &&
- this.state[propName] !== nextProps[propName]
- ) {
- newState[propName] = nextProps[propName];
- }
+ UNSAFE_componentWillReceiveProps(nextProps: DataSelectorProps) {
+ const newState: Partial<DataSelectorState> = {};
+ if (
+ nextProps.selectedDatabaseId !== this.props.selectedDatabaseId &&
+ this.state.selectedDatabaseId !== nextProps.selectedDatabaseId
+ ) {
+ newState.selectedDatabaseId = nextProps.selectedDatabaseId ?? null;
+ }
+ if (
+ nextProps.selectedSchemaId !== this.props.selectedSchemaId &&
+ this.state.selectedSchemaId !== nextProps.selectedSchemaId
+ ) {
+ newState.selectedSchemaId = nextProps.selectedSchemaId ?? null;
+ }
+ if (
+ nextProps.selectedTableId !== this.props.selectedTableId &&
+ this.state.selectedTableId !== nextProps.selectedTableId
+ ) {
+ newState.selectedTableId = nextProps.selectedTableId ?? null;
+ }
+ if (
+ nextProps.selectedFieldId !== this.props.selectedFieldId &&
+ this.state.selectedFieldId !== nextProps.selectedFieldId
+ ) {
+ newState.selectedFieldId = nextProps.selectedFieldId ?? null;
}
if (Object.keys(newState).length > 0) {
this.setStateWithComputedState(newState, nextProps);
@@ -381,7 +525,7 @@ export class UnconnectedDataSelector extends Component {
}
}
- async componentDidUpdate(prevProps) {
+ async componentDidUpdate(prevProps: DataSelectorProps) {
const { allLoading } = this.props;
const loadedDatasets = prevProps.allLoading && !allLoading;
@@ -422,12 +566,12 @@ export class UnconnectedDataSelector extends Component {
selectedSchema &&
selectedTable &&
!isVirtualCardId(selectedTable.id) &&
- selectedTable.schema.id !== selectedSchema.id;
+ selectedTable.schema?.id !== selectedSchema.id;
const invalidField =
selectedTable &&
selectedField &&
- selectedField.table.id !== selectedTable.id;
+ selectedField.table?.id !== selectedTable.id;
// A database with a single schema auto-selects it (see `skipSteps`). When the
// schema list arrives asynchronously *after* we already switched to the schema
@@ -467,7 +611,7 @@ export class UnconnectedDataSelector extends Component {
return this.props.loading;
};
- getCardType() {
+ getCardType(): CardType {
const { selectedDataBucketId, savedEntityType } = this.state;
switch (true) {
case selectedDataBucketId === DATA_BUCKET.MODELS ||
@@ -483,7 +627,7 @@ export class UnconnectedDataSelector extends Component {
hasModels = () => {
const { availableModels, canSelectModel, loaded } = this.props;
- return loaded && canSelectModel && availableModels.includes("dataset");
+ return loaded && !!canSelectModel && availableModels.includes("dataset");
};
hasUsableModels = () => {
@@ -493,7 +637,7 @@ export class UnconnectedDataSelector extends Component {
hasMetrics = () => {
const { availableModels, canSelectMetric, loaded } = this.props;
- return loaded && canSelectMetric && availableModels.includes("metric");
+ return loaded && !!canSelectMetric && availableModels.includes("metric");
};
hasUsableMetrics = () => {
@@ -509,7 +653,7 @@ export class UnconnectedDataSelector extends Component {
const { canSelectSavedQuestion } = this.props;
return (
this.state.databases.some((database) => database.is_saved_questions) &&
- canSelectSavedQuestion
+ !!canSelectSavedQuestion
);
};
@@ -593,13 +737,13 @@ export class UnconnectedDataSelector extends Component {
}
}
- getNextStep() {
+ getNextStep(): DataSelectorStep | null {
const { steps } = this.props;
- const index = steps.indexOf(this.state.activeStep);
+ const index = steps.findIndex((step) => step === this.state.activeStep);
return index < steps.length - 1 ? steps[index + 1] : null;
}
- getPreviousStep() {
+ getPreviousStep(): DataSelectorStep | null {
const { steps } = this.props;
const { activeStep } = this.state;
if (this.isSearchLoading() || activeStep === null) {
@@ -642,7 +786,10 @@ export class UnconnectedDataSelector extends Component {
});
};
- nextStep = async (stateChange = {}, skipSteps = true) => {
+ nextStep = async (
+ stateChange: Partial<DataSelectorState> = {},
+ skipSteps = true,
+ ) => {
const nextStep = this.getNextStep();
if (!nextStep) {
await this.setStateWithComputedState({
@@ -662,7 +809,7 @@ export class UnconnectedDataSelector extends Component {
}
};
- getClearedStateForStep(step) {
+ getClearedStateForStep(step: DataSelectorStep): Partial<DataSelectorState> {
if (step === DATA_BUCKET_STEP) {
return {
selectedDataBucketId: null,
@@ -697,8 +844,11 @@ export class UnconnectedDataSelector extends Component {
return {};
}
- async loadStepData(stepName) {
- const loadersForSteps = {
+ async loadStepData(stepName: DataSelectorStep) {
+ const loadersForSteps: Record<
+ DataSelectorStep,
+ (() => Promise<unknown> | undefined) | undefined
+ > = {
// NOTE: make sure to return the action's resulting promise
[DATA_BUCKET_STEP]: () => {
return Promise.all([
@@ -715,14 +865,16 @@ export class UnconnectedDataSelector extends Component {
[SCHEMA_STEP]: () => {
return Promise.all([
this.props.fetchDatabases(this.props.databaseQuery),
- this.props.fetchSchemas(this.state.selectedDatabaseId),
+ this.state.selectedDatabaseId != null
+ ? this.props.fetchSchemas(this.state.selectedDatabaseId)
+ : undefined,
]);
},
[TABLE_STEP]: () => {
if (this.state.selectedSchemaId != null) {
return this.props.fetchSchemaTables(this.state.selectedSchemaId);
} else if (this.state.selectedSchema?.id != null) {
- return this.props.fetchSchemaTables(this.state.selectedSchema?.id);
+ return this.props.fetchSchemaTables(this.state.selectedSchema.id);
}
},
[FIELD_STEP]: () => {
@@ -732,13 +884,14 @@ export class UnconnectedDataSelector extends Component {
},
};
- if (loadersForSteps[stepName]) {
+ const loader = loadersForSteps[stepName];
+ if (loader) {
try {
await this.setStateWithComputedState({
isLoading: true,
isError: false,
});
- await loadersForSteps[stepName]();
+ await loader();
await this.setStateWithComputedState({
isLoading: false,
isError: false,
@@ -752,7 +905,7 @@ export class UnconnectedDataSelector extends Component {
}
}
- hasPreloadedStepData(stepName) {
+ hasPreloadedStepData(stepName: DataSelectorStep): boolean {
const {
hasLoadedDatabasesWithTables,
hasLoadedDatabasesWithTablesSaved,
@@ -764,14 +917,19 @@ export class UnconnectedDataSelector extends Component {
return (
hasLoadedDatabasesWithTablesSaved ||
(hasLoadedDatabasesWithTables &&
- !this.state.selectedDatabase.is_saved_questions)
+ !this.state.selectedDatabase?.is_saved_questions)
);
} else if (stepName === FIELD_STEP) {
return this.state.fields.length > 0;
}
+ return false;
}
- switchToStep = async (stepName, stateChange = {}, skipSteps = true) => {
+ switchToStep = async (
+ stepName: DataSelectorStep,
+ stateChange: Partial<DataSelectorState> = {},
+ skipSteps = true,
+ ) => {
await this.setStateWithComputedState({
...stateChange,
activeStep: stepName,
@@ -784,13 +942,13 @@ export class UnconnectedDataSelector extends Component {
}
};
- showSavedEntityPicker = ({ entityType }) =>
+ showSavedEntityPicker = ({ entityType }: { entityType?: CardType }) =>
this.setState({
isSavedEntityPickerShown: true,
- savedEntityType: entityType,
+ savedEntityType: entityType ?? null,
});
- onChangeDataBucket = async (selectedDataBucketId) => {
+ onChangeDataBucket = async (selectedDataBucketId: DataPickerDataType) => {
if (selectedDataBucketId === DATA_BUCKET.RAW_DATA) {
await this.switchToStep(DATABASE_STEP, { selectedDataBucketId });
return;
@@ -808,14 +966,14 @@ export class UnconnectedDataSelector extends Component {
}
};
- onChangeDatabase = async (database) => {
+ onChangeDatabase = async (database: Database) => {
if (database.is_saved_questions) {
this.showSavedEntityPicker({ entityType: "question" });
return;
}
if (this.props.setDatabaseFn) {
- this.props.setDatabaseFn(database && database.id);
+ this.props.setDatabaseFn(database.id);
}
if (this.state.selectedDatabaseId != null) {
@@ -826,26 +984,27 @@ export class UnconnectedDataSelector extends Component {
await this.nextStep({ selectedDatabaseId: database && database.id });
};
- onChangeSchema = async (schema) => {
+ onChangeSchema = async (schema?: Schema) => {
// NOTE: not really any need to have a setSchemaFn since schemas are just a namespace
- await this.nextStep({ selectedSchemaId: schema && schema.id });
+ await this.nextStep({ selectedSchemaId: schema?.id ?? null });
};
- onChangeTable = async (table) => {
- if (this.props.setSourceTableFn) {
- this.props.setSourceTableFn(table?.id, table?.db_id);
+ onChangeTable = async (table?: Table) => {
+ if (this.props.setSourceTableFn && table?.id != null) {
+ this.props.setSourceTableFn(table.id, table.db_id);
}
- await this.nextStep({ selectedTableId: table?.id });
+ await this.nextStep({ selectedTableId: table?.id ?? null });
};
- onChangeField = async (field) => {
- if (this.props.setFieldFn) {
- this.props.setFieldFn(field?.id);
+ onChangeField = async (field?: Field) => {
+ const fieldId = field?.id;
+ if (this.props.setFieldFn && typeof fieldId === "number") {
+ this.props.setFieldFn(fieldId);
}
- await this.nextStep({ selectedFieldId: field?.id });
+ await this.nextStep({ selectedFieldId: fieldId ?? null });
};
- getTriggerElement = (triggerProps) => {
+ getTriggerElement = (triggerProps?: Partial<TriggerComponentProps>) => {
const {
className,
style,
@@ -871,12 +1030,14 @@ export class UnconnectedDataSelector extends Component {
iconSize={isMantine ? "1rem" : triggerIconSize}
isMantine={isMantine}
>
- <TriggerComponent
- database={selectedDatabase}
- table={selectedTable}
- field={selectedField}
- {...triggerProps}
- />
+ {TriggerComponent && (
+ <TriggerComponent
+ database={selectedDatabase}
+ table={selectedTable}
+ field={selectedField}
+ {...triggerProps}
+ />
+ )}
</Trigger>
);
};
@@ -912,9 +1073,14 @@ export class UnconnectedDataSelector extends Component {
steps.includes(DATA_BUCKET_STEP) &&
this.hasUsableModelsOrMetrics();
- const props = {
+ const stepProps = {
...this.state,
databases: this.getDatabases(),
+ selectedDatabase: this.state.selectedDatabase ?? undefined,
+ selectedSchema: this.state.selectedSchema ?? undefined,
+ selectedTable: this.state.selectedTable ?? undefined,
+ selectedField: this.state.selectedField ?? undefined,
+ selectedSchemaId: this.state.selectedSchemaId ?? undefined,
onChangeDataBucket: this.onChangeDataBucket,
onChangeDatabase: this.onChangeDatabase,
@@ -925,7 +1091,7 @@ export class UnconnectedDataSelector extends Component {
// misc
isLoading: this.state.isLoading,
hasNextStep,
- onBack: hasPreviousStep ? this.previousStep : null,
+ onBack: hasPreviousStep ? this.previousStep : undefined,
hasFiltering: true,
hasInitialFocus: true,
databaseIsDisabled: this.props.databaseIsDisabled,
@@ -939,37 +1105,37 @@ export class UnconnectedDataSelector extends Component {
<DataSelectorDataBucketPicker
dataTypes={getDataTypes({
hasModels: this.hasModels(),
- hasTables: this.props.canSelectTable,
+ hasTables: !!this.props.canSelectTable,
hasNestedQueriesEnabled,
hasSavedQuestions: this.hasSavedQuestions(),
hasMetrics: this.hasMetrics(),
})}
- {...props}
+ {...stepProps}
/>
</Box>
);
case DATABASE_STEP:
return combineDatabaseSchemaSteps ? (
<DataSelectorDatabaseSchemaPicker
- {...props}
+ {...stepProps}
hasBackButton={hasBackButton}
/>
) : (
- <DataSelectorDatabasePicker {...props} />
+ <DataSelectorDatabasePicker {...stepProps} />
);
case SCHEMA_STEP:
return combineDatabaseSchemaSteps ? (
<DataSelectorDatabaseSchemaPicker
- {...props}
+ {...stepProps}
hasBackButton={hasBackButton}
/>
) : (
- <DataSelectorSchemaPicker {...props} />
+ <DataSelectorSchemaPicker {...stepProps} />
);
case TABLE_STEP:
- return <DataSelectorTablePicker {...props} />;
+ return <DataSelectorTablePicker {...stepProps} />;
case FIELD_STEP:
- return <DataSelectorFieldPicker {...props} />;
+ return <DataSelectorFieldPicker {...stepProps} />;
}
return null;
@@ -977,11 +1143,11 @@ export class UnconnectedDataSelector extends Component {
isSavedEntitySelected = () => isVirtualCardId(this.props.selectedTableId);
- handleSavedEntitySelect = async (tableOrCardId) => {
+ handleSavedEntitySelect = async (tableOrCardId: string) => {
await this.props.fetchFields(tableOrCardId);
if (this.props.setSourceTableFn) {
const table = this.props.metadata.table(tableOrCardId);
- this.props.setSourceTableFn(tableOrCardId, table.db_id);
+ this.props.setSourceTableFn(tableOrCardId, table?.db_id);
}
this.togglePopoverOpen();
this.handleClose();
@@ -1027,7 +1193,11 @@ export class UnconnectedDataSelector extends Component {
<SavedEntityPicker
collectionId={selectedCollectionId}
type={this.getCardType()}
- tableId={selectedTable?.id}
+ tableId={
+ typeof selectedTable?.id === "string"
+ ? selectedTable.id
+ : undefined
+ }
databaseId={currentDatabaseId}
onSelect={this.handleSavedEntitySelect}
onBack={this.handleSavedEntityPickerClose}
@@ -1083,22 +1253,32 @@ export class UnconnectedDataSelector extends Component {
}
}
+type ConnectOwnProps = DataSelectorOwnProps &
+ SchemaFetchersProps &
+ AvailableModelsInjectedProps & {
+ availableModelsResult?: AvailableModelsResult;
+ };
+
+type WithoutSchemaFetchers = Omit<ConnectOwnProps, keyof SchemaFetchersProps>;
+
// Exposes `fetchSchemas` / `fetchSchemaTables` as props backed by RTK's lazy
// query triggers. The triggers' subscriptions are tied to this wrapper's
// lifecycle, so the cache is released when the DataSelector unmounts.
-function withSchemaFetchers(WrappedComponent) {
- return function DataSelectorWithSchemaFetchers(props) {
+function withSchemaFetchers(
+ WrappedComponent: ComponentType<ConnectOwnProps>,
+): ComponentType<WithoutSchemaFetchers> {
+ return function DataSelectorWithSchemaFetchers(props: WithoutSchemaFetchers) {
const [triggerListSchemas] = useLazyListDatabaseSchemasQuery();
const [triggerListSchemaTables] = useLazyListDatabaseSchemaTablesQuery();
const fetchSchemas = useCallback(
- (databaseId) =>
+ (databaseId: DatabaseId) =>
triggerListSchemas({ id: databaseId, "can-query": true }).unwrap(),
[triggerListSchemas],
);
const fetchSchemaTables = useCallback(
- (schemaId) => {
+ (schemaId: SchemaId) => {
const [dbId, schema] = parseSchemaId(schemaId);
return triggerListSchemaTables({
id: dbId,
@@ -1121,97 +1301,111 @@ function withSchemaFetchers(WrappedComponent) {
// If there is at least one model or metric, we want to display a slightly
// different data picker view (see DATA_BUCKET step). Pre-fetches available
-// models via search and exposes them as `metadata`/`loading`/`loaded` props.
-function withAvailableModels(WrappedComponent) {
- return function DataSelectorWithAvailableModels(props) {
+// models via search and exposes them as `availableModelsResult`/`loading`/`loaded` props.
+function withAvailableModels(
+ WrappedComponent: ComponentType<WithoutSchemaFetchers>,
+): ComponentType<DataSelectorOwnProps> {
+ return function DataSelectorWithAvailableModels(props: DataSelectorOwnProps) {
const { data: response, isLoading } = useSearchQuery({
calculate_available_models: true,
limit: 0,
models: ["dataset", "metric"],
context: "data-picker",
});
- let metadata;
+ let availableModelsResult: AvailableModelsResult | undefined;
if (response) {
const { data: _data, ...rest } = response;
- metadata = rest;
+ availableModelsResult = rest;
}
return (
<WrappedComponent
{...props}
- metadata={metadata}
+ availableModelsResult={availableModelsResult}
loading={isLoading}
loaded={!isLoading && response != null}
- allLoading={isLoading || (props.allLoading ?? false)}
+ allLoading={isLoading}
/>
);
};
}
-function withDatabaseList(WrappedComponent) {
- return function DataSelectorWithDatabaseList(props) {
+function withDatabaseList(
+ WrappedComponent: ComponentType<DataSelectorOwnProps>,
+): ComponentType<DataSelectorOwnProps> {
+ return function DataSelectorWithDatabaseList(props: DataSelectorOwnProps) {
useListDatabasesQuery({ "can-query": true });
return <WrappedComponent {...props} />;
};
}
-const isListDatabasesQuerySuccess = (state, query) =>
- databaseApi.endpoints.listDatabases.select(query)(state).isSuccess;
-
-const DataSelector = _.compose(
- withDatabaseList,
- withAvailableModels,
- withSchemaFetchers,
- connect(
- (state, ownProps) => {
- const databaseQuery = { ...ownProps.databaseQuery, "can-query": true };
- const queriedDatabases =
- databaseApi.endpoints.listDatabases.select(databaseQuery)(state).data
- ?.data;
- const metadata = getMetadata(state);
- return {
- availableModels: ownProps.metadata?.available_models ?? [],
- metadata,
- databases:
- ownProps.databases ||
- queriedDatabases
- ?.map(({ id }) => metadata.database(id))
- .filter((database) => database != null) ||
- [],
- hasLoadedDatabasesWithTablesSaved: isListDatabasesQuerySuccess(state, {
- include: "tables",
- saved: true,
- "can-query": true,
- }),
- hasLoadedDatabasesWithSaved: isListDatabasesQuerySuccess(state, {
- saved: true,
- "can-query": true,
- }),
- hasLoadedDatabasesWithTables: isListDatabasesQuerySuccess(state, {
- include: "tables",
- "can-query": true,
- }),
- hasDataAccess: canUserCreateQueries(state),
- hasNestedQueriesEnabled: getSetting(state, "enable-nested-queries"),
- selectedQuestion: getMetadata(state).question(
- getQuestionIdFromVirtualTableId(ownProps.selectedTableId),
- ),
- };
- },
- (dispatch) => ({
- fetchDatabases: (databaseQuery) =>
- runRtkEndpoint(
- { ...databaseQuery, "can-query": true },
- dispatch,
- databaseApi.endpoints.listDatabases,
- { forceRefetch: false },
- ),
- fetchFields: (tableId) => dispatch(fetchTableMetadata({ id: tableId })),
- fetchQuestion: (id) =>
- runRtkEndpoint(
- { id: getQuestionIdFromVirtualTableId(id) },
- dispatch,
- cardApi.endpoints.getCard,
- ),
+const isListDatabasesQuerySuccess = (
+ state: State,
+ query: ListDatabasesRequest,
+) => databaseApi.endpoints.listDatabases.select(query)(state).isSuccess;
+
+const mapStateToProps = (
+ state: State,
+ ownProps: ConnectOwnProps,
+): DataSelectorStateProps => {
+ const databaseQuery: ListDatabasesRequest = {
+ ...ownProps.databaseQuery,
+ "can-query": true,
+ };
+ const queriedDatabases =
+ databaseApi.endpoints.listDatabases.select(databaseQuery)(state).data?.data;
+ const metadata = getMetadata(state);
+ return {
+ availableModels: ownProps.availableModelsResult?.available_models ?? [],
+ metadata,
+ databases:
+ ownProps.databases ||
+ queriedDatabases
+ ?.map(({ id }) => metadata.database(id))
+ .filter((database): database is Database => database != null) ||
+ [],
+ hasLoadedDatabasesWithTablesSaved: isListDatabasesQuerySuccess(state, {
+ include: "tables",
+ saved: true,
+ "can-query": true,
+ }),
+ hasLoadedDatabasesWithSaved: isListDatabasesQuerySuccess(state, {
+ saved: true,
+ "can-query": true,
}),
+ hasLoadedDatabasesWithTables: isListDatabasesQuerySuccess(state, {
+ include: "tables",
+ "can-query": true,
+ }),
+ hasDataAccess: canUserCreateQueries(state),
+ hasNestedQueriesEnabled: getSetting(state, "enable-nested-queries"),
+ selectedQuestion: getMetadata(state).question(
+ getQuestionIdFromVirtualTableId(ownProps.selectedTableId),
+ ),
+ };
+};
+
+const mapDispatchToProps = (dispatch: Dispatch): DataSelectorDispatchProps => ({
+ fetchDatabases: (databaseQuery) =>
+ runRtkEndpoint(
+ { ...databaseQuery, "can-query": true },
+ dispatch,
+ databaseApi.endpoints.listDatabases,
+ { forceRefetch: false },
+ ),
+ fetchFields: (tableId) =>
+ Promise.resolve(dispatch(fetchTableMetadata({ id: tableId }))),
+ fetchQuestion: (id) =>
+ runRtkEndpoint(
+ { id: getQuestionIdFromVirtualTableId(id) },
+ dispatch,
+ cardApi.endpoints.getCard,
+ ),
+});
+
+const DataSelector = withDatabaseList(
+ withAvailableModels(
+ withSchemaFetchers(
+ connect(mapStateToProps, mapDispatchToProps)(UnconnectedDataSelector),
+ ),
),
-)(UnconnectedDataSelector);
+);
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.unit.spec.js b/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.unit.spec.tsx
similarity index 89%
rename from frontend/src/metabase/querying/common/components/DataSelector/DataSelector.unit.spec.js
rename to frontend/src/metabase/querying/common/components/DataSelector/DataSelector.unit.spec.tsx
index c653d192c57..7af5c47364b 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.unit.spec.js
+++ b/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.unit.spec.tsx
@@ -1,4 +1,5 @@
import userEvent from "@testing-library/user-event";
+import type { ComponentProps } from "react";
import { createMockMetadata } from "__support__/metadata";
import { getIcon, render, renderWithProviders, screen } from "__support__/ui";
@@ -8,6 +9,8 @@ import {
createMockSettingsState,
createMockState,
} from "metabase/redux/store/mocks";
+import { checkNotNull } from "metabase/utils/types";
+import { SAVED_QUESTIONS_VIRTUAL_DB_ID } from "metabase-lib/v1/metadata/utils/saved-questions";
import {
createMockDatabase,
createMockSavedQuestionsDatabase,
@@ -18,6 +21,8 @@ import {
createSampleDatabase,
} from "metabase-types/api/mocks/presets";
+type DataSelectorProps = ComponentProps<typeof DataSelector>;
+
const MULTI_SCHEMA_DB_ID = 2;
const MULTI_SCHEMA_TABLE1_ID = 100;
const MULTI_SCHEMA_TABLE2_ID = 101;
@@ -80,18 +85,46 @@ describe("DataSelector", () => {
}),
});
- const SAMPLE_DATABASE = metadata.database(SAMPLE_DB_ID);
- const ANOTHER_DATABASE = metadata.database(EMPTY_DB_ID);
- const MULTI_SCHEMA_DATABASE = metadata.database(MULTI_SCHEMA_DB_ID);
- const OTHER_MULTI_SCHEMA_DATABASE = metadata.database(
- OTHER_MULTI_SCHEMA_DB_ID,
+ const SAMPLE_DATABASE = checkNotNull(metadata.database(SAMPLE_DB_ID));
+ const ANOTHER_DATABASE = checkNotNull(metadata.database(EMPTY_DB_ID));
+ const MULTI_SCHEMA_DATABASE = checkNotNull(
+ metadata.database(MULTI_SCHEMA_DB_ID),
+ );
+ const OTHER_MULTI_SCHEMA_DATABASE = checkNotNull(
+ metadata.database(OTHER_MULTI_SCHEMA_DB_ID),
);
- const SAVED_QUESTIONS_DATABASE = createMockSavedQuestionsDatabase();
+ const SAVED_QUESTIONS_DATABASE = checkNotNull(
+ createMockMetadata({
+ databases: [createMockSavedQuestionsDatabase()],
+ }).database(SAVED_QUESTIONS_VIRTUAL_DB_ID),
+ );
+
+ const defaultProps: DataSelectorProps = {
+ steps: ["DATABASE"],
+ metadata: emptyMetadata,
+ databases: [],
+ availableModels: [],
+ hasLoadedDatabasesWithTablesSaved: false,
+ hasLoadedDatabasesWithSaved: false,
+ hasLoadedDatabasesWithTables: false,
+ hasDataAccess: false,
+ hasNestedQueriesEnabled: false,
+ selectedQuestion: null,
+ loading: false,
+ loaded: false,
+ allLoading: false,
+ fetchDatabases: jest.fn(),
+ fetchFields: jest.fn(),
+ fetchQuestion: jest.fn(),
+ fetchSchemas: jest.fn(),
+ fetchSchemaTables: jest.fn(),
+ };
it("should allow selecting db, schema, and table", async () => {
const setTable = jest.fn();
render(
<DataSelector
+ {...defaultProps}
steps={["DATABASE", "SCHEMA", "TABLE"]}
combineDatabaseSchemaSteps
triggerElement={<div />}
@@ -141,7 +174,8 @@ describe("DataSelector", () => {
const fetchSchemas = jest.fn();
const fetchSchemaTables = jest.fn();
- const props = {
+ const props: DataSelectorProps = {
+ ...defaultProps,
steps: ["DATABASE", "SCHEMA", "TABLE"],
combineDatabaseSchemaSteps: true,
triggerElement: <div />,
@@ -156,7 +190,7 @@ describe("DataSelector", () => {
const { rerender } = render(<DataSelector {...props} />);
// we call rerenderWith to add more data after a fetch function was called
- const rerenderWith = (nextMetadata) => {
+ const rerenderWith = (nextMetadata: typeof metadata) => {
rerender(
<DataSelector
{...props}
@@ -208,6 +242,7 @@ describe("DataSelector", () => {
it("should skip db and schema steps if there's only one option", async () => {
render(
<DataSelector
+ {...defaultProps}
steps={["DATABASE", "SCHEMA", "TABLE"]}
combineDatabaseSchemaSteps
triggerElement={<div />}
@@ -234,7 +269,8 @@ describe("DataSelector", () => {
databases: [createMockDatabase({ id: SAMPLE_DB_ID, tables: [] })],
});
- const props = {
+ const props: DataSelectorProps = {
+ ...defaultProps,
steps: ["SCHEMA", "TABLE"],
selectedDatabaseId: SAMPLE_DB_ID,
triggerElement: <div />,
@@ -247,7 +283,7 @@ describe("DataSelector", () => {
const { rerender } = render(
<DataSelector
{...props}
- databases={[metadataWithoutTables.database(SAMPLE_DB_ID)]}
+ databases={[checkNotNull(metadataWithoutTables.database(SAMPLE_DB_ID))]}
metadata={metadataWithoutTables}
/>,
);
@@ -261,7 +297,7 @@ describe("DataSelector", () => {
rerender(
<DataSelector
{...props}
- databases={[metadata.database(SAMPLE_DB_ID)]}
+ databases={[checkNotNull(metadata.database(SAMPLE_DB_ID))]}
metadata={metadata}
/>,
);
@@ -273,6 +309,7 @@ describe("DataSelector", () => {
const fetchDatabases = jest.fn();
render(
<DataSelector
+ {...defaultProps}
steps={["DATABASE"]}
triggerElement={<div>button</div>}
metadata={emptyMetadata}
@@ -289,6 +326,7 @@ describe("DataSelector", () => {
it("should click into a single-schema db after expanding a multi-schema db", async () => {
render(
<DataSelector
+ {...defaultProps}
steps={["DATABASE", "SCHEMA", "TABLE"]}
combineDatabaseSchemaSteps
triggerElement={<div />}
@@ -308,6 +346,7 @@ describe("DataSelector", () => {
it("should expand multi-schema after clicking into single-schema", async () => {
render(
<DataSelector
+ {...defaultProps}
steps={["DATABASE", "SCHEMA", "TABLE"]}
combineDatabaseSchemaSteps
triggerElement={<div />}
@@ -337,6 +376,7 @@ describe("DataSelector", () => {
// which caused a bug that the previous test didn't catch.
render(
<DataSelector
+ {...defaultProps}
steps={["DATABASE", "SCHEMA", "TABLE"]}
combineDatabaseSchemaSteps
triggerElement={<div />}
@@ -368,6 +408,7 @@ describe("DataSelector", () => {
it("should collapse expanded list of db's schemas", async () => {
render(
<DataSelector
+ {...defaultProps}
steps={["DATABASE", "SCHEMA", "TABLE"]}
combineDatabaseSchemaSteps
triggerElement={<div />}
@@ -399,6 +440,7 @@ describe("DataSelector", () => {
it("should auto-advance past db and schema in field picker", async () => {
render(
<DataSelector
+ {...defaultProps}
steps={["SCHEMA", "TABLE", "FIELD"]}
selectedDatabaseId={SAMPLE_DATABASE.id}
databases={[SAMPLE_DATABASE]}
@@ -415,6 +457,7 @@ describe("DataSelector", () => {
it("should select schema in field picker", async () => {
render(
<DataSelector
+ {...defaultProps}
steps={["SCHEMA", "TABLE", "FIELD"]}
selectedDatabaseId={MULTI_SCHEMA_DATABASE.id}
databases={[MULTI_SCHEMA_DATABASE]}
@@ -431,6 +474,7 @@ describe("DataSelector", () => {
it("should open database picker with correct database selected", async () => {
render(
<DataSelector
+ {...defaultProps}
steps={["DATABASE"]}
databases={[SAMPLE_DATABASE, MULTI_SCHEMA_DATABASE]}
selectedDatabaseId={SAMPLE_DATABASE.id}
@@ -448,6 +492,7 @@ describe("DataSelector", () => {
it("should move between selected multi-schema dbs", async () => {
render(
<DataSelector
+ {...defaultProps}
steps={["DATABASE", "SCHEMA", "TABLE"]}
databases={[MULTI_SCHEMA_DATABASE, OTHER_MULTI_SCHEMA_DATABASE]}
combineDatabaseSchemaSteps
@@ -469,6 +514,7 @@ describe("DataSelector", () => {
it("should skip schema when going to previous step", async () => {
render(
<DataSelector
+ {...defaultProps}
steps={["DATABASE", "SCHEMA", "TABLE"]}
databases={[SAMPLE_DATABASE, ANOTHER_DATABASE]}
combineDatabaseSchemaSteps
@@ -496,6 +542,7 @@ describe("DataSelector", () => {
it("shows an empty state without any databases", async () => {
render(
<DataSelector
+ {...defaultProps}
steps={["DATABASE", "SCHEMA", "TABLE"]}
databases={[]}
triggerElement={<div />}
@@ -513,13 +560,13 @@ describe("DataSelector", () => {
it("should show 'Saved Questions' option when there are saved questions", async () => {
renderWithProviders(
<DataSelector
+ {...defaultProps}
availableModels={[]}
steps={["BUCKET", "DATABASE", "SCHEMA", "TABLE"]}
combineDatabaseSchemaSteps
databases={[SAMPLE_DATABASE, SAVED_QUESTIONS_DATABASE]}
hasNestedQueriesEnabled
loaded
- search={[{}]}
triggerElement={<div />}
isOpen
/>,
@@ -532,13 +579,13 @@ describe("DataSelector", () => {
it("should not show 'Saved Questions' option when there are no saved questions (metabase#29760)", async () => {
renderWithProviders(
<DataSelector
+ {...defaultProps}
availableModels={[]}
steps={["BUCKET", "DATABASE", "SCHEMA", "TABLE"]}
combineDatabaseSchemaSteps
databases={[SAMPLE_DATABASE]}
hasNestedQueriesEnabled
loaded
- search={[{}]}
triggerElement={<div />}
isOpen
/>,
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabasePicker/DataSelectorDatabasePicker.tsx b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabasePicker/DataSelectorDatabasePicker.tsx
index 3b261484573..ffd240c9545 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabasePicker/DataSelectorDatabasePicker.tsx
+++ b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabasePicker/DataSelectorDatabasePicker.tsx
@@ -25,7 +25,7 @@ type DataSelectorDatabasePickerProps = {
selectedSchema?: Schema;
onBack?: () => void;
onChangeDatabase: (database: Database) => void;
- onChangeSchema: (item: { schema?: Schema }) => void;
+ onChangeSchema: (schema?: Schema) => void;
databaseIsDisabled?: (database: Database) => boolean;
databaseDisabledTooltip?: (database: Database) => string | undefined;
};
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabaseSchemaPicker/DataSelectorDatabaseSchemaPicker.tsx b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabaseSchemaPicker/DataSelectorDatabaseSchemaPicker.tsx
index d9391212297..3b9998b1aa9 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabaseSchemaPicker/DataSelectorDatabaseSchemaPicker.tsx
+++ b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabaseSchemaPicker/DataSelectorDatabaseSchemaPicker.tsx
@@ -22,9 +22,9 @@ type DataSelectorDatabaseSchemaPicker = {
hasInitialFocus: boolean;
hasNextStep: boolean;
isLoading: boolean;
- selectedDatabase: Database;
- selectedSchema: Schema;
- onBack: () => void;
+ selectedDatabase?: Database;
+ selectedSchema?: Schema;
+ onBack?: () => void;
onChangeDatabase: (database: Database) => void;
onChangeSchema: (schema?: Schema) => void;
};
@@ -76,7 +76,7 @@ export const DataSelectorDatabaseSchemaPicker = ({
const isNavigationSection = hasBackButton && sectionIndex === 0;
if (isNavigationSection) {
- onBack();
+ onBack?.();
return false;
}
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabaseSchemaPicker/DataSelectorDatabaseSchemaPicker.unit.spec.js b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabaseSchemaPicker/DataSelectorDatabaseSchemaPicker.unit.spec.tsx
similarity index 68%
rename from frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabaseSchemaPicker/DataSelectorDatabaseSchemaPicker.unit.spec.js
rename to frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabaseSchemaPicker/DataSelectorDatabaseSchemaPicker.unit.spec.tsx
index cac08643007..3b0dedb66fd 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabaseSchemaPicker/DataSelectorDatabaseSchemaPicker.unit.spec.js
+++ b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorDatabaseSchemaPicker/DataSelectorDatabaseSchemaPicker.unit.spec.tsx
@@ -3,12 +3,24 @@ import { render, renderWithProviders, screen } from "__support__/ui";
import { createMockState } from "metabase/redux/store/mocks";
import { getMetadata } from "metabase/selectors/metadata";
import { checkNotNull } from "metabase/utils/types";
+import type Database from "metabase-lib/v1/metadata/Database";
import { getSchemaDisplayName } from "metabase-lib/v1/metadata/utils/schema";
-import { createMockDatabase, createMockSchema } from "metabase-types/api/mocks";
+import type { Database as ApiDatabase } from "metabase-types/api";
+import { createMockDatabase, createMockTable } from "metabase-types/api/mocks";
import { DataSelectorDatabaseSchemaPicker } from "./DataSelectorDatabaseSchemaPicker";
-const setup = (opts) => {
+const defaultProps = {
+ hasBackButton: false,
+ hasFiltering: false,
+ hasInitialFocus: false,
+ hasNextStep: false,
+ isLoading: false,
+ onChangeDatabase: jest.fn(),
+ onChangeSchema: jest.fn(),
+};
+
+const setup = (opts: { database: ApiDatabase }) => {
const state = createMockState({
entities: createMockEntitiesState({ databases: [opts.database] }),
});
@@ -18,12 +30,10 @@ const setup = (opts) => {
renderWithProviders(
<DataSelectorDatabaseSchemaPicker
+ {...defaultProps}
selectedDatabase={database}
selectedSchema={schemas[0]}
databases={[database]}
- schemas={schemas}
- onChangeSchema={jest.fn()}
- onChangeDatabase={jest.fn()}
/>,
{ storeInitialState: state },
);
@@ -31,7 +41,9 @@ const setup = (opts) => {
describe("DataSelectorDatabaseSchemaPicker", () => {
it("displays loading message when it has no databases", () => {
- render(<DataSelectorDatabaseSchemaPicker databases={[]} />);
+ render(
+ <DataSelectorDatabaseSchemaPicker {...defaultProps} databases={[]} />,
+ );
expect(screen.getByTestId("loading-indicator")).toBeInTheDocument();
});
@@ -41,6 +53,8 @@ describe("DataSelectorDatabaseSchemaPicker", () => {
const databaseName = "Database name";
const schemaName = "Schema name";
+ // The picker only reads database id/name and getSchemas, so a partial
+ // mock is enough here.
const databases = [
{
id: 1,
@@ -50,13 +64,18 @@ describe("DataSelectorDatabaseSchemaPicker", () => {
{ name: "another schema name" },
],
},
- ];
+ ] as unknown as Database[];
- render(<DataSelectorDatabaseSchemaPicker databases={databases} />);
+ render(
+ <DataSelectorDatabaseSchemaPicker
+ {...defaultProps}
+ databases={databases}
+ />,
+ );
expect(screen.getByText(databaseName)).toBeInTheDocument();
expect(
- screen.getByText(getSchemaDisplayName(schemaName)),
+ screen.getByText(checkNotNull(getSchemaDisplayName(schemaName))),
).toBeInTheDocument();
});
@@ -64,6 +83,8 @@ describe("DataSelectorDatabaseSchemaPicker", () => {
const databaseName = "Database name";
const schemaName = "Schema name";
+ // The picker only reads database id/name, is_saved_questions and
+ // getSchemas, so a partial mock is enough here.
const databases = [
{
id: 1,
@@ -74,9 +95,14 @@ describe("DataSelectorDatabaseSchemaPicker", () => {
{ name: "another schema name" },
],
},
- ];
+ ] as unknown as Database[];
- render(<DataSelectorDatabaseSchemaPicker databases={databases} />);
+ render(
+ <DataSelectorDatabaseSchemaPicker
+ {...defaultProps}
+ databases={databases}
+ />,
+ );
expect(screen.queryByText(databaseName)).not.toBeInTheDocument();
expect(screen.queryByText(schemaName)).not.toBeInTheDocument();
@@ -87,9 +113,9 @@ describe("DataSelectorDatabaseSchemaPicker", () => {
it("doesn't display a loading spinner next to a schema when the database has initial_sync_status='incomplete'", () => {
const database = createMockDatabase({
initial_sync_status: "incomplete",
- schemas: [
- createMockSchema({ id: 1, name: "Schema 1" }),
- createMockSchema({ id: 2, name: "Schema 2" }),
+ tables: [
+ createMockTable({ id: 1, schema: "Schema 1" }),
+ createMockTable({ id: 2, schema: "Schema 2" }),
],
});
setup({ database });
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorSchemaPicker/DataSelectorSchemaPicker.tsx b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorSchemaPicker/DataSelectorSchemaPicker.tsx
index bdc0c4582e8..543f5ce5f52 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorSchemaPicker/DataSelectorSchemaPicker.tsx
+++ b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorSchemaPicker/DataSelectorSchemaPicker.tsx
@@ -8,15 +8,13 @@ import type { SchemaId } from "metabase-types/api";
import { CONTAINER_WIDTH } from "../constants";
type DataSelectorSchemaPickerProps = {
- hasBackButton: boolean;
hasFiltering: boolean;
hasInitialFocus: boolean;
hasNextStep: boolean;
isLoading: boolean;
schemas: Schema[];
- selectedSchemaId: SchemaId;
- onBack: () => void;
- onChangeSchema: (item: { schema: Schema }) => void;
+ selectedSchemaId?: SchemaId;
+ onChangeSchema: (schema?: Schema) => void;
};
export const DataSelectorSchemaPicker = ({
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorSchemaPicker/DataSelectorSchemaPicker.unit.spec.js b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorSchemaPicker/DataSelectorSchemaPicker.unit.spec.js
deleted file mode 100644
index f7d20810198..00000000000
--- a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorSchemaPicker/DataSelectorSchemaPicker.unit.spec.js
+++ /dev/null
@@ -1,16 +0,0 @@
-import { render, screen } from "__support__/ui";
-import { getSchemaDisplayName } from "metabase-lib/v1/metadata/utils/schema";
-
-import { DataSelectorSchemaPicker } from "./DataSelectorSchemaPicker";
-
-describe("DataSelectorSchemaPicker", () => {
- it("displays schema name", () => {
- const schemaName = "Schema name";
- const schemas = [{ name: schemaName }];
- render(<DataSelectorSchemaPicker schemas={schemas} />);
-
- expect(
- screen.getByText(getSchemaDisplayName(schemaName)),
- ).toBeInTheDocument();
- });
-});
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorSchemaPicker/DataSelectorSchemaPicker.unit.spec.tsx b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorSchemaPicker/DataSelectorSchemaPicker.unit.spec.tsx
new file mode 100644
index 00000000000..668168d50f4
--- /dev/null
+++ b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorSchemaPicker/DataSelectorSchemaPicker.unit.spec.tsx
@@ -0,0 +1,28 @@
+import { render, screen } from "__support__/ui";
+import { checkNotNull } from "metabase/utils/types";
+import type Schema from "metabase-lib/v1/metadata/Schema";
+import { getSchemaDisplayName } from "metabase-lib/v1/metadata/utils/schema";
+
+import { DataSelectorSchemaPicker } from "./DataSelectorSchemaPicker";
+
+describe("DataSelectorSchemaPicker", () => {
+ it("displays schema name", () => {
+ const schemaName = "Schema name";
+ // The picker only reads schema names, so a partial mock is enough here.
+ const schemas = [{ name: schemaName }] as Schema[];
+ render(
+ <DataSelectorSchemaPicker
+ schemas={schemas}
+ hasFiltering
+ hasInitialFocus
+ hasNextStep={false}
+ isLoading={false}
+ onChangeSchema={jest.fn()}
+ />,
+ );
+
+ expect(
+ screen.getByText(checkNotNull(getSchemaDisplayName(schemaName))),
+ ).toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorTablePicker/DataSelectorTablePicker.tsx b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorTablePicker/DataSelectorTablePicker.tsx
index 0d86eaf39bf..f5db414fdc2 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorTablePicker/DataSelectorTablePicker.tsx
+++ b/frontend/src/metabase/querying/common/components/DataSelector/DataSelectorTablePicker/DataSelectorTablePicker.tsx
@@ -31,7 +31,7 @@ type DataSelectorTablePickerProps = {
isLoading?: boolean;
minTablesToShowSearch?: number;
schemas: Schema[];
- selectedDatabase: Database;
+ selectedDatabase?: Database;
selectedSchema?: Schema;
selectedTable?: Table;
tables: Table[];
@@ -41,8 +41,10 @@ type DataSelectorTablePickerProps = {
type HeaderProps = Pick<
DataSelectorTablePickerProps,
- "schemas" | "selectedSchema" | "selectedDatabase" | "onBack"
->;
+ "schemas" | "selectedSchema" | "onBack"
+> & {
+ selectedDatabase: Database;
+};
type Item = {
name: string;
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/TriggerComponents.tsx b/frontend/src/metabase/querying/common/components/DataSelector/TriggerComponents.tsx
index 4cb0e78f414..eb2aa7aae5c 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/TriggerComponents.tsx
+++ b/frontend/src/metabase/querying/common/components/DataSelector/TriggerComponents.tsx
@@ -11,6 +11,12 @@ import type Table from "metabase-lib/v1/metadata/Table";
import DataSelectorS from "./DataSelector.module.css";
+export type TriggerComponentProps = {
+ database?: Database | null;
+ table?: Table | null;
+ field?: Field | null;
+};
+
export function Trigger({
className,
style,
@@ -22,7 +28,7 @@ export function Trigger({
className?: string;
style?: CSSProperties;
showDropdownIcon?: boolean;
- iconSize?: number;
+ iconSize?: number | string;
isMantine?: boolean;
children: ReactNode;
}) {
@@ -61,13 +67,7 @@ export function Trigger({
);
}
-export function FieldTrigger({
- database,
- field,
-}: {
- database: Database;
- field: Field;
-}) {
+export function FieldTrigger({ database, field }: TriggerComponentProps) {
if (!field || !field.table) {
return <Text>{t`Select...`}</Text>;
}
@@ -85,7 +85,7 @@ export function FieldTrigger({
);
}
-export function DatabaseTrigger({ database }: { database: Database }) {
+export function DatabaseTrigger({ database }: TriggerComponentProps) {
return database ? (
<span
className={cx(CS.textWrap, CS.noDecoration)}
@@ -100,7 +100,7 @@ export function DatabaseTrigger({ database }: { database: Database }) {
);
}
-export function TableTrigger({ table }: { table: Table }) {
+export function TableTrigger({ table }: TriggerComponentProps) {
return table ? (
<span
className={cx(CS.textWrap, CS.noDecoration)}
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityList.tsx b/frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityList.tsx
index 427802f7946..05f252bac34 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityList.tsx
+++ b/frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityList.tsx
@@ -16,8 +16,8 @@ import { CARD_INFO } from "./constants";
interface SavedEntityListProps {
type: CardType;
- selectedId: string;
- databaseId: DatabaseId;
+ selectedId?: string;
+ databaseId?: DatabaseId | null;
collection?: Collection;
onSelect: (tableOrModelId: string) => void;
}
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityPicker.jsx b/frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityPicker.tsx
similarity index 59%
rename from frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityPicker.jsx
rename to frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityPicker.tsx
index e38fe26e0ba..1147c38c46d 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/saved-entity-picker/SavedEntityPicker.jsx
+++ b/frontend/src/metabase/querying/common/components/DataSelector/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/common/collections/constants";
+import type { CollectionTreeItem } from "metabase/common/collections/utils";
import {
buildCollectionTree,
currentUserPersonalCollections,
@@ -13,38 +13,52 @@ import {
nonPersonalOrArchivedCollection,
} from "metabase/common/collections/utils";
import { Tree } from "metabase/common/components/tree";
+import type { ITreeNodeItem } from "metabase/common/components/tree/types";
import { findCollectionById } from "metabase/common/utils/collections";
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,
+ CollectionContentModel,
+ CollectionId,
+ DatabaseId,
+} from "metabase-types/api";
import { SavedEntityList } from "./SavedEntityList";
import SavedEntityPickerS from "./SavedEntityPicker.module.css";
import { CARD_INFO } from "./constants";
-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",
- };
-};
+interface SavedEntityPickerProps {
+ type: CardType;
+ onSelect: (tableOrModelId: string) => void;
+ onBack: () => void;
+ databaseId?: DatabaseId | null;
+ tableId?: string;
+ collectionId?: CollectionId;
+}
+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,
-};
+} as Collection;
-export function SavedEntityPicker(props) {
+export function SavedEntityPicker(props: SavedEntityPickerProps) {
const { data: collections } = useListCollectionsTreeQuery({
"exclude-archived": true,
});
@@ -61,6 +75,11 @@ export function SavedEntityPicker(props) {
);
}
+interface SavedEntityPickerInnerProps extends SavedEntityPickerProps {
+ collections: Collection[];
+ rootCollection: Collection;
+}
+
function SavedEntityPickerInner({
type,
onBack,
@@ -70,17 +89,17 @@ function SavedEntityPickerInner({
collectionId,
collections,
rootCollection,
-}) {
+}: SavedEntityPickerInnerProps) {
const currentUser = useSelector(getUser);
- const collectionTree = useMemo(() => {
- const modelFilter = (model) => CARD_INFO[type].model === model;
+ const collectionTree = useMemo<CollectionTreeItem[]>(() => {
+ const modelFilter = (model: CollectionContentModel) =>
+ CARD_INFO[type].model === model;
- const preparedCollections = [];
- const userPersonalCollections = currentUserPersonalCollections(
- collections,
- currentUser.id,
- );
+ const preparedCollections: Collection[] = [];
+ const userPersonalCollections = currentUser
+ ? currentUserPersonalCollections(collections, currentUser.id)
+ : [];
const nonPersonalOrArchivedCollections = collections.filter(
nonPersonalOrArchivedCollection,
);
@@ -88,7 +107,7 @@ function SavedEntityPickerInner({
preparedCollections.push(...userPersonalCollections);
preparedCollections.push(...nonPersonalOrArchivedCollections);
- if (currentUser.is_superuser) {
+ if (currentUser?.is_superuser) {
const otherPersonalCollections = collections.filter(
(collection) =>
isRootPersonalCollection(collection) &&
@@ -115,15 +134,27 @@ function SavedEntityPickerInner({
[],
);
- const [selectedCollection, setSelectedCollection] =
- useState(initialCollection);
+ const [selectedCollection, setSelectedCollection] = useState<
+ Collection | undefined
+ >(initialCollection);
- const handleSelect = useCallback((collection) => {
- if (collection.id === PERSONAL_COLLECTIONS.id) {
- return;
- }
- setSelectedCollection(collection);
- }, []);
+ const handleSelect = useCallback(
+ (node: ITreeNodeItem) => {
+ if (node.id === PERSONAL_COLLECTIONS.id) {
+ return;
+ }
+ const collection = findCollectionById(
+ collectionTree,
+ // Tree erases node ids to string | number, but these nodes are always
+ // collection tree items keyed by CollectionId.
+ node.id as CollectionId,
+ );
+ if (collection) {
+ setSelectedCollection(collection);
+ }
+ },
+ [collectionTree],
+ );
return (
<Box className={SavedEntityPickerS.SavedEntityPickerRoot}>
@@ -154,10 +185,3 @@ function SavedEntityPickerInner({
</Box>
);
}
-
-SavedEntityPicker.propTypes = propTypes;
-SavedEntityPickerInner.propTypes = {
- ...propTypes,
- collections: PropTypes.array.isRequired,
- rootCollection: PropTypes.object.isRequired,
-};
diff --git a/frontend/src/metabase/querying/components/NativeQueryEditor/DataSourceSelectors/DataSourceSelectors.tsx b/frontend/src/metabase/querying/components/NativeQueryEditor/DataSourceSelectors/DataSourceSelectors.tsx
index 1f6ba29e39f..a6f9d51871b 100644
--- a/frontend/src/metabase/querying/components/NativeQueryEditor/DataSourceSelectors/DataSourceSelectors.tsx
+++ b/frontend/src/metabase/querying/components/NativeQueryEditor/DataSourceSelectors/DataSourceSelectors.tsx
@@ -230,7 +230,7 @@ const TableSelector = ({
<SchemaAndTableDataSelector
selectedTableId={selectedTable?.id || null}
selectedDatabaseId={database?.id}
- databases={[database]}
+ databases={database ? [database] : []}
setSourceTableFn={setTableId}
isInitiallyOpen={false}
readOnly={readOnly}
diff --git a/frontend/src/metabase/querying/components/template_tags/TagEditorParamParts/FieldMappingSelect.tsx b/frontend/src/metabase/querying/components/template_tags/TagEditorParamParts/FieldMappingSelect.tsx
index 69725d98b20..96a16839df2 100644
--- a/frontend/src/metabase/querying/components/template_tags/TagEditorParamParts/FieldMappingSelect.tsx
+++ b/frontend/src/metabase/querying/components/template_tags/TagEditorParamParts/FieldMappingSelect.tsx
@@ -37,11 +37,8 @@ export function FieldMappingSelect({
{(!dimension || (dimension && field != null)) && (
<SchemaTableAndFieldDataSelector
databases={databases}
- selectedDatabase={database || null}
selectedDatabaseId={database?.id || null}
- selectedTable={field?.table || null}
selectedTableId={field?.table?.id || null}
- selectedField={field || null}
selectedFieldId={dimension ? dimension?.[1] : null}
setFieldFn={setFieldFn}
fieldFilter={getFieldFilter(tag)}
diff --git a/frontend/src/metabase/querying/components/template_tags/TagEditorParamParts/TableMappingSelect.tsx b/frontend/src/metabase/querying/components/template_tags/TagEditorParamParts/TableMappingSelect.tsx
index 0891ef7f7ff..17da826e66d 100644
--- a/frontend/src/metabase/querying/components/template_tags/TagEditorParamParts/TableMappingSelect.tsx
+++ b/frontend/src/metabase/querying/components/template_tags/TagEditorParamParts/TableMappingSelect.tsx
@@ -39,9 +39,7 @@ export function TableMappingSelect({
</ContainerLabel>
<SchemaAndTableDataSelector
databases={databases}
- selectedDatabase={database || null}
selectedDatabaseId={database?.id || null}
- selectedTable={tableId}
selectedTableId={tableId}
setSourceTableFn={onChange}
isInitiallyOpen={tableId == null}