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
Migrate DatasetEditor DatasetNotebook and DatasetFieldMetadataSidebar to TypeScript (#76971)
Romeo Van Snickc16bdc6c3257
diff --git a/frontend/src/metabase-types/api/dataset.ts b/frontend/src/metabase-types/api/dataset.tsindex 8445da3f9a8..1b61cfabc8b 100644--- a/frontend/src/metabase-types/api/dataset.ts+++ b/frontend/src/metabase-types/api/dataset.ts@@ -88,6 +88,7 @@ export interface DatasetColumn {// model with customized metadatafk_target_field_id?: FieldId | null;+ should_index?: boolean;remapping?: Map<RowValue, string | number>;}diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsxindex cee9690e540..f4dde35ccf1 100644--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx@@ -29,6 +29,7 @@ import {} from "metabase/query_builder/actions";import { ViewSidebar } from "metabase/query_builder/components/view/ViewSidebar";import { useVisualizationResultQBProps } from "metabase/query_builder/hooks";+import type { FieldWithMaybeIndex } from "metabase/query_builder/model-indexes/actions";import {getDatasetEditorTab,getIsListViewConfigurationShown,@@ -65,12 +66,14 @@ import type {Dataset,DatasetColumn,Field,+ FieldId,NativeQuerySnippet,RawSeries,ResultsMetadata,VisualizationDisplay,VisualizationSettings,} from "metabase-types/api";+import type { ModelIndex } from "metabase-types/api/modelIndexes";import DatasetEditorS from "./DatasetEditor.module.css";import {@@ -109,7 +112,8 @@ export type DatasetEditorInnerProps = {setDatasetEditorTab: (tab: DatasetEditorTab) => void;setMetadataDiff: (diff: {name: string;- changes: Partial<DatasetColumn>;+ // id can be null when a native model column is unmapped from its database column+ changes: Partial<Omit<DatasetColumn, "id">> & { id?: FieldId | null };}) => void;onSave: (q: Question,@@ -160,7 +164,7 @@ function mapStateToProps(state: any) {const mapDispatchToProps = { setDatasetEditorTab, setTemplateTagConfig };function getSidebar(- props: DatasetEditorInnerProps & { modelIndexes?: unknown },+ props: DatasetEditorInnerProps & { modelIndexes?: ModelIndex[] },{datasetEditorTab,isQueryError,@@ -173,11 +177,11 @@ function getSidebar(}: {datasetEditorTab: DatasetEditorTab;isQueryError?: unknown;- focusedField?: DatasetColumn;+ focusedField?: FieldWithMaybeIndex;focusedFieldIndex: number;focusFirstField: () => void;onFieldMetadataChange: (values: Partial<DatasetColumn>) => void;- onMappedDatabaseColumnChange: (value: number) => void;+ onMappedDatabaseColumnChange: (value: FieldId | null) => void;onUpdateModelSettings: (settings: {display: ModelSettings["display"];}) => void;@@ -264,13 +268,11 @@ function getSidebar(}function getColumnTabIndex(columnIndex: number, focusedFieldIndex: number) {- return Number(- columnIndex === focusedFieldIndex- ? EDITOR_TAB_INDEXES.FOCUSED_FIELD- : columnIndex > focusedFieldIndex- ? EDITOR_TAB_INDEXES.NEXT_FIELDS- : EDITOR_TAB_INDEXES.PREVIOUS_FIELDS,- );+ return columnIndex === focusedFieldIndex+ ? EDITOR_TAB_INDEXES.FOCUSED_FIELD+ : columnIndex > focusedFieldIndex+ ? EDITOR_TAB_INDEXES.NEXT_FIELDS+ : EDITOR_TAB_INDEXES.PREVIOUS_FIELDS;}function getTempRawSeries(@@ -403,7 +405,7 @@ const DatasetEditorInnerView = (props: DatasetEditorInnerProps) => {const previousFocusedFieldIndex = usePrevious(focusedFieldIndex);- const focusedField = fields[focusedFieldIndex] as unknown as DatasetColumn;+ const focusedField = fields[focusedFieldIndex];const focusFirstField = useCallback(() => {const [firstField] = fields;@@ -420,7 +422,7 @@ const DatasetEditorInnerView = (props: DatasetEditorInnerProps) => {}, [result, focusedFieldName, fields, focusFirstField, focusedField]);const inheritMappedFieldProperties = useCallback(- (changes: { id: number } & Partial<DatasetColumn>) => {+ (changes: { id: FieldId | null } & Partial<Omit<DatasetColumn, "id">>) => {const mappedField = metadata?.field?.(changes.id)?.getPlainObject();const inheritedProperties =mappedField && getWritableColumnProperties(mappedField, isNative);@@ -440,7 +442,7 @@ const DatasetEditorInnerView = (props: DatasetEditorInnerProps) => {);const onMappedDatabaseColumnChange = useCallback(- (value: number) => {+ (value: FieldId | null) => {if (!focusedFieldName) {return;}diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/DatasetFieldMetadataSidebar.jsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/DatasetFieldMetadataSidebar.tsxsimilarity index 80%rename from frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/DatasetFieldMetadataSidebar.jsxrename to frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/DatasetFieldMetadataSidebar.tsxindex 86d5363a268..d217f1d75c9 100644--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/DatasetFieldMetadataSidebar.jsx+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetFieldMetadataSidebar/DatasetFieldMetadataSidebar.tsx@@ -1,5 +1,13 @@-import PropTypes from "prop-types";-import { memo, useCallback, useEffect, useMemo, useRef, useState } from "react";+import {+ type ChangeEvent,+ type KeyboardEventHandler,+ memo,+ useCallback,+ useEffect,+ useMemo,+ useRef,+ useState,+} from "react";import { t } from "ttag";import _ from "underscore";@@ -13,6 +21,7 @@ import {FormTextInput,FormTextarea,} from "metabase/forms";+import type { FieldWithMaybeIndex } from "metabase/query_builder/model-indexes/actions";import {canIndexField,fieldHasIndex,@@ -25,7 +34,16 @@ import {} from "metabase/visualizations/components/ColumnSettings";import { getGlobalSettingsForColumn } from "metabase/visualizations/lib/settings/column";import * as Lib from "metabase-lib";+import type Question from "metabase-lib/v1/Question";import { isCurrency, isFK } from "metabase-lib/v1/types/utils/isa";+import type {+ ColumnSettings as ColumnSettingsType,+ DatasetColumn,+ Field,+ FieldId,+ FieldVisibilityType,+} from "metabase-types/api";+import type { ModelIndex } from "metabase-types/api/modelIndexes";import { EDITOR_TAB_INDEXES } from "../constants";@@ -35,17 +53,30 @@ import { DatasetFieldMetadataSemanticTypePicker } from "./DatasetFieldMetadataSeimport DatasetFieldMetadataSidebarS from "./DatasetFieldMetadataSidebar.module.css";import { MappedFieldPicker } from "./MappedFieldPicker";-const propTypes = {- dataset: PropTypes.object.isRequired,- field: PropTypes.object.isRequired,- isLastField: PropTypes.bool.isRequired,- handleFirstFieldFocus: PropTypes.func.isRequired,- onFieldMetadataChange: PropTypes.func.isRequired,- onMappedDatabaseColumnChange: PropTypes.func.isRequired,- modelIndexes: PropTypes.array,+type VisibilityType = (typeof FIELD_VISIBILITY_TYPES)[number];++type FieldMetadataFormValues = {+ display_name: Field["display_name"];+ description: Field["description"];+ semantic_type: Field["semantic_type"];+ fk_target_field_id: Field["fk_target_field_id"];+ visibility_type: Field["visibility_type"];+ should_index: boolean;+ settings: Field["settings"];+ id?: Field["id"];+};++type DatasetFieldMetadataSidebarProps = {+ dataset: Question;+ field: FieldWithMaybeIndex;+ isLastField: boolean;+ handleFirstFieldFocus: () => void;+ onFieldMetadataChange: (values: Partial<DatasetColumn>) => void;+ onMappedDatabaseColumnChange: (value: FieldId | null) => void;+ modelIndexes?: ModelIndex[];};-function getVisibilityTypeName(visibilityType) {+function getVisibilityTypeName(visibilityType: VisibilityType) {if (visibilityType.id === "normal") {return t`Table and details views`;}@@ -99,13 +130,13 @@ function DatasetFieldMetadataSidebarInner({onFieldMetadataChange,onMappedDatabaseColumnChange,modelIndexes,-}) {- const displayNameInputRef = useRef();+}: DatasetFieldMetadataSidebarProps) {+ const displayNameInputRef = useRef<HTMLInputElement>(null);const canIndex = dataset.isSaved() && canIndexField(field, dataset);const initialValues = useMemo(() => {- const values = {+ const values: FieldMetadataFormValues = {display_name: field.display_name,description: field.description,semantic_type: field.semantic_type,@@ -122,10 +153,10 @@ function DatasetFieldMetadataSidebarInner({return values;}, [field, dataset, modelIndexes]);- const [tab, setTab] = useState(TAB.SETTINGS);+ const [tab, setTab] = useState<string>(TAB.SETTINGS);const handleFormattingSettingsChange = useCallback(- (settings) => {+ (settings: ColumnSettingsType) => {onFieldMetadataChange({ settings });},[onFieldMetadataChange],@@ -138,11 +169,12 @@ function DatasetFieldMetadataSidebarInner({onChangeSetting: handleFormattingSettingsChange,inheritedSettings: getGlobalSettingsForColumn(),variant: "form-field",+ style: undefined,}),[field, handleFormattingSettingsChange],);- const hasColumnFormattingOptions = useMemo(+ const hasColumnFormattingOptions = useMemo<boolean>(() =>hasColumnSettingsWidgets({...columnSettingsProps,@@ -157,16 +189,17 @@ function DatasetFieldMetadataSidebarInner({}}, [tab, hasColumnFormattingOptions]);- const onLastEssentialFieldKeyDown = useCallback(- (e) => {- const isNextFieldAction = !e.shiftKey && e.key === "Tab";- if (isNextFieldAction && isLastField) {- e.preventDefault();- handleFirstFieldFocus();- }- },- [isLastField, handleFirstFieldFocus],- );+ const onLastEssentialFieldKeyDown: KeyboardEventHandler<HTMLInputElement> =+ useCallback(+ (e) => {+ const isNextFieldAction = !e.shiftKey && e.key === "Tab";+ if (isNextFieldAction && isLastField) {+ e.preventDefault();+ handleFirstFieldFocus();+ }+ },+ [isLastField, handleFirstFieldFocus],+ );const onFieldMetadataChangeDebounced = useMemo(() => _.debounce(onFieldMetadataChange, 500),@@ -174,7 +207,7 @@ function DatasetFieldMetadataSidebarInner({);const handleDisplayNameChange = useCallback(- (e) =>+ (e: ChangeEvent<HTMLInputElement>) =>onFieldMetadataChangeDebounced({display_name: e.target.value,}),@@ -182,7 +215,7 @@ function DatasetFieldMetadataSidebarInner({);const handleDescriptionChange = useCallback(- (e) =>+ (e: ChangeEvent<HTMLTextAreaElement>) =>onFieldMetadataChangeDebounced({description: e.target.value,}),@@ -190,7 +223,7 @@ function DatasetFieldMetadataSidebarInner({);const handleSemanticTypeChange = useCallback(- (value) =>+ (value: string | null) =>onFieldMetadataChange({semantic_type: value,}),@@ -198,7 +231,7 @@ function DatasetFieldMetadataSidebarInner({);const handleFkTargetChange = useCallback(- (value) =>+ (value: FieldId | null) =>onFieldMetadataChange({fk_target_field_id: value,}),@@ -206,15 +239,16 @@ function DatasetFieldMetadataSidebarInner({);const handleVisibilityTypeChange = useCallback(- (value) =>+ (value: string) =>onFieldMetadataChange({- visibility_type: value,+ // the radio options are built from FIELD_VISIBILITY_TYPES ids+ visibility_type: value as FieldVisibilityType,}),[onFieldMetadataChange],);const handleShouldIndexChange = useCallback(- (e) =>+ (e: ChangeEvent<HTMLInputElement>) =>onFieldMetadataChange({should_index: e.target.checked,}),@@ -225,7 +259,11 @@ function DatasetFieldMetadataSidebarInner({return (<SidebarContent>- <FormProvider initialValues={initialValues} enableReinitialize>+ <FormProvider<FieldMetadataFormValues>+ initialValues={initialValues}+ enableReinitialize+ onSubmit={_.noop}+ >{({ values: formFieldValues }) => {return (<Form>@@ -292,7 +330,8 @@ function DatasetFieldMetadataSidebarInner({)}{isFK(formFieldValues) && (<DatasetFieldMetadataFkTargetPicker- databaseId={dataset.databaseId()}+ // a model always maps to a concrete database+ databaseId={dataset.databaseId()!}field={field}onChange={handleFkTargetChange}/>@@ -300,7 +339,7 @@ function DatasetFieldMetadataSidebarInner({</Stack></div>- <Tabs value={tab} onChange={setTab}>+ <Tabs value={tab} onChange={(value) => value && setTab(value)}>{hasColumnFormattingOptions ? (<Tabs.List px="1rem">{TAB_OPTIONS.map((option) => (@@ -372,8 +411,6 @@ function DatasetFieldMetadataSidebarInner({);}-DatasetFieldMetadataSidebarInner.propTypes = propTypes;-export const DatasetFieldMetadataSidebar = memo(DatasetFieldMetadataSidebarInner,);diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetNotebook/DatasetNotebook.jsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetNotebook/DatasetNotebook.tsxsimilarity index 62%rename from frontend/src/metabase/query_builder/components/DatasetEditor/DatasetNotebook/DatasetNotebook.jsxrename to frontend/src/metabase/query_builder/components/DatasetEditor/DatasetNotebook/DatasetNotebook.tsxindex 0ad24d488a9..77d9805704c 100644--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetNotebook/DatasetNotebook.jsx+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetNotebook/DatasetNotebook.tsx@@ -1,19 +1,19 @@-/* eslint-disable react/prop-types */import cx from "classnames";-import PropTypes from "prop-types";-import { forwardRef } from "react";-import { ResizableBox } from "react-resizable";+import { type HTMLAttributes, type Ref, forwardRef } from "react";+import { ResizableBox, type ResizableBoxProps } from "react-resizable";import CS from "metabase/css/core/index.css";-import { Notebook } from "metabase/querying/notebook/components/Notebook";+import {+ Notebook,+ type NotebookProps,+} from "metabase/querying/notebook/components/Notebook";import { Box, Flex, rem } from "metabase/ui";import { darken } from "metabase/ui/colors";-const propTypes = {- question: PropTypes.object.isRequired,- isResizing: PropTypes.bool.isRequired,- resizableBoxProps: PropTypes.object.isRequired,- onResizeStop: PropTypes.func.isRequired,+type DatasetNotebookProps = NotebookProps & {+ isResizing: boolean;+ onResizeStop: ResizableBoxProps["onResizeStop"];+ resizableBoxProps: Partial<ResizableBoxProps> & { height: number };};/**@@ -23,9 +23,16 @@ const propTypes = {* Setting the overflow to "hidden" while resizing fixes that behavior.* @link Demo: https://github.com/metabase/metabase/pull/19103#issuecomment-981935878*/-const getOverflow = (isResizing) => (isResizing ? "hidden" : "auto");+const getOverflow = (isResizing: boolean) => (isResizing ? "hidden" : "auto");-const Handle = forwardRef(function Handle(props, ref) {+type HandleProps = HTMLAttributes<HTMLDivElement> & {+ handleAxis?: string;+};++const Handle = forwardRef(function Handle(+ props: HandleProps,+ ref: Ref<HTMLDivElement>,+) {const { handleAxis, ...rest } = props;return (@@ -45,8 +52,8 @@ const Handle = forwardRef(function Handle(props, ref) {<Boxw="6.25rem"h="xs"- bg={darken("border-neutral", 0.03)}style={{+ backgroundColor: darken("border-neutral", 0.03),borderRadius: "xs",}}></Box>@@ -59,16 +66,16 @@ export function DatasetNotebook({onResizeStop,resizableBoxProps,...notebookProps-}) {+}: DatasetNotebookProps) {return (<ResizableBoxclassName={cx(CS.borderTop, CS.flex)}- axis="y"handle={<Handle />}{...resizableBoxProps}+ axis="y"onResizeStop={(...args) => {- resizableBoxProps.onResizeStop(...args);- onResizeStop(...args);+ resizableBoxProps.onResizeStop?.(...args);+ onResizeStop?.(...args);}}><Box w="100%" style={{ overflowY: getOverflow(isResizing) }}>@@ -77,5 +84,3 @@ export function DatasetNotebook({</ResizableBox>);}--DatasetNotebook.propTypes = propTypes;diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.tsxindex ccd08a1e253..824c20af637 100644--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.tsx+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.tsx@@ -102,6 +102,7 @@ function DatasetQueryEditorInner({{isActive && <NativeQueryEditor.RunButton />}</NativeQueryEditor>) : (+ // @ts-expect-error TODO: Fix types in DatasetQueryEditor<DatasetNotebook{...props}question={question}diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/constants.ts b/frontend/src/metabase/query_builder/components/DatasetEditor/constants.tsindex 3913bef845b..9d186377487 100644--- a/frontend/src/metabase/query_builder/components/DatasetEditor/constants.ts+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/constants.ts@@ -10,8 +10,8 @@* 5. Column C and so on*/export const EDITOR_TAB_INDEXES = {- PREVIOUS_FIELDS: "1",- FOCUSED_FIELD: "2",- ESSENTIAL_FORM_FIELD: "3",- NEXT_FIELDS: "4",+ PREVIOUS_FIELDS: 1,+ FOCUSED_FIELD: 2,+ ESSENTIAL_FORM_FIELD: 3,+ NEXT_FIELDS: 4,};diff --git a/frontend/src/metabase/query_builder/model-indexes/utils.ts b/frontend/src/metabase/query_builder/model-indexes/utils.tsindex e833e0f9205..dee2e3fbae4 100644--- a/frontend/src/metabase/query_builder/model-indexes/utils.ts+++ b/frontend/src/metabase/query_builder/model-indexes/utils.ts@@ -1,7 +1,7 @@import _ from "underscore";import type Question from "metabase-lib/v1/Question";-import type FieldEntity from "metabase-lib/v1/metadata/Field";+import type { FieldTypeInfo } from "metabase-lib/v1/types/utils/isa";import {isBoolean,isInteger,@@ -19,7 +19,10 @@ const hasSingleIntegerPk = (model?: Question) => {return pkFields?.length === 1 && isInteger(pkFields[0]);};-export const canIndexField = (field: FieldEntity, model: Question): boolean => {+export const canIndexField = (+ field: FieldTypeInfo,+ model: Question,+): boolean => {return !!(isString(field) && !isBoolean(field) && hasSingleIntegerPk(model));};