Skip to content

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

Allow run-query overlay when query result has missing-required-parameter error (#64521)

Timofey Kachalov070963f9f9f7
diff --git a/e2e/support/helpers/e2e-ui-elements-helpers.js b/e2e/support/helpers/e2e-ui-elements-helpers.js
index 037ce70807d..bfcbb66d520 100644
--- a/e2e/support/helpers/e2e-ui-elements-helpers.js
+++ b/e2e/support/helpers/e2e-ui-elements-helpers.js
@@ -630,3 +630,11 @@ export function waitForLoaderToBeRemoved() {
export function leaveConfirmationModal() {
return cy.findByTestId("leave-confirmation");
}
+
+export function ensureParameterColumnValue({ columnName, columnValue }) {
+ tableInteractiveBody().within(() => {
+ cy.get(`[data-column-id="${columnName}"]`).each((cell) => {
+ cy.wrap(cell).should("have.text", columnValue);
+ });
+ });
+}
diff --git a/e2e/test-component/scenarios/embedding-sdk/sdk-question-native.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/sdk-question-native.cy.spec.tsx
index 9119c338b5e..a3280dfa13a 100644
--- a/e2e/test-component/scenarios/embedding-sdk/sdk-question-native.cy.spec.tsx
+++ b/e2e/test-component/scenarios/embedding-sdk/sdk-question-native.cy.spec.tsx
@@ -18,6 +18,7 @@ import { Box, Button } from "metabase/ui";
import type { DatasetColumn } from "metabase-types/api";
import { createMockParameter } from "metabase-types/api/mocks";
+const { H } = cy;
const { ORDERS, ORDERS_ID } = SAMPLE_DATABASE;
const setup = ({ question }: { question: NativeQuestionDetails }) => {
@@ -29,20 +30,6 @@ const setup = ({ question }: { question: NativeQuestionDetails }) => {
mockAuthProviderAndJwtSignIn();
};
-const ensureParameterColumnValue = ({
- columnName,
- columnValue,
-}: {
- columnName: string;
- columnValue: string;
-}) => {
- tableInteractiveBody().within(() => {
- cy.get(`[data-column-id="${columnName}"]`).each((cell) => {
- cy.wrap(cell).should("have.text", columnValue);
- });
- });
-};
-
describe("scenarios > embedding-sdk > interactive-question > native", () => {
describe("common", () => {
beforeEach(() => {
@@ -238,7 +225,7 @@ describe("scenarios > embedding-sdk > interactive-question > native", () => {
cy.findByPlaceholderText("State").clear().type("NY{enter}");
});
- ensureParameterColumnValue({
+ H.ensureParameterColumnValue({
columnName: "STATE",
columnValue: "NY",
});
@@ -247,7 +234,7 @@ describe("scenarios > embedding-sdk > interactive-question > native", () => {
cy.findByPlaceholderText("State").clear().type("AR{enter}");
});
- ensureParameterColumnValue({
+ H.ensureParameterColumnValue({
columnName: "STATE",
columnValue: "AR",
});
@@ -256,7 +243,7 @@ describe("scenarios > embedding-sdk > interactive-question > native", () => {
cy.findByPlaceholderText("City").type("El Paso{enter}");
});
- ensureParameterColumnValue({
+ H.ensureParameterColumnValue({
columnName: "CITY",
columnValue: "El Paso",
});
@@ -277,7 +264,7 @@ describe("scenarios > embedding-sdk > interactive-question > native", () => {
cy.wait("@cardQuery");
- ensureParameterColumnValue({
+ H.ensureParameterColumnValue({
columnName: "STATE",
columnValue: "AR",
});
@@ -286,7 +273,7 @@ describe("scenarios > embedding-sdk > interactive-question > native", () => {
cy.findByPlaceholderText("City").type("El Paso{enter}");
});
- ensureParameterColumnValue({
+ H.ensureParameterColumnValue({
columnName: "CITY",
columnValue: "El Paso",
});
diff --git a/e2e/test/scenarios/question-reproductions/reproductions.cy.spec.ts b/e2e/test/scenarios/question-reproductions/reproductions.cy.spec.ts
index b30b3d7fd1a..db025505de3 100644
--- a/e2e/test/scenarios/question-reproductions/reproductions.cy.spec.ts
+++ b/e2e/test/scenarios/question-reproductions/reproductions.cy.spec.ts
@@ -8,6 +8,7 @@ import type {
StructuredQuestionDetails,
} from "e2e/support/helpers";
import type { Filter, LocalFieldReference } from "metabase-types/api";
+import { createMockParameter } from "metabase-types/api/mocks";
const { ORDERS, ORDERS_ID, PRODUCTS, PRODUCTS_ID, REVIEWS, REVIEWS_ID } =
SAMPLE_DATABASE;
@@ -1290,3 +1291,48 @@ SELECT 2 AS ID, 3 AS USER_ID
});
});
});
+
+describe("issue 64293", () => {
+ beforeEach(() => {
+ H.restore();
+ cy.signInAsNormalUser();
+ });
+
+ it("should be possible to run a query for a empty required parameter without a default value (metabase#64293)", () => {
+ const questionDetails: NativeQuestionDetails = {
+ name: "Question 1",
+ native: {
+ query: "SELECT * FROM PEOPLE WHERE state = {{State}}",
+ "template-tags": {
+ State: {
+ type: "text",
+ name: "State",
+ id: "1",
+ "display-name": "State",
+ },
+ },
+ },
+ parameters: [
+ createMockParameter({
+ id: "1",
+ slug: "State",
+ required: true,
+ name: "State",
+ }),
+ ],
+ };
+
+ H.createNativeQuestion(questionDetails, { visitQuestion: true });
+
+ cy.findByPlaceholderText("State").should("exist");
+ cy.findByPlaceholderText("State").type("NY{enter}");
+
+ H.runButtonOverlay().should("exist");
+ H.runButtonOverlay().click();
+
+ H.ensureParameterColumnValue({
+ columnName: "STATE",
+ columnValue: "NY",
+ });
+ });
+});
diff --git a/frontend/src/metabase/lib/errors/server-error-types.ts b/frontend/src/metabase/lib/errors/server-error-types.ts
index 37d725514a6..8f164d49670 100644
--- a/frontend/src/metabase/lib/errors/server-error-types.ts
+++ b/frontend/src/metabase/lib/errors/server-error-types.ts
@@ -1,3 +1,4 @@
export const SERVER_ERROR_TYPES = {
+ missingRequiredParameter: "missing-required-parameter",
missingPermissions: "missing-required-permissions",
};
diff --git a/frontend/src/metabase/query_builder/components/QueryVisualization.jsx b/frontend/src/metabase/query_builder/components/QueryVisualization.jsx
index 3d87a49cadd..583e90df0a9 100644
--- a/frontend/src/metabase/query_builder/components/QueryVisualization.jsx
+++ b/frontend/src/metabase/query_builder/components/QueryVisualization.jsx
@@ -9,6 +9,7 @@ import LoadingSpinner from "metabase/common/components/LoadingSpinner";
import CS from "metabase/css/core/index.css";
import QueryBuilderS from "metabase/css/query_builder.module.css";
import { isMac } from "metabase/lib/browser";
+import { SERVER_ERROR_TYPES } from "metabase/lib/errors";
import { useSelector } from "metabase/lib/redux";
import { getWhiteLabeledLoadingMessageFactory } from "metabase/selectors/whitelabel";
import { Box, Flex, Stack, Text, Title } from "metabase/ui";
@@ -53,7 +54,9 @@ export default function QueryVisualization(props) {
!isRunnable ||
isRunning ||
isNativeEditorOpen ||
- result?.error
+ (result?.error &&
+ // This error should not prevent showing a dirty-state overlay with the `run` button
+ result.error_type !== SERVER_ERROR_TYPES.missingRequiredParameter)
}
className={cx(CS.spread, CS.z2)}
/>