Skip to content

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

e2e2unit: sql filters (#85849)

Nemanja Glumac9ca5411be47a
diff --git a/e2e/test/scenarios/native/sql-filters-reset-clear.cy.spec.ts b/e2e/test/scenarios/native/sql-filters-reset-clear.cy.spec.ts
deleted file mode 100644
index 6ec7fbd36a3..00000000000
--- a/e2e/test/scenarios/native/sql-filters-reset-clear.cy.spec.ts
+++ /dev/null
@@ -1,830 +0,0 @@
-const { H } = cy;
-import { SAMPLE_DATABASE } from "e2e/support/cypress_sample_database";
-import type { TemplateTag } from "metabase-types/api";
-
-type SectionId =
- | "no_default_non_required"
- | "no_default_required"
- | "default_non_required"
- | "default_required";
-
-const { PRODUCTS } = SAMPLE_DATABASE;
-
-const NO_DEFAULT_NON_REQUIRED = "no default value, non-required";
-
-// unlike required dashboard filter, required native filter doesn't need to have a default value
-const NO_DEFAULT_REQUIRED = "no default value, required";
-
-const DEFAULT_NON_REQUIRED = "default value, non-required";
-
-const DEFAULT_REQUIRED = "default value, required";
-
-describe("scenarios > filters > sql filters > reset & clear", () => {
- beforeEach(() => {
- H.restore();
- cy.signInAsAdmin();
- });
-
- it("text parameters", () => {
- createNativeQuestionWithParameters({
- no_default_non_required: {
- name: "no_default_non_required",
- "display-name": NO_DEFAULT_NON_REQUIRED,
- id: "fed1b918",
- type: "text",
- },
- no_default_required: {
- name: "no_default_required",
- "display-name": NO_DEFAULT_REQUIRED,
- id: "fed1b919",
- type: "text",
- required: true,
- },
- default_non_required: {
- name: "default_non_required",
- "display-name": DEFAULT_NON_REQUIRED,
- id: "75d67d38",
- type: "text",
- default: "a",
- },
- default_required: {
- name: "default_required",
- "display-name": DEFAULT_REQUIRED,
- id: "60f12ac8",
- type: "text",
- required: true,
- default: "a",
- },
- });
-
- checkNativeParametersInput({
- defaultValueFormatted: "a",
- otherValue: "{backspace}b",
- otherValueFormatted: "b",
- setValue: (label, value) => {
- filterInput(label).focus().clear().type(value).blur();
- },
- });
- });
-
- it("number parameters", () => {
- createNativeQuestionWithParameters({
- no_default_non_required: {
- name: "no_default_non_required",
- "display-name": NO_DEFAULT_NON_REQUIRED,
- id: "fed1b918",
- type: "number",
- },
- no_default_required: {
- name: "no_default_required",
- "display-name": NO_DEFAULT_REQUIRED,
- id: "fed1b919",
- type: "number",
- required: true,
- },
- default_non_required: {
- name: "default_non_required",
- "display-name": DEFAULT_NON_REQUIRED,
- id: "75d67d38",
- type: "number",
- default: "1",
- },
- default_required: {
- name: "default_required",
- "display-name": DEFAULT_REQUIRED,
- id: "60f12ac8",
- type: "number",
- required: true,
- default: "1",
- },
- });
-
- checkNativeParametersInput({
- defaultValueFormatted: "1",
- otherValue: "{backspace}2",
- otherValueFormatted: "2",
- setValue: (label, value) => {
- filterInput(label).focus().clear().type(value).blur();
- },
- });
- });
-
- it("date parameters", () => {
- createNativeQuestionWithParameters({
- no_default_non_required: {
- name: "no_default_non_required",
- "display-name": NO_DEFAULT_NON_REQUIRED,
- id: "fed1b918",
- type: "date",
- },
- no_default_required: {
- name: "no_default_required",
- "display-name": NO_DEFAULT_REQUIRED,
- id: "fed1b919",
- type: "date",
- required: true,
- },
- default_non_required: {
- name: "default_non_required",
- "display-name": DEFAULT_NON_REQUIRED,
- id: "75d67d38",
- type: "date",
- default: "2027-01-01",
- },
- default_required: {
- name: "default_required",
- "display-name": DEFAULT_REQUIRED,
- id: "60f12ac8",
- type: "date",
- required: true,
- default: "2027-01-01",
- },
- });
-
- checkNativeParametersDropdown({
- defaultValueFormatted: "January 1, 2027",
- otherValue: "01/01/2020",
- otherValueFormatted: "January 1, 2020",
- setValue: (value) => {
- addDateFilter(value);
- },
- updateValue: (value) => {
- updateDateFilter(value);
- },
- });
-
- checkParameterSidebarDefaultValueDate({
- defaultValueFormatted: "January 1, 2027",
- otherValue: "01/01/2020",
- otherValueFormatted: "January 1, 2020",
- });
- });
-
- it("field parameters", () => {
- createNativeQuestionWithParameters({
- no_default_non_required: {
- name: "no_default_non_required",
- "display-name": NO_DEFAULT_NON_REQUIRED,
- id: "fed1b918",
- type: "dimension",
- dimension: ["field", PRODUCTS.CATEGORY, null],
- "widget-type": "string/contains",
- options: { "case-sensitive": false },
- },
- no_default_required: {
- name: "no_default_required",
- "display-name": NO_DEFAULT_REQUIRED,
- id: "fed1b919",
- type: "dimension",
- dimension: ["field", PRODUCTS.CATEGORY, null],
- "widget-type": "string/contains",
- options: { "case-sensitive": false },
- required: true,
- },
- default_non_required: {
- name: "default_non_required",
- "display-name": DEFAULT_NON_REQUIRED,
- id: "75d67d38",
- type: "dimension",
- dimension: ["field", PRODUCTS.CATEGORY, null],
- "widget-type": "string/contains",
- options: { "case-sensitive": false },
- default: ["Gizmo"],
- },
- default_required: {
- name: "default_required",
- "display-name": DEFAULT_REQUIRED,
- id: "60f12ac8",
- type: "dimension",
- dimension: ["field", PRODUCTS.CATEGORY, null],
- "widget-type": "string/contains",
- options: { "case-sensitive": false },
- required: true,
- default: ["Gizmo"],
- },
- });
-
- checkNativeParametersDropdown({
- defaultValueFormatted: "Gizmo",
- otherValue: "{backspace}Gadget",
- otherValueFormatted: "Gadget",
- setValue: (value) => {
- H.popover().findByRole("combobox").clear().type(value).blur();
- H.popover().button("Add filter").click();
- },
- updateValue: (value) => {
- H.popover().findByRole("combobox").clear().type(value).blur();
- H.popover().button("Update filter").click();
- },
- });
-
- checkParameterSidebarDefaultValueDropdown({
- defaultValueFormatted: "Gizmo",
- otherValue: "{backspace}Gadget",
- otherValueFormatted: "Gadget",
- setValue: (value) => {
- H.popover().findByRole("combobox").clear().type(value).blur();
- H.popover().button("Add filter").click();
- },
- updateValue: (value) => {
- H.popover().findByRole("combobox").clear().type(value).blur();
- H.popover().button("Update filter").click();
- },
- });
- });
-
- function createNativeQuestionWithParameters(
- templateTags: Record<SectionId, TemplateTag>,
- ) {
- H.createNativeQuestion(
- {
- native: {
- query:
- "select {{no_default_non_required}}, {{no_default_required}}, {{default_non_required}}, {{default_required}}",
- "template-tags": templateTags,
- },
- },
- { visitQuestion: true },
- );
- }
-
- function checkStatusIcon(
- label: string,
- /**
- * Use 'none' when no icon should be visible.
- */
- icon: "chevron" | "reset" | "clear" | "none",
- ) {
- clearIcon(label).should(icon === "clear" ? "be.visible" : "not.exist");
- resetIcon(label).should(icon === "reset" ? "be.visible" : "not.exist");
- chevronIcon(label).should(icon === "chevron" ? "be.visible" : "not.exist");
- }
-
- function checkNativeParametersInput({
- defaultValueFormatted,
- otherValue,
- otherValueFormatted,
- setValue,
- updateValue = setValue,
- }: {
- defaultValueFormatted: string;
- otherValue: string;
- otherValueFormatted: string;
- setValue: (label: string, value: string) => void;
- updateValue?: (label: string, value: string) => void;
- }) {
- cy.log("no default value, non-required, no current value");
- checkStatusIcon(NO_DEFAULT_NON_REQUIRED, "none");
-
- cy.log("no default value, non-required, has current value");
- setValue(NO_DEFAULT_NON_REQUIRED, otherValue);
- filterInput(NO_DEFAULT_NON_REQUIRED).should(
- "have.value",
- otherValueFormatted,
- );
- checkStatusIcon(NO_DEFAULT_NON_REQUIRED, "clear");
- clearButton(NO_DEFAULT_NON_REQUIRED).click();
- filterInput(NO_DEFAULT_NON_REQUIRED).should("have.value", "");
- checkStatusIcon(NO_DEFAULT_NON_REQUIRED, "none");
-
- cy.log("no default value, required, no current value");
- checkStatusIcon(NO_DEFAULT_REQUIRED, "none");
-
- cy.log("no default value, required, has current value");
- updateValue(NO_DEFAULT_REQUIRED, otherValue);
- filterInput(NO_DEFAULT_REQUIRED).should("have.value", otherValueFormatted);
- checkStatusIcon(NO_DEFAULT_REQUIRED, "clear");
-
- cy.log("has default value, non-required, current value same as default");
- checkStatusIcon(DEFAULT_NON_REQUIRED, "clear");
- filterInput(DEFAULT_NON_REQUIRED).should(
- "have.value",
- defaultValueFormatted,
- );
- clearButton(DEFAULT_NON_REQUIRED).click();
- filterInput(DEFAULT_NON_REQUIRED).should("have.value", "");
-
- cy.log("has default value, non-required, no current value");
- checkStatusIcon(DEFAULT_NON_REQUIRED, "reset");
- resetButton(DEFAULT_NON_REQUIRED).click();
- filterInput(DEFAULT_NON_REQUIRED).should(
- "have.value",
- defaultValueFormatted,
- );
- checkStatusIcon(DEFAULT_NON_REQUIRED, "clear");
-
- cy.log(
- "has default value, non-required, current value different than default",
- );
- updateValue(DEFAULT_NON_REQUIRED, otherValue);
- filterInput(DEFAULT_NON_REQUIRED).should("have.value", otherValueFormatted);
- checkStatusIcon(DEFAULT_NON_REQUIRED, "reset");
- resetButton(DEFAULT_NON_REQUIRED).click();
- filterInput(DEFAULT_NON_REQUIRED).should(
- "have.value",
- defaultValueFormatted,
- );
- checkStatusIcon(DEFAULT_NON_REQUIRED, "clear");
-
- cy.log("has default value, required, value same as default");
- filterInput(DEFAULT_REQUIRED).should("have.value", defaultValueFormatted);
- checkStatusIcon(DEFAULT_REQUIRED, "none");
-
- cy.log("has default value, required, current value different than default");
- updateValue(DEFAULT_REQUIRED, otherValue);
- filterInput(DEFAULT_REQUIRED).should("have.value", otherValueFormatted);
- checkStatusIcon(DEFAULT_REQUIRED, "reset");
- resetButton(DEFAULT_REQUIRED).click();
- filterInput(DEFAULT_REQUIRED).should("have.value", defaultValueFormatted);
- checkStatusIcon(DEFAULT_REQUIRED, "none");
-
- checkParameterSidebarDefaultValue({
- defaultValueFormatted,
- otherValue,
- otherValueFormatted,
- setValue,
- updateValue,
- });
- }
-
- function checkNativeParametersDropdown({
- defaultValueFormatted,
- otherValue,
- otherValueFormatted,
- setValue,
- updateValue = setValue,
- }: {
- defaultValueFormatted: string;
- otherValue: string;
- otherValueFormatted: string;
- setValue: (value: string) => void;
- updateValue?: (value: string) => void;
- }) {
- cy.log("no default value, non-required, no current value");
- checkStatusIcon(NO_DEFAULT_NON_REQUIRED, "chevron");
-
- cy.log("no default value, non-required, has current value");
- filter(NO_DEFAULT_NON_REQUIRED).click();
- setValue(otherValue);
-
- filter(NO_DEFAULT_NON_REQUIRED).should("contain.text", otherValueFormatted);
- checkStatusIcon(NO_DEFAULT_NON_REQUIRED, "clear");
- clearButton(NO_DEFAULT_NON_REQUIRED).click();
- filter(NO_DEFAULT_NON_REQUIRED).should(
- "have.text",
- NO_DEFAULT_NON_REQUIRED,
- );
- checkStatusIcon(NO_DEFAULT_NON_REQUIRED, "chevron");
-
- cy.log("no default value, required, no current value");
- checkStatusIcon(NO_DEFAULT_REQUIRED, "none");
-
- cy.log("no default value, required, has current value");
- filter(NO_DEFAULT_REQUIRED).click();
- updateValue(otherValue);
- filter(NO_DEFAULT_REQUIRED).should("contain.text", otherValueFormatted);
- checkStatusIcon(NO_DEFAULT_REQUIRED, "clear");
-
- cy.log("has default value, non-required, current value same as default");
- checkStatusIcon(DEFAULT_NON_REQUIRED, "clear");
- filter(DEFAULT_NON_REQUIRED).should("contain.text", defaultValueFormatted);
- clearButton(DEFAULT_NON_REQUIRED).click();
- filter(DEFAULT_NON_REQUIRED).should("have.text", DEFAULT_NON_REQUIRED);
-
- cy.log("has default value, non-required, no current value");
- checkStatusIcon(DEFAULT_NON_REQUIRED, "reset");
- resetButton(DEFAULT_NON_REQUIRED).click();
- filter(DEFAULT_NON_REQUIRED).should("contain.text", defaultValueFormatted);
- checkStatusIcon(DEFAULT_NON_REQUIRED, "clear");
-
- cy.log(
- "has default value, non-required, current value different than default",
- );
- filter(DEFAULT_NON_REQUIRED).click();
- updateValue(otherValue);
- filter(DEFAULT_NON_REQUIRED).should("contain.text", otherValueFormatted);
- checkStatusIcon(DEFAULT_NON_REQUIRED, "reset");
- resetButton(DEFAULT_NON_REQUIRED).click();
- filter(DEFAULT_NON_REQUIRED).should("contain.text", defaultValueFormatted);
- checkStatusIcon(DEFAULT_NON_REQUIRED, "clear");
-
- cy.log("has default value, required, value same as default");
- filter(DEFAULT_REQUIRED).should("contain.text", defaultValueFormatted);
- checkStatusIcon(DEFAULT_REQUIRED, "none");
-
- cy.log("has default value, required, current value different than default");
- filter(DEFAULT_REQUIRED).click();
- updateValue(otherValue);
- filter(DEFAULT_REQUIRED).should("contain.text", otherValueFormatted);
- checkStatusIcon(DEFAULT_REQUIRED, "reset");
- resetButton(DEFAULT_REQUIRED).click();
- filter(DEFAULT_REQUIRED).should("contain.text", defaultValueFormatted);
- checkStatusIcon(DEFAULT_REQUIRED, "none");
- }
-
- function checkParameterSidebarDefaultValue<T = string>({
- defaultValueFormatted,
- otherValue,
- otherValueFormatted,
- setValue,
- updateValue,
- }: {
- defaultValueFormatted: string;
- otherValue: T;
- otherValueFormatted: string;
- setValue: (label: string, value: T) => void;
- updateValue: (label: string, value: T) => void;
- }) {
- cy.log("parameter sidebar");
-
- cy.findByTestId("visibility-toggler").click();
- cy.icon("variable").click();
-
- cy.log(NO_DEFAULT_NON_REQUIRED);
- filterSection("no_default_non_required").within(() => {
- filter("Default filter widget value").scrollIntoView();
- filterInput("Default filter widget value").should("have.value", "");
- checkStatusIcon("Default filter widget value", "none");
-
- setValue("Default filter widget value", otherValue);
- filterInput("Default filter widget value").should(
- "have.value",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearIcon("Default filter widget value").click();
- filterInput("Default filter widget value").should("have.value", "");
- checkStatusIcon("Default filter widget value", "none");
- });
-
- cy.log(DEFAULT_NON_REQUIRED);
- filterSection("default_non_required").within(() => {
- filter("Default filter widget value").scrollIntoView();
- filterInput("Default filter widget value").should(
- "have.value",
- defaultValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearIcon("Default filter widget value").click();
- filterInput("Default filter widget value").should("have.value", "");
- checkStatusIcon("Default filter widget value", "none");
-
- setValue("Default filter widget value", otherValue);
- filterInput("Default filter widget value").should(
- "have.value",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
- });
-
- cy.log(DEFAULT_REQUIRED);
- filterSection("default_required").within(() => {
- filter("Default filter widget value").scrollIntoView();
- filterInput("Default filter widget value").should(
- "have.value",
- defaultValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearIcon("Default filter widget value").click();
- filterInput("Default filter widget value (required)").should(
- "have.value",
- "",
- );
- checkStatusIcon("Default filter widget value (required)", "none");
-
- updateValue("Default filter widget value (required)", otherValue);
- filterInput("Default filter widget value").should(
- "have.value",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
- });
-
- cy.log(NO_DEFAULT_REQUIRED);
- filterSection("no_default_required").within(() => {
- filter("Default filter widget value (required)").scrollIntoView();
- filterInput("Default filter widget value (required)").should(
- "have.value",
- "",
- );
- checkStatusIcon("Default filter widget value (required)", "none");
-
- updateValue("Default filter widget value (required)", otherValue);
- filterInput("Default filter widget value").should(
- "have.value",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearButton("Default filter widget value").click();
- filterInput("Default filter widget value (required)").should(
- "have.value",
- "",
- );
- checkStatusIcon("Default filter widget value (required)", "none");
- });
- }
-
- function checkParameterSidebarDefaultValueDate({
- defaultValueFormatted,
- otherValue,
- otherValueFormatted,
- }: {
- defaultValueFormatted: string;
- otherValue: string;
- otherValueFormatted: string;
- }) {
- cy.log("parameter sidebar");
-
- cy.findByTestId("visibility-toggler").click();
- cy.icon("variable").click();
-
- cy.log(NO_DEFAULT_NON_REQUIRED);
- filterSection("no_default_non_required").within(() => {
- filter("Default filter widget value").scrollIntoView();
- filter("Default filter widget value").should(
- "have.text",
- "Select a default value…",
- );
- checkStatusIcon("Default filter widget value", "chevron");
- filter("Default filter widget value").click();
- });
-
- H.popover().findByRole("textbox").clear().type(otherValue).blur();
- H.popover().button("Add filter").click();
-
- filterSection("no_default_non_required").within(() => {
- filter("Default filter widget value").should(
- "have.text",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearIcon("Default filter widget value").click();
- filter("Default filter widget value").should(
- "have.text",
- "Select a default value…",
- );
- checkStatusIcon("Default filter widget value", "chevron");
- });
-
- cy.log(NO_DEFAULT_REQUIRED);
- filterSection("no_default_required").within(() => {
- filter("Default filter widget value (required)").scrollIntoView();
- filter("Default filter widget value (required)").should(
- "have.text",
- "Select a default value…",
- );
- checkStatusIcon("Default filter widget value (required)", "chevron");
- filter("Default filter widget value (required)").click();
- });
-
- H.popover().findByRole("textbox").clear().type(otherValue).blur();
- H.popover().button("Add filter").click();
-
- filterSection("no_default_required").within(() => {
- filter("Default filter widget value").should(
- "have.text",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearButton("Default filter widget value").click();
- checkStatusIcon("Default filter widget value (required)", "chevron");
- });
-
- cy.log(DEFAULT_NON_REQUIRED);
- filterSection("default_non_required").within(() => {
- filter("Default filter widget value").scrollIntoView();
- filter("Default filter widget value").should(
- "have.text",
- defaultValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearIcon("Default filter widget value").click();
- filter("Default filter widget value").should(
- "have.text",
- "Select a default value…",
- );
- checkStatusIcon("Default filter widget value", "chevron");
- filter("Default filter widget value").click();
- });
-
- H.popover().findByRole("textbox").clear().type(otherValue).blur();
- H.popover().button("Add filter").click();
-
- filterSection("default_non_required").within(() => {
- filter("Default filter widget value").should(
- "have.text",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
- });
-
- cy.log(DEFAULT_REQUIRED);
- filterSection("default_required").within(() => {
- filter("Default filter widget value").scrollIntoView();
- filter("Default filter widget value").should(
- "have.text",
- defaultValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearIcon("Default filter widget value").click();
- filter("Default filter widget value (required)").should(
- "have.text",
- "Select a default value…",
- );
- checkStatusIcon("Default filter widget value (required)", "chevron");
- filter("Default filter widget value (required)").click();
- });
-
- H.popover().findByRole("textbox").clear().type(otherValue).blur();
- H.popover().button("Add filter").click();
-
- filterSection("default_required").within(() => {
- filter("Default filter widget value").should(
- "have.text",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
- });
- }
-
- function checkParameterSidebarDefaultValueDropdown({
- defaultValueFormatted,
- otherValue,
- otherValueFormatted,
- setValue,
- updateValue = setValue,
- }: {
- defaultValueFormatted: string;
- otherValue: string;
- otherValueFormatted: string;
- setValue: (value: string) => void;
- updateValue?: (value: string) => void;
- }) {
- cy.log("parameter sidebar");
-
- cy.findByTestId("visibility-toggler").click();
- cy.icon("variable").click();
-
- cy.log(NO_DEFAULT_NON_REQUIRED);
- filterSection("no_default_non_required").within(() => {
- filter("Default filter widget value").scrollIntoView();
- filter("Default filter widget value").should(
- "have.text",
- "Enter a default value…",
- );
- checkStatusIcon("Default filter widget value", "chevron");
- filter("Default filter widget value").click();
- });
-
- setValue(otherValue);
-
- filterSection("no_default_non_required").within(() => {
- filter("Default filter widget value").should(
- "have.text",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearIcon("Default filter widget value").click();
- filter("Default filter widget value").should(
- "have.text",
- "Enter a default value…",
- );
- checkStatusIcon("Default filter widget value", "chevron");
- });
-
- cy.log(NO_DEFAULT_REQUIRED);
- filterSection("no_default_required").within(() => {
- filter("Default filter widget value (required)").scrollIntoView();
- filter("Default filter widget value (required)").should(
- "have.text",
- "Enter a default value…",
- );
- checkStatusIcon("Default filter widget value (required)", "chevron");
- filter("Default filter widget value (required)").click();
- });
-
- updateValue(otherValue);
-
- filterSection("no_default_required").within(() => {
- filter("Default filter widget value").should(
- "have.text",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearButton("Default filter widget value").click();
- checkStatusIcon("Default filter widget value (required)", "chevron");
- });
-
- cy.log(DEFAULT_NON_REQUIRED);
- filterSection("default_non_required").within(() => {
- filter("Default filter widget value").scrollIntoView();
- filter("Default filter widget value").should(
- "have.text",
- defaultValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearIcon("Default filter widget value").click();
- filter("Default filter widget value").should(
- "have.text",
- "Enter a default value…",
- );
- checkStatusIcon("Default filter widget value", "chevron");
- filter("Default filter widget value").click();
- });
-
- setValue(otherValue);
-
- filterSection("default_non_required").within(() => {
- filter("Default filter widget value").should(
- "have.text",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
- });
-
- cy.log(DEFAULT_REQUIRED);
- filterSection("default_required").within(() => {
- filter("Default filter widget value").scrollIntoView();
- filter("Default filter widget value").should(
- "have.text",
- defaultValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
-
- clearIcon("Default filter widget value").click();
- filter("Default filter widget value (required)").should(
- "have.text",
- "Enter a default value…",
- );
- checkStatusIcon("Default filter widget value (required)", "chevron");
- filter("Default filter widget value (required)").click();
- });
-
- updateValue(otherValue);
-
- filterSection("default_required").within(() => {
- filter("Default filter widget value").should(
- "have.text",
- otherValueFormatted,
- );
- checkStatusIcon("Default filter widget value", "clear");
- });
- }
-
- function filter(label: string) {
- return cy.findByLabelText(label);
- }
-
- function filterInput(label: string) {
- return filter(label).findByRole("textbox");
- }
-
- function filterSection(id: SectionId) {
- return cy.findByTestId(`tag-editor-variable-${id}`);
- }
-
- function clearIcon(label: string) {
- return filter(label).parent().icon("close");
- }
-
- function resetIcon(label: string) {
- return filter(label).parent().icon("revert");
- }
-
- function clearButton(label: string) {
- return filter(label).parent().findByLabelText("Clear");
- }
-
- function resetButton(label: string) {
- return filter(label)
- .parent()
- .findByLabelText("Reset filter to default state");
- }
-
- function chevronIcon(label: string) {
- return filter(label).parent().icon("chevrondown");
- }
-
- function addDateFilter(value: string) {
- H.popover().findByRole("textbox").clear().type(value).blur();
- H.popover().button("Add filter").click();
- }
-
- function updateDateFilter(value: string) {
- H.popover().findByRole("textbox").clear().type(value).blur();
- H.popover()
- .button(/(Add|Update) filter/)
- .click();
- }
-});
diff --git a/e2e/test/scenarios/native/sql-filters-source.cy.spec.js b/e2e/test/scenarios/native/sql-filters-source.cy.spec.js
deleted file mode 100644
index 6f7dd6e4a39..00000000000
--- a/e2e/test/scenarios/native/sql-filters-source.cy.spec.js
+++ /dev/null
@@ -1,395 +0,0 @@
-const { H } = cy;
-import { SAMPLE_DATABASE } from "e2e/support/cypress_sample_database";
-
-import * as FieldFilter from "./helpers/e2e-field-filter-helpers";
-import * as SQLFilter from "./helpers/e2e-sql-filter-helpers";
-
-const { PRODUCTS_ID, PRODUCTS } = SAMPLE_DATABASE;
-const structuredSourceQuestion = {
- name: "MBQL source",
- query: {
- "source-table": PRODUCTS_ID,
- aggregation: [["count"]],
- breakout: [["field", PRODUCTS.CATEGORY, null]],
- filter: ["!=", ["field", PRODUCTS.CATEGORY, null], "Doohickey"],
- },
-};
-
-const nativeSourceQuestion = {
- name: "SQL source",
- native: {
- query: "SELECT '1018947080336' EAN UNION ALL SELECT '7663515285824'",
- },
-};
-
-describe("scenarios > filters > sql filters > values source", () => {
- beforeEach(() => {
- H.restore();
- cy.signInAsAdmin();
- cy.intercept("POST", "/api/dataset").as("dataset");
- cy.intercept("PUT", "/api/card/*").as("updateQuestion");
- cy.intercept("POST", "/api/card/*/query").as("cardQuery");
- cy.intercept("POST", "/api/dataset/parameter/values").as("parameterValues");
- cy.intercept("GET", "/api/card/*/params/*/values").as(
- "cardParameterValues",
- );
- });
-
- describe("structured question source", () => {
- it("should be able to use a structured question source", () => {
- H.createQuestion(structuredSourceQuestion);
-
- H.startNewNativeQuestion();
- SQLFilter.enterParameterizedQuery("SELECT * FROM PRODUCTS WHERE {{tag}}");
- SQLFilter.openTypePickerFromDefaultFilterType();
- SQLFilter.chooseType("Field Filter");
- FieldFilter.mapTo({ table: "Products", field: "Category" });
- H.setFilterQuestionSource({ question: "MBQL source", field: "Category" });
- H.saveQuestion("SQL filter", undefined, {
- path: ["Our analytics"],
- });
-
- FieldFilter.openEntryForm();
- checkFilterValueInList("Gizmo");
- checkFilterValueNotInList("Doohickey");
- FieldFilter.selectFilterValueFromList("Gizmo");
- SQLFilter.runQuery("cardQuery");
- H.assertQueryBuilderRowCount(51);
-
- SQLFilter.toggleRequired();
- FieldFilter.openEntryForm(true);
- FieldFilter.selectFilterValueFromList("Gadget", {
- buttonLabel: "Update filter",
- });
- cy.findByTestId("sidebar-content").should("contain", "Gadget");
- });
-
- it("should be able to use a structured question source with a text tag", () => {
- H.createQuestion(structuredSourceQuestion);
-
- H.startNewNativeQuestion();
- SQLFilter.enterParameterizedQuery(
- "SELECT * FROM PRODUCTS WHERE CATEGORY = {{tag}}",
- );
- H.setDropdownFilterType();
- H.setFilterQuestionSource({ question: "MBQL source", field: "Category" });
- H.saveQuestion("SQL filter", undefined, {
- path: ["Our analytics"],
- });
-
- FieldFilter.openEntryForm();
- checkFilterValueInList("Gizmo");
- checkFilterValueNotInList("Doohickey");
- FieldFilter.selectFilterValueFromList("Gadget", { addFilter: false });
- FieldFilter.selectFilterValueFromList("Gizmo");
- SQLFilter.runQuery("cardQuery");
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("Showing 51 rows").should("exist");
-
- SQLFilter.toggleRequired();
- cy.findByTestId("sidebar-content")
- .findByText("Enter a default value…")
- .click();
-
- H.popover().within(() => {
- cy.findByText("Gadget").click();
- cy.button("Update filter").click();
- });
- cy.findByTestId("sidebar-content").should("contain", "Gadget");
- });
-
- it("should properly cache parameter values api calls", () => {
- H.createQuestion(structuredSourceQuestion);
- H.startNewNativeQuestion();
- SQLFilter.enterParameterizedQuery(
- "SELECT * FROM PRODUCTS WHERE CATEGORY = {{tag}}",
- );
-
- H.setDropdownFilterType();
- H.setFilterQuestionSource({ question: "MBQL source", field: "Category" });
- FieldFilter.openEntryForm();
- cy.wait("@parameterValues");
- checkFilterValueInList("Gizmo");
- FieldFilter.closeEntryForm();
- FieldFilter.openEntryForm();
- checkFilterValueInList("Gizmo");
- cy.get("@parameterValues.all").should("have.length", 1);
- checkFilterValueNotInList("Doohickey");
- FieldFilter.selectFilterValueFromList("Gizmo");
- SQLFilter.runQuery("dataset");
- H.assertQueryBuilderRowCount(51);
- H.setFilterListSource({ values: ["A", "B"] });
- FieldFilter.openEntryForm();
- cy.wait("@parameterValues");
- checkFilterValueInList("A");
-
- H.saveQuestion("SQL filter", undefined, {
- path: ["Our analytics"],
- });
- FieldFilter.openEntryForm();
- cy.wait("@cardParameterValues");
- checkFilterValueInList("A");
- FieldFilter.closeEntryForm();
- FieldFilter.openEntryForm();
- checkFilterValueInList("A");
- cy.get("@cardParameterValues.all").should("have.length", 1);
- H.setFilterQuestionSource({ question: "MBQL source", field: "Category" });
- updateQuestion();
- FieldFilter.openEntryForm();
- cy.wait("@cardParameterValues");
- checkFilterValueInList("Gizmo");
- });
- });
-
- describe("native question source", () => {
- it("should be able to use a native question source in the query builder", () => {
- H.createNativeQuestion(nativeSourceQuestion);
-
- H.startNewNativeQuestion();
- SQLFilter.enterParameterizedQuery("SELECT * FROM PRODUCTS WHERE {{tag}}");
- SQLFilter.openTypePickerFromDefaultFilterType();
- SQLFilter.chooseType("Field Filter");
- FieldFilter.mapTo({ table: "Products", field: "Ean" });
- FieldFilter.setWidgetType("String");
- H.setFilterQuestionSource({ question: "SQL source", field: "EAN" });
- H.saveQuestion("SQL filter", undefined, {
- path: ["Our analytics"],
- });
-
- FieldFilter.openEntryForm();
- checkFilterValueInList("1018947080336");
- checkFilterValueNotInList("0001664425970");
- FieldFilter.selectFilterValueFromList("1018947080336");
- SQLFilter.runQuery("cardQuery");
- H.assertQueryBuilderRowCount(1);
- });
- });
-
- describe("static list source with custom labels (dropdown)", () => {
- it("should be able to use a static list source in the query builder", () => {
- H.startNewNativeQuestion();
- SQLFilter.enterParameterizedQuery("SELECT * FROM PRODUCTS WHERE {{tag}}");
- SQLFilter.openTypePickerFromDefaultFilterType();
- SQLFilter.chooseType("Field Filter");
- FieldFilter.mapTo({ table: "Products", field: "Ean" });
- FieldFilter.setWidgetType("String");
- H.setFilterListSource({
- values: [["1018947080336", "Custom Label"], "7663515285824"],
- });
- H.saveQuestion("SQL filter", undefined, {
- path: ["Our analytics"],
- });
-
- FieldFilter.openEntryForm();
- checkFilterValueInList("Custom Label");
- checkFilterValueNotInList("0001664425970");
- checkFilterValueNotInList("1018947080336");
- FieldFilter.selectFilterValueFromList("Custom Label");
- cy.findByLabelText("Tag").should("contain.text", "Custom Label");
- SQLFilter.runQuery("cardQuery");
- H.assertQueryBuilderRowCount(1);
-
- FieldFilter.openEntryForm();
- H.popover().findByText("Custom Label").click();
- FieldFilter.selectFilterValueFromList("7663515285824", {
- buttonLabel: "Update filter",
- });
- cy.findByLabelText("Tag").should("contain.text", "7663515285824");
- SQLFilter.runQuery("cardQuery");
- H.assertQueryBuilderRowCount(1);
- });
- });
-
- describe("static list source with custom labels (search box)", () => {
- it("should be able to use a static list source in the query builder", () => {
- H.startNewNativeQuestion();
- SQLFilter.enterParameterizedQuery("SELECT * FROM PRODUCTS WHERE {{tag}}");
- SQLFilter.openTypePickerFromDefaultFilterType();
- SQLFilter.chooseType("Field Filter");
- FieldFilter.mapTo({ table: "Products", field: "Ean" });
- FieldFilter.setWidgetType("String");
-
- H.setSearchBoxFilterType();
- H.setFilterListSource({
- values: [["1018947080336", "Custom Label"], "7663515285824"],
- });
- H.saveQuestion("SQL filter", undefined, {
- path: ["Our analytics"],
- });
-
- FieldFilter.openEntryForm();
-
- H.fieldValuesCombobox().type("Custom Label");
- // eslint-disable-next-line metabase/no-unsafe-element-filtering
- H.popover().last().findByText("Custom Label").should("be.visible");
- // eslint-disable-next-line metabase/no-unsafe-element-filtering
- H.popover().last().findByText("1018947080336").should("not.exist");
- // eslint-disable-next-line metabase/no-unsafe-element-filtering
- H.popover().last().findByText("Custom Label").click();
- H.fieldValuesValue(0)
- .should("be.visible")
- .should("contain", "Custom Label");
- H.popover().button("Add filter").click();
-
- cy.findByLabelText("Tag").should("contain.text", "Custom Label");
-
- FieldFilter.openEntryForm();
- H.removeFieldValuesValue(0);
- H.fieldValuesCombobox().type("766");
- // eslint-disable-next-line metabase/no-unsafe-element-filtering
- H.popover().last().findByText("7663515285824").click();
- H.fieldValuesValue(0)
- .should("be.visible")
- .should("contain", "7663515285824");
- H.popover().button("Update filter").click();
-
- cy.findByLabelText("Tag").should("contain.text", "7663515285824");
- });
- });
-});
-describe("scenarios > filters > sql filters > values source > number parameter", () => {
- beforeEach(() => {
- H.restore();
- cy.signInAsAdmin();
- cy.intercept("POST", "/api/card/*/query").as("cardQuery");
- });
-
- describe("static list source with custom labels (search box)", () => {
- it("should be able to use a static list source in the query builder", () => {
- H.startNewNativeQuestion();
- SQLFilter.enterParameterizedQuery("SELECT {{ tag }} AS V");
- SQLFilter.openTypePickerFromDefaultFilterType();
- SQLFilter.chooseType("Number");
- H.setSearchBoxFilterType();
- H.setFilterListSource({
- values: [["10", "Ten"], ["20", "Twenty"], "30"],
- });
- H.saveQuestion("SQL filter", undefined, {
- path: ["Our analytics"],
- });
-
- FieldFilter.openEntryForm();
- H.dashboardParametersPopover().within(() => {
- H.multiAutocompleteInput().type("Tw");
- });
-
- // eslint-disable-next-line metabase/no-unsafe-element-filtering
- H.popover().last().findByText("Twenty").should("be.visible");
- checkFilterValueNotInList("10");
- checkFilterValueNotInList("20");
- // eslint-disable-next-line metabase/no-unsafe-element-filtering
- H.popover().last().findByText("Twenty").click();
- H.multiAutocompleteValue(0)
- .should("be.visible")
- .should("contain", "Twenty");
- H.popover().button("Add filter").click();
-
- cy.findByLabelText("Tag").should("contain.text", "Twenty");
- SQLFilter.runQuery("cardQuery");
- H.assertQueryBuilderRowCount(1);
- H.queryBuilderMain().findByText("20").should("be.visible");
- });
- });
-
- it("should show the values when picking the default value and use a static list source in the query builder", () => {
- H.startNewNativeQuestion();
- SQLFilter.enterParameterizedQuery("SELECT {{ x }} AS V");
- SQLFilter.openTypePickerFromDefaultFilterType();
- SQLFilter.chooseType("Number");
-
- H.setDropdownFilterType();
- H.setFilterListSource({
- values: [["10", "Ten"], ["20", "Twenty"], "30"],
- });
-
- cy.findByTestId("sidebar-content")
- .findByText("Enter a default value…")
- .click();
-
- H.popover().within(() => {
- cy.findByText("Twenty").click();
- cy.button("Add filter").click();
- });
-
- H.saveQuestion("SQL filter", undefined, {
- path: ["Our analytics"],
- });
-
- cy.findByLabelText("X").should("contain.text", "Twenty");
- SQLFilter.runQuery("cardQuery");
- H.assertQueryBuilderRowCount(1);
- H.queryBuilderMain().findByText("20").should("be.visible");
-
- cy.log("static list source (dropdown)");
- H.clearFilterWidget();
- cy.findByLabelText("X").should("not.contain.text", "Twenty");
-
- FieldFilter.openEntryForm();
- checkFilterValueInList("Ten");
- checkFilterValueNotInList("10");
- FieldFilter.selectFilterValueFromList("Ten", {
- buttonLabel: "Update filter",
- });
- cy.findByLabelText("X").should("contain.text", "Ten");
- SQLFilter.runQuery("cardQuery");
- H.assertQueryBuilderRowCount(1);
- H.queryBuilderMain().findByText("10").should("be.visible");
- });
-
- it("should clear the value type and config when changing the template tag type and restore them when changing the type back", () => {
- H.startNewNativeQuestion();
- SQLFilter.enterParameterizedQuery("SELECT * FROM PRODUCTS WHERE {{tag}}");
- SQLFilter.openTypePickerFromDefaultFilterType();
- SQLFilter.chooseType("Text");
- H.setSearchBoxFilterType();
- H.setFilterListSource({
- values: ["Foo", "Bar"],
- });
- H.saveQuestion("SQL filter", undefined, {
- path: ["Our analytics"],
- });
-
- SQLFilter.openTypePickerFromSelectedFilterType("Text");
- SQLFilter.chooseType("Number");
-
- cy.findByLabelText("Input box").should("be.checked");
-
- H.setSearchBoxFilterType();
- H.checkFilterListSourceHasValue({ values: [] });
-
- SQLFilter.openTypePickerFromSelectedFilterType("Number");
- SQLFilter.chooseType("Field Filter");
- H.setConnectedFieldSource("Orders", "Total");
-
- SQLFilter.openTypePickerFromSelectedFilterType("Number");
- SQLFilter.chooseType("Text");
- cy.findByLabelText("Search box").should("be.checked");
- H.checkFilterListSourceHasValue({ values: ["Foo", "Bar"] });
- });
-});
-
-const updateQuestion = () => {
- cy.findByText("Save").click();
- cy.findByTestId("save-question-modal").within(() => {
- cy.findByText("Save").click();
- });
- cy.wait("@updateQuestion");
-};
-
-const checkFilterValueInList = (value) => {
- // eslint-disable-next-line metabase/no-unsafe-element-filtering
- H.popover()
- .last()
- .within(() => {
- cy.findByText(value).should("be.visible");
- });
-};
-
-const checkFilterValueNotInList = (value) => {
- // eslint-disable-next-line metabase/no-unsafe-element-filtering
- H.popover()
- .last()
- .within(() => {
- cy.findByText(value).should("not.exist");
- });
-};
diff --git a/e2e/test/scenarios/native/sql-filters.cy.spec.js b/e2e/test/scenarios/native/sql-filters.cy.spec.js
deleted file mode 100644
index bdbbbb28206..00000000000
--- a/e2e/test/scenarios/native/sql-filters.cy.spec.js
+++ /dev/null
@@ -1,384 +0,0 @@
-const { H } = cy;
-
-import * as DateFilter from "./helpers/e2e-date-filter-helpers";
-import * as SQLFilter from "./helpers/e2e-sql-filter-helpers";
-
-describe("scenarios > filters > sql filters > basic filter types", () => {
- beforeEach(() => {
- H.restore();
- cy.intercept("POST", "api/dataset").as("dataset");
-
- cy.signInAsAdmin();
-
- H.startNewNativeQuestion();
- });
-
- describe("should work for text", () => {
- beforeEach(() => {
- SQLFilter.enterParameterizedQuery(
- "SELECT * FROM products WHERE products.category = {{textFilter}}",
- );
- });
-
- it("should handle a required tag", () => {
- cy.log("does not need a default value to run and save the query");
- SQLFilter.toggleRequired();
- SQLFilter.getRunQueryButton().should("not.be.disabled");
- SQLFilter.getSaveQueryButton().should("not.have.attr", "disabled");
- SQLFilter.toggleRequired();
-
- cy.log(
- "when there's a default value, enabling required sets it as a parameter value",
- );
- SQLFilter.setDefaultValue("default");
- H.filterWidget().find("input").clear();
- H.filterWidget().find("input").blur();
- H.filterWidget().find("input").should("have.value", "");
- SQLFilter.toggleRequired();
- H.filterWidget().find("input").should("have.value", "default");
-
- cy.log(
- "when there's a default value and input is empty, blur sets default value back",
- );
- H.filterWidget().within(() => {
- cy.get("input").type("{selectAll}{backspace}").should("have.value", "");
- cy.get("input").blur().should("have.value", "default");
- });
-
- cy.log(
- "when there's a default value and template tag is required, can reset it back",
- );
- H.filterWidget().within(() => {
- cy.get("input").type("abc").should("have.value", "defaultabc");
- cy.icon("revert").click();
- cy.get("input").should("have.value", "default");
- });
- });
- });
-
- describe("should work for number", () => {
- beforeEach(() => {
- SQLFilter.enterParameterizedQuery(
- "SELECT * FROM products WHERE products.rating = {{numberFilter}}",
- );
-
- SQLFilter.openTypePickerFromDefaultFilterType();
- SQLFilter.chooseType("Number");
- });
-
- it("should work when set through the filter widget and handle a required tag (metabase#15981)", () => {
- cy.log("when set through the filter widget");
- SQLFilter.setWidgetValue("4.3");
-
- SQLFilter.runQuery();
-
- H.assertQueryBuilderRowCount(17);
- H.tableInteractive()
- .findByText("Aerodynamic Linen Coat")
- .should("be.visible");
-
- H.filterWidget().find("input").clear();
- H.filterWidget().find("input").blur();
- H.filterWidget().find("input").should("have.value", "");
-
- cy.log("does not need a default value to run and save the query");
- SQLFilter.toggleRequired();
- SQLFilter.getRunQueryButton().should("not.be.disabled");
- SQLFilter.getSaveQueryButton().should("not.have.attr", "disabled");
- SQLFilter.toggleRequired();
-
- cy.log(
- "when there's a default value, enabling required sets it as a parameter value",
- );
- SQLFilter.setDefaultValue("3");
- H.filterWidget().find("input").clear();
- H.filterWidget().find("input").blur();
- H.filterWidget().find("input").should("have.value", "");
- SQLFilter.toggleRequired();
- H.filterWidget().find("input").should("have.value", "3");
-
- cy.log(
- "when there's a default value and input is empty, blur sets default value back",
- );
- H.filterWidget().within(() => {
- cy.get("input").type("{selectAll}{backspace}").should("have.value", "");
- cy.get("input").blur().should("have.value", "3");
- });
-
- cy.log(
- "when there's a default value and template tag is required, can reset it back",
- );
- H.filterWidget().within(() => {
- cy.get("input").type(".11").should("have.value", "3.11");
- cy.icon("revert").click();
- cy.get("input").should("have.value", "3");
- });
- });
- });
-
- describe("should work for date", () => {
- beforeEach(() => {
- SQLFilter.enterParameterizedQuery(
- "SELECT * FROM products WHERE products.created_at = {{dateFilter}}",
- );
-
- SQLFilter.openTypePickerFromDefaultFilterType();
- SQLFilter.chooseType("Date");
- });
-
- function setDefaultDate(year = "2024", month = "01", day = "22") {
- cy.findByTestId("sidebar-content")
- .findByText("Select a default value…")
- .click();
- DateFilter.setSingleDate(`${month}/${day}/${year}`);
- H.popover().findByText("Add filter").click();
- }
-
- it("should work when set through the filter widget and handle a required tag", () => {
- cy.log("when set through the filter widget");
- H.filterWidget().click();
- // Since we have fixed dates in Sample Database (dating back a couple of years), it'd be cumbersome to click back month by month.
- // Instead, let's choose the 15th of the current month and assert that there are no products / no results.
-
- H.popover().within(() => {
- cy.findByText("15").click();
- cy.findByText("Add filter").click();
- });
-
- SQLFilter.runQuery();
-
- cy.findByTestId("query-visualization-root").within(() => {
- cy.findByText("No results");
- });
-
- H.filterWidget().icon("close").click();
- H.filterWidget().icon("close").should("not.exist");
-
- cy.log("does not need a default value to run and save the query");
- SQLFilter.toggleRequired();
- SQLFilter.getRunQueryButton().should("not.be.disabled");
- SQLFilter.getSaveQueryButton().should("not.have.attr", "disabled");
- SQLFilter.toggleRequired();
-
- cy.log(
- "when there's a default value, enabling required sets it as a parameter value",
- );
- setDefaultDate("2026", "11", "01");
- H.filterWidget().icon("close").click();
- SQLFilter.toggleRequired();
- H.filterWidget().should("contain.text", "November 1, 2026");
-
- cy.log(
- "when there's a default value and template tag is required, can reset it back",
- );
- H.filterWidget().click();
- H.popover().within(() => {
- cy.findByText("15").click();
- cy.findByText("Update filter").click();
- });
- H.filterWidget().icon("revert").click();
- H.filterWidget().should("contain.text", "November 1, 2026");
- });
- });
-
- it("displays parameter field on desktop and mobile", () => {
- SQLFilter.enterParameterizedQuery(
- "SELECT * FROM products WHERE products.category = {{testingparamvisbility77}}",
- );
-
- SQLFilter.setWidgetValue("Gizmo");
- SQLFilter.runQuery();
-
- H.filterWidget()
- .findByPlaceholderText("Testingparamvisbility77")
- .should("be.visible");
-
- // close sidebar
- cy.findByTestId("sidebar-right").within(() => {
- cy.get(".Icon-close").click();
- });
-
- cy.icon("contract").click();
-
- // resize window to mobile form factor
- cy.viewport(480, 800);
-
- // eslint-disable-next-line metabase/no-unscoped-text-selectors -- deprecated usage
- cy.findByText("1 active filter").click();
-
- H.filterWidget()
- .findByPlaceholderText("Testingparamvisbility77")
- .should("be.visible");
- });
-});
-
-describe("scenarios > filters > sql filters > multiple values", () => {
- beforeEach(() => {
- H.restore();
- cy.signInAsAdmin();
- });
-
- function setFilterAndVerify({ values, isQueryBuilder } = {}) {
- H.filterWidget().click();
- H.popover().within(() => {
- H.multiAutocompleteInput().type(values.join(","));
- cy.button("Add filter").click();
- });
- if (isQueryBuilder) {
- cy.findAllByTestId("run-button").first().click();
- }
- values.forEach((value) => {
- H.tableInteractive().within(() => {
- cy.findAllByText(value).should("have.length.gte", 1);
- });
- });
- }
-
- it("should allow multiple values for Text variables", () => {
- const questionDetails = {
- name: "SQL",
- native: {
- query: "SELECT * FROM products WHERE category IN ({{text}})",
- "template-tags": {
- text: {
- id: "49596bcb-62bb-49d6-a92d-bf5dbfddf43b",
- name: "text",
- "display-name": "Text",
- type: "text",
- },
- },
- },
- parameters: [
- {
- id: "49596bcb-62bb-49d6-a92d-bf5dbfddf43b",
- type: "string/=",
- name: "Text",
- slug: "text",
- target: ["variable", ["template-tag", "text"]],
- isMultiSelect: true,
- },
- ],
- enable_embedding: true,
- embedding_params: {
- text: "enabled",
- },
- };
-
- cy.log("ad-hoc question");
- H.startNewNativeQuestion();
- SQLFilter.enterParameterizedQuery(
- "SELECT * FROM products WHERE category IN ({{text}})",
- );
- H.rightSidebar().findByLabelText("Multiple values").click();
- setFilterAndVerify({
- values: ["Gadget", "Widget"],
- isQueryBuilder: true,
- });
-
- cy.log("regular question");
- H.createNativeQuestion(questionDetails, {
- visitQuestion: true,
- wrapId: true,
- });
- setFilterAndVerify({
- values: ["Gadget", "Widget"],
- isQueryBuilder: true,
- });
-
- cy.log("public question");
- cy.get("@questionId").then((questionId) =>
- H.visitPublicQuestion(questionId),
- );
- setFilterAndVerify({
- values: ["Gadget", "Widget"],
- isQueryBuilder: false,
- });
-
- cy.log("embedded question");
- cy.get("@questionId").then((questionId) =>
- H.visitEmbeddedPage({
- resource: { question: questionId },
- params: {},
- }),
- );
- setFilterAndVerify({
- values: ["Gadget", "Widget"],
- isQueryBuilder: false,
- });
- });
-
- it("should allow multiple values for Number variables", () => {
- const questionDetails = {
- name: "SQL",
- native: {
- query: "SELECT ID FROM products WHERE ID IN ({{number}})",
- "template-tags": {
- number: {
- id: "49596bcb-62bb-49d6-a92d-bf5dbfddf43b",
- name: "number",
- "display-name": "Number",
- type: "number",
- },
- },
- },
- parameters: [
- {
- id: "49596bcb-62bb-49d6-a92d-bf5dbfddf43b",
- type: "number/=",
- name: "Number",
- slug: "number",
- target: ["variable", ["template-tag", "number"]],
- isMultiSelect: true,
- },
- ],
- enable_embedding: true,
- embedding_params: {
- number: "enabled",
- },
- };
-
- cy.log("ad-hoc question");
- H.startNewNativeQuestion();
- SQLFilter.enterParameterizedQuery(
- "SELECT ID FROM products WHERE ID IN ({{number}})",
- );
- SQLFilter.openTypePickerFromDefaultFilterType();
- H.popover().findByText("Number").click();
- H.rightSidebar().findByLabelText("Multiple values").click();
- setFilterAndVerify({
- values: ["10", "20"],
- isQueryBuilder: true,
- });
-
- cy.log("regular question");
- H.createNativeQuestion(questionDetails, {
- visitQuestion: true,
- wrapId: true,
- });
- setFilterAndVerify({
- values: ["10", "20"],
- isQueryBuilder: true,
- });
-
- cy.log("public question");
- cy.get("@questionId").then((questionId) =>
- H.visitPublicQuestion(questionId),
- );
- setFilterAndVerify({
- values: ["10", "20"],
- isQueryBuilder: false,
- });
-
- cy.log("embedded question");
- cy.get("@questionId").then((questionId) =>
- H.visitEmbeddedPage({
- resource: { question: questionId },
- params: {},
- }),
- );
- setFilterAndVerify({
- values: ["10", "20"],
- isQueryBuilder: false,
- });
- });
-});
diff --git a/e2e/test/scenarios/native/sql-filters.cy.spec.ts b/e2e/test/scenarios/native/sql-filters.cy.spec.ts
new file mode 100644
index 00000000000..c00ca78f2ab
--- /dev/null
+++ b/e2e/test/scenarios/native/sql-filters.cy.spec.ts
@@ -0,0 +1,179 @@
+const { H } = cy;
+import { SAMPLE_DATABASE } from "e2e/support/cypress_sample_database";
+import type { NativeQuestionDetails } from "e2e/support/helpers";
+import type { CardId } from "metabase-types/api";
+
+const { PRODUCTS, PRODUCTS_ID } = SAMPLE_DATABASE;
+const TAG_ID = "49596bcb-62bb-49d6-a92d-bf5dbfddf43b";
+
+describe("scenarios > filters > sql filters", () => {
+ beforeEach(() => {
+ H.restore();
+ cy.signInAsAdmin();
+ cy.intercept("POST", "/api/card/*/query").as("cardQuery");
+ });
+
+ it("should allow multiple values for a variable in regular, public, and embedded questions", () => {
+ const values = ["Gadget", "Widget"];
+ const questionDetails: NativeQuestionDetails = {
+ name: "SQL",
+ native: {
+ query: "SELECT * FROM products WHERE category IN ({{tag}})",
+ "template-tags": {
+ tag: { id: TAG_ID, name: "tag", "display-name": "Tag", type: "text" },
+ },
+ },
+ parameters: [
+ {
+ id: TAG_ID,
+ type: "string/=",
+ name: "Tag",
+ slug: "tag",
+ target: ["variable", ["template-tag", "tag"]],
+ isMultiSelect: true,
+ },
+ ],
+ enable_embedding: true,
+ embedding_params: { tag: "enabled" },
+ };
+
+ cy.log("regular question");
+ H.createNativeQuestion(questionDetails, {
+ visitQuestion: true,
+ wrapId: true,
+ });
+ setMultipleValues(values);
+ cy.findAllByTestId("run-button").first().click();
+ cy.wait("@cardQuery");
+ assertValuesInTable(values);
+
+ cy.log("public question");
+ cy.get<CardId>("@questionId").then((questionId) =>
+ H.visitPublicQuestion(questionId),
+ );
+ setMultipleValues(values);
+ assertValuesInTable(values);
+
+ cy.log("embedded question");
+ cy.get<CardId>("@questionId").then((questionId) =>
+ H.visitEmbeddedPage({
+ resource: { question: questionId },
+ params: {},
+ }),
+ );
+ setMultipleValues(values);
+ assertValuesInTable(values);
+ });
+
+ it("should search the values of a variable in its saved question source", () => {
+ H.createQuestion({
+ name: "Category source",
+ query: {
+ "source-table": PRODUCTS_ID,
+ aggregation: [["count"]],
+ breakout: [["field", PRODUCTS.CATEGORY, null]],
+ filter: ["!=", ["field", PRODUCTS.CATEGORY, null], "Doohickey"],
+ },
+ }).then(({ body: sourceCard }) => {
+ H.createNativeQuestion(
+ {
+ name: "SQL",
+ native: {
+ query: "SELECT * FROM products WHERE category IN ({{category}})",
+ "template-tags": {
+ category: {
+ id: TAG_ID,
+ name: "category",
+ "display-name": "Category",
+ type: "text",
+ },
+ },
+ },
+ parameters: [
+ {
+ id: TAG_ID,
+ type: "string/=",
+ name: "Category",
+ slug: "category",
+ target: ["variable", ["template-tag", "category"]],
+ isMultiSelect: true,
+ values_query_type: "search",
+ values_source_type: "card",
+ values_source_config: {
+ card_id: sourceCard.id,
+ value_field: ["field", PRODUCTS.CATEGORY, null],
+ },
+ },
+ ],
+ },
+ { visitQuestion: true },
+ );
+ });
+ cy.intercept("GET", "/api/card/*/params/*/search/*").as("searchValues");
+
+ H.filterWidget().click();
+ H.fieldValuesCombobox().type("Doo");
+ cy.wait("@searchValues");
+ cy.findByRole("option", { name: "Doohickey" }).should("not.exist");
+
+ H.fieldValuesCombobox().clear().type("Giz");
+ cy.wait("@searchValues");
+ cy.findByRole("option", { name: "Gizmo" }).click();
+ H.fieldValuesValue(0).should("contain", "Gizmo");
+ H.popover().button("Add filter").click();
+
+ cy.findAllByTestId("run-button").first().click();
+ cy.wait("@cardQuery");
+ H.assertQueryBuilderRowCount(51);
+ });
+
+ it("should show the filters in a toggleable list on small screens", () => {
+ H.createNativeQuestion(
+ {
+ name: "SQL",
+ native: {
+ query: "SELECT * FROM products WHERE category = {{category}}",
+ "template-tags": {
+ category: {
+ id: TAG_ID,
+ name: "category",
+ "display-name": "Category",
+ type: "text",
+ default: "Gizmo",
+ },
+ },
+ },
+ },
+ { visitQuestion: true },
+ );
+ cy.viewport(480, 800);
+
+ filterInput().should("not.be.visible");
+
+ cy.button(/1 active filter/).click();
+ filterInput().should("be.visible").and("have.value", "Gizmo");
+
+ cy.button("Close").click();
+ filterInput().should("not.be.visible");
+ });
+
+ function filterInput() {
+ return H.filterWidget().findByRole("textbox");
+ }
+
+ function setMultipleValues(values: string[]) {
+ H.filterWidget().click();
+ H.popover().within(() => {
+ H.multiAutocompleteInput().type(values.join(","));
+ cy.button("Add filter").click();
+ });
+ }
+
+ function assertValuesInTable(values: string[]) {
+ H.tableInteractive().within(() => {
+ values.forEach((value) => {
+ cy.findAllByText(value).should("have.length.gte", 1);
+ });
+ });
+ }
+});
diff --git a/frontend/src/metabase-lib/v1/queries/NativeQuery.unit.spec.ts b/frontend/src/metabase-lib/v1/queries/NativeQuery.unit.spec.ts
index 39aa0fb9310..7ce72b5e2b2 100644
--- a/frontend/src/metabase-lib/v1/queries/NativeQuery.unit.spec.ts
+++ b/frontend/src/metabase-lib/v1/queries/NativeQuery.unit.spec.ts
@@ -1,5 +1,6 @@
import { createMockMetadata } from "__support__/metadata";
import { checkNotNull } from "metabase/utils/types";
+import * as Lib from "metabase-lib";
import Question from "metabase-lib/v1/Question";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import NativeQuery, {
@@ -303,6 +304,32 @@ describe("NativeQuery", () => {
});
});
+ describe("required template tags", () => {
+ it.each(["text", "number", "date"] as const)(
+ "should run and save without a default value for a required %s tag",
+ (type) => {
+ const q = makeQuery().setQueryText(
+ "SELECT * from ORDERS where {{foo}}",
+ );
+ const requiredQuery = q.setTemplateTag(
+ "foo",
+ createMockTemplateTag({
+ name: "foo",
+ "display-name": "Foo",
+ type,
+ required: true,
+ default: undefined,
+ }),
+ );
+
+ expect(requiredQuery.canRun()).toBe(true);
+ expect(
+ Lib.canSave(requiredQuery.question().query(), "question"),
+ ).toBe(true);
+ },
+ );
+ });
+
describe("snippet template tags", () => {
it("should parse snippet tags", () => {
const q = makeQuery().setQueryText("{{ snippet: foo }}");
diff --git a/frontend/src/metabase/parameters/actions.unit.spec.ts b/frontend/src/metabase/parameters/actions.unit.spec.ts
index 606f70fdfb7..fcef95c453e 100644
--- a/frontend/src/metabase/parameters/actions.unit.spec.ts
+++ b/frontend/src/metabase/parameters/actions.unit.spec.ts
@@ -1,14 +1,18 @@
import fetchMock from "fetch-mock";
+import { getMainStore } from "__support__/entities-store";
+import { setupParameterValuesEndpoints } from "__support__/server-mocks";
import type { DispatchFn } from "metabase/redux";
+import { API_UPDATE_QUESTION } from "metabase/redux/query-builder";
import type { GetState } from "metabase/redux/store";
import { stableStringify } from "metabase/utils/objects";
import type { ParameterValues } from "metabase-types/api";
-import { createMockParameter } from "metabase-types/api/mocks";
+import { createMockCard, createMockParameter } from "metabase-types/api/mocks";
import {
fetchCardParameterValues,
fetchDashboardParameterValues,
+ fetchParameterValues,
} from "./actions";
const PARAMETER = createMockParameter({ id: "param-1", name: "Category" });
@@ -111,3 +115,52 @@ describe("parameters > actions", () => {
});
});
});
+
+describe("parameters > actions > values cache", () => {
+ const CARD_ID = 7;
+ const CARD_VALUES_PATH = `path:/api/card/${CARD_ID}/params/${PARAMETER.id}/values`;
+ const AD_HOC_VALUES_PATH = "path:/api/dataset/parameter/values";
+
+ beforeEach(() => {
+ fetchMock.get(CARD_VALUES_PATH, CACHED);
+ setupParameterValuesEndpoints(CACHED);
+ });
+
+ it("fetches the values of an ad-hoc question once per values source", async () => {
+ const store = getMainStore();
+ const staticListParameter = createMockParameter({
+ ...PARAMETER,
+ values_source_type: "static-list",
+ values_source_config: { values: ["A", "B"] },
+ });
+
+ await store.dispatch(fetchParameterValues({ parameter: PARAMETER }));
+ await store.dispatch(fetchParameterValues({ parameter: PARAMETER }));
+ expect(fetchMock.callHistory.calls(AD_HOC_VALUES_PATH)).toHaveLength(1);
+
+ await store.dispatch(
+ fetchParameterValues({ parameter: staticListParameter }),
+ );
+ expect(fetchMock.callHistory.calls(AD_HOC_VALUES_PATH)).toHaveLength(2);
+ });
+
+ it("fetches the values of a saved question once until the question is updated", async () => {
+ const store = getMainStore();
+ const fetchValues = () =>
+ store.dispatch(
+ fetchCardParameterValues({
+ cardId: CARD_ID,
+ entityIdentifier: null,
+ parameter: PARAMETER,
+ }),
+ );
+
+ await fetchValues();
+ await fetchValues();
+ expect(fetchMock.callHistory.calls(CARD_VALUES_PATH)).toHaveLength(1);
+
+ store.dispatch({ type: API_UPDATE_QUESTION, payload: createMockCard() });
+ await fetchValues();
+ expect(fetchMock.callHistory.calls(CARD_VALUES_PATH)).toHaveLength(2);
+ });
+});
diff --git a/frontend/src/metabase/parameters/components/NativeQueryParametersList.unit.spec.tsx b/frontend/src/metabase/parameters/components/NativeQueryParametersList.unit.spec.tsx
new file mode 100644
index 00000000000..f9e09d0a371
--- /dev/null
+++ b/frontend/src/metabase/parameters/components/NativeQueryParametersList.unit.spec.tsx
@@ -0,0 +1,86 @@
+import { renderWithProviders, screen } from "__support__/ui";
+import {
+ NativeQueryEditorContextProvider,
+ type NativeQueryEditorContextValue,
+} from "metabase/querying/components/NativeQueryEditor/context/NativeQueryEditorContext";
+import { checkNotNull } from "metabase/utils/types";
+import { SAMPLE_METADATA } from "metabase-lib/test-helpers";
+import Question from "metabase-lib/v1/Question";
+import type NativeQuery from "metabase-lib/v1/queries/NativeQuery";
+import {
+ createMockCard,
+ createMockTemplateTag,
+} from "metabase-types/api/mocks";
+import { SAMPLE_DB_ID } from "metabase-types/api/mocks/presets";
+
+import { NativeQueryParametersList } from "./NativeQueryParametersList";
+
+const TAG_ID = "category-tag";
+const DEFAULT_VALUE = "Gizmo";
+
+function setup() {
+ const card = createMockCard({
+ dataset_query: {
+ type: "native",
+ database: SAMPLE_DB_ID,
+ native: {
+ query: "select * from products where category = {{category}}",
+ "template-tags": {
+ category: createMockTemplateTag({
+ id: TAG_ID,
+ name: "category",
+ "display-name": "Category",
+ type: "text",
+ required: true,
+ default: DEFAULT_VALUE,
+ }),
+ },
+ },
+ },
+ });
+ const question = new Question(card, SAMPLE_METADATA).setParameterValues({
+ [TAG_ID]: DEFAULT_VALUE,
+ });
+ const query: NativeQuery = checkNotNull(question.legacyNativeQuery());
+
+ const context: NativeQueryEditorContextValue = {
+ question,
+ query,
+ setDatasetQuery: jest.fn(),
+ focusEditor: jest.fn(),
+ onFormatQuery: jest.fn(),
+ isNativeEditorOpen: true,
+ toggleEditor: jest.fn(),
+ canChangeDatabase: true,
+ editorContext: "question",
+ setParameterValue: jest.fn(),
+ isRunnable: true,
+ isRunning: false,
+ isResultDirty: false,
+ snippets: [],
+ snippetCollections: [],
+ isShowingDataReference: false,
+ isShowingSnippetSidebar: false,
+ isShowingTemplateTagsEditor: false,
+ };
+
+ renderWithProviders(
+ <NativeQueryEditorContextProvider value={context}>
+ <NativeQueryParametersList />
+ </NativeQueryEditorContextProvider>,
+ );
+}
+
+describe("NativeQueryParametersList", () => {
+ it("should apply the required behavior to template tag widgets", () => {
+ setup();
+
+ expect(screen.getByRole("textbox")).toHaveValue(DEFAULT_VALUE);
+ expect(
+ screen.queryByRole("button", { name: "Clear" }),
+ ).not.toBeInTheDocument();
+ expect(
+ screen.queryByRole("button", { name: "Reset filter to default state" }),
+ ).not.toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/parameters/components/ParameterValueWidget.unit.spec.tsx b/frontend/src/metabase/parameters/components/ParameterValueWidget.unit.spec.tsx
index 3aeb296b4dd..6446e026dde 100644
--- a/frontend/src/metabase/parameters/components/ParameterValueWidget.unit.spec.tsx
+++ b/frontend/src/metabase/parameters/components/ParameterValueWidget.unit.spec.tsx
@@ -1,9 +1,24 @@
import userEvent from "@testing-library/user-event";
+import { useState } from "react";
-import { renderWithProviders, screen } from "__support__/ui";
+import {
+ setupCardParameterRemappingEndpoint,
+ setupCardParameterSearchEndpoint,
+ setupCardParameterValuesEndpoint,
+} from "__support__/server-mocks";
+import { renderWithProviders, screen, within } from "__support__/ui";
import type { UiParameter } from "metabase-lib/v1/parameters/types";
+import type {
+ CardId,
+ ParameterValueOrArray,
+ ParameterValues,
+ ValuesQueryType,
+} from "metabase-types/api";
import { createMockParameter } from "metabase-types/api/mocks";
-import { createProductsRatingField } from "metabase-types/api/mocks/presets";
+import {
+ createProductsCategoryField,
+ createProductsRatingField,
+} from "metabase-types/api/mocks/presets";
import { ParameterValueWidget } from "./ParameterValueWidget";
@@ -33,6 +48,78 @@ function setup({ parameter }: { parameter?: Partial<UiParameter> } = {}) {
return { setValue };
}
+type WidgetValue = ParameterValueOrArray | null;
+
+interface StatefulSetupOpts {
+ parameter: Partial<UiParameter>;
+ value?: WidgetValue;
+ cardId?: CardId;
+}
+
+const FILTER_NAME = "Filter";
+const PARAMETER_ID = "param";
+
+function setupStateful({ parameter, value = null, cardId }: StatefulSetupOpts) {
+ const onValueChange = jest.fn<void, [WidgetValue]>();
+ const uiParameter: UiParameter = {
+ ...createMockParameter({
+ id: PARAMETER_ID,
+ slug: "filter",
+ name: FILTER_NAME,
+ }),
+ hasVariableTemplateTagTarget: true,
+ ...parameter,
+ };
+
+ const StatefulWidget = () => {
+ const [currentValue, setCurrentValue] = useState<WidgetValue>(value);
+
+ return (
+ <ParameterValueWidget
+ parameter={uiParameter}
+ value={currentValue}
+ setValue={(newValue) => {
+ onValueChange(newValue);
+ setCurrentValue(newValue);
+ }}
+ setParameterValueToDefault={() =>
+ setCurrentValue(uiParameter.default ?? null)
+ }
+ placeholder={FILTER_NAME}
+ cardId={cardId}
+ enableRequiredBehavior
+ />
+ );
+ };
+
+ renderWithProviders(<StatefulWidget />);
+
+ return { onValueChange };
+}
+
+type WidgetStatus = "clear" | "reset" | "chevron" | "none";
+
+function getWidgetStatus(): WidgetStatus | undefined {
+ const statuses: WidgetStatus[] = [
+ screen.queryByRole("button", { name: "Clear" }) && "clear",
+ screen.queryByRole("button", { name: "Reset filter to default state" }) &&
+ "reset",
+ screen.queryByLabelText("chevrondown icon") && "chevron",
+ screen.queryByLabelText("empty icon") && "none",
+ ].filter((status): status is WidgetStatus => Boolean(status));
+
+ return statuses.length === 1 ? statuses[0] : undefined;
+}
+
+const TEXT_PARAMETER: Partial<UiParameter> = { type: "category" };
+const DATE_PARAMETER: Partial<UiParameter> = { type: "date/single" };
+const NUMBER_PARAMETER: Partial<UiParameter> = { type: "number/=" };
+const FIELD_FILTER_PARAMETER: Partial<UiParameter> = {
+ type: "string/=",
+ hasVariableTemplateTagTarget: false,
+ fields: [createProductsCategoryField()],
+};
+
describe("ParameterValueWidget", () => {
it("should let a number filter be typed into when its field has no values to list", async () => {
setup({
@@ -55,6 +142,22 @@ describe("ParameterValueWidget", () => {
).toBeInTheDocument();
});
+ it("should accept multiple values for a multi-select number variable", async () => {
+ const { onValueChange } = setupStateful({
+ parameter: { type: "number/=", isMultiSelect: true },
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: FILTER_NAME }));
+ const dropdown = await screen.findByTestId("parameter-value-dropdown");
+ await userEvent.type(within(dropdown).getByRole("combobox"), "10,20,");
+ await userEvent.click(
+ within(dropdown).getByRole("button", { name: "Add filter" }),
+ );
+
+ expect(onValueChange).toHaveBeenCalledTimes(1);
+ expect(onValueChange).toHaveBeenCalledWith([10, 20]);
+ });
+
it("should apply aria-expanded=true on the trigger button element (#70543)", async () => {
setup();
@@ -72,4 +175,282 @@ describe("ParameterValueWidget", () => {
// After opening, aria-expanded should be true on the same button
expect(triggerButton).toHaveAttribute("aria-expanded", "true");
});
+
+ describe("static list source with custom labels in a saved question", () => {
+ const CARD_ID = 1;
+ const LABELED_VALUE = "1018947080336";
+ const LABEL = "Custom Label";
+ const PLAIN_VALUE = "7663515285824";
+ const VALUES: ParameterValues["values"] = [
+ [LABELED_VALUE, LABEL],
+ [PLAIN_VALUE],
+ ];
+
+ function setupStaticList({ queryType }: { queryType: ValuesQueryType }) {
+ setupCardParameterValuesEndpoint({
+ cardId: CARD_ID,
+ parameterId: PARAMETER_ID,
+ parameterValues: { values: VALUES, has_more_values: false },
+ });
+ setupCardParameterRemappingEndpoint({
+ cardId: CARD_ID,
+ parameterId: PARAMETER_ID,
+ remappings: VALUES,
+ });
+ return setupStateful({
+ cardId: CARD_ID,
+ parameter: {
+ type: "string/=",
+ hasVariableTemplateTagTarget: false,
+ values_query_type: queryType,
+ values_source_type: "static-list",
+ values_source_config: { values: VALUES },
+ },
+ });
+ }
+
+ it("should show labels instead of values in the dropdown list and store the value", async () => {
+ const { onValueChange } = setupStaticList({ queryType: "list" });
+
+ await userEvent.click(screen.getByRole("button", { name: FILTER_NAME }));
+ const dropdown = await screen.findByTestId("parameter-value-dropdown");
+ expect(await within(dropdown).findByText(LABEL)).toBeInTheDocument();
+ expect(within(dropdown).getByText(PLAIN_VALUE)).toBeInTheDocument();
+ expect(
+ within(dropdown).queryByText(LABELED_VALUE),
+ ).not.toBeInTheDocument();
+
+ await userEvent.click(within(dropdown).getByText(LABEL));
+ await userEvent.click(
+ within(dropdown).getByRole("button", { name: "Add filter" }),
+ );
+
+ expect(
+ screen.getByRole("button", { name: FILTER_NAME }),
+ ).toHaveTextContent(LABEL);
+ expect(onValueChange).toHaveBeenLastCalledWith([LABELED_VALUE]);
+ });
+
+ it("should show labels for search results in the search box and store the value", async () => {
+ const { onValueChange } = setupStaticList({ queryType: "search" });
+ setupCardParameterSearchEndpoint({
+ cardId: CARD_ID,
+ parameterId: PARAMETER_ID,
+ query: "Custom",
+ parameterValues: {
+ values: [[LABELED_VALUE, LABEL]],
+ has_more_values: false,
+ },
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: FILTER_NAME }));
+ const dropdown = await screen.findByTestId("parameter-value-dropdown");
+ await userEvent.type(within(dropdown).getByRole("combobox"), "Custom");
+
+ const option = await screen.findByRole("option", { name: LABEL });
+ expect(
+ screen.queryByRole("option", { name: LABELED_VALUE }),
+ ).not.toBeInTheDocument();
+
+ await userEvent.click(option);
+ await userEvent.click(
+ within(dropdown).getByRole("button", { name: "Add filter" }),
+ );
+
+ expect(
+ screen.getByRole("button", { name: FILTER_NAME }),
+ ).toHaveTextContent(LABEL);
+ expect(onValueChange).toHaveBeenLastCalledWith([LABELED_VALUE]);
+ });
+ });
+
+ describe("clear and reset status", () => {
+ describe.each<{
+ widget: string;
+ parameter: Partial<UiParameter>;
+ defaultValue: ParameterValueOrArray;
+ otherValue: ParameterValueOrArray;
+ emptyStatus: WidgetStatus;
+ }>([
+ {
+ widget: "input",
+ parameter: TEXT_PARAMETER,
+ defaultValue: "a",
+ otherValue: "b",
+ emptyStatus: "none",
+ },
+ {
+ widget: "dropdown",
+ parameter: DATE_PARAMETER,
+ defaultValue: "2027-01-01",
+ otherValue: "2020-01-01",
+ emptyStatus: "chevron",
+ },
+ {
+ widget: "number input",
+ parameter: NUMBER_PARAMETER,
+ defaultValue: "1",
+ otherValue: "2",
+ emptyStatus: "none",
+ },
+ {
+ widget: "field filter",
+ parameter: FIELD_FILTER_PARAMETER,
+ defaultValue: ["Gizmo"],
+ otherValue: ["Widget"],
+ emptyStatus: "chevron",
+ },
+ ])(
+ "$widget widget",
+ ({ parameter, defaultValue, otherValue, emptyStatus }) => {
+ it.each([
+ {
+ name: "no default, not required, no value",
+ required: false,
+ hasDefault: false,
+ value: null,
+ status: emptyStatus,
+ },
+ {
+ name: "no default, not required, has value",
+ required: false,
+ hasDefault: false,
+ value: otherValue,
+ status: "clear",
+ },
+ {
+ name: "no default, required, no value",
+ required: true,
+ hasDefault: false,
+ value: null,
+ status: "none",
+ },
+ {
+ name: "no default, required, has value",
+ required: true,
+ hasDefault: false,
+ value: otherValue,
+ status: "clear",
+ },
+ {
+ name: "default, not required, value same as default",
+ required: false,
+ hasDefault: true,
+ value: defaultValue,
+ status: "clear",
+ },
+ {
+ name: "default, not required, no value",
+ required: false,
+ hasDefault: true,
+ value: null,
+ status: "reset",
+ },
+ {
+ name: "default, not required, value different from default",
+ required: false,
+ hasDefault: true,
+ value: otherValue,
+ status: "reset",
+ },
+ {
+ name: "default, required, value same as default",
+ required: true,
+ hasDefault: true,
+ value: defaultValue,
+ status: "none",
+ },
+ {
+ name: "default, required, value different from default",
+ required: true,
+ hasDefault: true,
+ value: otherValue,
+ status: "reset",
+ },
+ ] as const)(
+ "$name → $status",
+ ({ required, hasDefault, value, status }) => {
+ setupStateful({
+ parameter: {
+ ...parameter,
+ required,
+ default: hasDefault ? defaultValue : undefined,
+ },
+ value,
+ });
+
+ expect(getWidgetStatus()).toBe(status);
+ },
+ );
+ },
+ );
+
+ it("should treat a single value equal to a one-item array default as the default", () => {
+ setupStateful({
+ parameter: { ...FIELD_FILTER_PARAMETER, default: ["Gizmo"] },
+ value: "Gizmo",
+ });
+
+ expect(getWidgetStatus()).toBe("clear");
+ });
+
+ it("should clear the value of a filter without a default value", async () => {
+ setupStateful({ parameter: TEXT_PARAMETER, value: "b" });
+
+ await userEvent.click(screen.getByRole("button", { name: "Clear" }));
+
+ expect(screen.getByRole("textbox")).toHaveValue("");
+ expect(getWidgetStatus()).toBe("none");
+ });
+
+ it("should clear the default value of a non-required filter, then reset it", async () => {
+ setupStateful({
+ parameter: { ...TEXT_PARAMETER, default: "a" },
+ value: "a",
+ });
+
+ await userEvent.click(screen.getByRole("button", { name: "Clear" }));
+ expect(screen.getByRole("textbox")).toHaveValue("");
+ expect(getWidgetStatus()).toBe("reset");
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Reset filter to default state" }),
+ );
+ expect(screen.getByRole("textbox")).toHaveValue("a");
+ expect(getWidgetStatus()).toBe("clear");
+ });
+
+ it("should reset a required filter to its default value", async () => {
+ setupStateful({
+ parameter: { ...TEXT_PARAMETER, required: true, default: "a" },
+ value: "a",
+ });
+
+ const input = screen.getByRole("textbox");
+ await userEvent.type(input, "bc");
+ await userEvent.tab();
+ expect(input).toHaveValue("abc");
+ expect(getWidgetStatus()).toBe("reset");
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Reset filter to default state" }),
+ );
+ expect(input).toHaveValue("a");
+ expect(getWidgetStatus()).toBe("none");
+ });
+
+ it("should restore the default value of a required filter on blur when the input is empty", async () => {
+ setupStateful({
+ parameter: { ...TEXT_PARAMETER, required: true, default: "a" },
+ value: null,
+ });
+
+ const input = screen.getByRole("textbox");
+ await userEvent.click(input);
+ await userEvent.tab();
+
+ expect(input).toHaveValue("a");
+ expect(getWidgetStatus()).toBe("none");
+ });
+ });
});
diff --git a/frontend/src/metabase/parameters/components/ResponsiveParametersList.unit.spec.tsx b/frontend/src/metabase/parameters/components/ResponsiveParametersList.unit.spec.tsx
index 4b4a8624faa..29ba39879fc 100644
--- a/frontend/src/metabase/parameters/components/ResponsiveParametersList.unit.spec.tsx
+++ b/frontend/src/metabase/parameters/components/ResponsiveParametersList.unit.spec.tsx
@@ -36,17 +36,15 @@ function setup({
}
describe("ResponsiveParametersList", () => {
- const matchMediaSpy = jest.spyOn(window, "matchMedia");
-
afterEach(() => {
- matchMediaSpy.mockRestore();
+ jest.restoreAllMocks();
});
describe("small screens", () => {
beforeEach(() => {
- matchMediaSpy.mockReturnValue(
- createMockMediaQueryList({ matches: true }),
- );
+ jest
+ .spyOn(window, "matchMedia")
+ .mockReturnValue(createMockMediaQueryList({ matches: true }));
});
it("should show the filter button when there are parameters", () => {
@@ -56,6 +54,21 @@ describe("ResponsiveParametersList", () => {
).toBeInTheDocument();
});
+ it("should count the active filters and render their widgets", () => {
+ setup({
+ parameters: [
+ createMockParameter({ id: "1", name: "Category", value: "Gizmo" }),
+ createMockParameter({ id: "2", name: "Vendor" }),
+ ],
+ });
+
+ expect(
+ screen.getByRole("button", { name: /1 active filter/ }),
+ ).toBeInTheDocument();
+ expect(screen.getByText("Gizmo")).toBeInTheDocument();
+ expect(screen.getByText("Vendor")).toBeInTheDocument();
+ });
+
it("should not show the filter button when there are no parameters", () => {
setup({ parameters: [] });
expect(
@@ -66,9 +79,9 @@ describe("ResponsiveParametersList", () => {
describe("large screens", () => {
beforeEach(() => {
- matchMediaSpy.mockReturnValue(
- createMockMediaQueryList({ matches: false }),
- );
+ jest
+ .spyOn(window, "matchMedia")
+ .mockReturnValue(createMockMediaQueryList({ matches: false }));
});
it("should not show the filter button for small screens when there are parameters", () => {
diff --git a/frontend/src/metabase/parameters/components/TagEditor/TagEditorParam.unit.spec.tsx b/frontend/src/metabase/parameters/components/TagEditor/TagEditorParam.unit.spec.tsx
index d7364b7bafe..e78e531ac8e 100644
--- a/frontend/src/metabase/parameters/components/TagEditor/TagEditorParam.unit.spec.tsx
+++ b/frontend/src/metabase/parameters/components/TagEditor/TagEditorParam.unit.spec.tsx
@@ -21,6 +21,8 @@ import type {
Database,
Field,
FieldId,
+ Parameter,
+ ParameterValues,
TemplateTag,
TemplateTagType,
} from "metabase-types/api";
@@ -28,6 +30,7 @@ import {
createMockCard,
createMockFieldDimension,
createMockNativeDatasetQuery,
+ createMockNativeQuery,
createMockTemplateTag,
} from "metabase-types/api/mocks";
import {
@@ -42,12 +45,16 @@ import { TagEditorParam } from "./TagEditorParam";
interface SetupOpts {
tag?: TemplateTag;
+ parameter?: Parameter;
+ parameterValues?: ParameterValues;
originalCard?: Card;
transformDatabase?: (database: Database) => void;
}
const setup = ({
tag = createMockTemplateTag(),
+ parameter = getTemplateTagParameter(tag),
+ parameterValues = { values: [], has_more_values: false },
originalCard,
transformDatabase,
}: SetupOpts = {}) => {
@@ -71,10 +78,7 @@ const setup = ({
setupDatabasesEndpoints([database]);
setupSearchEndpoints([]);
- setupParameterValuesEndpoints({
- values: [],
- has_more_values: false,
- });
+ setupParameterValuesEndpoints(parameterValues);
const setTemplateTag = jest.fn();
const setTemplateTagConfig = jest.fn();
@@ -85,7 +89,7 @@ const setup = ({
tag={tag}
database={databaseMetadata}
databases={metadata.databasesList()}
- parameter={getTemplateTagParameter(tag)}
+ parameter={parameter}
originalQuestion={
originalCard ? new Question(originalCard, metadata) : undefined
}
@@ -216,6 +220,63 @@ describe("TagEditorParam", () => {
});
});
+ describe("values source of the saved question", () => {
+ const savedTag = createMockTemplateTag({ type: "text" });
+ const savedValuesSource: Pick<
+ Parameter,
+ "values_query_type" | "values_source_type" | "values_source_config"
+ > = {
+ values_query_type: "search",
+ values_source_type: "static-list",
+ values_source_config: { values: ["Foo", "Bar"] },
+ };
+ const originalCard = createMockCard({
+ dataset_query: createMockNativeDatasetQuery({
+ native: createMockNativeQuery({
+ query: `SELECT {{${savedTag.name}}}`,
+ "template-tags": { [savedTag.name]: savedTag },
+ }),
+ }),
+ parameters: [
+ { ...getTemplateTagParameter(savedTag), ...savedValuesSource },
+ ],
+ });
+
+ it("should restore it when changing the type back to the saved type", async () => {
+ const tag = { ...savedTag, type: "number" } as const;
+ const { setTemplateTagConfig } = setup({ tag, originalCard });
+
+ await userEvent.click(screen.getByTestId("variable-type-select"));
+ await userEvent.click(screen.getByRole("option", { name: "Text" }));
+
+ expect(setTemplateTagConfig).toHaveBeenCalledTimes(1);
+ expect(setTemplateTagConfig).toHaveBeenCalledWith(
+ tag,
+ expect.objectContaining(savedValuesSource),
+ );
+ });
+
+ it("should clear it when changing to a type other than the saved type", async () => {
+ const { setTemplateTagConfig } = setup({
+ tag: savedTag,
+ originalCard,
+ });
+
+ await userEvent.click(screen.getByTestId("variable-type-select"));
+ await userEvent.click(screen.getByRole("option", { name: "Number" }));
+
+ expect(setTemplateTagConfig).toHaveBeenCalledTimes(1);
+ expect(setTemplateTagConfig).toHaveBeenCalledWith(
+ savedTag,
+ expect.objectContaining({
+ values_query_type: undefined,
+ values_source_type: undefined,
+ values_source_config: undefined,
+ }),
+ );
+ });
+ });
+
it("should reset type-specific properties when the type is changed", async () => {
const tag = createMockTemplateTag({
type: "table",
@@ -547,6 +608,73 @@ describe("TagEditorParam", () => {
});
});
+ describe("default value", () => {
+ it("should mark a required tag without a default value", () => {
+ setup({ tag: createMockTemplateTag({ required: true }) });
+
+ expect(screen.getByText("Default filter widget value")).toHaveTextContent(
+ "Default filter widget value (required)",
+ );
+ });
+
+ it.each([
+ { required: false, default: undefined },
+ { required: true, default: "a" },
+ ])(
+ "should not mark a tag that is required=$required with default=$default",
+ (opts) => {
+ setup({ tag: createMockTemplateTag(opts) });
+
+ expect(
+ screen.getByText("Default filter widget value"),
+ ).toHaveTextContent(/^Default filter widget value$/);
+ },
+ );
+
+ it.each([false, true])(
+ "should clear the default value with required=%s",
+ async (required) => {
+ const tag = createMockTemplateTag({ required, default: "a" });
+ const { setTemplateTag, setParameterValue } = setup({ tag });
+
+ await userEvent.click(screen.getByRole("button", { name: "Clear" }));
+
+ expect(setTemplateTag).toHaveBeenCalledWith({ ...tag, default: null });
+ expect(setParameterValue).toHaveBeenCalledWith(tag.id, null);
+ },
+ );
+
+ it("should show the labels of a static list when picking the default value", async () => {
+ const values: ParameterValues["values"] = [
+ [10, "Ten"],
+ [20, "Twenty"],
+ [30],
+ ];
+ const tag = createMockTemplateTag({ type: "number" });
+ const { setTemplateTag } = setup({
+ tag,
+ parameter: {
+ ...getTemplateTagParameter(tag),
+ values_query_type: "list",
+ values_source_type: "static-list",
+ values_source_config: { values },
+ },
+ parameterValues: { values, has_more_values: false },
+ });
+
+ await userEvent.click(screen.getByText("Enter a default value…"));
+ expect(await screen.findByText("Ten")).toBeInTheDocument();
+ expect(screen.getByText("Twenty")).toBeInTheDocument();
+ expect(screen.getByText("30")).toBeInTheDocument();
+ expect(screen.queryByText("20")).not.toBeInTheDocument();
+
+ await userEvent.click(screen.getByText("Twenty"));
+ await userEvent.click(screen.getByRole("button", { name: "Add filter" }));
+
+ expect(setTemplateTag).toHaveBeenCalledWith({ ...tag, default: [20] });
+ });
+ });
+
describe("multi select", () => {
it.each<TemplateTagType>(["text", "number"])(
"should support single and multiple values with %s variables",
diff --git a/frontend/src/metabase/query_builder/actions/core/core.unit.spec.ts b/frontend/src/metabase/query_builder/actions/core/core.unit.spec.ts
new file mode 100644
index 00000000000..e4e1f6973a1
--- /dev/null
+++ b/frontend/src/metabase/query_builder/actions/core/core.unit.spec.ts
@@ -0,0 +1,71 @@
+import {
+ createMockQueryBuilderState,
+ createMockState,
+} from "__support__/state";
+import { createMockEntitiesState } from "__support__/store";
+import type { TemplateTag } from "metabase-types/api";
+import {
+ createMockNativeDatasetQuery,
+ createMockNativeQuery,
+ createMockTemplateTag,
+} from "metabase-types/api/mocks";
+import {
+ SAMPLE_DB_ID,
+ createSampleDatabase,
+ createSavedNativeCard,
+} from "metabase-types/api/mocks/presets";
+
+import { setParameterValue } from "../../store/actions";
+
+import { setParameterValueToDefault } from "./core";
+
+const TAG_ID = "category-tag";
+
+interface SetupOpts {
+ tag: Partial<TemplateTag>;
+}
+
+async function setup({ tag }: SetupOpts) {
+ const card = createSavedNativeCard({
+ dataset_query: createMockNativeDatasetQuery({
+ database: SAMPLE_DB_ID,
+ native: createMockNativeQuery({
+ query: "select * from products where category = {{category}}",
+ "template-tags": {
+ category: createMockTemplateTag({
+ id: TAG_ID,
+ name: "category",
+ "display-name": "Category",
+ type: "text",
+ ...tag,
+ }),
+ },
+ }),
+ }),
+ });
+ const state = createMockState({
+ entities: createMockEntitiesState({ databases: [createSampleDatabase()] }),
+ qb: createMockQueryBuilderState({ card }),
+ });
+ const dispatch = jest.fn();
+
+ await setParameterValueToDefault(TAG_ID)(dispatch, () => state);
+
+ return { dispatch };
+}
+
+describe("setParameterValueToDefault", () => {
+ it("should set the parameter value to the default value of its template tag", async () => {
+ const { dispatch } = await setup({ tag: { default: "Gizmo" } });
+
+ expect(dispatch).toHaveBeenCalledWith(setParameterValue(TAG_ID, "Gizmo"));
+ });
+
+ it("should not set a value when the template tag has no default value", async () => {
+ const { dispatch } = await setup({ tag: { default: undefined } });
+
+ expect(dispatch).not.toHaveBeenCalledWith(
+ expect.objectContaining({ type: setParameterValue.toString() }),
+ );
+ });
+});
diff --git a/frontend/test/__support__/server-mocks/card.ts b/frontend/test/__support__/server-mocks/card.ts
index cc0720da93b..0cc27dec905 100644
--- a/frontend/test/__support__/server-mocks/card.ts
+++ b/frontend/test/__support__/server-mocks/card.ts
@@ -8,7 +8,10 @@ import type {
ConcreteTableId,
DashboardId,
Dataset,
+ FieldValue,
GetPublicCard,
+ ParameterId,
+ ParameterValues,
} from "metabase-types/api";
import { createMockCard } from "metabase-types/api/mocks";
@@ -171,3 +174,57 @@ export function setupCardDashboardsEndpoint(
name: `card-${cardId}-dashboards`,
});
}
+
+export function setupCardParameterValuesEndpoint({
+ cardId,
+ parameterId,
+ parameterValues,
+}: {
+ cardId: CardId;
+ parameterId: ParameterId;
+ parameterValues: ParameterValues;
+}) {
+ fetchMock.get(
+ `path:/api/card/${cardId}/params/${parameterId}/values`,
+ parameterValues,
+ );
+}
+
+export function setupCardParameterRemappingEndpoint({
+ cardId,
+ parameterId,
+ remappings,
+}: {
+ cardId: CardId;
+ parameterId: ParameterId;
+ remappings: FieldValue[];
+}) {
+ fetchMock.get(
+ `path:/api/card/${cardId}/params/${parameterId}/remapping`,
+ ({ url }) => {
+ const value = new URL(url).searchParams.get("value");
+ return (
+ remappings.find(
+ ([remappedValue]) => String(remappedValue) === value,
+ ) ?? [value]
+ );
+ },
+ );
+}
+
+export function setupCardParameterSearchEndpoint({
+ cardId,
+ parameterId,
+ query,
+ parameterValues,
+}: {
+ cardId: CardId;
+ parameterId: ParameterId;
+ query: string;
+ parameterValues: ParameterValues;
+}) {
+ fetchMock.get(
+ `path:/api/card/${cardId}/params/${parameterId}/search/${encodeURIComponent(query)}`,
+ parameterValues,
+ );
+}
diff --git a/test/metabase/driver/sql/parameters/substitute_test.clj b/test/metabase/driver/sql/parameters/substitute_test.clj
index f1f5e80efa2..eb62b212399 100644
--- a/test/metabase/driver/sql/parameters/substitute_test.clj
+++ b/test/metabase/driver/sql/parameters/substitute_test.clj
@@ -1356,6 +1356,19 @@
:target [:variable [:template-tag "names_list"]]
:value ["BBQ" "Bakery" "Bar"]}]})))))
+(deftest ^:parallel multiple-value-number-array-test
+ (testing "an array of values for a number variable is substituted as a list of numbers"
+ (is (= {:query "SELECT * FROM CATEGORIES where id IN (10, 20)"
+ :params []}
+ (expand*
+ {:native {:query "SELECT * FROM CATEGORIES [[where id IN ({{ids_list}})]]"
+ :template-tags {"ids_list" {:name "ids_list"
+ :display-name "Ids list"
+ :type :number}}}
+ :parameters [{:type "number/="
+ :target [:variable [:template-tag "ids_list"]]
+ :value [10 20]}]})))))
+
(deftest ^:parallel multiple-value-test-3
(testing "Make sure arrays of values also work for 'field filter' params"
(is (= {:query "SELECT * FROM CATEGORIES WHERE \"PUBLIC\".\"CATEGORIES\".\"NAME\" IN (?, ?, ?)",
diff --git a/test/metabase/queries_rest/api/card_test.clj b/test/metabase/queries_rest/api/card_test.clj
index d9b966a7057..2efc9c55fc3 100644
--- a/test/metabase/queries_rest/api/card_test.clj
+++ b/test/metabase/queries_rest/api/card_test.clj
@@ -4295,7 +4295,12 @@
(is (= {:has_more_values false,
:values [["African" "Af"]]}
(mt/user-http-request :rasta :get 200
- (param-values-url card (:static-list-label param-keys) "af")))))
+ (param-values-url card (:static-list-label param-keys) "af"))))
+ (testing "labeled values match the label, not the value"
+ (is (= {:has_more_values false,
+ :values []}
+ (mt/user-http-request :rasta :get 200
+ (param-values-url card (:static-list-label param-keys) "ican"))))))
(testing "we could edit the values list"
(let [card (mt/user-http-request :rasta :put 200 (str "card/" (:id card))
{:parameters [{:name "Static Category",