Skip to content

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

Convert parameters to typescript (#70137)

Romeo Van Snickd54e6b64e2f9
diff --git a/frontend/src/metabase-types/api/mocks/dashboard.ts b/frontend/src/metabase-types/api/mocks/dashboard.ts
index 16d235da05d..7fe393174c9 100644
--- a/frontend/src/metabase-types/api/mocks/dashboard.ts
+++ b/frontend/src/metabase-types/api/mocks/dashboard.ts
@@ -1,6 +1,7 @@
import type {
ActionDashboardCard,
Dashboard,
+ DashboardParameterMapping,
DashboardQueryMetadata,
DashboardTab,
QuestionDashboardCard,
@@ -81,6 +82,15 @@ export const createMockDashboardCard = (
...opts,
});
+export const createMockParameterMapping = (
+ opts?: Partial<DashboardParameterMapping>,
+): DashboardParameterMapping => ({
+ card_id: 1,
+ target: ["variable", ["template-tag", "foo"]],
+ parameter_id: "foo",
+ ...opts,
+});
+
export const createMockVirtualCard = (
opts?: Partial<VirtualCard>,
): VirtualCard => ({
diff --git a/frontend/src/metabase/lib/types.ts b/frontend/src/metabase/lib/types.ts
index 40427de2872..b36b669c1b9 100644
--- a/frontend/src/metabase/lib/types.ts
+++ b/frontend/src/metabase/lib/types.ts
@@ -4,6 +4,13 @@ export const isNotNull = <T>(value: T | null | undefined): value is T => {
return value != null;
};
+export const asNotNull = <T>(value: T | null | undefined): T => {
+ if (isNotNull(value)) {
+ return value;
+ }
+ throw new TypeError("value is null or undefined");
+};
+
export const isNotFalsy = <T>(
value: T | null | undefined | false | "",
): value is T => {
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/SingleSelectListField/SingleSelectListField.unit.spec.js b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/SingleSelectListField/SingleSelectListField.unit.spec.tsx
similarity index 84%
rename from frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/SingleSelectListField/SingleSelectListField.unit.spec.js
rename to frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/SingleSelectListField/SingleSelectListField.unit.spec.tsx
index 477c6ecbea7..cd3065bf27f 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/SingleSelectListField/SingleSelectListField.unit.spec.js
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/SingleSelectListField/SingleSelectListField.unit.spec.tsx
@@ -2,23 +2,30 @@ import { waitForElementToBeRemoved } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import { render, screen } from "__support__/ui";
+import type { OptionsType } from "metabase/lib/formatting";
+import type Field from "metabase-lib/v1/metadata/Field";
+import type { FieldValue, RowValue } from "metabase-types/api";
import { Value as ValueComponent } from "../../Value";
import SingleSelectListField from "./index";
-const value = [];
+const value: RowValue[] = [];
const firstOption = "AK";
const secondOption = "AL";
-const options = [[firstOption], [secondOption]];
-const fields = [];
+const options: FieldValue[] = [[firstOption], [secondOption]];
+const fields: Field[] = [];
const formatOptions = {};
-function showRemapping(fields) {
+function showRemapping(fields: Field[]) {
return fields.length === 1;
}
-function renderValue(fields, formatOptions, value, options) {
+function renderValue(
+ fields: Field[],
+ formatOptions: Partial<OptionsType>,
+ value: unknown,
+) {
return (
<ValueComponent
value={value}
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/SingleSelectListField/types.ts b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/SingleSelectListField/types.ts
index 3f1df4a0f3c..a2ec708accc 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/SingleSelectListField/types.ts
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/SingleSelectListField/types.ts
@@ -8,7 +8,7 @@ export interface SingleSelectListFieldProps {
options: Option[];
optionRenderer: (option: Option) => JSX.Element;
onSearchChange?: (value: string) => void;
- placeholder: string;
+ placeholder?: string;
isDashboardFilter?: boolean;
isLoading?: boolean;
checkedColor?: string;
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/utils.ts b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/utils.ts
index 7d6a0d099f1..5f3201ab332 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/utils.ts
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/utils.ts
@@ -46,7 +46,7 @@ export function shouldList({
}: {
parameter?: Parameter;
fields: Field[];
- disableSearch: boolean;
+ disableSearch?: boolean;
}) {
if (disableSearch) {
return false;
@@ -90,10 +90,10 @@ function getNonSearchableTokenFieldPlaceholder(
}
export function searchField(
- field: Field,
- disablePKRemappingForSearch: boolean,
+ field: Field | null,
+ disablePKRemappingForSearch?: boolean,
) {
- return field.searchField(disablePKRemappingForSearch);
+ return field?.searchField(disablePKRemappingForSearch) ?? null;
}
function getSearchableTokenFieldPlaceholder(
@@ -172,8 +172,8 @@ export function isSearchable({
valuesMode,
}: {
parameter?: Parameter;
- fields: Field[];
- disableSearch: boolean;
+ fields?: Field[];
+ disableSearch?: boolean;
disablePKRemappingForSearch?: boolean;
valuesMode?: ValuesMode;
}) {
@@ -183,8 +183,10 @@ export function isSearchable({
return true;
} else if (parameter) {
return canSearchParameterValues(parameter, disablePKRemappingForSearch);
- } else {
+ } else if (fields) {
return canSearchFieldValues(fields, disablePKRemappingForSearch);
+ } else {
+ return false;
}
}
@@ -248,7 +250,7 @@ export function getValuesMode({
}: {
parameter?: Parameter;
fields: Field[];
- disableSearch: boolean;
+ disableSearch?: boolean;
disablePKRemappingForSearch?: boolean;
}): ValuesMode {
if (
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/utils.unit.spec.js b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/utils.unit.spec.tsx
similarity index 78%
rename from frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/utils.unit.spec.js
rename to frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/utils.unit.spec.tsx
index 75c455f137a..2df099ec331 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/utils.unit.spec.js
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/utils.unit.spec.tsx
@@ -1,3 +1,5 @@
+import { asNotNull } from "metabase/lib/types";
+import type { FieldId } from "metabase-types/api";
import { ORDERS, PEOPLE, PRODUCTS } from "metabase-types/api/mocks/presets";
import {
@@ -7,15 +9,14 @@ import {
} from "./testMocks.spec";
import { getValuesMode, isSearchable, searchField } from "./utils";
+const getField = (id: FieldId) => asNotNull(metadata.field(id));
+
describe("Components > FieldValuesWidget > utils", () => {
describe("isSearchable", () => {
- const listField = metadata.field(PRODUCTS.CATEGORY);
- const searchField = metadata.field(PEOPLE.EMAIL);
- const nonExhaustiveListField = metadata.field(
- LISTABLE_FIELD_WITH_MANY_VALUES_ID,
- );
-
- const idField = metadata.field(PRODUCTS.ID);
+ const listField = getField(PRODUCTS.CATEGORY);
+ const searchField = getField(PEOPLE.EMAIL);
+ const nonExhaustiveListField = getField(LISTABLE_FIELD_WITH_MANY_VALUES_ID);
+ const idField = getField(PRODUCTS.ID);
describe("when the `valuesMode` is already set to 'search'", () => {
it("should return return true unless fully disabled", () => {
@@ -58,21 +59,21 @@ describe("Components > FieldValuesWidget > utils", () => {
describe("when passed fields that are searchable", () => {
it("should return 'search'", () => {
- const fields = [metadata.field(PEOPLE.EMAIL)];
+ const fields = [getField(PEOPLE.EMAIL)];
expect(getValuesMode({ fields })).toBe("search");
});
});
describe("when passed fields that are not searchable but listable", () => {
it("should return 'list'", () => {
- const fields = [metadata.field(PRODUCTS.CATEGORY)];
+ const fields = [getField(PRODUCTS.CATEGORY)];
expect(getValuesMode({ fields })).toBe("list");
});
});
describe("when passed fields that are not searchable and not listable", () => {
it("should return 'none'", () => {
- const fields = [metadata.field(ORDERS.SUBTOTAL)];
+ const fields = [getField(ORDERS.SUBTOTAL)];
expect(getValuesMode({ fields })).toBe("none");
});
});
@@ -82,8 +83,8 @@ describe("Components > FieldValuesWidget > utils", () => {
describe("`disablePKRemappingForSearch` is true and field is a PK", () => {
const disablePKRemappingForSearch = true;
- const stringPKField = metadata.field(STRING_PK_FIELD_ID);
- const numberPKField = metadata.field(PRODUCTS.ID);
+ const stringPKField = getField(STRING_PK_FIELD_ID);
+ const numberPKField = getField(PRODUCTS.ID);
it("should return same field when the field is searchable (the field is a string AND a PK)", () => {
expect(searchField(stringPKField, disablePKRemappingForSearch)).toBe(
@@ -99,8 +100,8 @@ describe("Components > FieldValuesWidget > utils", () => {
});
describe("when the field is remapped to a searchable field", () => {
- const stringField = metadata.field(PRODUCTS.TITLE);
- const remappedField = metadata.field(PRODUCTS.CATEGORY).clone();
+ const stringField = getField(PRODUCTS.TITLE);
+ const remappedField = getField(PRODUCTS.CATEGORY).clone();
remappedField.remappedExternalField = () => stringField;
it("should return the remapped field", () => {
@@ -110,12 +111,12 @@ describe("Components > FieldValuesWidget > utils", () => {
describe("when the field is remapped to a non-searchable field", () => {
it("should ignore it and return the original field, assuming it is searchable", () => {
- const numberField = metadata.field(ORDERS.TOTAL);
+ const numberField = getField(ORDERS.TOTAL);
- const remappedField = metadata.field(PRODUCTS.CATEGORY).clone();
+ const remappedField = getField(PRODUCTS.CATEGORY).clone();
remappedField.remappedExternalField = () => numberField;
- const nonSearchableRemappedField = metadata.field(PRODUCTS.ID);
+ const nonSearchableRemappedField = getField(PRODUCTS.ID);
nonSearchableRemappedField.remappedExternalField = () => numberField;
expect(searchField(remappedField)).toBe(remappedField);
@@ -124,12 +125,12 @@ describe("Components > FieldValuesWidget > utils", () => {
});
it("should return the field if it is searchable", () => {
- const searchableField = metadata.field(PRODUCTS.TITLE);
+ const searchableField = getField(PRODUCTS.TITLE);
expect(searchField(searchableField)).toBe(searchableField);
});
it("should return null if the field is not searchable", () => {
- const nonSearchableField = metadata.field(PRODUCTS.ID);
+ const nonSearchableField = getField(PRODUCTS.ID);
expect(searchField(nonSearchableField)).toBeNull();
});
});
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidgetValue/ParameterFieldWidgetValue.tsx b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidgetValue/ParameterFieldWidgetValue.tsx
index ab4cb27c69f..2fe0c3224e2 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidgetValue/ParameterFieldWidgetValue.tsx
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidgetValue/ParameterFieldWidgetValue.tsx
@@ -8,7 +8,7 @@ import { normalizeValue } from "../normalizeValue";
type ParameterFieldWidgetValueProps = {
value: unknown;
fields: Field[];
- parameter: Parameter;
+ parameter?: Parameter;
cardId?: CardId;
dashboardId?: DashboardId;
displayValue?: string;
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidgetValue/ParameterFieldWidgetValue.unit.spec.js b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidgetValue/ParameterFieldWidgetValue.unit.spec.tsx
similarity index 100%
rename from frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidgetValue/ParameterFieldWidgetValue.unit.spec.js
rename to frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/ParameterFieldWidgetValue/ParameterFieldWidgetValue.unit.spec.tsx
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/Value/RemappedValue.jsx b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/Value/RemappedValue.tsx
similarity index 57%
rename from frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/Value/RemappedValue.jsx
rename to frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/Value/RemappedValue.tsx
index ea59dbd438f..54c275dbb1a 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/Value/RemappedValue.jsx
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/Value/RemappedValue.tsx
@@ -1,13 +1,39 @@
-/* eslint-disable react/prop-types */
+import type { ReactNode } from "react";
+
import CS from "metabase/css/core/index.css";
import AutoLoadRemapped from "metabase/hoc/Remapped";
import { formatValue } from "metabase/lib/formatting";
+import type Field from "metabase-lib/v1/metadata/Field";
+
+type RenderNormal = (opts: { value?: unknown; column?: Field }) => ReactNode;
+type RenderRemapped = (opts: {
+ value: unknown;
+ column?: Field;
+ displayValue?: unknown;
+ displayColumn?: Field;
+}) => ReactNode;
+
+export type RemappedValueProps = {
+ value: unknown;
+ column?: Field;
+ displayValue: unknown;
+ displayColumn?: Field;
+ renderNormal?: RenderNormal;
+ renderRemapped?: RenderRemapped;
+ autoLoad?: boolean;
+};
-const defaultRenderNormal = ({ value }) => <span>{value}</span>;
+const defaultRenderNormal: RenderNormal = ({ value }) => (
+ <span>{value as ReactNode}</span>
+);
-const defaultRenderRemapped = ({ value, displayValue, column }) => (
+const defaultRenderRemapped: RenderRemapped = ({
+ value,
+ displayValue,
+ column,
+}) => (
<span>
- <span className={CS.textBold}>{displayValue}</span>
+ <span className={CS.textBold}>{displayValue as ReactNode}</span>
{/* Show the underlying ID for PK/FK */}
{column?.isID() && <span style={{ opacity: 0.5 }}>{" - " + value}</span>}
</span>
@@ -21,11 +47,11 @@ const RemappedValueContent = ({
renderNormal = defaultRenderNormal,
renderRemapped = defaultRenderRemapped,
...props
-}) => {
+}: Omit<RemappedValueProps, "autoLoad">) => {
if (column != null) {
value = formatValue(value, {
...props,
- column: column,
+ column,
jsx: true,
remap: false,
});
@@ -47,14 +73,16 @@ const RemappedValueContent = ({
export const AutoLoadRemappedValue = AutoLoadRemapped(RemappedValueContent);
-export const FieldRemappedValue = (props) => (
+export const FieldRemappedValue = (props: RemappedValueProps) => (
<RemappedValueContent
{...props}
- displayValue={props.displayValue ?? props.column.remappedValue(props.value)}
+ displayValue={
+ props.displayValue ?? props.column?.remappedValue(props.value)
+ }
/>
);
-const RemappedValue = ({ autoLoad = true, ...props }) =>
+const RemappedValue = ({ autoLoad = true, ...props }: RemappedValueProps) =>
autoLoad && !props.displayValue ? (
<AutoLoadRemappedValue {...props} />
) : (
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/normalizeValue.ts b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/normalizeValue.ts
index 3e42b0c62d2..50baaa716a3 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/normalizeValue.ts
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/normalizeValue.ts
@@ -1,7 +1,15 @@
-export function normalizeValue(value: unknown) {
+type NonArray<T> = Exclude<T, any[]>;
+
+export function normalizeValue<T>(
+ value: NonArray<T> | NonArray<T>[] | undefined,
+): T[] {
if (Array.isArray(value)) {
- return value;
+ return value as T[];
+ }
+
+ if (value || value === 0) {
+ return [value];
}
- return value || value === 0 ? [value] : [];
+ return [];
}
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/normalizeValue.unit.spec.js b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/normalizeValue.unit.spec.tsx
similarity index 91%
rename from frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/normalizeValue.unit.spec.js
rename to frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/normalizeValue.unit.spec.tsx
index 0430ddfeeeb..bf51076cb72 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/normalizeValue.unit.spec.js
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/normalizeValue.unit.spec.tsx
@@ -3,11 +3,10 @@ import { normalizeValue } from "./normalizeValue";
describe("normalizeValue", () => {
it("returns empty array if value is null", () => {
const value = null;
- const expected = [];
const normalized = normalizeValue(value);
- expect(normalized).toEqual(expected);
+ expect(normalized).toEqual([]);
});
it("returns value if value is an array", () => {
diff --git a/frontend/src/metabase/parameters/utils/dashboard-options.unit.spec.js b/frontend/src/metabase/parameters/utils/dashboard-options.unit.spec.tsx
similarity index 77%
rename from frontend/src/metabase/parameters/utils/dashboard-options.unit.spec.js
rename to frontend/src/metabase/parameters/utils/dashboard-options.unit.spec.tsx
index a126898abb7..1e73ebe0fa0 100644
--- a/frontend/src/metabase/parameters/utils/dashboard-options.unit.spec.js
+++ b/frontend/src/metabase/parameters/utils/dashboard-options.unit.spec.tsx
@@ -1,5 +1,7 @@
import _ from "underscore";
+import type { ParameterSectionId } from "metabase-lib/v1/parameters/utils/operators";
+
import { getDashboardParameterSections } from "./dashboard-options";
describe("parameters/utils/dashboard-options", () => {
@@ -15,7 +17,7 @@ describe("parameters/utils/dashboard-options", () => {
id: "location",
});
expect(
- locationSection.options.every((option) =>
+ locationSection?.options.every((option) =>
option.type.startsWith("string"),
),
).toBe(true);
@@ -23,7 +25,9 @@ describe("parameters/utils/dashboard-options", () => {
it("should have a string section", () => {
expect(
- _.findWhere(getDashboardParameterSections(), { id: "category" }),
+ _.findWhere(getDashboardParameterSections(), {
+ id: "bad-section-id" as ParameterSectionId,
+ }),
).not.toBeDefined();
expect(
diff --git a/frontend/src/metabase/parameters/utils/dashboards.unit.spec.js b/frontend/src/metabase/parameters/utils/dashboards.unit.spec.tsx
similarity index 69%
rename from frontend/src/metabase/parameters/utils/dashboards.unit.spec.js
rename to frontend/src/metabase/parameters/utils/dashboards.unit.spec.tsx
index f24cb4b9690..93105f462b0 100644
--- a/frontend/src/metabase/parameters/utils/dashboards.unit.spec.js
+++ b/frontend/src/metabase/parameters/utils/dashboards.unit.spec.tsx
@@ -7,8 +7,20 @@ import {
hasMatchingParameters,
setParameterName,
} from "metabase/parameters/utils/dashboards";
+import * as Lib from "metabase-lib";
+import { SAMPLE_PROVIDER } from "metabase-lib/test-helpers";
import Question from "metabase-lib/v1/Question";
import Field from "metabase-lib/v1/metadata/Field";
+import { createMockUiParameter } from "metabase-lib/v1/parameters/mock";
+import type { UiParameter } from "metabase-lib/v1/parameters/types";
+import type { Parameter } from "metabase-types/api";
+import {
+ createMockCard,
+ createMockDashboard,
+ createMockDashboardCard,
+ createMockParameter,
+ createMockParameterMapping,
+} from "metabase-types/api/mocks";
import {
PRODUCTS,
createSampleDatabase,
@@ -84,7 +96,12 @@ describe("metabase/parameters/utils/dashboards", () => {
describe("setParameterName", () => {
it("should set a name and a slug on parameter", () => {
- expect(setParameterName({ abc: 123 }, "foo")).toEqual({
+ expect(
+ // @ts-expect-error: extra options like abc are preserved
+ setParameterName(createMockParameter({ abc: 123 }), "foo"),
+ ).toEqual({
+ id: expect.any(String),
+ type: expect.any(String),
abc: 123,
name: "foo",
slug: "foo",
@@ -92,7 +109,9 @@ describe("metabase/parameters/utils/dashboards", () => {
});
it("should not default", () => {
- expect(setParameterName({}, "")).toEqual({
+ expect(setParameterName(createMockParameter(), "")).toEqual({
+ id: expect.any(String),
+ type: expect.any(String),
name: "",
slug: "",
});
@@ -100,85 +119,85 @@ describe("metabase/parameters/utils/dashboards", () => {
});
describe("hasMapping", () => {
- const parameter = { id: "foo" };
+ const parameter = createMockParameter({ id: "foo" });
it("should return false when there are no cards on the dashboard", () => {
- const dashboard = {
+ const dashboard = createMockDashboard({
dashcards: [],
- };
+ });
expect(hasMapping(parameter, dashboard)).toBe(false);
});
it("should return false when there are no cards with parameter mappings", () => {
- const dashboard = {
+ const dashboard = createMockDashboard({
dashcards: [
- {
+ createMockDashboardCard({
parameter_mappings: [],
- },
- {
+ }),
+ createMockDashboardCard({
parameter_mappings: [],
- },
+ }),
],
- };
+ });
expect(hasMapping(parameter, dashboard)).toBe(false);
});
it("should return false when missing parameter mappings", () => {
- const dashboard = {
- dashcards: [{ parameter_mappings: undefined }],
- };
+ const dashboard = createMockDashboard({
+ dashcards: [createMockDashboardCard({ parameter_mappings: undefined })],
+ });
expect(hasMapping(parameter, dashboard)).toBe(false);
});
it("should return false when there are no matching parameter mapping parameter_ids", () => {
- const dashboard = {
+ const dashboard = createMockDashboard({
dashcards: [
- {
+ createMockDashboardCard({
parameter_mappings: [
- {
+ createMockParameterMapping({
parameter_id: "bar",
- },
+ }),
],
- },
- {
+ }),
+ createMockDashboardCard({
parameter_mappings: [
- {
+ createMockParameterMapping({
parameter_id: "baz",
- },
- {
+ }),
+ createMockParameterMapping({
parameter_id: "abc",
- },
+ }),
],
- },
+ }),
],
- };
+ });
expect(hasMapping(parameter, dashboard)).toBe(false);
});
it("should return true when the given parameter's id is found in a parameter_mappings object", () => {
- const dashboard = {
+ const dashboard = createMockDashboard({
dashcards: [
- {
+ createMockDashboardCard({
parameter_mappings: [
- {
+ createMockParameterMapping({
parameter_id: "bar",
- },
+ }),
],
- },
- {
+ }),
+ createMockDashboardCard({
parameter_mappings: [
- {
+ createMockParameterMapping({
parameter_id: "baz",
- },
- {
+ }),
+ createMockParameterMapping({
parameter_id: "foo",
- },
+ }),
],
- },
+ }),
],
- };
+ });
expect(hasMapping(parameter, dashboard)).toBe(true);
});
@@ -186,21 +205,21 @@ describe("metabase/parameters/utils/dashboards", () => {
describe("hasMatchingParameters", () => {
it("should return false when the given card is not found on the dashboard", () => {
- const dashboard = {
+ const dashboard = createMockDashboard({
dashcards: [
- {
+ createMockDashboardCard({
id: 1,
card_id: 123,
- card: { id: 123 },
+ card: createMockCard({ id: 123 }),
parameter_mappings: [
- {
+ createMockParameterMapping({
card_id: 123,
parameter_id: "foo",
- },
+ }),
],
- },
+ }),
],
- };
+ });
expect(
hasMatchingParameters({
@@ -208,7 +227,6 @@ describe("metabase/parameters/utils/dashboards", () => {
dashcardId: 1,
cardId: 456,
parameters: [],
- metadata,
}),
).toBe(false);
@@ -218,38 +236,37 @@ describe("metabase/parameters/utils/dashboards", () => {
dashcardId: 2,
cardId: 123,
parameters: [],
- metadata,
}),
).toBe(false);
});
it("should return false when a given parameter is not found in the dashcard mappings", () => {
- const dashboard = {
+ const dashboard = createMockDashboard({
dashcards: [
- {
+ createMockDashboardCard({
id: 1,
card_id: 123,
- card: { id: 123 },
+ card: createMockCard({ id: 123 }),
parameter_mappings: [
- {
+ createMockParameterMapping({
card_id: 123,
parameter_id: "foo",
- },
+ }),
],
- },
- {
+ }),
+ createMockDashboardCard({
id: 2,
card_id: 456,
- card: { id: 456 },
+ card: createMockCard({ id: 456 }),
parameter_mappings: [
- {
+ createMockParameterMapping({
card_id: 456,
parameter_id: "bar",
- },
+ }),
],
- },
+ }),
],
- };
+ });
expect(
hasMatchingParameters({
@@ -257,38 +274,37 @@ describe("metabase/parameters/utils/dashboards", () => {
dashcardId: 1,
cardId: 123,
parameters: [
- {
+ createMockParameter({
id: "foo",
- },
- {
+ }),
+ createMockParameter({
id: "bar",
- },
+ }),
],
- metadata,
}),
).toBe(false);
});
it("should return true when all given parameters are found mapped to the dashcard", () => {
- const dashboard = {
+ const dashboard = createMockDashboard({
dashcards: [
- {
+ createMockDashboardCard({
id: 1,
card_id: 123,
- card: { id: 123 },
+ card: createMockCard({ id: 123 }),
parameter_mappings: [
- {
+ createMockParameterMapping({
card_id: 123,
parameter_id: "foo",
- },
- {
+ }),
+ createMockParameterMapping({
card_id: 123,
parameter_id: "bar",
- },
+ }),
],
- },
+ }),
],
- };
+ });
expect(
hasMatchingParameters({
@@ -296,48 +312,47 @@ describe("metabase/parameters/utils/dashboards", () => {
dashcardId: 1,
cardId: 123,
parameters: [
- {
+ createMockParameter({
id: "foo",
- },
- {
+ }),
+ createMockParameter({
id: "bar",
- },
+ }),
],
- metadata,
}),
).toBe(true);
});
});
describe("getFilteringParameterValuesMap", () => {
- const undefinedFilteringParameters = {};
- const emptyFilteringParameters = {
+ const undefinedFilteringParameters = {} as UiParameter;
+ const emptyFilteringParameters = createMockUiParameter({
filteringParameters: [],
- };
+ });
- const parameter = {
+ const parameter = createMockUiParameter({
filteringParameters: ["a", "b", "c", "d"],
- };
- const parameters = [
- {
+ });
+ const parameters: Parameter[] = [
+ createMockParameter({
id: "a",
value: "aaa",
- },
- {
+ }),
+ createMockParameter({
id: "b",
value: "bbb",
- },
- {
+ }),
+ createMockParameter({
id: "c",
- },
- {
+ }),
+ createMockParameter({
id: "d",
value: null,
- },
- {
+ }),
+ createMockParameter({
id: "e",
value: "eee",
- },
+ }),
];
it("should create a map of any defined parameterValues found in a specific parameter's filteringParameters property", () => {
@@ -370,19 +385,19 @@ describe("metabase/parameters/utils/dashboards", () => {
});
describe("getDashboardUiParameters", () => {
- const dashboard = {
+ const dashboard = createMockDashboard({
id: 1,
dashcards: [
- {
+ createMockDashboardCard({
id: 1,
card_id: 123,
- card: { id: 123, dataset_query: { type: "query" } },
- series: [{ id: 789, dataset_query: { type: "query" } }],
+ card: createMockCard({ id: 123 }),
+ series: [createMockCard({ id: 789 })],
parameter_mappings: [
{
card_id: 123,
parameter_id: "b",
- target: ["breakout", 0],
+ target: ["dimension", ["field", PRODUCTS.RATING, null]],
},
{
card_id: 789,
@@ -400,51 +415,49 @@ describe("metabase/parameters/utils/dashboards", () => {
target: ["dimension", ["field", PRODUCTS.TITLE, null]],
},
],
- },
- {
+ }),
+ createMockDashboardCard({
id: 2,
card_id: 456,
- card: {
+ card: createMockCard({
id: 456,
- dataset_query: {
- type: "native",
- native: {
+ dataset_query: Lib.toJsQuery(
+ Lib.createTestNativeQuery(SAMPLE_PROVIDER, {
query: "{{foo}}",
- "template-tags": {
+ templateTags: {
foo: {
type: "text",
},
bar: {
type: "dimension",
"widget-type": "string/contains",
- dimension: ["field", PRODUCTS.TITLE, null],
+ dimension: PRODUCTS.TITLE,
},
},
- },
- },
- },
+ }),
+ ),
+ }),
parameter_mappings: [
- {
+ createMockParameterMapping({
card_id: 456,
parameter_id: "e",
- target: ["variable", "foo"],
- },
- {
+ }),
+ createMockParameterMapping({
card_id: 456,
parameter_id: "f",
target: ["dimension", ["template-tag", "bar"]],
- },
- {
+ }),
+ createMockParameterMapping({
card_id: 456,
parameter_id: "h",
- target: ["variable", "foo"],
- },
+ target: ["variable", ["template-tag", "foo"]],
+ }),
],
- },
- {
+ }),
+ createMockDashboardCard({
id: 3,
card_id: 999,
- card: { id: 999, dataset_query: { type: "query" } },
+ card: createMockCard({ id: 999 }),
parameter_mappings: [
{
card_id: 999,
@@ -457,67 +470,75 @@ describe("metabase/parameters/utils/dashboards", () => {
target: ["dimension", ["field", PRODUCTS.CATEGORY, null]],
},
],
- },
- {
+ }),
+ createMockDashboardCard({
id: 4,
card_id: 888,
- card: { id: 888, dataset_query: { type: "query" } },
+ card: createMockCard({ id: 888 }),
parameter_mappings: [],
- },
+ }),
],
parameters: [
// unmapped, not field filter
- {
+ createMockParameter({
id: "a",
+ name: "a",
slug: "slug-a",
type: "foo",
- },
+ }),
// mapped, not field filter
- {
+ createMockParameter({
id: "b",
+ name: "b",
slug: "slug-b",
type: "granularity",
default: ["day"],
- },
+ }),
// unmapped, field filter
- {
+ createMockParameter({
id: "c",
+ name: "c",
slug: "slug-c",
type: "string/=",
- },
+ }),
// mapped, field filter
- {
+ createMockParameter({
id: "d",
+ name: "d",
slug: "slug-d",
type: "number/=",
default: [1, 2, 3],
- },
+ }),
// mapped to variable, field filter
- {
+ createMockParameter({
id: "e",
+ name: "e",
slug: "slug-e",
type: "category",
- },
+ }),
// field filter, mapped to two cards, same field
- {
+ createMockParameter({
id: "f",
+ name: "f",
slug: "slug-f",
type: "string/contains",
- },
+ }),
// field filter, mapped to two, different fields
- {
+ createMockParameter({
id: "g",
+ name: "g",
slug: "slug-g",
type: "string/starts-with",
- },
+ }),
// field filter, mapped to field and variable
- {
+ createMockParameter({
id: "h",
+ name: "h",
slug: "slug-h",
type: "string/=",
- },
+ }),
],
- };
+ });
it("should return a list of UiParameter objects from the given dashboard", () => {
const questions = Object.fromEntries(
@@ -536,17 +557,20 @@ describe("metabase/parameters/utils/dashboards", () => {
).toEqual([
{
id: "a",
+ name: "a",
slug: "slug-a",
type: "foo",
},
{
id: "b",
+ name: "b",
slug: "slug-b",
type: "granularity",
default: ["day"],
},
{
id: "c",
+ name: "c",
slug: "slug-c",
type: "string/=",
fields: [],
@@ -554,6 +578,7 @@ describe("metabase/parameters/utils/dashboards", () => {
},
{
id: "d",
+ name: "d",
slug: "slug-d",
type: "number/=",
default: [1, 2, 3],
@@ -562,6 +587,7 @@ describe("metabase/parameters/utils/dashboards", () => {
},
{
id: "e",
+ name: "e",
slug: "slug-e",
type: "category",
fields: [],
@@ -569,6 +595,7 @@ describe("metabase/parameters/utils/dashboards", () => {
},
{
id: "f",
+ name: "f",
slug: "slug-f",
type: "string/contains",
fields: [expect.any(Field)],
@@ -576,6 +603,7 @@ describe("metabase/parameters/utils/dashboards", () => {
},
{
id: "g",
+ name: "g",
slug: "slug-g",
type: "string/starts-with",
fields: [expect.any(Field), expect.any(Field)],
@@ -583,6 +611,7 @@ describe("metabase/parameters/utils/dashboards", () => {
},
{
id: "h",
+ name: "h",
slug: "slug-h",
type: "string/=",
fields: [expect.any(Field)],
diff --git a/frontend/src/metabase/parameters/utils/linked-filters.js b/frontend/src/metabase/parameters/utils/linked-filters.tsx
similarity index 57%
rename from frontend/src/metabase/parameters/utils/linked-filters.js
rename to frontend/src/metabase/parameters/utils/linked-filters.tsx
index 6acf3bde61d..9f807ff9082 100644
--- a/frontend/src/metabase/parameters/utils/linked-filters.js
+++ b/frontend/src/metabase/parameters/utils/linked-filters.tsx
@@ -1,15 +1,18 @@
+import _ from "underscore";
+
import {
FIELD_FILTER_PARAMETER_TYPES,
TYPE_SUPPORTS_LINKED_FILTERS,
} from "metabase-lib/v1/parameters/constants";
import { getParameterType } from "metabase-lib/v1/parameters/utils/parameter-type";
+import type { Parameter } from "metabase-types/api";
-export function canUseLinkedFilters(parameter) {
+export function canUseLinkedFilters(parameter: Parameter) {
const type = getParameterType(parameter);
- return TYPE_SUPPORTS_LINKED_FILTERS.includes(type);
+ return _.includes(TYPE_SUPPORTS_LINKED_FILTERS, type);
}
-export function usableAsLinkedFilter(parameter) {
+export function usableAsLinkedFilter(parameter: Parameter) {
const type = getParameterType(parameter);
return FIELD_FILTER_PARAMETER_TYPES.includes(type);
}
diff --git a/frontend/src/metabase/parameters/utils/mapping-options.ts b/frontend/src/metabase/parameters/utils/mapping-options.ts
index ade75256c5e..a17046a68ca 100644
--- a/frontend/src/metabase/parameters/utils/mapping-options.ts
+++ b/frontend/src/metabase/parameters/utils/mapping-options.ts
@@ -46,7 +46,7 @@ export type StructuredQuerySectionOption = {
name: string;
icon: string;
target: StructuredParameterDimensionTarget;
- isForeign: boolean;
+ isForeign?: boolean;
};
function buildStructuredQuerySectionOptions(
diff --git a/frontend/src/metabase/parameters/utils/mapping-options.unit.spec.js b/frontend/src/metabase/parameters/utils/mapping-options.unit.spec.tsx
similarity index 76%
rename from frontend/src/metabase/parameters/utils/mapping-options.unit.spec.js
rename to frontend/src/metabase/parameters/utils/mapping-options.unit.spec.tsx
index d8fc93c4e88..fbf0b7f80f1 100644
--- a/frontend/src/metabase/parameters/utils/mapping-options.unit.spec.js
+++ b/frontend/src/metabase/parameters/utils/mapping-options.unit.spec.tsx
@@ -1,14 +1,22 @@
import { createMockMetadata } from "__support__/metadata";
+import { isNotNull } from "metabase/lib/types";
import * as Lib from "metabase-lib";
-import { SAMPLE_METADATA, SAMPLE_PROVIDER } from "metabase-lib/test-helpers";
+import {
+ SAMPLE_METADATA,
+ SAMPLE_PROVIDER,
+ createMetadataProvider,
+} from "metabase-lib/test-helpers";
import Question from "metabase-lib/v1/Question";
+import type { ParameterTarget } from "metabase-types/api";
import {
createMockCard,
createMockDashboardCard,
+ createMockField,
createMockNativeDatasetQuery,
createMockParameter,
createMockStructuredDatasetQuery,
createMockTable,
+ createMockVirtualCard,
} from "metabase-types/api/mocks";
import {
ORDERS,
@@ -18,14 +26,16 @@ import {
PRODUCTS_ID,
REVIEWS,
REVIEWS_ID,
- SAMPLE_DB_ID,
- createAdHocCard,
- createAdHocNativeCard,
createOrdersTable,
createSampleDatabase,
} from "metabase-types/api/mocks/presets";
+import type {
+ TestNativeQuerySpec,
+ TestQuerySpec,
+} from "metabase-types/api/query";
import {
+ type ParameterMappingOption,
getMappingOptionByTarget,
getParameterMappingOptions,
} from "./mapping-options";
@@ -33,67 +43,55 @@ import {
const metadata = createMockMetadata({
databases: [createSampleDatabase()],
});
+const provider = createMetadataProvider({ metadata });
-const ordersTable = metadata.table(ORDERS_ID);
+const ordersTable = metadata.table(ORDERS_ID)!;
-function structured(query) {
- return createAdHocCard({
- dataset_query: {
- type: "query",
- database: SAMPLE_DB_ID,
- query,
- },
+function structured(spec: TestQuerySpec) {
+ return createMockCard({
+ dataset_query: Lib.toJsQuery(Lib.createTestQuery(provider, spec)),
});
}
-function native(native) {
- return createAdHocNativeCard({
- dataset_query: {
- type: "native",
- database: SAMPLE_DB_ID,
- native,
- },
+function native(spec: TestNativeQuerySpec) {
+ return createMockCard({
+ dataset_query: Lib.toJsQuery(Lib.createTestNativeQuery(provider, spec)),
});
}
describe("parameters/utils/mapping-options", () => {
describe("getParameterMappingOptions", () => {
describe("structured model", () => {
- let dataset;
- let virtualCardTable;
-
- beforeEach(() => {
- const question = ordersTable.question();
- dataset = question.setCard({
- ...question.card(),
- id: 123,
- type: "model",
- });
+ const question = ordersTable.question();
+ const dataset = question.setCard({
+ ...question.card(),
+ id: 123,
+ type: "model",
+ });
- // create a virtual table for the card
- // that contains fields with custom, model-specific metadata
- virtualCardTable = ordersTable.clone();
- virtualCardTable.id = `card__123`;
- virtualCardTable.fields = [
- metadata.field(ORDERS.CREATED_AT).clone({
- table_id: `card__123`,
- uniqueId: `card__123:${ORDERS.CREATED_AT}`,
- display_name: "~*~Created At~*~",
- }),
- ];
+ // create a virtual table for the card
+ // that contains fields with custom, model-specific metadata
+ const virtualCardTable = ordersTable?.clone();
+ virtualCardTable.id = `card__123`;
+ virtualCardTable.fields = [
+ metadata.field(ORDERS.CREATED_AT)?.clone({
+ table_id: `card__123`,
+ uniqueId: `card__123:${ORDERS.CREATED_AT}`,
+ display_name: "~*~Created At~*~",
+ }),
+ ].filter(isNotNull);
- // add instances to the `metadata` instance
- metadata.questions[dataset.id()] = dataset;
- metadata.tables[virtualCardTable.id] = virtualCardTable;
- virtualCardTable.fields.forEach((f) => {
- metadata.fields[f.uniqueId] = f;
- });
+ // add instances to the `metadata` instance
+ metadata.questions[dataset.id()] = dataset;
+ metadata.tables[virtualCardTable.id] = virtualCardTable;
+ virtualCardTable.fields.forEach((f) => {
+ metadata.fields[f.getUniqueId()] = f;
});
it("should return fields from the model question's virtual card table, as though it is already nested", () => {
const options = getParameterMappingOptions(
new Question(dataset.card(), metadata),
- { type: "date/single" },
+ createMockParameter({ type: "date/single" }),
dataset.card(),
);
@@ -148,11 +146,11 @@ describe("parameters/utils/mapping-options", () => {
describe("structured query", () => {
it("should return field-id and fk-> dimensions", () => {
const card = structured({
- "source-table": REVIEWS_ID,
+ stages: [{ source: { type: "table", id: REVIEWS_ID } }],
});
const options = getParameterMappingOptions(
new Question(card, metadata),
- { type: "date/single" },
+ createMockParameter({ type: "date/single" }),
card,
);
expect(options).toEqual([
@@ -190,27 +188,36 @@ describe("parameters/utils/mapping-options", () => {
it("should also return fields from explicitly joined tables", () => {
const card = structured({
- "source-table": ORDERS_ID,
- joins: [
+ stages: [
{
- alias: "Product",
- fields: "all",
- "source-table": PRODUCTS_ID,
- condition: [
- "=",
- [
- "field",
- ORDERS.PRODUCT_ID,
- { "base-type": "type/BigInteger" },
- ],
- ["field", PRODUCTS.ID, { "base-type": "type/BigInteger" }],
+ source: { type: "table", id: ORDERS_ID },
+ joins: [
+ {
+ source: { type: "table", id: PRODUCTS_ID },
+ strategy: "left-join",
+ conditions: [
+ {
+ operator: "=",
+ left: {
+ type: "column",
+ sourceName: "ORDERS",
+ name: "PRODUCT_ID",
+ },
+ right: {
+ type: "column",
+ sourceName: "PRODUCTS",
+ name: "ID",
+ },
+ },
+ ],
+ },
],
},
],
});
const options = getParameterMappingOptions(
new Question(card, metadata),
- { type: "date/single" },
+ createMockParameter({ type: "date/single" }),
card,
);
expect(options).toEqual([
@@ -234,7 +241,7 @@ describe("parameters/utils/mapping-options", () => {
[
"field",
PRODUCTS.CREATED_AT,
- { "base-type": "type/DateTime", "join-alias": "Product" },
+ { "base-type": "type/DateTime", "join-alias": "Products" },
],
{ "stage-number": 0 },
],
@@ -281,13 +288,17 @@ describe("parameters/utils/mapping-options", () => {
it("should return fields in nested query", () => {
const card = structured({
- "source-query": {
- "source-table": PRODUCTS_ID,
- },
+ stages: [
+ { source: { type: "table", id: PRODUCTS_ID } },
+ {
+ // second, empty, stage
+ },
+ ],
});
+
const options = getParameterMappingOptions(
new Question(card, metadata),
- { type: "date/single" },
+ createMockParameter({ type: "date/single" }),
card,
);
expect(options).toEqual([
@@ -321,7 +332,7 @@ describe("parameters/utils/mapping-options", () => {
it("should return variables for non-dimension template-tags", () => {
const card = native({
query: "select * from ORDERS where CREATED_AT = {{created}}",
- "template-tags": {
+ templateTags: {
created: {
type: "date",
name: "created",
@@ -330,12 +341,12 @@ describe("parameters/utils/mapping-options", () => {
});
const options = getParameterMappingOptions(
new Question(card, metadata),
- { type: "date/single" },
+ createMockParameter({ type: "date/single" }),
card,
);
expect(options).toEqual([
{
- name: "created",
+ name: "Created",
icon: "calendar",
target: ["variable", ["template-tag", "created"]],
isForeign: false,
@@ -347,22 +358,22 @@ describe("parameters/utils/mapping-options", () => {
it("should return dimensions for dimension template-tags", () => {
const card = native({
query: "select * from ORDERS where CREATED_AT = {{created}}",
- "template-tags": {
+ templateTags: {
created: {
type: "dimension",
name: "created",
- dimension: ["field", ORDERS.CREATED_AT, null],
+ dimension: ORDERS.CREATED_AT,
},
},
});
const options = getParameterMappingOptions(
new Question(card, metadata),
- { type: "date/single" },
+ createMockParameter({ type: "date/single" }),
card,
);
expect(options).toEqual([
{
- name: "Created At",
+ name: "Created",
icon: "calendar",
target: [
"dimension",
@@ -376,25 +387,25 @@ describe("parameters/utils/mapping-options", () => {
});
describe("iframe dashcard", () => {
- const createIframeDashcard = (iframeContent) =>
+ const createIframeDashcard = (iframeContent: string) =>
createMockDashboardCard({
visualization_settings: {
- virtual_card: {
+ virtual_card: createMockVirtualCard({
display: "iframe",
- },
+ }),
iframe: iframeContent,
},
});
- const getIframeOptions = (iframeContent) =>
+ const getIframeOptions = (iframeContent: string) =>
getParameterMappingOptions(
undefined,
null,
- { display: "iframe" },
+ createMockVirtualCard({ display: "iframe" }),
createIframeDashcard(iframeContent),
);
- const expectedTagOptions = (tags) =>
+ const expectedTagOptions = (tags: string[]) =>
tags.map((tag) => ({
name: tag,
icon: "string",
@@ -435,33 +446,35 @@ describe("parameters/utils/mapping-options", () => {
});
describe("link dashcard", () => {
- const createLinkDashcard = (linkUrl) =>
+ const createLinkDashcard = (linkUrl?: string) =>
createMockDashboardCard({
visualization_settings: {
- virtual_card: {
+ virtual_card: createMockVirtualCard({
display: "link",
- },
+ }),
link: {
url: linkUrl,
},
},
});
- const getLinkOptions = (linkUrl) =>
+ const getLinkOptions = (linkUrl?: string) =>
getParameterMappingOptions(
undefined,
null,
- { display: "link" },
+ createMockVirtualCard({ display: "link" }),
createLinkDashcard(linkUrl),
);
- const expectedTagOptions = (tags) =>
- tags.map((tag) => ({
- name: tag,
- icon: "string",
- isForeign: false,
- target: ["text-tag", tag],
- }));
+ const expectedTagOptions = (tags: string[]) =>
+ tags.map(
+ (tag): ParameterMappingOption => ({
+ name: tag,
+ icon: "string",
+ isForeign: false,
+ target: ["text-tag", tag],
+ }),
+ );
it("should return tag options from link URL", () => {
const options = getLinkOptions("https://example.com/{{foo}}/{{bar}}");
@@ -481,7 +494,9 @@ describe("parameters/utils/mapping-options", () => {
describe("parameterDashcard filtering", () => {
it("should return empty array when parameterDashcard is from a different tab", () => {
- const card = structured({ "source-table": ORDERS_ID });
+ const card = structured({
+ stages: [{ source: { type: "table", id: ORDERS_ID } }],
+ });
const question = new Question(card, metadata);
const dashcard = createMockDashboardCard({ dashboard_tab_id: 1 });
const parameterDashcard = createMockDashboardCard({
@@ -490,7 +505,7 @@ describe("parameters/utils/mapping-options", () => {
const options = getParameterMappingOptions(
question,
- { type: "date/single" },
+ createMockParameter({ type: "date/single" }),
card,
dashcard,
parameterDashcard,
@@ -500,7 +515,9 @@ describe("parameters/utils/mapping-options", () => {
});
it("should return normal options when parameterDashcard is on same tab", () => {
- const card = structured({ "source-table": ORDERS_ID });
+ const card = structured({
+ stages: [{ source: { type: "table", id: ORDERS_ID } }],
+ });
const question = new Question(card, metadata);
const dashcard = createMockDashboardCard({ dashboard_tab_id: 1 });
const parameterDashcard = createMockDashboardCard({
@@ -509,7 +526,7 @@ describe("parameters/utils/mapping-options", () => {
const options = getParameterMappingOptions(
question,
- { type: "date/single" },
+ createMockParameter({ type: "date/single" }),
card,
dashcard,
parameterDashcard,
@@ -519,7 +536,9 @@ describe("parameters/utils/mapping-options", () => {
});
it("should return empty array when inline parameter on question card tries to map to different card", () => {
- const card = structured({ "source-table": ORDERS_ID });
+ const card = structured({
+ stages: [{ source: { type: "table", id: ORDERS_ID } }],
+ });
const question = new Question(card, metadata);
const dashcard = createMockDashboardCard({
id: 1,
@@ -534,7 +553,7 @@ describe("parameters/utils/mapping-options", () => {
const options = getParameterMappingOptions(
question,
- { type: "date/single" },
+ createMockParameter({ type: "date/single" }),
card,
dashcard,
parameterDashcard,
@@ -544,7 +563,9 @@ describe("parameters/utils/mapping-options", () => {
});
it("should return normal options when inline parameter on question card maps to its own card", () => {
- const card = structured({ "source-table": ORDERS_ID });
+ const card = structured({
+ stages: [{ source: { type: "table", id: ORDERS_ID } }],
+ });
const question = new Question(card, metadata);
const dashcard = createMockDashboardCard({
id: 1,
@@ -559,7 +580,7 @@ describe("parameters/utils/mapping-options", () => {
const options = getParameterMappingOptions(
question,
- { type: "date/single" },
+ createMockParameter({ type: "date/single" }),
card,
dashcard,
parameterDashcard,
@@ -569,10 +590,16 @@ describe("parameters/utils/mapping-options", () => {
});
it("should return options when inline parameter on question card has existing connection to different card", () => {
- const card = { ...structured({ "source-table": ORDERS_ID }), id: 123 };
+ const card = structured({
+ stages: [{ source: { type: "table", id: ORDERS_ID } }],
+ });
+ card.id = 123;
const question = new Question(card, metadata);
const parameterId = "param123";
- const parameter = { id: parameterId, type: "date/single" };
+ const parameter = createMockParameter({
+ id: parameterId,
+ type: "date/single",
+ });
const dashcard = createMockDashboardCard({
id: 1,
dashboard_tab_id: 1,
@@ -609,8 +636,8 @@ describe("parameters/utils/mapping-options", () => {
const database = createSampleDatabase();
const ordersTable = createOrdersTable({
fields: [
- ...createOrdersTable().fields,
- {
+ ...(createOrdersTable().fields ?? []),
+ createMockField({
id: sensitiveFieldId,
table_id: ORDERS_ID,
name: "SECRET_FIELD",
@@ -618,23 +645,25 @@ describe("parameters/utils/mapping-options", () => {
base_type: "type/Text",
semantic_type: null,
visibility_type: "sensitive",
- },
+ }),
],
});
- database.tables = database.tables.map((t) =>
+ database.tables = database.tables?.map((t) =>
t.id === ORDERS_ID ? ordersTable : t,
);
const metadata = createMockMetadata({ databases: [database] }, undefined, {
includeSensitiveFields: true,
});
- const card = structured({ "source-table": ORDERS_ID });
+ const card = structured({
+ stages: [{ source: { type: "table", id: ORDERS_ID } }],
+ });
const question = new Question(card, metadata);
it("should exclude sensitive fields by default", () => {
const options = getParameterMappingOptions(
question,
- { type: "string/=" },
+ createMockParameter({ type: "string/=" }),
card,
);
@@ -647,7 +676,7 @@ describe("parameters/utils/mapping-options", () => {
it("should include sensitive fields when includeSensitiveFields is true", () => {
const options = getParameterMappingOptions(
question,
- { type: "string/=" },
+ createMockParameter({ type: "string/=" }),
card,
null,
null,
@@ -658,7 +687,7 @@ describe("parameters/utils/mapping-options", () => {
(opt) => opt.name === "Secret Field",
);
expect(sensitiveOption).toBeDefined();
- expect(sensitiveOption.name).toBe("Secret Field");
+ expect(sensitiveOption?.name).toBe("Secret Field");
});
});
});
@@ -666,13 +695,13 @@ describe("parameters/utils/mapping-options", () => {
describe("getMappingOptionByTarget", () => {
describe("virtual dashcard", () => {
it("should find mapping option", () => {
- const mappingOption = {
+ const mappingOption: ParameterMappingOption = {
name: "param",
icon: "string",
isForeign: false,
target: ["text-tag", "param"],
};
- const target = ["text-tag", "param"];
+ const target: ParameterTarget = ["text-tag", "param"];
expect(getMappingOptionByTarget([mappingOption], target)).toBe(
mappingOption,
@@ -680,13 +709,13 @@ describe("getMappingOptionByTarget", () => {
});
it("should return undefined if option is not found", () => {
- const mappingOption = {
+ const mappingOption: ParameterMappingOption = {
name: "param",
icon: "string",
isForeign: false,
target: ["text-tag", "param"],
};
- const target = ["text-tag", "param2"];
+ const target: ParameterTarget = ["text-tag", "param2"];
expect(getMappingOptionByTarget([mappingOption], target)).toBe(undefined);
});
@@ -694,13 +723,13 @@ describe("getMappingOptionByTarget", () => {
describe("native dashcard", () => {
it("should find mapping option", () => {
- const mappingOption = {
+ const mappingOption: ParameterMappingOption = {
name: "Source",
icon: "string",
isForeign: false,
target: ["variable", ["template-tag", "source"]],
};
- const target = ["variable", ["template-tag", "source"]];
+ const target: ParameterTarget = ["variable", ["template-tag", "source"]];
expect(getMappingOptionByTarget([mappingOption], target)).toBe(
mappingOption,
@@ -708,40 +737,36 @@ describe("getMappingOptionByTarget", () => {
});
it("should return undefined if option is not found", () => {
- const mappingOption = {
+ const mappingOption: ParameterMappingOption = {
name: "Source",
icon: "string",
isForeign: false,
target: ["variable", ["template-tag", "source"]],
};
- const target = ["variable", ["template-tag", "source1"]];
+ const target: ParameterTarget = ["variable", ["template-tag", "source1"]];
expect(getMappingOptionByTarget([mappingOption], target)).toBe(undefined);
});
});
describe("structured dashcard", () => {
- let question;
-
- beforeEach(() => {
- const card = createMockCard({
- dataset_query: createMockStructuredDatasetQuery({
- query: {
- "source-table": 2,
- },
- }),
- });
- const database = createSampleDatabase();
- const metadata = createMockMetadata({
- questions: [card],
- databases: [database],
- });
-
- question = new Question(card, metadata);
+ const card = createMockCard({
+ dataset_query: createMockStructuredDatasetQuery({
+ query: {
+ "source-table": 2,
+ },
+ }),
});
+ const database = createSampleDatabase();
+ const metadata = createMockMetadata({
+ questions: [card],
+ databases: [database],
+ });
+
+ const question = new Question(card, metadata);
it("should find mapping option", () => {
- const mappingOption = {
+ const mappingOption: ParameterMappingOption = {
sectionName: "User",
name: "Name",
icon: "string",
@@ -758,7 +783,7 @@ describe("getMappingOptionByTarget", () => {
isForeign: true,
};
- const target = [
+ const target: ParameterTarget = [
"dimension",
[
"field",
@@ -795,7 +820,7 @@ describe("getMappingOptionByTarget", () => {
query,
);
- const mappingOptions = [
+ const mappingOptions: ParameterMappingOption[] = [
{
sectionName: "Order",
name: "Created At",
@@ -818,7 +843,7 @@ describe("getMappingOptionByTarget", () => {
},
];
- const target = [
+ const target: ParameterTarget = [
"dimension",
["field", "CREATED_AT", { "base-type": "type/Text" }],
{ "stage-number": 1 },
@@ -830,7 +855,7 @@ describe("getMappingOptionByTarget", () => {
});
it("should ignore targets with invalid stage index", () => {
- const mappingOptions = [
+ const mappingOptions: ParameterMappingOption[] = [
{
sectionName: "Order",
name: "Created At",
@@ -843,7 +868,7 @@ describe("getMappingOptionByTarget", () => {
},
];
- const target = [
+ const target: ParameterTarget = [
"dimension",
["field", "CREATED_AT", { "base-type": "type/Text" }],
{ "stage-number": 1 },
@@ -870,7 +895,7 @@ describe("getMappingOptionByTarget", () => {
const question = new Question(card, metadata);
- const mappingOption = {
+ const mappingOption: ParameterMappingOption = {
sectionName: "User",
name: "Name",
icon: "string",
@@ -887,7 +912,7 @@ describe("getMappingOptionByTarget", () => {
isForeign: true,
};
- const target = [
+ const target: ParameterTarget = [
"dimension",
[
"field",