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
chore: convert dashcard mapping files to ts (#69836)
Uladzimir Havenchyk264604b61e2c
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.tsxindex 1f3c06146b0..0dc67f78486 100644--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.tsx+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.tsx@@ -25,6 +25,7 @@ import type {DashboardCard,Parameter,ParameterTarget,+ VirtualCard,} from "metabase-types/api";import type { State } from "metabase-types/store";@@ -52,15 +53,15 @@ const mapStateToProps = (};interface DashcardCardParameterMapperProps {- card: Card;+ card: Card | VirtualCard;dashcard: DashboardCard;- editingParameter: Parameter | null | undefined;- target: ParameterTarget | null | undefined;+ editingParameter?: Parameter | null | undefined;+ target?: ParameterTarget | null | undefined;isMobile: boolean;// virtual cards will not have questionquestion?: Question;- mappingOptions: ParameterMappingOption[];- isRecentlyAutoConnected: boolean;+ mappingOptions?: ParameterMappingOption[];+ isRecentlyAutoConnected?: boolean;editingParameterInlineDashcard?: DashboardCard;compact?: boolean;}@@ -72,8 +73,8 @@ export function DashCardCardParameterMapper({target,isMobile,question,- mappingOptions,- isRecentlyAutoConnected,+ mappingOptions = [],+ isRecentlyAutoConnected = false,editingParameterInlineDashcard,compact,}: DashcardCardParameterMapperProps) {diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.unit.spec.jsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.unit.spec.tsxsimilarity index 83%rename from frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.unit.spec.jsxrename to frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.unit.spec.tsxindex eb771de21ef..969603c94a9 100644--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.unit.spec.jsx+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapper.unit.spec.tsx@@ -7,8 +7,10 @@ import {renderWithProviders,screen,} from "__support__/ui";+import type { ParameterMappingOption } from "metabase/parameters/utils/mapping-options";import { getMetadata } from "metabase/selectors/metadata";import Question from "metabase-lib/v1/Question";+import type { Card, VirtualCard } from "metabase-types/api";import {createMockActionDashboardCard,createMockCard,@@ -40,14 +42,36 @@ const state = createMockState({const metadata = getMetadata(state); // metabase-lib Metadata instance-const setup = (options) => {+type MapperProps = React.ComponentProps<typeof DashCardCardParameterMapper>;+type SetupOptions = Partial<MapperProps>;++const DEFAULT_MAPPING_OPTIONS: ParameterMappingOption[] = [+ {+ target: ["dimension", ["field", 1, null]],+ icon: "string",+ isForeign: false,+ sectionName: "Section",+ name: "Name",+ },+];++const getQuestion = (card: Card | VirtualCard) => {+ return card.name !== null ? new Question(card, metadata) : undefined;+};++const setup = (options: SetupOptions = {}) => {const card = options.card ?? createMockCard();+ const dashcard =+ options.dashcard ??+ (card.name !== null+ ? createMockDashboardCard({ card })+ : createMockDashboardCard());const { rerender } = renderWithProviders(<DashCardCardParameterMappercard={card}- dashcard={createMockDashboardCard({ card })}- question={new Question(card, metadata)}+ dashcard={dashcard}+ question={getQuestion(card)}editingParameter={createMockParameter()}isRecentlyAutoConnected={false}mappingOptions={[]}@@ -56,14 +80,19 @@ const setup = (options) => {/>,);- const resultRerender = (newOptions) => {+ const resultRerender = (newOptions: SetupOptions) => {const card = newOptions.card ?? createMockCard();+ const dashcard =+ newOptions.dashcard ??+ (card.name !== null+ ? createMockDashboardCard({ card })+ : createMockDashboardCard());return rerender(<DashCardCardParameterMappercard={card}- dashcard={createMockDashboardCard({ card })}- question={new Question(card, metadata)}+ dashcard={dashcard}+ question={getQuestion(card)}editingParameter={createMockParameter()}isRecentlyAutoConnected={false}mappingOptions={[]}@@ -146,11 +175,8 @@ describe("DashCardCardParameterMapper", () => {setup({card: textCard,- dashcard: createMockVirtualDashCard({- card: textCard,- size_y: 3,- }),- mappingOptions: ["foo", "bar"],+ dashcard: createMockVirtualDashCard({ size_y: 3 }),+ mappingOptions: DEFAULT_MAPPING_OPTIONS,});expect(screen.getByText(/Variable to map to/i)).toBeInTheDocument();@@ -167,11 +193,11 @@ describe("DashCardCardParameterMapper", () => {size_y: 4,});- const expectCardText = (text) => {+ const expectCardText = (text: string) => {expect(screen.getByText(text)).toBeInTheDocument();};- const expectTooltipText = async (text) => {+ const expectTooltipText = async (text: string) => {const infoIcon = getIcon("info");expect(infoIcon).toBeInTheDocument();@@ -218,14 +244,8 @@ describe("DashCardCardParameterMapper", () => {setup({card,- mappingOptions: [- {- target: ["dimension", ["field", 1]],- sectionName: "Section",- name: "Name",- },- ],- target: ["dimension", ["field", 1]],+ mappingOptions: DEFAULT_MAPPING_OPTIONS,+ target: ["dimension", ["field", 1, null]],});expect(screen.getByText("Section.Name")).toBeInTheDocument();@@ -242,14 +262,8 @@ describe("DashCardCardParameterMapper", () => {setup({dashcard,card,- mappingOptions: [- {- target: ["dimension", ["field", 1]],- sectionName: "Section",- name: "Name",- },- ],- target: ["dimension", ["field", 1]],+ mappingOptions: DEFAULT_MAPPING_OPTIONS,+ target: ["dimension", ["field", 1, null]],isRecentlyAutoConnected: true,});@@ -278,14 +292,8 @@ describe("DashCardCardParameterMapper", () => {setup({dashcard,card,- mappingOptions: [- {- target: ["dimension", ["field", 1]],- sectionName: "Section",- name: "Name",- },- ],- target: ["dimension", ["field", 1]],+ mappingOptions: DEFAULT_MAPPING_OPTIONS,+ target: ["dimension", ["field", 1, null]],isRecentlyAutoConnected: true,});@@ -302,14 +310,8 @@ describe("DashCardCardParameterMapper", () => {setup({dashcard,card,- mappingOptions: [- {- target: ["dimension", ["field", 1]],- sectionName: "Section",- name: "Name",- },- ],- target: ["dimension", ["field", 1]],+ mappingOptions: DEFAULT_MAPPING_OPTIONS,+ target: ["dimension", ["field", 1, null]],isRecentlyAutoConnected: true,});@@ -332,8 +334,8 @@ describe("DashCardCardParameterMapper", () => {dashcard: createMockDashboardCard({card,}),- mappingOptions: [{ target: ["dimension", ["field", 1]] }],- target: ["dimension", ["field", 2]],+ mappingOptions: DEFAULT_MAPPING_OPTIONS,+ target: ["dimension", ["field", 2, null]],isMobile: true,});expect(screen.getByText(/unknown field/i)).toBeInTheDocument();@@ -370,7 +372,7 @@ describe("DashCardCardParameterMapper", () => {card: numberCard,size_y: 3,}),- mappingOptions: ["foo", "bar"],+ mappingOptions: DEFAULT_MAPPING_OPTIONS,});expect(screen.getByText(/Column to filter on/i)).toBeInTheDocument();});@@ -386,7 +388,7 @@ describe("DashCardCardParameterMapper", () => {card: numberCard,size_y: 2,}),- mappingOptions: ["foo", "bar"],+ mappingOptions: DEFAULT_MAPPING_OPTIONS,});expect(screen.queryByText(/Column to filter on/i)).not.toBeInTheDocument();});@@ -479,12 +481,12 @@ describe("DashCardCardParameterMapper", () => {it("should not show native question variable warning if a native question variable is used", () => {const card = createMockCard({dataset_query: createMockNativeDatasetQuery({- dataset_query: {- native: createMockNativeQuery({- query: "SELECT * FROM ACCOUNTS WHERE source = {{ source }}",- "template-tags": [createMockTemplateTag({ name: "source" })],- }),- },+ native: createMockNativeQuery({+ query: "SELECT * FROM ACCOUNTS WHERE source = {{ source }}",+ "template-tags": {+ source: createMockTemplateTag({ name: "source" }),+ },+ }),}),});setup({@@ -498,17 +500,15 @@ describe("DashCardCardParameterMapper", () => {it("should not show native question variable warning without single value explanation if parameter is date type", () => {const card = createMockCard({dataset_query: createMockNativeDatasetQuery({- dataset_query: {- native: createMockNativeQuery({- query: "SELECT * FROM ORDERS WHERE created_at = {{ created_at }}",- "template-tags": [- createMockTemplateTag({- name: "created_at",- type: "date/month-year",- }),- ],- }),- },+ native: createMockNativeQuery({+ query: "SELECT * FROM ORDERS WHERE created_at = {{ created_at }}",+ "template-tags": {+ created_at: createMockTemplateTag({+ name: "created_at",+ type: "date",+ }),+ },+ }),}),});setup({@@ -533,7 +533,7 @@ describe("DashCardCardParameterMapper", () => {card: numberCard,size_y: 2,}),- mappingOptions: ["foo", "bar"],+ mappingOptions: DEFAULT_MAPPING_OPTIONS,isMobile: true,});expect(screen.getByText(/Column to filter on/i)).toBeInTheDocument();@@ -544,11 +544,8 @@ describe("DashCardCardParameterMapper", () => {setup({card: textCard,- dashcard: createMockVirtualCard({- card: textCard,- size_y: 3,- }),- mappingOptions: ["foo", "bar"],+ dashcard: createMockVirtualDashCard({ card: textCard, size_y: 2 }),+ mappingOptions: DEFAULT_MAPPING_OPTIONS,isMobile: true,});expect(screen.queryByText(/Variable to map to/i)).not.toBeInTheDocument();diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapperButton.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapperButton.tsxindex 8e28728d5d7..7671ebce8fd 100644--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapperButton.tsx+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapperButton.tsx@@ -9,7 +9,7 @@ import type { ParameterMappingOption } from "metabase/parameters/utils/mapping-oimport { Box, Flex, Icon, Popover, Tooltip } from "metabase/ui";import * as Lib from "metabase-lib";import type Question from "metabase-lib/v1/Question";-import type { Card, ParameterTarget } from "metabase-types/api";+import type { Card, ParameterTarget, VirtualCard } from "metabase-types/api";import S from "./DashCardParameterMapper.module.css";@@ -18,7 +18,7 @@ interface DashCardCardParameterMapperButtonProps {isVirtual: boolean;isQuestion: boolean;question: Question | undefined;- card: Card;+ card: Card | VirtualCard;handleChangeTarget: (target: ParameterTarget | null) => void;selectedMappingOption: ParameterMappingOption | undefined;target: ParameterTarget | null | undefined;diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapperContent.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapperContent.tsxindex 6af0239c1ec..acc349a47a9 100644--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapperContent.tsx+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardCardParameterMapperContent.tsx@@ -30,6 +30,7 @@ import type {DashboardCard,Parameter,ParameterTarget,+ VirtualCard,} from "metabase-types/api";import { DashCardCardParameterMapperButton } from "./DashCardCardParameterMapperButton";@@ -46,7 +47,7 @@ interface DashCardCardParameterMapperContentProps {question: Question | undefined;editingParameter: Parameter | null | undefined;mappingOptions: ParameterMappingOption[];- card: Card;+ card: Card | VirtualCard;selectedMappingOption: ParameterMappingOption | undefined;target: ParameterTarget | null | undefined;layoutHeight: number;@@ -119,13 +120,9 @@ export const DashCardCardParameterMapperContent = ({const handleChangeTarget = useCallback((target: ParameterTarget | null) => {if (editingParameter) {+ const cardId = typeof card.id === "number" ? card.id : null;dispatch(- setParameterMapping(- editingParameter.id,- dashcard.id,- card.id,- target,- ),+ setParameterMapping(editingParameter.id, dashcard.id, cardId, target),);}},diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardParameterMapper.jsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardParameterMapper.jsxdeleted file mode 100644index 8aef911ecd7..00000000000--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardParameterMapper.jsx+++ /dev/null@@ -1,56 +0,0 @@-/* eslint-disable react/prop-types */-import cx from "classnames";-import { t } from "ttag";--import CS from "metabase/css/core/index.css";-import { Flex } from "metabase/ui";-import { color } from "metabase/ui/utils/colors";--import { DashCardCardParameterMapperConnected } from "./DashCardCardParameterMapper";-import S from "./DashCardParameterMapper.module.css";--export const DashCardParameterMapper = ({- dashcard,- isMobile,- compact = false,-}) => (- <div- className={cx(- CS.relative,- CS.flexFull,- CS.flex,- CS.flexColumn,- CS.layoutCentered,- )}- >- {dashcard.series && dashcard.series.length > 0 && (- <div- className={cx(CS.mx4, CS.my1, CS.p1, CS.rounded, CS.textMedium)}- style={{- backgroundColor: color("background-secondary"),- marginTop: -10,- }}- >- {t`Make sure to make a selection for each series, or the filter won't work on this card.`}- </div>- )}- <Flex- justify="space-around"- maw="100%"- m={compact ? undefined : "0 2rem"}- gap="sm"- className={S.MapperSettingsContainer}- data-testid="parameter-mapper-container"- >- {[dashcard.card].concat(dashcard.series || []).map((card) => (- <DashCardCardParameterMapperConnected- key={`${dashcard.id},${card.id}`}- dashcard={dashcard}- card={card}- isMobile={isMobile}- compact={compact}- />- ))}- </Flex>- </div>-);diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardParameterMapper.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardParameterMapper.tsxnew file mode 100644index 00000000000..7da38d575ac--- /dev/null+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardParameterMapper/DashCardParameterMapper.tsx@@ -0,0 +1,68 @@+import cx from "classnames";+import { t } from "ttag";++import CS from "metabase/css/core/index.css";+import { isQuestionDashCard } from "metabase/dashboard/utils";+import { Flex } from "metabase/ui";+import { color } from "metabase/ui/utils/colors";+import type { DashboardCard } from "metabase-types/api";++import { DashCardCardParameterMapperConnected } from "./DashCardCardParameterMapper";+import S from "./DashCardParameterMapper.module.css";++type DashCardParameterMapperProps = {+ dashcard: DashboardCard;+ isMobile: boolean;+ compact?: boolean;+};++export const DashCardParameterMapper = ({+ dashcard,+ isMobile,+ compact = false,+}: DashCardParameterMapperProps) => {+ const seriesCards =+ isQuestionDashCard(dashcard) && dashcard.series ? dashcard.series : [];++ return (+ <div+ className={cx(+ CS.relative,+ CS.flexFull,+ CS.flex,+ CS.flexColumn,+ CS.layoutCentered,+ )}+ >+ {seriesCards.length > 0 && (+ <div+ className={cx(CS.mx4, CS.my1, CS.p1, CS.rounded, CS.textMedium)}+ style={{+ backgroundColor: color("background-secondary"),+ marginTop: -10,+ }}+ >+ {t`Make sure to make a selection for each series, or the filter won't work on this card.`}+ </div>+ )}+ <Flex+ justify="space-around"+ maw="100%"+ m={compact ? undefined : "0 2rem"}+ gap="sm"+ className={S.MapperSettingsContainer}+ data-testid="parameter-mapper-container"+ >+ {[dashcard.card, ...seriesCards].map((card) => (+ <DashCardCardParameterMapperConnected+ key={`${dashcard.id},${card.id}`}+ dashcard={dashcard}+ card={card}+ isMobile={isMobile}+ compact={compact}+ />+ ))}+ </Flex>+ </div>+ );+};